Merge pull request #59 from apiaryio/honzajavorek/test-upgrade

Test and fix the 'upgrade' command

Author: honzajavorek

cli/copyFeatures.js

@@ -10,9 +10,9 @@ const glob = require('glob');
  */
 module.exports = function copyFeatures(srcDir, dstDir, transformBasename = basename => basename) {
   glob.sync(path.join(srcDir, '*.feature')).forEach((featureSrcPath) => {
-    const featureContent = fs.readFileSync(featureSrcPath, { encoding: 'utf-8' });
+    const featureContent = fs.readFileSync(featureSrcPath, 'utf8');
     const featureBasename = path.basename(featureSrcPath);
     const featurePath = path.join(dstDir, transformBasename(featureBasename));
-    fs.writeFileSync(featurePath, featureContent, { encoding: 'utf-8' });
+    fs.writeFileSync(featurePath, featureContent, 'utf8');
   });
 };

cli/index.js

@@ -39,12 +39,15 @@ function upgrade() {
   // read the project's package.json and get currently installed version
   // of the 'dredd-hooks-template' package
   const packageDataPath = path.join(PROJECT_DIR, 'package.json');
-  const packageData = JSON.parse(fs.readFileSync(packageDataPath, { encoding: 'utf-8' }));
+  const packageData = JSON.parse(fs.readFileSync(packageDataPath, 'utf8'));
   const currentVersion = packageData.devDependencies['dredd-hooks-template'];
 
   // ask npm about the latest published version of the 'dredd-hooks-template'
   // package
-  const proc = run('npm', ['view', 'dredd-hooks-template', 'version'], { cwd: PROJECT_DIR });
+  const proc = run('npm', ['view', 'dredd-hooks-template', 'version'], {
+    cwd: PROJECT_DIR,
+    stdio: 'pipe',
+  });
   const version = proc.stdout.toString().trim();
 
   // halt in case the project already depends on the latest version
@@ -60,7 +63,17 @@ function upgrade() {
   // copy '*.feature' files from the upgraded 'dredd-hooks-template' package
   // to the project, but don't overwrite the existing feature files, add these
   // as new ones, suffixed with the 'dredd-hooks-template' version
-  copyFeatures(FEATURES_SRC_DIR, FEATURES_DIR, basename => `${basename}~${version}`);
+  copyFeatures(FEATURES_SRC_DIR, FEATURES_DIR, basename => `${basename}~v${version}`);
+
+  // inform user about what has just happened and what's the next step
+  console.log(`\
+The test suite template has been upgraded. New feature files have been copied
+to the 'features' directory, suffixed with '~v${version}'. Please go through
+them manually and update your test suite with the latest changes. Seeing the
+changes on GitHub might help as well:
+
+https://github.com/apiaryio/dredd-hooks-template/compare/v${currentVersion}...v${version}
+`);
 }
 
 

cli/run.js

@@ -6,7 +6,7 @@ const { spawnSync } = require('child_process');
  * by default and throws in case the command failed
  */
 module.exports = function run(command, args, options) {
-  const proc = spawnSync(command, args, { ...options, stdio: 'inherit' });
+  const proc = spawnSync(command, args, { stdio: 'inherit', ...options });
   if (proc.error) throw proc.error;
   if (proc.status) throw new Error(`'${[command].concat(args).join(' ')}' failed`);
   return proc;

scripts/smoke-test.js

@@ -42,6 +42,10 @@ function parseShebang(contents) {
 }
 
 
+/* ****************************************************************************
+  SET UP
+**************************************************************************** */
+
 // create a temporary directory and init an npm package there
 const testDir = fs.mkdtempSync(path.join(os.tmpdir(), 'dredd-hooks-template-test-'));
 run('npm', ['init', '--yes'], { cwd: testDir });
@@ -54,6 +58,11 @@ const tgzBasename = `${packageData.name}-${packageData.version}.tgz`;
 const tgzPath = path.join(projectDir, tgzBasename);
 run('npm', ['install', tgzPath, '--save-dev'], { cwd: testDir });
 
+
+/* ****************************************************************************
+  INITIALIZE & TEST
+**************************************************************************** */
+
 // initialize the test suite template
 run('npx', ['dredd-hooks-template', 'init'], { cwd: testDir });
 
@@ -72,14 +81,48 @@ const handlerCommand = `${path.relative(relativeBase, pythonPath)} ${path.relati
 // make custom changes to the '*.feature' files so they're able to test
 // the Python hooks (reference implementation)
 glob.sync(path.join(testDir, '**/*.feature')).forEach((featurePath) => {
-  const content = fs.readFileSync(featurePath, { encoding: 'utf-8' });
+  const content = fs.readFileSync(featurePath, 'utf8');
   const modifiedContent = uncommentPythonCodeBlocks(replacePlaceholders(content, handlerCommand));
-  fs.writeFileSync(featurePath, modifiedContent, { encoding: 'utf-8' });
+  fs.writeFileSync(featurePath, modifiedContent, 'utf8');
 });
 
 // run 'dredd-hooks-template test', should pass
 run('npx', ['dredd-hooks-template', 'test'], { cwd: testDir });
 
+
+/* ****************************************************************************
+  UPGRADE
+**************************************************************************** */
+
+// pretend 'dredd-hooks-template' is in one of the previous versions
+const projectPackagePath = path.join(testDir, 'package.json');
+const projectPackageData = fs.readJSONSync(projectPackagePath);
+projectPackageData.devDependencies['dredd-hooks-template'] = '1.0.0';
+fs.writeJSONSync(projectPackagePath, projectPackageData);
+
+// run 'dredd-hooks-template upgrade'
+const output = run('npx', ['dredd-hooks-template', 'upgrade'], {
+  cwd: testDir,
+  stdio: 'pipe',
+}).stdout.toString();
+
+// the upgrade output should contain hints
+const containsHint = output.includes('copied') && output.includes('suffixed') && output.includes('manually');
+if (!containsHint) throw new Error("Output of 'dredd-hooks-template upgrade' doesn't include hint text");
+
+// the upgrade output should contain a link to the relevant GitHub diff
+const containsLink = output.includes('https://github.com/apiaryio/dredd-hooks-template/compare/v1.0.0...');
+if (!containsLink) throw new Error("Output of 'dredd-hooks-template upgrade' doesn't include link to GitHub");
+
+// the upgrade should copy the newest files over with suffixed extensions
+const filesCopied = glob.sync(path.join(testDir, '**/*.feature~v*')).length;
+if (!filesCopied) throw new Error("Running 'dredd-hooks-template upgrade' didn't copy feature files");
+
+
+/* ****************************************************************************
+  TEAR DOWN
+**************************************************************************** */
+
 // cleanup (intentionally doesn't cleanup on exception, as then one can 'cd'
 // to the temporary directory and play with it to debug problems)
 fs.removeSync(testDir);