@toa.io/operations 0.2.0-dev.3 → 0.2.1-dev.3

package/types/deployment/dependency.d.ts

@@ -0,0 +1,77 @@
+// noinspection JSUnusedGlobalSymbols,ES6UnusedImports
+
+import { Service } from './service'
+import { dependencies } from '@toa.io/norm/types/context'
+
+declare namespace toa.deployment {
+
+  namespace dependency {
+
+    type Constructor = (instances: dependencies.Instance[], annotation: any) => Declaration
+
+    type Reference = {
+      name: string
+      version: string
+      repository?: string
+      alias?: string
+      values?: Object
+    }
+
+    type Service = {
+      group: string
+      name: string
+      version: string
+      port: number
+      ingress?: {
+        host: string
+        class: string
+        annotations?: object
+      }
+    }
+
+    type Proxy = {
+      name: string
+      target: string
+    }
+
+    type Variable = {
+      name: string
+      value?: string | number
+      secret?: {
+        name: string,
+        key: string
+      }
+    }
+
+    type Variables = {
+      [key: string]: Variable[]
+    }
+
+    type Declaration = {
+      references?: Reference[]
+      services?: Service[] // dependency.Service
+      proxies?: Proxy[]
+      variables?: Variables
+    }
+
+  }
+
+  type Dependency = {
+    references?: dependency.Reference[]
+    services?: Service[] // deployment.Service
+    proxies?: dependency.Proxy[]
+    variables?: dependency.Variables
+  }
+
+}
+
+export namespace dependency {
+  export type Declaration = toa.deployment.dependency.Declaration
+  export type Reference = toa.deployment.dependency.Reference
+  export type Service = toa.deployment.dependency.Service
+  export type Proxy = toa.deployment.dependency.Proxy
+  export type Variables = toa.deployment.dependency.Variables
+  export type Variable = toa.deployment.dependency.Variable
+}
+
+export type Dependency = toa.deployment.Dependency

package/types/deployment/deployment.d.ts

@@ -0,0 +1,67 @@
+// noinspection ES6UnusedImports,JSUnusedGlobalSymbols
+
+import type { Composition } from './composition'
+import type { Service } from './service'
+import type { dependency } from './dependency'
+
+declare namespace toa.deployment {
+
+    interface Declaration {
+        apiVersion: string
+        type: string
+        name: string
+        description?: string
+        version: string
+        appVersion: string
+        dependencies: dependency.Reference[]
+    }
+
+    interface Contents {
+        compositions?: Composition[]
+        components?: string[]
+        services?: Service[]
+        proxies?: dependency.Proxy[]
+        variables?: dependency.Variables
+        [key: string]: Object
+    }
+
+    namespace installation {
+
+        interface Options {
+            wait?: boolean
+            target?: string
+            namespace?: string
+        }
+
+    }
+
+    namespace template {
+        interface Options {
+            namespace: string
+        }
+    }
+
+    interface Deployable {
+        name: string
+        image: string
+    }
+
+    interface Deployment {
+        export(target: string): Promise<void>
+
+        install(options: installation.Options): Promise<void>
+
+        template(options: template.Options): Promise<string>
+    }
+
+}
+
+export namespace installation {
+    export type Options = toa.deployment.installation.Options
+}
+
+export namespace template {
+    export type Options = toa.deployment.template.Options
+}
+
+export type Deployable = toa.deployment.Deployable

package/types/deployment/factory.d.ts

@@ -0,0 +1,12 @@
+// noinspection ES6UnusedImports
+import type { Operator } from './operator'
+
+declare namespace toa.deployment {
+
+    interface Factory {
+        operator(): Operator
+    }
+
+}
+
+export type Factory = toa.deployment.Factory

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

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

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

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

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

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

package/types/deployment/index.d.ts

@@ -0,0 +1 @@
+export { Dependency, dependency } from './dependency'

package/types/deployment/operator.d.ts

