@toptal/davinci-ci 1.13.4-alpha-fx-upgrade-stylelint-rules.1335 → 1.14.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## 1.14.0
+
+### Minor Changes
+
+- [#1047](https://github.com/toptal/davinci/pull/1047) [`850d14f9`](https://github.com/toptal/davinci/commit/850d14f9574d6b32abe6425e3f3248afb1d2e0b4) Thanks [@dmaklygin1](https://github.com/dmaklygin1)! - Remove npx package
+
+### Patch Changes
+
+- [#1042](https://github.com/toptal/davinci/pull/1042) [`da14a73e`](https://github.com/toptal/davinci/commit/da14a73e3ec62f34b709baf80b15cffe3b080bb9) Thanks [@OndrejTuma](https://github.com/OndrejTuma)! - More verbose error of toptal commit message check. Now it tells you where the problem is and hints the correct version
+
+- Updated dependencies [[`850d14f9`](https://github.com/toptal/davinci/commit/850d14f9574d6b32abe6425e3f3248afb1d2e0b4)]:
+  - @toptal/davinci-cli-shared@1.5.0
+
 ## 1.13.3
 
 ### Patch Changes

package/dist-package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@toptal/davinci-ci",
+  "version": "1.14.0",
+  "description": "Continuos integrations tools for frontend projects",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "jenkins",
+    "docker",
+    "ci"
+  ],
+  "author": "Toptal",
+  "homepage": "https://github.com/toptal/davinci/tree/master/packages/ci#readme",
+  "license": "ISC",
+  "bin": {
+    "davinci-code": "./bin/davinci-ci.js"
+  },
+  "main": "./src/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/toptal/davinci.git"
+  },
+  "scripts": {
+    "build:package": "../../bin/build-package.js",
+    "prepublishOnly": "../../bin/prepublish.js",
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  },
+  "bugs": {
+    "url": "https://github.com/toptal/davinci/issues"
+  },
+  "dependencies": {
+    "@commitlint/cli": "^12.1.4",
+    "@commitlint/config-conventional": "^12.1.4",
+    "@toptal/davinci-cli-shared": "^1.5.0",
+    "danger": "^10.7.1",
+    "markdown-table": "^2.0.0"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-ci",
-  "version": "1.13.4-alpha-fx-upgrade-stylelint-rules.1335+72109f9",
+  "version": "1.14.0",
   "description": "Continuos integrations tools for frontend projects",
   "publishConfig": {
     "access": "public"
@@ -32,9 +32,8 @@
   "dependencies": {
     "@commitlint/cli": "^12.1.4",
     "@commitlint/config-conventional": "^12.1.4",
-    "@toptal/davinci-cli-shared": "1.4.2-alpha-fx-upgrade-stylelint-rules.1335+72109f9",
+    "@toptal/davinci-cli-shared": "^1.5.0",
     "danger": "^10.7.1",
     "markdown-table": "^2.0.0"
-  },
-  "gitHead": "72109f93ee9cf82099b24934b322929fe3e9b883"
+  }
 }

package/src/commands/danger.js

@@ -36,7 +36,7 @@ const dangerCommand = ({ options }) => {
     : toptalCommitsDangerfilePath
 
   runSync(
-    'npx',
+    'yarn',
     [
       'danger',
       local ? 'local' : 'ci',

package/src/configs/danger/toptal/config.js

@@ -1,6 +1,12 @@
 const WHITELISTED_USERS = ['dependabot-preview[bot]', 'dependabot[bot]', 'toptal-devbot']
 const VALID_PR_CODE_REGEX = /\[[A-Z]{1,4}-.*]\s/
-const VALID_COMMIT_MESSAGE_REGEX = /^[A-Z]\w[^.\n]*[^.\s](\n\n(.|\n)*)*$/
+// Valid commit titles:
+// "Regular commit message"
+// "Commit with sentence. But does not end with a full-stop"
+// "[FOO-1234] Commit with prefix"
+// "[FOO] Prefix numbers can be omitted"
+// "[FOO][BAR] Prefixes can couple"
+const VALID_COMMIT_TITLE_REGEX = /^((\[[A-Z]+(-\d+)?])+ )?[A-Z]\w[^\n]*[^.]$/
 const MAX_COMMIT_LINE_LENGTH = 79
 const ENGINEERING_DOCS_LINK =
   'https://toptal-core.atlassian.net/wiki/spaces/ENG/pages/210665897/Commit+Message+Quality'
@@ -14,7 +20,7 @@ module.exports = {
   ENGINEERING_DOCS_LINK,
   MAX_COMMIT_LINE_LENGTH,
   MISSING_TICKET_CODE_ERROR_MESSAGE,
-  VALID_COMMIT_MESSAGE_REGEX,
+  VALID_COMMIT_TITLE_REGEX,
   VALID_PR_CODE_REGEX,
   WHITELISTED_USERS
 }

package/src/configs/danger/toptal/plugins/toptal-commits/index.js

@@ -1,6 +1,6 @@
 const {
   MAX_COMMIT_LINE_LENGTH,
-  VALID_COMMIT_MESSAGE_REGEX,
+  VALID_COMMIT_TITLE_REGEX,
   WHITELISTED_USERS
 } = require('../../config')
 
@@ -8,14 +8,20 @@ const validateCommitMessage = message => {
   const errors = []
   const [title = '', body = ''] = message.split(/\n\n/)
   const bodyLines = body.split(/\n/)
-  const isFormatValid = VALID_COMMIT_MESSAGE_REGEX.test(message)
+  const isTitleFormatValid = VALID_COMMIT_TITLE_REGEX.test(title)
   const isTitleLengthValid = title.length <= MAX_COMMIT_LINE_LENGTH
   const isBodyLinesLengthValid = bodyLines.every(
     line => line.length <= MAX_COMMIT_LINE_LENGTH
   )
 
-  if (!isFormatValid) {
-    errors.push('- format of commit title or body is not correct')
+  if (!isTitleFormatValid) {
+    errors.push(`- format of commit title is not correct ([read more](https://toptal-core.atlassian.net/wiki/spaces/ENG/pages/210665897/Commit+Message+Quality)): 
+  - Title should start with capital letter
+  - Title should not end with a full-stop (i.e .)\n
+  Example of a valid commit title:
+    - Regular commit message
+    - [FOO-1234] Commit with prefix
+    - [FOO][BAR] Coupled prefixes`)
   }
 
   if (!isTitleLengthValid) {

package/src/configs/danger/toptal/plugins/toptal-commits/toptal-commits.test.js

@@ -0,0 +1,128 @@
+const { toptalCommits } = require('.')
+
+const prepareCommitsWithMessages = (messages = []) => ({
+  commits: messages.map(message => ({
+    message,
+    sha: '123'
+  }))
+})
+
+describe('commit danger plugin', () => {
+  beforeEach(() => {
+    global.fail = jest.fn()
+    global.danger = {
+      github: {
+        pr: {
+          user: {
+            login: 'user'
+          }
+        }
+      }
+    }
+  })
+
+  afterEach(() => {
+    global.fail = undefined
+    global.danger = undefined
+  })
+
+  test('commit with title only', () => {
+    global.danger.git = prepareCommitsWithMessages(['Hello world'])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  test('commit with title and body', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Hello world\n\nSome commit body here.'
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  test('commit with multi-line body', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Hello world\n\nFirst line of commit body\nSecond line of commit body'
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  test('commit with title longer than allowed', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'This commit message is a teeny tiny bit longer than allowed length of 79 characters'
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  test('commit with body lines longer than allowed', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Short commit title\n\nBut this body line commit message is a bit longer than allowed length of 79 characters\nAnd this one is fine again.'
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  test('commit message not starting with an uppercase letter', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      '23432 starts with a number',
+      'starts with a lowercase letter',
+      '* starts with a symbol',
+      ' starts with a space'
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(4)
+  })
+
+  test('commit message ending with a period in title', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Commit title ending with period.',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  test('commit without a blank line between title and body', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Commit title\nBody without a blank line after title'
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  test('valid commit titles', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Regular commit title',
+      'Commit with sentence. But does not end with a full-stop',
+      '[FOO-1234] Commit with prefix',
+      '[FOO] Prefix numbers can be omitted',
+      '[FOO][BAR] Prefixes can couple',
+      '[FOO-1234][BAR] Mixed prefixes',
+      '[FOO-1234][BAR-123][BAZ] Everything. Together',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  test('invalid commit title prefixes', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      '[FOO-1234] commit with lowercase',
+      '[FOO-BAR] Prefix with letter after dash',
+      '[FOO] [BAR] Prefixes with space between',
+      '[FOO]Prefix without space',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(4)
+  })
+})

package/src/configs/danger/toptal/plugins/toptal-pr-title/index.js

@@ -1,5 +1,5 @@
 const {
-  VALID_COMMIT_MESSAGE_REGEX,
+  VALID_COMMIT_TITLE_REGEX,
   VALID_PR_CODE_REGEX,
   WHITELISTED_USERS,
   DEFAULT_PR_TITLE_ERROR_MESSAGE,
@@ -47,7 +47,7 @@ const toptalPRTitle = () => {
   }
 
   const titleText = splitTitle[splitTitle.length - 1]
-  const isTitleFormatValid = VALID_COMMIT_MESSAGE_REGEX.test(titleText)
+  const isTitleFormatValid = VALID_COMMIT_TITLE_REGEX.test(titleText)
 
   if (!isTitleFormatValid) {
     showError()

package/src/configs/danger/toptal/plugins/toptal-pr-title/toptal-pr-title.test.js

@@ -0,0 +1,66 @@
+const { toptalPRTitle } = require('.')
+const {
+  MISSING_TICKET_CODE_ERROR_MESSAGE,
+  DEFAULT_PR_TITLE_ERROR_MESSAGE
+} = require('../../config')
+
+const VALID_PR_TITLE = '[ASD-123] Hello world'
+const INVALID_PR_TITLE = '[ASD-123] hello world'
+const NO_TICKET_CODE_PR_TITLE = 'Hello world'
+
+describe('commit danger plugin', () => {
+  beforeEach(() => {
+    global.fail = jest.fn()
+    global.danger = {
+      github: {
+        issue: {
+          labels: [
+            { name: 'My Team' }
+          ]
+        },
+        pr: {
+          title: '',
+          user: {
+            login: 'user'
+          }
+        }
+      }
+    }
+  })
+
+  afterEach(() => {
+    global.fail = undefined
+    global.danger = undefined
+  })
+
+  test('should pass valid PR title', () => {
+    global.danger.github.pr.title = VALID_PR_TITLE
+
+    toptalPRTitle()
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  test('should fail PR title with missing ticket code', () => {
+    global.danger.github.pr.title = NO_TICKET_CODE_PR_TITLE
+
+    toptalPRTitle()
+    expect(global.fail).toHaveBeenCalledTimes(1)
+    expect(global.fail).toHaveBeenCalledWith(MISSING_TICKET_CODE_ERROR_MESSAGE)
+  })
+
+  test('should pass valid PR title with missing ticket code and no-jira label', () => {
+    global.danger.github.pr.title = NO_TICKET_CODE_PR_TITLE
+    global.danger.github.issue.labels = [{ name: 'no-jira' }]
+
+    toptalPRTitle()
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  test('should fail invalid PR title', () => {
+    global.danger.github.pr.title = INVALID_PR_TITLE
+
+    toptalPRTitle()
+    expect(global.fail).toHaveBeenCalledTimes(1)
+    expect(global.fail).toHaveBeenCalledWith(DEFAULT_PR_TITLE_ERROR_MESSAGE)
+  })
+})

package/src/configs/jobs/pr-tests/Jenkinsfile

@@ -166,7 +166,7 @@ pipeline {
             -e BUILD_URL=${BUILD_URL} \
             -e DANGER_GITHUB_API_TOKEN=${DANGER_GITHUB_API_TOKEN} \
             gcr.io/toptal-hub/${repositoryName}:${commitId} \
-            npx davinci ci danger
+            yarn davinci ci danger
           """
         }
       } //steps

package/src/configs/jobs/publish-alpha-package/Jenkinsfile

@@ -126,7 +126,7 @@ pipeline {
             -v ${PWD}/.git:/app/.git \
             gcr.io/toptal-hub/${repositoryName}:${commitId} \
             /bin/bash -c "yarn ${params.BUILD_PACKAGE_SCRIPT_NAME} && \
-            npx davinci engine publish-package \
+            yarn davinci engine publish-package \
             --alpha \
             --outputVersion /artifacts/.version \
             --branch ${sourceBranch}"