@leverege/build-tools 2.46.0-beta.1 → 2.46.0

package/package.json

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

package/src/Docker.mjs

@@ -3,7 +3,7 @@ import fs from 'node:fs'
 import chalk from 'chalk'
 import handlebars from 'handlebars'
 
-import { errorExit, log, shellCmd, warning } from './Utils.mjs'
+import { errorExit, 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
@@ -116,6 +116,10 @@ cmclear()
 {
   cmstat /status/clear
 }
+
+dunm() {
+  du -sh /usr/src/app/node_modules/* | sort -sh
+}
 `
 
 // Just uses the old dockreate of formatting the date.
@@ -169,10 +173,10 @@ const generateDockerfile = ( settings = defaultSettings ) => {
   try {
     const build = fs.readdirSync( './build' )
     if ( build.length === 0 ) {
-      errorExit( `***ERROR: the build dir is empty - ${chalk.yellow( 'run npm build' )}` )
+      errorExit( `***ERROR: the build dir is empty - ${chalk.yellow( 'npm run build' )}` )
     }
   } catch ( err ) {
-    errorExit( `***ERROR: expected the ./build directory to exist - ${chalk.yellow( 'run npm build' )}` )
+    errorExit( `***ERROR: expected the ./build directory to exist - ${chalk.yellow( 'npm run build' )}` )
   }
 
   // At this point the plugin template better exist.
@@ -184,6 +188,8 @@ const generateDockerfile = ( settings = defaultSettings ) => {
 
   const compiled = handlebars.compile( dockerfileTemplate )
   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 )
@@ -212,19 +218,24 @@ const validateCloudBuildBucket = async ( artifactProject ) => {
 }
 
 const buildContainerImage = async ( { artifactProject, artifactRegistry, containerName, imageVersion } ) => {
-  const cloudBuildWorkspace = './docker/workspace'
+  const buildWorkspace = './build/workspace' // passed to Cloud Build
 
-  if ( fs.existsSync( cloudBuildWorkspace ) ) {
-    fs.renameSync( cloudBuildWorkspace, `${cloudBuildWorkspace}-junk` )
-    fs.rm( `${cloudBuildWorkspace}-junk`, { recursive : true }, ( err ) => {} ) // fire and forget
+  if ( fs.existsSync( buildWorkspace ) ) {
+    fs.renameSync( buildWorkspace, `${buildWorkspace}-junk` )
+    fs.rm( `${buildWorkspace}-junk`, { recursive : true }, ( err ) => {} ) // fire and forget
   }
 
-  fs.mkdirSync( cloudBuildWorkspace )
-
-  fs.cpSync( './build', './docker/workspace', { recursive : true } )
-  fs.cpSync( `${process.env.HOME}/.npmrc`, './docker/.npmrc' )
-  fs.cpSync( './package.json', './docker/workspace/package.json' )
-  fs.renameSync( './package-lock.json', './docker/workspace/package-lock.json' )
+  // 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.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` )
 
   setPreviousBuild( imageVersion ) // update docker/.previous file
 
@@ -239,7 +250,35 @@ const buildContainerImage = async ( { artifactProject, artifactRegistry, contain
            ${gcloudTags}
   ` ) )
 
-  await shellCmd( `${gcloudBuild} ${gcloudLogs} ${gcloudTags} ./docker`, { stdio : 'inherit' } )
+  await shellCmd( `${gcloudBuild} ${gcloudLogs} ${gcloudTags} ./build`, { stdio : 'inherit' } )
+}
+
+const repoCleanup = async () => {
+  // remove garbase from the repo
+  const garbage = [
+    'build',
+    'dist',
+    'docker/.keep',
+    'docker/.npmrc',
+    'docker/.gitignore',
+    'docker/Dockerfile',
+    'docker/workspace',
+  ]
+  garbage.forEach( trash => fs.rmSync( trash, { recursive : true, force : true } ) )
+
+  fs.writeFileSync( 'docker/.gitignore', '.previous' )
+
+  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 {
@@ -249,4 +288,5 @@ export default {
   formCloudBuildBucketName,
   validateCloudBuildBucket,
   buildContainerImage,
+  repoCleanup,
 }

package/src/Utils.mjs

@@ -134,7 +134,11 @@ export const parsePackageJson = async ( packageFileName ) => {
     },
 
 
-Where <registry folder> should be an existing folder in the artifact-registry.
+Where <registry folder> should be an existing folder in the artifact-registry
+and must not contain the service name. Visit the link below for a list of the
+existing / valid registry folders.
+
+https://console.cloud.google.com/artifacts/browse/leverege-registry?project=leverege-registry
 `
   const registry = packageJson?.leverege?.registry
   if ( !registry ) {
@@ -248,20 +252,35 @@ Where <registry folder> should be an existing folder in the artifact-registry.
   // DEPRECATED: old reference to ./dist should be ./build
   const { build, clean, dockerize, } = packageJson.scripts
 
-  if ( build.match( 'dist' ) || clean.match( 'dist' ) || dockerize.match( 'dockreate|cd docker' ) ) {
+  if ( build.match( 'dist' ) || clean.match( 'dist' ) ) {
     const deprecationError = `
 
-  Update the npm build, clean and dockerize scripts to use ./build instead of
-  the old ./dist directory, and docker-to-registry instead of the deprecated
-  dockreate script - note there is no longer a need to change dir into docker
-  in the dockerize script.
+  Update the npm build and clean scripts to use ./build instead of the old
+  ./dist directory.
     `
     const deprecationInfo = `
   "scripts": {
-    "build": "npm run clean && mkdir ./build && cp -r ./src/* ./build",
+    ${chalk.green.bold( '"build": "npm run clean && mkdir ./build && cp -r ./src/* ./build",' )}
     ...
-    "clean": "rm -fr coverage build",
-    "dockerize": "npm run build && docker-to-registry",
+    ${chalk.green.bold( '"clean": "rm -fr coverage build",' )}
+  },
+  `
+
+    deprecated( { deprecationError, deprecationInfo } )
+  }
+  
+  // DEPRECATED: old dockerize reference to docker dir and dockreate script
+  if ( dockerize.match( 'dockreate|cd docker' ) ) {
+    const deprecationError = `
+
+  Update the npm dockerize script to use docker-to-registry instead of the
+  deprecated dockreate script, and remove the old "cd docker" as well. The new
+  dockerize target is simply:
+    `
+    const deprecationInfo = `
+  "scripts": {
+    ...
+    ${chalk.green.bold( '"dockerize": "npm run build && docker-to-registry",' )}
     ...
   },
   `
@@ -291,13 +310,40 @@ export const analyzeRepository = async () => {
   const subPkgs = await glob( `${gitRoot}/packages/**/package.json`, { ignore : '/**/node_modules/**' } )
   const isMonoRepo = subPkgs?.length > 0
 
+  // Verify the presence of a root package.json file for all monorepos
   let rootPackageJson
   try {
     rootPackageJson = await parseJsonFile( `${gitRoot}/package.json` )
   } catch ( error ) {
-    rootPackageJson = { invalid : true, error : 'invalid or non-existent root package.json file' }
+    rootPackageJson = { isInvalid : true, error : 'invalid or non-existent root package.json file' }
+  }
+  const isNpmWorkspace = rootPackageJson?.workspaces?.length > 0
+  if ( isMonoRepo && rootPackageJson.isInvalid ) {
+    log( chalk.red.bold( `
+  ***REQUIRED: A package.json file is required at the monorepo root` ) )
+
+    log( chalk.green.bold( `
+  A basic root package.json resembles the following:` ) )
+
+    log( chalk.yellow.bold( `
+{
+  "name": "@leverege/<your mono name>",
+  "description": "A monorepo for <what is it for?>",
+  "scripts": {
+    "lint": "npm run lint --workspaces",
+    "prepare": "husky",
+    "test": "npm run test --workspaces"
+  },
+  "author": "Leverege",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "devDependencies": {
+    "husky": "^9.0.5"
+  },
+  "workspaces": [
+  ]
+}` ) )
+    process.exit( 1 )
   }
-  const isNpmWorkspace = subPkgs?.length > 0
 
   log( chalk.green.bold( '\nParsing and analyzing the package.json file\n' ) )
   let closestPackageJson

package/src/docker-to-registry.mjs

@@ -34,7 +34,9 @@ debug( { dockerInfo }, '<==The Docker Info' )
 
 const { artifactProject, artifactRegistry, containerName } = repoDescr
 
-await docker.validateCloudBuildBucket( artifactProject )
+if ( imageVersion === 'guide-me' ) {
+  await docker.validateCloudBuildBucket( artifactProject )
+}
 
 const registryFolder = `${artifactRegistry}/images/${containerName}`
 
@@ -42,6 +44,51 @@ const registryFolder = `${artifactRegistry}/images/${containerName}`
 log( chalk.green.bold( 'Updating dependencies and workspace...' ) )
 await shellCmd( 'npm install', { stdio : 'inherit' } )
 
+if ( imageVersion === 'guide-me' ) {
+  await docker.repoCleanup() // adjusts gitignore files and removes cruft
+  /* eslint-disable max-len */
+  log( `
+
+
+  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:
+
+  ${chalk.yellow.bold( `serviceConfig:
+    VERSION: v1.2.3
+    PREEMPTIBLE: true` )}
+
+  are pre-ignition era charts and should be replaced with the latest helm chart
+  templates available from ignition. Either dive in or ask devops for a hand
+  when converting these legacy / deprecated charts.
+
+
+  More recently updated helm charts that have already started the migration to
+  the new approach may already have registry entries like this:
+
+  ${chalk.yellow.bold( `image:
+    registry: gcr.io/leverege-docker-images
+    tag: ""` )}
+
+  The above registry statement references the deprecated container registry and
+  must be adjusted accordingly to resemble:
+
+    ${chalk.green.bold( 'registry: us-docker.pkg.dev/leverege-registry/<registry folder>/images' )}
+
+  There may also be a corresponding modification needed in the helm template
+  deployment.yaml file in the container image spec:
+
+    ${chalk.green.bold( 'image: {{ .Values.image.registry }}/{{ .Chart.Name }}:{{ default .Chart.AppVersion .Values.image.tag }}' )}
+
+
+  ${chalk.magenta.bold( `Upgrading all service charts to the latest ignition template chart structure
+  is the preferred approach to making the transition to the artifact registry.` )}
+
+  ` )
+  log( chalk.green.bold( '*** docker-to-registry guidance complete - ready for dockerization ***' ) )
+  process.exit( 0 )
+}
+
 // Give the summary and the user a chance to proceed or not
 log( `
   ${chalk.green.bold( 'Build Information:' )}