@invarn/cibuild 2.9.4 → 2.9.7

package/dist/src/yaml/step-validator-self-assigned.test.js

@@ -1,191 +0,0 @@
-/**
- * A step does not owe itself the variables its own shell sets.
- *
- * Pre-execution validation auto-discovers every `$UPPERCASE` in a step's
- * inputs and treats it as a value the pipeline must supply. For a `script`
- * step the inputs *are* the shell body, so a variable the script computes was
- * indistinguishable from one it needed handed to it — and because the check
- * cannot prompt in a sandbox, the pipeline was refused before step 1 for
- * values nothing was ever meant to provide.
- *
- * A generated multiplatform pipeline hit exactly that. Its prepare step opens
- * with `INTEGRATION="$KMM_IOS_INTEGRATION"`, `IOS_DIR=$(dirname
- * "$IOS_PROJECT_PATH")` and `for WORKSPACE in "$IOS_DIR"/*.xcworkspace`, and
- * the run died on "3 required value(s) missing — INTEGRATION, IOS_DIR,
- * WORKSPACE" while the two variables it genuinely reads were both declared and
- * present. The iOS templates do the same thing with `IOS_DIR` alone.
- *
- * The load-bearing half of these tests is the second half: only the assignment
- * *target* is excused, never the right-hand side, so a script cannot exempt
- * itself from a value it reads by mentioning it.
- */
-import { describe, test, expect } from '@jest/globals';
-import '../yaml/steps/index.js';
-import { StepValidator } from './step-validator.js';
-import { EnvResolver } from './env-resolver.js';
-import { shellAssignedNames } from './shell-assignments.js';
-import { loadConfig } from '../config.js';
-const config = loadConfig();
-/** A one-script workflow, so the only issues are about its variables. */
-function scriptPipeline(content, envs = {}) {
-    return {
-        format_version: '1',
-        meta: { invarn: { stack: 'macos-xcode-26.4' } },
-        app: { envs: Object.entries(envs).map(([k, v]) => ({ [k]: v })) },
-        workflows: {
-            primary: {
-                steps: [{ 'script@1.0.0': { title: 'Prepare', inputs: { content } } }],
-            },
-        },
-    };
-}
-async function missingEnv(pipeline) {
-    const validator = new StepValidator(pipeline, 'primary', config);
-    const result = await validator.validateWorkflow();
-    return (result.issuesByCategory.get('environment') ?? [])
-        .map((i) => i.requirement.name)
-        .sort();
-}
-describe('shellAssignedNames', () => {
-    test('plain assignment, command substitution and quoted value', () => {
-        const found = shellAssignedNames({
-            content: [
-                'PLAIN=1',
-                'CAPTURED=$(dirname "$SOMEWHERE")',
-                'QUOTED="a b"',
-                'EMPTY=',
-            ].join('\n'),
-        });
-        expect([...found].sort()).toEqual(['CAPTURED', 'EMPTY', 'PLAIN', 'QUOTED']);
-    });
-    test('export, local, readonly, declare, typeset and append', () => {
-        const found = shellAssignedNames({
-            content: [
-                'export EXPORTED=1',
-                '  local SCOPED=2',
-                'readonly FROZEN=3',
-                'declare DECLARED=4',
-                'typeset TYPESET=5',
-                'APPENDED+=6',
-            ].join('\n'),
-        });
-        expect([...found].sort()).toEqual([
-            'APPENDED',
-            'DECLARED',
-            'EXPORTED',
-            'FROZEN',
-            'SCOPED',
-            'TYPESET',
-        ]);
-    });
-    test('loop and read bindings', () => {
-        const found = shellAssignedNames({
-            content: [
-                'for WORKSPACE in "$IOS_DIR"/*.xcworkspace; do echo "$WORKSPACE"; done',
-                'select CHOICE in a b; do break; done',
-                'read -r LINE',
-                'echo x | while read -r KEY VALUE; do echo "$KEY"; done',
-            ].join('\n'),
-        });
-        expect([...found].sort()).toEqual(['CHOICE', 'KEY', 'LINE', 'VALUE', 'WORKSPACE']);
-    });
-    test('a flag that looks like an assignment is not one', () => {
-        const found = shellAssignedNames({
-            content: 'xcodebuild --setting FOO=1 -destination PLATFORM=iOS\ngradlew -PSOME=2',
-        });
-        expect([...found]).toEqual([]);
-    });
-    test('walks nested inputs, not just a top-level string', () => {
-        const found = shellAssignedNames({ inputs: { content: 'NESTED=1' }, other: ['ALSO=2'] });
-        expect([...found].sort()).toEqual(['ALSO', 'NESTED']);
-    });
-});
-describe('pre-execution validation and self-assigned variables', () => {
-    // The shape that was refused, reduced to its first three lines.
-    const PREPARE = [
-        'INTEGRATION="$KMM_IOS_INTEGRATION"',
-        'IOS_DIR=$(dirname "$IOS_PROJECT_PATH")',
-        'for WORKSPACE in "$IOS_DIR"/*.xcworkspace; do echo "$WORKSPACE"; done',
-    ].join('\n');
-    test('asks for nothing when the script sets its own and the rest are declared', async () => {
-        expect(await missingEnv(scriptPipeline(PREPARE, {
-            KMM_IOS_INTEGRATION: 'direct',
-            IOS_PROJECT_PATH: 'iosApp/iosApp.xcodeproj',
-        }))).toEqual([]);
-    });
-    // The regression this relaxation could introduce, and the reason only the
-    // assignment target is excused: a script that READS a variable still needs
-    // it, even where it assigns something else from it on the same line.
-    test('still requires the right-hand side of a self-assignment', async () => {
-        expect(await missingEnv(scriptPipeline(PREPARE))).toEqual([
-            'IOS_PROJECT_PATH',
-            'KMM_IOS_INTEGRATION',
-        ]);
-    });
-    test('still requires a variable the script only reads', async () => {
-        expect(await missingEnv(scriptPipeline('SET_HERE=1\necho "$SET_HERE $NEVER_SET"'))).toEqual([
-            'NEVER_SET',
-        ]);
-    });
-});
-/**
- * The resolver half, and the worse half.
- *
- * `StepValidator` only *demands* a script's own locals. `EnvResolver`
- * SUBSTITUTES them — so a defined `IOS_DIR` would paste a pipeline value over
- * the one `dirname` had just computed, and an undefined one refuses the build.
- * Both are wrong; leaving the reference for the shell is the only correct
- * answer, and it is the same thing `registerStepOutput` already does for a
- * value a previous step exports.
- */
-describe('EnvResolver leaves a script its own locals', () => {
-    const PREPARE = [
-        'INTEGRATION="$KMM_IOS_INTEGRATION"',
-        'IOS_DIR=$(dirname "$IOS_PROJECT_PATH")',
-        'echo "$INTEGRATION in $IOS_DIR"',
-        'for WORKSPACE in "$IOS_DIR"/*.xcworkspace; do echo "$WORKSPACE"; done',
-    ].join('\n');
-    function resolver(envs) {
-        const pipeline = {
-            format_version: '1',
-            app: { envs: Object.entries(envs).map(([k, v]) => ({ [k]: v })) },
-            workflows: { primary: { steps: [] } },
-        };
-        return new EnvResolver(pipeline, pipeline.workflows.primary, 'primary', 'macos');
-    }
-    test('does not substitute or demand what the snippet assigns', () => {
-        const out = resolver({
-            KMM_IOS_INTEGRATION: 'cocoapods',
-            IOS_PROJECT_PATH: 'iosApp/iosApp.xcodeproj',
-        }).interpolate(PREPARE, 'Prepare the iOS build');
-        // The right-hand sides ARE resolved…
-        expect(out).toContain('INTEGRATION="cocoapods"');
-        expect(out).toContain('IOS_DIR=$(dirname "iosApp/iosApp.xcodeproj")');
-        // …and the locals are left for the shell, verbatim.
-        expect(out).toContain('echo "$INTEGRATION in $IOS_DIR"');
-        expect(out).toContain('for WORKSPACE in "$IOS_DIR"/*.xcworkspace');
-        expect(out).toContain('echo "$WORKSPACE"');
-    });
-    // Before the fix this threw MissingEnvironmentVariableError for INTEGRATION,
-    // which is what stopped every generated KMM and iOS pipeline before step 1.
-    test('does not throw for a local the snippet assigns', () => {
-        expect(() => resolver({
-            KMM_IOS_INTEGRATION: 'direct',
-            IOS_PROJECT_PATH: 'iosApp/iosApp.xcodeproj',
-        }).interpolate(PREPARE, 'Prepare the iOS build')).not.toThrow();
-    });
-    // The regression guard: a value the script only READS is still required.
-    test('still throws for a variable the snippet only reads', () => {
-        expect(() => resolver({}).interpolate(PREPARE, 'Prepare the iOS build')).toThrow(/Missing environment variable: 'KMM_IOS_INTEGRATION'/);
-    });
-    test('substitutes normally where the snippet assigns nothing', () => {
-        expect(resolver({ IOS_SCHEME: 'Hush iOS' }).interpolate('xcodebuild -scheme "$IOS_SCHEME"'))
-            .toBe('xcodebuild -scheme "Hush iOS"');
-    });
-    // `{{getenv "X"}}` is an explicit request by name, not a bare shell
-    // expansion, so it is honoured even where the snippet also assigns X.
-    test('still honours an explicit {{getenv}} for an assigned name', () => {
-        expect(resolver({ IOS_DIR: 'from-pipeline' }).interpolate('IOS_DIR=x\necho {{getenv "IOS_DIR"}}')).toContain('echo from-pipeline');
-    });
-});
-//# sourceMappingURL=step-validator-self-assigned.test.js.map

