Run CI on Windows (#494)

hasparus · web-flow · commit a1c467581656 · 2021-10-08T12:53:41.000+02:00
* Rewrite post-build to TS and run CI on Windows

* Rewrite compile-contracts.sh to TypeScript

* Prefix cli.js calls with Node to make tests work on Windows

* Fix 'yarn ENOENT' on Windows

* Change truffle.js to truffle-config.js

* Change placeholder script from 'true' which fails on Windows to 'echo ok'

* Increase ethers DataTypesInput test timeout

* Make TypeChain CLI more permissive when parsing files glob

* Update packages/typechain/src/cli/cli.ts

* Improve error message

* Fix contracts dir path in compile-contracts.ts

* Reset process.cwd before calling readdir in hardhat test

* Don't run yarn format check on Windows

* Generate missing ERC20

* Fix ci.yml

* Set global Mocha timeout to 5000ms

* Remove redundant shebang
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,8 +11,7 @@ jobs:
     strategy:
       matrix:
         node: ['12.x']
-        os: [ubuntu-latest]
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v1
@@ -37,9 +36,11 @@ jobs:
 
   test:
     strategy:
+      # When set to true, GitHub cancels all in-progress jobs if any matrix job fails.
+      fail-fast: false
       matrix:
         node: ['12.x']
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -62,14 +63,19 @@ jobs:
       - run: yarn build
       - run: yarn test
       - run: yarn format # do it at the very end because "yarn test" can generate types (which should be formatted)
+        if: runner.os == 'Linux'
+      - run: yarn format:fix
+        if: runner.os == 'Windows'
       - run: yarn typecheck # this has to happen after yarn test b/c test does type generation
       - run: yarn no-git-changes # ensure that committed types are up to date
 
   test-examples:
     strategy:
+      # When set to true, GitHub cancels all in-progress jobs if any matrix job fails.
+      fail-fast: false
       matrix:
         node: ['12.x']
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
 
     steps:
diff --git a/.gitignore b/.gitignore
@@ -25,3 +25,4 @@ examples/hardhat-truffe-v5/typechain
 packages/hardhat/test/fixture-projects/hardhat-project/contracts/TestContract2.sol
 packages/hardhat-test/cache
 packages/hardhat-test/artifacts
+yarn-error.log
diff --git a/.mocharc.js b/.mocharc.js
@@ -5,4 +5,5 @@ module.exports = {
   extension: ['ts'],
   watchExtensions: ['ts'],
   spec: ['test/**/*.test.ts'],
+  timeout: 5000,
 }
diff --git a/package.json b/package.json
@@ -20,7 +20,7 @@
     "build": "tsc --build --verbose ./tsconfig.prod.json  && wsrun -m -c post-build",
     "watch": "tsc --build --verbose --watch ./tsconfig.prod.json",
     "clean": "wsrun -c clean",
-    "compile-contracts": "./scripts/compile-contracts/compile-contracts.sh && wsrun -m -c compile-contracts",
+    "compile-contracts": "ts-node ./scripts/compile-contracts && wsrun -m -c compile-contracts",
     "test": "yarn compile-contracts && wsrun -mse -c test",
     "test:fix": "yarn lint:fix && yarn test && yarn format:fix && yarn typecheck",
     "no-git-changes": "./scripts/no-git-changes.sh",
diff --git a/packages/hardhat-test/package.json b/packages/hardhat-test/package.json
@@ -6,8 +6,8 @@
   "scripts": {
     "format": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --check \"./**/*.ts\"",
     "format:fix": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --write \"./**/*.ts\"",
-    "lint": "true",
-    "lint:fix": "true",
+    "lint": "echo ok",
+    "lint:fix": "echo ok",
     "typecheck": "tsc --noEmit --incremental false --composite false && tsc --noEmit --incremental false --composite false -p tsconfig.types.json",
     "clean": "hardhat clean && rm -f tsconfig.build.tsbuildinfo && rm -rf build",
     "generate-types": "hardhat clean && hardhat compile",
diff --git a/packages/hardhat/test/project.test.ts b/packages/hardhat/test/project.test.ts
@@ -34,13 +34,17 @@ describe('Typechain x Hardhat', function () {
   it('compiles and generates typings when not in root directory', async function () {
     const exists = existsSync(this.hre.config.typechain.outDir)
     expect(exists).toEqual(false)
+
     const oldCwd = process.cwd()
     // force change cwd to not-existing dir
     // cwd should not be used to determine output dir path
     process.cwd = () => join(oldCwd, 'src')
 
     await this.hre.run('compile')
 
+    // fsPromises.readdir uses process.cwd on Windows
+    process.cwd = originalCwd
+
     const dir = await fsPromises.readdir(this.hre.config.typechain.outDir)
     expect(dir.length).not.toEqual(0)
   })
diff --git a/packages/target-ethers-v4-test/package.json b/packages/target-ethers-v4-test/package.json
@@ -10,7 +10,7 @@
     "lint:fix": "yarn lint --fix",
     "typecheck": "tsc --noEmit --incremental false --composite false && tsc --noEmit --incremental false --composite false -p tsconfig.types.json",
     "clean": "rm -rf dist contracts/* && rm -f tsconfig.build.tsbuildinfo && rm -rf build",
-    "generate-types": "../typechain/dist/cli/cli.js --target=`pwd`/../target-ethers-v4/dist/index.js --out-dir ./types/ '../../contracts/compiled/*.abi'",
+    "generate-types": "node ../typechain/dist/cli/cli.js --target=../target-ethers-v4/dist/index.js --out-dir ./types/ '../../contracts/compiled/*.abi'",
     "test": "yarn generate-types && mocha --config ../../.mocharc.js",
     "test:fix": "yarn lint:fix && yarn format:fix && yarn test && yarn typecheck"
   },
diff --git a/packages/target-ethers-v5-test/package.json b/packages/target-ethers-v5-test/package.json
@@ -10,7 +10,7 @@
     "lint:fix": "yarn lint --fix",
     "typecheck": "tsc --noEmit --incremental false --composite false && tsc --noEmit --incremental false --composite false -p tsconfig.types.json",
     "clean": "rm -rf dist contracts/* && rm -f tsconfig.build.tsbuildinfo && rm -rf build",
-    "generate-types": "../typechain/dist/cli/cli.js --target=`pwd`/../target-ethers-v5/dist/index.js --out-dir ./types/ '../../contracts/compiled/*.abi'",
+    "generate-types": "node ../typechain/dist/cli/cli.js --target=../target-ethers-v5/dist/index.js --out-dir ./types/ '../../contracts/compiled/*.abi'",
     "test": "yarn generate-types && mocha --config ../../.mocharc.js",
     "test:fix": "yarn lint:fix && yarn format:fix && yarn test && yarn typecheck"
   },
diff --git a/packages/target-truffle-v5-test/package.json b/packages/target-truffle-v5-test/package.json
@@ -11,7 +11,7 @@
     "typecheck": "tsc --noEmit --incremental false --composite false && tsc --noEmit --incremental false --composite false -p tsconfig.types.json",
     "clean": "rm -rf dist contracts/* && rm -f tsconfig.build.tsbuildinfo && rm -rf build",
     "compile-contracts": "truffle compile",
-    "generate-types": "../typechain/dist/cli/cli.js --target=`pwd`/../target-truffle-v5/dist/index.js './build/**/*.json'",
+    "generate-types": "node ../typechain/dist/cli/cli.js --target=../target-truffle-v5/dist/index.js './build/**/*.json'",
     "test": "yarn generate-types && truffle test",
     "test:fix": "yarn lint:fix && yarn format:fix && yarn test && yarn typecheck"
   },
diff --git a/packages/target-truffle-v5-test/truffle-config.js b/packages/target-truffle-v5-test/truffle-config.js
diff --git a/packages/target-truffle-v5/package.json b/packages/target-truffle-v5/package.json
@@ -26,7 +26,7 @@
     "lint:fix": "yarn lint --fix",
     "typecheck": "tsc --noEmit --incremental false --composite false",
     "clean": "rm -rf dist && rm -f tsconfig.build.tsbuildinfo",
-    "test": "true",
+    "test": "echo ok",
     "test:fix": "yarn lint:fix && yarn format:fix && yarn test && yarn typecheck"
   },
   "peerDependencies": {
diff --git a/packages/target-web3-v1-test/package.json b/packages/target-web3-v1-test/package.json
@@ -10,7 +10,7 @@
     "lint:fix": "yarn lint --fix",
     "typecheck": "tsc --noEmit --incremental false --composite false && tsc --noEmit --incremental false --composite false -p tsconfig.types.json",
     "clean": "rm -rf dist contracts/* && rm -f tsconfig.build.tsbuildinfo && rm -rf build",
-    "generate-types": "../typechain/dist/cli/cli.js --target=`pwd`/../target-web3-v1/dist/index.js --out-dir ./types/ '../../contracts/compiled/*.abi'",
+    "generate-types": "node ../typechain/dist/cli/cli.js --target=../target-web3-v1/dist/index.js --out-dir ./types/ '../../contracts/compiled/*.abi'",
     "test": "yarn generate-types && mocha --config ../../.mocharc.js",
     "test:fix": "yarn lint:fix && yarn format:fix && yarn test && yarn typecheck"
   },
