@codedependant/semantic-release-docker 3.1.1

package/lib/publish.js

@@ -0,0 +1,32 @@
+'use strict'
+
+const buildTemplateVars = require('./build-template-vars.js')
+const docker = require('./docker/index.js')
+const string = require('./lang/string/index.js')
+
+module.exports = publish
+
+async function publish(opts, context) {
+  const {cwd, logger} = context
+  const image = new docker.Image({
+    registry: opts.registry
+  , project: opts.project
+  , name: opts.name
+  , dockerfile: opts.dockerfile
+  , build_id: opts.build
+  , cwd: cwd
+  })
+
+  const vars = buildTemplateVars(opts, context)
+  const tags = opts.tags.map((template) => {
+    return string.template(template)(vars)
+  }).filter(Boolean)
+
+  logger.info('tagging docker image', image.id)
+  for (const tag of tags) {
+    logger.info(`pushing image: ${image.repo} tag: ${tag}`)
+    await image.tag(tag, opts.publish)
+  }
+
+  await image.clean()
+}

package/lib/read-pkg.js

@@ -0,0 +1,12 @@
+'use strict'
+
+const path = require('path')
+const {promises: fs} = require('fs')
+
+module.exports = getPkg
+
+async function getPkg(opts) {
+  const {cwd = process.cwd()} = opts || {}
+  const pkg = await fs.readFile(path.join(cwd, 'package.json'), 'utf8')
+  return JSON.parse(pkg)
+}

package/lib/verify.js

