SDX subsystems, services, runtime groups and connections

.github/workflows/ci-feat-sonar.yaml

@@ -44,14 +44,14 @@ jobs:
           docker compose down
 
       - name: SonarCloud Scan
-        uses: sonarsource/sonarqube-scan-action@master
+        uses: sonarsource/sonarqube-scan-action@v6
         with:
           args: >
             -Dsonar.organization=bcgov-oss
             -Dsonar.projectKey=aps-portal
-            -Dsonar.host.url=https://sonarcloud.io
             -Dsonar.sources=src/auth,src/authz,src/batch,src/services
             -Dsonar.javascript.lcov.reportPaths=./src/__coverage__/lcov.info
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: https://sonarcloud.io

.gitignore

@@ -122,4 +122,7 @@ e2e/cypress/fixtures/state/*.pub
 e2e/cypress/fixtures/state/*.pem
 e2e/cypress/fixtures/state/scanResult.json
 e2e/cypress/fixtures/state/scanID.json
-e2e/cypress/downloads/
+e2e/cypress/downloads/
+
+openapi.yaml
+routes.ts

.spectral.yaml

@@ -0,0 +1,2 @@
+extends:
+  - https://raw.githubusercontent.com/bcgov/csit-api-governance-spectral-style-guide/refs/heads/main/spectral/basic-ruleset.yaml

e2e/cypress.config.ts

@@ -43,6 +43,7 @@ export default defineConfig({
         './cypress/tests/18-*/*.ts',
         './cypress/tests/19-*/*.ts',
         './cypress/tests/20-*/*.ts',
+        './cypress/tests/21-*/**/*.ts',
       ]
       return config
     },

e2e/cypress/support/auth-commands.ts

@@ -22,6 +22,7 @@ let headers: any
 const login = new LoginPage()
 
 let requestBody: any = {}
+let queryString: any = undefined
 interface formDataRequestOptions {
   method: string
   url: string
@@ -86,8 +87,9 @@ Cypress.Commands.add('createGateway', (gatewayid?: string, displayname?: string)
   }
   cy.setHeaders({ 'Content-Type': 'application/json' })
   cy.setRequestBody(payload)
-  return cy.callAPI('ds/api/v3/gateways', 'POST').then(
-    ({ apiRes: { body, status } }: any) => {
+  return cy
+    .callAPI('ds/api/v3/gateways', 'POST')
+    .then(({ apiRes: { body, status } }: any) => {
       cy.log(JSON.stringify(body, null, 2))
       expect(status).to.be.equal(200)
       if (payload.gatewayId) {
@@ -97,8 +99,7 @@ Cypress.Commands.add('createGateway', (gatewayid?: string, displayname?: string)
         expect(body.displayName).to.be.equal(payload.displayName)
       }
       return cy.wrap(body)
-    }
-  )
+    })
 })
 
 Cypress.Commands.add('deleteGatewayCli', (gatewayid: string, force: boolean = false) => {
@@ -107,20 +108,23 @@ Cypress.Commands.add('deleteGatewayCli', (gatewayid: string, force: boolean = fa
       (response) => {
         console.log(response)
         expect(response.stdout).to.contain('Gateway destroyed: ' + gatewayid)
-    })
+      }
+    )
   })
 })
 
