Improve check to use test env

Author: SamyPesse

integrations/intercom-conversations/gitbook-manifest.yaml

@@ -19,6 +19,10 @@ secrets:
     CLIENT_SECRET: ${{ env.INTERCOM_CLIENT_SECRET }}
 target: organization
 envs:
+    test:
+        secrets:
+            CLIENT_ID: '<CLIENT_ID>'
+            CLIENT_SECRET: '<CLIENT_SECRET>'
     dev-samy:
         organization: 27dLEczo4lLcYIQhRuxg
         secrets:

integrations/zendesk-conversations/gitbook-manifest.yaml

@@ -19,6 +19,10 @@ secrets:
     CLIENT_SECRET: ${{ env.ZENDESK_CLIENT_SECRET }}
 target: organization
 envs:
+    test:
+        secrets:
+            CLIENT_ID: '<CLIENT_ID>'
+            CLIENT_SECRET: '<CLIENT_SECRET>'
     dev-samy:
         organization: 27dLEczo4lLcYIQhRuxg
         secrets:

packages/cli/src/check.ts

@@ -1,20 +1,22 @@
 import { Miniflare } from 'miniflare';
 
 import { buildScriptFromManifest } from './build';
-import { getDefaultManifestPath, resolveIntegrationManifestPath } from './manifest';
 import { getMiniflareOptions } from './dev';
+import { withEnvironment } from './environments';
 
 /**
  * Check that an integration can build correctly without publishing it.
  */
-export async function checkIntegrationBuild() {
-    const manifestSpecPath = await resolveIntegrationManifestPath(getDefaultManifestPath());
-    const { path: scriptPath } = await buildScriptFromManifest(manifestSpecPath, {
-        mode: 'development',
-    });
+export async function checkIntegrationBuild(manifestSpecPath: string) {
+    // We use a special env "test" to make it easy to configure the integration for testing.
+    return withEnvironment('test', async () => {
+        const { path: scriptPath } = await buildScriptFromManifest(manifestSpecPath, {
+            mode: 'development',
+        });
 
-    const mf = new Miniflare(getMiniflareOptions(scriptPath));
-    await mf.ready;
+        const mf = new Miniflare(getMiniflareOptions(scriptPath));
+        await mf.ready;
 
-    await mf.dispose();
+        await mf.dispose();
+    });
 }

packages/cli/src/cli.ts

@@ -142,12 +142,12 @@ program
 
 program
     .command('check')
+    .argument('[file]', 'integration definition file', DEFAULT_MANIFEST_FILE)
     .description('check the integration build')
-    .option('--env <env>', 'environment to use')
-    .action(async (options) => {
-        return withEnvironment(options.env, async () => {
-            await checkIntegrationBuild();
-        });
+    .action(async (filePath) => {
+        await checkIntegrationBuild(
+            await resolveIntegrationManifestPath(path.resolve(process.cwd(), filePath)),
+        );
     });
 
 const openAPIProgram = program.command('openapi').description('manage OpenAPI specifications');

packages/cli/src/manifest.ts

@@ -121,7 +121,7 @@ const IntegrationManifestSchema = z
             )
             .optional(),
         contentSecurityPolicy: z.union([z.string(), z.record(z.string(), z.string())]).optional(),
-        envs: z.record(IntegrationManifestEnvironmentSchema).optional(),
+        envs: z.record(z.object(IntegrationManifestEnvironmentSchema.shape).partial()).optional(),
     })
     .merge(IntegrationManifestEnvironmentSchema);