@codedependant/semantic-release-docker 3.1.2 → 4.0.0

package/test/integration/prepare.js

@@ -1,76 +0,0 @@
-'use strict'
-
-const path = require('path')
-const crypto = require('crypto')
-const sinon = require('sinon')
-const execa = require('execa')
-const {test, threw} = require('tap')
-const buildConfig = require('../../lib/build-config.js')
-const verify = require('../../lib/verify.js')
-const prepare = require('../../lib/prepare.js')
-const DOCKER_REGISTRY_HOST = process.env.TEST_DOCKER_REGISTRY || 'localhost:5000'
-const fixturedir = path.join(__dirname, '..', 'fixture')
-const DATE_REGEX = new RegExp(
-  '^[\\d]{4}-[\\d]{2}-[\\d]{2}T[\\d]{2}:[\\d]{2}:[\\d]{2}'
-    + '(\.[\\d]{1,6})?(Z|[\\+\\-][\\d]{2}:[\\d]{2})$' // eslint-disable-line no-useless-escape
-)
-
-test('steps::prepare', async (t) => {
-  t.test('build image created', async (tt) => {
-    const build_id = crypto.randomBytes(5).toString('hex')
-    const context = {
-      env: {
-        ...process.env
-      , DOCKER_REGISTRY_USER: 'iamweasel'
-      , DOCKER_REGISTRY_PASSWORD: 'secretsquirrel'
-      }
-    , cwd: fixturedir
-    , nextRelease: {
-        version: '2.1.2'
-      , gitTag: 'v2.1.2'
-      , gitHead: 'abacadaba'
-      }
-    , logger: {
-        success: sinon.stub()
-      , info: sinon.stub()
-      , debug: sinon.stub()
-      }
-    }
-
-    const config = await buildConfig(build_id, {
-      dockerRegistry: DOCKER_REGISTRY_HOST
-    , dockerProject: 'docker-prepare'
-    , dockerImage: 'fake'
-    , dockerArgs: {
-        MY_VARIABLE: '1'
-      , TAG_TEMPLATE: '{git_tag}'
-      , MAJOR_TEMPLATE: '{major}'
-      , GIT_REF: '{git_sha}'
-      , BUILD_DATE: '{now}'
-      }
-    , dockerFile: 'docker/Dockerfile.prepare'
-    , dockerContext: 'docker'
-    }, context)
-
-    const auth = await verify(config, context)
-    tt.ok(auth, `authentication to ${DOCKER_REGISTRY_HOST} suceeds`)
-
-    const image = await prepare(config, context)
-
-    tt.on('end', () => {
-      image.clean()
-    })
-
-    tt.equal(image.opts.args.get('TAG_TEMPLATE'), 'v2.1.2', 'TAG_TEMPLATE value')
-    tt.equal(image.opts.args.get('MAJOR_TEMPLATE'), '2', 'MAJOR_TEMPLATE value')
-    tt.equal(image.opts.args.get('GIT_REF'), 'abacadaba', 'GIT_REF value')
-    tt.match(image.opts.args.get('BUILD_DATE'), DATE_REGEX, 'BUILD_DATE value')
-    tt.equal(image.context, path.join(context.cwd, config.context), 'docker context path')
-
-    const {stdout} = await execa('docker', [
-      'images', image.name
-    , '-q', '--format={{ .Tag }}'
-    ])
-    tt.equal(stdout, build_id, 'build image fully built')
-  })
-}).catch(threw)

package/test/integration/publish.js

