@codedependant/semantic-release-docker 3.1.1

package/test/integration/verify.js

@@ -0,0 +1,205 @@
+'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 "image" 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

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

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