feat: pnpm compatible, manually invoke mdep install

Author: AVVS

.gitattributes

@@ -0,0 +1,4 @@
+pnpm-lock.yaml               merge=text
+shrinkwrap.yaml              merge=binary
+npm-shrinkwrap.json          merge=binary
+yarn.lock                    merge=binary

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npx --no-install commitlint --edit $1
+"$(dirname "$0")/../node_modules/.bin/commitlint" --edit $1

.mdeprc.js

@@ -1,8 +1,6 @@
 /* eslint-disable no-template-curly-in-string */
 const execa = require('execa');
 
-const yarnCache = execa.commandSync('yarn cache dir').stdout;
-
 module.exports = {
   nycCoverage: false,
   test_framework: 'jest --coverage --coverageDirectory <coverageDirectory> --runTestsByPath --maxWorkers=50% --verbose --colors',
@@ -27,12 +25,10 @@ module.exports = {
         CHROME_PATH: '/usr/bin/chromium-browser',
         DEBUG: "${DEBUG:-''}",
       },
-      volumes: [
-        `${yarnCache}:/tmp/yarn-cache/v6:ro`,
-      ],
     },
   },
   arbitrary_exec: [
-    'apk add git',
+    'apk add git curl',
+    'npm i --global pnpm@6'
   ],
 };

.npmrc

@@ -0,0 +1,2 @@
+access = public
+hoist = false

__tests__/install.spec.js

@@ -2,15 +2,13 @@
 
 const { directory } = require('tempy');
 const { resolve } = require('path');
-const { promisify } = require('util');
 const set = require('lodash.set');
-const stripEOF = require('strip-final-newline');
 const fs = require('fs/promises');
 const debug = require('debug')('test');
-const execFile = promisify(require('child_process').execFile);
+const execa = require('execa');
 
