Merge pull request #55 from apiaryio/honzajavorek/running-hooks-handler

Allow running hooks handler using command and/or relative path

Author: honzajavorek

features/execution_order.feature

@@ -1,8 +1,7 @@
 Feature: Execution order
 
   Background:
-    Given I have "{{my-executable-path}}" command installed
-    And I have "dredd" command installed
+    Given I have Dredd installed
     And a file named "server.js" with:
       """
       require('http')

features/failing_transaction.feature

@@ -1,8 +1,7 @@
 Feature: Failing a transaction
 
   Background:
-    Given I have "{{my-executable-path}}" command installed
-    And I have "dredd" command installed
+    Given I have Dredd installed
     And a file named "server.js" with:
       """
       require('http')

features/hook_handlers.feature

@@ -1,8 +1,7 @@
 Feature: Hook handlers
 
   Background:
-    Given I have "{{my-executable-path}}" command installed
-    And I have "dredd" command installed
+    Given I have Dredd installed
     And a file named "server.js" with:
       """
       require('http')

features/multiple_hookfiles.feature

@@ -1,8 +1,7 @@
 Feature: Multiple hook files with a glob
 
   Background:
-    Given I have "{{my-executable-path}}" command installed
-    And I have "dredd" command installed
+    Given I have Dredd installed
     And a file named "server.js" with:
       """
       require('http')

features/support/steps.js

@@ -16,13 +16,10 @@ const {
 } = require('cucumber');
 
 
-const DREDD_BIN = path.join(process.cwd(), 'node_modules', '.bin', 'dredd');
-
-
 Before(function hook() {
   this.dir = fs.mkdtempSync(path.join(os.tmpdir(), 'dredd-hooks-template-'));
+  this.dreddBin = path.join(process.cwd(), 'node_modules', '.bin', 'dredd');
   this.env = { ...process.env };
-  this.commands = [];
   this.dataSent = '';
 });
 
@@ -32,11 +29,8 @@ After(async function hook() {
 });
 
 
-Given(/^I have "([^"]+)" command installed$/, (match) => {
-  const command = match === 'dredd'
-    ? DREDD_BIN
-    : match;
-  which.sync(command); // throws if the command is not found
+Given('I have Dredd installed', function step() {
+  which.sync(this.dreddBin); // throws if not found
 });
 
 Given(/^a file named "([^"]+)" with:$/, function step(filename, content) {
@@ -48,9 +42,8 @@ Given(/^I set the environment variables to:$/, function step(env) {
 });
 
 
-When(/^I run `([^`]+)`$/, function step(match) {
-  const command = match.replace(/^dredd(?= )/, DREDD_BIN);
-  this.proc = childProcess.spawnSync(command, [], {
+When(/^I run `dredd ([^`]+)`$/, function step(args) {
+  this.proc = childProcess.spawnSync(`${this.dreddBin} ${args}`, [], {
     shell: true,
     cwd: this.dir,
     env: this.env,

scripts/smoke-test.js

@@ -2,14 +2,15 @@ const os = require('os');
 const fs = require('fs-extra');
 const path = require('path');
 const glob = require('glob');
+const which = require('which');
 
 const packageData = require('../package');
 const run = require('../cli/run');
 
 
-function replacePlaceholders(content) {
+function replacePlaceholders(content, handlerCommand = 'dredd-hooks-python') {
   return content
-    .replace(/\{\{my-executable-path\}\}/g, 'dredd-hooks-python')
+    .replace(/\{\{my-executable-path\}\}/g, handlerCommand)
     .replace(/import hooks/g, 'import dredd_hooks as hooks')
     .replace(/\.\{\{my-extension\}\}/g, '.py');
 }
@@ -34,6 +35,12 @@ function uncommentPythonCodeBlocks(content) {
     .join('\n');
 }
 
+// https://en.wikipedia.org/wiki/Shebang_(Unix)
+function parseShebang(contents) {
+  const shebang = contents.toString().split(/[\r\n]+/)[0];
+  return shebang.replace(/^#!/, '');
+}
+
 
 // create a temporary directory and init an npm package there
 const testDir = fs.mkdtempSync(path.join(os.tmpdir(), 'dredd-hooks-template-test-'));
@@ -50,11 +57,23 @@ run('npm', ['install', tgzPath, '--save-dev'], { cwd: testDir });
 // initialize the test suite template
 run('npx', ['dredd-hooks-template', 'init'], { cwd: testDir });
 
+// find out what is the relative path to the Python hooks executable so
+// we can use it in the test suite (with Python hooks this is not necessary,
+// plain 'dredd-hooks-python' would work fine, but we want to test here that
+// relative paths and complex commands work with the test suite)
+//
+// (instead of 'dredd-hooks-python', the handler command is going to be
+// something like '../…/bin/python ../…/bin/dredd-hooks-python')
+const executablePath = which.sync('dredd-hooks-python');
+const pythonPath = parseShebang(fs.readFileSync(executablePath));
+const relativeBase = path.join(testDir, 'package.json');
+const handlerCommand = `${path.relative(relativeBase, pythonPath)} ${path.relative(relativeBase, executablePath)}`;
+
 // 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 modifiedContent = uncommentPythonCodeBlocks(replacePlaceholders(content));
+  const modifiedContent = uncommentPythonCodeBlocks(replacePlaceholders(content, handlerCommand));
   fs.writeFileSync(featurePath, modifiedContent, { encoding: 'utf-8' });
 });