@toptal/davinci-ci 3.0.1-alpha-chore-improve-packages-building-14e3a950.51 → 3.0.2-alpha-chore-improve-packages-building-4fb91e1f.10

package/src/configs/docker/Dockerfile.gha-deploy

@@ -0,0 +1,33 @@
+# Create the image with Nginx environment.
+FROM nginx:alpine
+
+# Copy results from the dist folder to the image.
+ARG DIST_FOLDER
+RUN [ -z "$DIST_FOLDER" ] && echo "DIST_FOLDER is required" && exit 1 || true
+COPY $DIST_FOLDER /usr/share/nginx/html
+
+# Remove source maps from the production build
+RUN find /usr/share/nginx/html -name "*.map" -type f -delete
+
+# Copy the entrypoint.
+ARG ENV_RUNTIME_ENTRYPOINT
+RUN [ -z "$ENV_RUNTIME_ENTRYPOINT" ] && echo "ENV_RUNTIME_ENTRYPOINT is required" && exit 1 || true
+COPY $ENV_RUNTIME_ENTRYPOINT /usr/local/bin/env-runtime.entrypoint.sh
+RUN chmod +x /usr/local/bin/env-runtime.entrypoint.sh
+
+# version is used in build process, so the value won't be available here otherwise
+ARG VERSION
+RUN [ -z "$VERSION" ] && echo "VERSION is required" && exit 1 || true
+ENV DAVINCI_RELEASE_VERSION $VERSION
+
+RUN echo $VERSION > /usr/share/nginx/html/REVISION.txt
+
+# Copy configuration file for Nginx and replace the default one.
+ARG NGINX_CONFIG
+RUN [ -z "$NGINX_CONFIG" ] && echo "NGINX_CONFIG is required" && exit 1 || true
+COPY $NGINX_CONFIG /etc/nginx/conf.d/default.conf
+
+# Entry point to provide Run Time Environment Variables for the App.
+ENTRYPOINT ["/usr/local/bin/env-runtime.entrypoint.sh"]
+
+CMD ["nginx", "-g", "daemon off;"]

package/src/configs/docker/Dockerfile.release

@@ -0,0 +1,28 @@
+ARG VERSION
+ARG REPO_NAME
+
+FROM gcr.io/toptal-hub/${REPO_NAME}:${VERSION} as builder
+
+FROM nginx:alpine
+
+ARG ENV_RUNTIME_ENTRYPOINT
+
+COPY --from=builder /app/dist /usr/share/nginx/html
+COPY --from=builder /app/node_modules/@toptal/davinci-ci/src/configs/docker/nginx-vhost.conf /etc/nginx/conf.d/default.conf
+
+# Remove source maps from the production build
+RUN find /usr/share/nginx/html -name "*.map" -type f -delete
+
+# Copy the entrypoint to prepare env variables
+# example davinci/packages/ci/scr/configs/docker/env-runtime.entrypoint.sh
+COPY ${ENV_RUNTIME_ENTRYPOINT} /usr/local/bin/env-runtime.entrypoint.sh
+
+# version is used in build process, so the value won't be available here otherwise
+ARG VERSION
+ENV DAVINCI_RELEASE_VERSION $VERSION
+
+RUN echo $VERSION > /usr/share/nginx/html/REVISION.txt
+
+ENTRYPOINT ["/usr/local/bin/env-runtime.entrypoint.sh"]
+
+CMD ["nginx", "-g", "daemon off;"]

package/src/configs/docker/Dockerfile.storybook

@@ -0,0 +1,20 @@
+# Create the image with Nginx environment.
+FROM nginx:alpine
+
+# Copy results from the dist folder to the image.
+ARG DIST_FOLDER
+RUN [ -z "$DIST_FOLDER" ] && echo "DIST_FOLDER is required" && exit 1 || true
+COPY $DIST_FOLDER /usr/share/nginx/html/storybook
+
+# version is used in build process, so the value won't be available here otherwise
+ARG VERSION
+RUN [ -z "$VERSION" ] && echo "VERSION is required" && exit 1 || true
+
+RUN echo $VERSION > /usr/share/nginx/html/REVISION.txt
+
+# Copy configuration file for Nginx and replace the default one.
+ARG NGINX_CONFIG
+RUN [ -z "$NGINX_CONFIG" ] && echo "NGINX_CONFIG is required" && exit 1 || true
+COPY $NGINX_CONFIG /etc/nginx/conf.d/default.conf
+
+CMD ["nginx", "-g", "daemon off;"]

