GHA-93 Add UTs for OctokitAction input and load (#230)

Author: pavel-mikula-sonarsource

.github/workflows/Build.yml

@@ -54,6 +54,7 @@ jobs:
         uses: SonarSource/vault-action-wrapper@v3
         with:
           secrets: |
+            development/github/token/{REPO_OWNER_NAME_DASH}-jira token | GITHUB_TOKEN;
             development/artifactory/token/{REPO_OWNER_NAME_DASH}-private-reader access_token | REPOX_TOKEN;
             development/kv/data/jira user | JIRA_USER;
             development/kv/data/jira token | JIRA_TOKEN;
@@ -67,6 +68,7 @@ jobs:
 
       - name: Run tests
         env:
-            JIRA_USER:  ${{ fromJSON(steps.secrets.outputs.vault).JIRA_USER }}
-            JIRA_TOKEN: ${{ fromJSON(steps.secrets.outputs.vault).JIRA_TOKEN }}
+            GITHUB_TOKEN: ${{ fromJSON(steps.secrets.outputs.vault).GITHUB_TOKEN }}
+            JIRA_USER:    ${{ fromJSON(steps.secrets.outputs.vault).JIRA_USER }}
+            JIRA_TOKEN:   ${{ fromJSON(steps.secrets.outputs.vault).JIRA_TOKEN }}
         run: npm run test

dist/lib/OctokitAction.test.js

@@ -0,0 +1,184 @@
+import { LogTester } from '../tests/LogTester';
+import { jiraClientStub } from '../tests/JiraClientStub';
+import { createOctokitRestStub } from '../tests/OctokitRestStub';
+import { OctokitAction } from './OctokitAction';
+import { fail } from 'assert';
+
+class TestOctokitAction extends OctokitAction {
+
+  constructor() {
+    super();
+    (this as any).jira = jiraClientStub;
+    (this as any).rest = createOctokitRestStub('PR title');
+  }
+
+  async execute(): Promise<void> {
+    this.log('Invoked execute()');
+  }
+}
+
+describe('OctokitAction', () => {
+  const originalKeys = Object.keys(process.env);
+  let logTester: LogTester;
+  let sut: any; // TestOctokitAction, but with access to protected methods
+
+  beforeEach(() => {
+    logTester = new LogTester();
+    const token = process.env["GITHUB_TOKEN"];
+    if (token) {
+      for (const key of Object.keys(process.env)) {
+        if (!originalKeys.includes(key)) {
+          // Otherwise, changes form previous UT are propagated to the next one
+          delete process.env[key];
+        }
+      }
+      process.env['GITHUB_REPOSITORY'] = 'test-owner/test-repo';
+      process.env['INPUT_GITHUB-TOKEN'] = token;
+      sut = new TestOctokitAction();
+    } else {
+      fail("OctokitAction tests require GITHUB_TOKEN environment variables to be set.");
+    }
+  });
+
+  afterEach(() => {
+    logTester.afterEach();
+  });
+
+  it('isEngXpSquad is true', async () => {
+    process.env['INPUT_IS-ENG-XP-SQUAD'] = 'true';
+    const action = new TestOctokitAction();
+    expect((action as any).isEngXpSquad).toBe(true);
+  });
+
+  it('isEngXpSquad is false', async () => {
+    const action = new TestOctokitAction();
+    expect((action as any).isEngXpSquad).toBe(false);
+  });
+
+  it('sendGraphQL', async () => {
+    const result = await sut.sendGraphQL(`
+      query {
+        repository (owner: "SonarSource", name: "gh-action-lt-backlog") {
+          id
+          name
+        }
+      }`);
+    expect(result).toEqual({
+      repository: {
+        id: "R_kgDOGZ6k-Q",
+        name: "gh-action-lt-backlog"
+      }
+    })
+  });
+
+  it('inputString', async () => {
+    process.env['INPUT_KEY'] = 'Value'; // KEY must be upper case, otherwise Ubuntu in CI doesn't work
+    expect(sut.inputString('key')).toBe('Value');
+    expect(sut.inputString('missing')).toBe('');
+  });
+
+  it('inputNumber', async () => {
+    process.env['INPUT_KEY'] = '42';
+    process.env['INPUT_STRING'] = 'Lorem Ipsum';
+    expect(sut.inputNumber('key')).toBe(42);
+    expect(() => sut.inputNumber('string')).toThrow("Value of input 'string' is not a number: Lorem Ipsum")
+  });
+
+  it('inputBoolean true', async () => {
+    for (const value of ['true', 'True', 'TRUE', 'tRuE']) {
+      process.env['INPUT_KEY'] = value;
+      expect(sut.inputBoolean('key')).toBe(true);
+    }
+  });
+
+  it('inputBoolean false', async () => {
+    for (const value of ['', 'false', 'False', '0', 'no']) {
+      process.env['INPUT_KEY'] = value;
+      expect(sut.inputBoolean('key')).toBe(false);
+    }
+  });
+
+  it('loadPullRequest', async () => {
+    const pr = await sut.loadPullRequest(42);
+    expect(pr).toMatchObject({ number: 42, title: "PR title" });  // Plus the remainig properties from scaffolding
+    expect(logTester.logsParams).toStrictEqual(["Loading PR #42"]);
+  });
+
+  it('loadIssue', async () => {
+    const issue = await sut.loadIssue(24);
+    expect(issue).toMatchObject({ number: 24, title: "Issue title" });  // Plus the remainig properties from scaffolding
+    expect(logTester.logsParams).toStrictEqual(["Loading issue #24"]);
+  });
+
+  it.skip('findFixedIssues no body', async () => {
+
+  });
+
+  it.skip('findFixedIssues no issue', async () => {
+
+  });
+
+  it.skip('findFixedIssues with issues in body', async () => {
+
+  });
+
+  it.skip('findFixedIssues renovate no issue', async () => {
+
+  });
+
+  it.skip('findFixedIssues renovate with issue', async () => {
+
+  });
+
+  it.skip('addComment', async () => {
+
+  });
+
+  it.skip('listComments', async () => {
+
+  });
+
+  it.skip('updateIssueTitle', async () => {
+
+  });
+
+  it.skip('updatePullRequestTitle', async () => {
+
+  });
+
+  it.skip('updatePullRequestDescription', async () => {
+
+  });
+
+  it.skip('findEmail returns first', async () => {
+
+  });
+
+  it.skip('findEmail no results', async () => {
+
+  });
+
+  it.skip('findEmail bad token', async () => {
+
+  });
+
+  it.skip('sendSlackMessage', async () => {
+
+  });
+
+  it.skip('processRequestReview', async () => {
+
+  });
+
+  it.skip('addJiraComponent success', async () => {
+
+  });
+
+  it.skip('addJiraComponent fails to create component', async () => {
+
+  });
+
+  it.skip('addJiraComponent fails to assign component', async () => {
+
+  });
+});

dist/lib/OctokitAction.test.js.map

@@ -1,6 +1,7 @@
 type RestStub = {
   issues: {
     createComment: (params: any) => void,
+    get: (params: any) => any,
     listComments: (params: any) => any
   }
   pulls: {
@@ -15,6 +16,14 @@ export function createOctokitRestStub(title: string, body?: string, login: strin
       createComment(params: any): void {
         console.log(`Invoked rest.issues.createComment(${JSON.stringify(params)})`);
       },
+      get(params: any): any {
+        return {
+          data: {
+            number: 24,
+            title: "Issue title"
+          }
+        }
+      },
       listComments(params: any): any {
         return {
           data: []
@@ -38,7 +47,7 @@ export function createOctokitRestStub(title: string, body?: string, login: strin
               login,
             }
           }
-        }
+        };
       },
       update(params: any): void {
         console.log(`Invoked rest.pulls.update(${JSON.stringify(params)})`);