feat(sonarrqube): make admin group path configurable though console

Signed-off-by: William Phetsinorath <william.phetsinorath-open@interieur.gouv.fr>

Author: shikanime

packages/shared/src/utils/const.ts

@@ -1,4 +1,3 @@
-export const adminGroupPath = '/console/admin'
 export const deleteValidationInput = 'DELETE'
 export const forbiddenRepoNames = ['mirror', 'infra-apps', 'infra-observability']
 

plugins/sonarqube/src/functions.ts

@@ -1,4 +1,3 @@
-import { adminGroupPath } from '@cpn-console/shared'
 import type { Project, StepCall } from '@cpn-console/hooks'
 import { generateProjectKey, parseError } from '@cpn-console/hooks'
 import type { VaultProjectApi } from '@cpn-console/vault-plugin/types/vault-project-api.js'
@@ -27,13 +26,17 @@ const projectPermissions = [
   'user',
 ]
 
-export async function initSonar() {
+export async function initSonar(config?: { adminGroupPath?: string }) {
+  const adminGroupPath = config?.adminGroupPath
+  if (!adminGroupPath) {
+    throw new Error('adminGroupPath is required')
+  }
   await setTemplatePermisions()
-  await createAdminGroup()
-  await setAdminPermisions()
+  await createAdminGroup(adminGroupPath)
+  await setAdminPermisions(adminGroupPath)
 }
 
-async function createAdminGroup() {
+async function createAdminGroup(adminGroupPath: string) {
   const axiosInstance = getAxiosInstance()
   const adminGroup = await findGroupByName(adminGroupPath)
   if (!adminGroup) {
@@ -48,7 +51,7 @@ async function createAdminGroup() {
   }
 }
 
-async function setAdminPermisions() {
+async function setAdminPermisions(adminGroupPath: string) {
   const axiosInstance = getAxiosInstance()
   for (const permission of globalPermissions) {
     await axiosInstance({

plugins/sonarqube/src/index.ts

@@ -1,12 +1,13 @@
-import type { HookStepsNames, Plugin } from '@cpn-console/hooks'
+import type { DeclareModuleGenerator, HookStepsNames, Plugin } from '@cpn-console/hooks'
 import { getStatus } from './check.js'
 import { deleteProject, initSonar, setVariables, upsertProject } from './functions.js'
 import infos from './infos.js'
 import monitor from './monitor.js'
 
-function start(_options: unknown) {
+function start(options: unknown) {
+  const config = (options as any)?.config?.sonarqube?.global
   try {
-    initSonar()
+    initSonar(config)
     getStatus()
   } catch (_error) {}
 }
@@ -34,4 +35,5 @@ declare module '@cpn-console/hooks' {
   interface PluginResult {
     errors?: Partial<Record<HookStepsNames, unknown>>
   }
+  interface Config extends DeclareModuleGenerator<typeof infos, 'global'> {}
 }

plugins/sonarqube/src/infos.ts

@@ -1,12 +1,27 @@
 import type { ServiceInfos } from '@cpn-console/hooks'
 import { getConfig } from './tech.js'
 
-const infos: ServiceInfos = {
+const infos = {
   name: 'sonarqube',
   to: () => `${getConfig().url}/projects`,
   title: 'SonarQube',
   imgSrc: '/img/sonarqube.svg',
   description: 'SonarQube permet à tous les développeurs d\'écrire un code plus propre et plus sûr',
-}
+  config: {
+    global: [{
+      kind: 'text',
+      key: 'adminGroupPath',
+      permissions: {
+        admin: { read: true, write: true },
+        user: { read: false, write: false },
+      },
+      title: 'Chemin du groupe OIDC Admin',
+      value: '/console/admin',
+      description: 'Le chemin du groupe OIDC qui donne les droits d\'administrateur SonarQube',
+      placeholder: '/console/admin',
+    }],
+    project: [],
+  },
+} as const satisfies ServiceInfos
 
 export default infos