@codedependant/semantic-release-docker 3.1.1 → 4.1.0

package/lib/verify.js

@@ -4,12 +4,13 @@ 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 prepare = require('./prepare.js')
 const docker = require('./docker/index.js')
 
 module.exports = verify
 
 async function verify(opts, context) {
-  const {env, logger, cwd} = context
+  const {env, cwd} = context
   const PASSWORD = env.DOCKER_REGISTRY_PASSWORD || env.GITHUB_TOKEN
   const USERNAME = env.DOCKER_REGISTRY_USER
 
@@ -17,7 +18,8 @@ async function verify(opts, context) {
     const error = new SemanticError(
       'Docker image name not found'
     , 'EINVAL'
-    , 'Image name parsed from package.json name if possible. Or via the "image" option.'
+    , 'Image name parsed from package.json name if possible. '
+        + 'Or via the "dockerImage" option.'
     )
     throw error
   }
@@ -29,6 +31,7 @@ async function verify(opts, context) {
   , dockerfile: opts.dockerfile
   , build_id: opts.build
   , cwd: cwd
+  , context: opts.context
   })
 
   debug('docker options', opts)
@@ -49,47 +52,59 @@ async function verify(opts, context) {
   debug('image to build', image.repo)
   if (!USERNAME && !PASSWORD) {
     debug('No docker credentials found.  Skipping login')
-    return false
+  } else {
+    await doLogin({...opts, USERNAME, PASSWORD}, context)
   }
 
+  if (!opts.verifycmd) return true
+
+  const img = await prepare(opts, context)
+  const output = await img.run(opts.verifycmd)
+  if (opts.dryRun) await img.clean()
+  return output
+}
+
+async function doLogin(opts, context) {
+  const {USERNAME, PASSWORD} = opts
+  const {logger} = context
+
   if (opts.login === false) {
     debug('docker login === false. Skipping login')
-    return false
-  }
+  } else {
+    let set = 0
+    if (USERNAME) set += 1
+    if (PASSWORD) set += 1
 
-  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
+    }
 
-  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'
-  ])
+    const passwd = execa('echo', [PASSWORD])
+    const login = execa('docker', [
+      'login'
+    , opts.registry || ''
+    , '-u', USERNAME
+    , '--password-stdin'
+    ])
 
-  passwd.stdout.pipe(login.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
+    try {
+      await login
+    } catch (err) {
+      logger.fatal(err)
+      const error = new SemanticError(
+        'Docker authentication failed'
+      , 'EAUTH'
+      , `Authentication to ${opts.registry || 'dockerhub'} failed`
+      )
+      throw error
+    }
+    logger.success('docker login successful')
   }
-  logger.success('docker login successful')
-  return true
 }

package/package.json

@@ -1,16 +1,25 @@
 {
   "name": "@codedependant/semantic-release-docker",
   "private": false,
-  "version": "3.1.1",
+  "version": "4.1.0",
   "description": "docker package",
   "main": "index.js",
+  "files": [
+    "lib/",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
+    "package.json",
+    "index.js"
+  ],
   "scripts": {
-    "test": "docker-compose -f compose/base.yml -f compose/test.yml up --exit-code-from semantic-release --force-recreate --remove-orphans",
+    "test": "docker-compose -f compose/base.yml -f compose/test.yml up --exit-code-from semantic-release --force-recreate --remove-orphans --build",
     "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",
+    "local": "env $(cat env/local.env)",
     "pretap": "npm run lint",
     "release": "semantic-release"
   },
@@ -26,33 +35,7 @@
     "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,
@@ -70,29 +53,33 @@
       "text",
       "text-summary",
       "json",
+      "json-summary",
       "html"
     ],
     "nyc-arg": [
       "--exclude=coverage/",
       "--exclude=test/",
+      "--exclude=.eslintrc.js",
+      "--exclude=release.config.js",
       "--all"
     ]
   },
   "devDependencies": {
-    "@codedependant/release-config-npm": "^1.0.1",
+    "@codedependant/release-config-npm": "^1.0.4",
     "@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",
+    "eslint": "^8.5.0",
+    "eslint-config-codedependant": "^3.0.0",
+    "semantic-release": "17",
     "sinon": "^9.0.2",
-    "tap": "^14.10.7"
+    "tap": "^16.0.0"
   },
   "dependencies": {
-    "@semantic-release/error": "^2.2.0",
+    "@semantic-release/error": "^3.0.0",
     "debug": "^4.1.1",
     "execa": "^4.0.2",
-    "semantic-release": "^17.1.1",
+    "handlebars": "^4.7.7",
     "semver": "^7.3.2"
   }
 }

package/test/common/git/add.js

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

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

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

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

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

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

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

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

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

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

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

package/test/fixture/docker/Dockerfile.publish

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

package/test/fixture/docker/Dockerfile.test

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

package/test/fixture/package.json

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

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

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

package/test/integration/prepare.js

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

@@ -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)