diff --git a/packages/target-web3-v1/package.json b/packages/target-web3-v1/package.json
@@ -27,7 +27,7 @@
     "lint:fix": "yarn lint --fix",
     "typecheck": "tsc --noEmit --incremental false --composite false",
     "clean": "rm -rf dist && rm -f tsconfig.build.tsbuildinfo",
-    "test": "true",
+    "test": "echo ok",
     "test:fix": "yarn lint:fix && yarn format:fix && yarn test && yarn typecheck"
   },
   "peerDependencies": {
diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json
@@ -13,7 +13,7 @@
     "lint:fix": "yarn lint --fix",
     "typecheck": "tsc --noEmit --incremental false --composite false",
     "clean": "rm -rf dist && rm -f tsconfig.build.tsbuildinfo",
-    "test": "true",
+    "true": "echo ok",
     "test:fix": "yarn lint:fix && yarn format:fix && yarn test && yarn typecheck"
   },
   "dependencies": {
diff --git a/packages/typechain/package.json b/packages/typechain/package.json
@@ -26,7 +26,7 @@
     "lint:fix": "yarn lint --fix",
     "typecheck": "tsc --noEmit --incremental false --composite false",
     "clean": "rm -rf dist && rm -f tsconfig.build.tsbuildinfo",
-    "post-build": "chmod +x ./dist/cli/cli.js && cp ../../README.md .",
+    "post-build": "ts-node scripts/post-build",
     "test": "mocha --config ../../.mocharc.js",
     "test:fix": "yarn lint:fix && yarn format:fix && yarn test && yarn typecheck"
   },