package/dist/src/yaml/step-validator.d.ts

@@ -1,67 +0,0 @@
-/**
- * Pre-execution validation orchestrator
- *
- * Validates all steps in a workflow BEFORE execution begins.
- * All validation checks are READ-ONLY and safe to run on the user's machine.
- * This enables catching all issues at once instead of failing on the first error.
- */
-import type { YAMLPipeline } from './types.js';
-import type { CIConfig } from '../types.js';
-import type { WorkflowValidationResult } from './validation-types.js';
-/**
- * StepValidator orchestrates pre-execution validation for a workflow.
- * It iterates through all steps, collects validation requirements,
- * runs pre-execution checks, and aggregates all issues.
- */
-export declare class StepValidator {
-    private pipeline;
-    private workflow;
-    private workflowName;
-    private config;
-    private envResolver;
-    private yamlFilePath?;
-    private availableOutputs;
-    private establishedPlatform;
-    private readonly spansPlatforms;
-    constructor(pipeline: YAMLPipeline, workflowName: string, config: CIConfig, yamlFilePath?: string);
-    /**
-     * Validates all steps in the workflow.
-     * Returns a complete validation result with all issues grouped by step and category.
-     */
-    validateWorkflow(): Promise<WorkflowValidationResult>;
-    /**
-     * Validates a single requirement and returns an issue if it fails
-     */
-    private validateRequirement;
-    /**
-     * Extracts all $VAR and ${VAR} variable names referenced in an object recursively.
-     *
-     * `${{ secrets.X }}` / `${{ vars.X }}` references are deliberately ignored:
-     * those are resolved by the runner-side interpolator before cibuild sees
-     * the YAML (or by the dashboard's secrets-resolver on dispatch). Without
-     * this filter the inner regex would capture `{ secrets.X ` as if it were
-     * a `${VAR}` reference, producing garbled variable names in the
-     * missing-env error output.
-     */
-    private extractVariableReferences;
-    /**
-     * Replaces all unresolved $VAR and ${VAR} references with empty string.
-     * Used as a lenient fallback when full interpolation fails, so that
-     * getValidationRequirements can detect truly-missing variables correctly.
-     *
-     * `${{ ... }}` refs are left intact — they belong to the runner-side
-     * interpolator / dashboard secrets-resolver layer, not to shell-level
-     * variable substitution. Stripping them here would destroy the YAML for
-     * any downstream consumer that still expects to see them.
-     */
-    private stripUnresolvedVars;
-    /**
-     * Parses a YAML step into a ParsedStep (simplified version of converter logic)
-     */
-    private parseStep;
-}
-/**
- * Format validation result for console output
- */
-export declare function formatValidationResult(result: WorkflowValidationResult): string;
-//# sourceMappingURL=step-validator.d.ts.map

