Vmeda.Online/scripts/build-behat-plugin.js

#!/usr/bin/env node

// (C) Copyright 2021 Moodle Pty Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

const minimatch = require('minimatch');
const { existsSync, readFileSync, writeFileSync, statSync, renameSync, rmSync } = require('fs');
const { readdir } = require('fs').promises;
const { mkdirSync, copySync } = require('fs-extra');
const { resolve, extname, dirname, basename, relative } = require('path');

async function main() {
    const pluginPath = process.argv[2] || guessPluginPath() || fail('Folder argument missing!');
    const excludeFeatures = process.argv.some(arg => arg === '--exclude-features');
    const exclusions = excludeFeatures
        ? [
            '*.feature',
            '**/js/mobile/index.js',
            '**/db/mobile.php',
            '**/classes/output/mobile.php',
        ]
        : [];

    if (!existsSync(pluginPath)) {
        mkdirSync(pluginPath, { recursive: true });
    } else {
        // Empty directory, except the excluding list.
        const excludeFromErase = [
            ...exclusions,
            '.git',
            '.gitignore',
            'README.md',
        ];

        const files = await readdir(pluginPath, { withFileTypes: true });
        for (const file of files) {
            if (isExcluded(file.name, excludeFromErase)) {
                continue;
            }

            const path = resolve(pluginPath, file.name);
            rmSync(`${path}`, {recursive: true});
        }
    }

    // Copy plugin template.
    const { version: appVersion } = require(projectPath('package.json'));
    const templatePath = projectPath('local_moodleappbehat');

    for await (const file of getDirectoryFiles(templatePath)) {
        if (isExcluded(file, exclusions)) {
            continue;
        }

        copySync(file, file.replace(templatePath, pluginPath));
    }

    // Update version.php
    const pluginFilePath = pluginPath + '/version.php';
    const fileContents = readFileSync(pluginFilePath).toString();

    const replacements = {
        appVersion,
        pluginVersion: getMoodlePluginVersion(),
    };
    writeFileSync(pluginFilePath, replaceArguments(fileContents, replacements));

    // Copy features, snapshots, and fixtures.
    if (!excludeFeatures) {
        const behatTempFeaturesPath = `${pluginPath}/behat-tmp`;
        copySync(projectPath('src'), behatTempFeaturesPath, { filter: shouldCopyFileOrDirectory });

        const behatFeaturesPath = `${pluginPath}/tests/behat`;
        if (!existsSync(behatFeaturesPath)) {
            mkdirSync(behatFeaturesPath, { recursive: true });
        }

        for await (const file of getDirectoryFiles(behatTempFeaturesPath)) {
            const filePath = dirname(file);
            const snapshotsIndex = file.indexOf('/tests/behat/snapshots/');
            const fixturesIndex = file.indexOf('/tests/behat/fixtures/');

            if (snapshotsIndex !== -1) {
                moveFile(file, behatFeaturesPath + '/snapshots/' + file.slice(snapshotsIndex + 23));

                continue;
            }

            if (fixturesIndex !== -1) {
                moveFile(file, behatFeaturesPath + '/fixtures/' + file.slice(fixturesIndex + 22));

                continue;
            }

            if (!filePath.endsWith('/tests/behat')) {
                continue;
            }

            const newPath = filePath.substring(0, filePath.length - ('/tests/behat'.length));
            const searchRegExp = /\//g;
            const prefix = relative(behatTempFeaturesPath, newPath).replace(searchRegExp,'-') || 'core';
            const featureFilename = prefix + '-' + basename(file);
            moveFile(file, behatFeaturesPath + '/' + featureFilename);
        }

        rmSync(behatTempFeaturesPath, {recursive: true});
    }
}

function shouldCopyFileOrDirectory(path) {
    const stats = statSync(path);

    return stats.isDirectory()
        || extname(path) === '.feature'
        || path.includes('/tests/behat/snapshots')
        || path.includes('/tests/behat/fixtures');
}

function isExcluded(file, exclusions) {
    return exclusions.some(exclusion => minimatch(file, exclusion));
}

function fail(message) {
    console.error(message);
    process.exit(1);
}

function moveFile(from, to) {
    const targetDir = dirname(to);

    if (!existsSync(targetDir)) {
        mkdirSync(targetDir, { recursive: true });
    }

    renameSync(from, to);
}

function guessPluginPath() {
    if (process.env.MOODLE_APP_BEHAT_PLUGIN_PATH) {
        return process.env.MOODLE_APP_BEHAT_PLUGIN_PATH;
    }

    if (process.env.MOODLE_DOCKER_WWWROOT) {
        return `${process.env.MOODLE_DOCKER_WWWROOT}/local/moodleappbehat`;
    }

    return null;
}

function projectPath(path) {
    return resolve(__dirname, '../', path);
}

async function* getDirectoryFiles(dir) {
    const files = await readdir(dir, { withFileTypes: true });

    for (const file of files) {
        const path = resolve(dir, file.name);
        if (file.isDirectory()) {
            yield* getDirectoryFiles(path);
        } else {
            yield path;
        }
    }
}

function replaceArguments(text, args) {
    for (const [arg, value] of Object.entries(args)) {
        const regexp = new RegExp(`\\{\\{\\s+${arg}\\s+\\}\\}`, 'gm');

        text = text.replace(regexp, value);
    }

    return text;
}

function getMoodlePluginVersion() {
    const now = new Date();
    const padded = (number, length = 2) => number.toString().padStart(length, '0');
    const year = padded(now.getFullYear(), 4);
    const month = padded(now.getMonth() + 1);
    const day = padded(now.getDate());

    return `${year}${month}${day}00`;
}

main();