@@ -1,60 +0,0 @@
-'use strict'
-
-const crypto = require('crypto')
-const path = require('path')
-const sinon = require('sinon')
-const execa = require('execa')
-const {test, threw} = require('tap')
-const buildConfig = require('../../lib/build-config.js')
-const verify = require('../../lib/verify.js')
-const prepare = require('../../lib/prepare.js')
-const publish = require('../../lib/publish.js')
-const DOCKER_REGISTRY_HOST = process.env.TEST_DOCKER_REGISTRY || 'localhost:5000'
-const fixturedir = path.join(__dirname, '..', 'fixture')
-
-test('steps::publish', async (t) => {
-  t.test('publish multi tags', async (tt) => {
-    const build_id = crypto.randomBytes(5).toString('hex')
-    const context = {
-      env: {
-        ...process.env
-      , DOCKER_REGISTRY_USER: 'iamweasel'
-      , DOCKER_REGISTRY_PASSWORD: 'secretsquirrel'
-      }
-    , cwd: fixturedir
-    , nextRelease: {version: '2.0.0'}
-    , lastRelease: {version: '1.5.0'}
-    , logger: {
-        success: sinon.stub()
-      , info: sinon.stub()
-      , debug: sinon.stub()
-      }
-    }
-
-    const config = await buildConfig(build_id, {
-      dockerRegistry: DOCKER_REGISTRY_HOST
-    , dockerProject: 'docker-publish'
-    , dockerImage: 'real'
-    , dockerTags: ['{previous.major}-previous', '{major}-foobar', '{version}']
-    , dockerFile: 'docker/Dockerfile.publish'
-    }, context)
-
-    const auth = await verify(config, context)
-    tt.ok(auth, `authentication to ${DOCKER_REGISTRY_HOST} suceeds`)
-
-    const image = await prepare(config, context)
-    tt.on('end', () => {
-      image.clean()
-    })
-
-    // removes images when done
-    await publish(config, context)
-
-    const tags = ['1-previous', '2-foobar', '2.0.0']
-    for (const tag of tags) {
-      const expected = `${image.repo}:${tag}`
-      const {stdout} = await execa('docker', ['pull', expected, '-q'])
-      tt.equal(expected, stdout, `${expected} successfully published`)
-    }
-  })
-}).catch(threw)

package/test/integration/release.js

@@ -1,92 +0,0 @@
-'use strict'
-
-const execa = require('execa')
-const {test, threw} = require('tap')
-const git = require('../common/git/index.js')
-const DOCKER_REGISTRY_HOST = process.env.TEST_DOCKER_REGISTRY || 'localhost:5000'
-
-const stringify = JSON.stringify
-
-test('docker release', async (t) => {
-  const cwd = t.testdir({
-    'package.json': stringify({
-      name: 'service-meta-package'
-    , version: '0.0.0-development'
-    , scripts: {
-        'test-release': 'semantic-release'
-      }
-    , release: {
-        ci: true
-      , npmPublish: false
-      , branches: ['main']
-      , dockerRegistry: DOCKER_REGISTRY_HOST
-      , dockerProject: 'docker-release'
-      , dockerImage: 'fake'
-      , dockerArgs: {
-          SAMPLE_THING: '{type}.{version}'
-        , GIT_REF: '{git_sha}-{git_tag}'
-        , BUILD_DATE: '{now}'
-        }
-      , plugins: [
-          '@semantic-release/commit-analyzer'
-        , '@semantic-release/release-notes-generator'
-        , '@semantic-release/npm'
-        , '@codedependant/semantic-release-docker'
-        ]
-      }
-    , devDependencies: {
-        'semantic-release': '*'
-      , '@semantic-release/commit-analyzer': '*'
-      , '@semantic-release/release-notes-generator': '*'
-      , '@semantic-release/npm': '*'
-      , '@codedependant/semantic-release-docker': 'file:../../../'
-      }
-    })
-  , Dockerfile: 'FROM debian:buster-slim\n\nRUN ls -alh'
-  , '.gitignore': 'node_modules/'
-  })
-
-  await git.init(cwd)
-  t.comment('git repo initialized')
-  await git.add(cwd)
-  await git.commit(cwd, 'feat: initial release')
-
-  const origin = await git.initOrigin(cwd)
-  t.comment(`repository: ${cwd}`)
-  t.comment(`origin: ${origin}`)
-
-  {
-    const stream = execa('npm', [
-      'install'
-    ], {
-      cwd: cwd
-    , env: {
-        BRANCH_NAME: 'main'
-      , CI_BRANCH: 'main'
-      , CI: 'true'
-      , GITHUB_REF: 'refs/heads/main'
-      , DOCKER_REGISTRY_USER: 'iamweasel'
-      , DOCKER_REGISTRY_PASSWORD: 'secretsquirrel'
-      }
-    })
-
-    stream.stdout.pipe(process.stdout)
-    await stream
-  }
-
-  const stream = execa('npm', [
-    'run'
-  , 'test-release'
-  , `--repositoryUrl=${origin}`], {
-    cwd: cwd
-  , env: {
-      BRANCH_NAME: 'main'
-    , CI_BRANCH: 'main'
-    , CI: 'true'
-    , GITHUB_REF: 'refs/heads/main'
-    }
-  })
-  stream.stdout.pipe(process.stdout)
-  await stream
-
-}).catch(threw)

package/test/integration/verify.js

@@ -1,206 +0,0 @@
-'use strict'
-
-const crypto = require('crypto')
-const sinon = require('sinon')
-const {test, threw} = require('tap')
-
-const buildConfig = require('../../lib/build-config.js')
-const verify = require('../../lib/verify.js')
-const DOCKER_REGISTRY_HOST = process.env.TEST_DOCKER_REGISTRY || 'localhost:5000'
-
-test('steps::verify', async (t) => {
-  const build_id = crypto.randomBytes(5).toString('hex')
-  t.test('docker password, no username', async (tt) => {
-    const context = {
-      env: {
-        ...process.env
-      , DOCKER_REGISTRY_PASSWORD: 'abc123'
-      }
-    , cwd: process.cwd()
-    , logger: {
-        success: sinon.stub()
-      , info: sinon.stub()
-      }
-    }
-    const config = await buildConfig(build_id, {}, context)
-    await tt.rejects(
-      verify(config, context)
-    , {
-        message: /docker authentication failed/i
-      , code: 'EAUTH'
-      , details: /DOCKER_REGISTRY_USER AND DOCKER_REGISTRY_PASSWORD must be set/ig
-      }
-    )
-  })
-
-  t.test('docker password, no username', async (tt) => {
-    const context = {
-      env: {
-        ...process.env
-      , DOCKER_REGISTRY_USER: 'abc123'
-      }
-    , cwd: process.cwd()
-    , logger: {
-        success: sinon.stub()
-      , info: sinon.stub()
-      }
-    }
-    const config = await buildConfig(build_id, {}, context)
-    await tt.rejects(
-      verify(config, context)
-    , {
-        message: /docker authentication failed/i
-      , code: 'EAUTH'
-      , details: /DOCKER_REGISTRY_USER AND DOCKER_REGISTRY_PASSWORD must be set/ig
-      }
-    )
-  })
-
-  t.test('docker USER/PASS succeeds', async (tt) => {
-    const context = {
-      env: {
-        ...process.env
-      , DOCKER_REGISTRY_USER: 'iamweasel'
-      , DOCKER_REGISTRY_PASSWORD: 'secretsquirrel'
-      }
-    , cwd: process.cwd()
-    , logger: {
-        success: sinon.stub()
-      , info: sinon.stub()
-      }
-    }
-    const config = await buildConfig(build_id, {
-      dockerRegistry: DOCKER_REGISTRY_HOST
-    }, context)
-    tt.resolves(verify(config, context))
-  })
-
-  t.test('docker USER / GITHUB_TOKEN succeeds', async (tt) => {
-    const context = {
-      env: {
-        ...process.env
-      , DOCKER_REGISTRY_USER: 'iamweasel'
-      , GITHUB_TOKEN: 'secretsquirrel'
-      }
-    , cwd: process.cwd()
-    , logger: {
-        success: sinon.stub()
-      , info: sinon.stub()
-      }
-    }
-    const config = await buildConfig(build_id, {
-      dockerRegistry: DOCKER_REGISTRY_HOST
-    }, context)
-    tt.resolves(verify(config, context))
-  })
-
-  t.test('docker no login', async (tt) => {
-    const context = {
-      env: {
-        ...process.env
-      , DOCKER_REGISTRY_USER: 'iamweasel'
-      }
-    , cwd: process.cwd()
-    , logger: {
-        success: sinon.stub()
-      , info: sinon.stub()
-      }
-    }
-    const config = await buildConfig(build_id, {
-      dockerRegistry: DOCKER_REGISTRY_HOST
-    , dockerLogin: false
-    }, context)
-    tt.resolves(verify(config, context))
-  })
-
-  t.test('docker password, no username', async (tt) => {
-    const context = {
-      env: {
-        ...process.env
-      , DOCKER_REGISTRY_PASSWORD: 'abc123'
-      , DOCKER_REGISTRY_USER: 'abc123'
-      }
-    , cwd: process.cwd()
-    , logger: {
-        success: sinon.stub()
-      , info: sinon.stub()
-      }
-    }
-    const config = await buildConfig(build_id, {}, context)
-    tt.rejects(
-      verify(config, context)
-    , {
-        message: /docker authentication failed/i
-      , code: 'EAUTH'
-      , details: /authentication to dockerhub failed/ig
-      }
-    )
-  })
-
-  t.test('No auth provided succeed', async (tt) => {
-    const context = {
-      env: {
-        ...process.env
-      }
-    , cwd: process.cwd()
-    , logger: {
-        success: sinon.stub()
-      , info: sinon.stub()
-      }
-    }
-
-    const config = await buildConfig(build_id, {}, context)
-    tt.strictEqual(await verify(config, context), false, 'auth step skipped')
-  })
-
-  t.test('unable to collect image name', async (tt) => {
-    const context = {
-      env: {
-        ...process.env
-      }
-    , cwd: __dirname
-    , logger: {
-        success: sinon.stub()
-      , info: sinon.stub()
-      }
-    }
-
-    const config = await buildConfig(build_id, {
-      dockerRegistry: DOCKER_REGISTRY_HOST
-    }, context)
-    tt.rejects(verify(config, context), {
-      code: 'EINVAL'
-    , name: 'SemanticReleaseError'
-    , details: new RegExp(
-        'image name parsed from package.json name if possible. '
-          + 'or via the "dockerImage" option'
-      , 'gi'
-      )
-    })
-  })
-
-  t.test('invalid docker file location', async (tt) => {
-    const context = {
-      env: {
-        ...process.env
-      }
-    , cwd: process.cwd()
-    , logger: {
-        success: sinon.stub()
-      , info: sinon.stub()
-      }
-    }
-
-    const config = await buildConfig(build_id, {
-      dockerRegistry: DOCKER_REGISTRY_HOST
-    , dockerFile: 'Notafile'
-    }, context)
-
-    await tt.rejects(verify(config, context), {
-      code: 'ENOENT'
-    , name: 'SemanticReleaseError'
-    , details: /relative to pwd/gi
-    })
-
-  })
-}).catch(threw)

