@leverege/build-tools 2.60.0 → 2.61.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.60.0",
+  "version": "2.61.0",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -16,6 +16,7 @@
   "bin": {
     "build-tools": "src/build-tools.mjs",
     "build-and-push": "src/build-and-push.sh",
+    "build-cnpg-image": "src/build-cnpg-image.mjs",
     "chart-to-registry": "src/chart-to-registry.mjs",
     "circleate": "src/circleate.sh",
     "cnpg-backup": "src/cnpg-backup.mjs",
@@ -23,7 +24,6 @@
     "dirty-git": "src/dirty-git.sh",
     "dockreate": "src/dockreate.sh",
     "docker-to-registry": "src/docker-to-registry.mjs",
-    "docker-to-registry.sh": "src/docker-to-registry.sh",
     "encrypt-secrets": "src/encrypt-secrets.sh",
     "firebaseDeploy": "src/firebaseDeploy.mjs",
     "firebaseServe": "src/firebaseServe.mjs",
@@ -61,23 +61,21 @@
   "dependencies": {
     "@google-cloud/artifact-registry": "^3.5.0",
     "@leverege/jsdoc-template": "^1.0.1",
-    "ansi-colors": "^4.1.3",
     "chalk": "^5.4.1",
     "command-line-args": "^6.0.1",
     "command-line-usage": "^7.0.3",
     "deepmerge": "^4.3.1",
     "enquirer": "^2.4.1",
     "execa": "^9.5.2",
-    "glob": "^11.0.0",
+    "glob": "^11.0.1",
     "handlebars": "^4.7.8",
-    "inquirer": "^12.3.0",
+    "inquirer": "^12.3.2",
     "js-yaml": "^4.1.0",
     "jsdoc": "^4.0.4",
     "ms": "^2.1.3",
     "npm-registry-fetch": "^18.0.2",
     "package-up": "^5.0.0",
     "parse-gitignore": "^2.0.0",
-    "read-pkg": "^9.0.1",
     "readline-sync": "^1.4.10",
     "semver": "^7.6.3",
     "simple-git": "^3.27.0",

package/registry-compass.yaml

@@ -0,0 +1,20 @@
+registry:
+  - root: us-docker.pkg.dev
+  - repositories:
+    - name: stack
+      charts:
+        - api-server
+        - authz-server
+        - emailer
+        - message-processor
+    - name: leverege
+      charts:
+        - pubsub-pulse
+        - pusher
+        - overdose
+    - name: cox-health
+      charts:
+        - actions-server
+        - analytics-server
+        - centrak-healthz
+        - centrak-ingestor

package/src/Docker.mjs

@@ -24,7 +24,7 @@ const dockerfileNodeVersion = 'jod-alpine'
 // the build-tools repository, but it just became simpler to pull the contents
 // directly into these variables and forego the file loading.
 //
-const pluginTemplate = `
+const dockerfilePluginTemplate = `
 # Dockerfile.plugin - optionally extend the service Docker image
 #
 # This file may be used to run additional docker commands during the image
@@ -38,6 +38,14 @@ const pluginTemplate = `
 # Keep in mind that the Alpine Linux base image is used to keep image
 # footprints small, so adding packages "just because" is not considered
 # a best practice.
+`
+const bashrcPluginTemplate = `
+
+# Bashrc.plugin - optionally extend the image .bashrc file
+#
+# This plugin file may contain additional .bashrc settigns / functions to
+# provide on the target image.
+
 `
 const dockerfileTemplate = fs.readFileSync( path.join( DIRNAME, './templates/dockerfileTemplate.hbs' ), 'utf8' )
 const bashrcTemplate = fs.readFileSync( path.join( DIRNAME, './templates/bashrcTemplate.hbs' ), 'utf8' )
@@ -85,24 +93,31 @@ const generateDockerfile = ( options ) => {
     fs.mkdirSync( './docker' ) // TODO: blindly assumes the mkdir succeeds
   }
 
+  // Create a bashrc plugin file if one does not already exist
+  const bashrcPluginFile = './docker/Bashrc.plugin'
+  if ( !fs.existsSync( bashrcPluginFile ) ) {
+    warning( `creating the missing ${bashrcPluginFile} file in the docker directory\n` )
+    fs.writeFileSync( bashrcPluginFile, bashrcPluginTemplate )
+  }
+  const bashrcPlugin = fs.readFileSync( bashrcPluginFile )
+
+  // Build the target bashrc file by using the template plus Bashrc.plugin
   const bashrcFile = './docker/bashrc'
-  // DISABLING exists check. With addition of Bashrc.plugin, the file needs to
-  // always be created or we encounter errors
-  if ( true ) { // !fs.existsSync( bashrcFile ) ) {
-    let bf = bashrcTemplate
-    const bashrcFilePlugin = './docker/Bashrc.plugin'
-    if ( fs.existsSync( bashrcFilePlugin ) ) {
-      const bashrcAdditions = fs.readFileSync( bashrcFilePlugin )
-      bf = `${bf}\n${bashrcAdditions}`
-    }
-    warning( `creating the missing ${bashrcFile} file in the docker directory` )
-    fs.writeFileSync( bashrcFile, bf )
+  if ( fs.existsSync( bashrcFile ) ) {
+    fs.rmSync( bashrcFile ) // start with a clean bashrc
+  }
+
+  try {
+    fs.writeFileSync( bashrcFile, bashrcTemplate )
+    fs.appendFileSync( bashrcFile, bashrcPlugin )
+  } catch ( err ) {
+    errorExit( `***ERROR: failed creation of the ${bashrcFile} file` )
   }
 
   const dockerfilePlugin = './docker/Dockerfile.plugin'
   if ( !fs.existsSync( dockerfilePlugin ) ) {
     warning( `creating the missing ${dockerfilePlugin} file in the docker directory` )
-    fs.writeFileSync( dockerfilePlugin, pluginTemplate )
+    fs.writeFileSync( dockerfilePlugin, dockerfilePluginTemplate )
   }
 
   try {
@@ -114,7 +129,7 @@ const generateDockerfile = ( options ) => {
     errorExit( `***ERROR: expected the ./build directory to exist - ${chalk.yellow( 'npm run build' )}` )
   }
 
-  // At this point the plugin template better exist.
+  // At this point the docker plugin file better exist.
   if ( fs.existsSync( dockerfilePlugin ) ) {
     settings.pluginfile = fs.readFileSync( dockerfilePlugin )
   } else {
@@ -177,8 +192,8 @@ const buildContainerImage = async ( {
   fs.mkdirSync( './build' )
   fs.renameSync( './workspace', buildWorkspace )
   fs.renameSync( './docker/Dockerfile', './build/Dockerfile' )
+  fs.renameSync( './docker/bashrc', './build/bashrc' )
   fs.cpSync( `${process.env.HOME}/.npmrc`, './build/.npmrc' )
-  fs.cpSync( './docker/bashrc', './build/bashrc' )
   fs.cpSync( './package.json', `${buildWorkspace}/package.json` )
   fs.cpSync( './package-lock.json', `${buildWorkspace}/package-lock.json` )
   if ( isNpmWorkspace ) {

package/src/build-cnpg-image.mjs

@@ -0,0 +1,173 @@
+#!/usr/bin/env node
+
+// A simple utility for easily building CNPG based psql images. The resultant
+// image will contain PostgreSQL, the JS query and Timescale extensions, and
+// the extensions that are required by CNPG like barman, pgaudit, pgvector and
+// pg-failover-slots.
+//
+// Latest Versions:
+//   postgres    => https://www.postgresql.org/
+//   timescale   => https://docs.timescale.com/about/latest/
+//   CNPG images => https://github.com/cloudnative-pg/postgres-containers/pkgs/container/postgresql
+
+import fs from 'node:fs'
+import path from 'node:path'
+
+import chalk from 'chalk'
+import cliArgs from 'command-line-args'
+import cliHelp from 'command-line-usage'
+import Handlebars from 'handlebars'
+
+import {
+  debug,
+  log,
+  err,
+  errorExit,
+  shellCmd,
+} from './Utils.mjs'
+
+// Define CLI options
+const optionList = [
+  { name : 'sub-tag', type : String, description : '{green sub-tag to add to the image tag (required)}', defaultOption : true },
+  { name : 'pg-version', type : String, description : '{green pgsql version (default: 16.6)}' },
+  { name : 'version', type : Boolean, description : '{green show script version}' },
+  { name : 'help', type : Boolean, description : '{green display this help screen}' },
+]
+
+const sections = [
+  {
+    header : 'Leverege CNPG Docker Image Builder',
+    content : `{green   This tool will build a PostgreSQL based image that is suitable for
+deployment by the CNPG operator. It builds the docker image by using an
+official CNPG docker image as a base and added the jsquery and timescale
+extensions for use within a Leverege k8s cluster. The resultant image may be
+used in the standard PostgreSQL configuration which is used by the stack
+components, as well as timescale based services like transponder tsdb and
+dense history.}`
+  },
+  {
+    header : 'Options',
+    optionList
+  },
+  {
+    header : 'Leverege Registry Image Tag',
+    content : `{green The resultant image will be tagged with a label comprised of the PG version,
+the specified --sub-tag and a fixed string:
+
+    {yellow <PG ver>-cnpg-lvrg-<sub tag>}
+
+For example, version {yellow 16.6} with a sub tag of {yellow rel.1} will be tagged:
+
+    {yellow 16.6-cnpg-lvrg-rel.1}}`
+  },
+]
+const args = cliArgs( optionList, { camelCase : true, partial : true } )
+const help = cliHelp( sections )
+
+debug( { args, help }, '<==Command Line Info?' )
+
+// Show help if needed
+if ( args.help ) {
+  log( help )
+  process.exit( 0 )
+}
+
+// Define defaults
+const PG_VERSION = args.pgVersion || '16.6'
+const { subTag } = args
+if ( !subTag ) {
+  errorExit( 'Error: An image version must be specified.' )
+}
+
+const LEVEREGE_REGISTRY = 'us-docker.pkg.dev/leverege-registry/system/images/leverege-pgsql'
+const LEVEREGE_IMAGE_TAG = `${PG_VERSION}-cnpg-lvrg-${subTag}`
+const LEVEREGE_IMAGE_NAME_WITH_TAG = `${LEVEREGE_REGISTRY}:${LEVEREGE_IMAGE_TAG}`
+
+const DOCKERFILE_TEMPLATE = `
+FROM ghcr.io/cloudnative-pg/postgresql:{{PG_VERSION}}-bookworm
+
+USER root
+
+RUN set -xe; \\
+    apt-get update; \\
+    apt-get install -y --no-install-recommends \\
+        "postgresql-\${PG_MAJOR}-jsquery"; \\
+    rm -fr /tmp/*; \\
+    rm -rf /var/lib/apt/lists/*;
+
+RUN apt-get update \\
+    && apt-get install -y lsb-release wget \\
+    && echo "deb https://packagecloud.io/timescale/timescaledb/debian/ $(lsb_release -c -s) main" | tee /etc/apt/sources.list.d/timescaledb.list \\
+    && wget --quiet -O - https://packagecloud.io/timescale/timescaledb/gpgkey | apt-key add - \\
+    && apt-get update \\
+    && apt-get install -y "timescaledb-2-postgresql-\${PG_MAJOR}" \\
+    && apt-get remove -y lsb-release wget \\
+    && rm -fr /tmp/* \\
+    && rm -rf /var/lib/apt/lists/*;
+
+RUN usermod -u 26 postgres
+USER 26
+`
+
+// Check for existing image
+const checkExistingImage = async ( imageName ) => {
+  const dockerResults = await shellCmd( `docker image list ${imageName} --quiet` )
+  debug( { imageName, dockerResults }, '<==docker image list' )
+  return dockerResults
+}
+
+// Build and push Docker image
+const buildAndPushImage = async () => {
+  const template = Handlebars.compile( DOCKERFILE_TEMPLATE )
+  const renderedDockerfile = template( { PG_VERSION } )
+  debug( { renderedDockerfile }, '<==Dockerfile' )
+
+  // Write the Dockerfile to a temporary location
+  const dockerfilePath = path.resolve( 'Dockerfile.temp' )
+  fs.writeFileSync( dockerfilePath, renderedDockerfile )
+
+  // Build the image
+  log( chalk.yellow( '\nBuilding Docker image...' ) )
+  await shellCmd( `docker build --file ${dockerfilePath} --tag ${LEVEREGE_IMAGE_NAME_WITH_TAG} .`, { stdio : 'inherit' } )
+
+  // Push the image
+  log( chalk.green( '\nPushing Docker image...' ) )
+  await shellCmd( `docker push ${LEVEREGE_IMAGE_NAME_WITH_TAG}`, { stdio : 'inherit' } )
+
+  // Clean up the temporary Dockerfile
+  fs.unlinkSync( dockerfilePath )
+}
+
+// Main execution flow
+try {
+  if ( await checkExistingImage( LEVEREGE_IMAGE_NAME_WITH_TAG ) ) {
+    err(
+      `${chalk.red( '*** ERROR ***' )} The image already exists:\n` +
+      `  Image   : ${chalk.yellow( LEVEREGE_IMAGE_NAME_WITH_TAG )}\n` +
+      `  Registry: ${chalk.green( LEVEREGE_REGISTRY )}\n` +
+      `  Tag     : ${chalk.green( LEVEREGE_IMAGE_TAG )}\n`
+    )
+    process.exit( 1 )
+  }
+
+  log( `${chalk.cyan( '\nAbout to build a new Docker image:\n' )}
+    PostgreSQL   => ${chalk.green( PG_VERSION )}
+    Image Name   => ${chalk.green( LEVEREGE_IMAGE_NAME_WITH_TAG )}\n` )
+
+  log( `Enter "${chalk.green( 'yes' )}" to proceed or anything else to exit.` )
+  const confirmation = await new Promise( ( resolve ) => {
+    process.stdin.once( 'data', data => resolve( data.toString().trim() ) )
+  } )
+
+  if ( confirmation !== 'yes' ) {
+    log( chalk.red( 'Aborted by user.' ) )
+    process.exit( 1 )
+  }
+
+  await buildAndPushImage()
+  log( chalk.green( '\nDocker image build and push completed successfully!' ) )
+  process.exit( 0 )
+} catch ( error ) {
+  err( chalk.red( 'An error occurred:' ), error.message )
+  process.exit( 1 )
+}

package/src/chart-compass.mjs

@@ -0,0 +1,97 @@
+#!/usr/bin/env node
+/* eslint-disable */
+/*
+ * chart-to-registry will...
+ */
+import fs from 'node:fs'
+
+import chalk from 'chalk'
+import commandLineArgs from 'command-line-args'
+import commandLineUsage from 'command-line-usage'
+import { lt as semverLt } from 'semver'
+import YAML from 'js-yaml'
+
+import {
+  condir,
+  debug,
+  errorExit,
+  log,
+  warning,
+  getGitRootDirectory,
+  parsePackageJson,
+  parseHelmChart,
+  shellCmd } from './Utils.mjs'
+
+const commandLineOptions = [ // Use commandLineOptions to tie into the Usage statements
+   
+  {
+    name : 'location',
+    type : String,
+    description : '{green the location of the artifact registry the chart will be pushed to (default us-docker.pkg.dev)}',
+  },
+  {
+    name : 'project',
+    type : String,
+    description : '{green the name of the google project containing the npmrc and slack config secrets (default leverege-registry)}',
+  },
+  {
+    name : 'repository',
+    type : String,
+    description : '{green the target repository to receive the pushed chart}',
+  },
+  {
+    name : 'dry-run',
+    type : Boolean,
+    description : '{yellow perform everything except the actual chart push}',
+  },
+  {
+    name : 'help',
+    type : Boolean,
+    description : '{green display this help screen}',
+  },
+   
+]
+
+const sections = [
+  {
+    header : 'Leverege Helm Chart Compass (for helmup)',
+    content : `{green This tool helps helmup navigate the helm charts stored in the
+artifact-registries.}`
+  },
+  { header : 'Options',
+    optionList : commandLineOptions,
+  },
+]
+
+const args = commandLineArgs( commandLineOptions, { camelCase : true, partial : true } )
+const usage = commandLineUsage( sections )
+
+if ( args.help ) {
+  log( usage )
+  process.exit( 0 )
+}
+
+/* eslint-disable no-underscore-dangle */
+if ( args._unknown ) {
+  log( usage )
+  log( `\nUnrecognized argument [${chalk.bold.red( args._unknown )}]\n` )
+  process.exit( 1 )
+}
+/* eslint-enable no-underscore-dangle */
+
+const minNodejsVersion = '18.0.0'
+if ( semverLt( process.version, minNodejsVersion ) ) {
+  errorExit( `\n***ERROR: must be running at least node ${minNodejsVersion}\n` )
+}
+
+// First of all, fail if we are not in a git repository
+let gitRoot
+try {
+  gitRoot = await getGitRootDirectory()
+} catch ( error ) {
+  errorExit( chalk.red.bold( error ), { errorCode : 5 } )
+}
+
+const chartCompass = YAML.load( fs.readFileSync( './registry-compass.yaml', 'utf8' ) )
+
+condir( { chartCompass }, '<==Navigation' )

package/src/docker-to-registry.sh

@@ -19,7 +19,7 @@ cat<<DEPRECATED_TOOL
   `color y "***DEPRECATED docker-to-registry.sh - upgrade to docker-to-registry.mjs***"`
 
 DEPRECATED_TOOL
-sleep 3
+exit 1
 
 PKGTOP="$npm_config_local_prefix"
 cd $PKGTOP/docker