@leverege/build-tools 2.99.2-quinn.1 → 2.100.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.99.2-quinn.1",
+  "version": "2.100.0",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -16,18 +16,20 @@
     "prepack": "npm exec prepack"
   },
   "bin": {
+    "build-and-push": "src/build-and-push.sh",
     "build-cnpg-image": "src/build-cnpg-image.mjs",
     "build-tools": "src/build-tools.mjs",
     "change-up": "src/change-up.sh",
     "chart-compass": "src/chart-compass.mjs",
     "chart-to-registry": "src/chart-to-registry.mjs",
-    "circleate": "src/circleate.sh",
+    "circle-orb-it": "src/circle-orb-it/circle-orb-it.mjs",
     "clone-cnpg-from-snapshot": "src/clone-cnpg-from-snapshot.mjs",
     "count-lines-of-code": "src/count-lines-of-code.mjs",
     "decrypt-secrets": "src/decrypt-secrets.sh",
     "dirty-git": "src/dirty-git.sh",
     "docker-to-registry": "src/docker-to-registry.mjs",
     "docker-to-registry-py": "src/docker-to-registry-py.mjs",
+    "docker-to-registry.sh": "src/docker-to-registry.sh",
     "dockreate": "src/dockreate.sh",
     "encrypt-secrets": "src/encrypt-secrets.sh",
     "firebaseDeploy": "src/firebaseDeploy.mjs",
@@ -45,6 +47,7 @@
     "helmup": "src/helmup.sh",
     "helmwhat": "src/helmup.sh",
     "hook-and-release": "src/hook-and-release.mjs",
+    "dashboard": "src/dashboard/dashboard.mjs",
     "init-my-chart": "src/init-my-chart.mjs",
     "k8scale": "src/k8scale.sh",
     "k8x": "src/k8x.sh",
@@ -77,11 +80,10 @@
   },
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
+    "@kubernetes/client-node": "^1.4.0",
     "@leverege/jsdoc-template": "^1.0.1",
-    "@yarnpkg/core": "^4.5.0",
-    "@yarnpkg/fslib": "^3.1.4",
     "chalk": "^5.6.2",
-    "command-line-args": "^6.0.1",
+    "command-line-args": "^6.0.2",
     "command-line-usage": "^7.0.4",
     "commander": "^14.0.3",
     "deepmerge": "^4.3.1",
@@ -90,7 +92,7 @@
     "find-yarn-workspace-root": "^2.0.0",
     "glob": "^13.0.6",
     "googleapis": "^171.4.0",
-    "handlebars": "^4.7.8",
+    "handlebars": "^4.7.9",
     "ignore": "^7.0.5",
     "inquirer": "^13.3.2",
     "js-yaml": "^4.1.1",
@@ -108,13 +110,13 @@
     "superstruct": "^2.0.2",
     "tmp": "^0.2.5",
     "toml": "^3.0.0",
-    "yaml": "^2.8.2",
+    "yaml": "^2.8.3",
     "zx": "^8.8.5"
   },
   "devDependencies": {
     "@leverege/eslint-config-leverege": "^5.1.2",
     "chai": "^6.2.2",
     "mocha": "^11.7.5",
-    "npm": "^11.11.1"
+    "npm": "^11.12.1"
   }
 }

package/src/circle-orb-it/circle-orb-it.mjs