@@ -0,0 +1,21 @@
+// noinspection ES6UnusedImports
+
+import { installation, template } from './deployment'
+
+declare namespace toa.deployment {
+
+    interface Operator {
+        export(path?: string): Promise<string>
+
+        prepare(path?: string): Promise<string>
+
+        build(): Promise<void>
+
+        install(options?: installation.Options): Promise<void>
+
+        template(options?: template.Options): Promise<string>
+    }
+
+}
+
+export type Operator = toa.deployment.Operator

package/types/deployment/service.d.ts

@@ -0,0 +1,20 @@
+// noinspection ES6UnusedImports
+
+import type { Deployable } from './deployment'
+
+declare namespace toa.deployment {
+
+    interface Ingress {
+        host: string
+        class: string
+        annotations?: object
+    }
+
+    interface Service extends Deployable {
+        port: number
+        ingress?: Ingress
+    }
+    
+}
+
+export type Service = toa.deployment.Service

package/types/process.d.ts

@@ -0,0 +1,13 @@
+declare namespace toa.operations {
+
+    namespace process {
+        interface Options {
+            silently?: boolean
+        }
+    }
+
+    interface Process {
+        execute(cmd: string, args: Array<string>, options?: process.Options): Promise<string>
+    }
+
+}

package/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2020-present Artem Gurtovoi
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/src/deployment/assets/Dockerfile

@@ -1,10 +0,0 @@
-# TODO: bridge specifics
-
-FROM node:alpine
-
-RUN npm i -g @toa.io/runtime@{{version}}
-
-WORKDIR /composition
-ADD . .
-
-CMD toa compose *

package/src/deployment/assets/chart/templates/deployment.yaml

@@ -1,23 +0,0 @@
-{{- range .Values.compositions }}
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: composition-{{ required "deployment name is required" .name }}
-spec:
-  replicas: {{ .replicas | default 2 }}
-  selector:
-    matchLabels:
-      toa.io/composition: {{ .name }}
-  template:
-    metadata:
-      labels:
-        toa.io/composition: {{ .name }}
-        {{- range .components }}
-        {{ . }}: "1"
-        {{- end }}
-    spec:
-      containers:
-        - name: {{ .name }}
-          image: {{ .image }}
----
-{{- end }}

package/src/deployment/assets/chart/values.yaml

@@ -1,18 +0,0 @@
-# This file just helps with IDE autocompletion and helm debugging. Actually dynamically replaced by ../values.js.
-compositions:
-  - name: todos
-    image: localhost:5000/todos:0.0.0
-    replicas: 2
-    components:
-      - todos-tasks
-      - todos-stats
-  - name: messages
-    image: localhost:5000/messages:0.0.0
-    replicas: 2
-    components:
-      - users-users
-# TODO: create services only if sync binding is being used by a component
-components:
-  - todos-tasks
-  - todos-stats
-  - users-users

package/src/deployment/chart.js

@@ -1,79 +0,0 @@
-'use strict'
-
-class Chart {
-  name
-
-  #context
-  #compositions
-  #dependencies
-
-  constructor (context, compositions) {
-    this.name = context.name
-
-    this.#context = context
-    this.#compositions = compositions
-    this.#dependencies = Chart.dependencies(context)
-  }
-
-  get declaration () {
-    const { name, description, version } = this.#context
-    const dependencies = this.#dependencies.map((dependency) => dependency.chart)
-
-    return {
-      apiVersion: 'v2',
-      type: 'application',
-      name,
-      description,
-      version,
-      appVersion: version,
-      dependencies
-    }
-  }
-
-  get values () {
-    const result = {}
-
-    result.compositions = this.#deployments()
-    result.components = this.#context.components.map((component) => component.domain + '-' + component.name)
-
-    for (const { chart, values } of this.#dependencies) result[chart.alias || chart.name] = values
-
-    return result
-  }
-
-  #deployments () {
-    return Array.from(this.#compositions).map((composition) => {
-      const { name, components, replicas, image: { tag: image } } = composition
-
-      return {
-        name,
-        components: components.map((component) => component.locator.label),
-        replicas,
-        image
-      }
-    })
-  }
-
-  static dependencies (context) {
-    const map = (map) => {
-      const list = []
-
-      for (const [key, values] of Object.entries(map)) {
-        const dependency = require(key)
-
-        if (dependency.deployments !== undefined) list.push(...dependency.deployments(values))
-      }
-
-      return list
-    }
-
-    const dependencies = []
-
-    if (context.connectors !== undefined) dependencies.push(...map(context.connectors))
-    if (context.extensions !== undefined) dependencies.push(...map(context.extensions))
-
-    return dependencies
-  }
-}
-
-exports.Chart = Chart

