@graphprotocol/graph-cli 0.40.0 → 0.40.1-alpha-20230216174117-760a195

package/dist/commands/test.js

@@ -6,92 +6,48 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const child_process_1 = require("child_process");
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
+const core_1 = require("@oclif/core");
 const binary_install_raw_1 = require("binary-install-raw");
-const chalk_1 = __importDefault(require("chalk"));
 const gluegun_1 = require("gluegun");
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const semver_1 = __importDefault(require("semver"));
-const gluegun_2 = require("../command-helpers/gluegun");
-const HELP = `
-${chalk_1.default.bold('graph test')} ${chalk_1.default.dim('[options]')} ${chalk_1.default.bold('<datasource>')}
-
-${chalk_1.default.dim('Options:')}
-  -c, --coverage                Run the tests in coverage mode
-  -d, --docker                  Run the tests in a docker container(Note: Please execute from the root folder of the subgraph)
-  -f  --force                   Binary - overwrites folder + file when downloading. Docker - rebuilds the docker image
-  -h, --help                    Show usage information
-  -l, --logs                    Logs to the console information about the OS, CPU model and download url (debugging purposes)
-  -r, --recompile               Force-recompile tests
-  -v, --version <tag>           Choose the version of the rust binary that you want to be downloaded/used
-  `;
-exports.default = {
-    description: 'Runs rust binary for subgraph testing',
-    run: async (toolbox) => {
-        // Read CLI parameters
-        const { c, coverage, d, docker, f, force, h, help, l, logs, r, recompile, v, version } = toolbox.parameters.options;
-        const testsFolder = './tests';
+class TestCommand extends core_1.Command {
+    async run() {
+        const { args: { datasource }, flags: { coverage, docker, force, logs, recompile, version }, } = await this.parse(TestCommand);
+        const testsDir = './tests';
+        const cachePath = path_1.default.resolve(testsDir, '.latest.json');
         const opts = {
-            testsFolder,
-            cachePath: path_1.default.join(testsFolder, '.latest.json'),
+            testsDir,
+            cachePath,
+            coverage,
+            docker,
+            force,
+            logs,
+            recompile,
+            version,
+            latestVersion: getLatestVersionFromCache(cachePath),
         };
-        // Support both long and short option variants
-        opts.coverage = coverage || c;
-        opts.docker = docker || d;
-        opts.force = force || f;
-        opts.help = help || h;
-        opts.logs = logs || l;
-        opts.recompile = recompile || r;
-        opts.version = version || v;
-        // Fix if a boolean flag (e.g -c, --coverage) has an argument
-        try {
-            (0, gluegun_2.fixParameters)(toolbox.parameters, {
-                h,
-                help,
-                c,
-                coverage,
-                d,
-                docker,
-                f,
-                force,
-                l,
-                logs,
-                r,
-                recompile,
-            });
-        }
-        catch (e) {
-            gluegun_1.print.error(e.message);
-            process.exitCode = 1;
-            return;
-        }
-        const datasource = toolbox.parameters.first || toolbox.parameters.array?.[0];
-        // Show help text if requested
-        if (opts.help) {
-            gluegun_1.print.info(HELP);
-            return;
-        }
         // Check if matchstick.yaml config exists
         if (gluegun_1.filesystem.exists('matchstick.yaml')) {
             try {
                 // Load the config
                 const config = await js_yaml_1.default.load(gluegun_1.filesystem.read('matchstick.yaml', 'utf8'));
-                // Check if matchstick.yaml and testsFolder not null
-                if (config?.testsFolder) {
+                // Check if matchstick.yaml and testsDir not null
+                if (config?.testsDir) {
                     // assign test folder from matchstick.yaml if present
-                    opts.testsFolder = config.testsFolder;
+                    opts.testsDir = config.testsDir;
                 }
             }
             catch (error) {
-                gluegun_1.print.info('A problem occurred while reading matchstick.yaml. Please attend to the errors below:');
-                gluegun_1.print.error(error.message);
-                process.exit(1);
+                this.error(`A problem occurred while reading "matchstick.yaml":\n${error.message}`, {
+                    exit: 1,
+                });
             }
         }
-        setVersionFromCache(opts);
         // Fetch the latest version tag if version is not specified with -v/--version or if the version is not cached
         if (opts.force || (!opts.version && !opts.latestVersion)) {
-            gluegun_1.print.info('Fetching latest version tag');
+            this.log('Fetching latest version tag...');
             const result = await (0, node_fetch_1.default)('https://api.github.com/repos/LimeChain/matchstick/releases/latest');
             const json = await result.json();
             opts.latestVersion = json.tag_name;
@@ -103,23 +59,58 @@ exports.default = {
             });
         }
         if (opts.docker) {
-            runDocker(datasource, opts);
+            runDocker.bind(this)(datasource, opts);
         }
         else {
-            runBinary(datasource, opts);
+            runBinary.bind(this)(datasource, opts);
         }
-    },
+    }
+}
+exports.default = TestCommand;
+TestCommand.description = 'Runs rust binary for subgraph testing.';
+TestCommand.args = {
+    datasource: core_1.Args.string({
+        required: true,
+    }),
 };
-async function setVersionFromCache(opts) {
-    if (gluegun_1.filesystem.exists(opts.cachePath) == 'file') {
-        const cached = gluegun_1.filesystem.read(opts.cachePath, 'json');
+TestCommand.flags = {
+    coverage: core_1.Flags.boolean({
+        summary: 'Run the tests in coverage mode.',
+        char: 'c',
+    }),
+    docker: core_1.Flags.boolean({
+        summary: 'Run the tests in a docker container (Note: Please execute from the root folder of the subgraph).',
+        char: 'd',
+    }),
+    force: core_1.Flags.boolean({
+        summary: 'Binary - overwrites folder + file when downloading. Docker - rebuilds the docker image.',
+        char: 'f',
+    }),
+    logs: core_1.Flags.boolean({
+        summary: 'Logs to the console information about the OS, CPU model and download url (debugging purposes).',
+        char: 'l',
+    }),
+    recompile: core_1.Flags.boolean({
+        summary: 'Force-recompile tests.',
+        char: 'r',
+    }),
+    version: core_1.Flags.string({
+        summary: 'Choose the version of the rust binary that you want to be downloaded/used.',
+        char: 'v',
+        required: true,
+    }),
+};
+function getLatestVersionFromCache(cachePath) {
+    if (gluegun_1.filesystem.exists(cachePath) == 'file') {
+        const cached = gluegun_1.filesystem.read(cachePath, 'json');
         // Get the cache age in days
         const cacheAge = (Date.now() - cached.timestamp) / (1000 * 60 * 60 * 24);
         // If cache age is less than 1 day, use the cached version
         if (cacheAge < 1) {
-            opts.latestVersion = cached.version;
+            return cached.version;
         }
     }
+    return null;
 }
 async function runBinary(datasource, opts) {
     const coverageOpt = opts.coverage;
@@ -128,10 +119,11 @@ async function runBinary(datasource, opts) {
     const versionOpt = opts.version;
     const latestVersion = opts.latestVersion;
     const recompileOpt = opts.recompile;
-    const platform = await getPlatform(logsOpt);
-    const url = `https://github.com/LimeChain/matchstick/releases/download/${versionOpt || latestVersion}/${platform}`;
+    const platform = await getPlatform.bind(this)(logsOpt);
+    const url = `https://github.com/LimeChain/matchstick/releases/download/${versionOpt ||
+        latestVersion}/${platform}`;
     if (logsOpt) {
-        gluegun_1.print.info(`Download link: ${url}`);
+        this.log(`Download link: ${url}`);
     }
     const binary = new binary_install_raw_1.Binary(platform, url, versionOpt || latestVersion);
     forceOpt ? await binary.install(true) : await binary.install(false);
@@ -149,12 +141,13 @@ async function getPlatform(logsOpt) {
     const arch = os_1.default.arch();
     const cpuCore = os_1.default.cpus()[0];
     const isAppleSilicon = arch === 'arm64' && /Apple (M1|M2|processor)/.test(cpuCore.model);
-    const linuxInfo = type === 'Linux' ? await getLinuxInfo() : {};
+    const linuxInfo = type === 'Linux' ? await getLinuxInfo.bind(this)() : {};
     const linuxDistro = linuxInfo.name;
     const release = linuxInfo.version || os_1.default.release();
     const majorVersion = parseInt(linuxInfo.version || '', 10) || semver_1.default.major(release);
     if (logsOpt) {
-        gluegun_1.print.info(`OS type: ${linuxDistro || type}\nOS arch: ${arch}\nOS release: ${release}\nOS major version: ${majorVersion}\nCPU model: ${cpuCore.model}`);
+        this.log(`OS type: ${linuxDistro ||
+            type}\nOS arch: ${arch}\nOS release: ${release}\nOS major version: ${majorVersion}\nCPU model: ${cpuCore.model}`);
     }
     if (arch === 'x64' || isAppleSilicon) {
         if (type === 'Darwin') {
@@ -194,8 +187,7 @@ async function getLinuxInfo() {
         return linuxInfo;
     }
     catch (error) {
-        gluegun_1.print.error(`Error fetching the Linux version:\n ${error}`);
-        process.exit(1);
+        this.error(`Error fetching the Linux version:\n${error}`, { exit: 1 });
     }
 }
 async function runDocker(datasource, opts) {
@@ -210,13 +202,13 @@ async function runDocker(datasource, opts) {
     // Get current working directory
     const current_folder = gluegun_1.filesystem.cwd();
     // Declate dockerfilePath with default location
-    const dockerfilePath = path_1.default.join(opts.testsFolder || 'tests', '.docker/Dockerfile');
+    const dockerfilePath = path_1.default.join(opts.testsDir || 'tests', '.docker/Dockerfile');
     // Check if the Dockerfil already exists
     const dockerfileExists = gluegun_1.filesystem.exists(dockerfilePath);
     // Generate the Dockerfile only if it doesn't exists,
     // version flag and/or force flag is passed.
     if (!dockerfileExists || versionOpt || forceOpt) {
-        await dockerfile(dockerfilePath, versionOpt, latestVersion);
+        await dockerfile.bind(this)(dockerfilePath, versionOpt, latestVersion);
     }
     // Run a command to check if matchstick image already exists
     (0, child_process_1.exec)('docker images -q matchstick', (_error, stdout, _stderr) => {
@@ -248,7 +240,7 @@ async function runDocker(datasource, opts) {
         if (!dockerfileExists || stdout === '' || versionOpt || forceOpt) {
             if (stdout !== '') {
                 (0, child_process_1.exec)('docker image rm matchstick', (_error, stdout, _stderr) => {
-                    gluegun_1.print.info(chalk_1.default.bold(`Removing matchstick image\n${stdout}`));
+                    this.log(`Remove matchstick image result:\n${stdout}`);
                 });
             }
             // Build a docker image. If the process has executed successfully
@@ -262,7 +254,7 @@ async function runDocker(datasource, opts) {
             });
         }
         else {
-            gluegun_1.print.info('Docker image already exists. Skipping `docker build` command.');
+            this.log('Docker image already exists. Skipping `docker build` command...');
             // Run the container from the existing matchstick docker image
             (0, child_process_1.spawn)('docker', dockerRunOpts, { stdio: 'inherit' });
         }
@@ -271,7 +263,7 @@ async function runDocker(datasource, opts) {
 // Downloads Dockerfile template from the demo-subgraph repo
 // Replaces the placeholders with their respective values
 async function dockerfile(dockerfilePath, versionOpt, latestVersion) {
-    const spinner = gluegun_1.print.spin('Generating Dockerfile...');
+    core_1.ux.action.start('Generating Dockerfile');
     try {
         // Fetch the Dockerfile template content from the demo-subgraph repo
         const content = await (0, node_fetch_1.default)('https://raw.githubusercontent.com/LimeChain/demo-subgraph/main/Dockerfile').then(response => {
@@ -286,8 +278,9 @@ async function dockerfile(dockerfilePath, versionOpt, latestVersion) {
         await gluegun_1.patching.replace(dockerfilePath, '<MATCHSTICK_VERSION>', versionOpt || latestVersion || 'unknown');
     }
     catch (error) {
-        spinner.fail(`A problem occurred while generating the Dockerfile. Please attend to the errors below:\n ${error.message}`);
-        process.exit(1);
+        this.error(`A problem occurred while generating the Dockerfile:\n${error.message}`, {
+            exit: 1,
+        });
     }
-    spinner.succeed('Successfully generated Dockerfile.');
+    core_1.ux.action.stop('Successfully generated Dockerfile');
 }

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });