fix: cleanup and addres comments

Author: ElderMatt

src/cmd/apply-as-apps.ts

@@ -153,8 +153,8 @@ export const getArgocdGitopsManifest = (name: string, targetNamespace?: string)
   }
   const repoURL = `${env.GIT_PROTOCOL}://${env.GIT_URL}:${env.GIT_PORT}/otomi/values.git`
   const path = targetNamespace
-    ? `${operatorEnv.GITOPS_MANIFESTS_NS_PATH}/${targetNamespace}`
-    : operatorEnv.GITOPS_MANIFESTS_GLOBAL_PATH
+    ? `${operatorEnv.GITOPS_MANIFESTS_NS_RELATIVE_DIR_PATH}/${targetNamespace}`
+    : operatorEnv.GITOPS_GLOBAL_MANIFESTS_RELATIVE_PATH
   return getArgoCdAppManifest(name, ARGOCD_APP_GITOPS_LABEL, {
     project: 'default',
     syncPolicy,
@@ -461,13 +461,17 @@ export const calculateGitOpsAppsDiff = async (
   deps = { getApplications },
 ): Promise<{ toAdd: Set<string>; toRemove: Set<string>; namespaceDirs: string[] }> => {
   const envDir = env.ENV_DIR
-  const namespaceListing = await glob(`${envDir}/${operatorEnv.GITOPS_MANIFESTS_NS_PATH}/*`, { withFileTypes: true })
+  const namespaceListing = await glob(`${envDir}/${operatorEnv.GITOPS_MANIFESTS_NS_RELATIVE_DIR_PATH}/*`, {
+    withFileTypes: true,
+  })
   const namespaceDirs = namespaceListing.filter((path) => path.isDirectory()).map((path) => path.name)
   const existingGitOpsApps = new Set(await deps.getApplications(`otomi.io/app=${ARGOCD_APP_GITOPS_LABEL}`))
 
   // First create sets of Applications to be updated
   const requiredGitOpsApps = new Set(namespaceDirs.map((dirName) => `${ARGOCD_APP_GITOPS_NS_PREFIX}-${dirName}`))
-  const globalPath = statSync(`${envDir}/${operatorEnv.GITOPS_MANIFESTS_GLOBAL_PATH}`, { throwIfNoEntry: false })
+  const globalPath = statSync(`${envDir}/${operatorEnv.GITOPS_GLOBAL_MANIFESTS_RELATIVE_PATH}`, {
+    throwIfNoEntry: false,
+  })
   if (globalPath && globalPath.isDirectory()) {
     requiredGitOpsApps.add(ARGOCD_APP_GITOPS_GLOBAL_NAME)
   }

src/common/utils.ts

@@ -2,12 +2,11 @@ import $RefParser, { JSONSchema } from '@apidevtools/json-schema-ref-parser'
 import cleanDeep, { CleanOptions } from 'clean-deep'
 import { createHash } from 'crypto'
 import fs, { existsSync, readFileSync } from 'fs'
-import { readdir, readFile, writeFile } from 'fs/promises'
+import { readdir, readFile } from 'fs/promises'
 import { glob } from 'glob'
 import walk from 'ignore-walk'
 import { dump, load } from 'js-yaml'
 import { omit } from 'lodash'
-import * as pathModule from 'path'
 import { dirname, join, resolve } from 'path'
 import { $, ProcessOutput, within } from 'zx'
 import { operatorEnv } from '../operator/validators'
@@ -207,25 +206,14 @@ export const getSchemaSecretsPaths = async (teams: string[]): Promise<string[]>
   return cleanSecretPaths
 }
 
-async function ensureKeepFile(keepFilePath: string, deps = { writeFile }): Promise<void> {
-  const dirPath = dirname(keepFilePath)
-  if (!existsSync(dirPath)) {
-    await $`mkdir -p ${dirname(keepFilePath)}`
-  }
-  if (existsSync(keepFilePath)) return
-  // create the .keep file
-  await deps.writeFile(keepFilePath, '')
-}
-
-export function ensureManifestDirectories(): void {
-  ;[operatorEnv.GITOPS_MANIFESTS_NS_PATH, operatorEnv.GITOPS_MANIFESTS_GLOBAL_PATH].forEach((p) =>
-    ensureDirectoryWithGitkeepAsync(pathModule.join(env.ENV_DIR, p)),
-  )
+export async function ensureManifestDirectories(): Promise<void> {
+  await ensureDirectoryWithGitkeepAsync(join(env.ENV_DIR, operatorEnv.GITOPS_MANIFESTS_NS_RELATIVE_DIR_PATH))
+  await ensureDirectoryWithGitkeepAsync(join(env.ENV_DIR, operatorEnv.GITOPS_GLOBAL_MANIFESTS_RELATIVE_PATH))
 }
 
-async function ensureDirectoryWithGitkeepAsync(dirPath: string, deps = { fs, path: pathModule }) {
+async function ensureDirectoryWithGitkeepAsync(dirPath: string, deps = { fs }) {
   await deps.fs.promises.mkdir(dirPath, { recursive: true })
-  const gitkeepPath = deps.path.join(dirPath, '.gitkeep')
+  const gitkeepPath = join(dirPath, '.gitkeep')
 
   try {
     await deps.fs.promises.access(gitkeepPath)
@@ -234,11 +222,7 @@ async function ensureDirectoryWithGitkeepAsync(dirPath: string, deps = { fs, pat
   }
 }
 
-export async function ensureTeamGitOpsDirectories(
-  envDir: string,
-  values: Record<string, any>,
-  deps = { fs, path: pathModule, glob },
-) {
+export async function ensureTeamGitOpsDirectories(envDir: string, values: Record<string, any>, deps = { fs, glob }) {
   const dirs = await deps.glob(`${envDir}/env/teams/*`)
   const baseGitOpsDirs = ['sealedsecrets', 'workloadValues']
   const aiGitOpsDirs = ['databases', 'knowledgebases', 'agents']

src/operator/validators.ts

@@ -6,11 +6,11 @@ dotenv.config()
 export const operatorEnv = cleanEnv(process.env, {
   GIT_ORG: str({ desc: 'Git organisation', default: 'otomi' }),
   GIT_REPO: str({ desc: 'Git repository', default: 'values' }),
-  GITOPS_MANIFESTS_NS_PATH: str({
+  GITOPS_MANIFESTS_NS_RELATIVE_DIR_PATH: str({
     desc: 'Path to the gitops manifests namespace',
     default: 'env/manifests/namespaces',
   }),
-  GITOPS_MANIFESTS_GLOBAL_PATH: str({
+  GITOPS_GLOBAL_MANIFESTS_RELATIVE_PATH: str({
     desc: 'Path to the gitops manifests global',
     default: 'env/manifests/global',
   }),