Added deployment unit and integration testing

.github/workflows/test-code.yml

@@ -22,6 +22,7 @@ jobs:
         continue-on-error: true
         run: |
           npm install
+          export GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
           ./node_modules/.bin/jest --json --outputFile=${{env.jest-output-file}} ./src/
 
       - name: Process jest results

README.md

@@ -70,7 +70,7 @@ jobs:
       - name: Create GitHub Deployment
         id: defaults
         continue-on-error: true                                      # Setting to true so the job doesn't fail if updating the board fails.
-        uses: im-open/[email protected].10               # You may also reference just the major or major.minor version
+        uses: im-open/[email protected].8                # You may also reference just the major or major.minor version
         with:
           workflow-actor: ${{ github.actor }}                        # This will add the user who kicked off the workflow to the deployment payload
           token: ${{ secrets.GITHUB_TOKEN }}                         # If a different token is used, update github-login with the corresponding account

dist/index.js

@@ -42107,17 +42107,21 @@ var require_deployments = __commonJS({
     var { Octokit } = require_dist_node12();
     var { graphql } = require_dist_node6();
     var WORKFLOW_DEPLOY = 'workflowdeploy';
-    var ALLOWED_STATUSES = [
-      'success',
-      'error',
-      'failure',
-      'inactive',
-      'in_progress',
-      'queued',
-      'pending'
-    ];
+    var ALLOWED_STATUSES = {
+      SUCCESS: 'success',
+      ERROR: 'error',
+      FAILURE: 'failure',
+      INACTIVE: 'inactive',
+      IN_PROGRESS: 'in_progress',
+      QUEUED: 'queued',
+      PENDING: 'pending'
+    };
+    var createOctokitClient = token => new Octokit({ auth: token });
+    var createOctokitGraphQLClient = token =>
+      graphql.defaults({ headers: { authorization: `token ${token}` } });
     async function inactivatePriorDeployments(context, currentDeploymentNodeId) {
-      const octokit = new Octokit({ auth: context.token });
+      const octokit = createOctokitClient(context.token);
+      const octokitGraphQl = createOctokitGraphQLClient(context.token);
       const params = {
         owner: context.owner,
         repo: context.repo,
@@ -42126,19 +42130,14 @@ var require_deployments = __commonJS({
         per_page: 100
       };
       const deploymentsList = (
-        await octokit.paginate(octokit.rest.repos.listDeployments, params)
-      ).filter(
-        d =>
-          d.node_id != currentDeploymentNodeId &&
-          d.payload.entity == context.entity &&
-          d.payload.instance == context.instance
-      );
+        await getPriorDeployments(octokit, context.entity, context.instance, params)
+      ).filter(d => d.node_id != currentDeploymentNodeId);
       const statuses = await getPriorDeploymentStatuses(
-        context.token,
+        octokitGraphQl,
         deploymentsList.map(d => d.node_id)
       );
-      for (let i = 0; i < statuses.deployments.length; i++) {
-        let deploymentQl = statuses.deployments[i];
+      for (let i = 0; i < statuses.length; i++) {
+        let deploymentQl = statuses[i];
         let deployment = deploymentsList.filter(d => d.node_id == deploymentQl.id)[0];
         for (let j = 0; j < deploymentQl.statuses.nodes.length; j++) {
           const status = deploymentQl.statuses.nodes[j];
@@ -42156,12 +42155,12 @@ var require_deployments = __commonJS({
         }
       }
     }
-    async function getPriorDeploymentStatuses(token, deploymentNodeIds) {
-      const octokitGraphQl = graphql.defaults({
-        headers: {
-          authorization: `token ${token}`
-        }
-      });
+    async function getPriorDeployments(octokit, entity, instance, params) {
+      return (await octokit.paginate(octokit.rest.repos.listDeployments, params)).filter(
+        d => d.payload.entity == entity && d.payload.instance == instance
+      );
+    }
+    async function getPriorDeploymentStatuses(octokitGraphQl, deploymentNodeIds) {
       const statuses = [];
       const statusesQuery = `
           query($deploymentNodeIds: [ID!]!) {
@@ -42194,7 +42193,7 @@ var require_deployments = __commonJS({
       return statuses;
     }
     async function createDeployment2(context) {
-      const octokit = new Octokit({ auth: context.token });
+      const octokit = createOctokitClient(context.token);
       const deployment = (
         await octokit.rest.repos.createDeployment({
           owner: context.owner,
@@ -42252,7 +42251,12 @@ var require_deployments = __commonJS({
     }
     module2.exports = {
       ALLOWED_STATUSES,
-      createDeployment: createDeployment2
+      WORKFLOW_DEPLOY,
+      createDeployment: createDeployment2,
+      createOctokitClient,
+      createOctokitGraphQLClient,
+      getPriorDeployments,
+      getPriorDeploymentStatuses
     };
   }
 });
@@ -42317,7 +42321,7 @@ var require_library = __commonJS({
       const workflow_run_id = github.context.runId;
       const owner = github.context.repo.owner;
       const repo = github.context.repo.repo;
-      if (!ALLOWED_STATUSES.map(s => s.toLowerCase()).includes(deployment_status.toLowerCase())) {
+      if (!Object.values(ALLOWED_STATUSES).includes(deployment_status.toLowerCase())) {
         throw { name: INVALID_STATUS, message: `Invalid deployment status: ${deployment_status}` };
       }
       return new context(
@@ -42337,7 +42341,8 @@ var require_library = __commonJS({
     }
     module2.exports = {
       INVALID_STATUS,
-      setup: setup2
+      setup: setup2,
+      context
     };
   }
 });

src/deployments.js

@@ -1,18 +1,23 @@
 const { Octokit } = require('@octokit/rest');
 const { graphql } = require('@octokit/graphql');
 const WORKFLOW_DEPLOY = 'workflowdeploy';
-const ALLOWED_STATUSES = [
-  'success',
-  'error',
-  'failure',
-  'inactive',
-  'in_progress',
-  'queued',
-  'pending'
-];
+const ALLOWED_STATUSES = {
+  SUCCESS: 'success',
+  ERROR: 'error',
+  FAILURE: 'failure',
+  INACTIVE: 'inactive',
+  IN_PROGRESS: 'in_progress',
+  QUEUED: 'queued',
+  PENDING: 'pending'
+};
+
+const createOctokitClient = token => new Octokit({ auth: token });
+const createOctokitGraphQLClient = token =>
+  graphql.defaults({ headers: { authorization: `token ${token}` } });
 
 async function inactivatePriorDeployments(context, currentDeploymentNodeId) {
-  const octokit = new Octokit({ auth: context.token });
+  const octokit = createOctokitClient(context.token);
+  const octokitGraphQl = createOctokitGraphQLClient(context.token);
 
   const params = {
     owner: context.owner,
@@ -23,21 +28,16 @@ async function inactivatePriorDeployments(context, currentDeploymentNodeId) {
   };
 
   const deploymentsList = (
-    await octokit.paginate(octokit.rest.repos.listDeployments, params)
-  ).filter(
-    d =>
-      d.node_id != currentDeploymentNodeId &&
-      d.payload.entity == context.entity &&
-      d.payload.instance == context.instance
-  );
+    await getPriorDeployments(octokit, context.entity, context.instance, params)
+  ).filter(d => d.node_id != currentDeploymentNodeId);
 
   const statuses = await getPriorDeploymentStatuses(
-    context.token,
+    octokitGraphQl,
     deploymentsList.map(d => d.node_id)
   );
 
-  for (let i = 0; i < statuses.deployments.length; i++) {
-    let deploymentQl = statuses.deployments[i];
+  for (let i = 0; i < statuses.length; i++) {
+    let deploymentQl = statuses[i];
     let deployment = deploymentsList.filter(d => d.node_id == deploymentQl.id)[0];
 
     for (let j = 0; j < deploymentQl.statuses.nodes.length; j++) {
@@ -58,13 +58,13 @@ async function inactivatePriorDeployments(context, currentDeploymentNodeId) {
   }
 }
 
-async function getPriorDeploymentStatuses(token, deploymentNodeIds) {
-  const octokitGraphQl = graphql.defaults({
-    headers: {
-      authorization: `token ${token}`
-    }
-  });
+async function getPriorDeployments(octokit, entity, instance, params) {
+  return (await octokit.paginate(octokit.rest.repos.listDeployments, params)).filter(
+    d => d.payload.entity == entity && d.payload.instance == instance
+  );
+}
 
+async function getPriorDeploymentStatuses(octokitGraphQl, deploymentNodeIds) {
   const statuses = [];
   const statusesQuery = `
           query($deploymentNodeIds: [ID!]!) {
@@ -101,7 +101,8 @@ async function getPriorDeploymentStatuses(token, deploymentNodeIds) {
 }
 
 async function createDeployment(context) {
-  const octokit = new Octokit({ auth: context.token });
+  const octokit = createOctokitClient(context.token);
+
   // create deployment record
   const deployment = (
     await octokit.rest.repos.createDeployment({
@@ -126,6 +127,7 @@ async function createDeployment(context) {
   const inactivate = new Promise((resolve, reject) =>
     resolve(inactivatePriorDeployments(context, deployment.node_id))
   );
+
   inactivate.then(async () => {
     await createDeploymentStatus(
       octokit,
@@ -164,5 +166,10 @@ async function createDeploymentStatus(
 
 module.exports = {
   ALLOWED_STATUSES,
-  createDeployment
+  WORKFLOW_DEPLOY,
+  createDeployment,
+  createOctokitClient,
+  createOctokitGraphQLClient,
+  getPriorDeployments,
+  getPriorDeploymentStatuses
 };

src/deployments.test.js

@@ -0,0 +1,99 @@
+const { describe, test, expect, beforeEach, beforeAll, afterAll } = require('@jest/globals');
+const {
+  ALLOWED_STATUSES,
+  WORKFLOW_DEPLOY,
+  createOctokitClient,
+  createOctokitGraphQLClient,
+  getPriorDeployments,
+  getPriorDeploymentStatuses,
+  createDeployment
+} = require('./deployments.js');
+const { context } = require('./library.js');
+
+const token = process.env['GITHUB_TOKEN'];
+let octokit;
+let octokitGraphQl;
+const owner = 'im-open';
+const repo = 'create-github-deployment';
+const create_environment = 'INTEGRATION';
+const pull_environment = 'DEV';
+const entity = 'create-github-deployment';
+const instance = 'action';
+const priorDeployments = [];
+const priorDeploymentStatuses = [];
+let testDeploymentId = null;
+const workflow_actor = 'test-actor';
+
+// Create the octokit clients
+beforeAll(() => {
+  octokit = createOctokitClient(token);
+  octokitGraphQl = createOctokitGraphQLClient(token);
+});
+
+//clean up test deployment
+afterAll(async () => {
+  if (testDeploymentId !== null) {
+    setTimeout(async () => {
+      await octokit.rest.repos.deleteDeployment({
+        owner: owner,
+        repo: repo,
+        deployment_id: testDeploymentId
+      });
+      octokit = null;
+      octokitGraphQl = null;
+    }, 5000);
+  }
+});
+
+describe('deployments', () => {
+  let firstDeploymentId;
+
+  test('get the deployments', async () => {
+    const deployments = await getPriorDeployments(octokit, entity, instance, {
+      owner: owner,
+      repo: repo,
+      task: WORKFLOW_DEPLOY,
+      environment: pull_environment,
+      per_page: 100
+    });
+    expect(deployments).toBeDefined();
+    expect(deployments.length).toBeGreaterThan(0);
+    expect(deployments[0].payload).toBeDefined();
+    firstDeploymentId = deployments[0].node_id;
+
+    priorDeployments.push(...deployments);
+  });
+
+  test('get the deployment statuses', async () => {
+    const statuses = await getPriorDeploymentStatuses(octokitGraphQl, [firstDeploymentId]);
+    expect(statuses).toBeDefined();
+    expect(statuses.length).toBeGreaterThan(0);
+
+    expect(statuses[0].statuses).toBeDefined();
+    expect(statuses[0].statuses.nodes).toBeDefined();
+    expect(statuses[0].statuses.nodes.length).toBeGreaterThan(0);
+
+    priorDeploymentStatuses.push(...statuses);
+  });
+
+  test('create deployment', async () => {
+    testDeploymentId = await createDeployment(
+      new context(
+        workflow_actor,
+        token,
+        create_environment,
+        'v1',
+        ALLOWED_STATUSES.SUCCESS,
+        'Testing deployment creation',
+        entity,
+        instance,
+        'https://github.com',
+        'https://github.com',
+        owner,
+        repo
+      )
+    );
+
+    expect(Number.isNaN(testDeploymentId)).toBe(false);
+  });
+});

src/library.js

@@ -57,7 +57,7 @@ function setup() {
   const owner = github.context.repo.owner;
   const repo = github.context.repo.repo;
 
-  if (!ALLOWED_STATUSES.map(s => s.toLowerCase()).includes(deployment_status.toLowerCase())) {
+  if (!Object.values(ALLOWED_STATUSES).includes(deployment_status.toLowerCase())) {
     throw { name: INVALID_STATUS, message: `Invalid deployment status: ${deployment_status}` };
   }
 
@@ -79,5 +79,6 @@ function setup() {
 
 module.exports = {
   INVALID_STATUS,
-  setup
+  setup,
+  context
 };

src/library.test.js

@@ -1,4 +1,3 @@
-const { assert } = require('node:assert');
 const { describe, test, expect, beforeEach } = require('@jest/globals');
 const { setup, INVALID_STATUS } = require('./library.js');
 const { ALLOWED_STATUSES } = require('./deployments.js');
@@ -32,13 +31,16 @@ describe('deployment status', () => {
     }
   });
 
-  test.each(ALLOWED_STATUSES)(`valid deployment status of %s does not throw exception`, status => {
-    process.env[inputKey('deployment-status')] = status;
-    try {
-      const testConext = setup();
-      expect(testConext.deployment_status).toBe(status);
-    } catch (error) {
-      expect(error).toBeUndefined();
+  test.each(Object.values(ALLOWED_STATUSES))(
+    `valid deployment status of %s does not throw exception`,
+    status => {
+      process.env[inputKey('deployment-status')] = status;
+      try {
+        const testContext = setup();
+        expect(testContext.deployment_status).toBe(status);
+      } catch (error) {
+        expect(error).toBeUndefined();
+      }
     }
-  });
+  );
 });