package/test/unit/build-config.js

@@ -1,167 +0,0 @@
-'use strict'
-
-const path = require('path')
-const {test, threw} = require('tap')
-const buildConfig = require('../../lib/build-config.js')
-
-test('build-config', async (t) => {
-  t.testdir({
-    standard: {
-      'package.json': JSON.stringify({name: 'this-is-not-scoped'})
-    }
-  , scoped: {
-      'package.json': JSON.stringify({name: '@scope/this-is-scoped'})
-    }
-  , workspace: {
-      one: {
-        'package.json': JSON.stringify({name: '@internal/package'})
-      }
-    }
-  })
-
-  t.test('standard package', async (tt) => {
-    const config = await buildConfig('id', {
-    }, {
-      cwd: path.join(t.testdirName, 'standard')
-    })
-    tt.match(config, {
-      dockerfile: 'Dockerfile'
-    , publish: true
-    , nocache: false
-    , tags: ['latest', '{major}-latest', '{version}']
-    , args: {
-        SRC_DIRECTORY: 'standard'
-      , TARGET_PATH: '.'
-      , NPM_PACKAGE_NAME: 'this-is-not-scoped'
-      , NPM_PACKAGE_SCOPE: null
-      , CONFIG_NAME: 'this-is-not-scoped'
-      , CONFIG_PROJECT: null
-      }
-    , pkg: Object
-    , registry: null
-    , name: 'this-is-not-scoped'
-    , project: null
-    , build: 'id'
-    , context: '.'
-    })
-  })
-
-  t.test('nested workspace: target resolution', async (tt) => {
-    const config = await buildConfig('id', {
-    }, {
-      options: {
-        root: t.testdirName
-      }
-    , cwd: path.join(t.testdirName, 'workspace', 'one')
-    })
-    tt.match(config, {
-      dockerfile: 'Dockerfile'
-    , nocache: false
-    , publish: true
-    , tags: ['latest', '{major}-latest', '{version}']
-    , args: {
-        SRC_DIRECTORY: 'one'
-      , TARGET_PATH: 'workspace/one'
-      , NPM_PACKAGE_NAME: 'package'
-      , NPM_PACKAGE_SCOPE: 'internal'
-      , CONFIG_NAME: 'package'
-      , CONFIG_PROJECT: 'internal'
-      }
-    , pkg: Object
-    , registry: null
-    , name: 'package'
-    , project: 'internal'
-    , build: 'id'
-    , context: '.'
-    })
-  })
-
-  t.test('scoped package', async (tt) => {
-    {
-      const config = await buildConfig('id', {
-      }, {
-        cwd: path.join(t.testdirName, 'scoped')
-      })
-      tt.match(config, {
-        dockerfile: 'Dockerfile'
-      , nocache: false
-      , tags: ['latest', '{major}-latest', '{version}']
-      , args: {
-          SRC_DIRECTORY: 'scoped'
-        , TARGET_PATH: '.'
-        , NPM_PACKAGE_NAME: '@scope/this-is-scoped'
-        , NPM_PACKAGE_SCOPE: 'scope'
-        , CONFIG_NAME: 'this-is-scoped'
-        , CONFIG_PROJECT: 'scope'
-        }
-      , pkg: Object
-      , registry: null
-      , name: 'this-is-scoped'
-      , project: 'scope'
-      , build: 'id'
-      , context: '.'
-      })
-    }
-
-    {
-      const config = await buildConfig('id', {
-        dockerProject: 'kittens'
-      , dockerImage: 'override'
-      , dockerFile: 'Dockerfile.test'
-      , dockerPublish: false
-      }, {
-        cwd: path.join(t.testdirName, 'scoped')
-      })
-      tt.match(config, {
-        dockerfile: 'Dockerfile.test'
-      , publish: false
-      , nocache: false
-      , tags: ['latest', '{major}-latest', '{version}']
-      , args: {
-          SRC_DIRECTORY: 'scoped'
-        , TARGET_PATH: '.'
-        , NPM_PACKAGE_NAME: '@scope/this-is-scoped'
-        , NPM_PACKAGE_SCOPE: 'scope'
-        , CONFIG_NAME: 'override'
-        , CONFIG_PROJECT: 'kittens'
-        }
-      , pkg: Object
-      , registry: null
-      , name: 'override'
-      , project: 'kittens'
-      , build: 'id'
-      , context: '.'
-      })
-    }
-
-    {
-      const config = await buildConfig('id', {
-        dockerProject: null
-      , dockerImage: 'override'
-      , dockerFile: 'Dockerfile.test'
-      , dockerTags: 'latest,{major}-latest , fake, {version}'
-      }, {
-        cwd: path.join(t.testdirName, 'scoped')
-      })
-      tt.match(config, {
-        dockerfile: 'Dockerfile.test'
-      , nocache: false
-      , tags: ['latest', '{major}-latest', 'fake', '{version}']
-      , args: {
-          SRC_DIRECTORY: 'scoped'
-        , TARGET_PATH: '.'
-        , NPM_PACKAGE_NAME: '@scope/this-is-scoped'
-        , NPM_PACKAGE_SCOPE: 'scope'
-        , CONFIG_NAME: 'override'
-        , CONFIG_PROJECT: null
-        }
-      , pkg: Object
-      , registry: null
-      , name: 'override'
-      , project: null
-      , build: 'id'
-      , context: '.'
-      })
-    }
-  })
-}).catch(threw)

