@leverege/build-tools 2.93.0-beta.8 → 2.93.0-pedro.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.93.0-beta.8",
+  "version": "2.93.0-pedro.1",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -50,13 +50,12 @@
     "npm-link": "src/npm-link.sh",
     "npm-unlink": "src/npm-unlink.sh",
     "overwhelm": "src/overwhelm.mjs",
+    "package-artifact": "src/package-artifact/command.mjs",
     "pkgck": "src/pkgck.sh",
     "pkglint": "src/pkglint.sh",
     "prepack": "src/prepack.mjs",
     "prune-git": "src/prune-git.sh",
-    "pull-artifact": "src/artifacts/pull-artifact.mjs",
     "pull-git": "src/pull-git.sh",
-    "push-artifact": "src/artifacts/push-artifact.mjs",
     "push-my-chart": "src/push-my-chart.mjs",
     "refresh-npm-token": "src/refresh-npm-token.mjs",
     "refresh-py-idx": "src/refresh-py-idx.sh",

package/src/{artifacts/ArtifactPusher.mjs → package-artifact/Packager.mjs}

@@ -1,7 +1,7 @@
 import crypto from 'crypto'
 import fs from 'fs'
 
-class ArtifactPusher {
+class ArtifactPackager {
   constructor( artifact ) {
     this.artifact = artifact
   }
@@ -12,7 +12,6 @@ class ArtifactPusher {
       hash.update( fs.readFileSync( this.artifact.source_path ) )
       return hash.digest( 'base64url' )
     } catch ( error ) {
-      console.error( error )
       throw new Error( `Failed to calculate hash for artifact ${this.artifact.name}: ${error.message}` )
     }
   }
@@ -21,24 +20,27 @@ class ArtifactPusher {
     throw new Error( 'Not implemented' )
   }
 
-  async push() {
+  async build() {
     throw new Error( 'Not implemented' )
   }
-}
 
-class GenericArtifactPusher extends ArtifactPusher {
+  async publish() {
+    throw new Error( 'Not implemented' )
+  }
 
-  async exists() {
-    const isDirectory = fs.statSync( this.artifact.source_path ).isDirectory()
-    
-    // If source path is a directory, check whether the destination path alreadu exists in the registry
-    if ( isDirectory ) {
-      // For the time being, return false, and let gcloud skip existing files in upload-time.
-      // It's pretty slow, might be worth to break down the directory into individual artifacts
-      // and manage each one with its own pusher.
+  async package() {
+    if ( await this.exists() ) {
+      console.log( 'Artifact already exists in the registry' )
       return false
     }
+    await this.build()
+    return this.publish()
+  }
+}
+
+class GenericArtifactPackager extends ArtifactPackager {
 
+  async exists() {
     // Check if artifact already exists in the registry
     console.log( 'Checking if artifact already exists in the registry...' )
         
@@ -82,37 +84,22 @@ class GenericArtifactPusher extends ArtifactPusher {
       throw error
     }
   }
+
+  async build() {
+    return true
+  }
     
-  async push() {
+  async publish() {
     console.log( 'Publishing artifact to registry...' )
-
-    if ( await this.exists() ) {
-      console.log( 'Artifact already exists in the registry' )
-      return false
-    }
-
-    console.log( 'Uploading artifact to registry...' )
-   
-    let command = ''
-
-    command = `gcloud artifacts generic upload \
-      --project=${this.artifact.gcp_project_id} \
-      --location=${this.artifact.gcp_location} \
-      --repository=${this.artifact.gcp_artifact_registry_repository_name} \
-      --package=${this.artifact.gcp_artifact_registry_package_name} \
-      --version=${this.artifact.gcp_artifact_registry_package_version}`
-
-    const isDirectory = fs.statSync( this.artifact.source_path ).isDirectory()
-    if ( isDirectory ) {
-      command += ` --source-directory=${this.artifact.source_path}`
-      command += ' --skip-existing'
-    } else {
-      command += ` --source=${this.artifact.source_path}`
-    }
-
-    if ( this.artifact.destination_path ) {
-      command += ` --destination-path=${this.artifact.destination_path}`
-    }
+        
+    const command = `gcloud artifacts generic upload \
+        --project=${this.artifact.gcp_project_id} \
+        --location=${this.artifact.gcp_location} \
+        --repository=${this.artifact.gcp_artifact_registry_repository_name} \
+        --package=${this.artifact.gcp_artifact_registry_package_name} \
+        --version=${this.artifact.gcp_artifact_registry_package_version} \
+        --source=${this.artifact.source_path} \
+        --destination-path=${this.artifact.destination_path}`
     
     // console.log( 'Command:', command )
         
@@ -128,4 +115,4 @@ class GenericArtifactPusher extends ArtifactPusher {
   }
 }
 
-export { ArtifactPusher, GenericArtifactPusher }
+export { ArtifactPackager, GenericArtifactPackager }

package/src/{artifacts → package-artifact}/Structs.mjs

@@ -1,13 +1,11 @@
 import { assign, object, string, array, optional, enums, union } from 'superstruct'
 
-const ArtifactTypeEnum = {
-  GENERIC : 'generic',
-}
+const ArtifactTypeEnum = enums( [ 'generic' ] )
 
 // Superstruct schema for individual artifact configuration
-const PartialArtifactSchema = object( {
+const PartialArtifactEntrySchema = object( {
   name : string(),
-  type : optional( enums( Object.values( ArtifactTypeEnum ) ) ),
+  type : optional( ArtifactTypeEnum ),
   gcp_project_id : optional( string() ),
   gcp_location : optional( string() ),
   gcp_artifact_registry_repository_name : optional( string() ),
@@ -15,9 +13,9 @@ const PartialArtifactSchema = object( {
   gcp_artifact_registry_package_version : optional( string() )
 } )
 
-const ArtifactSchema = assign( PartialArtifactSchema, object( {
+const ArtifactEntrySchema = assign( PartialArtifactEntrySchema, object( {
   name : string(),
-  type : enums( Object.values( ArtifactTypeEnum ) ),
+  type : ArtifactTypeEnum,
   gcp_project_id : string(),
   gcp_location : string(),
   gcp_artifact_registry_repository_name : string(),
@@ -25,15 +23,15 @@ const ArtifactSchema = assign( PartialArtifactSchema, object( {
   gcp_artifact_registry_package_version : string()
 } ) )
 
-const PartialGenericArtifactSchema = assign( PartialArtifactSchema, object( {
-  type : enums( [ ArtifactTypeEnum.GENERIC ] ),
+const PartialGenericArtifactEntrySchema = assign( PartialArtifactEntrySchema, object( {
+  type : enums( [ 'generic' ] ),
   source_path : string(),
   destination_path : string()
 } ) )
 
-const GenericArtifactSchema = assign( ArtifactSchema, object( {
+const GenericArtifactEntrySchema = assign( ArtifactEntrySchema, object( {
   source_path : string(),
-  destination_path : optional( string() )
+  destination_path : string()
 } ) )
 
 // Superstruct schema for defaults configuration
@@ -46,18 +44,17 @@ const DefaultsSchema = object( {
 } )
 
 // Superstruct schema for the complete artifacts configuration with defaults
-const ArtifactsSchema = object( {
-  defaults : optional( DefaultsSchema ),
-  artifacts : array( union( [ PartialArtifactSchema, PartialGenericArtifactSchema ] ) )
+const ArtifactEntriesSchema = object( {
+  defaults : DefaultsSchema,
+  artifacts : array( union( [ PartialArtifactEntrySchema, PartialGenericArtifactEntrySchema ] ) )
 } )
 
-const FlattenedArtifactsSchema = array( assign( union( [ ArtifactSchema, GenericArtifactSchema ] ) ) )
+const FlattenedArtifactEntriesSchema = array( assign( union( [ ArtifactEntrySchema, GenericArtifactEntrySchema ] ) ) )
 
 export {
-  ArtifactTypeEnum,
-  ArtifactsSchema,
-  FlattenedArtifactsSchema,
-  ArtifactSchema,
+  ArtifactEntriesSchema,
+  FlattenedArtifactEntriesSchema,
+  ArtifactEntrySchema,
   DefaultsSchema,
-  GenericArtifactSchema,
+  GenericArtifactEntrySchema,
 }

package/src/{artifacts → package-artifact}/Utils.mjs

@@ -2,18 +2,18 @@ import { validate } from 'superstruct'
 
 import { parseYamlFile, warning } from '../Utils.mjs'
 
-import { ArtifactTypeEnum, ArtifactsSchema, GenericArtifactSchema } from './Structs.mjs'
+import { ArtifactEntriesSchema, GenericArtifactEntrySchema } from './Structs.mjs'
 
-const getArtifactsSchema = async ( artifactsFilePath = './artifacts.yml' ) => {
-  const artifactsConfig = await parseYamlFile( artifactsFilePath )
-  const [ error, result ] = validate( artifactsConfig, ArtifactsSchema )
+const getArtifactEntriesSchema = async ( artifactsConfigPath = './artifacts.yml' ) => {
+  const artifactsConfig = await parseYamlFile( artifactsConfigPath )
+  const [ error, result ] = validate( artifactsConfig, ArtifactEntriesSchema )
   if ( error ) {
     throw new Error( `Invalid artifacts.yml file: ${error.message}` )
   }
   return result
 }
 
-const flattenArtifactsSchema = ( artifactsSchema ) => {
+const flattenArtifactEntriesSchema = ( artifactsSchema ) => {
   return artifactsSchema.artifacts.reduce( ( flattenedArtifacts, artifact ) => {
     const mergedArtifact = {
       ...artifactsSchema.defaults,
@@ -22,8 +22,8 @@ const flattenArtifactsSchema = ( artifactsSchema ) => {
     
     let schema
     switch ( mergedArtifact.type ) {
-      case ArtifactTypeEnum.GENERIC:
-        schema = GenericArtifactSchema
+      case 'generic':
+        schema = GenericArtifactEntrySchema
         break
       default:
         warning( `Unsupported artifact type "${mergedArtifact.type}"` )
@@ -46,4 +46,4 @@ const flattenArtifactsSchema = ( artifactsSchema ) => {
   }, [] )
 }
 
-export { getArtifactsSchema, flattenArtifactsSchema }
+export { getArtifactEntriesSchema, flattenArtifactEntriesSchema }

package/src/{artifacts/push-artifact.mjs → package-artifact/command.mjs}

@@ -1,10 +1,7 @@
-#!/usr/bin/env node
-
 import { warning } from '../Utils.mjs'
 
-import { getArtifactsSchema, flattenArtifactsSchema } from './Utils.mjs'
-import { ArtifactTypeEnum } from './Structs.mjs'
-import { GenericArtifactPusher } from './ArtifactPusher.mjs'
+import { getArtifactEntriesSchema, flattenArtifactEntriesSchema } from './Utils.mjs'
+import { GenericArtifactEntryPackager } from './Packager.mjs'
 
 async function main() {
 
@@ -14,8 +11,8 @@ async function main() {
   const artifactPackageVersion = process.argv[4]
 
   if ( artifactsYmlPath ) {
-    const artifactsSchema = await getArtifactsSchema( artifactsYmlPath )
-    const flattenedArtifactsSchema = flattenArtifactsSchema( artifactsSchema )
+    const artifactsSchema = await getArtifactEntriesSchema( artifactsYmlPath )
+    const flattenedArtifactsSchema = flattenArtifactEntriesSchema( artifactsSchema )
     
     // Open for unexpected matches if we end up re-using the same package name and version for
     // multiple artifacts spread across multiple repositories and/or projects.
@@ -24,16 +21,14 @@ async function main() {
       artifact.gcp_artifact_registry_package_version === artifactPackageVersion )
     
     if ( filteredArtifactSchemas.length === 0 ) {
-      console.error( `No artifacts found for ${artifactPackageName} version ${artifactPackageVersion} in ${artifactsYmlPath}` )
+      console.error( `No artifact entries found for ${artifactPackageName} version ${artifactPackageVersion} in ${artifactsYmlPath}` )
       process.exit( 1 )
     }
-
-    // TODO: Use concurrency to package artifacts and provide summary of results.
     for ( const artifactSchema of filteredArtifactSchemas ) {
       let packager
       switch ( artifactSchema.type ) {
-        case ArtifactTypeEnum.GENERIC:
-          packager = new GenericArtifactPusher( artifactSchema )
+        case 'generic':
+          packager = new GenericArtifactEntryPackager( artifactSchema )
           break
         default:
           warning( `Unsupported artifact type "${artifactSchema.type}"` )

package/src/artifacts/ArtifactPuller.mjs

@@ -1,21 +0,0 @@
-import crypto from 'crypto'
-import fs from 'fs'
-
-class ArtifactPusher {
-  constructor( artifact ) {
-    this.artifact = artifact
-  }
-
-  async pull() {
-    throw new Error( 'Not implemented' )
-  }
-}
-
-class GenericArtifactPusher extends ArtifactPusher {
-
-  async pull() {
-    throw new Error( 'Not implemented' )
-  }
-}
-
-export { ArtifactPusher, GenericArtifactPusher }

package/src/artifacts/pull-artifact.mjs

@@ -1,7 +0,0 @@
-#!/usr/bin/env node
-
-async function main() {
-  return null
-}
-
-main()