@toptal/davinci-ci 2.0.15-alpha-fx-3248-update-davinci-to-the-latest-version-containing-metrics-in-talent-portal-frontend-97a8b1bc.7 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Change Log
 
+## 2.1.0
+
+### Minor Changes
+
+- [#1774](https://github.com/toptal/davinci/pull/1774) [`ca7a20f2`](https://github.com/toptal/davinci/commit/ca7a20f248784371af9db64df31e05ada1e69179) Thanks [@TomasSlama](https://github.com/TomasSlama)! - ---
+
+  ### davinci.yaml (config)
+
+  - add new options to the config
+
+  ```yaml
+  master:
+    # danger check will require every PR
+    # created by not whitelisted user to have an assignee
+    require_assignee: false
+    require_assignee_whitelist: ['dependabot-preview[bot]', 'dependabot[bot]']
+  ```
+
+### Patch Changes
+
+- Updated dependencies [[`ca7a20f2`](https://github.com/toptal/davinci/commit/ca7a20f248784371af9db64df31e05ada1e69179)]:
+  - @toptal/davinci-cli-shared@1.10.0
+
 ## 2.0.14
 
 ### Patch Changes

package/README.md

@@ -47,6 +47,9 @@ master:
   deploy_staging: false
   deploy_storybook_staging: false
   deploy: false
+  conventional_commits: false # danger check will require each commit to follow convential commits
+  require_assignee: false # danger check will require each PR to have assignee
+  require_assignee_whitelist: ['dependabot-preview[bot]', 'dependabot[bot]']
 
 # Customize Slack channel where the notifications will get posted
 slack_channel: 'custom-slack-channel'

package/dist-package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@toptal/davinci-ci",
+  "version": "2.1.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-ci": "./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": "^17.0.2",
+    "@commitlint/config-conventional": "^17.1.0",
+    "@toptal/davinci-cli-shared": "1.10.0",
+    "danger": "^11.0.7",
+    "markdown-table": "^2.0.0"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-ci",
-  "version": "2.0.15-alpha-fx-3248-update-davinci-to-the-latest-version-containing-metrics-in-talent-portal-frontend-97a8b1bc.7+97a8b1bc",
+  "version": "2.1.0",
   "description": "Continuos integrations tools for frontend projects",
   "publishConfig": {
     "access": "public"
@@ -32,9 +32,8 @@
   "dependencies": {
     "@commitlint/cli": "^17.0.2",
     "@commitlint/config-conventional": "^17.1.0",
-    "@toptal/davinci-cli-shared": "1.9.1-alpha-fx-3248-update-davinci-to-the-latest-version-containing-metrics-in-talent-portal-frontend-97a8b1bc.7+97a8b1bc",
+    "@toptal/davinci-cli-shared": "1.10.0",
     "danger": "^11.0.7",
     "markdown-table": "^2.0.0"
-  },
-  "gitHead": "97a8b1bc26ae92a5de08d4019682514bab39594d"
+  }
 }

package/src/configs/danger/conventional-commits/dangerfile.js

@@ -1,7 +1,17 @@
 const { schedule } = require('danger')
+const { davinciProjectConfig } = require('@toptal/davinci-cli-shared')
 
 const { conventionalCommits } = require('./plugins/conventional-commits')
 const { conventionalPRTitle } = require('./plugins/conventional-pr-title')
+const { checkAssigneeExist } = require('../plugins/empty-assignee')
 
 schedule(conventionalCommits)
 schedule(conventionalPRTitle)
+
+const {
+  master: { requireAssignee },
+} = davinciProjectConfig
+
+if (requireAssignee) {
+  schedule(checkAssigneeExist)
+}

package/src/configs/danger/plugins/empty-assignee.js

@@ -0,0 +1,24 @@
+/// <reference types="danger" />
+/* globals danger, fail */
+const { davinciProjectConfig } = require('@toptal/davinci-cli-shared')
+
+const {
+  master: { requireAssigneeWhiteList = [] },
+} = davinciProjectConfig
+
+const WHITELISTED_USERS = requireAssigneeWhiteList
+const checkAssigneeExist = () => {
+  const isLocalRun = !danger.github
+
+  if (isLocalRun || WHITELISTED_USERS.includes(danger.github.pr.user.login)) {
+    return
+  }
+
+  if (!danger.github.pr.assignee || danger.github.pr.assignees.length === 0) {
+    fail('Please assign someone to this PR before merging.')
+  }
+}
+
+module.exports = {
+  checkAssigneeExist,
+}

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

@@ -1,7 +1,17 @@
 const { schedule } = require('danger')
+const { davinciProjectConfig } = require('@toptal/davinci-cli-shared')
 
 const { toptalCommits } = require('./plugins/toptal-commits')
 const { toptalPRTitle } = require('./plugins/toptal-pr-title')
+const { checkAssigneeExist } = require('../plugins/empty-assignee')
 
 schedule(toptalCommits)
 schedule(toptalPRTitle)
+
+const {
+  master: { requireAssignee },
+} = davinciProjectConfig
+
+if (requireAssignee) {
+  schedule(checkAssigneeExist)
+}

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
+  })
+
+  it('commit with title only', () => {
+    global.danger.git = prepareCommitsWithMessages(['Hello world'])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('commit with title and body', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Hello world\n\nSome commit body here.',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('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)
+  })
+
+  it('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)
+  })
+
+  it('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)
+  })
+
+  it('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)
+  })
+
+  it('commit message ending with a period in title', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Commit title ending with period.',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  it('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)
+  })
+
+  it('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)
+  })
+
+  it('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/toptal-pr-title.test.js

@@ -0,0 +1,68 @@
+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
+  })
+
+  it('should pass valid PR title', () => {
+    global.danger.github.pr.title = VALID_PR_TITLE
+
+    toptalPRTitle()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('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)
+  })
+
+  it('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)
+  })
+
+  it('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/deploy-helm-run/Jenkinsfile

@@ -13,7 +13,7 @@ def hasCommandInDavinci(args) {
       docker run \
       --rm \
       -u 469:469 \
-      gcr.io/toptal-hub/${repoName}:${tag} \
+      us-central1-docker.pkg.dev/toptal-hub/containers/${repoName}:${tag} \
       yarn davinci help
     """,
     returnStdout: true
@@ -109,7 +109,7 @@ pipeline {
               HELM_OPTS='\
               $set_params_env \
               --set image.tag=${params.TAG} \
-              --set image.repository=gcr.io/toptal-hub/${params.REPOSITORY_NAME}-release' \
+              --set image.repository=us-central1-docker.pkg.dev/toptal-hub/containers/${params.REPOSITORY_NAME}-release' \
               make $chart $release dep_build upgrade
               """
             }
@@ -137,7 +137,7 @@ pipeline {
               -e SENTRY_ORG=${sentryOrg} \
               -e SENTRY_PROJECT=${REPOSITORY_NAME} \
               -e SENTRY_AUTH_TOKEN=${SENTRY_AUTH_TOKEN} \
-              gcr.io/toptal-hub/${REPOSITORY_NAME}:${TAG} \
+              us-central1-docker.pkg.dev/toptal-hub/containers/${REPOSITORY_NAME}:${TAG} \
               yarn davinci-engine sentry-upload-source-maps
             """
           } else {

package/src/configs/jobs/master-main/Jenkinsfile

@@ -91,7 +91,7 @@ def hasParamInDavinciCommand(args) {
       docker run \
       --rm \
       -u 469:469 \
-      gcr.io/toptal-hub/${repoName}:${tag} \
+      us-central1-docker.pkg.dev/toptal-hub/containers/${repoName}:${tag} \
       yarn davinci help ${command}
     """,
     returnStdout: true
@@ -205,7 +205,7 @@ pipeline {
             -u 469:469 \
             -v ${jenkinsTestsCoverageDirectory}:/app/${testsCoverageDirectory} \
             -v ${jenkinsTestsPactContractsDirectory}:/app/${testsPactsDirectory} \
-            gcr.io/toptal-hub/${repositoryName}:${commitId} \
+            us-central1-docker.pkg.dev/toptal-hub/containers/${repositoryName}:${commitId} \
             yarn test --ci
           """
         }
@@ -231,7 +231,7 @@ pipeline {
             -e GIT_BRANCH=${branch} \
             -e GIT_СOMMIT=${commitId} \
             -v ${jenkinsTestsPactContractsDirectory}:/app/${testsPactsDirectory} \
-            gcr.io/toptal-hub/${repositoryName}:${commitId} \
+            us-central1-docker.pkg.dev/toptal-hub/containers/${repositoryName}:${commitId} \
             yarn publish-pact
           """
         }
@@ -316,7 +316,7 @@ pipeline {
             -v $SSH_AUTH_SOCK:/ssh-agent \
             -e SSH_AUTH_SOCK=/ssh-agent \
             -v ${PWD}/.git:/app/.git \
-            gcr.io/toptal-hub/${repositoryName}:${commitId} \
+            us-central1-docker.pkg.dev/toptal-hub/containers/${repositoryName}:${commitId} \
             ${releasePackageCommand}
           """
         }
@@ -380,7 +380,7 @@ pipeline {
             sh """
               docker run \
               --user="root" \
-              --rm gcr.io/toptal-hub/${repositoryName}:${commitId} /bin/bash -c "apt update && apt-get -y install libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libgconf-2-4 libnss3 libxss1 libasound2 libxtst6 xauth xvfb  && yarn cypress install > /dev/null && yarn test:$testCommand:ci"
+              --rm us-central1-docker.pkg.dev/toptal-hub/containers/${repositoryName}:${commitId} /bin/bash -c "apt update && apt-get -y install libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libgconf-2-4 libnss3 libxss1 libasound2 libxtst6 xauth xvfb  && yarn cypress install > /dev/null && yarn test:$testCommand:ci"
             """
         }
       } //steps

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

@@ -124,7 +124,7 @@ pipeline {
             -v $SSH_AUTH_SOCK:/ssh-agent \
             -e SSH_AUTH_SOCK=/ssh-agent \
             -v ${PWD}/.git:/app/.git \
-            gcr.io/toptal-hub/${repositoryName}:${commitId} \
+            us-central1-docker.pkg.dev/toptal-hub/containers/${repositoryName}:${commitId} \
             /bin/bash -c "yarn ${params.BUILD_PACKAGE_SCRIPT_NAME} && \
             yarn davinci-engine publish-package \
             --alpha \