@leverege/build-tools 2.93.5 → 2.93.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.93.5",
+  "version": "2.93.7",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -82,7 +82,7 @@
     "glob": "^13.0.0",
     "handlebars": "^4.7.8",
     "ignore": "^7.0.5",
-    "inquirer": "^12.11.1",
+    "inquirer": "^13.1.0",
     "js-yaml": "^4.1.1",
     "jsdoc": "^4.0.5",
     "ms": "^2.1.3",
@@ -105,4 +105,4 @@
     "mocha": "^11.7.5",
     "npm": "^11.7.0"
   }
-}
+}

package/src/Docker.mjs

@@ -17,8 +17,14 @@ import {
 
 const DIRNAME = path.dirname( url.fileURLToPath( import.meta.url ) )
 
-// TODO: change default to node 22 (jod) after 01/01/25
-const dockerfileNodeVersion = 'jod-alpine'
+// TODO: This is a temporary band-aid while we assess the impact of the yarn
+// and/or CI pipeline transition. This will at least allow us to lock down the
+// specific versions of node/npm and facilitate testing via the env vars.
+//
+// See the latest docker images here => https://hub.docker.com/_/node
+//
+const dockerfileNodeVersion = process.env.DOCKER_BUILD_NODE_VERSION || '24.12.0-alpine3.23'
+const dockerfileNpmVersion = process.env.DOCKER_BUILD_NPM_VERSION || '11.6.0'
 
 // 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
@@ -55,7 +61,7 @@ const defaultSettings = {
   nodeimage : 'jod-alpine',
   imageBase : 'node:jod-alpine',
   npmlogging : process.env.VERBOSE_NPM_LOGGING ? '--ddd' : '--silent',
-  npmVersion : 'npm@11',
+  npmVersion : `npm@${dockerfileNpmVersion}`,
   pluginfile : '# NO PLUGIN',
   preInstallPluginfile : '# NO PRE-INSTALL PLUGIN',
   regvers : 'package.version',

package/src/Utils.mjs

@@ -493,7 +493,7 @@ export const parseHelmChart = async ( helmroot = './helm' ) => {
   
   // See if this is a leaf chart and whether or not dependencies need updating
   const hasDependencies = chartYaml.dependencies !== undefined
-  let depsOutOfSync
+  let depsOutOfSync = hasDependencies // assume unsynced if dependencies
   if ( chartFiles.includes( 'Chart.lock' ) ) {
     const chartLock = YAML.load( fs.readFileSync( `${helmroot}/Chart.lock`, 'utf8' ) )
     // Using Object.fromEntries will be able to handle multiple dependencies if ever needed

package/src/artifacts/ArtifactPusher.mjs

@@ -1,11 +1,15 @@
 import path from 'node:path'
+import fs from 'node:fs'
 
 import { shellCmd, log, err, debug } from '../Utils.mjs'
 
 import {
   parseGenericArtifactFileToRemoteRelativePath,
   parseGenericArtifactSchemaToRemoteRelativePath,
-  listGenericArtifactFiles
+  listGenericArtifactFiles,
+  shouldUseIgnoreConfiguration,
+  findIgnoreFilePath,
+  copyFilesWithIgnoreConfiguration
 } from './Utils.mjs'
 
 class ArtifactPusher {
@@ -29,8 +33,12 @@ class GenericArtifactPusher extends ArtifactPusher {
       return false
     }
 
-    try {
-   
+    if ( !this.artifact.local_path && !this.artifact.local_file_path ) {
+      err( 'Local path or local file path is required for pushing artifacts' )
+      return false
+    }
+
+    try {   
       let command = ''
 
       command = `gcloud artifacts generic upload \
@@ -40,8 +48,25 @@ class GenericArtifactPusher extends ArtifactPusher {
       --package=${this.artifact.package} \
       --version=${this.artifact.version}`
 
+      let pathToDelete
+
       if ( this.artifact.local_path ) {
-        const localPath = path.join( this.path, this.artifact.local_path )
+        const originalLocalPath = path.join( this.path, this.artifact.local_path )
+
+        let localPath = originalLocalPath
+
+        const useIgnoreConfiguration = await shouldUseIgnoreConfiguration()
+
+        if ( useIgnoreConfiguration ) {
+          const ignoreFilePath = await findIgnoreFilePath( this.path )
+          if ( ignoreFilePath ) {
+            const tmpLocalPath = path.join( '/', 'tmp', `${this.artifact.project}_${this.artifact.location}_${this.artifact.repository}_${this.artifact.package}_${this.artifact.version}` )
+            localPath = tmpLocalPath
+            pathToDelete = tmpLocalPath
+            await copyFilesWithIgnoreConfiguration( originalLocalPath, tmpLocalPath, ignoreFilePath )
+          }
+        }
+
         command += ` --source-directory=${localPath}`
         command += ' --skip-existing'
       } else if ( this.artifact.local_file_path ) {
@@ -66,7 +91,11 @@ class GenericArtifactPusher extends ArtifactPusher {
       debug( { command }, '<==Upload Command' )
         
       await shellCmd( command )
-      
+
+      if ( pathToDelete ) {
+        await fs.promises.rm( pathToDelete, { recursive : true } )
+      }
+
       log( `Successfully pushed artifact: ${this.artifact.name}` )
 
       return true

package/src/artifacts/Utils.mjs

@@ -8,7 +8,7 @@ import { parseYamlFile, err, warning, debug, shellCmd } from '../Utils.mjs'
 
 import { ArtifactTypeEnum, ArtifactsSchema, GenericArtifactSchema } from './Structs.mjs'
 
-const getArtifactsSchema = async ( artifactsFilePath = './artifacts.yml' ) => {
+const getArtifactsSchema = async ( artifactsFilePath = './artifacts.yaml' ) => {
   const artifactsConfig = await parseYamlFile( artifactsFilePath )
   const [ error, result ] = validate( artifactsConfig, ArtifactsSchema )
   if ( error ) {
@@ -163,7 +163,6 @@ const calculateHash = async ( path ) => {
     hash.update( await fs.promises.readFile( path ) )
     return `${hash.digest( 'base64url' )}=`
   } catch ( error ) {
-    console.error( error )
     throw new Error( `Failed to calculate hash for artifact ${path}: ${error.message}` )
   }
 }
@@ -186,7 +185,7 @@ const listGenericArtifactFiles = async ( artifact ) => {
   return files
 }
 
-const checkGenericArtifactMatch = async ( genericArtifactFiles, genericArtifactSchemaPath, genericArtifactSchema ) => {
+const getMissingRemoteFiles = async ( genericArtifactFiles, genericArtifactSchemaPath, genericArtifactSchema ) => {
   
   const expectedRemoteRelativePath = parseGenericArtifactSchemaToRemoteRelativePath( genericArtifactSchema )
   const localRelativePath = parseGenericArtifactSchemaToLocalRelativePath( genericArtifactSchema )
@@ -221,8 +220,47 @@ const checkGenericArtifactMatch = async ( genericArtifactFiles, genericArtifactS
   const actualArray = Array.from( actualFiles )
   const expectedArray = Array.from( expectedFiles )
 
-  return actualArray.length === expectedArray.length && 
-    expectedArray.every( expected => actualArray.some( actual => actual.remoteFilePath === expected.remoteFilePath && actual.remoteFileHash === expected.remoteFileHash ) )
+  return expectedArray.filter( expected => !actualArray.some( actual => actual.remoteFilePath === expected.remoteFilePath && actual.remoteFileHash === expected.remoteFileHash ) )
+}
+
+const shouldUseIgnoreConfiguration = async () => {
+  let result
+  try {
+    result = await shellCmd( 'gcloud config get-value gcloudignore/enabled' )
+    if ( result.trim() === '' || result.includes( 'has no property' ) ) {
+      return false
+    }
+    return result.trim() === 'true'
+  } catch ( error ) {
+    if ( error.message && error.message.includes( 'Section [gcloudignore] has no property [enabled]' ) ) {
+      return false
+    }
+    // Re-throw other errors
+    throw error
+  }
+}
+
+const findIgnoreFilePath = async ( relativePath ) => {
+  if ( relativePath ) {
+    const ignoreFilePath = path.join( relativePath, '.gcloudignore' )
+    if ( fs.existsSync( ignoreFilePath ) ) {
+      return ignoreFilePath
+    }
+  }
+
+  const ignoreFilePath = path.join( process.cwd(), '.gcloudignore' )
+  if ( fs.existsSync( ignoreFilePath ) ) {
+    return ignoreFilePath
+  }
+
+  return null
+}
+
+const copyFilesWithIgnoreConfiguration = async ( sourcePath, destinationPath, ignoreFilePath ) => {
+  // Ensure sourcePath ends with / so rsync copies contents (not the folder itself) and exclude patterns work correctly
+  const normalizedSourcePath = sourcePath.endsWith( '/' ) ? sourcePath : `${sourcePath}/`
+  const command = `rsync -av --delete --exclude-from='${ignoreFilePath}' ${normalizedSourcePath} ${destinationPath}`
+  await shellCmd( command )
 }
 
 export {
@@ -232,7 +270,12 @@ export {
   parseGenericArtifactFileToRemoteRelativePath,
   parseGenericArtifactSchemaToRemoteRelativePath,
   parseGenericArtifactSchemaToLocalRelativePath,
+  parseGenericArtifactSchemaToArtifactNameBase,
+  parseGenericArtifactSchemaToArtifactNameFile,
   parseGenericArtifactSchemaToArtifactName,
-  checkGenericArtifactMatch,
-  listGenericArtifactFiles
+  getMissingRemoteFiles,
+  listGenericArtifactFiles,
+  shouldUseIgnoreConfiguration,
+  findIgnoreFilePath,
+  copyFilesWithIgnoreConfiguration
 }

package/src/artifacts/pull-artifact.mjs

@@ -13,12 +13,8 @@ import { GenericArtifactPuller } from './ArtifactPuller.mjs'
 program
   .name( 'pull-artifact' )
   .description( 'Pull artifacts from GCP Artifact Registry' )
-  .requiredOption( '-f, --file-path <path>', 'Path to artifacts.yaml file' )
-  .requiredOption( '-p, --project <project>', 'GCP project id' )
-  .requiredOption( '-l, --location <location>', 'GCP location' )
-  .requiredOption( '-r, --repository <repository>', 'GCP artifact registry repository' )
-  .requiredOption( '-n  --package <name>', 'GCP artifact registry package name' )
-  .requiredOption( '-v, --version <version>', 'GCP artifact registry package version' )
+  .option( '-f, --file-path <file-path>', 'Path to artifacts.yaml file', './artifacts.yaml' )
+  .option( '-a, --artifact-path <artifact-path>', 'GCP artifact path' )
   .parse()
 
 const options = program.opts()
@@ -26,13 +22,26 @@ const options = program.opts()
 async function main() {
   const artifactsSchema = await getArtifactsSchema( options.filePath )
   const flattenedArtifactsSchema = flattenArtifactsSchema( artifactsSchema )
-  
-  const filteredArtifactsSchema = flattenedArtifactsSchema.filter(
-    artifact => artifact.project === options.project &&
-    artifact.location === options.location &&
-    artifact.repository === options.repository &&
-    artifact.package === options.package &&
-    artifact.version === options.version )
+
+  let filteredArtifactsSchema = flattenedArtifactsSchema
+
+  if ( options.artifactPath ) {
+    const artifactPathElements = options.artifactPath.split( '/' )
+
+    if ( artifactPathElements.length !== 5 ) {
+      warning( 'Invalid artifact path, it must be in the format <project>/<location>/<repository>/<package>/<version>' )
+      return false
+    }
+
+    const [ project, location, repository, packageName, version ] = artifactPathElements
+
+    filteredArtifactsSchema = flattenedArtifactsSchema.filter(
+      artifact => artifact.project === project &&
+      artifact.location === location &&
+      artifact.repository === repository &&
+      artifact.package === packageName &&
+      artifact.version === version )
+  }
 
   let counter = 0
 
@@ -65,6 +74,8 @@ async function main() {
   counter = pullResults.filter( Boolean ).length
 
   log( `Successfully pulled ${counter}/${filteredArtifactsSchema.length} artifacts` )
+
+  return counter === filteredArtifactsSchema.length
 }
 
 main()

package/src/artifacts/push-artifact.mjs

@@ -13,12 +13,8 @@ import { GenericArtifactPusher } from './ArtifactPusher.mjs'
 program
   .name( 'push-artifact' )
   .description( 'Push artifacts to GCP Artifact Registry' )
-  .requiredOption( '-f, --file-path <path>', 'Path to artifacts.yaml file' )
-  .requiredOption( '-p, --project <project>', 'GCP project id' )
-  .requiredOption( '-l, --location <location>', 'GCP location' )
-  .requiredOption( '-r, --repository <repository>', 'GCP artifact registry repository' )
-  .requiredOption( '-n  --package <name>', 'GCP artifact registry package name' )
-  .requiredOption( '-v, --version <version>', 'GCP artifact registry package version' )
+  .option( '-f, --file-path <file-path>', 'Path to artifacts.yaml file', './artifacts.yaml' )
+  .option( '-a, --artifact-path <artifact-path>', 'GCP artifact path' )
   .parse()
 
 const options = program.opts()
@@ -26,13 +22,25 @@ const options = program.opts()
 async function main() {
   const artifactsSchema = await getArtifactsSchema( options.filePath )
   const flattenedArtifactsSchema = flattenArtifactsSchema( artifactsSchema )
-  
-  const filteredArtifactsSchema = flattenedArtifactsSchema.filter(
-    artifact => artifact.project === options.project &&
-    artifact.location === options.location &&
-    artifact.repository === options.repository &&
-    artifact.package === options.package &&
-    artifact.version === options.version )
+
+  let filteredArtifactsSchema = flattenedArtifactsSchema
+
+  if ( options.artifactPath ) {
+    const artifactPathElements = options.artifactPath.split( '/' )
+    if ( artifactPathElements.length !== 5 ) {
+      warning( 'Invalid artifact path, it must be in the format <project>/<location>/<repository>/<package>/<version>' )
+      return false
+    }
+
+    const [ project, location, repository, packageName, version ] = artifactPathElements
+
+    filteredArtifactsSchema = flattenedArtifactsSchema.filter(
+      artifact => artifact.project === project &&
+      artifact.location === location &&
+      artifact.repository === repository &&
+      artifact.package === packageName &&
+      artifact.version === version )
+  }
 
   let counter = 0
 
@@ -65,6 +73,8 @@ async function main() {
   counter = pushResults.filter( Boolean ).length
 
   log( `Successfully pushed ${counter}/${filteredArtifactsSchema.length} artifacts` )
+  
+  return counter === filteredArtifactsSchema.length
 }
 
 main()

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

@@ -8,14 +8,14 @@ showInstalling "The Prometheus Operator (kube-prometheus-stack)"
 
 # https://artifacthub.io/packages/helm/prometheus-community/kube-prometheus-stack
 OCI_CHART="oci://ghcr.io/prometheus-community/charts/kube-prometheus-stack"
-[ -z "$PROMETHEUS_STACK_CHART_VERSION" ] && PROMETHEUS_STACK_CHART_VERSION="80.2.0"
+[ -z "$PROMETHEUS_STACK_CHART_VERSION" ] && PROMETHEUS_STACK_CHART_VERSION="80.4.1"
 helm upgrade $NS --install prometheus-stack $OCI_CHART \
                  --values  prom-operator/prometheus-stack.yaml \
                  --version $PROMETHEUS_STACK_CHART_VERSION $HELM_WHAT
 
 # https://artifacthub.io/packages/helm/prometheus-community/prometheus-elasticsearch-exporter
 showInstalling "The Elasticsearch Exporter (prom-operator ES metrics exports)"
-[ -z "$ELASTICSEARCH_EXPORTER_CHART_VERSION" ] && ELASTICSEARCH_EXPORTER_CHART_VERSION="7.2.0"
+[ -z "$ELASTICSEARCH_EXPORTER_CHART_VERSION" ] && ELASTICSEARCH_EXPORTER_CHART_VERSION="7.2.1"
 OCI_CHART="oci://ghcr.io/prometheus-community/charts/prometheus-elasticsearch-exporter"
 helm upgrade $NS --install elasticsearch8-exporter $OCI_CHART \
                  --values prom-operator/elasticsearch-exporter.yaml \

package/.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-    "editor.formatOnSave": true
-}