add tests

Author: josephjclark

packages/cli/src/deploy/handler.ts

@@ -14,23 +14,27 @@ import { yamlToJson } from '@openfn/project';
 import fs from 'node:fs/promises';
 
 export type DeployFn = typeof deploy;
+export type BetaHandlerFn = typeof beta.handler;
 
 const actualDeploy: DeployFn = deploy;
+const actualBetaHandler: BetaHandlerFn = beta.handler;
 
-// Flexible `deployFn` interface for testing.
+// Flexible `deployFn` / `betaHandler` interfaces for testing.
 async function deployHandler<F extends (...args: any) => any>(
   options: DeployOptions,
   logger: Logger,
-  deployFn: F
+  deployFn: F,
+  betaHandler?: BetaHandlerFn
 ): Promise<ReturnType<typeof deployFn>>;
 
 async function deployHandler(
   options: DeployOptions,
   logger: Logger,
-  deployFn = actualDeploy
+  deployFn = actualDeploy,
+  betaHandler: BetaHandlerFn = actualBetaHandler
 ) {
   if (options.beta) {
-    return beta.handler(options as any, logger);
+    return betaHandler(options as any, logger);
   }
 
   try {
@@ -41,7 +45,7 @@ async function deployHandler(
       'openfn.yaml'
     );
     if (!process.env.PREFER_LEGACY_SYNC && (await fileExists(v2ConfigPath))) {
-      return redirectTov2(v2ConfigPath, options, config, logger);
+      return redirectTov2(v2ConfigPath, options, config, logger, betaHandler);
     }
 
     if (options.confirm === false) {
@@ -110,7 +114,8 @@ const redirectTov2 = async (
   v2ConfigPath: string,
   options: DeployOptions,
   config: DeployConfig,
-  logger: Logger
+  logger: Logger,
+  betaHandler: BetaHandlerFn = actualBetaHandler
 ) => {
   logger.always(
     'Detected openfn.yaml file - switching to v2 deploy (openfn project deploy). Set PREFER_LEGACY_SYNC to disable this.'
@@ -121,7 +126,7 @@ const redirectTov2 = async (
   const endpoint =
     options.endpoint ?? v2config?.project?.endpoint ?? config.endpoint;
 
-  return beta.handler(
+  return betaHandler(
     {
       ...options,
       force: true,

packages/cli/test/deploy/deploy.test.ts

@@ -3,7 +3,10 @@
 import test from 'ava';
 import mockfs from 'mock-fs';
 import { Logger, createMockLogger } from '@openfn/logger';
-import deployHandler, { DeployFn } from '../../src/deploy/handler';
+import deployHandler, {
+  BetaHandlerFn,
+  DeployFn,
+} from '../../src/deploy/handler';
 
 import { DeployError, type DeployConfig } from '@openfn/deploy';
 import { DeployOptions } from '../../src/deploy/command';
@@ -88,6 +91,91 @@ test.serial('sets the exit code to 1', async (t) => {
   process.exitCode = origExitCode;
 });
 
+test.serial(
+  'redirects to beta handler when openfn.yaml exists in cwd',
+  async (t) => {
+    t.plan(3);
+    mockfs({
+      ['./config.json']: `{"apiKey": "123"}`,
+      ['./project.yaml']: `{"apiKey": "123"}`,
+      ['./openfn.yaml']: 'project:\n  endpoint: https://from-yaml.org',
+    });
+
+    await deployHandler(options, logger, mockDeploy, async (args: any) => {
+      t.is(args.force, true);
+      t.is(args.endpoint, 'https://from-yaml.org');
+      t.truthy(logger._find('always', /Detected openfn.yaml file/i));
+    });
+  }
+);
+
+test.serial('does not redirect when PREFER_LEGACY_SYNC is set', async (t) => {
+  t.plan(1);
+  mockfs({
+    ['./config.json']: `{"apiKey": "123", "endpoint": "https://api.example.com"}`,
+    ['./project.yaml']: `{"apiKey": "123"}`,
+    ['./openfn.yaml']: 'project:\n  endpoint: https://from-yaml.org',
+  });
+  process.env.PREFER_LEGACY_SYNC = '1';
+
+  await deployHandler(options, logger, mockDeploy, async (args: any) => {
+    t.fail('called beta handler');
+  });
+
+  delete process.env.PREFER_LEGACY_SYNC;
+  t.pass();
+});
+
+test.serial('CLI endpoint preferred over openfn.yaml endpoint', async (t) => {
+  t.plan(1);
+  mockfs({
+    ['./config.json']: `{"apiKey": "123"}`,
+    ['./project.yaml']: `{"apiKey": "123"}`,
+    ['./openfn.yaml']: 'project:\n  endpoint: https://from-yaml.org',
+  });
+
+  await deployHandler(
+    { ...options, endpoint: 'https://from-cli.org' } as any,
+    logger,
+    mockDeploy,
+    async (args: any) => {
+      t.is(args.endpoint, 'https://from-cli.org');
+    }
+  );
+});
+
+test.serial(
+  'openfn.yaml endpoint preferred over config.json endpoint',
+  async (t) => {
+    mockfs({
+      ['./config.json']: `{"apiKey": "123", "endpoint": "https://from-config.org"}`,
+      ['./project.yaml']: `{"apiKey": "123"}`,
+      ['./openfn.yaml']: 'project:\n  endpoint: https://from-yaml.org',
+    });
+
+    await deployHandler(options, logger, mockDeploy, async (args: any) => {
+      t.is(args.endpoint, 'https://from-yaml.org');
+    });
+  }
+);
+
+test.serial('CLI apiKey preferred over config.json apiKey', async (t) => {
+  mockfs({
+    ['./config.json']: `{"apiKey": "from-config"}`,
+    ['./project.yaml']: `{"apiKey": "from-config"}`,
+    ['./openfn.yaml']: 'project:\n  endpoint: https://from-yaml.org',
+  });
+
+  await deployHandler(
+    { ...options, apiKey: 'from-cli' } as any,
+    logger,
+    mockDeploy,
+    async (args: any) => {
+      t.is(args.apiKey, 'from-cli');
+    }
+  );
+});
+
 test.serial('catches DeployErrors', async (t) => {
   const origExitCode = process.exitCode;