@postman-cse/onboarding-bootstrap 0.10.0 → 0.12.0

package/tests/cli.test.ts

@@ -1,150 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-
-import { ConsoleReporter, createCliDependencies, parseCliArgs, runCli, toDotenv } from '../src/cli.js';
-import { resolveInputs } from '../src/index.js';
-
-describe('parseCliArgs', () => {
-  it('maps CLI flags into INPUT_* environment variables', () => {
-    const config = parseCliArgs(
-      [
-        '--project-name',
-        'core-payments',
-        '--spec-url=https://example.test/openapi.yaml',
-        '--postman-api-key',
-        'pmak-test',
-        '--workspace-admin-user-ids',
-        '101,102',
-        '--collection-sync-mode',
-        'version',
-        '--spec-sync-mode',
-        'version',
-        '--release-label',
-        'v1.2.3',
-        '--team-id',
-        '12345',
-        '--repo-url',
-        'https://github.com/postman-cs/postman-bootstrap-action',
-        '--result-json',
-        'tmp/result.json',
-        '--dotenv-path',
-        'tmp/result.env'
-      ],
-      {}
-    );
-
-    expect(config.inputEnv.INPUT_PROJECT_NAME).toBe('core-payments');
-    expect(config.inputEnv.INPUT_SPEC_URL).toBe('https://example.test/openapi.yaml');
-    expect(config.inputEnv.INPUT_POSTMAN_API_KEY).toBe('pmak-test');
-    expect(config.inputEnv.INPUT_WORKSPACE_ADMIN_USER_IDS).toBe('101,102');
-    expect(config.inputEnv.INPUT_COLLECTION_SYNC_MODE).toBe('version');
-    expect(config.inputEnv.INPUT_SPEC_SYNC_MODE).toBe('version');
-    expect(config.inputEnv.INPUT_RELEASE_LABEL).toBe('v1.2.3');
-    expect(config.inputEnv.INPUT_TEAM_ID).toBe('12345');
-    expect(config.inputEnv.INPUT_REPO_URL).toBe('https://github.com/postman-cs/postman-bootstrap-action');
-    expect(config.resultJsonPath).toBe('tmp/result.json');
-    expect(config.dotenvPath).toBe('tmp/result.env');
-  });
-});
-
-describe('toDotenv', () => {
-  it('formats planned outputs as POSTMAN_BOOTSTRAP_* dotenv pairs', () => {
-    const dotenv = toDotenv({
-      'workspace-id': 'ws-123',
-      'workspace-url': 'https://go.postman.co/workspace/ws-123',
-      'workspace-name': '[AF] core-payments',
-      'spec-id': 'spec-123',
-      'baseline-collection-id': 'col-baseline',
-      'smoke-collection-id': 'col-smoke',
-      'contract-collection-id': 'col-contract',
-      'collections-json': '{"baseline":"col-baseline"}',
-      'lint-summary-json': '{"errors":0}'
-    } as any);
-
-    expect(dotenv).toContain('POSTMAN_BOOTSTRAP_WORKSPACE_ID="ws-123"');
-    expect(dotenv).toContain('POSTMAN_BOOTSTRAP_SPEC_ID="spec-123"');
-    expect(dotenv).toContain('POSTMAN_BOOTSTRAP_LINT_SUMMARY_JSON="{\\"errors\\":0}"');
-  });
-});
-
-describe('ConsoleReporter', () => {
-  it('writes info, warning, and group logs to stderr', async () => {
-    const stderrSpy = vi.spyOn(console, 'error').mockImplementation(() => undefined);
-    const reporter = new ConsoleReporter();
-
-    reporter.info('hello');
-    reporter.warning('careful');
-    await reporter.group('work', async () => undefined);
-
-    expect(stderrSpy).toHaveBeenNthCalledWith(1, 'hello');
-    expect(stderrSpy).toHaveBeenNthCalledWith(2, 'warning: careful');
-    expect(stderrSpy).toHaveBeenNthCalledWith(3, '[group] work');
-
-    stderrSpy.mockRestore();
-  });
-});
-
-describe('runCli', () => {
-  it('writes only JSON payload to stdout while routing exec output to stderr', async () => {
-    const stdoutChunks: string[] = [];
-    const stderrSpy = vi.spyOn(process.stderr, 'write').mockReturnValue(true);
-
-    await runCli(
-      [
-        '--project-name',
-        'core-payments',
-        '--spec-url',
-        'https://example.test/openapi.yaml',
-        '--postman-api-key',
-        'pmak-secret',
-        '--result-json',
-        'tmp/cli-run-result.json'
-      ],
-      {
-        env: {},
-        executeBootstrap: async (inputs, dependencies) => {
-          await dependencies.exec.exec('node', ['-e', `process.stdout.write(${JSON.stringify(inputs.postmanApiKey)})`]);
-          return {
-            'workspace-id': 'ws-123',
-            'workspace-url': 'https://go.postman.co/workspace/ws-123',
-            'workspace-name': '[AF] core-payments',
-            'spec-id': 'spec-123',
-            'baseline-collection-id': 'col-baseline',
-            'smoke-collection-id': 'col-smoke',
-            'contract-collection-id': 'col-contract',
-            'collections-json': '{"baseline":"col-baseline","smoke":"col-smoke","contract":"col-contract"}',
-            'lint-summary-json': '{"errors":0,"total":0,"violations":[],"warnings":0}'
-          } as any;
-        },
-        writeStdout: (chunk) => {
-          stdoutChunks.push(chunk);
-        }
-      }
-    );
-
-    expect(stdoutChunks).toHaveLength(1);
-    const parsed = JSON.parse(stdoutChunks[0]);
-    expect(parsed['workspace-id']).toBe('ws-123');
-    const stderrCombined = stderrSpy.mock.calls.map(([entry]) => String(entry)).join('');
-    expect(stderrCombined).toContain('[REDACTED]');
-    expect(stderrCombined).not.toContain('pmak-secret');
-
-    stderrSpy.mockRestore();
-  });
-});
-
-describe('createCliDependencies', () => {
-  it('creates internal integration dependencies under token conditions', () => {
-    const inputs = resolveInputs({
-      INPUT_PROJECT_NAME: 'core-payments',
-      INPUT_SPEC_URL: 'https://example.test/openapi.yaml',
-      INPUT_POSTMAN_API_KEY: 'pmak-test',
-      INPUT_POSTMAN_ACCESS_TOKEN: 'pat-test',
-      INPUT_REPO_URL: 'https://github.com/postman-cs/postman-bootstrap-action',
-      INPUT_TEAM_ID: '12345'
-    });
-
-    const dependencies = createCliDependencies(inputs);
-
-    expect(dependencies.internalIntegration).toBeDefined();
-  });
-});

