update integration with tests to cover credential preload, getAuth, and logout

Author: michaelmalave

test/api-client.test.ts

@@ -8,6 +8,7 @@ import * as sinon from 'sinon'
 import {stderr} from 'stdout-stderr'
 
 import {Command as CommandBase} from '../src/command.js'
+import {setCredentialManagerProvider} from '../src/credential-manager.js'
 import {RequestId, requestIdHeader} from '../src/request-id.js'
 import {restoreCredentialManagerStub, stubCredentialManager} from './helpers/credential-manager-stub.js'
 
@@ -28,6 +29,7 @@ const test = fancy
 
 describe('api_client', () => {
   beforeEach(function () {
+    nock.cleanAll()
     process.env = {}
     debug.disable()
     api = nock('https://api.heroku.com')
@@ -40,6 +42,56 @@ describe('api_client', () => {
     restoreCredentialManagerStub()
   })
 
+  describe('getAuth', () => {
+    test
+      .it('returns token from credential manager', async ctx => {
+        stubCredentialManager('token-from-store')
+        const cmd = new Command([], ctx.config)
+        cmd.config = ctx.config
+        expect(await cmd.heroku.getAuth()).to.equal('token-from-store')
+      })
+
+    test
+      .it('returns cached auth when _auth is already set', async ctx => {
+        stubCredentialManager('ignored-after-cache')
+        const cmd = new Command([], ctx.config)
+        cmd.config = ctx.config
+        cmd.heroku.auth = 'cached-only'
+        expect(await cmd.heroku.getAuth()).to.equal('cached-only')
+      })
+  })
+
+  describe('logout', () => {
+    const removeAuthCalls: {account: string | undefined; hosts: string[]}[] = []
+
+    beforeEach(() => {
+      removeAuthCalls.length = 0
+      setCredentialManagerProvider({
+        async getAuth() {
+          return 'logout-test-token'
+        },
+        async removeAuth(account: string | undefined, hosts: string[]) {
+          removeAuthCalls.push({account, hosts})
+        },
+        async saveAuth() {},
+      })
+      api.delete('/oauth/sessions/~').reply(200, {})
+      api.get('/oauth/authorizations').reply(200, [])
+      api.get('/oauth/authorizations/~').reply(200, {})
+    })
+
+    test
+      .it('calls removeAuth with api and git hosts after revoking session', async ctx => {
+        const cmd = new Command([], ctx.config)
+        cmd.config = ctx.config
+        await cmd.heroku.logout()
+        expect(removeAuthCalls).to.have.length(1)
+        expect(removeAuthCalls[0].account).to.be.undefined
+        expect(removeAuthCalls[0].hosts).to.deep.equal(['api.heroku.com', 'git.heroku.com'])
+        expect(cmd.heroku.auth).to.be.undefined
+      })
+  })
+
   test
     .it('makes an HTTP request', async ctx => {
       api = nock('https://api.heroku.com', {

test/command.test.ts

@@ -8,6 +8,9 @@ const __dirname = dirname(__filename)
 
 import {Command} from '../src/command.js'
 import * as flags from '../src/flags/index.js'
+import {restoreCredentialManagerStub, stubCredentialManager, stubCredentialManagerWithNoCredentials} from './helpers/credential-manager-stub.js'
+
+const {env: processEnv} = process
 
 const test = fancy
   .add('config', () => {
@@ -37,6 +40,45 @@ class CommandWithoutPromptInBaseFlags extends TestableCommand {
 }
 
 describe('command', () => {
+  describe('credential preload in init', () => {
+    beforeEach(() => {
+      process.env = {}
+      stubCredentialManager('mypass')
+    })
+
+    afterEach(() => {
+      process.env = processEnv
+      restoreCredentialManagerStub()
+    })
+
+    test
+      .it('populates this.heroku.auth after init so sync checks see the token', async (ctx: any) => {
+        const cmd = new MyCommand([], ctx.config)
+        cmd.config = ctx.config
+        await cmd.init()
+        expect(cmd.heroku.auth).to.equal('mypass')
+      })
+
+    test
+      .it('uses HEROKU_API_KEY over credential store in init', async (ctx: any) => {
+        process.env.HEROKU_API_KEY = 'env-token'
+        const cmd = new MyCommand([], ctx.config)
+        cmd.config = ctx.config
+        await cmd.init()
+        expect(cmd.heroku.auth).to.equal('env-token')
+      })
+
+    test
+      .it('leaves this.heroku.auth undefined after init when no credentials exist', async (ctx: any) => {
+        restoreCredentialManagerStub()
+        stubCredentialManagerWithNoCredentials()
+        const cmd = new MyCommand([], ctx.config)
+        cmd.config = ctx.config
+        await cmd.init()
+        expect(cmd.heroku.auth).to.be.undefined
+      })
+  })
+
   it('sets app', () => class AppCommand extends Command {
     static flags = {
       app: flags.app(),

test/helpers/credential-manager-stub.ts

@@ -14,6 +14,17 @@ export function stubCredentialManager(token = DEFAULT_TOKEN) {
   })
 }
 
+/** Simulates credential-manager when no token is stored (getAuth throws; APIClient.getAuth returns undefined). */
+export function stubCredentialManagerWithNoCredentials() {
+  setCredentialManagerProvider({
+    async getAuth() {
+      throw new Error('No credentials found. Please log in.')
+    },
+    async removeAuth() {},
+    async saveAuth() {},
+  })
+}
+
 export function restoreCredentialManagerStub() {
   setCredentialManagerProvider({
     getAuth: real.getAuth,