@leverege/build-tools 2.58.6 → 2.59.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.58.6",
+  "version": "2.59.0-beta.2",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -27,7 +27,6 @@
     "encrypt-secrets": "src/encrypt-secrets.sh",
     "firebaseDeploy": "src/firebaseDeploy.mjs",
     "firebaseServe": "src/firebaseServe.mjs",
-    "generate-docs": "src/generate-docs.mjs",
     "getfbcfg": "src/getfbcfg.mjs",
     "getjson": "src/getjson.mjs",
     "git-tar": "src/git-tar.sh",
@@ -60,9 +59,8 @@
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
     "@google-cloud/artifact-registry": "^3.5.0",
-    "@leverege/jsdoc-template": "^1.0.1",
     "ansi-colors": "^4.1.3",
-    "chalk": "^5.4.1",
+    "chalk": "^5.3.0",
     "command-line-args": "^6.0.1",
     "command-line-usage": "^7.0.3",
     "deepmerge": "^4.3.1",
@@ -70,9 +68,8 @@
     "execa": "^9.5.2",
     "glob": "^11.0.0",
     "handlebars": "^4.7.8",
-    "inquirer": "^12.3.0",
+    "inquirer": "^12.2.0",
     "js-yaml": "^4.1.0",
-    "jsdoc": "^4.0.4",
     "ms": "^2.1.3",
     "npm-registry-fetch": "^18.0.2",
     "package-up": "^5.0.0",
@@ -81,10 +78,10 @@
     "readline-sync": "^1.4.10",
     "semver": "^7.6.3",
     "simple-git": "^3.27.0",
-    "zx": "^8.3.0"
+    "zx": "^8.2.4"
   },
   "devDependencies": {
     "@leverege/eslint-config-leverege": "^5.0.1",
-    "npm": "^11.0.0"
+    "npm": "^10.9.2"
   }
 }

package/src/Docker.mjs

@@ -1,4 +1,6 @@
 import fs from 'node:fs'
+import path from 'node:path'
+import url from 'node:url'
 
 import chalk from 'chalk'
 import handlebars from 'handlebars'
@@ -13,6 +15,8 @@ import {
   warning
 } from './Utils.mjs'
 
+const DIRNAME = path.dirname( url.fileURLToPath( import.meta.url ) )
+
 // TODO: change default to node 22 (jod) after 01/01/25
 const dockerfileNodeVersion = process.env.USE_NODEJS_22 ? 'jod-alpine' : 'iron-alpine'
 
@@ -20,73 +24,6 @@ const dockerfileNodeVersion = process.env.USE_NODEJS_22 ? 'jod-alpine' : 'iron-a
 // the build-tools repository, but it just became simpler to pull the contents
 // directly into these variables and forego the file loading.
 //