package/tests/contract.test.ts

@@ -1,123 +0,0 @@
-import { readFileSync } from 'node:fs';
-import { resolve } from 'node:path';
-import { parse } from 'yaml';
-import { describe, expect, it } from 'vitest';
-
-import {
-  openAlphaActionContract,
-  contractInputNames,
-  contractOutputNames
-} from '../src/contracts.js';
-import { createPlannedOutputs, resolveInputs } from '../src/index.js';
-
-const repoRoot = resolve(import.meta.dirname, '..');
-const actionManifest = parse(
-  readFileSync(resolve(repoRoot, 'action.yml'), 'utf8')
-) as {
-  inputs: Record<string, { required?: boolean; default?: string }>;
-  outputs: Record<string, unknown>;
-};
-
-describe('open-alpha action contract', () => {
-  it('uses kebab-case input and output names', () => {
-    const kebabCasePattern = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
-
-    for (const name of [...contractInputNames, ...contractOutputNames]) {
-      expect(name).toMatch(kebabCasePattern);
-    }
-  });
-
-  it('keeps action.yml aligned with the contract surface', () => {
-    expect(Object.keys(actionManifest.inputs)).toEqual(contractInputNames);
-    expect(Object.keys(actionManifest.outputs)).toEqual(contractOutputNames);
-  });
-
-  it('defaults integration-backend to bifrost in the contract, manifest, and runtime', () => {
-    expect(openAlphaActionContract.inputs['integration-backend'].default).toBe('bifrost');
-    expect(openAlphaActionContract.inputs['integration-backend'].allowedValues).toEqual([
-      'bifrost'
-    ]);
-    expect(actionManifest.inputs['integration-backend'].default).toBe('bifrost');
-    expect(resolveInputs({}).integrationBackend).toBe('bifrost');
-  });
-
-  it('defaults lifecycle controls in contract, manifest, and runtime', () => {
-    expect(openAlphaActionContract.inputs['collection-sync-mode'].default).toBe('refresh');
-    expect(openAlphaActionContract.inputs['collection-sync-mode'].allowedValues).toEqual([
-      'reuse',
-      'refresh',
-      'version'
-    ]);
-    expect(actionManifest.inputs['collection-sync-mode'].default).toBe('refresh');
-    expect(resolveInputs({}).collectionSyncMode).toBe('refresh');
-
-    expect(openAlphaActionContract.inputs['spec-sync-mode'].default).toBe('update');
-    expect(openAlphaActionContract.inputs['spec-sync-mode'].allowedValues).toEqual([
-      'update',
-      'version'
-    ]);
-    expect(actionManifest.inputs['spec-sync-mode'].default).toBe('update');
-    expect(resolveInputs({}).specSyncMode).toBe('update');
-
-  });
-
-  it('rejects unsupported integration backends during input resolution', () => {
-    expect(() =>
-      resolveInputs({
-        INPUT_INTEGRATION_BACKEND: 'custom'
-      })
-    ).toThrow(/Unsupported integration-backend/);
-  });
-
-  it('rejects non-HTTPS spec URLs', () => {
-    expect(() =>
-      resolveInputs({
-        'INPUT_SPEC_URL': 'http://example.com/spec.yaml'
-      })
-    ).toThrow(/spec-url must be a valid HTTPS URL/);
-  });
-
-  it('documents the retained bootstrap steps and removed internal-only behavior', () => {
-    expect(openAlphaActionContract.retainedBehavior).toContain('spec linting by UID');
-    expect(openAlphaActionContract.retainedBehavior).toContain('workspace creation');
-    expect(openAlphaActionContract.retainedBehavior).toContain(
-      'governance group assignment'
-    );
-    expect(openAlphaActionContract.removedBehavior).toContain('step mode');
-    expect(openAlphaActionContract.removedBehavior).toContain(
-      'aws, docker, and infra workflow concerns'
-    );
-  });
-
-  it('builds placeholder outputs that match the public open-alpha output surface', () => {
-    const outputs = createPlannedOutputs(
-      resolveInputs({
-        INPUT_PROJECT_NAME: 'core-payments',
-        INPUT_DOMAIN_CODE: 'AF',
-        INPUT_SPEC_URL: 'https://example.com/openapi.yaml',
-        INPUT_POSTMAN_API_KEY: 'pmak-test'
-      })
-    );
-
-    expect(outputs).toEqual({
-      'workspace-id': '',
-      'workspace-url': '',
-      'workspace-name': '[AF] core-payments',
-      'spec-id': '',
-      'baseline-collection-id': '',
-      'smoke-collection-id': '',
-      'contract-collection-id': '',
-      'collections-json': JSON.stringify({
-        baseline: '',
-        smoke: '',
-        contract: ''
-      }),
-      'lint-summary-json': JSON.stringify({
-        errors: 0,
-        total: 0,
-        violations: [],
-        warnings: 0
-      })
-    });
-  });
-});

