@toa.io/operations 1.0.0-alpha.31 → 1.0.0-alpha.310

package/src/process.test.js

@@ -0,0 +1,33 @@
+import { it, describe } from 'node:test'
+import assert from 'node:assert/strict'
+
+import { Process } from './process.js'
+
+describe('execute', () => {
+  it('should answer what the command wrote', async () => {
+    const output = await new Process().execute(
+      'node',
+      ['-e', 'process.stdout.write("ok")'],
+      { silently: true }
+    )
+
+    assert.strictEqual(output, 'ok')
+  })
+
+  it('should reject what the command failed at, with what it wrote', async () => {
+    await assert.rejects(
+      new Process().execute(
+        'node',
+        ['-e', 'process.stderr.write("broken"); process.exit(2)'],
+        { silently: true }
+      ),
+      (error) => /exit code 2: node/.test(error.message) && /broken/.test(error.message)
+    )
+  })
+
+  it('should reject a command that does not exist', async () => {
+    await assert.rejects(
+      new Process().execute('toa-no-such-command', [], { silently: true })
+    )
+  })
+})

package/types/_deployment/composition.d.ts

@@ -1,11 +1,10 @@
-import type * as _deployment from './deployment'
+import type * as _deployment from './deployment.d.ts'
 
 declare namespace toa.deployment {
-
   interface Composition extends _deployment.Deployable {
     components: Array<string>
+    replicas?: number
   }
-
 }
 
 export type Composition = toa.deployment.Composition

package/types/_deployment/dependency.d.ts

