Test suite fails when commander error is thrown in jest even with catch

Question

I have written a script using commander. When testing this script for logical throw that cause errors I cannot seem to trap the commander error that gets thrown

Test Logic

    expect.assertions(1)

    try {
      const program = createProgram()
      program.exitOverride()
      await program.parse(['npx', 'bomci', 'artefact-save', 'some-file', 'some-folder', 'some-location' ])
    } catch(err) {
      expect(true).toBe(true)
      // put assertions here
    }

I would expect the error to be caught in the catch statement but instead I get:

CommanderError: bomci artefact-save expects the environment variable {ARTIFACTORY_USER} to be set.
    at Command._exit (/home/mbell/projects/bom-pipeline-utils/node_modules/commander/lib/command.js:449:26)
    at Command.error (/home/mbell/projects/bom-pipeline-utils/node_modules/commander/lib/command.js:1608:10)
    at Command.<anonymous> (/home/mbell/projects/bom-pipeline-utils/src/index.ts:25:21)
    at Command.listener [as _actionHandler] (/home/mbell/projects/bom-pipeline-utils/node_modules/commander/lib/command.js:482:17)
    at /home/mbell/projects/bom-pipeline-utils/node_modules/commander/lib/command.js:1300:65
    at Command._chainOrCall (/home/mbell/projects/bom-pipeline-utils/node_modules/commander/lib/command.js:1197:12)
    at Command._parseCommand (/home/mbell/projects/bom-pipeline-utils/node_modules/commander/lib/command.js:1300:27)
    at /home/mbell/projects/bom-pipeline-utils/node_modules/commander/lib/command.js:1081:27
    at Command._chainOrCall (/home/mbell/projects/bom-pipeline-utils/node_modules/commander/lib/command.js:1197:12)
    at Command._dispatchSubcommand (/home/mbell/projects/bom-pipeline-utils/node_modules/commander/lib/command.js:1077:23) {
  code: 'commander.error',
  exitCode: 9,
  nestedError: undefined
}

The line triggering the error is:

      let artiCreds
      try {
        artiCreds = getArtifactoryCredentials('artefact-save')
      } catch (err) {
        program.error(err.message, { exitCode: 9 })
      }

So why is my error not getting caught and how can I trap this error for my testing?

What are createProgram and getArtifactoryCredentials? Your code is incomplete. — Lin Du
– Lin Du, Commented Aug 17, 2023 at 2:10

user3559247 · Accepted Answer · 2023-08-15 01:25:41Z

1

After a lot of digging around I found that for commander if your action is asynchronous you need to parseAsync instead of parse

The following test now works correctly for me:

    const program = createProgram()
    program.exitOverride()
    expect(() => program.parseAsync(['npx', 'bomci', 'artefact-save', 'some-file', 'some-folder', 'some-location' ]))
      .rejects.toEqual(new CommanderError(9 , '', 'bomci artefact-save expects the environment variable {ARTIFACTORY_USER} to be set.'))

answered Aug 15, 2023 at 1:25

user3559247

1,2282 gold badges12 silver badges24 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

shadowspawn Over a year ago

Note also: if your program has subcommands, the inherited settings like for exitOverride are inherited as the subcommands are added to the program. So calling program.exitOverride() on a program after the subcommands are added only affects the root command.

Collectives™ on Stack Overflow

Test suite fails when commander error is thrown in jest even with catch

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related