@leverege/build-tools 2.101.0 → 2.101.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.101.0",
+  "version": "2.101.1",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -48,7 +48,7 @@
     "helmup": "src/helmup.sh",
     "helmwhat": "src/helmup.sh",
     "hook-and-release": "src/hook-and-release.mjs",
-    "init-my-chart": "src/init-my-chart.mjs",
+    "init-my-chart": "src/init-my-chart/init-my-chart.mjs",
     "k8scale": "src/k8scale.sh",
     "k8x": "src/k8x.sh",
     "klog": "src/klog.sh",

package/src/bash-funcs

@@ -229,28 +229,6 @@ function waitForIAM() {
   done
 }
 
-# *** DEPRECATED *** REMOVE AFTER BITNAMI ERADICATED ***
-# *** DEPRECATED *** REMOVE AFTER BITNAMI ERADICATED ***
-# *** DEPRECATED *** REMOVE AFTER BITNAMI ERADICATED ***
-#
-function addBitnamiRepo() {
-  warning '*** the addBitnamiRepo function should be removed - DEPRECATED ***'
-  if [ ! -z "$BITNAMI_LATEST" ] || [ "$1" == "latest" ];
-  then
-    BITNAMI_URL="https://charts.bitnami.com/bitnami"
-  else
-    cat<<CATNAMI
-    Using the pre 2022 legacy charts from bitnami. To use latest run:
-
-        `color y "BITNAMI_LATEST=1 $HELMUP_ARGS"`
-
-CATNAMI
-    BITNAMI_URL="https://raw.githubusercontent.com/bitnami/charts/eb5f9a9513d987b519f0ecd732e7031241c50328/bitnami"
-  fi
-
-  addHelmRepo bitnami $BITNAMI_URL
-}
-
 function removeHelmRepo(){
   [ ! -z "$SKIP_RM_HELM_REPO" ] && return
   helm repo remove $1 &> $DEVNULL

package/src/DockerPy.mjs

@@ -1,266 +0,0 @@
-/**
- * DEPRECATED - DO NOT MODIFY
- */
-import fs from 'node:fs'
-import path from 'node:path'
-import url from 'node:url'
-
-import chalk from 'chalk'
-import handlebars from 'handlebars'
-
-import {
-  errorExit,
-  getCleanTag,
-  getDateTimestamp,
-  getGcpAccount,
-  log,
-  proceed,
-  shellCmd,
-  warning
-} from './Utils.mjs'
-
-const DIRNAME = path.dirname( url.fileURLToPath( import.meta.url ) )
-
-// The contents of these variables were initially located in files that live in
-// the build-tools repository, but it just became simpler to pull the contents
-// directly into these variables and forego the file loading.
-//
-const pluginTemplate = `
-# Dockerfile.plugin - optionally extend the service Docker image
-#
-# This file may be used to run additional docker commands during the image
-# build process without needing to maintain a local custom Dockerfile. For
-# example, uncommenting the following docker RUN command will cause the
-# curl and vim packages to be added to the deployed image thus making them
-# available from the pod's command line on k8s:
-#
-# RUN apk update && apk add --no-cache curl vim
-#
-# 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 dockerfileTemplate = fs.readFileSync( path.join( DIRNAME, './templates/dockerfileTemplatePy.hbs' ), 'utf8' )
-const cloudBuildSteps = fs.readFileSync( path.join( DIRNAME, './templates/cloudBuildTargetGKE.hbs' ), 'utf8' )
-let bashrcTemplate = fs.readFileSync( path.join( DIRNAME, './templates/bashrcTemplate.hbs' ), 'utf8' )
-const bashrcPyTemplate = fs.readFileSync( path.join( DIRNAME, './templates/bashrcTemplatePy.hbs' ), 'utf8' )
-bashrcTemplate = `${bashrcTemplate}\n${bashrcPyTemplate}`
-
-const defaultSettings = {
-  date : getDateTimestamp(),
-  imageBase : 'python:3.12.8-slim-bookworm',
-  npmlogging : process.env.VERBOSE_NPM_LOGGING ? '--ddd' : '--silent',
-  npmVersion : 'npm@11',
-  pluginfile : '# NO PLUGIN',
-  preInstallPluginfile : '# NO PRE-INSTALL PLUGIN',
-  regvers : 'package.version',
-  runuser : 'python',
-}
-
-// the previous build version is simply informational for the user
-const previousFile = './docker/.previous'
-
-function getPreviousBuild() {
-  return fs.existsSync( previousFile ) ? fs.readFileSync( previousFile ) : 'FIRST BUILD'
-}
-
-const setPreviousBuild = ( version ) => {
-  fs.writeFileSync( previousFile, version )
-}
-
-// the base image string to be in the form of an image name and a version
-// for example:
-//
-//   python:3.12.8-slim-bookworm becomes python-3.12.8
-//   nvcr.io/nvidia/cuda:12.3.1-base-ubuntu22.04 becomes cuda-12.3.1
-//
-// which will then be used to tag the image for information purposes only
-const extractBaseImageTag = ( imageStr ) => {
-  const match = imageStr.match( /(\w+:\d+(?:\.\d+)*)(?=-)/ ) // eslint-disable-line security/detect-unsafe-regex
-  return match ? match[1].replace( ':', '-' ) : null
-}
-
-function generateDockerfile( options ) {
-
-  const settings = { ...defaultSettings, ...options }
-  settings.image = settings.imageBase
-  // TODO: this is a janky way to pass the image tag back out
-  defaultSettings.buildTag = extractBaseImageTag( settings.image )
-
-  // Ensure the presence of the docker dir with plugin and bashrc - this code
-  // could probably be tightened up a little.
-  try {
-    fs.readdirSync( './docker' )
-  } catch ( err ) {
-    warning( 'creating the missing ./docker directory' )
-    fs.mkdirSync( './docker' ) // TODO: blindly assumes the mkdir succeeds
-  }
-
-  const bashrcFile = './docker/bashrc'
-  let bf = bashrcTemplate
-  const bashrcFilePlugin = './docker/Bashrc.plugin'
-  if ( fs.existsSync( bashrcFilePlugin ) ) {
-    const bashrcAdditions = fs.readFileSync( bashrcFilePlugin )
-    bf = `${bf}\n${bashrcAdditions}`
-  }
-  fs.writeFileSync( bashrcFile, bf )
-
-  const dockerfilePlugin = './docker/Dockerfile.plugin'
-  if ( !fs.existsSync( dockerfilePlugin ) ) {
-    warning( `creating the missing ${dockerfilePlugin} file in the docker directory` )
-    fs.writeFileSync( dockerfilePlugin, pluginTemplate )
-  }
-
-  try {
-    const build = fs.readdirSync( './build' )
-    if ( build.length === 0 ) {
-      errorExit( `***ERROR: the build dir is empty - ${chalk.yellow( 'npm run build' )}` )
-    }
-  } catch ( err ) {
-    errorExit( `***ERROR: expected the ./build directory to exist - ${chalk.yellow( 'npm run build' )}` )
-  }
-
-  // At this point the plugin template better exist.
-  if ( fs.existsSync( dockerfilePlugin ) ) {
-    settings.pluginfile = fs.readFileSync( dockerfilePlugin )
-  } else {
-    errorExit( `***ERROR: something went wrong with ${dockerfilePlugin} plugin creation` )
-  }
-
-  const dockerfilePrePlugin = './docker/DockerfilePreInstall.plugin'
-  if ( fs.existsSync( dockerfilePrePlugin ) ) {
-    settings.preInstallPluginfile = fs.readFileSync( dockerfilePrePlugin )
-  }
-
-  const compiled = handlebars.compile( dockerfileTemplate, { noEscape : true } )
-  const replaced = compiled( settings )
-  // temporarily write the Dockerfile to the docker subdir - the container
-  // image builder will then move it over to the build subdir
-  const dockerfile = './docker/Dockerfile'
-  try {
-    fs.writeFileSync( dockerfile, replaced )
-  } catch ( err ) {
-    errorExit( `***ERROR: failed to write ${dockerfile}\n${err}` )
-  }
-
-  const previousBuild = getPreviousBuild()
-  const dockerInfo = { dockerfile, previousBuild, ...settings }
-  delete dockerInfo.pluginfile
-  return dockerInfo
-}
-
-function formCloudBuildBucketName( artifactProject ) {
-  return `gs://${artifactProject}_cloudbuild`
-}
-
-async function validateCloudBuildBucket( artifactProject ) {
-  const bucketName = formCloudBuildBucketName( artifactProject )
-  log( chalk.green.bold( `Verifying the build bucket exists => ${bucketName}\n` ) )
-  try {
-    await shellCmd( `gsutil ls -p ${artifactProject} -b ${bucketName}` )
-  } catch ( error ) {
-    errorExit( `***Error: from Docker.validateCloudBuildBucket\n\n${chalk.bold.yellow( error )}` )
-  }
-}
-
-async function buildContainerImage( {
-  artifactProject, artifactRegistry, containerName, 
-  imageVersion, isNpmWorkspace, options
-} ) {
-  const buildWorkspace = './build/workspace' // passed to Cloud Build
-  const imageName = `${artifactRegistry}/images/${containerName}`
-
-  // clean up any residual build cruft (should be clean though)
-  if ( fs.existsSync( buildWorkspace ) ) {
-    fs.renameSync( buildWorkspace, `${buildWorkspace}-junk` )
-    fs.rm( `${buildWorkspace}-junk`, { recursive : true }, ( err ) => {} ) // fire and forget
-  }
-
-  // TODO: This is janky - I'll clean it up later
-  // NOTE: this is dealing with raw filesystem interactions, meaning there
-  //   isn't a shell performing file globbing and what not
-  fs.renameSync( './build', './workspace' )
-  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( './package.json', `${buildWorkspace}/package.json` )
-  // fs.cpSync( './package-lock.json', `${buildWorkspace}/package-lock.json` )
-
-  setPreviousBuild( imageVersion ) // update docker/.previous file
-
-  const { fullName } = await getGcpAccount()
-  const imageBuilder = getCleanTag( fullName )
-  const imageArch = defaultSettings.buildTag
-  const imageInfoTag = `zzinfo_${imageArch}_${imageBuilder}_${defaultSettings.date}`
-  const gcloudProjectNumber = await shellCmd( `gcloud projects describe ${artifactProject} --format="value(projectNumber)"` )
-
-  // build the cloudbuild.yaml from the handlebars template
-  const cloudBuildFile = './build/cloudbuild.yaml'
-  const cbst = handlebars.compile( cloudBuildSteps, { noEscape : true } )
-  const cbs = cbst( { artifactProject, artifactRegistry, imageName, imageVersion, imageInfoTag, } )
-  fs.writeFileSync( cloudBuildFile, cbs )
-
-  // build up the cloud build command and options
-  const cloudBuildCmd = `gcloud builds submit --project ${artifactProject}`
-  const cloudBuildLogs = `--gcs-log-dir ${formCloudBuildBucketName( artifactProject )}/log`
-  const cloudBuildCfg = `--config=${cloudBuildFile}`
-  const cloudBuildSA = `--service-account=${gcloudProjectNumber}-compute@cloudbuild.gserviceaccount.com`
-
-  log( chalk.green.bold( `
-  *** Submitting Build as ${imageBuilder} ***
-      ${cloudBuildCmd} \\
-           ${cloudBuildLogs}  \\
-           ${cloudBuildCfg} \\
-           ${cloudBuildSA}
-  ` ) )
-
-  if ( process.env.DRY_RUN === '1' ) {
-    log( `Would have run => ${cloudBuildCmd} ${cloudBuildLogs} ${cloudBuildCfg} ./build` )
-    log( '\n***Exiting from DRY_RUN\n' )
-    process.exit( 0 )
-  }
-
-  await shellCmd( `${cloudBuildCmd} ${cloudBuildLogs} ${cloudBuildCfg} ./build`, { stdio : 'inherit' } )
-}
-
-async function repoCleanup() {
-  // remove garbage from the repo
-  const garbage = [
-    'build',
-    'dist',
-    'docker/.keep',
-    'docker/.npmrc',
-    'docker/.gitignore',
-    'docker/.previous',
-    'docker/Dockerfile',
-    'docker/workspace',
-  ]
-
-  garbage.forEach( trash => fs.rmSync( trash, { recursive : true, force : true } ) )
-
-  fs.writeFileSync( 'docker/.gitignore', '.previous\nDockerfile' )
-
-  await shellCmd( 'git add -f docker' )
-
-  log( `
-  ${chalk.yellow.bold( '***IMPORTANT***' )}
-
-  Please make the following .gitignore modifications:
-    change /dist to ${chalk.green.bold( '/build' )}
-    remove ${chalk.red.bold( '/docker' )}
-` )
-
-  await proceed( 'Acknowledge the .gitignore mods were made?' )
-}
-
-export default {
-  getPreviousBuild,
-  setPreviousBuild,
-  generateDockerfile,
-  formCloudBuildBucketName,
-  validateCloudBuildBucket,
-  buildContainerImage,
-  repoCleanup,
-}