CONT-1219 : fail ci for puppetlabs members if no labe

Author: malikparvez

README.md

@@ -10,6 +10,7 @@ This is a basic action that will label issues and pull request with a given labe
 | label_color | false | The color of the label. If the label already exists in the repository, this setting will have no effect. | 5319E7 |
 | org_membership | false | Contributions from users that are not members of the specified organisations will be labeled with the configured label. The value can be a single organisation or a comma-separated list of organisations. | puppetlabs |
 | logins_to_ignore | false | Contributions from the specified users will not be labeled by this action. The value can be a single login or a comma-separated list of logins. | `N/A` |
+| fail_if_member | false | Pipeline will fail, if the user is member of specified organisations and no label has been added manually. | false |
 | token | true | A token with enough privilege to view org memberships and repo content. | `N/A` |
 
 ## Security

__tests__/github.test.ts

@@ -160,13 +160,48 @@ describe('With a new github client', () => {
     )
   })
 
-  test('hasLabel returns true if the label already exists on the issue or pr', () => {
-    const result = client.hasLabel('community')
-    expect(result).toBe(true)
+  test('getLabels returns true if the label already exists on the issue or pr', () => {
+    const result = client.getLabels()
+    expect(result).toEqual(['community'])
+  })
+})
+
+describe('With a new github client without label', () => {
+  let client: GitHubClient
+
+  beforeAll(() => {
+    process.env['GITHUB_PATH'] = ''
+
+    Object.defineProperty(github, 'context', {
+      value: {
+        eventName: 'issues',
+        repo: {
+          owner: 'puppetlabs',
+          repo: 'iac'
+        },
+        issue: {
+          number: 331
+        },
+        payload: {
+          action: 'opened',
+          sender: {
+            login: 'dependabot[bot]'
+          },
+          issue: {
+            labels: [
+            ]
+          }
+        }
+      }
+    })
+
+    client = new GitHubClient('1234')
+    console.log('::stop-commands::stoptoken')
+    process.stdout.write = jest.fn()
   })
 
-  test('hasLabel returns false if the label does not exist on the issue or pr', () => {
-    const result = client.hasLabel('test')
+  test('getLabels returns false if the label does not exist on the issue or pr', () => {
+    const result = client.getLabels()
     expect(result).toBe(false)
   })
 })

action.yml

@@ -17,6 +17,10 @@ inputs:
   logins_to_ignore:
     description: 'Contributions from the specified users will not be labeled by this action. The value can be a single login or a comma-separated list of logins.'
     required: false
+  fail_if_member:
+    description: 'Pipeline will fail, if the user is member of specified organisations and no label has been added manually.'
+    default: 'false'
+    required: false
   token:
     description: 'The GitHub token to use for authentication.'
     required: true

src/github.ts

@@ -88,11 +88,10 @@ export class GitHubClient {
   }
 
   // Checks if the issue already has the label
-  hasLabel(name: string): boolean {
+  getLabels(): string[] | false {
     let labels!: Label[]
 
     if (github.context.eventName === 'issues') {
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       labels = (this.payload as IssuesEvent).issue.labels!
     } else if (
       github.context.eventName === 'pull_request' ||
@@ -103,7 +102,11 @@ export class GitHubClient {
       return false
     }
 
-    return labels.some((l) => l.name === name)
+    if (labels.length > 0) {
+      return labels.map((label) => label.name)
+    }
+
+    return false
   }
 
   /* Adds the label to the issue/pull request. It will attempt to create the label

src/main.ts

@@ -11,12 +11,14 @@ export async function run(): Promise<void> {
     const labelName = core.getInput('label_name', {required: true})
     const labelColor = core.getInput('label_color', {required: true})
     const loginsToIgnore = core.getInput('logins_to_ignore', {required: false})
+    const failIfMember = core.getInput('fail_if_member', {required: false})
     const orgs = getOrgMembershipList()
     const token = core.getInput('token', {required: true})
-
     const client = new GitHubClient(token)
+    const labels = client.getLabels()
 
-    if (client.hasLabel(labelName)) {
+    if (labels && labels.includes(labelName)) {
+      // "community" label exists
       core.info(`The '${labelName}' label is already present on this issue! 🙌`)
       return
     }
@@ -25,7 +27,11 @@ export async function run(): Promise<void> {
       (await client.checkOrgMembership(orgs)) ||
       client.isExcludedLogin(loginsToIgnore)
     ) {
-      core.info("Looks like this issue doesn't need labeling! 👍")
+      if (failIfMember === 'true' && !labels) {
+        core.setFailed('The PR does not have a label, please add one!')
+      } else {
+        core.info("Looks like this issue doesn't need labeling! 👍")
+      }
       return
     }