@@ -0,0 +1,95 @@
+'use strict'
+
+const {promises: fs} = require('fs')
+const execa = require('execa')
+const debug = require('debug')('semantic-release:semantic-release-docker:verify')
+const SemanticError = require('@semantic-release/error')
+const docker = require('./docker/index.js')
+
+module.exports = verify
+
+async function verify(opts, context) {
+  const {env, logger, cwd} = context
+  const PASSWORD = env.DOCKER_REGISTRY_PASSWORD || env.GITHUB_TOKEN
+  const USERNAME = env.DOCKER_REGISTRY_USER
+
+  if (!opts.name) {
+    const error = new SemanticError(
+      'Docker image name not found'
+    , 'EINVAL'
+    , 'Image name parsed from package.json name if possible. Or via the "image" option.'
+    )
+    throw error
+  }
+
+  const image = new docker.Image({
+    registry: opts.registry
+  , project: opts.project
+  , name: opts.name
+  , dockerfile: opts.dockerfile
+  , build_id: opts.build
+  , cwd: cwd
+  })
+
+  debug('docker options', opts)
+
+  try {
+    await fs.readFile(image.dockerfile)
+  } catch (err) {
+    const error = new SemanticError(
+      `Unable to locate Dockerfile: ${image.dockerfile}`
+    , err.code
+    , 'Docker file is read from a local relative to PWD. Make sure the "dockerfile"'
+        + ' option is set to the desired location'
+    )
+
+    throw error
+  }
+
+  debug('image to build', image.repo)
+  if (!USERNAME && !PASSWORD) {
+    debug('No docker credentials found.  Skipping login')
+    return false
+  }
+
+  if (opts.login === false) {
+    debug('docker login === false. Skipping login')
+    return false
+  }
+
+  let set = 0
+  if (USERNAME) set += 1
+  if (PASSWORD) set += 1
+
+  if (set !== 2) {
+    const error = new SemanticError(
+      'Docker authentication failed'
+    , 'EAUTH'
+    , 'Both ENV vars DOCKER_REGISTRY_USER and DOCKER_REGISTRY_PASSWORD must be set'
+    )
+    throw error
+  }
+
+  const passwd = execa('echo', [PASSWORD])
+  const login = execa('docker', [
+    'login'
+  , opts.registry || ''
+  , '-u', USERNAME
+  , '--password-stdin'
+  ])
+
+  passwd.stdout.pipe(login.stdin)
+
+  try {
+    await login
+  } catch (err) {
+    const error = new SemanticError(
+      'Docker authentication failed'
+    , 'EAUTH'
+    , `Authentication to ${opts.registry || 'dockerhub'} failed`
+    )
+    throw error
+  }
+  logger.success('docker login successful')
+  return true
+}

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "@codedependant/semantic-release-docker",
+  "private": false,
+  "version": "3.1.1",
+  "description": "docker package",
+  "main": "index.js",
+  "scripts": {
+    "test": "docker-compose -f compose/base.yml -f compose/test.yml up --exit-code-from semantic-release --force-recreate --remove-orphans",
+    "start": "docker-compose -f compose/base.yml -f compose/dev.yml up --force-recreate --remove-orphans --build",
+    "stop": "docker-compose -f compose/base.yml -f compose/dev.yml down",
+    "tap": "tap",
+    "lint": "eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "pretap": "npm run lint",
+    "release": "semantic-release"
+  },
+  "keywords": [
+    "semantic-release"
+  ],
+  "author": "Eric Satterwhite <esatterwhite@wi.rr.com>",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/esatterwhite/semantic-release-docker.git"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": "codedependant",
+    "ignorePatterns": [
+      "node_modules/",
+      "test/fixture/",
+      "coverage/",
+      ".nyc_output/",
+      "env/",
+      "doc/"
+    ],
+    "rules": {
+      "object-shorthand": 0,
+      "no-unused-vars": [
+        "error",
+        {
+          "varsIgnorePattern": "_"
+        }
+      ],
+      "quote-props": [
+        2,
+        "as-needed"
+      ]
+    }
+  },
+  "tap": {
+    "esm": false,
+    "ts": false,
+    "jsx": false,
+    "timeout": 60,
+    "browser": false,
+    "check-coverage": true,
+    "lines": 95,
+    "branches": 95,
+    "statements": 95,
+    "functions": 95,
+    "files": [
+      "test/unit",
+      "test/integration"
+    ],
+    "coverage-report": [
+      "text",
+      "text-summary",
+      "json",
+      "html"
+    ],
+    "nyc-arg": [
+      "--exclude=coverage/",
+      "--exclude=test/",
+      "--all"
+    ]
+  },
+  "devDependencies": {
+    "@codedependant/release-config-npm": "^1.0.1",
+    "@semantic-release/changelog": "^5.0.1",
+    "@semantic-release/git": "^9.0.0",
+    "@semantic-release/github": "^7.0.7",
+    "eslint": "^7.4.0",
+    "eslint-config-codedependant": "^2.1.6",
+    "sinon": "^9.0.2",
+    "tap": "^14.10.7"
+  },
+  "dependencies": {
+    "@semantic-release/error": "^2.2.0",
+    "debug": "^4.1.1",
+    "execa": "^4.0.2",
+    "semantic-release": "^17.1.1",
+    "semver": "^7.3.2"
+  }
+}

package/test/common/git/add.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const execa = require('execa')
+
+module.exports = add
+
+async function add(cwd, file = '.') {
+  await execa('git', ['add', file], {cwd: cwd})
+}

package/test/common/git/commit.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const execa = require('execa')
+const head = require('./head.js')
+
+module.exports = commit
+
+async function commit(cwd, message) {
+  await execa('git', ['commit', '-m', message], {cwd: cwd})
+  return head(cwd)
+}

package/test/common/git/head.js

@@ -0,0 +1,10 @@
+'use strict'
+
+const execa = require('execa')
+
+module.exports = head
+
+async function head(cwd) {
+  const {stdout} = await execa('git', ['rev-parse', 'HEAD'], {cwd: cwd})
+  return stdout
+}

package/test/common/git/index.js

@@ -0,0 +1,13 @@
+'use strict'
+
+module.exports = {
+  add: require('./add.js')
+, commit: require('./commit.js')
+, head: require('./head.js')
+, initOrigin: require('./init-origin.js')
+, initRemote: require('./init-remote.js')
+, init: require('./init.js')
+, push: require('./push.js')
+, tag: require('./tag.js')
+, tags: require('./tags.js')
+}

package/test/common/git/init-origin.js

