Merge pull request #956 from bcgov/test

Create Latest Release

.github/workflows/jira.yaml

@@ -9,3 +9,18 @@ jobs:
       - uses: ikethecoder/sync-issues-github-jira@dev
         with:
           webhook-url: ${{ secrets.JIRA_WEBHOOK_URL }}
+
+  cleanup-runs:
+    name: Delete workflow runs
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write    
+    steps:
+      - name: Delete workflow runs
+        uses: Mattraks/delete-workflow-runs@v2
+        with:
+          token: ${{ github.token }}
+          repository: ${{ github.repository }}
+          retain_days: 1
+          keep_minimum_runs: 5
+          delete_workflow_pattern: jira.yaml

README.md

@@ -1,7 +1,7 @@
 # API Services Portal
 
 [![Lifecycle:Stable](https://img.shields.io/badge/Lifecycle-Stable-97ca00?style=for-the-badge)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
-[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/bcgov/aps-portal/Build%20and%20Deploy/dev?style=for-the-badge)](https://github.com/bcgov/api-services-portal/actions/workflows/ci-build-deploy.yaml)
+[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/bcgov/api-services-portal/ci-build-deploy.yaml?branch=dev&style=for-the-badge)](https://github.com/bcgov/api-services-portal/actions/workflows/ci-build-deploy.yaml)
 [![Coverage](https://img.shields.io/sonar/coverage/aps-portal/dev?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge)](https://sonarcloud.io/summary/new_code?id=aps-portal)
 ![GitHub](https://img.shields.io/github/license/bcgov/aps-portal?style=for-the-badge)
 ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/bcgov/aps-portal?label=release&style=for-the-badge)
@@ -58,10 +58,13 @@ Once running, the `api services portal` application is reachable via `localhost:
 
 1. Create a `.env` from `.env.local` file
 2. Create a `.env` from `.env.local` file under `feeds` directory
-3. Run `docker-compose up` to spin up a local development environment with services (Postgres, Keycloak, OAuth2-proxy, APS-Portal, Feeder and Kong Gateway)
-4. Go to: http://oauth2proxy.localtest.me:4180
-5. To login, use username `local` and password `local`, or username `awsummer@idir` and password `awsummer`
-6. `docker-compose down` : Removes all the hosted services
+3. Remove cypress from docker-compose file (L106-129 & L217-229)
+4. Run build steps [here](https://github.com/bcgov/api-services-portal/tree/dev/e2e#build-gateway-api-image)
+5. Run `docker-compose build`
+5. Run `docker-compose up` to spin up a local development environment with services (Postgres, Keycloak, OAuth2-proxy, APS-Portal, Feeder and Kong Gateway)
+6. Go to: http://oauth2proxy.localtest.me:4180
+7. To login, use username `local` and password `local`, or username `janis@idir` and password `awsummer`
+8. `docker-compose down` : Removes all the hosted services
 
 ##### Note:
 

e2e/cypress/fixtures/common-testdata.json

@@ -0,0 +1,82 @@
+{
+  "namespace": "newplatform",
+  "deleteResources": {
+    "namespace": "gw-a9232"
+  },
+  "clientCredentials": {
+    "namespace": "gw-d2c50"
+  },
+  "namespacePreview": {
+    "namespace": "gw-16a3a"
+  },
+  "orgAssignment": {
+    "namespace": "gw-f016e"
+  },
+  "orgAssignmentMultipleAdmin": {
+    "namespace": "orgassignment1"
+  },
+  "orgAssignmentOrgUnit": {
+    "namespace": "orgassign-unit"
+  },
+  "checkPermission": {
+    "namespace": "gw-deedd",
+    "grantPermission": {
+      "Mark": {
+        "userName": "Mark F Mark L",
+        "email": "[email protected]",
+        "accessRole": [
+          "Access.Manage"
+        ]
+      },
+      "Mark_NV": {
+        "userName": "Mark F Mark L",
+        "email": "[email protected]",
+        "accessRole": [
+          "Namespace.View"
+        ]
+      },
+      "Wendy": {
+        "userName": "Wendy F Wendy L",
+        "email": "[email protected]",
+        "accessRole": [
+          "Namespace.Manage",
+          "CredentialIssuer.Admin"
+        ]
+      },
+      "Wendy_NM": {
+        "userName": "Wendy F Wendy L",
+        "email": "[email protected]",
+        "accessRole": [
+          "Namespace.Manage"
+        ]
+      },
+      "Wendy_CA": {
+        "userName": "Wendy F Wendy L",
+        "email": "[email protected]",
+        "accessRole": [
+          "CredentialIssuer.Admin"
+        ]
+      },
+      "Wendy_GC": {
+        "userName": "Wendy F Wendy L",
+        "email": "[email protected]",
+        "accessRole": [
+          "GatewayConfig.Publish",
+          "Namespace.View"
+        ]
+      },
+      "Janis": {
+        "userName": "Janis Smith",
+        "email": "[email protected]",
+        "accessRole": [
+          "Namespace.Manage",
+          "CredentialIssuer.Admin"
+        ]
+      }
+    }
+  },
+  "apiTest": {
+    "namespace": "gw-c3f31",
+    "delete_namespace": "testplatform"
+  }
+}

e2e/cypress/fixtures/developer.json

@@ -146,6 +146,16 @@
       "environment": "dev"
     }
   },
+  "deleteResources":{
+    "application": {
+      "name": "Delete-Auto Test App",
+      "description": "Test application for auto test"
+    },
+    "product": {
+      "name": "Delete-Auto Test Product",
+      "environment": "dev"
+    }
+  },
   "elevatedAccess":{
     "application": {
       "name": "Request for Elevated Acess",

e2e/cypress/fixtures/service-plugin_A.yml

@@ -0,0 +1,34 @@
+services:
+- name: a-service-for-newplatform
+  host: httpbin.org
+  tags: [ns.newplatform.test]
+  port: 443
+  protocol: https
+  retries: 0
+  routes:
+  - name: a-service-for-newplatform-route
+    tags: [ns.newplatform.test]
+    hosts:
+      - a-service-for-newplatform.api.gov.bc.ca
+    paths:
+      - /
+    methods:
+      - GET
+    strip_path: false
+    https_redirect_status_code: 426
+    path_handling: v0
+
+  plugins:
+  - name: key-auth
+    tags: [ ns.newplatform.test ]
+    protocols: [ http, https ]
+    config:
+      key_names: ["X-API-KEY"]
+      run_on_preflight: true
+      hide_credentials: true
+      key_in_body: false
+  - name: acl
+    tags: [ ns.newplatform.test ]
+    config:
+      hide_groups_header: true
+      allow: [ "406CB7CF" ]

e2e/cypress/fixtures/service-plugin_B.yml

@@ -0,0 +1,34 @@
+services:
+- name: a-service-for-newplatform-test
+  host: httpbin.org
+  tags: [ns.newplatform.test]
+  port: 443
+  protocol: https
+  retries: 0
+  routes:
+  - name: a-service-for-newplatform-test-route
+    tags: [ns.newplatform.test]
+    hosts:
+      - a-service-for-newplatform-test.api.gov.bc.ca
+    paths:
+      - /
+    methods:
+      - GET
+    strip_path: false
+    https_redirect_status_code: 426
+    path_handling: v0
+
+  plugins:
+  - name: key-auth
+    tags: [ ns.newplatform.test ]
+    protocols: [ http, https ]
+    config:
+      key_names: ["X-API-KEY"]
+      run_on_preflight: true
+      hide_credentials: true
+      key_in_body: false
+  - name: acl
+    tags: [ ns.newplatform.test ]
+    config:
+      hide_groups_header: true
+      allow: [ "9AA97172" ]

e2e/cypress/pageObjects/authProfile.ts

@@ -175,7 +175,7 @@ class AuthorizationProfile {
         cy.wrap($e1).find('button').eq(1).click()
         cy.wait(2000)
         cy.wrap($e1).find('button').last().click({force: true})
-        cy.verifyToastMessage(authProfileName +' deleted')
+        // cy.verifyToastMessage(authProfileName +' deleted')
         return false
       }
     })

e2e/cypress/pageObjects/consumers.ts

@@ -45,6 +45,7 @@ export default class ConsumersPage {
   linkConsumerToNamespaceBtn: string = '[data-testid="link-consumer-namespace"]'
   userNameTxt: string = '[data-testid="link-consumer-username"]'
   linkBtn: string = '[data-testid="link-consumer-link-btn"]'
+  productDetails: string = '[data-testid="product-list-table"]'
 
   clickOnRateLimitingOption() {
     cy.get(this.rateLimitingOption, { timeout: 2000 }).click()
@@ -202,7 +203,7 @@ export default class ConsumersPage {
   }
 
   editConsumerDialog() {
-    cy.get('[data-testid="product-list-table"]').then($button => {
+    cy.get(this.productDetails).then($button => {
       if ($button.is(':visible')) {
         cy.contains('Edit').first().click()
       }
@@ -374,4 +375,12 @@ export default class ConsumersPage {
   getText() {
     cy.get('[data-testid="all-consumer-control-tbl"]').find('tr').last().find('td').first().find('a').as('inputValue')
   }
+
+  revokeProductEnvAccess(prodEnv: any) {
+    cy.get(this.productDetails).find('tr').each(($row) => {
+      if ($row.find('td:nth-child(1)').text() == prodEnv) {
+        cy.wrap($row).find('button').last().click({ force: true })
+      }
+    })
+  }
 }

e2e/cypress/pageObjects/home.ts

@@ -56,7 +56,7 @@ class HomePage {
       cy.wait(1000)
       cy.get(this.namespaceNameInput).next('div').then(($ele) => {
         let validationMessage = $ele.text()
-        assert.equal(validationMessage,"Namespace name must be between 5 and 15 alpha-numeric lowercase characters and begin with an alphabet.")
+        assert.equal(validationMessage,"Namespace name must be between 5 and 15 alpha-numeric lowercase characters and start and end with an alphabet.")
       })
       // cy.verifyToastMessage("Namespace create failed")
     })

e2e/cypress/support/auth-commands.ts

@@ -95,17 +95,20 @@ Cypress.Commands.add('resetCredential', (accessRole: string) => {
   cy.visit('/')
   cy.reload()
   cy.fixture('apiowner').as('apiowner')
+  cy.fixture('common-testdata').as('common-testdata')
   cy.preserveCookies()
   cy.visit(login.path)
-  cy.get('@apiowner').then(({ user, checkPermission }: any) => {
-    cy.login(user.credentials.username, user.credentials.password)
-    cy.log('Logged in!')
-    home.useNamespace(checkPermission.namespace)
-    cy.visit(na.path)
-    na.revokeAllPermission(checkPermission.grantPermission[accessRole].userName)
-    cy.wait(2000)
-    na.clickGrantUserAccessButton()
-    na.grantPermission(checkPermission.grantPermission[accessRole])
+  cy.get('@apiowner').then(({ user }: any) => {
+    cy.get('@common-testdata').then(({ checkPermission }: any) => {
+      cy.login(user.credentials.username, user.credentials.password)
+      cy.log('Logged in!')
+      home.useNamespace(checkPermission.namespace)
+      cy.visit(na.path)
+      na.revokeAllPermission(checkPermission.grantPermission[accessRole].userName)
+      cy.wait(2000)
+      na.clickGrantUserAccessButton()
+      na.grantPermission(checkPermission.grantPermission[accessRole])
+    })
   })
 })
 
@@ -241,17 +244,26 @@ Cypress.Commands.add('getServiceOrRouteID', (configType: string, host: string) =
   }).then((res) => {
     expect(res.status).to.eq(200)
     if (config === 'routes') {
-      cy.saveState(config + 'ID', Cypress._.get((Cypress._.filter(res.body.data, ["hosts", [host+".api.gov.bc.ca"]]))[0], 'id'))
+      cy.saveState(config + 'ID', Cypress._.get((Cypress._.filter(res.body.data, ["hosts", [host + ".api.gov.bc.ca"]]))[0], 'id'))
     }
     else {
       cy.saveState(config + 'ID', Cypress._.get((Cypress._.filter(res.body.data, ["name", host]))[0], 'id'))
     }
   })
 })
 
-Cypress.Commands.add('publishApi', (fileName: string, namespace: string, flag?: boolean) => {
+Cypress.Commands.add('publishApi', (fileNames: any, namespace: string, flag?: boolean) => {
   let fixtureFile = flag ? "state/regen" : "state/store";
   cy.log('< Publish API')
+  let fileName = ''
+  if (fileNames instanceof Array) {
+    for (const filepath of fileNames) {
+      fileName = fileName + ' ./cypress/fixtures/' + filepath;
+    }
+  }
+  else {
+    fileName = ' ./cypress/fixtures/' + fileNames
+  }
   const requestName: string = 'publishAPI'
   cy.fixture(fixtureFile).then((creds: any) => {
     const serviceAcctCreds = JSON.parse(creds.credentials)
@@ -263,7 +275,7 @@ Cypress.Commands.add('publishApi', (fileName: string, namespace: string, flag?:
             cy.executeCliCommand('gwa config set --token ' + res.body.access_token).then((response) => {
               {
                 expect(response.stdout).to.contain("Config settings saved")
-                cy.executeCliCommand('gwa pg ./cypress/fixtures/' + fileName).then((response) => {
+                cy.executeCliCommand('gwa pg ' + fileName).then((response) => {
                   expect(response.stdout).to.contain("Gateway config published")
                 })
               }
@@ -502,7 +514,7 @@ Cypress.Commands.add('updatePropertiesOfPluginFile', (filename: string, property
     if (propertyName === "config.anonymous") {
       obj.plugins[0].config.anonymous = propertyValue
     }
-    else if (propertyName === "tags"){
+    else if (propertyName === "tags") {
       obj.plugins[0][propertyName] = propertyValue
     }
     else {
@@ -573,7 +585,7 @@ Cypress.Commands.add('forceVisit', (url: string) => {
   });
 });
 
-Cypress.Commands.add('updateJsonBoby', (json: any, key: string, newValue: string):any => {
+Cypress.Commands.add('updateJsonBoby', (json: any, key: string, newValue: string): any => {
   json[key] = newValue
   return json
 });

e2e/cypress/support/global.d.ts

@@ -36,7 +36,7 @@ declare namespace Cypress {
       client_secret: string
     ): Chainable<Cypress.Response<any>>
 
-    publishApi(fileName: string, namespace: string, flag?: boolean): Chainable<Cypress.Response<any>>
+    publishApi(fileNames: any, namespace: string, flag?: boolean): Chainable<Cypress.Response<any>>
 
     getServiceOrRouteID(configType: string, host: string
     ): Chainable<Cypress.Response<any>>

e2e/cypress/support/util-commands.ts

@@ -111,9 +111,7 @@ Cypress.Commands.add('resetState', () => {
 })
 
 Cypress.Commands.add('updateJsonValue', (filePath: string, jsonPath: string, newValue: string, index?: any) => {
-  debugger
   cy.readFile('cypress/fixtures/' + filePath).then(currState => {
-    debugger
 
     const keys = jsonPath.split('.'); // Split the keyPath using dot notation
     let currentObj = currState;
@@ -142,7 +140,6 @@ Cypress.Commands.add('executeCliCommand', (command: string) => {
 })
 
 Cypress.Commands.add('replaceWordInJsonObject', (targetWord: string, replacement: string, fileName: string) => {
-  debugger
   cy.readFile('cypress/fixtures/' + fileName).then((content: any) => {
     let regex = new RegExp(targetWord, 'g');
     let modifiedString = content.replace(regex, replacement);
@@ -165,7 +162,6 @@ Cypress.Commands.add('gwaPublish', (type: string, fileName: string) => {
 Cypress.Commands.add('deleteFileInE2EFolder', (fileName: string) => {
   const currentDirectory = Cypress.config('fileServerFolder'); // Get the current working directory
   const filePath = path.join(currentDirectory, fileName)
-  debugger
   try {
     cy.exec(`rm -f ${filePath}`);
     cy.log(`File '${fileName}' has been deleted from the e2e folder.`);