--verbose flag to print configuration debugging info

Fixes #211.

Author: sgravrock

lib/command.js

@@ -79,19 +79,20 @@ function isFileArg(arg) {
 }
 
 function parseOptions(argv, isWindows) {
-  let files = [],
-      helpers = [],
-      requires = [],
-      unknownOptions = [],
-      usageErrors = [],
-      color = process.stdout.isTTY || false,
-      reporter,
-      configPath,
-      filter,
-      failFast,
-      random,
-      seed,
-      numWorkers = 1;
+  let files = [];
+  let helpers = [];
+  let requires = [];
+  let unknownOptions = [];
+  let usageErrors = [];
+  let color = process.stdout.isTTY || false;
+  let reporter;
+  let configPath;
+  let filter;
+  let failFast;
+  let random;
+  let seed;
+  let numWorkers = 1;
+  let verbose = false;
 
   for (const arg of argv) {
     if (arg === '--no-color') {
@@ -125,6 +126,8 @@ function parseOptions(argv, isWindows) {
           usageErrors.push('Argument to --parallel= must be an integer greater than 1');
         }
       }
+    } else if (arg === '--verbose') {
+      verbose = true;
     } else if (arg === '--') {
       break;
     } else if (isFileArg(arg)) {
@@ -150,6 +153,7 @@ function parseOptions(argv, isWindows) {
     random,
     seed,
     numWorkers,
+    verbose,
     usageErrors
   };
 }
@@ -168,6 +172,7 @@ async function runJasmine(Jasmine, ParallelRunner, projectBaseDir, options) {
     });
   }
 
+  runner.verbose(options.verbose);
   await runner.loadConfigFile(options.configPath || process.env.JASMINE_CONFIG_PATH);
 
   if (options.failFast !== undefined) {
@@ -307,6 +312,7 @@ function help(options) {
   print('%s\tstop Jasmine execution on spec failure', lPad('--fail-fast', 18));
   print('%s\tpath to your optional jasmine.json', lPad('--config=', 18));
   print('%s\tpath to reporter to use instead of the default Jasmine reporter', lPad('--reporter=', 18));
+  print('%s\tprint information that may be useful for debugging configuration', lPad('--verbose', 18));
   print('%s\tmarker to signal the end of options meant for Jasmine', lPad('--', 18));
   print('');
   print('The given arguments take precedence over options in your jasmine.json');

lib/jasmine.js

@@ -205,6 +205,10 @@ class Jasmine extends RunnerBase {
     }
 
     if (files && files.length > 0) {
+      if (this.isVerbose_) {
+        console.log('Overriding previous specDir and specFiles because a list of spec files was provided on the command line or as an argument to Jasmine#execute');
+      }
+
       this.specDir = '';
       this.specFiles = [];
       this.addMatchingSpecFiles(files);

lib/parallel_runner.js

@@ -120,6 +120,9 @@ class ParallelRunner extends RunnerBase {
    * @return {Promise<JasmineDoneInfo>} Promise that is resolved when the suite completes.
    */
   async execute(files, filterString) {
+    if (this.isVerbose_) {
+      console.log(`Running in parallel with ${this.numWorkers_} workers`);
+    }
     if (this.startedExecuting_) {
       throw new Error('Parallel runner instance can only be executed once');
     }
@@ -148,6 +151,10 @@ class ParallelRunner extends RunnerBase {
     }
 
     if (files && files.length > 0) {
+      if (this.isVerbose_) {
+        console.log('Overriding previous specDir and specFiles because a list of spec files was provided on the command line or as an argument to ParallelRunner#execute');
+      }
+
       this.specDir = '';
       this.specFiles = [];
       this.addMatchingSpecFiles(files);

lib/runner_base.js

@@ -54,6 +54,17 @@ class RunnerBase {
     this.showingColors = value;
   }
 
+  /**
+   * Sets whether to run in verbose mode, which prints information that may
+   * be useful for debugging configuration problems.
+   * @function
+   * @name Runner#verbose
+   * @param {boolean} value Whether to run in verbose mode
+   */
+  verbose(isVerbose) {
+    this.isVerbose_ = isVerbose;
+  }
+
   /**
    * Sets whether the console reporter should list pending specs even when there
    * are failures.
@@ -79,21 +90,34 @@ class RunnerBase {
    * @return Promise
    */
   async loadConfigFile(configFilePath) {
+    if (this.isVerbose_) {
+      console.log(`Project base dir: ${this.projectBaseDir}`);
+    }
+
     if (configFilePath) {
+      if (this.isVerbose_) {
+        console.log(`Loading config file ${configFilePath} because it was explicitly specified`);
+      }
       await this.loadSpecificConfigFile_(configFilePath);
     } else {
       let numFound = 0;
 
       for (const ext of ['json', 'js']) {
+        const candidate = `spec/support/jasmine.${ext}`;
+
         try {
-          await this.loadSpecificConfigFile_(`spec/support/jasmine.${ext}`);
+          await this.loadSpecificConfigFile_(candidate);
           numFound++;
         } catch (e) {
           if (e.code !== 'MODULE_NOT_FOUND'       // CommonJS
             && e.code !== 'ERR_MODULE_NOT_FOUND'  // ESM
             && e.code !== 'ENOENT') {             // Testdouble.js, maybe other ESM loaders too
             throw e;
           }
+
+          if (this.isVerbose_) {
+            console.log(`Tried to load config file ${candidate} but it does not exist (${e.code})`);
+          }
         }
       }
 
@@ -104,13 +128,18 @@ class RunnerBase {
           'config files. In a future version, only the first file found ' +
           'will be loaded.'
         );
+      } else if (numFound === 0 && this.isVerbose_) {
+        console.log('Did not find any config files.');
       }
     }
   }
 
   async loadSpecificConfigFile_(relativePath) {
     const absolutePath = path.resolve(this.projectBaseDir, relativePath);
     const config = await this.loader.load(absolutePath);
+    if (this.isVerbose_) {
+      console.log(`Loaded config file ${absolutePath}`);
+    }
     this.loadConfig(config);
   }
 
@@ -510,6 +539,11 @@ function addFiles(kind) {
         fileArr.push(filePath);
       });
     });
+
+    if (this.isVerbose_) {
+      console.log(`File glob for ${kind}: ${files}`);
+      console.log(`Resulting ${kind}: [${fileArr}]`);
+    }
   };
 }
 

spec/command_spec.js

@@ -56,6 +56,7 @@ describe('command', function() {
       'loadConfigFile',
       'execute',
       'showColors',
+      'verbose',
       'coreVersion',
       'clearReporters',
       'addReporter',
@@ -266,6 +267,18 @@ describe('command', function() {
         }.bind(this));
       });
 
+      it('does not enable verbose mode by default', async function() {
+        await this.run(['node', 'bin/jasmine.js']);
+        expect(this.runner.verbose).toHaveBeenCalledWith(false);
+        expect(this.runner.verbose).toHaveBeenCalledBefore(this.runner.loadConfigFile);
+      });
+
+      it('can enable verbose mode', async function() {
+        await this.run(['node', 'bin/jasmine.js', '--verbose']);
+        expect(this.runner.verbose).toHaveBeenCalledWith(true);
+        expect(this.runner.verbose).toHaveBeenCalledBefore(this.runner.loadConfigFile);
+      });
+
       it('should execute the jasmine suite', async function () {
         await this.run(['node', 'bin/jasmine.js']);
         expect(this.runner.execute).toHaveBeenCalled();