package/src/configs/docker/env-runtime.entrypoint.sh

@@ -0,0 +1,47 @@
+#!/bin/sh -e
+
+# This bash script takes required Environment Variables of current process
+# and put them into `index.html` file which is an entry-point of the application.
+# By this way we provide run time variables to a precompiled JS code.
+
+# This is how a place which contains `run time` variables may look in `index.html`
+#
+# window.TP = {
+#   env: '%REACT_APP_ENV_NAME%',
+#   graphql_url: '%REACT_APP_GRAPHQL_URI%'
+# }
+
+# keep in sync with index.html
+VARS_PREFIX="DAVINCI_"
+INDEX_FILE="/usr/share/nginx/html/index.html"
+
+VARS="$(env | grep $VARS_PREFIX | awk -F = '{print $1}')"
+
+# trim whitespaces
+REQUIRED_VARS="$(echo "$VARS" | xargs -n1 | sed 's/^//g')"
+
+# trim whitespaces and prepend $ to every var above
+ENVSUBST_KNOWN_VARS="$(echo "$VARS" | xargs -n1 | sed 's/^/\$/g')"
+
+# replace all the placeholders %VARIABLE_NAME% with the actual value of the variable
+for placeholder in $REQUIRED_VARS
+do
+  value=`printenv "$placeholder"`
+  # any character after 's' in sed is used as a separator
+  # https://stackoverflow.com/a/16790877/1611414
+  sed -i "s|%${placeholder}%|$value|g" $INDEX_FILE
+done
+
+MISSING_VARS="$(cat $INDEX_FILE | grep "%$VARS_PREFIX.*%" | sed 's/.*%\(.*\)%.*/\1/g')"
+
+if [ -n "$MISSING_VARS" ]; then
+  for placeholder in $MISSING_VARS
+  do
+    if ! printenv "$placeholder" > /dev/null; then
+      echo "Variable '$placeholder' is not set. Exiting..."
+      exit 1
+    fi
+  done
+fi
+
+exec "$@"

package/src/configs/docker/nginx-vhost-storybook.conf

@@ -0,0 +1,20 @@
+server {
+  listen       80;
+  server_name  localhost;
+  root   /usr/share/nginx/html/storybook;
+
+  location / {
+    try_files $uri $uri/ index.html;
+    index index.html;
+  }
+
+  location ~ \.(js|png|svg|jpg|gif)$ {
+		try_files $uri $uri/ =404;
+	}
+
+  # redirect server error pages to the static page /50x.html
+  error_page   500 502 503 504  /50x.html;
+  location = /50x.html {
+    root   /usr/share/nginx/html;
+  }
+}

package/src/configs/docker/nginx-vhost.conf

@@ -0,0 +1,18 @@
+# When you are redirecting to any url, which is handled by react-router
+# on nginx we need special configuration to handle those
+# and don't just return 404
+server {
+  listen       80;
+  server_name  localhost;
+  
+  index index.html;
+  root   /usr/share/nginx/html;
+
+  location ~ \.(js|css)$ {
+    # allow returning 404s for assets
+  }
+
+  location / {
+    try_files $uri /index.html;
+  }
+}

package/src/configs/jobs/build-image/Jenkinsfile

