From 34234fffb9811a2c6d03fafaab2f37adc7ccbf82 Mon Sep 17 00:00:00 2001 From: Omer Bektas Date: Sun, 8 Nov 2026 14:59:10 +0300 Subject: [PATCH] fix(codegen): stop generation on failed steps --- README.md | 2 + build-utils/gen-sdk.sh | 2 + tests/gen-sdk.test.ts | 104 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 108 insertions(+) create mode 100644 tests/gen-sdk.test.ts diff --git a/README.md b/README.md index d607fe9e..139c1dab 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,8 @@ yarn install yarn gen-sdk ``` + Generation stops with a nonzero exit status if generation, transformation, linting, or formatting fails. Existing generated TypeScript files are removed before generation starts; a failed run does not restore them. + 2. Run all tests: ```bash diff --git a/build-utils/gen-sdk.sh b/build-utils/gen-sdk.sh index b8ef6ece..8a296ba1 100644 --- a/build-utils/gen-sdk.sh +++ b/build-utils/gen-sdk.sh @@ -1,3 +1,5 @@ +set -e + find src/generated -name '*.ts' -delete npx openapi-generator-cli generate -g typescript-axios \ diff --git a/tests/gen-sdk.test.ts b/tests/gen-sdk.test.ts new file mode 100644 index 00000000..4370f6ad --- /dev/null +++ b/tests/gen-sdk.test.ts @@ -0,0 +1,104 @@ +import { spawnSync } from "child_process"; +import { + existsSync, + mkdirSync, + mkdtempSync, + readFileSync, + rmSync, + writeFileSync +} from "fs"; +import { tmpdir } from "os"; +import { join, resolve } from "path"; + +describe("SDK generation failure propagation", () => { + let directory: string; + + beforeEach(() => { + directory = mkdtempSync(join(tmpdir(), "circle-codegen-")); + mkdirSync(join(directory, "src/generated"), { recursive: true }); + mkdirSync(join(directory, "bin")); + writeFileSync(join(directory, "src/generated/index.ts"), "old index\n"); + writeFileSync( + join(directory, "bin/npx"), + `#!/usr/bin/env bash +printf '%s\\n' "$1" >> calls +if [[ "$1" == openapi-generator-cli ]]; then + [[ "$FAIL_STAGE" == generator ]] && exit 23 + printf 'generated index\\n' > src/generated/index.ts +else + [[ "$FAIL_STAGE" == transform ]] && exit 29 + printf 'transformed index\\n' +fi +`, + { mode: 0o755 } + ); + writeFileSync( + join(directory, "bin/yarn"), + `#!/usr/bin/env bash +printf '%s\\n' "$1" >> calls +[[ "$FAIL_STAGE" == "$1" ]] && exit 31 +exit 0 +`, + { mode: 0o755 } + ); + }); + + afterEach(() => { + rmSync(directory, { recursive: true, force: true }); + }); + + it.each<[string, number, string[], string | null]>([ + ["generator", 23, ["openapi-generator-cli"], null], + [ + "transform", + 29, + ["openapi-generator-cli", "ts-node"], + "generated index\n" + ], + [ + "lint-fix", + 31, + ["openapi-generator-cli", "ts-node", "lint-fix"], + "transformed index\n" + ], + [ + "format", + 31, + ["openapi-generator-cli", "ts-node", "lint-fix", "format"], + "transformed index\n" + ], + [ + "", + 0, + ["openapi-generator-cli", "ts-node", "lint-fix", "format"], + "transformed index\n" + ] + ])("stops at %s (empty means success)", (stage, status, calls, index) => { + const result = spawnSync( + "bash", + ["-c", 'export PATH="$PWD/bin:$PATH"; bash "$GEN_SDK_SCRIPT"'], + { + cwd: directory, + env: { + ...process.env, + FAIL_STAGE: stage, + GEN_SDK_SCRIPT: resolve( + __dirname, + "../build-utils/gen-sdk.sh" + ).replace(/\\/g, "/") + }, + encoding: "utf8" + } + ); + expect(result.error).toBeUndefined(); + expect(result.stderr).toBe(""); + expect(result.status).toBe(status); + expect( + readFileSync(join(directory, "calls"), "utf8").trim().split("\n") + ).toEqual(calls); + const indexPath = join(directory, "src/generated/index.ts"); + expect(existsSync(indexPath) ? readFileSync(indexPath, "utf8") : null).toBe( + index + ); + }); +});