package/test/unit/build-template-vars.js

@@ -1,63 +0,0 @@
-'use strict'
-
-const {test, threw} = require('tap')
-const buildConfig = require('../../lib/build-config.js')
-const buildTemplateVars = require('../../lib/build-template-vars.js')
-
-test('buildTemplateVars', async (t) => {
-  const cwd = t.testdir({
-    'package.json': JSON.stringify({
-      name: 'template-vars'
-    })
-  })
-  const context = {
-    cwd
-  , nextRelease: {
-      version: '1.0.0'
-    , gitTag: 'v1.0.0'
-    , gitHead: 'abcdefgh'
-    , type: 'major'
-    , notes: 'test it'
-    }
-  }
-  const opts = await buildConfig('abacadaba', {
-    dockerArgs: {
-      TEMPLATE_VALUE: '{type}.{version}'
-    , BOOLEAN_VALUE: true
-    , NULL_VALUE: null
-    }
-  }, context)
-
-  const vars = buildTemplateVars(opts, context)
-  t.match(vars, {
-    release_type: 'major'
-  , release_notes: 'test it'
-  , version: '1.0.0'
-  , git_sha: 'abcdefgh'
-  , git_tag: 'v1.0.0'
-  , pkg: {name: 'template-vars'}
-  , major: 1
-  , minor: 0
-  , patch: 0
-  , version: '1.0.0'
-  , next: {
-      major: 1
-    , minor: 0
-    , patch: 0
-    , version: '1.0.0'
-    }
-  , args: {
-      SRC_DIRECTORY: String
-    , TARGET_PATH: String
-    , NPM_PACKAGE_NAME: 'template-vars'
-    , NPM_PACKAGE_SCOPE: null
-    , CONFIG_NAME: String
-    , CONFIG_PROJECT: null
-    , GIT_SHA: 'abcdefgh'
-    , GIT_TAG: 'v1.0.0'
-    , TEMPLATE_VALUE: '{type}.{version}'
-    , BOOLEAN_VALUE: true
-    , NULL_VALUE: null
-    }
-  }, 'expected template values')
-}).catch(threw)