-describe('test installing the package', () => {
-  const kFilename = 'deploy.tgz';
+describe('(yarn) test installing the package', () => {
+  const kFilename = 'deploy-yarn.tgz';
   const cwd = process.cwd();
   const tarball = resolve(cwd, kFilename);
   const clean = async () => {
@@ -23,11 +21,10 @@ describe('test installing the package', () => {
 
   beforeAll(async () => {
     await clean();
-    await execFile('yarn', ['config', 'set', 'preferred-cache-folder', '/tmp/yarn-cache']);
-    await execFile('yarn', ['config', 'set', 'cache-folder', '/tmp/yarn-cache-internal']);
-    await execFile('yarn', ['config', 'set', 'prefer-offline', 'true']);
-    const { stdout } = await execFile('yarn', ['pack', '--filename', kFilename]);
-    console.info(stdout);
+    await execa('yarn', ['config', 'set', 'preferred-cache-folder', '/tmp/yarn-cache']);
+    await execa('yarn', ['config', 'set', 'cache-folder', '/tmp/yarn-cache-internal']);
+    await execa('yarn', ['config', 'set', 'prefer-offline', 'true']);
+    await execa('yarn', ['pack', '--filename', kFilename]);
   });
 
   describe('local install', () => {
@@ -36,21 +33,160 @@ describe('test installing the package', () => {
     beforeAll(async () => {
       debug('changing to %s', tmpDir);
       process.chdir(tmpDir);
-      await execFile('yarn', ['init', '-yp']);
-      await execFile('git', ['init']);
+      await execa('yarn', ['init', '-yp']);
+      await execa('git', ['init']);
     });
 
     test('is able to install package locally', async () => {
-      await execFile('yarn', ['add', tarball, '--no-lockfile']);
+      await execa('yarn', ['add', tarball, '--no-lockfile']);
+      await execa('yarn', ['mdep', 'install']);
     }, 240000);
 
     test('returns node version', async () => {
-      const { stdout } = await execFile('node_modules/.bin/mdep', ['get-config', 'node', '--node', '99.0.0']);
-      expect(stripEOF(stdout)).toBe('99.0.0');
+      const { stdout } = await execa('node_modules/.bin/mdep', ['get-config', 'node', '--node', '99.0.0']);
+      expect(stdout).toBe('99.0.0');
     });
 
     test('package.json enhanced', async () => {
-      const pkg = require(`${tmpDir}/package.json`); // eslint-disable-line import/no-dynamic-require
+      const pkg = JSON.parse(await fs.readFile(`${tmpDir}/package.json`));
+      expect(pkg.scripts['semantic-release']).toBeDefined();
+      expect(pkg.husky).toBeUndefined();
+    });
+
+    test('.husky create', async () => {
+      expect((await fs.stat('.husky')).isDirectory()).toBe(true);
+      expect((await fs.stat('.husky/_/husky.sh')).isFile()).toBe(true);
+      expect((await fs.stat('.husky/commit-msg')).isFile()).toBe(true);
+      expect((await fs.stat('.husky/prepare-commit-msg')).isFile()).toBe(true);
+    });
+
+    test('releaserc & commitlint copied over', async () => {
+      expect((await fs.stat('.releaserc.json')).isFile()).toBe(true);
+      expect((await fs.stat('.commitlintrc.js')).isFile()).toBe(true);
+    });
+
+    test('on reinstall doesnt overwrite existing .releaserc.js(on)', async () => {
+      expect.assertions(1);
+
+      await fs.writeFile('.releaserc.json', 'overwrite');
+      const { stderr } = await execa('yarn', ['add', tarball, '--no-lockfile']);
+      debug(stderr);
+      await expect(fs.readFile('.releaserc.json', 'utf8')).resolves.toBe('overwrite');
+    }, 240000);
+
+    test('on reinstall doesnt overwrite existing .commitlintrc.js', async () => {
+      expect.assertions(1);
+
+      await fs.writeFile('.commitlintrc.js', 'overwrite');
+      await execa('yarn', ['add', tarball, '--no-lockfile']);
+      await expect(fs.readFile('.commitlintrc.js', 'utf8')).resolves.toBe('overwrite');
+    }, 240000);
+  });
+
+  describe('local install (husky migration)', () => {
+    const tmpDir = directory();
+
+    beforeAll(async () => {
+      debug('changing to %s', tmpDir);
+      process.chdir(tmpDir);
+      await execa('yarn', ['init', '-yp']);
+      await execa('git', ['init']);
+
+      const pkgName = `${tmpDir}/package.json`;
+      const pkg = JSON.parse(await fs.readFile(pkgName));
+      set(pkg, 'husky.hooks.commit-msg', 'commitlint -e $HUSKY_GIT_PARAMS');
+      await fs.writeFile(pkgName, JSON.stringify(pkg, null, 2));
+    });
+
+    test('is able to install package locally', async () => {
+      await execa('yarn', ['add', tarball, '--no-lockfile']);
+      await execa('yarn', ['mdep', 'install']);
+    }, 240000);
+
+    test('package.json enhanced, no husky', async () => {
+      const pkg = JSON.parse(await fs.readFile(`${tmpDir}/package.json`));
+      expect(pkg.husky).toBeUndefined();
+    });
+
+    test('.husky files present', async () => {
+      expect((await fs.stat('.husky')).isDirectory()).toBe(true);
+      expect((await fs.stat('.husky/_/husky.sh')).isFile()).toBe(true);
+      expect((await fs.stat('.husky/commit-msg')).isFile()).toBe(true);
+      expect((await fs.stat('.husky/prepare-commit-msg')).isFile()).toBe(true);
+
+      const files = await fs.readdir('.husky');
+      expect(files.length).toBe(3);
+    });
+
+    test('.husky files content sane', async () => {
+      const contents = await fs.readFile('.husky/commit-msg', { encoding: 'utf8' });
+      expect(contents).toContain('npx --no-install commitlint -e $1');
+    });
+  });
+
+  describe('installs globally', () => {
+    test('is able to install package globally', async () => {
+      await execa('yarn', ['global', 'add', tarball, '--no-lockfile']);
+    }, 240000);
+
+    test('returns current node version in module', async () => {
+      process.chdir(cwd);
+      const { stdout } = await execa('mdep', ['get-config', '--path', 'node']);
+      expect(stdout).toBe('16');
+    });
+  });
+
+  afterAll(clean);
+});
+
+describe('(pnpm) test installing the package', () => {
+  const kFilename = 'makeomatic-deploy-0.0.0-development.tgz';
+  const cwd = process.cwd();
+  const tarball = resolve(cwd, kFilename);
+  const clean = async () => {
+    try {
+      await fs.rm(tarball);
+    } catch (e) {
+      process.stderr.write(`nothing to cleanup ~ ${tarball}\n`);
+    }
+  };
+
+  beforeAll(async () => {
+    await clean();
+    await execa('pnpm', ['pack']);
+  });
+
+  describe('local install', () => {
+    const tmpDir = directory();
+
+    beforeAll(async () => {
+      debug('changing to %s', tmpDir);
+      process.chdir(tmpDir);
+      await execa('pnpm', ['init', '-yp']);
+      await execa('git', ['init']);
+    });
+
+    test('is able to install package locally', async () => {
+      const proc = execa('pnpm', ['add', tarball], {
+        buffer: false,
+        cwd: tmpDir,
+        all: true,
+        env: {
+          DEBUG: 'makeomatic:deploy',
+        },
+      });
+      proc.all.pipe(process.stdout);
+      await proc;
+      await execa('pnpm', ['mdep', 'install']);
+    }, 240000);
+
+    test('returns node version', async () => {
+      const { stdout } = await execa('node_modules/.bin/mdep', ['get-config', 'node', '--node', '99.0.0']);
+      expect(stdout).toBe('99.0.0');
+    });
+
+    test('package.json enhanced', async () => {
+      const pkg = JSON.parse(await fs.readFile(`${tmpDir}/package.json`));
       expect(pkg.scripts['semantic-release']).toBeDefined();
       expect(pkg.husky).toBeUndefined();
     });
@@ -71,7 +207,7 @@ describe('test installing the package', () => {
       expect.assertions(1);
 
       await fs.writeFile('.releaserc.json', 'overwrite');
-      const { stderr } = await execFile('yarn', ['add', tarball, '--no-lockfile']);
+      const { stderr } = await execa('pnpm', ['add', tarball]);
       debug(stderr);
       await expect(fs.readFile('.releaserc.json', 'utf8')).resolves.toBe('overwrite');
     }, 240000);
@@ -80,7 +216,7 @@ describe('test installing the package', () => {
       expect.assertions(1);
 
       await fs.writeFile('.commitlintrc.js', 'overwrite');
-      await execFile('yarn', ['add', tarball, '--no-lockfile']);
+      await execa('pnpm', ['add', tarball]);
       await expect(fs.readFile('.commitlintrc.js', 'utf8')).resolves.toBe('overwrite');
     }, 240000);
   });
@@ -91,8 +227,8 @@ describe('test installing the package', () => {
     beforeAll(async () => {
       debug('changing to %s', tmpDir);
       process.chdir(tmpDir);
-      await execFile('yarn', ['init', '-yp']);
-      await execFile('git', ['init']);
+      await execa('pnpm', ['init', '-yp']);
+      await execa('git', ['init']);
 
       const pkgName = `${tmpDir}/package.json`;
       const pkg = JSON.parse(await fs.readFile(pkgName));
@@ -101,7 +237,17 @@ describe('test installing the package', () => {
     });
 
     test('is able to install package locally', async () => {
-      await execFile('yarn', ['add', tarball, '--no-lockfile']);
+      const proc = execa('pnpm', ['add', tarball], {
+        buffer: false,
+        cwd: tmpDir,
+        all: true,
+        env: {
+          DEBUG: 'makeomatic:deploy',
+        },
+      });
+      proc.all.pipe(process.stdout);
+      await proc;
+      await execa('pnpm', ['mdep', 'install']);
     }, 240000);
 
     test('package.json enhanced, no husky', async () => {
@@ -127,13 +273,13 @@ describe('test installing the package', () => {
 
   describe('installs globally', () => {
     test('is able to install package globally', async () => {
-      await execFile('yarn', ['global', 'add', tarball, '--no-lockfile']);
+      await execa('pnpm', ['-g', 'add', tarball]);
     }, 240000);
 
     test('returns current node version in module', async () => {
       process.chdir(cwd);
-      const { stdout } = await execFile('mdep', ['get-config', '--path', 'node']);
-      expect(stripEOF(stdout)).toBe('16');
+      const { stdout } = await execa('mdep', ['get-config', '--path', 'node']);
+      expect(stdout).toBe('16');
     });
   });
 

bin/cmds/get-config.js

@@ -1,4 +1,4 @@
-const { get } = require('lodash');
+const get = require('lodash.get');
 
 exports.command = 'get-config [path]';
 exports.desc = 'return mdeprc properties';

bin/cmds/install.js

@@ -0,0 +1,10 @@
+const execa = require('execa');
+const { resolve } = require('path');
+
+exports.command = 'install';
+exports.desc = 'install husky, performs auto migration';
+exports.handler = async () => {
+  const proc = execa('node', [resolve(__dirname, '../../scripts/setup-semantic-release.js')], { all: true, buffer: false });
+  proc.all.pipe(process.stdout);
+  await proc;
+};

bin/cmds/test_cmds/init.js

@@ -5,7 +5,8 @@
 
 const path = require('path');
 const fs = require('fs');
-const { get, set } = require('lodash');
+const get = require('lodash.get');
+const set = require('lodash.set');
 const { cp, test } = require('shelljs');
 
 exports.command = 'init';

bin/cmds/test_cmds/run.js

@@ -8,11 +8,11 @@ const glob = require('glob');
 const execa = require('execa');
 const { echo, exit } = require('shelljs');
 const { Client } = require('undici');
-// const { resolve } = require('path');
 const split = require('split2');
 const { pipeline: _pipeline, Writable } = require('stream');
 const { promisify } = require('util');
 const { deserializeError } = require('serialize-error');
+const assert = require('assert');
 
 const pipeline = promisify(_pipeline);
 const debug = require('debug')('test');
@@ -84,14 +84,25 @@ exports.handler = async (argv) => {
   let dockerExec;
   if (argv.http) {
     const getSocketId = async (attempt = 0) => {
-      try {
-        const { stdout } = await execAsync('docker', ['logs', container]);
-        return JSON.parse(stdout.split('\n').pop()).socketId;
-      } catch (e) {
-        if (attempt > 10) throw e;
-        await new Promise((resolve) => setTimeout(resolve, 500));
-        return getSocketId(attempt + 1);
+      const { stdout } = await execAsync('docker', ['logs', container]);
+      const lines = stdout.split('\n');
+
+      let line;
+      // eslint-disable-next-line no-cond-assign
+      while ((line = lines.pop()) !== undefined) {
+        try {
+          const { socketId } = JSON.parse(line);
+          assert(socketId);
+          return socketId;
+        } catch (e) {
+          // ignore line, check previous
+        }
       }
+
+      if (attempt > 20) throw new Error('cant get socket id after 20s');
+
+      await new Promise((resolve) => setTimeout(resolve, 1000));
+      return getSocketId(attempt + 1);
     };
 
     const socketId = await getSocketId();