@@ -0,0 +1,142 @@
+@Library('globalLibrary@master') _
+
+image = null
+
+repositoryName =  REPOSITORY_NAME
+repositorySSHUrl = "git@github.com:toptal/${repositoryName}.git"
+env.REPO_NAME_FOR_COMMIT = "toptal/${repositoryName}"
+
+pipeline {
+  agent { label 'slave_aws' }
+
+  options {
+    ansiColor('xterm')
+    timestamps()
+    timeout(time: params.TIMEOUT, unit: 'MINUTES')
+    buildDiscarder(logRotator(numToKeepStr: '20'))
+    skipDefaultCheckout()
+  }
+
+  parameters {
+    string(name: 'BRANCH', defaultValue: 'master', description: 'Branch or tag to build')
+    string(name: 'IMAGE_NAME', description: 'Image name')
+    string(name: 'VERSION', description: 'Tag for the created docker image')
+    string(name: 'ALIAS_VERSIONS', defaultValue: "", description: 'Comma separated list of alias tags for the created docker image. Ex: "master,latest"')
+    string(name: 'REPOSITORY_NAME', description: 'Repository name')
+    string(name: 'DAVINCI_BRANCH', defaultValue: 'master', description: 'Davinci branch to checkout')
+    string(name: 'TIMEOUT', defaultValue: '25', description: 'Timeout value for the job (in minutes)')
+  }
+
+  environment {
+    GCE_ACCOUNT_KEY = credentials('jenkins-storage-administrator')
+    NPM_TOKEN = credentials('npm-token-for-toptal-private-registry')
+  }
+
+  stages {
+
+    stage('Git checkouts') {
+      parallel {
+
+        stage('Git checkout project') {
+          steps {
+            dir(repositoryName) {
+              info "== Checking out ${BRANCH} =="
+              gitCheckout(
+                branches: BRANCH,
+                credentials: [username: 'toptal-build', description: "toptal-build-ssh-key"],
+                url: repositorySSHUrl,
+                additionalBehaviours: [
+                  cleanBeforeCheckout: true
+                ])
+              script { env.COMMIT_FOR_ANVIL = gitCommit() }
+              success "== Checked out ${BRANCH} at ${gitCommit()}"
+            }
+          }
+        } //checkout project
+
+        stage('Git checkout davinci') {
+          steps {
+            dir('davinci') {
+              info "== Checking out davinci=="
+              gitCheckout(
+                branches: DAVINCI_BRANCH,
+                credentials: [username: 'toptal-build', description: "toptal-build-ssh-key"],
+                url: 'git@github.com:toptal/davinci.git',
+                additionalBehaviours: [
+                  cleanBeforeCheckout: true,
+                ])
+              success "== Checked out"
+            }
+          }
+        } //checkout davinci
+
+     } // parallel
+    } //checkout
+
+    stage('Build image') {
+      steps {
+        script {
+          sh "gcloud auth activate-service-account --key-file=$GCE_ACCOUNT_KEY"
+
+          if (!isDockerImagePresentRemotely("gcr.io/toptal-hub/${IMAGE_NAME}", VERSION)) {
+            image = docker.build(
+              "toptal-hub/${IMAGE_NAME}:${VERSION}",
+              """-f ./davinci/packages/ci/src/configs/docker/Dockerfile \
+              --build-arg NPM_TOKEN=${NPM_TOKEN} \
+              ./${repositoryName}"""
+            )
+            success "== Built image for version ${VERSION} =="
+          } else {
+            success "== Found image for version ${VERSION} =="
+          }
+
+          if (!isDockerImagePresentRemotely("us-central1-docker.pkg.dev/toptal-hub/containers/${IMAGE_NAME}", VERSION)) {
+            image = docker.build(
+              "us-central1-docker.pkg.dev/toptal-hub/containers/${IMAGE_NAME}:${VERSION}",
+              """-f ./davinci/packages/ci/src/configs/docker/Dockerfile \
+              --build-arg NPM_TOKEN=${NPM_TOKEN} \
+              ./${repositoryName}"""
+            )
+            success "== Built image for version ${VERSION} =="
+          } else {
+            success "== Found image for version ${VERSION} =="
+          }
+        }
+      }
+    } //build image
+
+    stage('Push image') {
+      steps {
+        script {
+          if (image) {
+            docker.withRegistry('https://gcr.io/toptal-hub/') {
+              image.push(VERSION)
+              if(ALIAS_VERSIONS) {
+                ALIAS_VERSIONS.split(',').each { aliasVersion ->
+                  image.push(aliasVersion)
+                }
+              }
+            }
+            docker.withRegistry('us-central1-docker.pkg.dev/toptal-hub/containers/') {
+              image.push(VERSION)
+              if(ALIAS_VERSIONS) {
+                ALIAS_VERSIONS.split(',').each { aliasVersion ->
+                  image.push(aliasVersion)
+                }
+              }
+            }
+            success "== Pushed image with tag ${VERSION} =="
+          }
+        }
+      }
+    } //push image
+  }
+
+  post {
+    always {
+      script {
+        sendBuildData(currentBuild)
+      }
+    }
+  }
+}