@@ -0,0 +1,178 @@
+#!/usr/bin/env node
+/* eslint-disable security/detect-non-literal-fs-filename */
+import fs from 'node:fs'
+import path from 'node:path'
+
+import { program } from 'commander'
+import chalk from 'chalk'
+
+import {
+  BUILD_TOOLS_ROOT,
+  enableDebug,
+  errorExit,
+  getGitRootDirectory,
+  log,
+  proceed,
+} from '../Utils.mjs'
+
+const ORB_VERSION = '1.2.4' // Keep this in sync with the version in circle-orb.yml
+const CIRCLE_DIR = '.circleci'
+const CIRCLE_YML = `${CIRCLE_DIR}/config.yml`
+const CIRCLE_YML_TEMPLATE = path.join( BUILD_TOOLS_ROOT, 'circle-orb-it', 'circle-orb.yml' )
+const GITHUB_DIR = '.github'
+const DEPENDABOT_FILE = `${GITHUB_DIR}/dependabot.yml`
+const DEPENDABOT_TEMPLATE = path.join( BUILD_TOOLS_ROOT, 'circle-orb-it', 'dependabot.yml' )
+
+program
+  .name( 'circle-orb-it' )
+  .description( chalk.green( 'Installs or updates CI and GitHub configuration files for a Leverege repository' ) )
+  .option( '--debug', 'Enable debug logging' )
+  .option( '--dry-run', 'Show what would be written without making changes' )
+  .addHelpText( 'after', `
+${chalk.yellow( 'Files managed:' )}
+  ${chalk.green( CIRCLE_YML )}     leverege orb v${ORB_VERSION}
+  ${chalk.green( DEPENDABOT_FILE )}  weekly npm dependency updates
+
+${chalk.yellow( 'Notes:' )}
+  Run from anywhere inside a git repository.
+  Python projects are not supported by the leverege orb.
+  The dependabot config is skipped if it already exists.
+
+${chalk.yellow( 'Examples:' )}
+  ${chalk.green( 'circle-orb-it' )}            install or upgrade
+  ${chalk.green( 'circle-orb-it --dry-run' )}  preview without writing files
+` )
+  .parse()
+
+const options = program.opts()
+if ( options.debug ) { enableDebug() }
+
+const gitRoot = await getGitRootDirectory()
+if ( !gitRoot ) {
+  errorExit( 'This command must be run inside a git repository' )
+}
+
+// Warn if this looks like a Python project since the orb is Node.js only
+if ( fs.existsSync( path.join( gitRoot, 'pyproject.toml' ) ) ) {
+  log( chalk.yellow( '\n***WARNING: pyproject.toml detected - the leverege orb is Node.js only' ) )
+  await proceed( 'Continue anyway?' )
+}
+
+// ---------- Circle CI ----------
+
+const circleDir = path.join( gitRoot, CIRCLE_DIR )
+const circleYml = path.join( gitRoot, CIRCLE_YML )
+
+let writeCircleYml = true
+let redisEnabled = false
+let githubTeam = null
+
+if ( fs.existsSync( circleYml ) ) {
+  const existing = fs.readFileSync( circleYml, 'utf-8' )
+  const alreadyUsesOrb = existing.includes( 'leverege/circle-nodejs-ci' )
+
+  redisEnabled = existing.includes( 'enable-redis: true' )
+  if ( redisEnabled ) {
+    log( chalk.yellow( '\nRedis detected in existing config - will be preserved' ) )
+  }
+
+  const githubTeamMatch = existing.match( /github-team:\s+(\S+)/ )
+  githubTeam = githubTeamMatch ? githubTeamMatch[1] : null
+  if ( githubTeam ) {
+    log( chalk.yellow( `\ngithub-team "${githubTeam}" detected in existing config - will be preserved` ) )
+  }
+
+  if ( alreadyUsesOrb ) {
+    if ( existing.includes( `circle-nodejs-ci@${ORB_VERSION}` ) ) {
+      log( chalk.green( `\nCircleCI already using leverege/circle-nodejs-ci@${ORB_VERSION} - skipping` ) )
+      writeCircleYml = false
+    } else {
+      log( chalk.yellow( `\nExisting orb config found - will update to @${ORB_VERSION}` ) )
+    }
+  } else {
+    log( chalk.yellow( '\nLegacy CircleCI config detected - will replace with orb-based config' ) )
+  }
+
+  if ( writeCircleYml ) {
+    await proceed( `Overwrite ${CIRCLE_YML}?` )
+  }
+}
+
+// ---------- Dependabot ----------
+
+const githubDir = path.join( gitRoot, GITHUB_DIR )
+const dependabotPath = path.join( gitRoot, DEPENDABOT_FILE )
+
+const writeDependabot = !fs.existsSync( dependabotPath )
+if ( !writeDependabot ) {
+  log( chalk.green( '\nDependabot config already exists - skipping' ) )
+}
+
+// ---------- Nothing to do ----------
+
+if ( !writeCircleYml && !writeDependabot ) {
+  log( chalk.green( '\nAll configs are up to date - nothing to do\n' ) )
+  process.exit( 0 )
+}
+
+// ---------- Dry run ----------
+
+if ( options.dryRun ) {
+  if ( writeCircleYml ) {
+    let dryRunContent = fs.readFileSync( CIRCLE_YML_TEMPLATE, 'utf-8' )
+    if ( redisEnabled ) {
+      dryRunContent = dryRunContent
+        .replace( 'enable-redis: false', 'enable-redis: true' )
+        .replace( '\'{"type":"inMemory"}\'', '\'{"type":"redis"}\'' )
+    }
+    if ( githubTeam ) {
+      dryRunContent = dryRunContent
+        .replace( / {10}# github-team: \S+.*/, `          github-team: ${githubTeam}` )
+    }
+    log( chalk.green( `\n[dry-run] Would write ${CIRCLE_YML}:\n` ) )
+    log( dryRunContent )
+  }
+  if ( writeDependabot ) {
+    log( chalk.green( `\n[dry-run] Would write ${DEPENDABOT_FILE}:\n` ) )
+    log( fs.readFileSync( DEPENDABOT_TEMPLATE, 'utf-8' ) )
+  }
+  process.exit( 0 )
+}
+
+// ---------- Write ----------
+
+if ( writeCircleYml ) {
+  if ( !fs.existsSync( circleDir ) ) {
+    fs.mkdirSync( circleDir, { recursive : true } )
+  }
+  let circleYmlContent = fs.readFileSync( CIRCLE_YML_TEMPLATE, 'utf-8' )
+  if ( redisEnabled ) {
+    circleYmlContent = circleYmlContent
+      .replace( 'enable-redis: false', 'enable-redis: true' )
+      .replace( '\'{"type":"inMemory"}\'', '\'{"type":"redis"}\'' )
+    log( chalk.yellow( 'Redis settings preserved in new config' ) )
+  }
+  if ( githubTeam ) {
+    circleYmlContent = circleYmlContent
+      .replace( / {10}# github-team: \S+.*/, `          github-team: ${githubTeam}` )
+    log( chalk.yellow( `github-team "${githubTeam}" preserved in new config` ) )
+  }
+  fs.writeFileSync( circleYml, circleYmlContent )
+  log( chalk.green( `\nCircleCI config written => ${circleYml}` ) )
+}
+
+if ( writeDependabot ) {
+  if ( !fs.existsSync( githubDir ) ) {
+    fs.mkdirSync( githubDir, { recursive : true } )
+  }
+  fs.writeFileSync( dependabotPath, fs.readFileSync( DEPENDABOT_TEMPLATE, 'utf-8' ) )
+  log( chalk.green( `Dependabot config written => ${dependabotPath}` ) )
+}
+
+const filesToAdd = [
+  writeCircleYml ? CIRCLE_YML : null,
+  writeDependabot ? DEPENDABOT_FILE : null,
+].filter( Boolean ).join( ' ' )
+
+log( chalk.yellow( '\nNext steps:' ) )
+log( `  git add ${filesToAdd} && git commit -m "CHORE migrate to leverege orb ${ORB_VERSION}"\n` )

package/src/circle-orb-it/circle-orb.yml

@@ -0,0 +1,27 @@
+version: 2.1
+
+orbs:
+  leverege: leverege/circle-nodejs-ci@1.2.4
+
+workflows:
+  build-and-verify:
+    jobs:
+      - leverege/install-dependencies:
+          context: npm
+          # pkg-manager: yarn-berry   # uncomment for Yarn Berry repos
+      - leverege/code-analysis:
+          requires:
+            - leverege/install-dependencies
+      - leverege/code-coverage:
+          coverage-threshold: 70          # percentage threshold for functions, lines, and statements
+          context: leverege-gcp           # provides GCP_SA_KEY_JSON for tests that need GCP access
+          enable-redis: false             # set to true if tests require a live Redis connection
+          cache-config: '{"type":"inMemory"}' # sets CACHE_CONFIG env var - options: inMemory, redis
+          requires:
+            - leverege/install-dependencies
+      - leverege/generate-docs:
+          requires:
+            - leverege/install-dependencies
+      - leverege/mirror-to-github:
+          context: github-mirror
+          # github-team: platform   # available teams: platform, utilities, pitcrew, recovr

package/src/circle-orb-it/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10

package/src/dashboard/DashboardManager.mjs

@@ -0,0 +1,126 @@
+import fs from 'node:fs'
+import path from 'node:path'
+
+import * as k8s from '@kubernetes/client-node'
+import chalk from 'chalk'
+
+import { debug, errorExit, log } from '../Utils.mjs'
+
+// const FIELD_MANAGER = 'dashboard'
+const GRAFANA_LABEL = 'grafana_dashboard'
+const GRAFANA_FOLDER = 'grafana_folder'
+
+/* eslint-disable security/detect-non-literal-fs-filename */
+export default class DashboardManager {
+  #api
+  #namespace
+  #dryRun
+
+  constructor( { namespace = 'prometheus', dryRun = false } = {} ) {
+    this.#namespace = namespace
+    this.#dryRun = dryRun
+  }
+
+  #getApi() {
+    if ( !this.#api ) {
+      const kc = new k8s.KubeConfig()
+      kc.loadFromDefault()
+      this.#api = kc.makeApiClient( k8s.CoreV1Api )
+    }
+    return this.#api
+  }
+
+  async apply( dir ) {
+    const folders = fs.readdirSync( dir, { withFileTypes : true } )
+      .filter( e => e.isDirectory() )
+
+    if ( folders.length === 0 ) {
+      log( chalk.yellow( `No dashboard subfolders found in ${dir}` ) )
+      return
+    }
+
+    for ( const folder of folders ) {
+      const files = fs.readdirSync( path.join( dir, folder.name ) )
+        .filter( f => f.endsWith( '.json' ) )
+
+      for ( const file of files ) {
+        await this.#applyDashboard( folder.name, path.join( dir, folder.name, file ) )
+      }
+    }
+  }
+
+  async list( dir ) {
+    if ( !fs.existsSync( dir ) ) {
+      errorExit( `Dashboard directory not found: ${dir}` )
+    }
+
+    log( chalk.bold( `Dashboards in: ${dir}` ) )
+
+    const folders = fs.readdirSync( dir, { withFileTypes : true } )
+      .filter( e => e.isDirectory() )
+
+    if ( folders.length === 0 ) {
+      log( chalk.yellow( 'No subfolders found' ) )
+      return
+    }
+
+    for ( const folder of folders ) {
+      const files = fs.readdirSync( path.join( dir, folder.name ) )
+        .filter( f => f.endsWith( '.json' ) )
+
+      log( chalk.bold( `\n[${folder.name}]` ) )
+      if ( files.length === 0 ) {
+        log( chalk.dim( '  (empty)' ) )
+      } else {
+        files.forEach( f => log( `  ${chalk.cyan( path.basename( f, '.json' ) )}` ) )
+      }
+    }
+  }
+
+  async #applyDashboard( folder, filePath ) {
+    const filename = path.basename( filePath )
+    const name = `dashboard-${path.basename( filePath, '.json' )}`
+    const json = fs.readFileSync( filePath, 'utf8' )
+
+    const configMap = {
+      apiVersion : 'v1',
+      kind : 'ConfigMap',
+      metadata : {
+        name,
+        namespace : this.#namespace,
+        labels : { [GRAFANA_LABEL] : '1' },
+        annotations : { [GRAFANA_FOLDER] : folder },
+      },
+      data : { [filename] : json },
+    }
+
+    debug( configMap, `dashboard: ${name}` )
+
+    if ( this.#dryRun ) {
+      log( chalk.yellow( `  [dry-run] ${filename} → [${folder}]` ) )
+      return
+    }
+
+    const api = this.#getApi()
+    try {
+      let resourceVersion
+      try {
+        const existing = await api.readNamespacedConfigMap( { name, namespace : this.#namespace } )
+        resourceVersion = existing.metadata.resourceVersion
+      } catch {
+        // doesn't exist yet — will create below
+      }
+
+      if ( resourceVersion ) {
+        configMap.metadata.resourceVersion = resourceVersion
+        await api.replaceNamespacedConfigMap( { name, namespace : this.#namespace, body : configMap } )
+      } else {
+        await api.createNamespacedConfigMap( { namespace : this.#namespace, body : configMap } )
+      }
+      log( chalk.green( `  ✓ ${filename} → [${folder}]` ) )
+    } catch ( e ) {
+      errorExit( `Failed to apply ${name}: ${e.message}` )
+    }
+  }
+
+}

package/src/dashboard/dashboard.mjs

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+import path from 'node:path'
+
+import { program } from 'commander'
+import chalk from 'chalk'
+
+import { enableDebug, errorExit, log } from '../Utils.mjs'
+
+import DashboardManager from './DashboardManager.mjs'
+
+const defaultJsonDir = path.join( import.meta.dirname, 'json' )
+
+program
+  .name( 'dashboard' )
+  .description( 'Manage Grafana dashboards as Kubernetes ConfigMaps' )
+  .argument( '[dir]', 'Directory of dashboard subfolders', defaultJsonDir )
+  .option( '--list', 'List available dashboards without applying' )
+  .option( '--dry-run', 'Show what would be applied without making changes' )
+  .option( '--debug', 'Enable debug logging' )
+  .option( '-n, --namespace <ns>', 'Target Kubernetes namespace', 'prometheus' )
+  .parse()
+
+const { list, dryRun, debug, namespace } = program.opts()
+const [ dir = defaultJsonDir ] = program.args
+
+if ( debug ) enableDebug()
+
+const mgr = new DashboardManager( { namespace, dryRun } )
+
+if ( list ) {
+  await mgr.list( dir ).catch( e => errorExit( e ) )
+} else {
+  log( chalk.bold( `Applying dashboards from: ${dir}` ) )
+  await mgr.apply( dir ).catch( e => errorExit( e ) )
+}