package/tests/github-api-client.test.ts

@@ -1,91 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-
-import {
-  GitHubApiClient,
-  type GitHubApiClientAuthMode
-} from '../src/lib/github/github-api-client.js';
-
-function jsonResponse(body: unknown, init: ResponseInit = {}): Response {
-  return new Response(JSON.stringify(body), {
-    headers: {
-      'content-type': 'application/json'
-    },
-    ...init
-  });
-}
-
-describe('GitHubApiClient', () => {
-  it('falls back to the fallback token for repo variable writes after a 403', async () => {
-    const fetchMock = vi
-      .fn<typeof fetch>()
-      .mockResolvedValueOnce(new Response('forbidden', { status: 403 }))
-      .mockResolvedValueOnce(new Response('', { status: 201 }));
-
-    const client = new GitHubApiClient({
-      repository: 'postman-cs/bootstrap-demo',
-      token: 'primary-token',
-      fallbackToken: 'fallback-token',
-      fetch: fetchMock
-    });
-
-    await client.setRepositoryVariable('POSTMAN_WORKSPACE_ID', 'ws_123');
-
-    expect(fetchMock).toHaveBeenCalledTimes(2);
-    expect(fetchMock.mock.calls[0]?.[1]).toMatchObject({
-      method: 'POST',
-      headers: expect.objectContaining({
-        Authorization: 'Bearer primary-token'
-      })
-    });
-    expect(fetchMock.mock.calls[1]?.[1]).toMatchObject({
-      method: 'POST',
-      headers: expect.objectContaining({
-        Authorization: 'Bearer fallback-token'
-      })
-    });
-  });
-
-  it.each<[GitHubApiClientAuthMode, string[]]>([
-    ['github_token_first', ['primary-token', 'fallback-token']],
-    ['fallback_pat_first', ['fallback-token', 'primary-token']],
-    ['app_token', ['app-token', 'primary-token', 'fallback-token']]
-  ])('exposes explicit token ordering for %s', (authMode, expected) => {
-    const client = new GitHubApiClient({
-      repository: 'postman-cs/bootstrap-demo',
-      token: 'primary-token',
-      fallbackToken: 'fallback-token',
-      appToken: 'app-token',
-      authMode
-    });
-
-    expect(client.getTokenOrder()).toEqual(expected);
-  });
-
-  it('sanitizes GitHub API error messages before surfacing them', async () => {
-    const fetchMock = vi.fn<typeof fetch>().mockResolvedValue(
-      jsonResponse(
-        {
-          message:
-            'workflow write denied for token fallback-token and bearer primary-token'
-        },
-        { status: 500, statusText: 'Internal Server Error' }
-      )
-    );
-    const client = new GitHubApiClient({
-      repository: 'postman-cs/bootstrap-demo',
-      token: 'primary-token',
-      fallbackToken: 'fallback-token',
-      fetch: fetchMock
-    });
-
-    await expect(
-      client.getRepositoryVariable('POSTMAN_WORKSPACE_ID')
-    ).rejects.toThrow('[REDACTED]');
-    await expect(
-      client.getRepositoryVariable('POSTMAN_WORKSPACE_ID')
-    ).rejects.not.toThrow('primary-token');
-    await expect(
-      client.getRepositoryVariable('POSTMAN_WORKSPACE_ID')
-    ).rejects.not.toThrow('fallback-token');
-  });
-});

