Add option to run commands with exit code expectation

This is in preperation of testing message merging.
badeball · Dec 17, 2023 · d53c18f · d53c18f
1 parent d3ed34d
commit d53c18f
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 3 deletions.
diff --git a/features/support/ICustomWorld.ts b/features/support/ICustomWorld.ts
@@ -1,6 +1,7 @@
 export interface ExtraOptions {
  extraArgs?: string[];
  extraEnv?: Record<string, string>;
+ expectedExitCode?: number;
 }
 
 export default interface ICustomWorld {

diff --git a/features/support/world.ts b/features/support/world.ts
@@ -33,7 +33,11 @@ export default class CustomWorld implements ICustomWorld {
  }
  | undefined;
 
- runCypress({ extraArgs = [], extraEnv = {} }: ExtraOptions = {}) {
+ runCypress({
+ extraArgs = [],
+ extraEnv = {},
+ expectedExitCode,
+ }: ExtraOptions = {}) {
  return this.runCommand({
  cmd: path.join(
  projectPath,
@@ -46,28 +50,36 @@ export default class CustomWorld implements ICustomWorld {
  NO_COLOR: "1",
  ...extraEnv,
  },
+ expectedExitCode,
  });
  }
 
- runDiagnostics({ extraArgs = [], extraEnv = {} }: ExtraOptions = {}) {
+ runDiagnostics({
+ extraArgs = [],
+ extraEnv = {},
+ expectedExitCode,
+ }: ExtraOptions = {}) {
  return this.runCommand({
  cmd: "node",
  args: [
  path.join(projectPath, bin["cypress-cucumber-diagnostics"]),
  ...extraArgs,
  ],
  extraEnv,
+ expectedExitCode,
  });
  }
 
  async runCommand({
  cmd,
  args = [],
  extraEnv = {},
+ expectedExitCode,
  }: {
  cmd: string;
  args: string[];
  extraEnv: Record<string, string>;
+ expectedExitCode?: number;
  }) {
  const child = childProcess.spawn(cmd, args, {
  stdio: ["ignore", "pipe", "pipe"],
@@ -97,7 +109,21 @@ export default class CustomWorld implements ICustomWorld {
  const stderr = stderrBuffer.getContentsAsString() || "";
  const output = outputBuffer.getContentsAsString() || "";
 
- this.verifiedLastRunError = false;
+ if (expectedExitCode != null) {
+ if (exitCode !== expectedExitCode) {
+ if (exitCode === 0) {
+ throw new Error(`Last run passed unexpectedly. Output:\n\n${output}`);
+ } else {
+ throw new Error(
+ `Last run errored unexpectedly. Output:\n\n${output}`
+ );
+ }
+ } else {
+ this.verifiedLastRunError = true;
+ }
+ } else {
+ this.verifiedLastRunError = false;
+ }
 
  this.lastRun = {
  stdout,