package/src/configs/jobs/build-image/config.xml

@@ -0,0 +1,119 @@
+<flow-definition plugin="workflow-job@2.35">
+  <actions>
+    <org.jenkinsci.plugins.pipeline.modeldefinition.actions.DeclarativeJobAction plugin="pipeline-model-definition@1.3.9"/>
+    <org.jenkinsci.plugins.pipeline.modeldefinition.actions.DeclarativeJobPropertyTrackerAction plugin="pipeline-model-definition@1.3.9">
+      <jobProperties>
+        <string>jenkins.model.BuildDiscarderProperty</string>
+      </jobProperties>
+      <triggers/>
+      <parameters>
+        <string>BRANCH</string>
+        <string>IMAGE_NAME</string>
+        <string>VERSION</string>
+        <string>ALIAS_VERSIONS</string>
+        <string>REPOSITORY_NAME</string>
+        <string>DAVINCI_BRANCH</string>
+        <string>TIMEOUT</string>
+      </parameters>
+      <options>
+        <string>skipDefaultCheckout</string>
+      </options>
+    </org.jenkinsci.plugins.pipeline.modeldefinition.actions.DeclarativeJobPropertyTrackerAction>
+  </actions>
+  <description></description>
+  <keepDependencies>false</keepDependencies>
+  <properties>
+    <hudson.model.ParametersDefinitionProperty>
+      <parameterDefinitions>
+        <hudson.model.StringParameterDefinition>
+          <name>BRANCH</name>
+          <description>Branch or tag to build</description>
+          <defaultValue>master</defaultValue>
+          <trim>false</trim>
+        </hudson.model.StringParameterDefinition>
+        <hudson.model.StringParameterDefinition>
+          <name>IMAGE_NAME</name>
+          <description>Image name</description>
+          <trim>false</trim>
+        </hudson.model.StringParameterDefinition>
+        <hudson.model.StringParameterDefinition>
+          <name>VERSION</name>
+          <description>Tag for the created docker image</description>
+          <trim>false</trim>
+        </hudson.model.StringParameterDefinition>
+        <hudson.model.StringParameterDefinition>
+          <name>ALIAS_VERSIONS</name>
+          <description>Comma separated list of alias tags for the created docker image. Ex: "master,latest"</description>
+          <defaultValue></defaultValue>
+          <trim>false</trim>
+        </hudson.model.StringParameterDefinition>
+        <hudson.model.StringParameterDefinition>
+          <name>REPOSITORY_NAME</name>
+          <description>Repository name</description>
+          <trim>false</trim>
+        </hudson.model.StringParameterDefinition>
+        <hudson.model.StringParameterDefinition>
+          <name>DAVINCI_BRANCH</name>
+          <description>Davinci branch to checkout</description>
+          <defaultValue>master</defaultValue>
+          <trim>false</trim>
+        </hudson.model.StringParameterDefinition>
+        <hudson.model.StringParameterDefinition>
+          <name>TIMEOUT</name>
+          <description>Timeout value for the job (in minutes)</description>
+          <defaultValue>25</defaultValue>
+          <trim>false</trim>
+        </hudson.model.StringParameterDefinition>
+      </parameterDefinitions>
+    </hudson.model.ParametersDefinitionProperty>
+    <jenkins.model.BuildDiscarderProperty>
+      <strategy class="hudson.tasks.LogRotator">
+        <daysToKeep>-1</daysToKeep>
+        <numToKeep>20</numToKeep>
+        <artifactDaysToKeep>-1</artifactDaysToKeep>
+        <artifactNumToKeep>-1</artifactNumToKeep>
+      </strategy>
+    </jenkins.model.BuildDiscarderProperty>
+    <hudson.plugins.jira.JiraProjectProperty plugin="jira@3.0.7"/>
+    <com.sonyericsson.jenkins.plugins.bfa.model.ScannerJobProperty plugin="build-failure-analyzer@1.20.0">
+      <doNotScan>false</doNotScan>
+    </com.sonyericsson.jenkins.plugins.bfa.model.ScannerJobProperty>
+    <com.coravy.hudson.plugins.github.GithubProjectProperty plugin="github@1.29.4">
+      <projectUrl>$PROJECT_URL</projectUrl>
+      <displayName></displayName>
+    </com.coravy.hudson.plugins.github.GithubProjectProperty>
+    <hudson.plugins.throttleconcurrents.ThrottleJobProperty plugin="throttle-concurrents@2.0.1">
+      <maxConcurrentPerNode>0</maxConcurrentPerNode>
+      <maxConcurrentTotal>0</maxConcurrentTotal>
+      <categories class="java.util.concurrent.CopyOnWriteArrayList"/>
+      <throttleEnabled>false</throttleEnabled>
+      <throttleOption>project</throttleOption>
+      <limitOneJobWithMatchingParams>false</limitOneJobWithMatchingParams>
+      <paramsToUseForLimit></paramsToUseForLimit>
+      <configVersion>1</configVersion>
+    </hudson.plugins.throttleconcurrents.ThrottleJobProperty>
+  </properties>
+  <definition class="org.jenkinsci.plugins.workflow.cps.CpsScmFlowDefinition" plugin="workflow-cps@2.74">
+    <scm class="hudson.plugins.git.GitSCM" plugin="git@3.10.1">
+      <configVersion>2</configVersion>
+      <userRemoteConfigs>
+        <hudson.plugins.git.UserRemoteConfig>
+          <url>git@github.com:toptal/davinci.git</url>
+          <credentialsId>$CREDENTIALS_ID</credentialsId>
+        </hudson.plugins.git.UserRemoteConfig>
+      </userRemoteConfigs>
+      <branches>
+        <hudson.plugins.git.BranchSpec>
+          <name>master</name>
+        </hudson.plugins.git.BranchSpec>
+      </branches>
+      <doGenerateSubmoduleConfigurations>false</doGenerateSubmoduleConfigurations>
+      <submoduleCfg class="list"/>
+      <extensions/>
+    </scm>
+    <scriptPath>packages/ci/src/configs/jobs/build-image/Jenkinsfile</scriptPath>
+    <lightweight>true</lightweight>
+  </definition>
+  <triggers/>
+  <disabled>false</disabled>
+</flow-definition>