@@ -0,0 +1,13 @@
+'use strict'
+
+const execa = require('execa')
+const initRemote = require('./init-remote.js')
+
+module.exports = initOrigin
+
+async function initOrigin(cwd) {
+  const origin = await initRemote()
+  await execa('git', ['remote', 'add', 'origin', origin], {cwd: cwd})
+  await execa('git', ['push', '--all', 'origin'], {cwd: cwd})
+  return origin
+}

package/test/common/git/init-remote.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const path = require('path')
+const os = require('os')
+const {promises: fs} = require('fs')
+const execa = require('execa')
+
+module.exports = initRemote
+
+async function initRemote(branch = 'main') {
+  const cwd = await fs.mkdtemp(path.join(os.tmpdir(), path.sep))
+  await execa('git', [
+    'init', '--bare', `--initial-branch=${branch}`
+  ], {cwd: cwd})
+  return `file://${cwd}`
+}

package/test/common/git/init.js

@@ -0,0 +1,20 @@
+'use strict'
+
+const path = require('path')
+const os = require('os')
+const {promises: fs} = require('fs')
+const execa = require('execa')
+
+module.exports = init
+
+async function init(dir, branch = 'main') {
+  const cwd = dir || await fs.mkdtemp(path.join(os.tmpdir(), path.sep))
+  await execa('git', ['init', cwd])
+  await execa('git', ['checkout', '-b', branch], {cwd: cwd})
+  await execa('git', ['config', '--add', 'commit.gpgsign', false])
+  await execa('git', ['config', '--add', 'pull.default', 'current'], {cwd})
+  await execa('git', ['config', '--add', 'push.default', 'current'], {cwd})
+  await execa('git', ['config', '--add', 'user.name', 'secretsquirrel'], {cwd})
+  await execa('git', ['config', '--add', 'user.email', 'secret@mail.com'], {cwd})
+  return cwd
+}

package/test/common/git/push.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const execa = require('execa')
+
+module.exports = push
+
+async function push(cwd, remote = 'origin', branch = 'main') {
+  await execa('git', ['push', '--tags', remote, `HEAD:${branch}`], {cwd: cwd})
+}

package/test/common/git/tag.js

@@ -0,0 +1,13 @@
+'use strict'
+
+const execa = require('execa')
+
+module.exports = tag
+
+async function tag(cwd, name, hash) {
+  const args = hash
+    ? ['tag', '-f', name, hash]
+    : ['tag', name]
+
+  await execa('git', args, {cwd: cwd})
+}

package/test/common/git/tags.js

@@ -0,0 +1,14 @@
+'use strict'
+
+const os = require('os')
+const execa = require('execa')
+
+module.exports = tags
+
+async function tags(cwd, hash) {
+  const cmd = hash
+    ? ['describe', '--tags', '--exact-match', hash]
+    : ['tag', '-l', '--sort', 'v:refname']
+  const {stdout} = await execa('git', cmd, {cwd: cwd})
+  return stdout.split(os.EOL).filter(Boolean)
+}

package/test/fixture/docker/Dockerfile.prepare

@@ -0,0 +1,4 @@
+FROM debian:buster-slim
+COPY . /opt/prepare
+WORKDIR /opt/prepare
+CMD ["echo", "$PWD"]

package/test/fixture/docker/Dockerfile.publish

@@ -0,0 +1,4 @@
+FROM debian:buster-slim
+COPY . /opt/whizbang
+WORKDIR /opt/whizbang
+CMD ["echo", "$PWD"]

package/test/fixture/docker/Dockerfile.test

@@ -0,0 +1,4 @@
+FROM debian:buster-slim
+COPY . /opt/app
+WORKDIR /opt/app
+RUN ls -alh

package/test/fixture/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@fake-scope/whizbangs"
+, "version": "0.0.0"
+}

package/test/fixture/pkg/one/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "@fixture/one",
+  "version": "0.0.0",
+  "private": true
+}

package/test/integration/prepare.js

@@ -0,0 +1,74 @@
+'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'
+    }, 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')
+
+    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

@@ -0,0 +1,60 @@
+'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

@@ -0,0 +1,92 @@
+'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)