Add tests for lone short and long flags

tj · shadowspawn · May 26, 2020 · Apr 25, 2020 · Apr 27, 2020 · May 2, 2020
commit af45c33ee1f5ee415b191b2252f8c05f4d0d919e
diff --git a/tests/command.helpOption.test.js b/tests/command.helpOption.test.js
@@ -1,22 +1,66 @@
 const commander = require('../');
 
-test('when helpOption has custom flags then custom flag invokes help', () => {
-  // Optional. Suppress normal output to keep test output clean.
-  const writeSpy = jest.spyOn(process.stdout, 'write').mockImplementation(() => { });
-  const program = new commander.Command();
-  program
-    .exitOverride()
-    .helpOption('--custom-help', 'custom help output');
-  expect(() => {
-    program.parse(['node', 'test', '--custom-help']);
-  }).toThrow('(outputHelp)');
-  writeSpy.mockClear();
-});
+describe('helpOption', () => {
+  let writeSpy;
+
+  beforeAll(() => {
+    // Optional. Suppress normal output to keep test output clean.
+    writeSpy = jest.spyOn(process.stdout, 'write').mockImplementation(() => { });
+  });
+
+  afterEach(() => {
+    writeSpy.mockClear();
+  });
+
+  afterAll(() => {
+    writeSpy.mockRestore();
+  });
+
+  test('when helpOption has custom flags then custom short flag invokes help', () => {
+    const program = new commander.Command();
+    program
+      .exitOverride()
+      .helpOption('-c,--custom-help', 'custom help output');
+    expect(() => {
+      program.parse(['-c'], { from: 'user' });
+    }).toThrow('(outputHelp)');
+  });
+
+  test('when helpOption has custom flags then custom long flag invokes help', () => {
+    const program = new commander.Command();
+    program
+      .exitOverride()
+      .helpOption('-c,--custom-help', 'custom help output');
+    expect(() => {
+      program.parse(['--custom-help'], { from: 'user' });
+    }).toThrow('(outputHelp)');
+  });
+
+  test('when helpOption has just custom short flag then custom short flag invokes help', () => {
+    const program = new commander.Command();
+    program
+      .exitOverride()
+      .helpOption('-c', 'custom help output');
+    expect(() => {
+      program.parse(['-c'], { from: 'user' });
+    }).toThrow('(outputHelp)');
+  });
+
+  test('when helpOption has just custom long flag then custom long flag invokes help', () => {
+    const program = new commander.Command();
+    program
+      .exitOverride()
+      .helpOption('--custom-help', 'custom help output');
+    expect(() => {
+      program.parse(['--custom-help'], { from: 'user' });
+    }).toThrow('(outputHelp)');
+  });
 
-test('when helpOption has custom description then helpInformation include custom description', () => {
-  const program = new commander.Command();
-  program
-    .helpOption('-C,--custom-help', 'custom help output');
-  const helpInformation = program.helpInformation();
-  expect(helpInformation).toMatch(/-C,--custom-help +custom help output/);
+  test('when helpOption has custom description then helpInformation include custom description', () => {
+    const program = new commander.Command();
+    program
+      .helpOption('-C,--custom-help', 'custom help output');
+    const helpInformation = program.helpInformation();
+    expect(helpInformation).toMatch(/-C,--custom-help +custom help output/);
+  });
 });
diff --git a/tests/options.flags.test.js b/tests/options.flags.test.js
@@ -2,6 +2,15 @@ const commander = require('../');
 
 // Test the various ways flags can be specified in the first parameter to `.option`
 
+test('when only short flag defined and not specified then value is undefined', () => {
+  const program = new commander.Command();
+  program
+    .option('-p', 'add pepper');
+  program.parse(['node', 'test']);
+  expect(program.p).toBeUndefined();
+});
+
+// Sanity check that pepper is not true normally, as otherwise all the following tests would pass for thr wrong reasons!
 test('when only short flag defined and specified then value is true', () => {
   const program = new commander.Command();
   program
@@ -10,7 +19,6 @@ test('when only short flag defined and specified then value is true', () => {
   expect(program.p).toBe(true);
 });
 
-// Sanity check that pepper is not true normally, as otherwise all the following tests would pass for thr wrong reasons!
 test('when only long flag defined and not specified then value is undefined', () => {
   const program = new commander.Command();
   program

diff --git a/tests/options.version.test.js b/tests/options.version.test.js
@@ -89,6 +89,18 @@ describe('.version', () => {
     }).toThrow(myVersion);
   });
 
+  test('when specify just custom short flag then display version', () => {
+    const myVersion = '1.2.3';
+    const program = new commander.Command();
+    program
+      .exitOverride()
+      .version(myVersion, '-r');
+
+    expect(() => {
+      program.parse(['node', 'test', '-r']);
+    }).toThrow(myVersion);
+  });
+
   test('when specify custom long flag then display version', () => {
     const myVersion = '1.2.3';
     const program = new commander.Command();
@@ -101,6 +113,18 @@ describe('.version', () => {
     }).toThrow(myVersion);
   });
 
+  test('when specify just custom long flag then display version', () => {
+    const myVersion = '1.2.3';
+    const program = new commander.Command();
+    program
+      .exitOverride()
+      .version(myVersion, '--revision');
+
+    expect(() => {
+      program.parse(['node', 'test', '--revision']);
+    }).toThrow(myVersion);
+  });
+
   test('when custom .version then helpInformation includes custom version help', () => {
     const myVersion = '1.2.3';
     const myVersionFlags = '-r, --revision';