package/tests/internal-integration-adapter.test.ts

@@ -1,244 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-
-import {
-  createInternalIntegrationAdapter
-} from '../src/lib/postman/internal-integration-adapter.js';
-
-function jsonResponse(body: unknown, init: ResponseInit = {}): Response {
-  return new Response(JSON.stringify(body), {
-    headers: {
-      'Content-Type': 'application/json'
-    },
-    ...init
-  });
-}
-
-describe('internal integration adapter', () => {
-  it('routes governance assignment through the internal gateway API', async () => {
-    const fetchImpl = vi
-      .fn<typeof fetch>()
-      .mockResolvedValueOnce(
-        jsonResponse({
-          data: [{ id: 'group-1', name: 'Core Banking' }]
-        })
-      )
-      .mockResolvedValueOnce(new Response(null, { status: 204 }));
-
-    const adapter = createInternalIntegrationAdapter({
-      backend: 'bifrost',
-      accessToken: 'token-123',
-      teamId: '11430732',
-      fetchImpl
-    });
-
-    await adapter.assignWorkspaceToGovernanceGroup(
-      'ws-123',
-      'core-banking',
-      JSON.stringify({ 'core-banking': 'Core Banking' })
-    );
-
-    expect(fetchImpl).toHaveBeenCalledTimes(2);
-    expect(fetchImpl).toHaveBeenNthCalledWith(
-      1,
-      'https://gateway.postman.com/configure/workspace-groups',
-      expect.objectContaining({
-        headers: expect.objectContaining({
-          'x-access-token': 'token-123'
-        })
-      })
-    );
-    expect(fetchImpl).toHaveBeenNthCalledWith(
-      2,
-      'https://gateway.postman.com/configure/workspace-groups/group-1',
-      expect.objectContaining({
-        method: 'PATCH',
-        body: JSON.stringify({ workspaces: ['ws-123'] })
-      })
-    );
-  });
-
-  it('routes system-env association through the worker internal endpoint', async () => {
-    const fetchImpl = vi.fn<typeof fetch>().mockResolvedValue(
-      jsonResponse({
-        data: {
-          associations: 1
-        }
-      })
-    );
-
-    const adapter = createInternalIntegrationAdapter({
-      backend: 'bifrost',
-      accessToken: 'token-123',
-      teamId: '11430732',
-      workerBaseUrl: 'https://catalog-admin.example.test',
-      fetchImpl
-    });
-
-    await adapter.associateSystemEnvironments('ws-123', [
-      { envUid: 'env-prod', systemEnvId: 'sys-prod' }
-    ]);
-
-    expect(fetchImpl).toHaveBeenCalledWith(
-      'https://catalog-admin.example.test/api/internal/system-envs/associate',
-      expect.objectContaining({
-        method: 'POST',
-        headers: expect.objectContaining({
-          Authorization: 'Bearer token-123',
-          'Content-Type': 'application/json'
-        }),
-        body: JSON.stringify({
-          workspace_id: 'ws-123',
-          associations: [{ env_uid: 'env-prod', system_env_id: 'sys-prod' }]
-        })
-      })
-    );
-  });
-
-  it('uses the Bifrost proxy for workspace repository linking and rejects unsupported backends', async () => {
-    expect(() =>
-      createInternalIntegrationAdapter({
-        backend: 'custom',
-        accessToken: 'token-123',
-        teamId: '11430732'
-      })
-    ).toThrow(/Unsupported integration backend/);
-
-    const fetchImpl = vi.fn<typeof fetch>().mockResolvedValue(
-      jsonResponse({
-        data: {
-          ok: true
-        }
-      })
-    );
-
-    const adapter = createInternalIntegrationAdapter({
-      backend: 'bifrost',
-      accessToken: 'token-123',
-      teamId: '11430732',
-      fetchImpl
-    });
-
-    await adapter.connectWorkspaceToRepository(
-      'ws-123',
-      'https://github.com/Postman-FDE/example'
-    );
-
-    expect(fetchImpl).toHaveBeenCalledWith(
-      'https://bifrost-premium-https-v4.gw.postman.com/ws/proxy',
-      expect.objectContaining({
-        method: 'POST',
-        headers: expect.objectContaining({
-          'x-access-token': 'token-123',
-          'x-entity-team-id': '11430732'
-        }),
-        body: JSON.stringify({
-          service: 'workspaces',
-          method: 'POST',
-          path: '/workspaces/ws-123/filesystem',
-          body: {
-            path: '/',
-            repo: 'https://github.com/Postman-FDE/example',
-            versionControl: true
-          }
-        })
-      })
-    );
-  });
-
-  it('links GitLab repository URLs via the Bifrost proxy', async () => {
-    const fetchImpl = vi.fn<typeof fetch>().mockResolvedValue(
-      jsonResponse({
-        data: {
-          ok: true
-        }
-      })
-    );
-
-    const adapter = createInternalIntegrationAdapter({
-      backend: 'bifrost',
-      accessToken: 'token-123',
-      teamId: '11430732',
-      fetchImpl
-    });
-
-    await adapter.connectWorkspaceToRepository(
-      'ws-456',
-      'https://gitlab.com/org/my-service'
-    );
-
-    expect(fetchImpl).toHaveBeenCalledWith(
-      'https://bifrost-premium-https-v4.gw.postman.com/ws/proxy',
-      expect.objectContaining({
-        method: 'POST',
-        body: JSON.stringify({
-          service: 'workspaces',
-          method: 'POST',
-          path: '/workspaces/ws-456/filesystem',
-          body: {
-            path: '/',
-            repo: 'https://gitlab.com/org/my-service',
-            versionControl: true
-          }
-        })
-      })
-    );
-  });
-
-  it('treats projectAlreadyConnected as idempotent when the same repo is linked', async () => {
-    const fetchImpl = vi.fn<typeof fetch>()
-      // First call: connectWorkspaceToRepository POST returns 400 projectAlreadyConnected
-      .mockResolvedValueOnce(
-        jsonResponse(
-          { error: { status: 400, name: 'projectAlreadyConnected', message: 'Workspace already has a file system connected.' } },
-          { status: 400 }
-        )
-      )
-      // Second call: getWorkspaceGitRepoUrl GET returns the linked repo
-      .mockResolvedValueOnce(
-        jsonResponse({
-          repo: 'https://gitlab.com/org/my-service'
-        })
-      );
-
-    const adapter = createInternalIntegrationAdapter({
-      backend: 'bifrost',
-      accessToken: 'token-123',
-      teamId: '11430732',
-      fetchImpl
-    });
-
-    // Should not throw because the linked repo matches
-    await adapter.connectWorkspaceToRepository(
-      'ws-456',
-      'https://gitlab.com/org/my-service'
-    );
-
-    expect(fetchImpl).toHaveBeenCalledTimes(2);
-  });
-
-  it('throws when projectAlreadyConnected but linked to a different repo', async () => {
-    const fetchImpl = vi.fn<typeof fetch>()
-      .mockResolvedValueOnce(
-        jsonResponse(
-          { error: { status: 400, name: 'projectAlreadyConnected', message: 'Workspace already has a file system connected.' } },
-          { status: 400 }
-        )
-      )
-      .mockResolvedValueOnce(
-        jsonResponse({
-          repo: 'https://gitlab.com/org/different-service'
-        })
-      );
-
-    const adapter = createInternalIntegrationAdapter({
-      backend: 'bifrost',
-      accessToken: 'token-123',
-      teamId: '11430732',
-      fetchImpl
-    });
-
-    await expect(
-      adapter.connectWorkspaceToRepository('ws-456', 'https://gitlab.com/org/my-service')
-    ).rejects.toThrow(/linked to a different repo/);
-  });
-});