package/src/deployment/compositions.js

@@ -1,60 +0,0 @@
-'use strict'
-
-class Compositions {
-  #compositions
-
-  constructor (context, instantiate) {
-    if (context.compositions === undefined) context.compositions = []
-
-    Compositions.#resolve(context)
-    Compositions.#complete(context)
-
-    this.#compositions = context.compositions.map(instantiate)
-  }
-
-  [Symbol.iterator] = () => this.#compositions.values()
-
-  static #resolve (context) {
-    const map = {}
-
-    for (const component of context.components) {
-      const id = component.locator.id
-
-      map[id] = component
-    }
-
-    for (const composition of context.compositions) {
-      composition.components = composition.components.map((id) => {
-        const component = map[id]
-
-        if (component === undefined) {
-          throw new Error(`Unknown component '${id}' within composition '${composition.name}'`)
-        }
-
-        return component
-      })
-    }
-  }
-
-  static #complete (context) {
-    const composed = new Set(context.compositions.map((composition) =>
-      composition.components.map((component) => component.locator.id)
-    ).flat())
-
-    const names = new Set(context.compositions.map((composition) => composition.name))
-
-    for (const component of context.components) {
-      const { id, label } = component.locator
-
-      if (composed.has(id)) continue
-      if (names.has(label)) throw new Error(`Duplicate composition name '${label}'`)
-
-      context.compositions.push({
-        name: label,
-        components: [component]
-      })
-    }
-  }
-}
-
-exports.Compositions = Compositions

package/src/deployment/copy.js

@@ -1,7 +0,0 @@
-'use strict'
-
-const execa = require('execa')
-
-const copy = async (source, target) => await execa('cp', ['-r', source, target])
-
-exports.copy = copy

package/src/deployment/directory.js

@@ -1,19 +0,0 @@
-'use strict'
-
-const fs = require('node:fs/promises')
-const { join } = require('node:path')
-const { tmpdir } = require('node:os')
-
-const directory = async (path) => {
-  await fs.mkdir(path, { recursive: true })
-
-  const entries = await fs.readdir(path)
-
-  if (entries.length > 0) throw new Error('Target directory must be empty')
-
-  return path
-}
-
-directory.temp = async (type) => await fs.mkdtemp(join(tmpdir(), `toa-${type}-`))
-
-exports.directory = directory

package/src/deployment/image.js

