Merge pull request #15 from github/handle-github-emu-usernames

Handle GitHub EMU usernames
github · Dec 2, 2023 · fa10401 · fa10401
2 parents 9d1a5c2 + 5a88cc3
commit fa10401
Show file tree

Hide file tree

Showing 7 changed files with 158 additions and 14 deletions.
diff --git a/__tests__/functions/allowlist.test.js b/__tests__/functions/allowlist.test.js
@@ -61,6 +61,17 @@ test('runs isAllowed checks and finds a valid admin via handle reference', async
   )
 })
 
+test('runs isAllowed checks and finds a valid handle that is a GitHub EMU', async () => {
+  process.env.INPUT_ALLOWLIST = 'username_company'
+  const contextNoAdmin = {
+    actor: 'username_company'
+  }
+  expect(await isAllowed(contextNoAdmin)).toStrictEqual(true)
+  expect(debugMock).toHaveBeenCalledWith(
+    'username_company is an allowlisted operator via handle reference'
+  )
+})
+
 test('runs isAllowed checks and does not find a valid admin', async () => {
   process.env.INPUT_ALLOWLIST = 'monalisa'
   const contextNoAdmin = {
@@ -72,6 +83,17 @@ test('runs isAllowed checks and does not find a valid admin', async () => {
   )
 })
 
+test('runs isAllowed checks and does not find a valid admin due to a bad GitHub handle', async () => {
+  process.env.INPUT_ALLOWLIST = 'mona%lisa-'
+  const contextNoAdmin = {
+    actor: 'mona%lisa-'
+  }
+  expect(await isAllowed(contextNoAdmin)).toStrictEqual(false)
+  expect(debugMock).toHaveBeenCalledWith(
+    'mona%lisa- is not a valid GitHub username... skipping allowlist check'
+  )
+})
+
 test('runs isAllowed checks and determines that all users are allowed because it is unset', async () => {
   process.env.INPUT_ALLOWLIST = 'false'
   expect(await isAllowed(context)).toStrictEqual(true)

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/licenses.txt b/dist/licenses.txt
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -30,7 +30,7 @@
     "@actions/github": "^6.0.0",
     "@octokit/plugin-retry": "^6.0.1",
     "dedent-js": "^1.0.1",
-    "github-username-regex": "^1.0.0"
+    "github-username-regex-js": "^1.0.0"
   },
   "jest": {
     "coverageReporters": [

diff --git a/src/functions/allowlist.js b/src/functions/allowlist.js
@@ -1,6 +1,6 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import githubUsernameRegex from 'github-username-regex'
+import githubUsernameRegex from 'github-username-regex-js'
 
 // Helper function to check if a user exists in an org team
 // :param actor: The user to check