@toa.io/operations 0.8.0-dev.0 → 0.8.0-dev.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/operations",
-  "version": "0.8.0-dev.0",
+  "version": "0.8.0-dev.4",
   "description": "Toa Deployment",
   "homepage": "https://toa.io",
   "author": {
@@ -26,10 +26,10 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@toa.io/filesystem": "1.1.0-dev.2",
-    "@toa.io/generic": "0.11.0-dev.16",
-    "@toa.io/yaml": "0.7.6-dev.16",
+    "@toa.io/filesystem": "1.1.0-dev.4",
+    "@toa.io/generic": "0.11.0-dev.3",
+    "@toa.io/yaml": "0.8.0-dev.4",
     "execa": "5.1.1"
   },
-  "gitHead": "669be360acebac4dbe49735ec506127d9d0a05e3"
+  "gitHead": "24d68d70a56717f2f4441cc9884a60f9fee0863e"
 }

package/readme.md

@@ -0,0 +1,30 @@
+# Toa Operations
+
+## Context
+
+### Container Registry
+
+#### Build Options
+
+```yaml
+# context.toa.yaml
+
+registry:
+  build:
+    arguments: [NPM_TOKEN]
+    run: echo //npm.pkg.github.com/:_authToken=${NPM_TOKEN} > .npmrc
+```
+
+`arguments` is a list of environemt varialbes to be passed to `docker build`.
+
+`run` is a command(s) to be executed during build. Multiline is supported.
+
+```yaml
+# context.toa.yaml
+
+registry:
+  build:
+    run: |
+      echo test > .test
+      rm .test
+```

package/src/deployment/factory.js

