PP-12395: Cypress test for API keys landing page

app/controllers/simplified-account/settings/api-keys/api-keys.controller.test.js

@@ -5,9 +5,9 @@ const ACCOUNT_TYPE = 'live'
 const SERVICE_ID = 'service-id-123abc'
 
 const mockResponse = sinon.spy()
-const tokens = [{ description: 'my token', createdBy: 'system generated', issuedDate: '12 Dec 2024' }]
+const apiKeys = [{ description: 'my token', createdBy: 'system generated', issuedDate: '12 Dec 2024' }]
 const apiKeysService = {
-  getActiveKeys: sinon.stub().resolves(tokens)
+  getActiveKeys: sinon.stub().resolves(apiKeys)
 }
 
 const {
@@ -39,7 +39,7 @@ describe('Controller: settings/api-keys', () => {
 
     it('should pass context data to the response method', () => {
       expect(mockResponse.args[0][3]).to.have.property('accountType').to.equal('live')
-      expect(mockResponse.args[0][3]).to.have.property('activeKeys').to.deep.equal(tokens)
+      expect(mockResponse.args[0][3]).to.have.property('activeKeys').to.deep.equal(apiKeys)
     })
   })
 })

app/models/Token.class.js

@@ -19,6 +19,15 @@ class Token {
     return this
   }
 
+  toJson () {
+    return {
+      ...this.description && { description: this.description },
+      ...this.createdBy && { created_by: this.createdBy },
+      ...this.issuedDate && { issued_date: this.issuedDate },
+      ...this.lastUsed && { last_used: this.lastUsed }
+    }
+  }
+
   static fromJson (data) {
     if (!data) {
       return undefined

test/cypress/integration/simplified-account/service-settings/api-keys/api-keys.cy.js

@@ -0,0 +1,103 @@
+const userStubs = require('@test/cypress/stubs/user-stubs')
+const ROLES = require('@test/fixtures/roles.fixtures')
+const gatewayAccountStubs = require('@test/cypress/stubs/gateway-account-stubs')
+const apiKeysStubs = require('@test/cypress/stubs/api-keys-stubs')
+const { Token } = require('@models/Token.class')
+
+const USER_EXTERNAL_ID = 'user-123-abc'
+const SERVICE_EXTERNAL_ID = 'service-456-def'
+const GATEWAY_ACCOUNT_ID = 11
+const ACCOUNT_TYPE = 'test'
+
+const setupStubs = (role = 'admin', apiKeys = []) => {
+  cy.task('setupStubs', [
+    userStubs.getUserSuccess({
+      userExternalId: USER_EXTERNAL_ID,
+      gatewayAccountId: GATEWAY_ACCOUNT_ID,
+      serviceName: { en: 'My cool service' },
+      serviceExternalId: SERVICE_EXTERNAL_ID,
+      role: ROLES[role],
+      features: 'degatewayaccountification' // TODO remove features once simplified accounts are live
+    }),
+    gatewayAccountStubs.getAccountByServiceIdAndAccountType(SERVICE_EXTERNAL_ID, ACCOUNT_TYPE, { gateway_account_id: GATEWAY_ACCOUNT_ID }),
+    apiKeysStubs.getApiKeysForGatewayAccount(GATEWAY_ACCOUNT_ID, apiKeys)
+  ])
+}
+
+describe('Settings - API keys', () => {
+  beforeEach(() => {
+    cy.setEncryptedCookies(USER_EXTERNAL_ID)
+  })
+
+  describe('for an admin user', () => {
+
+    describe('when there are no active API keys', () => {
+      beforeEach(() => {
+        setupStubs()
+      })
+      it('should show appropriate buttons and text', () => {
+        cy.visit(`/simplified/service/${SERVICE_EXTERNAL_ID}/account/${ACCOUNT_TYPE}/settings/api-keys`)
+
+        cy.get('#api-keys').should('have.text', 'API keys')
+        cy.get('.service-settings-pane')
+          .find('a')
+          .contains('Create a new API key')
+          .should('exist')
+        cy.get('.service-settings-pane')
+          .find('h2')
+          .contains('There are no active test API keys')
+          .should('exist')
+        cy.get('.service-settings-pane')
+          .find('a')
+          .contains('Show revoked API keys')
+          .should('exist')
+      })
+    })
+
+    describe('when there are active API keys', () => {
+      const apiKeys = [
+        new Token().withCreatedBy('system generated').withDescription('description').withIssuedDate('12 Dec 2024'),
+        new Token().withCreatedBy('algae bra').withDescription('mathematical clothes').withIssuedDate('10 Dec 2024')
+      ]
+      beforeEach(() => {
+        setupStubs('admin', apiKeys)
+      })
+      it('should show appropriate buttons and text', () => {
+        cy.visit(`/simplified/service/${SERVICE_EXTERNAL_ID}/account/${ACCOUNT_TYPE}/settings/api-keys`)
+
+        cy.get('#api-keys').should('have.text', 'API keys')
+        cy.get('.service-settings-pane')
+          .find('a')
+          .contains('Create a new API key')
+          .should('exist')
+        cy.get('.service-settings-pane')
+          .find('h2')
+          .contains('Active test API keys (2)')
+          .should('exist')
+        cy.get('.service-settings-pane')
+          .find('a')
+          .contains('Show revoked API keys')
+          .should('exist')
+      })
+    })
+  })
+
+  describe('for a non-admin user', () => {
+    beforeEach(() => {
+      setupStubs('view-only')
+    })
+    it('should return forbidden when visiting the url directly', () => {
+      cy.request({
+        url: `/simplified/service/${SERVICE_EXTERNAL_ID}/account/${ACCOUNT_TYPE}/settings/api-keys`,
+        failOnStatusCode: false
+      }).then((response) => {
+        expect(response.status).to.eq(403)
+      })
+    })
+
+    it('should not show API keys link in the navigation panel', () => {
+      cy.visit(`/simplified/service/${SERVICE_EXTERNAL_ID}/account/${ACCOUNT_TYPE}/settings`)
+      cy.get('#api-keys').should('not.exist')
+    })
+  })
+})

test/cypress/stubs/api-keys-stubs.js

@@ -0,0 +1,18 @@
+const { stubBuilder } = require('@test/cypress/stubs/stub-builder')
+
+/**
+ * @param {number} gatewayAccountId
+ * @param {[Token]} tokens
+ */
+function getApiKeysForGatewayAccount (gatewayAccountId, tokens = []) {
+  const path = `/v1/frontend/auth/${gatewayAccountId}`
+  return stubBuilder('GET', path, 200, {
+    response: {
+      tokens: tokens.map(t => t.toJson())
+    }
+  })
+}
+
+module.exports = {
+  getApiKeysForGatewayAccount
+}