package/dist/src/yaml/step-validator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"step-validator.d.ts","sourceRoot":"","sources":["../../../src/yaml/step-validator.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAQH,OAAO,KAAK,EAAE,YAAY,EAA4B,MAAM,YAAY,CAAC;AACzE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAGV,wBAAwB,EAGzB,MAAM,uBAAuB,CAAC;AAwB/B;;;;GAIG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAe;IAC/B,OAAO,CAAC,QAAQ,CAAe;IAC/B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,YAAY,CAAC,CAAS;IAG9B,OAAO,CAAC,gBAAgB,CAAoE;IAG5F,OAAO,CAAC,mBAAmB,CAA6B;IAKxD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAU;gBAGvC,QAAQ,EAAE,YAAY,EACtB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,QAAQ,EAChB,YAAY,CAAC,EAAE,MAAM;IA0BvB;;;OAGG;IACG,gBAAgB,IAAI,OAAO,CAAC,wBAAwB,CAAC;IAwN3D;;OAEG;YACW,mBAAmB;IAuEjC;;;;;;;;;OASG;IACH,OAAO,CAAC,yBAAyB;IAsBjC;;;;;;;;;OASG;IACH,OAAO,CAAC,mBAAmB;IAoB3B;;OAEG;IACH,OAAO,CAAC,SAAS;CA8BlB;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,wBAAwB,GAAG,MAAM,CA4D/E"}