@@ -34,7 +34,7 @@ class Factory {
     this.#context = context
     this.#process = new Process()
 
-    const imagesFactory = new ImagesFactory(context.name, context.runtime)
+    const imagesFactory = new ImagesFactory(context.name, context.runtime, context.registry)
 
     this.#registry = new Registry(context.registry, imagesFactory, this.#process)
     this.#compositions = context.compositions.map((composition) => this.#composition(composition))

package/src/deployment/images/composition.Dockerfile

@@ -1,9 +1,11 @@
 FROM node:18.16.0-alpine3.17
 
+{{build.arguments}}
+
 ENV NODE_ENV=production
-RUN if [ {{registry}} != undefined ]; then npm set registry {{registry}}; fi
-RUN if [ {{proxy}} != undefined ]; then npm set proxy {{proxy}}; fi
-RUN npm i -g @toa.io/runtime@{{version}}
+RUN if [ {{runtime.registry}} != undefined ]; then npm set registry {{runtime.registry}}; fi
+RUN if [ {{runtime.proxy}} != undefined ]; then npm set proxy {{runtime.proxy}}; fi
+RUN npm i -g @toa.io/runtime@{{runtime.version}}
 
 WORKDIR /composition
 ADD . .
@@ -11,4 +13,6 @@ ADD . .
 # run 'npm i' in each component
 RUN find . -maxdepth 1 -type d \( ! -name . \) -exec /bin/sh -c "cd '{}' && if [ -f package.json ]; then npm i; fi" \;
 
+{{build.run}}
+
 CMD toa compose *

package/src/deployment/images/composition.js

@@ -11,16 +11,18 @@ class Composition extends Image {
 
   /** @type {string} */
   #name
+
   /** @type {toa.norm.Component[]} */
   #components
 
   /**
-   * @param scope {string}
-   * @param runtime {toa.norm.context.Runtime}
-   * @param composition {toa.norm.context.Composition}
+   * @param {string} scope
+   * @param {toa.norm.context.Runtime} runtime
+   * @param {toa.norm.context.Registry} registry
+   * @param {toa.norm.context.Composition} composition
    */
-  constructor (scope, runtime, composition) {
-    super(scope, runtime)
+  constructor (scope, runtime, registry, composition) {
+    super(scope, runtime, registry)
 
     this.#name = composition.name
     this.#components = composition.components

package/src/deployment/images/factory.js

@@ -9,30 +9,44 @@ const { Service } = require('./service')
 class Factory {
   /** @type {string} */
   #scope
+
   /** @type {toa.norm.context.Runtime} */
   #runtime
 
+  /** @type {toa.norm.context.Registry} */
+  #registry
+
   /**
-   * @param scope {string}
-   * @param runtime {toa.norm.context.Runtime}
+   * @param {string} scope
+   * @param {toa.norm.context.Runtime} runtime
+   * @param {toa.norm.context.Registry} registry
    */
-  constructor (scope, runtime) {
+  constructor (scope, runtime, registry) {
     this.#scope = scope
     this.#runtime = runtime
+    this.#registry = registry
   }
 
   /**
    * @returns {Composition}
    */
   composition (composition) {
-    return new Composition(this.#scope, this.#runtime, composition)
+    const instance = new Composition(this.#scope, this.#runtime, this.#registry, composition)
+
+    instance.tag()
+
+    return instance
   }
 
   /**
    * @returns {Service}
    */
   service (path, service) {
-    return new Service(this.#scope, this.#runtime, path, service)
+    const instance = new Service(this.#scope, this.#runtime, this.#registry, path, service)
+
+    instance.tag()
+
+    return instance
   }
 }
 

package/src/deployment/images/image.fixtures.js

@@ -25,9 +25,15 @@ const runtime = {
   version: generate()
 }
 
+/** @type {toa.norm.context.Registry} */
+const registry = {
+  base: generate()
+}
+
 exports.scope = generate()
 exports.name = name
 exports.version = hash(runtime.version + ';' + version)
 exports.Class = Class
 exports.runtime = runtime
+exports.registry = registry
 exports.process = process

package/src/deployment/images/image.js

@@ -3,7 +3,7 @@
 const { join, posix } = require('node:path')
 const { readFile: read, writeFile: write } = require('node:fs/promises')
 
-const { hash } = require('@toa.io/generic')
+const { hash, overwrite } = require('@toa.io/generic')
 const { directory } = require('@toa.io/filesystem')
 
 /**
@@ -22,19 +22,37 @@ class Image {
 
   /** @type {string} */
   #scope
+
+  /** @type {toa.norm.context.Registry} */
+  #registry
+
   /** @type {toa.norm.context.Runtime} */
   #runtime
+
   /** @type {string} */
   #type
 
+  /** @type {{ runtime?: Partial<toa.norm.context.Runtime>, build: object }} */
+  #values = { build: { command: 'echo hello' } }
+
   /**
-   * @param scope {string}
-   * @param runtime {toa.norm.context.Runtime}
+   * @param {string} scope
+   * @param {toa.norm.context.Runtime} runtime
+   * @param {toa.norm.context.Registry} registry
    */
-  constructor (scope, runtime) {
+  constructor (scope, runtime, registry) {
     this.#scope = scope
+    this.#registry = registry
     this.#runtime = runtime
     this.#type = this.constructor.name.toLowerCase()
+
+    this.#setValues()
+  }
+
+  tag () {
+    const tag = hash(this.#runtime?.version + ';' + this.version)
+
+    this.reference = posix.join(this.#registry.base ?? '', this.#scope, `${this.#type}-${this.name}:${tag}`)
   }
 
   /**
@@ -51,12 +69,6 @@ class Image {
    */
   get version () {}
 
-  tag (base) {
-    const tag = hash(this.#runtime?.version + ';' + this.version)
-
-    this.reference = posix.join(base ?? '', this.#scope, `${this.#type}-${this.name}:${tag}`)
-  }
-
   async prepare (root) {
     if (this.dockerfile === undefined) throw new Error('Dockerfile isn\'t specified')
 
@@ -65,7 +77,7 @@ class Image {
     await directory.ensure(path)
 
     const template = await read(this.dockerfile, 'utf-8')
-    const contents = template.replace(/{{(\.?\w+)}}/g, (_, key) => this.#value(key))
+    const contents = template.replace(/{{(\S{1,32})}}/g, (_, key) => this.#value(key))
     const ignore = 'Dockerfile'
 
     await write(join(path, 'Dockerfile'), contents)
@@ -76,16 +88,44 @@ class Image {
     return path
   }
 
+  #setValues () {
+    this.#values.runtime = this.#runtime
+    this.#values.build = overwrite(this.#values.build, this.#registry.build)
+
+    if (this.#values.build.arguments !== undefined) this.#values.build.arguments = createArguments(this.#values.build.arguments)
+    if (this.#values.build.run !== undefined) this.#values.build.run = createRunCommands(this.#values.build.run)
+  }
+
   /**
    * @param key {string}
    * @returns {string}
    */
   #value (key) {
-    const [, property] = key.split('.')
+    const [source, property] = key.split('.')
+
+    return this.#values[source]?.[property] ?? ''
+  }
+}
 
-    if (property !== undefined) return this[property]
-    else return this.#runtime[key]
+function createRunCommands (input) {
+  const lines = input.split('\n')
+
+  return lines.reduce((commands, command) => {
+    commands += '\nRUN ' + command
+
+    return commands
+  }, '')
+}
+
+function createArguments (variables) {
+  const args = []
+
+  for (const variable of variables) {
+    args.push('ARG ' + variable)
+    args.push(`ENV ${variable}=$${variable}`)
   }
+
+  return args.join('\n')
 }
 
 exports.Image = Image

package/src/deployment/images/image.test.js

@@ -7,15 +7,13 @@ const { generate } = require('randomstring')
 let instance
 
 beforeEach(() => {
-  instance = new fixtures.Class(fixtures.scope, fixtures.runtime)
+  instance = new fixtures.Class(fixtures.scope, fixtures.runtime, fixtures.registry)
 })
 
 it('should assign url', () => {
-  const registry = generate()
+  instance.tag()
 
-  instance.tag(registry)
-
-  expect(instance.reference).toEqual(`${registry}/${fixtures.scope}/class-${fixtures.name}:${fixtures.version}`)
+  expect(instance.reference).toEqual(`${fixtures.registry.base}/${fixtures.scope}/class-${fixtures.name}:${fixtures.version}`)
 })
 
 describe('prepare', () => {

package/src/deployment/images/service.Dockerfile

@@ -1,9 +1,9 @@
 FROM node:18.16.0-alpine3.17
 
 ENV NODE_ENV=production
-RUN if [ {{registry}} != undefined ]; then npm set registry {{registry}}; fi
-RUN if [ {{proxy}} != undefined ]; then npm set proxy {{proxy}}; fi
-RUN npm i -g @toa.io/runtime@{{version}}
+RUN if [ {{runtime.registry}} != undefined ]; then npm set registry {{runtime.registry}}; fi
+RUN if [ {{runtime.proxy}} != undefined ]; then npm set proxy {{runtime.proxy}}; fi
+RUN npm i -g @toa.io/runtime@{{runtime.version}}
 
 WORKDIR /service
 ADD . .

package/src/deployment/images/service.js

@@ -28,11 +28,12 @@ class Service extends Image {
   /**
    * @param {string} scope
    * @param {toa.norm.context.Runtime} runtime
+   * @param {toa.norm.context.Registry} registry
    * @param {string} reference
    * @param {toa.deployment.dependency.Service} service
    */
-  constructor (scope, runtime, reference, service) {
-    super(scope, runtime)
+  constructor (scope, runtime, registry, reference, service) {
+    super(scope, runtime, registry)
 
     this.service = service.name
 

package/src/deployment/registry.js

@@ -65,7 +65,6 @@ class Registry {
   #create (type, ...args) {
     const image = this.#factory[type](...args)
 
-    image.tag(this.#registry?.base)
     this.#images.push(image)
 
     return image
@@ -85,6 +84,10 @@ class Registry {
 
     const multiarch = this.#registry.platforms !== null
 
+    if (this.#registry.build?.arguments !== undefined) {
+      for (const arg of this.#registry.build.arguments) args.push('--build-arg', `${arg}=${process.env[arg]}`)
+    }
+
     if (multiarch) {
       const platform = this.#registry.platforms.join(',')
 

package/types/deployment/images/image.d.ts

@@ -1,13 +1,13 @@
 declare namespace toa.deployment.images {
 
-    export interface Image {
-        readonly reference: string
-        readonly context: string
+  export interface Image {
+    readonly reference: string
+    readonly context: string
 
-        tag(base: string): void
+    tag(): void
 
-        prepare(root: string): Promise<string>
-    }
+    prepare(root: string): Promise<string>
+  }
 
 }
 

package/types/deployment/registry.d.ts

@@ -3,7 +3,7 @@ import type * as _dependency from './dependency'
 import type * as _image from "./images/image"
 
 declare namespace toa.deployment {
-
+  
   interface Registry {
     composition(composition: _norm.Composition): _image.Image