diff --git a/packages/typechain/scripts/post-build.ts b/packages/typechain/scripts/post-build.ts
@@ -0,0 +1,9 @@
+import { chmodSync, copyFileSync } from 'fs'
+import { resolve } from 'path'
+
+const packageDir = resolve(__dirname, '..')
+const distDir = resolve(packageDir, 'dist')
+const rootDir = resolve(packageDir, '..', '..')
+
+chmodSync(resolve(distDir, 'cli/cli.js'), 0o755)
+copyFileSync(resolve(rootDir, 'README.md'), resolve(packageDir, 'README.md'))
diff --git a/packages/typechain/src/cli/cli.ts b/packages/typechain/src/cli/cli.ts
@@ -12,12 +12,17 @@ async function main() {
   const cliConfig = parseArgs()
   const cwd = process.cwd()
 
+  const files = getFilesToProcess(cwd, cliConfig.files)
+  if (files.length === 0) {
+    throw new Error('No files passed.' + '\n' + `\`${cliConfig.files}\` didn't match any input files in ${cwd}`)
+  }
+
   const config: Config = {
     cwd,
     target: cliConfig.target,
     outDir: cliConfig.outDir,
-    allFiles: glob(cwd, cliConfig.files),
-    filesToProcess: glob(cwd, cliConfig.files),
+    allFiles: files,
+    filesToProcess: files,
     prettier,
     flags: {
       ...cliConfig.flags,
@@ -40,3 +45,15 @@ main().catch((e) => {
   }
   process.exit(1)
 })
+
+function getFilesToProcess(cwd: string, filesOrPattern: string[]) {
+  let res = glob(cwd, filesOrPattern)
+
+  if (res.length === 0) {
+    // If there are no files found, but first parameter is surrounded with single quotes, we try again without quotes
+    const match = filesOrPattern[0].match(/'([\s\S]*)'/)?.[1]
+    if (match) res = glob(cwd, [match])
+  }
+
+  return res
+}
diff --git a/scripts/check-examples.ts b/scripts/check-examples.ts
@@ -11,7 +11,8 @@ const failures: string[] = []
 for (const dir of readdirSync(examplesDir)) {
   console.log(`Checking example: ${dir}`)
 
-  const childProcess = spawnSync('yarn', ['--non-interactive'], {
+  const yarn = process.platform === 'win32' ? 'yarn.cmd' : 'yarn'
+  const childProcess = spawnSync(yarn, ['--non-interactive'], {
     cwd: path.resolve(examplesDir, dir),
     encoding: 'utf-8',
     env: {
@@ -20,6 +21,8 @@ for (const dir of readdirSync(examplesDir)) {
     },
   })
 
+  if (childProcess.error) throw childProcess.error
+
   if (childProcess.status === 0) {
     console.log(bold('&#9989; Success'))
     if (VERBOSE) {
diff --git a/scripts/compile-contracts.ts b/scripts/compile-contracts.ts
@@ -0,0 +1,67 @@
+import { execSync } from 'child_process'
+import { copyFileSync, mkdirSync, readdirSync, renameSync, rmdirSync } from 'fs'
+import { resolve } from 'path'
+
+const rootDir = resolve(__dirname, '..')
+const contractsDir = resolve(rootDir, 'contracts')
+const outDir = resolve(contractsDir, 'compiled')
+
+const contracts = readdirSync(contractsDir, { withFileTypes: true }).filter(
+  (d) => d.isFile() && d.name.endsWith('.sol'),
+)
+
+function main() {
+  removeOutDir()
+  generateABIs()
+  renameUglyNames()
+  copyTruffleV5()
+}
+
+main()
+
+function generateABIs() {
+  console.log('Generating ABIs')
+
+  const contractPaths = contracts.map((f) => `./contracts/${f.name}`).join(' ')
+  execSync(`yarn solcjs --abi ${contractPaths} --bin -o ./contracts/compiled/`, { cwd: rootDir })
+}
+
+function removeOutDir() {
+  console.log('Cleaning up contracts/abis')
+
+  try {
+    rmdirSync(outDir, { recursive: true })
+  } catch (e: any) {
+    if (e.code !== 'ENOENT') {
+      throw e
+    }
+  }
+}
+
+/**
+ * Rename ugly names generated by solc to something human redable.
+ * NOTE: we assume that there is only one contract per file
+ */
+function renameUglyNames() {
+  console.log('Renaming ABIs')
+
+  const files = readdirSync(outDir)
+
+  for (const file of files) {
+    const renamed = file.replace(/^__contracts_([A-Za-z0-9-]+)_sol_([A-Za-z0-9-]*)\.([a-z]+)$/, '$1.$3')
+
+    console.log(file, ' => ', renamed)
+    renameSync(resolve(outDir, file), resolve(outDir, renamed))
+  }
+}
+
+function copyTruffleV5() {
+  console.log('Copy truffle-v5 contracts')
+
+  const truffleV5ContractsDir = resolve(rootDir, 'packages/target-truffle-v5-test/contracts')
+  mkdirSync(truffleV5ContractsDir, { recursive: true })
+
+  for (const { name } of contracts) {
+    copyFileSync(resolve(contractsDir, name), resolve(truffleV5ContractsDir, name))
+  }
+}
diff --git a/scripts/compile-contracts/compile-contracts.sh b/scripts/compile-contracts/compile-contracts.sh
diff --git a/scripts/compile-contracts/rename.js b/scripts/compile-contracts/rename.js

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,5 @@ module.exports = {`
`5`	`5`	`extension: ['ts'],`
`6`	`6`	`watchExtensions: ['ts'],`
`7`	`7`	`spec: ['test/*/.test.ts'],`
	`8`	`+ timeout: 5000,`
`8`	`9`	`}`