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

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/chart.js

@@ -1,15 +0,0 @@
-'use strict'
-
-const chart = (context, dependencies) => {
-  return {
-    apiVersion: 'v2',
-    type: 'application',
-    name: context.name,
-    description: context.description,
-    version: context.version,
-    appVersion: context.version,
-    dependencies: dependencies.map((dependency) => dependency.chart)
-  }
-}
-
-exports.chart = chart

package/src/deployment/dependencies.js

@@ -1,25 +0,0 @@
-'use strict'
-
-const dependencies = (context) => {
-  const dependencies = map(context.connectors)
-
-  if (context.extensions !== undefined) dependencies.push(...map(context.extensions))
-
-  return dependencies
-}
-
-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
-}
-
-exports.dependencies = dependencies

package/src/deployment/directory.js

@@ -1,21 +0,0 @@
-'use strict'
-
-const fs = require('node:fs/promises')
-const { join } = require('node:path')
-const { tmpdir } = require('node:os')
-
-const directory = async (path) => {
-  if (path === undefined) {
-    path = await fs.mkdtemp(join(tmpdir(), 'toa-deployment-'))
-  } else {
-    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
-}
-
-exports.directory = directory

package/src/deployment/values.js

@@ -1,7 +0,0 @@
-'use strict'
-
-const values = (context, dependencies) => {
-  return Object.fromEntries(dependencies.map(({ chart, values }) => [chart.alias || chart.name, values]))
-}
-
-exports.values = values

package/src/deployment.js

@@ -1,64 +0,0 @@
-'use strict'
-
-const fs = require('node:fs/promises')
-const execa = require('execa')
-const { join } = require('node:path')
-const { yaml } = require('@toa.io/gears')
-
-const { dependencies } = require('./deployment/dependencies')
-const { directory } = require('./deployment/directory')
-const { chart } = require('./deployment/chart')
-const { values } = require('./deployment/values')
-
-class Deployment {
-  #context
-  #chart
-  #values
-
-  constructor (context) {
-    const deps = dependencies(context)
-
-    this.#context = context
-    this.#chart = chart(context, deps)
-    this.#values = values(context, deps)
-  }
-
-  async export (path) {
-    path = await directory(path)
-
-    await this.#dump(path)
-
-    return path
-  }
-
-  async install (wait) {
-    const path = await this.export()
-    const args = []
-
-    if (wait === true) args.push('--wait')
-
-    const update = execa('helm', ['dependency', 'update', path])
-
-    update.stdout.pipe(process.stdout)
-    await update
-
-    const upgrade = execa('helm', ['upgrade', this.#context.name, '-i', ...args, path])
-
-    upgrade.stdout.pipe(process.stdout)
-    await upgrade
-
-    await fs.rm(path, { recursive: true })
-  }
-
-  async #dump (path) {
-    const chart = yaml.dump(this.#chart)
-    const values = yaml.dump(this.#values)
-
-    await Promise.all([
-      fs.writeFile(join(path, 'Chart.yaml'), chart),
-      fs.writeFile(join(path, 'values.yaml'), values)
-    ])
-  }
-}
-
-exports.Deployment = Deployment

package/src/images/Dockerfile

@@ -1,10 +0,0 @@
-#TODO: bridge specifics
-
-FROM node:alpine
-
-RUN npm i -g @toa.io/runtime@0.1.0-dev.13
-
-WORKDIR /app
-ADD . .
-
-CMD toa compose .

package/src/images/image.js

@@ -1,38 +0,0 @@
-'use strict'
-
-const { join } = require('node:path')
-const execa = require('execa')
-
-class Image {
-  #manifest
-  #registry
-  #tag
-
-  constructor (manifest, registry) {
-    this.#manifest = manifest
-    this.#registry = registry
-
-    const { domain, name, version } = this.#manifest
-    this.#tag = this.#registry + '/' + domain + '-' + name + ':' + version
-  }
-
-  async build () {
-    const build = execa('docker', ['build', this.#manifest.path, '-f', DOCKERFILE, '-t', this.#tag])
-
-    build.stdout.pipe(process.stdout)
-
-    await build
-  }
-
-  async push () {
-    const push = execa('docker', ['push', this.#tag])
-
-    push.stdout.pipe(process.stdout)
-
-    await push
-  }
-}
-
-const DOCKERFILE = join(__dirname, 'Dockerfile')
-
-exports.Image = Image

package/src/images.js

@@ -1,26 +0,0 @@
-'use strict'
-
-const { Image } = require('./images/image')
-
-class Images {
-  #images
-
-  constructor (context) {
-    this.#images = context.manifests.map((manifest) => new Image(manifest, context.registry))
-  }
-
-  async push () {
-    await this.#build()
-    await this.#push()
-  }
-
-  async #build () {
-    await Promise.all(this.#images.map((image) => image.build()))
-  }
-
-  async #push () {
-    await Promise.all(this.#images.map((image) => image.push()))
-  }
-}
-
-exports.Images = Images

package/test/deployment.fixtures.js

@@ -1,34 +0,0 @@
-'use strict'
-
-const { generate } = require('randomstring')
-
-const context = {
-  name: generate(),
-  description: generate(),
-  version: '0.0.1',
-  runtime: '0.1.0',
-  packages: './path/to/' + generate()
-}
-
-const mock = {
-  dependencies: {
-    dependencies: jest.fn(() => [generate(), generate()])
-  },
-  directory: {
-    directory: jest.fn(() => generate())
-  },
-  chart: {
-    chart: jest.fn(() => ({ [generate()]: generate() }))
-  },
-  values: {
-    values: jest.fn(() => ({ [generate()]: generate() }))
-  },
-  fs: {
-    writeFile: jest.fn(),
-    rm: jest.fn()
-  },
-  execa: jest.fn(() => ({ stdout: { pipe: jest.fn() } }))
-}
-
-exports.context = context
-exports.mock = mock

package/test/deployment.test.js

@@ -1,88 +0,0 @@
-'use strict'
-
-const fixtures = require('./deployment.fixtures')
-const mock = fixtures.mock
-
-jest.mock('node:fs/promises', () => mock.fs)
-jest.mock('execa', () => mock.execa)
-jest.mock('../src/deployment/dependencies', () => mock.dependencies)
-jest.mock('../src/deployment/directory', () => mock.directory)
-jest.mock('../src/deployment/chart', () => mock.chart)
-jest.mock('../src/deployment/values', () => mock.values)
-
-const { Deployment } = require('../src')
-const { join } = require('node:path')
-const { generate } = require('randomstring')
-const { yaml } = require('@toa.io/gears')
-
-let deployment
-
-beforeEach(() => {
-  deployment = new Deployment(fixtures.context)
-})
-
-describe('export', () => {
-  const test = async (arg) => {
-    const result = await deployment.export(arg)
-
-    if (arg !== undefined) expect(arg).toBe(mock.directory.directory.mock.calls[0][0])
-
-    const path = mock.directory.directory.mock.results[0].value
-    const chart = yaml.dump(mock.chart.chart.mock.results[0].value)
-    const values = yaml.dump(mock.values.values.mock.results[0].value)
-
-    expect(mock.fs.writeFile).toHaveBeenNthCalledWith(1, join(path, 'Chart.yaml'), chart)
-    expect(mock.fs.writeFile).toHaveBeenNthCalledWith(2, join(path, 'values.yaml'), values)
-    expect(result).toBe(path)
-  }
-
-  it('should export chart', async () => {
-    await test()
-  })
-
-  it('should export chart to given path', async () => {
-    await test(generate())
-  })
-})
-
-describe('install', () => {
-  let path
-
-  beforeEach(async () => {
-    await deployment.install()
-
-    path = mock.directory.directory.mock.results[0].value
-  })
-
-  it('should update', () => {
-    expect(mock.execa).toHaveBeenNthCalledWith(1, 'helm', ['dependency', 'update', path])
-  })
-
-  it('should upgrade', () => {
-    expect(mock.execa).toHaveBeenNthCalledWith(2,
-      'helm', ['upgrade', fixtures.context.name, '-i', path])
-  })
-
-  it('should wait on upgrade', async () => {
-    jest.clearAllMocks()
-
-    await deployment.install(true)
-
-    path = mock.directory.directory.mock.results[0].value
-
-    expect(mock.execa).toHaveBeenNthCalledWith(2,
-      'helm', ['upgrade', fixtures.context.name, '-i', '--wait', path])
-  })
-
-  it('should pipe stdout', () => {
-    const update = mock.execa.mock.results[0].value
-    const upgrade = mock.execa.mock.results[1].value
-
-    expect(update.stdout.pipe).toHaveBeenCalledWith(process.stdout)
-    expect(upgrade.stdout.pipe).toHaveBeenCalledWith(process.stdout)
-  })
-
-  it('should clear', () => {
-    expect(mock.fs.rm).toHaveBeenCalledWith(path, { recursive: true })
-  })
-})

package/test/image.fixtures.js

@@ -1,24 +0,0 @@
-'use strict'
-
-const { newid, random } = require('@toa.io/gears')
-const { join } = require('node:path')
-
-const mock = {
-  execa: jest.fn(() => ({ stdout: { pipe: jest.fn() } }))
-}
-
-const manifest = {
-  domain: 'domain' + newid(),
-  name: 'component' + newid(),
-  version: '0.0.' + random(9),
-  path: newid()
-}
-
-const registry = `registry-${newid()}:${random(999) + 5000}`
-
-const DOCKERFILE = join(__dirname, '../src/images/Dockerfile')
-
-exports.mock = mock
-exports.manifest = manifest
-exports.registry = registry
-exports.DOCKERFILE = DOCKERFILE

package/test/image.test.js

@@ -1,45 +0,0 @@
-'use strict'
-
-const fixtures = require('./image.fixtures')
-const mock = fixtures.mock
-
-jest.mock('execa', () => mock.execa)
-
-const { Image } = require('../src/images/image')
-
-let image
-let tag
-
-beforeAll(() => {
-  const { domain, name, version } = fixtures.manifest
-
-  tag = `${fixtures.registry}/${domain}-${name}:${version}`
-})
-
-beforeEach(() => {
-  image = new Image(fixtures.manifest, fixtures.registry)
-})
-
-it('should build', async () => {
-  await image.build()
-
-  expect(mock.execa).toHaveBeenCalledWith('docker',
-    ['build', fixtures.manifest.path, '-f', fixtures.DOCKERFILE, '-t', tag])
-})
-
-it('should push', async () => {
-  await image.push()
-
-  expect(mock.execa).toHaveBeenCalledWith('docker', ['push', tag])
-})
-
-it('should pipe stdout', async () => {
-  await image.build()
-  await image.push()
-
-  const build = mock.execa.mock.results[0].value
-  const push = mock.execa.mock.results[1].value
-
-  expect(build.stdout.pipe).toHaveBeenCalledWith(process.stdout)
-  expect(push.stdout.pipe).toHaveBeenCalledWith(process.stdout)
-})

package/test/images.fixtures.js

@@ -1,29 +0,0 @@
-'use strict'
-
-const { random, repeat, newid } = require('@toa.io/gears')
-
-const mock = {
-  image: {
-    Image: jest.fn(() => {
-      return {
-        build: jest.fn(),
-        push: jest.fn()
-      }
-    })
-  }
-}
-
-const context = {
-  name: 'context-' + newid(),
-  registry: `registry-${newid()}:${random(999) + 5000}`,
-  manifests: repeat(
-    () => ({
-      domain: 'domain-' + newid(),
-      name: 'component-' + newid(),
-      version: '0.0.0'
-    }),
-    random(9) + 1)
-}
-
-exports.mock = mock
-exports.context = context