@@ -1,11 +1,12 @@
-import * as _service from './service'
+import * as _service from './service.d.ts'
 import { dependencies } from '@toa.io/norm/types/context'
 
 declare namespace toa.deployment {
-
   namespace dependency {
-
-    type Constructor = (instances: dependencies.Instance[], annotation: any) => Declaration
+    type Constructor = (
+      instances: dependencies.Instance[],
+      annotation: any
+    ) => Declaration
 
     type Reference = {
       name: string
@@ -19,6 +20,11 @@ declare namespace toa.deployment {
       group: string
       name: string
       version: string
+
+      /** The repository the extension publishes this service's image to, without a tag.
+       *  Stating it lets an application take the published image instead of building one. */
+      image?: string
+
       port: number
       ingress?: {
         host: string
@@ -36,7 +42,7 @@ declare namespace toa.deployment {
       name: string
       value?: string | number
       secret?: {
-        name: string,
+        name: string
         key: string
       }
     }
@@ -50,8 +56,8 @@ declare namespace toa.deployment {
       services?: Service[] // dependency.Service
       proxies?: Proxy[]
       variables?: Variables
+      events?: string[]
     }
-
   }
 
   type Dependency = {
@@ -59,8 +65,8 @@ declare namespace toa.deployment {
     services?: _service.Service[] // deployment.Service
     proxies?: dependency.Proxy[]
     variables?: dependency.Variables
+    events?: string[]
   }
-
 }
 
 export type Declaration = toa.deployment.dependency.Declaration

package/types/_deployment/deployment.d.ts

@@ -1,9 +1,8 @@
-import type * as _composition from './composition'
-import type * as _service from './service'
-import type * as _dependency from './dependency'
+import type * as _composition from './composition.d.ts'
+import type * as _service from './service.d.ts'
+import type * as _dependency from './dependency.d.ts'
 
 declare namespace toa.deployment {
-
   interface Declaration {
     apiVersion: string
     type: string
@@ -25,13 +24,11 @@ declare namespace toa.deployment {
   }
 
   namespace installation {
-
     interface Options {
       wait?: boolean
       target?: string
       namespace?: string
     }
-
   }
 
   namespace template {
@@ -52,9 +49,11 @@ declare namespace toa.deployment {
 
     template(options: template.Options): Promise<string>
 
-    variables(): _dependency.Variables
+    variables(options?: {
+      components?: string[]
+      services?: string[]
+    }): _dependency.Variable[]
   }
-
 }
 
 export namespace installation {

package/types/_deployment/factory.d.ts

@@ -1,14 +1,12 @@
-import type * as _operator from './operator'
-import * as _registry from './registry'
+import type * as _operator from './operator.d.ts'
+import * as _registry from './registry.d.ts'
 
 declare namespace toa.deployment {
-
   interface Factory {
     operator(): _operator.Operator
 
     registry(): _registry.Registry
   }
-
 }
 
 export type Factory = toa.deployment.Factory

package/types/_deployment/images/factory.d.ts

@@ -1,17 +1,15 @@
 // noinspection ES6UnusedImports
 
 import type { Composition } from '@toa.io/norm/types'
-import type { Image } from './image'
-import type { dependency } from '../dependency'
+import type { Image } from './image.d.ts'
+import type { dependency } from '../dependency.d.ts'
 
 declare namespace toa.deployment.images {
+  interface Factory {
+    composition(composition: Composition): Image
 
-    interface Factory {
-        composition(composition: Composition): Image
-
-        service(path: string, service: dependency.Service): Image
-    }
-
+    service(path: string, service: dependency.Service): Image
+  }
 }
 
 export type Factory = toa.deployment.images.Factory

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

@@ -1,14 +1,29 @@
 declare namespace toa.deployment.images {
-
   export interface Image {
     readonly reference: string
     readonly context: string
 
+    /** The image this one is laid over, built and pushed as an image of its own. */
+    readonly dependencies?: Image
+
+    /** Whether the build reads `registry.build.arguments`. */
+    readonly arguments?: boolean
+
+    name: string
+
     tag(): void
 
     prepare(root: string): Promise<string>
   }
 
+  /** Components in one image, laid over their dependencies. */
+  export interface Bundle extends Image {
+    readonly image?: string
+    readonly components: any[]
+
+    conflict(): string
+  }
 }
 
 export type Image = toa.deployment.images.Image
+export type Bundle = toa.deployment.images.Bundle

package/types/_deployment/images/registry.d.ts

@@ -1,20 +1,17 @@
 // noinspection ES6UnusedImports
 
 import type { Composition } from '@toa.io/norm'
-import type { dependency } from '../dependency'
-import type { Image } from "./image"
+import type { dependency } from '../dependency.d.ts'
+import type { Image } from './image.d.ts'
 
 declare namespace toa.deployment.images {
+  interface Registry {
+    composition(composition: Composition): Image
 
-    interface Registry {
-        composition(composition: Composition): Image
+    service(path: string, service: dependency.Service): Image
 
-        service(path: string, service: dependency.Service): Image
-
-        prepare(target: string): Promise<void>
-
-        push(): Promise<void>
-    }
+    prepare(target: string): Promise<void>
 
+    push(): Promise<void>
+  }
 }
-

package/types/_deployment/operator.d.ts

@@ -1,20 +1,21 @@
-import * as _deployment from './deployment'
-import * as _dependency from './dependency'
+import * as _deployment from './deployment.d.ts'
+import * as _dependency from './dependency.d.ts'
 
 declare namespace toa.deployment {
-
   interface Operator {
-    export (path?: string): Promise<string>
+    export(path?: string): Promise<string>
 
-    install (options?: _deployment.installation.Options): Promise<void>
+    install(options?: _deployment.installation.Options): Promise<void>
 
-    template (options?: _deployment.template.Options): Promise<string>
+    template(options?: _deployment.template.Options): Promise<string>
 
-    variables (): _dependency.Variables
+    variables(options?: {
+      components?: string[]
+      services?: string[]
+    }): _dependency.Variable[]
 
-    listVariables (): _dependency.Variable[]
+    listVariables(): _dependency.Variable[]
   }
-
 }
 
 export type Operator = toa.deployment.Operator

package/types/_deployment/registry.d.ts

@@ -1,9 +1,8 @@
 import type * as _norm from '@toa.io/norm/types'
-import type * as _dependency from './dependency'
-import type * as _image from "./images/image"
+import type * as _dependency from './dependency.d.ts'
+import type * as _image from './images/image.d.ts'
 
 declare namespace toa.deployment {
-  
   interface Registry {
     composition(composition: _norm.Composition): _image.Image
 
@@ -14,8 +13,12 @@ declare namespace toa.deployment {
     build(): Promise<void>
 
     push(): Promise<void>
-  }
 
+    /** Point each workload image at `environment` (`:production`). `deps-*` is not tagged. */
+    alias(environment?: string): Promise<void>
+
+    tags(): string[]
+  }
 }
 
 export type Registry = toa.deployment.Registry

package/types/_deployment/service.d.ts

@@ -1,7 +1,6 @@
-import type * as _deployment from './deployment'
+import type * as _deployment from './deployment.d.ts'
 
 declare namespace toa.deployment {
-
   interface Ingress {
     host: string
     class: string
@@ -11,8 +10,10 @@ declare namespace toa.deployment {
   interface Service extends _deployment.Deployable {
     port: number
     ingress?: Ingress
-  }
 
+    /** Annotations for the Service itself, as opposed to `ingress.annotations`. */
+    annotations?: object
+  }
 }
 
 export type Service = toa.deployment.Service

package/types/dependency.ts

@@ -0,0 +1,79 @@
+import type { Manifest } from '@toa.io/norm'
+import type { Locator } from '@toa.io/core'
+
+export interface Service {
+  group: string
+  name: string
+  version: string
+  /** The repository the extension publishes this service's image to, without a tag.
+   *  Stating it lets an application take the published image instead of building one. */
+  image?: string
+  port?: number
+  ingress?: Ingress
+  /** Annotations for the Service itself, as opposed to `ingress.annotations`. */
+  annotations?: object
+  resources?: Resources
+  variables?: Variable[]
+  components?: string[]
+  probe?: Probe | false
+  /** The workloads running this service, when compositions declared it instead of letting
+   *  it deploy on its own. Set by the deployment, never by an extension. */
+  workload?: string[]
+}
+
+export interface Variable {
+  name: string
+  value?: string
+  secret?: {
+    name: string
+    key: string
+    optional?: boolean
+  }
+}
+
+export interface Instance<T> {
+  locator: Locator
+  manifest: T
+  component: Manifest
+}
+
+export type Instances<T> = Array<Instance<T>>
+
+export type Variables = Record<'global' | string, Variable[]>
+export type Mounts = Record<'global' | string, Mount[]>
+
+export interface Dependency {
+  services?: Service[]
+  variables?: Variables
+  mounts?: Mounts
+  /** Event labels (`namespace.name.event`) this dependency consumes. */
+  events?: string[]
+  /** Default probe for compositions and services without their own probe. `false` disables. */
+  probe?: Probe | false
+}
+
+interface Ingress {
+  /** Path prefix this service claims on the host. Defaults to `/`. */
+  path?: string
+  default?: boolean
+  hosts?: string[]
+  class?: string
+  annotations?: object
+}
+
+export interface Probe {
+  port: number
+  path: string
+  delay?: number
+}
+
+interface Mount {
+  name: string
+  path: string
+  claim: string
+}
+
+export interface Resources {
+  cpu: string[]
+  memory: string[]
+}

package/types/index.ts

@@ -0,0 +1 @@
+export * from './dependency.ts'

package/types/dependency.d.ts

@@ -1,39 +0,0 @@
-export type Service = {
-  group: string
-  name: string
-  version: string
-  port: number
-  ingress: Ingress
-  variables: Variable[]
-  components?: string[]
-  probe?: Probe
-}
-
-export type Variable = {
-  name: string
-  value?: string
-  secret?: {
-    name: string,
-    key: string
-    optional?: boolean
-  }
-}
-
-export type Variables = Record<'global' | string, Variable[]>
-
-export type Dependency = {
-  services?: Service[]
-  variables?: Variables
-}
-
-type Ingress = {
-  hosts: string[]
-  class?: string
-  annotations?: object
-}
-
-interface Probe {
-  port: number
-  path: string
-  delay?: number
-}

package/types/index.d.ts

@@ -1 +0,0 @@
-export * from './dependency'