feat: migrate teamsettings to v2 endpoint

src/api.authz.test.ts

@@ -1,6 +1,5 @@
 /* eslint-disable @typescript-eslint/no-empty-function */
 
-import { Express } from 'express'
 import { mockDeep } from 'jest-mock-extended'
 import { initApp, loadSpec } from 'src/app'
 import getToken from 'src/fixtures/jwt'
@@ -9,8 +8,10 @@ import request, { SuperAgentTest } from 'supertest'
 import { HttpError } from './error'
 import { Git } from './git'
 import { getSessionStack } from './middleware'
-import { App, CodeRepo, SealedSecret } from './otomi-models'
+import { App, CodeRepo, Repo, SealedSecret } from './otomi-models'
 import * as getValuesSchemaModule from './utils'
+import { RepoService } from './services/RepoService'
+import { Express } from 'express'
 
 const platformAdminToken = getToken(['platform-admin'])
 const teamAdminToken = getToken(['team-admin', 'team-team1'])
@@ -22,10 +23,10 @@ const otherTeamId = 'team2'
 jest.mock('./k8s_operations')
 jest.mock('./utils/sealedSecretUtils')
 beforeAll(async () => {
-  jest.spyOn(console, 'log').mockImplementation(() => {})
-  jest.spyOn(console, 'debug').mockImplementation(() => {})
-  jest.spyOn(console, 'info').mockImplementation(() => {})
-  jest.spyOn(console, 'warn').mockImplementation(() => {})
+  // jest.spyOn(console, 'log').mockImplementation(() => {})
+  // jest.spyOn(console, 'debug').mockImplementation(() => {})
+  // jest.spyOn(console, 'info').mockImplementation(() => {})
+  // jest.spyOn(console, 'warn').mockImplementation(() => {})
 
   jest.spyOn(getValuesSchemaModule, 'getValuesSchema').mockResolvedValue({})
 
@@ -42,14 +43,14 @@ describe('API authz tests', () => {
     _otomiStack.git = mockDeep<Git>()
     _otomiStack.doDeployment = jest.fn().mockImplementation(() => Promise.resolve())
     _otomiStack.transformApps = jest.fn().mockReturnValue([])
-    await _otomiStack.initRepo()
+    _otomiStack.repoService = new RepoService({} as Repo)
     otomiStack = _otomiStack as jest.Mocked<OtomiStack>
 
     otomiStack.saveTeam = jest.fn().mockResolvedValue(undefined)
     otomiStack.doDeployment = jest.fn().mockImplementation(() => Promise.resolve())
     otomiStack.doRepoDeployment = jest.fn().mockImplementation(() => Promise.resolve())
     otomiStack.doTeamDeployment = jest.fn().mockImplementation(() => Promise.resolve())
-    await otomiStack.loadValues()
+    otomiStack.isLoaded = true
     await otomiStack.createTeam({ name: 'team1' })
     await otomiStack.createTeam({ name: 'team2' })
     app = await initApp(otomiStack)
@@ -717,6 +718,7 @@ describe('API authz tests', () => {
     })
 
     test('team member can test code repository url', async () => {
+      jest.spyOn(otomiStack, 'getTestRepoConnect').mockResolvedValue({})
       await agent
         .get(`/v1/testRepoConnect`)
         .query({ url: data.repositoryUrl })

src/api/v2/teams.ts

@@ -0,0 +1,34 @@
+import Debug from 'debug'
+import { Operation, OperationHandlerArray } from 'express-openapi'
+import { AplTeamSettingsRequest, OpenApiRequestExt } from 'src/otomi-models'
+
+const debug = Debug('otomi:api:v2:teams')
+
+export default function (): OperationHandlerArray {
+  const get: Operation = [
+    ({ otomi }: OpenApiRequestExt, res): void => {
+      debug('getTeams')
+      // we filter admin team here as it is not for console
+      const teams = (otomi.getAplTeams() || [])
+        .filter((t) => t.metadata.name !== 'admin')
+        .map(({ spec, ...rest }) => ({
+          ...rest,
+          spec: { ...spec, password: undefined },
+        }))
+
+      res.json(teams)
+    },
+  ]
+  const post: Operation = [
+    async ({ otomi, body }: OpenApiRequestExt, res): Promise<void> => {
+      debug('createTeam')
+      const data = await otomi.createAplTeam(body as AplTeamSettingsRequest)
+      res.json(data)
+    },
+  ]
+  const api = {
+    get,
+    post,
+  }
+  return api
+}

src/api/v2/teams/{teamId}.ts

@@ -0,0 +1,43 @@
+import Debug from 'debug'
+import { Operation, OperationHandlerArray } from 'express-openapi'
+import { AplTeamSettingsRequest, OpenApiRequestExt } from 'src/otomi-models'
+
+const debug = Debug('otomi:api:v2:teams')
+
+export default function (): OperationHandlerArray {
+  const del: Operation = [
+    async ({ otomi, params: { teamId } }: OpenApiRequestExt, res): Promise<void> => {
+      debug(`deleteTeam(${teamId})`)
+      await otomi.deleteTeam(teamId)
+      res.json({})
+    },
+  ]
+  const get: Operation = [
+    ({ otomi, params: { teamId } }: OpenApiRequestExt, res): void => {
+      debug(`getTeam(${teamId})`)
+      const data = otomi.getAplTeam(teamId)
+      res.json(data)
+    },
+  ]
+  const put: Operation = [
+    async ({ otomi, params: { teamId }, body }: OpenApiRequestExt, res): Promise<void> => {
+      debug(`editTeam(${teamId})`)
+      const data = await otomi.editAplTeam(teamId, body as AplTeamSettingsRequest)
+      res.json(data)
+    },
+  ]
+  const patch: Operation = [
+    async ({ otomi, params: { teamId }, body }: OpenApiRequestExt, res): Promise<void> => {
+      debug(`editTeam(${teamId}, patch)`)
+      const data = await otomi.editAplTeam(teamId, body as AplTeamSettingsRequest, true)
+      res.json(data)
+    },
+  ]
+  const api = {
+    delete: del,
+    get,
+    put,
+    patch,
+  }
+  return api
+}

src/app.ts

@@ -152,7 +152,7 @@ export const getAppList = (): string[] => {
   return appsSchema.enum as string[]
 }
 
-export async function initApp(inOtomiStack?: OtomiStack | undefined) {
+export async function initApp(inOtomiStack?: OtomiStack) {
   const lightship = createLightship()
   const app = express()
   const apiRoutesPath = path.resolve(__dirname, 'api')
@@ -170,12 +170,14 @@ export async function initApp(inOtomiStack?: OtomiStack | undefined) {
     })
   }
   // Transforms the interval to minutes
-  const gitCheckVersionInterval = env.CHECK_LATEST_COMMIT_INTERVAL * 60 * 1000
-  setInterval(async function () {
-    await checkAgainstGitea()
-  }, gitCheckVersionInterval)
+  if (!env.isTest) {
+    const gitCheckVersionInterval = env.CHECK_LATEST_COMMIT_INTERVAL * 60 * 1000
+    setInterval(async function () {
+      await checkAgainstGitea()
+    }, gitCheckVersionInterval)
+  }
   let server: Server | undefined
-  if (!inOtomiStack) {
+  if (!inOtomiStack && !env.isTest) {
     // initialize full server
     const { PORT = 8080 } = process.env
     server = app
@@ -194,19 +196,20 @@ export async function initApp(inOtomiStack?: OtomiStack | undefined) {
     })
   }
 
-  // emit resource status every 10 seconds
-  const emitResourceStatusInterval = 10 * 1000
-  const errorSet = new Set()
-  setInterval(async function () {
-    try {
-      await resourceStatus(errorSet)
-    } catch (e) {
-      debug(e)
-    }
-  }, emitResourceStatusInterval)
-
-  // and register session middleware
+  if (!env.isTest) {
+    // emit resource status every 10 seconds
+    const emitResourceStatusInterval = 10 * 1000
+    const errorSet = new Set()
+    setInterval(async function () {
+      try {
+        await resourceStatus(errorSet)
+      } catch (e) {
+        debug(e)
+      }
+    }, emitResourceStatusInterval)
+  }
   app.use(sessionMiddleware(server as Server))
+  // and register session middleware
   // now we can initialize the more specific routes
   initialize({
     // @ts-ignore

src/openapi/api.yaml

@@ -111,6 +111,7 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Team'
+
   '/v1/teams/{teamId}':
     parameters:
       - $ref: '#/components/parameters/teamParams'
@@ -154,6 +155,83 @@ paths:
         '200':
           description: Successfully deleted a team
 
+  /v2/teams:
+    get:
+      operationId: getAplTeams
+      description: Get teams collection
+      x-aclSchema: Team
+      responses:
+        '200':
+          description: Successfully obtained teams collection
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/AplTeamSettingsResponse'
+    post:
+      operationId: createAplTeam
+      description: Create a team
+      x-aclSchema: Team
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AplTeamSettingsRequest'
+        description: Team object that needs to be added to the collection
+        required: true
+      responses:
+        <<: *DefaultPostResponses
+        '200':
+          description: Successfully obtained teams collection
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AplTeamSettingsResponse'
+
+  '/v2/teams/{teamId}':
+    parameters:
+      - $ref: '#/components/parameters/teamParams'
+    get:
+      operationId: getAplTeam
+      description: Get a specific team
+      x-aclSchema: Team
+      responses:
+        <<: *DefaultGetResponses
+        '200':
+          description: Successfully obtained team
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AplTeamSettingsResponse'
+    put:
+      operationId: editAplTeam
+      description: Edit a team
+      x-aclSchema: Team
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AplTeamSettingsRequest'
+        description: Team object that contains updated values
+        required: true
+      responses:
+        <<: *DefaultGetResponses
+        '200':
+          description: Successfully edited team
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AplTeamSettingsResponse'
+    delete:
+      operationId: deleteAplTeam
+      description: Delete team
+      x-aclSchema: Team
+      responses:
+        <<: *DefaultGetResponses
+        '200':
+          description: Successfully deleted a team
+
   /v1/services:
     get:
       operationId: getAllServices
@@ -2848,7 +2926,7 @@ components:
       properties:
         kind:
           type: string
-          enum: [AplTeamSettings]
+          enum: [AplTeamSettingSet]
         spec:
           $ref: 'team.yaml#/AplTeamSpec'
       required:
@@ -2857,12 +2935,12 @@ components:
     AplTeamSettingsRequest:
       allOf:
         - $ref: '#/components/schemas/AplTeamSettings'
-        - $ref: '#/components/schemas/aplMetadata'
+        - $ref: '#/components/schemas/aplTeamMetadata'
     AplTeamSettingsResponse:
       type: object
       allOf:
         - $ref: '#/components/schemas/AplTeamSettings'
-        - $ref: '#/components/schemas/aplMetadata'
+        - $ref: '#/components/schemas/aplTeamMetadata'
         - $ref: '#/components/schemas/aplStatusResponse'
     AplWorkload:
       type: object

src/otomi-models.ts

@@ -34,6 +34,8 @@ export type RepoBranches = components['schemas']['RepoBranches']
 export type TestRepoConnect = components['schemas']['TestRepoConnect']
 export type InternalRepoUrls = components['schemas']['InternalRepoUrls']
 export type Team = components['schemas']['Team']
+export type AplTeamSettingsRequest = components['schemas']['AplTeamSettingsRequest']
+export type AplTeamSettingsResponse = components['schemas']['AplTeamSettingsResponse']
 export type TeamSelfService = components['schemas']['Team']['selfService']
 export type SessionUser = components['schemas']['SessionUser']
 export type UserAuthz = components['schemas']['SessionUser']['authz']
@@ -78,6 +80,7 @@ export type AplRequestObject =
   | AplSecretRequest
   | AplServiceRequest
   | AplWorkloadRequest
+  | AplTeamSettingsRequest
 export type AplResponseObject =
   | AplBackupResponse
   | AplBuildResponse
@@ -88,6 +91,7 @@ export type AplResponseObject =
   | AplSecretResponse
   | AplServiceResponse
   | AplWorkloadResponse
+  | AplTeamSettingsResponse
 export type AplKind =
   | 'AplApp'
   | 'AplAlertSet'
@@ -254,6 +258,6 @@ export interface TeamConfig {
   projects: AplProjectResponse[]
   sealedsecrets: AplSecretResponse[]
   services: AplServiceResponse[]
-  settings: Team
+  settings: AplTeamSettingsResponse
   workloads: AplWorkloadResponse[]
 }