package/src/configs/jobs/build-release-image/Jenkinsfile

@@ -0,0 +1,154 @@
+@Library('globalLibrary@master') _
+
+ghHelper = new helpers.GithubNotifyHelper()
+helper = new helpers.Helpers()
+
+release_docker_image = null
+
+repositoryName = REPOSITORY_NAME
+repositorySSHUrl = "git@github.com:toptal/${repositoryName}.git"
+releaseImageName = "${repositoryName}-release"
+env.REPO_NAME_FOR_COMMIT = "toptal/${repositoryName}"
+
+pipeline {
+  agent { label 'slave_aws' }
+
+  options {
+    ansiColor('xterm')
+    timestamps()
+    timeout(time: 15, unit: 'MINUTES')
+    buildDiscarder(logRotator(daysToKeepStr: '5'))
+    skipDefaultCheckout()
+  }
+
+  parameters {
+    string(name: 'BRANCH', defaultValue: 'master', description: 'Branch or tag to build')
+    string(name: 'DAVINCI_BRANCH', defaultValue: 'master', description: 'Davinci branch')
+    string(name: 'IMAGE_TAG', description: 'Docker tag of the image with dist folder which we are going to deploy')
+    string(name: 'ALIAS_IMAGE_TAGS', defaultValue: "", description: 'Comma separated list of alias tags for the created docker image. Ex: "master,latest"')
+    string(name: 'REPOSITORY_NAME', description: 'Repository name')
+  }
+
+  environment {
+    GCE_ACCOUNT_KEY = credentials('jenkins-storage-administrator')
+  }
+
+  stages {
+    stage('Git checkouts') {
+      parallel {
+
+        stage('Git checkout project') {
+          steps {
+            dir(repositoryName) {
+              info "== Checking out ${BRANCH} =="
+              gitCheckout(
+                branches: BRANCH,
+                credentials: [username: 'toptal-build', description: "toptal-build-ssh-key"],
+                url: repositorySSHUrl,
+                additionalBehaviours: [
+                  cleanBeforeCheckout: true
+                ])
+              script { env.COMMIT_FOR_ANVIL = gitCommit() }
+              success "== Checked out ${BRANCH} at ${gitCommit()}"
+            }
+          }
+        } //checkout project
+
+        stage('Git checkout davinci') {
+          steps {
+            dir('davinci') {
+              info "== Checking out davinci=="
+              gitCheckout(
+                branches: DAVINCI_BRANCH,
+                credentials: [username: 'toptal-build', description: "toptal-build-ssh-key"],
+                url: 'git@github.com:toptal/davinci.git',
+                additionalBehaviours: [
+                  cleanBeforeCheckout: true,
+                ])
+              success "== Checked out"
+            }
+          }
+        } //checkout davinci
+
+      } // parallel
+    } //checkout
+
+    stage('Build docker image') {
+      steps {
+        info "== Building new docker image"
+        script {
+          sh "gcloud auth activate-service-account --key-file=$GCE_ACCOUNT_KEY"
+          sh "cp ./davinci/packages/ci/src/configs/docker/env-runtime.entrypoint.sh ./${repositoryName}/env-runtime.entrypoint.sh"
+
+          if (!isDockerImagePresentRemotely("gcr.io/toptal-hub/${releaseImageName}", IMAGE_TAG)) {
+            release_docker_image = docker.build(
+              "gcr.io/toptal-hub/${releaseImageName}:${IMAGE_TAG}",
+              """-f ./davinci/packages/ci/src/configs/docker/Dockerfile.release \
+              --build-arg REPO_NAME=${repositoryName} \
+              --build-arg VERSION=${IMAGE_TAG} \
+              --build-arg ENV_RUNTIME_ENTRYPOINT=./env-runtime.entrypoint.sh \
+              ./${repositoryName}"""
+            )
+            success "== Built '${releaseImageName}' image for version ${IMAGE_TAG} =="
+          } else {
+            success "== Found '${releaseImageName}' image for version ${IMAGE_TAG} =="
+          }
+
+          if (!isDockerImagePresentRemotely("us-central1-docker.pkg.dev/toptal-hub/containers/${releaseImageName}", IMAGE_TAG)) {
+            release_docker_image = docker.build(
+              "us-central1-docker.pkg.dev/toptal-hub/containers/${releaseImageName}:${IMAGE_TAG}",
+              """-f ./davinci/packages/ci/src/configs/docker/Dockerfile.release \
+              --build-arg REPO_NAME=${repositoryName} \
+              --build-arg VERSION=${IMAGE_TAG} \
+              --build-arg ENV_RUNTIME_ENTRYPOINT=./env-runtime.entrypoint.sh \
+              ./${repositoryName}"""
+            )
+            success "== Built '${releaseImageName}' image for version ${IMAGE_TAG} =="
+          } else {
+            success "== Found '${releaseImageName}' image for version ${IMAGE_TAG} =="
+          }
+        }
+      } //steps
+
+      post {
+        always {
+          sh "rm ./${repositoryName}/env-runtime.entrypoint.sh"
+        }
+      }
+    } //stage
+
+    stage('Push docker image for release') {
+      steps {
+        script {
+          if (release_docker_image) {
+            docker.withRegistry('https://gcr.io/toptal-hub/') {
+              release_docker_image.push(IMAGE_TAG)
+               if(ALIAS_IMAGE_TAGS) {
+                ALIAS_IMAGE_TAGS.split(',').each { aliasImageTag ->
+                  release_docker_image.push(aliasImageTag)
+                }
+              }
+            }
+            docker.withRegistry('us-central1-docker.pkg.dev/toptal-hub/containers/') {
+              release_docker_image.push(IMAGE_TAG)
+               if(ALIAS_IMAGE_TAGS) {
+                ALIAS_IMAGE_TAGS.split(',').each { aliasImageTag ->
+                  release_docker_image.push(aliasImageTag)
+                }
+              }
+            }
+            success "== Pushed '${releaseImageName}' image for version ${IMAGE_TAG} =="
+          }
+        }
+      }  //steps
+    } //stage
+  }//stages
+
+  post {
+    always {
+      script {
+        sendBuildData(currentBuild)
+      }
+    }
+  }
+}//pipeline