add test coverage for google

Author: chrisns

src/google.ts

@@ -1,9 +1,8 @@
 import { google } from 'googleapis'
-
-const privatekey = JSON.parse(Buffer.from(process.env.GOOGLE_CREDENTIALS, 'base64').toString('utf-8'))
-
+import * as mod from './google'
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export async function googleAuth() {
+  const privatekey = JSON.parse(Buffer.from(process.env.GOOGLE_CREDENTIALS, 'base64').toString('utf-8'))
   const jwtClient = new google.auth.JWT(
     privatekey.client_email,
     null,
@@ -24,7 +23,7 @@ export async function getAdminService() {
 }
 
 export async function getGithubUsersFromGoogle(): Promise<Set<string>> {
-  const service = await getAdminService()
+  const service = await mod.getAdminService()
 
   const userList = await service.users.list({
     customer: 'my_customer',
@@ -34,15 +33,15 @@ export async function getGithubUsersFromGoogle(): Promise<Set<string>> {
     customFieldMask: 'Accounts',
   })
 
-  const githubAccounts = formatUserList(userList.data.users)
+  const githubAccounts = mod.formatUserList(userList.data.users)
   return githubAccounts
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export function formatUserList(users): Set<string> {
   return new Set(
     users
-      .map((user) => user?.customSchemas?.Accounts?.github.map((account) => account.value.toLowerCase()))
+      .map((user) => user.customSchemas?.Accounts?.github.map((account) => account?.value?.toLowerCase()))
       .flat()
       .filter(Boolean),
   )

tests/__snapshots__/google.spec.ts.snap

@@ -0,0 +1,24 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`google integration getGithubUsersFromGoogle 1`] = `
+Set {
+  "chrisns",
+  "foo",
+  "tar",
+  "bar",
+}
+`;
+
+exports[`google integration googleAuth 1`] = `
+Array [
+  Array [
+    "foo",
+    null,
+    "bar",
+    Array [
+      "https://www.googleapis.com/auth/admin.directory.user.readonly",
+    ],
+    "hello@example.com",
+  ],
+]
+`;

tests/google.spec.ts

@@ -1,28 +1,50 @@
+jest.mock('googleapis')
+import { google } from 'googleapis'
 import * as mod from '../src/google'
 
+const fakeUsersResponse = [
+  { customSchemas: { Accounts: { github: [{ value: 'chrisns' }] } } },
+  {
+    customSchemas: {
+      Accounts: { github: [{ value: 'Foo' }, , { value: 'tar' }] },
+    },
+  },
+  {
+    customSchemas: {
+      Accounts: { github: [{ value: 'foo' }, { value: 'bar' }] },
+    },
+  },
+]
+
 describe('google integration', () => {
-  it.todo('googleAuth')
-  it.skip('getAdminService', () => {
+  beforeEach(() => {
+    process.env.GOOGLE_EMAIL_ADDRESS = 'hello@example.com'
+    process.env.GOOGLE_CREDENTIALS = Buffer.from(JSON.stringify({ client_email: 'foo', private_key: 'bar' })).toString(
+      'base64',
+    )
+    jest.resetAllMocks()
+  })
+  it('googleAuth', () => {
+    mod.googleAuth()
+    // @ts-expect-error .mocks isn't on the original object so will fail
+    return expect(google.auth.JWT.mock.calls).toMatchSnapshot()
+  })
+  it('getAdminService', () => {
+    // @ts-expect-error mock service isn't a complete implementation, so being lazy and just doing the bare minimum
+    google.admin.mockReturnValue('adminservice')
     const result = mod.getAdminService()
-    return expect(result).resolves.toBe({})
+    return expect(result).resolves.toBe('adminservice')
   })
 
-  it.todo('getGithubUsersFromGoogle')
+  it('getGithubUsersFromGoogle', () => {
+    const service = { users: { list: jest.fn().mockResolvedValue({ data: { users: fakeUsersResponse } }) } }
+    // @ts-expect-error mock service isn't a complete implementation, so being lazy and just doing the bare minimum
+    jest.spyOn(mod, 'getAdminService').mockResolvedValue(service)
 
-  it('formatUserList', () => {
-    const response = [
-      { customSchemas: { Accounts: { github: [{ value: 'chrisns' }] } } },
-      {
-        customSchemas: {
-          Accounts: { github: [{ value: 'Foo' }, , { value: 'tar' }] },
-        },
-      },
-      {
-        customSchemas: {
-          Accounts: { github: [{ value: 'foo' }, { value: 'bar' }] },
-        },
-      },
-    ]
-    return expect(mod.formatUserList(response)).toEqual(new Set(['chrisns', 'foo', 'bar', 'tar']))
+    const result = mod.getGithubUsersFromGoogle()
+    expect(result).resolves.toMatchSnapshot()
   })
+
+  it('formatUserList', () =>
+    expect(mod.formatUserList(fakeUsersResponse)).toEqual(new Set(['chrisns', 'foo', 'bar', 'tar'])))
 })

wallaby.js

@@ -0,0 +1,23 @@
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+module.exports = function (w) {
+  return {
+    files: [
+      '*.ts',
+      'tests/**/*.json',
+      'src/**/*.ts',
+      { pattern: '.env', instrument: false },
+      // '__mocks__/**/*.ts',
+    ],
+    tests: ['tests/**/*.spec.ts'],
+    env: {
+      type: 'node',
+    },
+    testFramework: 'jest',
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    // setup: function (w) {
+    //   // eslint-disable-next-line @typescript-eslint/no-var-requires
+    //   require('dotenv').config()
+
+    // },
+  }
+}