-Cypress.Commands.add('activateGateway', (gatewayId: string, checkNoNamespace: boolean = false) => {
-  const getAllNsQuery = `
+Cypress.Commands.add(
+  'activateGateway',
+  (gatewayId: string, checkNoNamespace: boolean = false) => {
+    const getAllNsQuery = `
 query GetNamespaces {
   allNamespaces {
     id
     name
   }
 }
 `
-  const currentNsQuery = `
+    const currentNsQuery = `
   query GetCurrentNamespace {
     currentNamespace {
       name
@@ -129,33 +133,39 @@ query GetNamespaces {
     }
   }
 `
-  cy.log('< Activating namespace - ' + gatewayId)
-  // get the (true) id for the namespace
-  cy.setHeaders({ 'Content-Type': 'application/json' })
-  return cy.gqlQuery(getAllNsQuery).then((response) => {
-    const nsdata = response.apiRes.body.data.allNamespaces.find((ns: { name: string }) => ns.name === gatewayId)
-    if (nsdata) {
-      return nsdata.id
-    } else {
-      if (checkNoNamespace) {
-        return 'Namespace not found'
-      } else {
-        throw new Error('Namespace not found')
-      }
-    }
-  }).then((namespaceId) => {
-    if (namespaceId === 'Namespace not found') {
-      return namespaceId;
-    }    
-    // then activate the namespace
+    cy.log('< Activating namespace - ' + gatewayId)
+    // get the (true) id for the namespace
     cy.setHeaders({ 'Content-Type': 'application/json' })
-    cy.callAPI(`admin/switch/${namespaceId}`, 'PUT')
-    return cy.gqlQuery(currentNsQuery).then((response) => {
-      const currentNs = response.apiRes.body.data.currentNamespace
-      expect(currentNs.name).to.eq(gatewayId)
-    })
-  })
-})
+    return cy
+      .gqlQuery(getAllNsQuery)
+      .then((response) => {
+        const nsdata = response.apiRes.body.data.allNamespaces.find(
+          (ns: { name: string }) => ns.name === gatewayId
+        )
+        if (nsdata) {
+          return nsdata.id
+        } else {
+          if (checkNoNamespace) {
+            return 'Namespace not found'
+          } else {
+            throw new Error('Namespace not found')
+          }
+        }
+      })
+      .then((namespaceId) => {
+        if (namespaceId === 'Namespace not found') {
+          return namespaceId
+        }
+        // then activate the namespace
+        cy.setHeaders({ 'Content-Type': 'application/json' })
+        cy.callAPI(`admin/switch/${namespaceId}`, 'PUT')
+        return cy.gqlQuery(currentNsQuery).then((response) => {
+          const currentNs = response.apiRes.body.data.currentNamespace
+          expect(currentNs.name).to.eq(gatewayId)
+        })
+      })
+  }
+)
 
 Cypress.Commands.add('getGateways', () => {
   const getAllNsQuery = `
@@ -549,42 +559,72 @@ Cypress.Commands.add('setHeaders', (headerValues: any) => {
   headers = headerValues
 })
 
+Cypress.Commands.add('setHeader', (key: string, value: string) => {
+  headers[key] = value
+})
+
 Cypress.Commands.add('setRequestBody', (body: any) => {
   requestBody = JSON.stringify(body)
 })
 
+Cypress.Commands.add('setRequestFormData', (body: FormData) => {
+  requestBody = body
+})
+
+Cypress.Commands.add('setQueryString', (qs: any) => {
+  queryString = qs
+})
+
 Cypress.Commands.add('setAuthorizationToken', (token: string) => {
   headers['Authorization'] = 'Bearer ' + token
 })
 
-Cypress.Commands.add('callAPI', (endPoint: string, methodType: string) => {
-  let body = '{}'
-  let requestData: any = {}
-  if (methodType.toUpperCase() === 'PUT' || methodType.toUpperCase() === 'POST') {
-    body = requestBody
-  }
-
-  requestData['appname'] = 'Test1'
-  requestData['url'] = Cypress.env('BASE_URL') + '/' + endPoint
-  requestData['headers'] = headers
-  requestData['body'] = ''
-  requestData['method'] = methodType
+Cypress.Commands.add(
+  'callAPI',
+  (endPoint: string, methodType: string, formData?: boolean) => {
+    let body = '{}'
+    let requestData: any = {}
+    if (methodType.toUpperCase() === 'PUT' || methodType.toUpperCase() === 'POST') {
+      body = requestBody
+    }
 
-  cy.request({
-    url: Cypress.env('BASE_URL') + '/' + endPoint,
-    method: methodType,
-    body,
-    headers,
-    failOnStatusCode: false,
-  }).then((apiResponse) => {
-    // You can also return data or use it in further tests
-    const responseData = {
-      apiRes: apiResponse,
+    requestData['appname'] = 'Test1'
+    requestData['url'] = Cypress.env('BASE_URL') + '/' + endPoint
+    requestData['headers'] = headers
+    requestData['body'] = ''
+    requestData['method'] = methodType
+
+    const newHeaders = {
+      ...headers,
+      ...(formData
+        ? { Accept: 'application/json', 'Content-Type': 'multipart/form-data' }
+        : {}),
     }
-    // cy.addToAstraScanIdList(response2.body.status)
-    return responseData
-  })
-})
+
+    cy.request({
+      url: Cypress.env('BASE_URL') + '/' + endPoint,
+      method: methodType,
+      body: body,
+      qs: queryString,
+      headers: newHeaders,
+      failOnStatusCode: false,
+    })
+      .then((res) => {
+        if (formData || res.body instanceof ArrayBuffer) {
+          res.body = JSON.parse(new TextDecoder().decode(res.body))
+        }
+        return res
+      })
+      .then((apiResponse) => {
+        // You can also return data or use it in further tests
+        const responseData = {
+          apiRes: apiResponse,
+        }
+        // cy.addToAstraScanIdList(response2.body.status)
+        return responseData
+      })
+  }
+)
 
 Cypress.Commands.add('makeAPIRequest', (endPoint: string, methodType: string) => {
   let body = {}
@@ -644,25 +684,27 @@ Cypress.Commands.add('makeAPIRequest', (endPoint: string, methodType: string) =>
 
 Cypress.Commands.add('gqlQuery', (query, variables = {}) => {
   cy.loginByAuthAPI('', '').then((token_res: any) => {
-    cy.setHeaders({ 
-      'Accept': 'application/json',
-      'Content-Type': 'application/json'
+    cy.setHeaders({
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
     })
     cy.setAuthorizationToken(token_res.token)
-    return cy.request({
-      url: Cypress.env('BASE_URL') + '/gql/api',
-      method: 'POST',
-      headers,
-      body: JSON.stringify({ query, variables }),
-      failOnStatusCode: false,
-    }).then((apiResponse) => {
-      // You can also return data or use it in further tests
-      const responseData = {
-        apiRes: apiResponse,
-      }
-      // cy.addToAstraScanIdList(response2.body.status)
-      return responseData
-    })
+    return cy
+      .request({
+        url: Cypress.env('BASE_URL') + '/gql/api',
+        method: 'POST',
+        headers,
+        body: JSON.stringify({ query, variables }),
+        failOnStatusCode: false,
+      })
+      .then((apiResponse) => {
+        // You can also return data or use it in further tests
+        const responseData = {
+          apiRes: apiResponse,
+        }
+        // cy.addToAstraScanIdList(response2.body.status)
+        return responseData
+      })
   })
 })
 
@@ -678,9 +720,9 @@ Cypress.Commands.add('getUserSession', () => {
   cy.request({
     method: 'GET',
     url: Cypress.config('baseUrl') + '/admin/session',
-    failOnStatusCode: true
+    failOnStatusCode: true,
   }).as('login')
-});
+})
 
 Cypress.Commands.add('interceptUserSession', () => {
   cy.intercept(Cypress.config('baseUrl') + '/admin/session').as('login')

e2e/cypress/support/global.d.ts

@@ -3,8 +3,8 @@
 
 declare namespace Cypress {
   interface Namespace {
-    id: string;
-    name: string;
+    id: string
+    name: string
   }
 
   interface Chainable<Subject> {
@@ -33,10 +33,7 @@ declare namespace Cypress {
 
     preserveCookiesDefaults(): void
 
-    createGateway(
-      gatewayid?: string,
-      displayname?: string,
-    ): Chainable<any>
+    createGateway(gatewayid?: string, displayname?: string): Chainable<any>
 
     deleteGatewayCli(gatewayid: string, force: boolean): Chainable<any>
 
@@ -93,18 +90,28 @@ declare namespace Cypress {
 
     setHeaders(headerValues: any): void
 
+    setHeader(key: string, value: string): void
+
     setRequestBody(requestBody: any): void
 
+    setQueryString(qs: any): void
+
+    setRequestFormData(body: FormData): void
+
     setAuthorizationToken(token: string): void
-    
+
     gqlQuery<T = any>(query: string, variables?: Record<string, any>): Chainable<T>
-
-    callAPI(endPoint: string, methodType: string): Chainable<Cypress.Response<any>>
+
+    callAPI(
+      endPoint: string,
+      methodType: string,
+      formData?: boolean
+    ): Chainable<Cypress.Response<any>>
 
     makeAPIRequest(endPoint: string, methodType: string): Chainable<Cypress.Response<any>>
 
     getUserSession(): Chainable<Cypress.Response<any>>
-    
+
     interceptUserSession(): Chainable<Cypress.Response<any>>
 
     compareJSONObjects(

e2e/cypress/support/prep-commands.ts

@@ -45,7 +45,7 @@ Cypress.Commands.add('buildOrgGatewayDatasetAndProduct', (): Cypress.Chainable<a
               member: {
                 email: '[email protected]',
               },
-              roles: ['organization-admin'],
+              roles: ['organization-admin', 'system-owner'],
             },
           ],
         }
@@ -143,7 +143,7 @@ Cypress.Commands.add('buildOrgGatewayDatasetAndProduct', (): Cypress.Chainable<a
                 expect(JSON.stringify(body)).to.be.equal(JSON.stringify(match))
 
                 // New Gateway
-                cy.setRequestBody({})
+                cy.setRequestBody({ displayName: `Gateway ${payload.name}` })
                 return cy
                   .callAPI('ds/api/v3/gateways', 'POST')
                   .then(({ apiRes: { body, status } }: any) => {