Fix CI breaking on new release (#770)

* remove this commit: Fake version to break CI

* refactor: Extract tests/utils function to execute CLI commands

* fix: Make init 'From contract' (scaffold) tests work

The 'From contract' `init` tests would fail whenever the
`package.json`'s version gets updated.

That's because `init` would try to install the version
generated from the `scaffold` base `package.json` (current in branch).

To fix this we'll be using `npm link` from now on **only** for the tests.

1. We do a `npm link` on `graph-cli` itself (root of the repo);
2. Then we run `npm link @graphprotocol/graph-cli` on each `from-contract`
  folder.

We also removed the `@graphprotocol/graph-cli` from the `scaffold` if
there's a `GRAPH_CLI_TESTS` env var set.

* fix: Make init 'From example' tests work

Similar principle from the 'From contract' tests fix,
however for this one we **also** needed to modify the
cloned repo's `package.json` to remove the `graph-cli`
dependency, and add it via `npm link` (setup from previous commit).

* remove this commit: Revert fake version that broke CI

* refactor: Move GRAPH_CLI_TESTS env var to jest setup

This is so that you don't have to set this env var
manually when running the tests locally.

Author: evaporei

jest.config.js

@@ -49,10 +49,10 @@ module.exports = {
   // forceCoverageMatch: [],
 
   // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: null,
+  globalSetup: './tests/cli/globalSetup',
 
   // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: null,
+  globalTeardown: './tests/cli/globalTeardown',
 
   // A set of global variables that need to be available in all test environments
   // globals: {},

src/commands/init.js

@@ -538,12 +538,26 @@ const initRepository = async (toolbox, directory) =>
     },
   )
 
+// Only used for local testing / continuous integration.
+//
+// This requires that the command `npm link` is called
+// on the root directory of this repository, as described here:
+// https://docs.npmjs.com/cli/v7/commands/npm-link.
+const npmLinkToLocalCli = async (toolbox, directory) => {
+  if (process.env.GRAPH_CLI_TESTS) {
+    await toolbox.system.run('npm link @graphprotocol/graph-cli', { cwd: directory })
+  }
+}
+
 const installDependencies = async (toolbox, directory, installCommand) =>
   await withSpinner(
     `Install dependencies with ${toolbox.print.colors.muted(installCommand)}`,
     `Failed to install dependencies`,
     `Warnings while installing dependencies`,
     async spinner => {
+      // Links to local graph-cli if we're running the automated tests
+      await npmLinkToLocalCli(toolbox, directory)
+
       await toolbox.system.run(installCommand, { cwd: directory })
       return true
     },
@@ -651,6 +665,11 @@ const initSubgraphFromExample = async (
         delete pkgJson['license']
         delete pkgJson['repository']
 
+        // Remove example's cli in favor of the local one (added via `npm link`)
+        if (process.env.GRAPH_CLI_TESTS) {
+          delete pkgJson['devDependencies']['@graphprotocol/graph-cli']
+        }
+
         // Write package.json
         await filesystem.write(pkgJsonFilename, pkgJson, { jsonIndent: 2 })
         return true

src/scaffold.js

@@ -18,6 +18,13 @@ const abiEvents = abi =>
     setName: (event, name) => event.set('_alias', name),
   })
 
+const graphCliVersion = process.env.GRAPH_CLI_TESTS
+  // JSON.stringify should remove this key, we will install the local
+  // graph-cli for the tests using `npm link` instead of fetching from npm.
+  ? undefined
+  // For scaffolding real subgraphs
+  : `${module.exports.version}`
+
 // package.json
 
 const generatePackageJson = ({ subgraphName, node }) =>
@@ -41,7 +48,7 @@ const generatePackageJson = ({ subgraphName, node }) =>
           subgraphName,
       },
       dependencies: {
-        '@graphprotocol/graph-cli': `${module.exports.version}`,
+        '@graphprotocol/graph-cli': graphCliVersion,
         '@graphprotocol/graph-ts': `0.22.1`,
       },
     }),

tests/cli/globalSetup.js

@@ -0,0 +1,6 @@
+const { npmLinkCli } = require('./util')
+
+module.exports = async () => {
+  process.env.GRAPH_CLI_TESTS = '1'
+  await npmLinkCli()
+}

tests/cli/globalTeardown.js

@@ -0,0 +1,6 @@
+const { npmUnlinkCli } = require('./util')
+
+module.exports = async () => {
+  delete process.env.GRAPH_CLI_TESTS
+  await npmUnlinkCli()
+}

tests/cli/init.test.js

@@ -1,6 +1,6 @@
 const fs = require('fs-extra')
 const path = require('path')
-const cliTest = require('./util').cliTest
+const { cliTest } = require('./util')
 
 describe('Init', () => {
   let baseDir = path.join(__dirname, 'init')

tests/cli/util.js

@@ -13,7 +13,7 @@ const cliTest = (title, args, testPath, options) => {
       let cwd =
         options !== undefined && options.cwd ? options.cwd : resolvePath(`./${testPath}`)
 
-      let [exitCode, stdout, stderr] = await runCli(args, cwd)
+      let [exitCode, stdout, stderr] = await runGraphCli(args, cwd)
 
       let expectedExitCode = undefined
       if (options !== undefined && options.exitCode !== undefined) {
@@ -55,18 +55,14 @@ const cliTest = (title, args, testPath, options) => {
   )
 }
 
-const runCli = async (args = [], cwd = process.cwd()) => {
-  // Resolve the path to graph.js
-  let graphCli = path.join(__dirname, '..', '..', 'bin', 'graph')
-
+const runCommand = async (command, args = [], cwd = process.cwd()) => {
   // Make sure to set an absolute working directory
   cwd = cwd[0] !== '/' ? path.resolve(__dirname, cwd) : cwd
 
   return new Promise((resolve, reject) => {
     let stdout = ''
     let stderr = ''
-    const command = `${graphCli} ${args.join(' ')}`
-    const child = spawn(command, { cwd })
+    const child = spawn(`${command} ${args.join(' ')}`, { cwd })
 
     child.on('error', error => {
       reject(error)
@@ -86,7 +82,20 @@ const runCli = async (args = [], cwd = process.cwd()) => {
   })
 }
 
+const runGraphCli = async (args, cwd) => {
+  // Resolve the path to graph.js
+  let graphCli = path.join(__dirname, '..', '..', 'bin', 'graph')
+
+  return await runCommand(graphCli, args, cwd)
+}
+
+const npmLinkCli = () => runCommand('npm', ['link'])
+
+const npmUnlinkCli = () => runCommand('npm', ['unlink'])
+
 module.exports = {
   cliTest,
-  runCli,
+  npmLinkCli,
+  npmUnlinkCli,
+  runGraphCli,
 }