-const dockerfileTemplate = `
-# Version {{regvers}} @ {{date}}
-#
-# The FROM directive sets the Base Image for subsequent instructions
-FROM node:{{nodeimage}} as intermediate
-ENV NODE_ENV production
-ENV NPM_CONFIG_USERCONFIG /usr/src/app/.npmrc
-
-RUN mkdir -p /usr/src/app
-WORKDIR /usr/src/app
-
-# Install app dependencies
-COPY ./workspace/ /usr/src/app/
-ENV GRPC_VERBOSITY ERROR
-
-# --------------------------------------------------------------
-# copy the ssh keys into place, npm install, and remove them
-# --------------------------------------------------------------
-
-# Install packages to install private repos with ssh keys
-COPY ./.npmrc \${NPM_CONFIG_USERCONFIG}
-RUN apk --no-cache add openssh-client && \
-    apk --update add --no-cache --virtual build-dep g++ gcc libgcc \\
-      libstdc++ linux-headers make {{apkadds}} && \
-    npm install -g npm@10
-
-{{preInstallPluginfile}}
-
-# Use SKIP_PREPARE to disable hook-and-release from running
-ENV SKIP_PREPARE=true
-
-# Do the clean install and remove the npm token and ssh keys from the image
-RUN npm ci --only=production --no-optional {{npmlogging}} && \
-    rm -f \${NPM_CONFIG_USERCONFIG} /root/.ssh/*
-
-# --------------------------------------------------------------
-# Docker Final Stage
-# --------------------------------------------------------------
-
-FROM node:{{nodeimage}}
-ENV NPM_CONFIG_USERCONFIG /usr/src/app/.npmrc
-
-# Copy .npmrc for private registry access for access to any @leverege packages
-COPY ./.npmrc \${NPM_CONFIG_USERCONFIG}
-
-# Install tini for PID 1 and replace shell with bash so we can source files
-RUN apk update && \
-    apk add --no-cache bash curl tini vim {{apkadds}} && \
-    npm install -g npm@10 && \
-    rm /bin/sh && ln -s /bin/bash /bin/sh && \
-    mkdir -p /usr/src/app /tmp/levlog && \
-    chown node:node /usr/src/app
-
-# Pull in the Dockerfile.plugin file here
-{{pluginfile}}
-
-# Eliminate the sensitive info from the final stage image
-RUN rm -f \${NPM_CONFIG_USERCONFIG}
-
-ENTRYPOINT [ "/sbin/tini", "--" ]
-WORKDIR /usr/src/app
-
-COPY --chown=node:node --from=intermediate /usr/src/app /usr/src/app
-
-USER {{runuser}}
-COPY ./bashrc /home/node/.bashrc
-CMD [ "/bin/bash", "-c", "source /home/node/.bashrc && node index.js" ]`
 
 const pluginTemplate = `
 # Dockerfile.plugin - optionally extend the service Docker image
@@ -103,73 +40,16 @@ const pluginTemplate = `
 # footprints small, so adding packages "just because" is not considered
 # a best practice.
 `
-
-const bashrcTemplate = `#!/bin/bash
-#
-alias h=history
-
-alias ls='ls -CF --color=auto'
-alias ll='ls -lh'
-alias lla='ls -lha'
-alias glep='grep -l -s'
-alias m=less
-alias menv='env | sort | less'
-
-alias whatsmyip='wget -qO- ifconfig.co'
-
-alias err='wget -q -O- localhost:5111/logLevel/error'
-alias wrn='wget -q -O- localhost:5111/logLevel/warn'
-alias inf='wget -q -O- localhost:5111/logLevel/info'
-alias dbg='wget -q -O- localhost:5111/logLevel/debug'
-alias trc='wget -q -O- localhost:5111/logLevel/trace'
-
-socks()
-{
-  netstat -ant | awk '{print }' | sort | uniq -c | sort -n
-}
-
-cmetrics()
-{
-  wget -qO- localhost:5111/metrics
-}
-
-cmstat()
-{
-  wget -qO- localhost:5111
-}
-
-cmclear()
-{
-  # Future me - thinking this should call cmstat and pass in the endpoint as
-  # a parameter? Well don't do it - without escaping the dollar 1 in cmstat
-  # the port will end up being 51111, and escaping causes linting to complain
-  # about unnecessary escaping.
-  wget -qO- localhost:5111/status/clear
-}
-
-dunm() {
-  du -sh /usr/src/app/node_modules/* | sort -sh
-}
-`
-const cloudBuildSteps = `
-steps:
-  - name: 'gcr.io/cloud-builders/docker'
-    args:
-      - 'build' 
-      - '--network=cloudbuild'
-      - '-t'
-      - '{{imageName}}:{{imageVersion}}'
-      - '.'
-    
-images:
-  - '{{imageName}}:{{imageVersion}}'
-`
+const dockerfileTemplate = fs.readFileSync( path.join( DIRNAME, './templates/dockerfileTemplate.hbs' ), 'utf8' )
+const bashrcTemplate = fs.readFileSync( path.join( DIRNAME, './templates/bashrcTemplate.hbs' ), 'utf8' )
+const cloudBuildSteps = fs.readFileSync( path.join( DIRNAME, './templates/cloudBuildSteps.hbs' ), 'utf8' )
 
 const defaultSettings = {
   apkadds : '',
   date : getDateTimestamp(),
   nodeimage : process.env.USE_NODEJS_22 ? 'jod-alpine' : 'iron-alpine',
-  npmlogging : process.env.VERBOSE_NPM_LOGGING ? '--ddd' : '--silent',
+  imageBase : process.env.USE_NODEJS_22 ? 'node:jod-alpine' : 'node:iron-alpine',
+  npmlogging : process.env.VERBOSE_NPM_LOGGING ? '--ddd' : '--ddd',
   pluginfile : '# NO PLUGIN',
   preInstallPluginfile : '# NO PRE-INSTALL PLUGIN',
   regvers : 'package.version',
@@ -195,7 +75,7 @@ const generateDockerfile = ( options ) => {
   if ( !settings.nodeimage ) {
     settings.nodeimage = dockerfileNodeVersion
   }
-
+  settings.image = settings.imageBase || `node:${settings.nodeimage}`
   // Ensure the presence of the docker dir with plugin and bashrc - this code
   // could probably be tightened up a little.
   try {

package/src/Utils.mjs

@@ -1,6 +1,4 @@
 import { existsSync, readdirSync, readFileSync } from 'node:fs'
-import path from 'node:path'
-import url from 'node:url'
 
 import chalk from 'chalk'
 import { $ } from 'execa'
@@ -9,10 +7,6 @@ import { glob } from 'glob'
 import { packageUp } from 'package-up'
 import YAML from 'js-yaml'
 
-// __dirname goes away with ESM so we take this approach instead and
-// this assumes this file lives in the src dir of the build-tools repo
-export const BUILD_TOOLS_ROOT = path.dirname( url.fileURLToPath( import.meta.url ) )
-
 let debugEnabled = process.env.BUILD_TOOLS_DEBUG === '1'
 
 export const enableDebug = () => { debugEnabled = true }
@@ -477,7 +471,7 @@ export const analyzeRepository = async ( giveGuidance ) => {
     await shellCmd( 'npm run build' )
   }
 
-  const buildToolsVersion = closestPackageJson.devDependencies['@leverege/build-tools'] || closestPackageJson.dependencies['@leverege/build-tools']
+  const buildToolsVersion = closestPackageJson.devDependencies['@leverege/build-tools']
   if ( !buildToolsVersion ) {
     errorExit( 'Error: missing devDependency for @leverege/build-tools in package.json' )
   }

package/src/circleate.sh

@@ -128,7 +128,7 @@ jobs:
           at: ~/project
       - run:
           name: Generate docs
-          command: npm run docs
+          command: npx jsdoc -r src -R README.md -d docs
       - store_artifacts:
           path: docs
           prefix: docs
@@ -347,7 +347,7 @@ jobs:
           at: ~/project
       - run:
           name: Generate docs
-          command: npm run docs
+          command: npx jsdoc -r src -R README.md -d docs
       - store_artifacts:
           path: docs
           prefix: docs

package/src/docker-to-registry.mjs

@@ -96,6 +96,8 @@ if ( semver.lt( semver.coerce( repoDescr.buildToolsVersion ), minimumBuildToolsV
 
 const dockerInfo = await docker.generateDockerfile( {
   regvers : repoDescr.packageVersion,
+  imageBase : repoDescr.closestPackageJson.leverege?.imageBase,
+  buildEnv : repoDescr.closestPackageJson.leverege?.buildEnv || 'alpine',
   nodeimage : repoDescr.closestPackageJson.leverege?.nodeimg, // left as nodeimg in package.json for backwards compat
 } )
 debug( { dockerInfo }, '<==The Docker Info' )
@@ -216,7 +218,8 @@ log( `
     NPM Workspace: ${chalk.green.bold( isNpmWorkspace )}
 
   ${chalk.green.bold( 'Docker Information:' )}
-    NodeImage:     ${chalk.green.bold( dockerInfo.nodeimage )}
+    NodeImage:     ${chalk.green.bold( dockerInfo.imageBase || `node:${dockerInfo.nodeimage}` )}
+    Docker Env:    ${chalk.green.bold( dockerInfo.buildEnv || 'alpine' )}
     AddedPkgs:     ${chalk.green.bold( dockerInfo.apkadds )}
     Run User:      ${chalk.green.bold( dockerInfo.runuser )}
     Previous:      ${chalk.yellow.bold( dockerInfo.previousBuild )}

package/src/helm-charts/elasticsearch8/helmup.plugin

@@ -2,7 +2,7 @@
 #
 showInstalling "Elastic Search 8"
 
-[ -z "$ELASTIC_CHART_VERSION" ] && ELASTIC_CHART_VERSION="21.4.1"
+[ -z "$ELASTIC_CHART_VERSION" ] && ELASTIC_CHART_VERSION="21.3.22"
 
 OCI_CHART="oci://registry-1.docker.io/bitnamicharts/elasticsearch"
 

package/src/helm-charts/prom-operator/helmup.plugin

@@ -4,7 +4,7 @@ showInstalling "The Prometheus Operator and Components"
 addHelmRepo prometheus-community https://prometheus-community.github.io/helm-charts
 
 showInstalling "The Prometheus Operator (kube-prometheus-stack)"
-[ -z "$PROMETHEUS_STACK_CHART_VERSION" ] && PROMETHEUS_STACK_CHART_VERSION="67"
+[ -z "$PROMETHEUS_STACK_CHART_VERSION" ] && PROMETHEUS_STACK_CHART_VERSION="66"
 
 NS="--namespace prometheus"
 

package/src/helm-charts/redis/helmup.plugin

@@ -4,7 +4,7 @@ showInstalling "Redis"
 
 OCI_CHART="oci://registry-1.docker.io/bitnamicharts/redis"
 
-[ -z "$REDIS_CHART_VERSION" ] && REDIS_CHART_VERSION="20.6.0"
+[ -z "$REDIS_CHART_VERSION" ] && REDIS_CHART_VERSION="20.3.0"
 
 helm upgrade --install redis $OCI_CHART       \
              --values  redis/redis-local.yaml \

package/src/helm-charts/velero/helmup.plugin

@@ -4,7 +4,7 @@ showInstalling "Velero Backup System"
 
 addHelmRepo vmware-tanzu https://vmware-tanzu.github.io/helm-charts
 
-[ -z "$VELERO_CHART_VERSION" ] && VELERO_CHART_VERSION="8"
+[ -z "$VELERO_CHART_VERSION" ] && VELERO_CHART_VERSION="7"
 #
 # Build the bucket, region and SA email variables and use --set to mod the
 # chart values as opposed to using an OVH:<label> approach. This eliminates

package/src/helmup.sh

@@ -699,10 +699,10 @@ function installVeleroEnvironment() {
   gcloud config set project $GCP_PROJECT_ID
 
   ## The major chart version will determine the bucket suffix
-  [ -z "$VELERO_CHART_VERSION" ] && VELERO_CHART_VERSION="8"
+  [ -z "$VELERO_HELM_CHART" ] && VELERO_HELM_CHART="7"
 
   ## Create a bucket
-  BUCKET="$GCP_PROJECT_ID-velero-$VELERO_CHART_VERSION"
+  BUCKET="$GCP_PROJECT_ID-velero-$VELERO_HELM_CHART"
   printf "\nCreating storage bucket `color g $BUCKET` in `color g $GCE_REGION`\n"
   gsutil mb -l $GCE_REGION gs://$BUCKET/ &> $DEVNULL
   warnOnError $? "Bucket failed to create or already exists - go check it\n"

package/src/templates/bashrcTemplate.hbs

@@ -0,0 +1,46 @@
+#!/bin/bash
+#
+alias h=history
+
+alias ls='ls -CF --color=auto'
+alias ll='ls -lh'
+alias lla='ls -lha'
+alias glep='grep -l -s'
+alias m=less
+alias menv='env | sort | less'
+
+alias whatsmyip='wget -qO- ifconfig.co'
+
+alias err='wget -q -O- localhost:5111/logLevel/error'
+alias wrn='wget -q -O- localhost:5111/logLevel/warn'
+alias inf='wget -q -O- localhost:5111/logLevel/info'
+alias dbg='wget -q -O- localhost:5111/logLevel/debug'
+alias trc='wget -q -O- localhost:5111/logLevel/trace'
+
+socks()
+{
+  netstat -ant | awk '{print }' | sort | uniq -c | sort -n
+}
+
+cmetrics()
+{
+  wget -qO- localhost:5111/metrics
+}
+
+cmstat()
+{
+  wget -qO- localhost:5111
+}
+
+cmclear()
+{
+  # Future me - thinking this should call cmstat and pass in the endpoint as
+  # a parameter? Well don't do it - without escaping the dollar 1 in cmstat
+  # the port will end up being 51111, and escaping causes linting to complain
+  # about unnecessary escaping.
+  wget -qO- localhost:5111/status/clear
+}
+
+dunm() {
+  du -sh /usr/src/app/node_modules/* | sort -sh
+}

package/src/templates/cloudBuildSteps.hbs

@@ -0,0 +1,13 @@
+steps:
+  - name: 'gcr.io/cloud-builders/docker'
+    args:
+      - 'build' 
+      - '--network=cloudbuild'
+      - '-t'
+      - '{{imageName}}:{{imageVersion}}'
+      - '--cache-from'
+      - '{{imageName}}:{{imageVersion}}'
+      - '.'
+    
+images:
+  - '{{imageName}}:{{imageVersion}}'

package/src/templates/dockerfileTemplate.hbs

@@ -0,0 +1,86 @@
+# Version {{regvers}} @ {{date}}
+
+# The FROM directive sets the Base Image for subsequent instructions
+FROM {{image}} as intermediate
+
+ARG BUILD_ENV="{{buildEnv}}"
+
+ENV NODE_ENV production
+ENV NPM_CONFIG_USERCONFIG /usr/src/app/.npmrc
+
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+
+# Install app dependencies
+COPY ./workspace/ /usr/src/app/
+ENV GRPC_VERBOSITY ERROR
+
+# --------------------------------------------------------------
+# copy the ssh keys into place, npm install, and remove them
+# --------------------------------------------------------------
+
+# Install packages to install private repos with ssh keys
+COPY ./.npmrc ${NPM_CONFIG_USERCONFIG}
+
+RUN if [ "${BUILD_ENV}" = "debian" ]; then \
+      apt-get update && \
+      apt-get install -y openssh-client build-essential && \
+      npm install -g npm@10; \
+    else \
+      apk --no-cache add openssh-client && \
+      apk --update add --no-cache --virtual build-dep g++ gcc libgcc libstdc++ linux-headers make {{apkadds}} && \
+      npm install -g npm@10; \
+    fi
+
+# Use SKIP_PREPARE to disable hook-and-release from running
+ENV SKIP_PREPARE=true
+
+{{preInstallPluginfile}}
+
+# Do the clean install and remove the npm token and ssh keys from the image
+RUN npm ci --only=production --no-optional {{npmlogging}} && \
+    rm -f ${NPM_CONFIG_USERCONFIG} /root/.ssh/*
+
+# --------------------------------------------------------------
+# Docker Final Stage
+# --------------------------------------------------------------
+
+FROM {{image}}
+
+ARG BUILD_ENV="{{buildEnv}}"
+
+ENV NPM_CONFIG_USERCONFIG /usr/src/app/.npmrc
+
+# Copy .npmrc for private registry access for access to any @leverege packages
+COPY ./.npmrc ${NPM_CONFIG_USERCONFIG}
+
+# Install tini for PID 1 and replace shell with bash so we can source files
+RUN if [ "$BUILD_ENV" = "debian" ]; then \
+      apt-get update && \
+      apt-get install -y tini bash curl vim {{apkadds}} && \
+      npm install -g npm@10 && \
+      rm /bin/sh && ln -s /bin/bash /bin/sh && \
+      mkdir -p /usr/src/app /tmp/levlog && chown node:node /usr/src/app; \
+    else \
+      apk update && \
+      apk add --no-cache bash curl tini vim {{apkadds}} && \
+      npm install -g npm@10 && \
+      rm /bin/sh && ln -s /bin/bash /bin/sh && \
+      mkdir -p /usr/src/app /tmp/levlog && chown node:node /usr/src/app; \
+    fi
+
+
+# Pull in the Dockerfile.plugin file here
+{{pluginfile}}
+
+# Eliminate the sensitive info from the final stage image
+RUN rm -f ${NPM_CONFIG_USERCONFIG}
+
+ENTRYPOINT [ "tini", "--" ]
+WORKDIR /usr/src/app
+
+COPY --chown=node:node --from=intermediate /usr/src/app /usr/src/app
+
+USER {{runuser}}
+COPY ./bashrc /home/node/.bashrc
+CMD [ "/bin/bash", "-c", "source /home/node/.bashrc && node index.js" ]

package/src/generate-docs-conf.json

@@ -1,41 +0,0 @@
-{
-  "tags": {
-    "allowUnknownTags": false
-  },
-  "source": {
-    "includePattern": "\\.(js|mjs|jsx)$",
-    "excludePattern": "(node_modules/|docs)"
-  },
-  "plugins": [],
-  "templates": {
-    "cleverLinks": true,
-    "monospaceLinks": false,
-    "preserveDescriptions": true,
-    "default": {
-      "useLongnameInNav": true,
-      "outputSourceFiles": false
-    }
-  },
-  "opts": {
-    "encoding": "utf8",
-    "lenient": false,
-    "markdown": true
-  },
-  "docdash": {
-    "static": true,
-    "sort": false,
-    "search": true,
-    "collapse": true,
-    "typedefs": true,
-    "removeQuotes": "none",
-    "scripts": [],
-    "menu":{
-      "Bitbucket": {
-        "href":"https://bitbucket.org/leverege/IF_THIS_MAKES_SENSE",
-        "target":"_blank",
-        "class":"menu-item",
-        "id":"repository"
-      }
-    }
-  }
-}

package/src/generate-docs.mjs

@@ -1,51 +0,0 @@
-#!/usr/bin/env node
-/*
- * Encapsulates the rather lengthy jsdoc / md docs npm script:
- *
- *   npx jsdoc -c ./jsdoc.json -R README.md -d docs src && \
- *   mkdir -p docs/md && \
- *   npx --package=jsdoc-to-markdown jsdoc2md --files src/*.js --configure ./jsdoc.json > docs/md/API.md
- *
- */
-import fs from 'node:fs'
-
-import {
-  BUILD_TOOLS_ROOT,
-  debug,
-  err,
-  getRepositoryDescr,
-  shellCmd,
-} from './Utils.mjs'
-
-const jsdocConfig = `${BUILD_TOOLS_ROOT}/generate-docs-conf.json`
-
-// build the location of the template file from the build-tools root
-// in order to avoid hardcoding in the jsdoc config file - this is
-// important in order to support running generate-docs from a user's
-// laptop or deployed to the doc-creator service on k8s
-const jsdocTemplate = `${BUILD_TOOLS_ROOT}/../../jsdoc-template`
-
-if ( !fs.existsSync( jsdocConfig ) ) { // eslint-disable-line security/detect-non-literal-fs-filename
-  err( `cannot find the jsdoc config file: ${jsdocConfig}` )
-  process.exit( 1 )
-}
-
-const repoDescr = await getRepositoryDescr()
-
-debug( { jsdocConfig, repoDescr }, '<==The Repo' )
-
-// blow away any existing docs before recreating the docs dir
-if ( fs.existsSync( 'docs' ) ) {
-  fs.rmSync( 'docs', { recursive : true } )
-}
-fs.mkdirSync( 'docs/md', { recursive : true } )
-
-try {
-  await shellCmd( `npx --yes jsdoc -c ${jsdocConfig} -t ${jsdocTemplate} -R README.md -d docs src` )
-  await shellCmd(
-    `npx --yes --package=jsdoc-to-markdown jsdoc2md --files src/*.js --configure ${jsdocConfig}`,
-    { stdout : { file : 'docs/md/API.md' } }
-  )
-} catch ( error ) {
-  err( error )
-}