@@ -1,67 +0,0 @@
-'use strict'
-
-const { join } = require('node:path')
-const { readFile: read, writeFile: write, rm: remove } = require('node:fs/promises')
-const execa = require('execa')
-
-const { hash } = require('@toa.io/gears')
-const { directory } = require('./directory')
-const { copy } = require('./copy')
-
-class Image {
-  tag
-
-  #composition
-  #registry
-  #runtime
-
-  constructor (composition, context) {
-    this.#composition = composition
-    this.#registry = context.registry
-    this.#runtime = context.runtime
-
-    this.tag = context.registry + '/' + composition.name + ':' + Image.#tag(composition)
-  }
-
-  async build () {
-    const path = await this.#context()
-    const build = execa('docker', ['build', path, '-t', this.tag])
-
-    build.stdout.pipe(process.stdout)
-
-    await build
-
-    await remove(path, { recursive: true })
-  }
-
-  async push () {
-    const push = execa('docker', ['push', this.tag])
-
-    push.stdout.pipe(process.stdout)
-
-    await push
-  }
-
-  async #context () {
-    const path = await directory.temp('composition')
-    const dockerfile = (await read(DOCKERFILE, 'utf-8')).replace('{{version}}', this.#runtime)
-
-    for (const component of this.#composition.components) {
-      await copy(component.path, join(path, component.locator.id))
-    }
-
-    await write(join(path, 'Dockerfile'), dockerfile)
-
-    return path
-  }
-
-  static #tag (composition) {
-    const components = composition.components.map((component) => component.locator.id).join(';')
-
-    return hash(components)
-  }
-}
-
-const DOCKERFILE = join(__dirname, 'assets/Dockerfile')
-
-exports.Image = Image

package/test/deployment/compositions.test.js

@@ -1,31 +0,0 @@
-'use strict'
-
-const fixtures = require('./copositions.fixtures')
-const { Compositions } = require('../../src/deployment/compositions')
-
-const clone = require('clone-deep')
-
-let context, compositions
-
-beforeEach(() => {
-  context = clone(fixtures.context)
-  compositions = new Compositions(context, fixtures.instantiate)
-})
-
-it('should instantiate', () => {
-  expect(fixtures.instantiate).toHaveBeenCalledTimes(context.compositions.length)
-})
-
-it('should be iterable over instances', () => {
-  expect(Symbol.iterator in compositions).toEqual(true)
-
-  for (const composition of compositions) expect(fixtures.instantiate).toHaveReturnedWith(composition)
-})
-
-it('should complete compositions', () => {
-  expect(context.compositions.length).toBeGreaterThan(fixtures.context.compositions.length)
-
-  const used = new Set(context.compositions.map((composition) => composition.components).flat())
-
-  expect(used.size).toEqual(context.components.length)
-})

package/test/deployment/copositions.fixtures.js

@@ -1,42 +0,0 @@
-'use strict'
-
-const { repeat, random } = require('@toa.io/gears')
-const { generate } = require('randomstring')
-
-const components = repeat(() => ({
-  domain: generate(),
-  name: generate(),
-  locator: {
-    id: generate(),
-    label: generate()
-  },
-  version: random(10) + '.' + random(20) + '.' + random(30)
-}), random(10) + 5)
-
-const context = {
-  registry: generate(),
-  components,
-  compositions: []
-}
-
-let unused = components.length
-
-while (1) {
-  const use = random(3) + 1
-  const index = components.length - unused
-
-  if (use >= unused) break
-
-  context.compositions.push({
-    name: generate(),
-    components: components.slice(index, index + use)
-      .map((component) => component.locator.id)
-  })
-
-  unused -= use
-}
-
-const instantiate = jest.fn(() => generate())
-
-exports.context = context
-exports.instantiate = instantiate

package/test/deployment/image.fixtures.js

@@ -1,26 +0,0 @@
-'use strict'
-
-const { newid, random, repeat } = require('@toa.io/gears')
-const { join } = require('node:path')
-const { generate } = require('randomstring')
-
-const mock = {
-  execa: jest.fn(() => ({ stdout: { pipe: jest.fn() } }))
-}
-
-const composition = {
-  name: generate(),
-  components: repeat(() => ({ locator: { id: newid() } }), random(5) + 5)
-}
-
-const context = {
-  registry: `registry-${newid()}:${random(999) + 5000}`,
-  runtime: `${random(9)}.${random(9)}.${random(20)}`
-}
-
-const DOCKERFILE = join(__dirname, '../src/images/Dockerfile')
-
-exports.mock = mock
-exports.composition = composition
-exports.context = context
-exports.DOCKERFILE = DOCKERFILE