Merge pull request #16 from humanitec/configurable-automation-rule

feat: configurable automation rule creation

README.md

@@ -22,6 +22,7 @@ This GitHub action allows you to dynamically create and deleted preview environm
 ## Outputs
 
 * `environment-url` : Rendered URL of the preview environment.
+* `humanitec-env`: Id of the created environment.
 
 ## Example usage
 

action.yaml

@@ -28,9 +28,15 @@ inputs:
   environment-url-template:
     description: 'Provide a custom mustache template for the environment url, "https://app.humanitec.io/orgs/{{orgId}}/apps/{{appId}}/envs/{{envId}}" by default.'
     required: false
+  create-automation-rule:
+    description: 'Automatically create an automation rule for the environment, "true" by default.'
+    required: false
+    default: 'true'
 outputs:
   environment-url:
     description: 'URL where the running application can be accessed'
+  humanitec-env:
+    description: 'The id of the created environment'
 runs:
   using: 'node16'
   main: 'dist/index.js'

package.json

@@ -29,7 +29,7 @@
   "dependencies": {
     "@actions/core": "^1.9.1",
     "@actions/github": "^5.1.1",
-    "@humanitec/autogen": "^0.0.8",
+    "@humanitec/autogen": "^0.0.9",
     "axios": "^1.2.1",
     "mustache": "^4.2.0"
   },

src/action.test.ts

@@ -1,6 +1,8 @@
 import {describe, expect, test, beforeEach, afterAll} from '@jest/globals';
 import {runAction} from './action';
 import {randomBytes} from 'crypto';
+import {createApiClient} from './humanitec';
+import {branchNameToEnvId} from './utils';
 
 // Emulate https://github.com/actions/toolkit/blob/819157bf8/packages/core/src/core.ts#L128
 const setInput = (name: string, value: string): void => {
@@ -22,8 +24,11 @@ const appId = ensureEnv('HUMANITEC_APP');
 
 describe('action', () => {
   let branch: string;
+  let humClient: ReturnType<typeof createApiClient>;
 
   beforeEach(async () => {
+    humClient = createApiClient('', token);
+
     setInput('humanitec-token', token);
     setInput('humanitec-org', orgId);
     setInput('humanitec-app', appId);
@@ -38,10 +43,56 @@ describe('action', () => {
 
   test('succeeds', async () => {
     try {
+      setInput('create-automation-rule', 'true');
       setInput('action', 'create');
       await runAction();
       expect(process.exitCode).toBeFalsy();
 
+      // TODO Get from output instead
+      const envId = branchNameToEnvId('dev', branch);
+
+      const listRules = await humClient.orgsOrgIdAppsAppIdEnvsEnvIdRulesGet({
+        orgId,
+        appId,
+        envId,
+      });
+      expect(listRules.status).toBe(200);
+      expect(listRules.data).toHaveLength(1);
+      expect(listRules.data[0].match_ref).toEqual(`refs/heads/${branch}`);
+
+
+      setInput('action', 'notify');
+      await runAction();
+      expect(process.exitCode).toBeFalsy();
+
+      setInput('action', 'delete');
+      await runAction();
+      expect(process.exitCode).toBeFalsy();
+    } catch (e) {
+      console.log(e);
+      throw new Error('failed');
+    }
+  });
+
+
+  test('succeeds without automation rule', async () => {
+    try {
+      setInput('create-automation-rule', 'false');
+      setInput('action', 'create');
+      await runAction();
+      expect(process.exitCode).toBeFalsy();
+
+      // TODO Get from output instead
+      const envId = branchNameToEnvId('dev', branch);
+
+      const listRules = await humClient.orgsOrgIdAppsAppIdEnvsEnvIdRulesGet({
+        orgId,
+        appId,
+        envId,
+      });
+      expect(listRules.status).toBe(200);
+      expect(listRules.data).toEqual([]);
+
       setInput('action', 'notify');
       await runAction();
       expect(process.exitCode).toBeFalsy();

src/action.ts

@@ -1,5 +1,5 @@
 import {getOctokit, context} from '@actions/github';
-import {getInput, setOutput, info} from '@actions/core';
+import {getInput, setOutput, info, getBooleanInput} from '@actions/core';
 import {render} from 'mustache';
 
 import {branchNameToEnvId} from './utils';
@@ -11,6 +11,8 @@ async function createEnvironment(input: ActionInput): Promise<void> {
   const {orgId, appId, envId, context, octokit, humClient, branchName, environmentUrl, webAppUrl} = input;
 
   const baseEnvId = getInput('base-env') || 'development';
+  const createAutomationRule = getBooleanInput('create-automation-rule');
+  console.log('createAutomationRule', createAutomationRule);
   const imageName = (process.env.GITHUB_REPOSITORY || '').replace(/.*\//, '');
   const image = getInput('image') || `registry.humanitec.io/${orgId}/${imageName}`;
 
@@ -48,23 +50,27 @@ async function createEnvironment(input: ActionInput): Promise<void> {
 
   console.log(`Created environment: ${envId}, ${environmentUrl}`);
 
-  const matchRef =`refs/heads/${branchName}`;
-  const createRuleRes = await humClient.orgsOrgIdAppsAppIdEnvsEnvIdRulesPost({
-    orgId,
-    appId,
-    envId,
-    automationRuleRequest: {
-      active: true,
-      artefacts_filter: [image],
-      type: 'update',
-      match_ref: matchRef,
-    },
-  });
-  if (createRuleRes.status != 201) {
-    throw new Error(`Unexpected response creating rule: ${baseEnvRes.status}, ${baseEnvRes.data}`);
+
+  if (createAutomationRule) {
+    const matchRef =`refs/heads/${branchName}`;
+    const createRuleRes = await humClient.orgsOrgIdAppsAppIdEnvsEnvIdRulesPost({
+      orgId,
+      appId,
+      envId,
+      automationRuleRequest: {
+        active: true,
+        artefacts_filter: [image],
+        type: 'update',
+        match_ref: matchRef,
+      },
+    });
+    if (createRuleRes.status != 201) {
+      throw new Error(`Unexpected response creating rule: ${baseEnvRes.status}, ${baseEnvRes.data}`);
+    }
+
+    console.log(`Created auto-deployment rule for ${matchRef} and image ${image}`);
   }
 
-  console.log(`Created auto-deployment rule for ${matchRef} and image ${image}`);
 
   if (!octokit) {
     return;
@@ -238,6 +244,7 @@ export async function runAction(): Promise<void> {
   }
   info('Using environment: '+environmentUrl);
   setOutput('environment-url', environmentUrl);
+  setOutput('humanitec-env', envId);
   if (action == 'get-environment-url') {
     return;
   }

src/humanitec/index.ts

@@ -1,13 +1,18 @@
-import {apiConfig, PublicApi} from '@humanitec/autogen';
+import {APIConfig, apiConfig, PublicApi} from '@humanitec/autogen';
 
 export type HumanitecClient = PublicApi
 
 export const createApiClient = (basePath: string, token: string): PublicApi => {
-  const config = apiConfig({
+  const clientConfig: APIConfig = {
     token,
-    apiHost: `https://${basePath}`,
     internalApp: 'preview-envs-action/latest',
-  });
+  };
+
+  if (basePath) {
+    clientConfig.apiHost = `https://${basePath}`;
+  }
+
+  const config = apiConfig(clientConfig);
 
   return new PublicApi(config);
 };