@leverege/build-tools 2.59.2 → 2.60.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.59.2",
+  "version": "2.60.0",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {

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 = 'jod-alpine'
 
@@ -20,74 +24,6 @@ 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 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 {{npmVersion}}
-
-{{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 {{npmVersion}} && \
-    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,72 +39,15 @@ 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 : 'jod-alpine',
+  imageBase : 'node:jod-alpine',
   npmlogging : process.env.VERBOSE_NPM_LOGGING ? '--ddd' : '--silent',
   npmVersion : 'npm@11',
   pluginfile : '# NO PLUGIN',
@@ -196,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 {
@@ -207,7 +86,9 @@ const generateDockerfile = ( options ) => {
   }
 
   const bashrcFile = './docker/bashrc'
-  if ( !fs.existsSync( bashrcFile ) ) {
+  // 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 ) ) {

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/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 wget 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" ]