@leverege/build-tools 2.46.0 → 2.47.0

package/package.json

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

package/src/Docker.mjs

@@ -3,7 +3,14 @@ import fs from 'node:fs'
 import chalk from 'chalk'
 import handlebars from 'handlebars'
 
-import { errorExit, log, proceed, shellCmd, warning } from './Utils.mjs'
+import {
+  errorExit,
+  getGcpAccount,
+  log,
+  proceed,
+  shellCmd,
+  warning
+} from './Utils.mjs'
 
 // 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
@@ -217,8 +224,11 @@ const validateCloudBuildBucket = async ( artifactProject ) => {
   }
 }
 
-const buildContainerImage = async ( { artifactProject, artifactRegistry, containerName, imageVersion } ) => {
+const buildContainerImage = async ( {
+  artifactProject, artifactRegistry, containerName, imageVersion, isNpmWorkspace,
+} ) => {
   const buildWorkspace = './build/workspace' // passed to Cloud Build
+  const imageName = `${artifactRegistry}/images/${containerName}`
 
   if ( fs.existsSync( buildWorkspace ) ) {
     fs.renameSync( buildWorkspace, `${buildWorkspace}-junk` )
@@ -235,26 +245,40 @@ const buildContainerImage = async ( { artifactProject, artifactRegistry, contain
   fs.cpSync( `${process.env.HOME}/.npmrc`, './build/.npmrc' )
   fs.cpSync( './docker/bashrc', './build/bashrc' )
   fs.cpSync( './package.json', `${buildWorkspace}/package.json` )
-  fs.renameSync( './package-lock.json', `${buildWorkspace}/package-lock.json` )
+  fs.cpSync( './package-lock.json', `${buildWorkspace}/package-lock.json` )
+  if ( isNpmWorkspace ) {
+    fs.rm( './package-lock.json', ( err ) => {} ) // no leaf node locks in workspaces
+  }
 
   setPreviousBuild( imageVersion ) // update docker/.previous file
 
+  const { fullName : builderName } = await getGcpAccount()
   const gcloudBuild = `time gcloud builds submit --project ${artifactProject}`
   const gcloudLogs = `--gcs-log-dir ${formCloudBuildBucketName( artifactProject )}/log`
-  const gcloudTags = `--tag ${artifactRegistry}/images/${containerName}:${imageVersion}`
+  const gcloudTags = `--tag ${imageName}:${imageVersion}`
 
   log( chalk.green.bold( `
-  *** Submitting Build ***
+  *** Submitting Build as ${builderName} ***
       ${gcloudBuild} \\
            ${gcloudLogs}  \\
            ${gcloudTags}
   ` ) )
 
+  if ( process.env.DRY_RUN === '1' ) {
+    log( '\n***Exiting from DRY_RUN\n' )
+    process.exit( 0 )
+  }
+
   await shellCmd( `${gcloudBuild} ${gcloudLogs} ${gcloudTags} ./build`, { stdio : 'inherit' } )
+
+  const imageTag = `${defaultSettings.date}-${defaultSettings.nodeimage}-${builderName}`
+  await shellCmd(
+    `gcloud container images add-tag --quiet ${imageName}:${imageVersion} ${imageName}:${imageTag} ${imageName}:latest`
+  )
 }
 
 const repoCleanup = async () => {
-  // remove garbase from the repo
+  // remove garbage from the repo
   const garbage = [
     'build',
     'dist',
@@ -266,9 +290,9 @@ const repoCleanup = async () => {
   ]
   garbage.forEach( trash => fs.rmSync( trash, { recursive : true, force : true } ) )
 
-  fs.writeFileSync( 'docker/.gitignore', '.previous' )
+  fs.writeFileSync( 'docker/.gitignore', '.previous\nDockerfile' )
 
-  await shellCmd( 'git add -f docker' )
+  await shellCmd( 'git add docker' )
 
   log( `
   ${chalk.yellow.bold( '***IMPORTANT***' )}

package/src/Utils.mjs

@@ -68,6 +68,18 @@ export const shellCmd = async ( cmdstr, opts = {} ) => {
   }
 }
 
+// returns YYYMMDD-hhmm
+export const getDateTimestamp = () => {
+  const fullDTS = new Date().toISOString().replace( /[-T:]/g, '' ).slice( 0, 14 )
+  return `${fullDTS.slice( 0, 8 )}-${fullDTS.slice( 8, 12 )}`
+}
+
+export const getGcpAccount = async () => {
+  const fullAccount = await shellCmd( 'gcloud config get account' )
+  const [ fullName, domain ] = fullAccount.split( '@' )
+  return { fullAccount, fullName, domain }
+}
+
 export const getGcpSecret = async ( gcpProject, secretName, opts ) => {
   const secretFetchCmd = `gcloud secrets versions access latest --project=${gcpProject} --secret=${secretName}`
   let secretString
@@ -100,6 +112,22 @@ export const getGitRootDirectory = async () => {
   }
 }
 
+export const getGitUpstream = async () => {
+  let branch
+  try {
+    branch = await shellCmd( 'git rev-parse --abbrev-ref HEAD' )
+    const upstream = await shellCmd( `git rev-parse --abbrev-ref ${branch}@{u}` )
+    return { branch, upstream }
+  } catch ( err ) {
+    return { branch, upstream : undefined }
+  }
+}
+
+export const gitRepoIsDirty = async () => {
+  const cleanliness = await shellCmd( 'git status --porcelain' )
+  return cleanliness?.length
+}
+
 export const parseJsonFile = async ( jsonFile ) => {
   /* eslint-disable security/detect-non-literal-fs-filename */
   if ( existsSync( jsonFile ) ) {
@@ -290,7 +318,7 @@ https://console.cloud.google.com/artifacts/browse/leverege-registry?project=leve
   return { artifactRegistry, ...packageJson }
 }
 
-export const parseHelmChart = async ( helmroot ) => {
+export const parseHelmChart = async ( helmroot = './helm' ) => {
   /* eslint-disable security/detect-non-literal-fs-filename */
   const chartFiles = readdirSync( helmroot, { encoding : 'utf8', recursive : true } )
   const chartYaml = YAML.load( readFileSync( `${helmroot}/Chart.yaml`, 'utf8' ) )
@@ -308,6 +336,7 @@ export const parseHelmChart = async ( helmroot ) => {
 export const analyzeRepository = async () => {
   const gitRoot = await getGitRootDirectory()
   const subPkgs = await glob( `${gitRoot}/packages/**/package.json`, { ignore : '/**/node_modules/**' } )
+  const helmChart = await parseHelmChart()
   const isMonoRepo = subPkgs?.length > 0
 
   // Verify the presence of a root package.json file for all monorepos
@@ -355,6 +384,7 @@ export const analyzeRepository = async () => {
   const containerName = closestPackageJson.name
   const artifactProject = closestPackageJson.artifactRegistry.project
   const artifactRegistry = closestPackageJson.leverege.registry
+  const packageVersion = `v${closestPackageJson.version}`
 
   const currentDir = process.cwd()
   const closestPkg = await packageUp()
@@ -381,10 +411,12 @@ export const analyzeRepository = async () => {
     closestPkg,
     gitRoot,
     gitRemote,
+    helmChart,
     isMonoRepo,
     isNpmWorkspace,
     rootPackageJson,
     closestPackageJson,
+    packageVersion,
     subPkgs,
     wsName,
   }

package/src/docker-to-registry.mjs

@@ -8,6 +8,8 @@ import {
   debug, log,
   errorExit,
   analyzeRepository,
+  getGitUpstream,
+  gitRepoIsDirty,
   proceed,
   shellCmd } from './Utils.mjs'
 
@@ -16,23 +18,55 @@ import docker from './Docker.mjs'
 // refresh-npm-token does not throw so no need to try, but it emits in debug
 const refreshErr = await shellCmd( 'refresh-npm-token' )
 if ( refreshErr && !process.env.BUILD_TOOLS_DEBUG ) {
-  errorExit( `***Error: npm token refresh failed\n\n${refreshErr}` )
+  log( refreshErr ) // most likely the token refreshed message
 }
 
 // Expected to be invoked like docker-to-registry v1.2.3
 const imageVersion = process.argv[2]
+if ( !imageVersion ) {
+  errorExit( '***Error: docker-to-registry requires an image version' )
+}
+
 const willGitTag = imageVersion.match( /^v\d+\.\d+\.\d+$/ )
 const tagInfo = willGitTag ?
   chalk.yellow.bold( 'will be git tagged' ) :
   chalk.red( 'BETA RELEASE WILL NOT BE GIT TAGGED' )
 
+const repoIsDirty = await gitRepoIsDirty()
+
+if ( willGitTag && repoIsDirty ) {
+  log( `
+  ${chalk.red.bold( '***ERROR: attempting to tag a non-beta dirty git repository' )}
+
+  You are attempting to create a tagged release image for pushing to the
+  artifact registry, but there are locally modified files. This is not
+  allowed since the applied tag will not be relevant to the image version
+  due to the pending commits.
+
+  Available options for proceeding:
+
+    ${chalk.green.bold( '1) cleanly commit all local mods assuming relevance' )}
+    ${chalk.yellow( '2) eliminate unwanted local modifications' )}
+    ${chalk.red( '3) stash anything that is irrelevant to this release' )}
+
+  ` )
+  process.exit( 1 )
+}
+
 const repoDescr = await analyzeRepository()
 debug( { repoDescr }, '<==The Repo Description' )
 
 const dockerInfo = await docker.generateDockerfile()
 debug( { dockerInfo }, '<==The Docker Info' )
 
-const { artifactProject, artifactRegistry, containerName } = repoDescr
+const {
+  artifactProject,
+  artifactRegistry,
+  packageVersion,
+  containerName,
+  helmChart,
+  isNpmWorkspace,
+} = repoDescr
 
 if ( imageVersion === 'guide-me' ) {
   await docker.validateCloudBuildBucket( artifactProject )
@@ -50,6 +84,9 @@ if ( imageVersion === 'guide-me' ) {
   log( `
 
 
+
+  ${chalk.green.bold( '-------------------- Potential Helm Chart Mods --------------------' )}
+
   Moving to the new artifact-registry for docker image storage may also require
   helm chart changes depending on how old the current charts are. Charts that
   contain helm/values.yaml files that resemble this:
@@ -89,6 +126,31 @@ if ( imageVersion === 'guide-me' ) {
   process.exit( 0 )
 }
 
+// do chart checks too
+const chart = helmChart?.yaml['Chart.yaml']
+const values = helmChart?.yaml['values.yaml']
+const expectedChartRegistry = `${artifactRegistry}/images`
+
+if ( expectedChartRegistry !== values.image.registry ) {
+  log( `
+  ${chalk.red.bold( '***Error: mismatched package.json registry and helm/values.yaml' )}
+
+  The registry specified in the package.json leverege stanza does not line up
+  with the image registry in helm/values.yaml. The naming convention expects
+  the '/images' suffix to be added to the package.json registry string and then
+  stored as the image.registry in the helm/values.yaml file.
+
+    Current settings:
+      package.json registry => ${chalk.yellow.bold( artifactRegistry )}
+      values.yaml  registry => ${chalk.red.bold( values.image.registry )}
+
+    Expected settings:
+      values.yaml  registry => ${chalk.green.bold( expectedChartRegistry )}
+  ` )
+
+  process.exit( 1 )
+}
+
 // Give the summary and the user a chance to proceed or not
 log( `
   ${chalk.green.bold( 'Build Information:' )}
@@ -97,7 +159,7 @@ log( `
     Registry:      ${chalk.green.bold( artifactRegistry )}
     Image Folder:  ${chalk.yellow.bold( registryFolder )}
     Monorepo:      ${chalk.green.bold( repoDescr.isMonoRepo )}
-    NPM Workspace: ${chalk.green.bold( repoDescr.isNpmWorkspace )}
+    NPM Workspace: ${chalk.green.bold( isNpmWorkspace )}
 
   ${chalk.green.bold( 'Docker Information:' )}
     NodeImage:     ${chalk.green.bold( dockerInfo.nodeimage )}
@@ -108,11 +170,64 @@ log( `
     NPM Logs:      ${chalk.green.bold( dockerInfo.npmlogging )}
 ` )
 
+if ( imageVersion !== packageVersion ) {
+  log( `
+  ${chalk.yellow.bold( '***WARNING: specified version does not match package.json version' )}
+        package.json => ${chalk.green.bold( packageVersion )}
+        specified    => ${chalk.red.bold( imageVersion )}
+  ` )
+
+  if ( willGitTag ) {
+    log( chalk.red.bold( '... and you are attempting to release so NOPE!\n' ) )
+    process.exit( 1 )
+  }
+}
+
+const repoInfo = await getGitUpstream()
+
+if ( willGitTag && !repoInfo.upstream ) {
+  log( `
+  ${chalk.red.bold( '***ERROR: the current branch must have an upstream' )}
+
+  You are attempting to create a tagged release image for pushing to the
+  container registry, but the current branch does not have an upstream to
+  push to. This is not allowed since the applied tag will be stranded here
+  in your local repository, which is what we are trying to avoid.
+
+  Available options for proceeding:` )
+  log( chalk.green.bold( `
+    1) set an upstream for this branch via:
+           git push --set-upstream origin ${repoInfo.branch}` ) )
+  log( chalk.yellow.bold( `
+    2) rebase, squash and merge onto a branch with an upstream` ) )
+
+  process.exit( 1 )
+}
+
+if ( willGitTag ) {
+  if ( chart.appVersion !== imageVersion ) {
+    log( `
+  ${chalk.yellow.bold( '***WARNING: the helm/Chart.yaml appVersion does not align with the build version' )}
+    chart appVersion => ${chalk.yellow.bold( chart.appVersion )}
+    build version    => ${chalk.green.bold( imageVersion )}
+  ` )
+  }
+}
+
 await proceed()
 
-if ( repoDescr.isNpmWorkspace ) {
+if ( isNpmWorkspace ) {
   log( chalk.yellow.bold( 'Generating an NPM workspace package-lock.json file' ) )
   await shellCmd( 'npm install --package-lock-only --workspaces false', { stdio : 'inherit' } )
 }
 
-await docker.buildContainerImage( { artifactProject, artifactRegistry, containerName, imageVersion } )
+await docker.buildContainerImage( { artifactProject, artifactRegistry, containerName, imageVersion, isNpmWorkspace } )
+
+if ( willGitTag ) {
+  log( chalk.green.bold( `Tagging and Pushing ${imageVersion}\n` ) )
+  const tagDescription = `docker_${imageVersion}`
+  await shellCmd( `git tag -f ${imageVersion} -m ${tagDescription}` )
+  await shellCmd( 'git push --follow-tags' )
+} else {
+  log( chalk.yellow.bold( '\n*** Skipped git tagging - beta release' ) )
+}

package/src/docker-to-registry.sh

@@ -14,6 +14,13 @@ BASE_NODE_IMAGE="${BASE_NODE_IMAGE:-iron-alpine}" # node 20, iron
 
 # Load common bash functions
 . `build-tools --bashfun`
+cat<<DEPRECATED_TOOL
+
+  `color y "***DEPRECATED docker-to-registry.sh - upgrade to docker-to-registry.mjs***"`
+
+DEPRECATED_TOOL
+sleep 3
+
 PKGTOP="$npm_config_local_prefix"
 cd $PKGTOP/docker
 

package/src/dockreate.sh

@@ -8,6 +8,13 @@ fi
 
 # Load common bash functions
 . `build-tools --bashfun`
+cat<<DOCKREATE_DEPRECATED
+
+  `color y "***DOCKREATE is DEPRECATED - move to docker-to-registry***"`
+
+DOCKREATE_DEPRECATED
+sleep 3
+
 PKGTOP="$npm_config_local_prefix"
 cd $PKGTOP/docker
 

package/src/k8x.sh

@@ -16,6 +16,21 @@ cmd=${@:-"bash"}
 ns="default"
 
 case "$cmd" in 
+  "help")
+    cat<<K8X_HELP
+    
+Usage: `color g 'k8x <target>'` where target can be:
+
+  `color g cnpg`  - run bash on a cloudnative-pg cluster node
+  `color g es8`   - run bash on an elasticsearch8 node
+  `color g psql`  - run psql on a legacy database node
+  `color g redis` - run redis-cli on a redis master/replica
+  `color g help`  - this right here
+
+K8X_HELP
+    exit 0
+    ;;
+
   "bash")
     # invoked simply as k8x
     ;;
@@ -36,29 +51,8 @@ case "$cmd" in
     FZFQ="--query=redis" && cmd='redis-cli'
     ;;
 
-  "help"|*)
-    if [ "$cmd" != "help" ];
-    then
-      cat<<BAD_K8X
-
-`color r ***Error:` unrecognized k8x target => `color y "$cmd"`
-BAD_K8X
-      k8x.sh help
-      exit 1
-    fi
-
-    cat<<K8X_HELP
-    
-Usage: `color g 'k8x <target>'` where target can be:
-
-  `color g cnpg`  - run bash on a cloudnative-pg cluster node
-  `color g es8`   - run bash on an elasticsearch8 node
-  `color g psql`  - run psql on a legacy database node
-  `color g redis` - run redis-cli on a redis master/replica
-  `color g help`  - this right here
-
-K8X_HELP
-    exit 0
+  *)
+    FZFQ="--query=$cmd" && cmd='bash'
     ;;
 esac