@toptal/davinci-ci 7.3.2 → 7.4.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 7.4.0
+
+### Minor Changes
+
+- [#2368](https://github.com/toptal/davinci/pull/2368) [`676ef4fd`](https://github.com/toptal/davinci/commit/676ef4fdc68cee6766903fb811274c470bf3a5ee) Thanks [@sashuk](https://github.com/sashuk)!
+- add ability to override environment variables by reading environment files
+
 ## 7.3.2
 
 ### Patch Changes

package/README.md

@@ -85,6 +85,8 @@ The image is present on path `src/configs/docker/Dockerfile.gha-deploy` and have
 | `NGINX_CONFIG`           | Ngninx config, davinci has an example file present at `src/configs/docker/nginx-vhost.conf`              | Yes      |
 | `HTML_CDN_CACHE_TAG`     | `Cache-Tag` header for HTML documents, used for specific cache purging                                   | No       |
 
+The default entrypoint `src/configs/docker/env-runtime.entrypoint.sh` reads environment file (`.env.$DAVINCI_ENV` has to be located in the root of the dist folder) and populates the environment variables with values from the file if the overriden environment variable is not set. Variables that are provided to `docker run` command (for example, `docker run -e DAVINCI_envvar1=1`) have higher priority that variables from the envrionment file.
+
 ### IDE Tooling
 
 This package can be used directly in your IDE through these extensions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-ci",
-  "version": "7.3.2",
+  "version": "7.4.0",
   "keywords": [
     "ci",
     "docker",

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

@@ -15,6 +15,10 @@ RUN [ -z "$ENV_RUNTIME_ENTRYPOINT" ] && echo "ENV_RUNTIME_ENTRYPOINT is required
 COPY $ENV_RUNTIME_ENTRYPOINT /usr/local/bin/env-runtime.entrypoint.sh
 RUN chmod +x /usr/local/bin/env-runtime.entrypoint.sh
 
+# Copy script that reads .env file and replaces DAVINCI_* environment variables if they are empty
+COPY ./davinci/packages/ci/src/configs/docker/import-davinci-environment-file.sh /usr/local/bin/import-davinci-environment-file.sh
+RUN chmod +x /usr/local/bin/import-davinci-environment-file.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

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

@@ -13,7 +13,11 @@
 
 # keep in sync with index.html
 VARS_PREFIX="DAVINCI_"
-INDEX_FILE="/usr/share/nginx/html/index.html"
+DIST_PATH="/usr/share/nginx/html"
+INDEX_FILE="$DIST_PATH/index.html"
+
+# import environment variables from .env.DAVINCI_ENV file depending
+source import-davinci-environment-file.sh
 
 VARS="$(env | grep $VARS_PREFIX | awk -F = '{print $1}')"
 

package/src/configs/docker/import-davinci-environment-file.sh

@@ -0,0 +1,31 @@
+#!/bin/sh -e
+
+# Reads environment variables from .env.$DAVINCI_ENV file and overrides every empty
+# variable in the existing environment
+# See import-davinci-environment-file.test.sh for testing
+
+if [ -z "$DAVINCI_ENV" ]; then
+    echo "Error: DAVINCI_ENV is empty"
+    exit 1
+fi
+
+if [ -z "$DIST_PATH" ]; then
+    echo "Error: DIST_PATH is empty"
+    exit 1
+fi
+
+ENV_FILE="$DIST_PATH/.env.$DAVINCI_ENV"
+if [ -f "$ENV_FILE" ]; then
+    echo "Info: $ENV_FILE exists, importing variables..."
+
+    # Store current environment variables
+    OLD_ENV="$(export -p)"
+
+    # Load env file variables
+    export $(grep -v '^#' $ENV_FILE | xargs)
+
+    # Override env variables with previous values
+    eval "$OLD_ENV"    
+else 
+    echo "Info: $ENV_FILE does not exist"
+fi

package/src/configs/docker/import-davinci-environment-file.test.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+# How to run test:
+# - navigate to this folder in bash
+# - run script "./import-davinci-environment-variables.test.sh", there should be no lines with "Assertion failed"
+
+# Set up test environment
+export TMP_PATH="./tmp"
+mkdir -p "$TMP_PATH"
+export DIST_PATH="$TMP_PATH"
+
+# Set up console colors
+RED='\033[0;31m'
+NC='\033[0m'
+
+############
+# Test case:
+# - EMPTY_VARIALBE_ABC value is replaced with value from .env.staging if the value in .env.staging is not empty
+# - EMPTY_VARIALBE_DEF value stays empty as the value in .env.staging is empty
+# - NON_EMPTY_VARIABLE value is not replaced with value from .env.staging
+############
+
+export DAVINCI_ENV="staging"
+export NON_EMPTY_VARIABLE="123"
+printf "%s\n" "EMPTY_VARIALBE_ABC=from-env-file" "EMPTY_VARIALBE_DEF=" "NON_EMPTY_VARIABLE=from-env-file" "RANDOM_VARIABLE=456" > "$DIST_PATH/.env.$DAVINCI_ENV"
+
+set -a
+source import-davinci-environment-file.sh
+
+if [ "$EMPTY_VARIALBE_ABC" != "from-env-file" ]; then
+    echo -e "${RED}Assertion failed:${NC} EMPTY_VARIALBE_ABC is not equal to expected_value (received \"$EMPTY_VARIALBE_ABC\")"
+    exit 1
+fi
+
+if [ "$EMPTY_VARIALBE_DEF" != "" ]; then
+    echo -e "${RED}Assertion failed:${NC} EMPTY_VARIALBE_DEF is not equal to expected_value (received \"$EMPTY_VARIALBE_DEF\")"
+    exit 1
+fi
+
+if [ "$NON_EMPTY_VARIABLE" != "123" ]; then
+    echo -e "${RED}Assertion failed:${NC} NON_EMPTY_VARIABLE is not equal to expected_value"
+    exit 1
+fi
+
+# Clean up test environment
+rm -rf "$TMP_PATH"
+
+###########
+# Test case: environment file does not exist
+###########
+command_output=$(source import-davinci-environment-file.sh)
+
+if [ "$command_output" != "Info: $DIST_PATH/.env.$DAVINCI_ENV does not exist" ]; then
+    echo -e "${RED}Assertion failed:${NC} command_output is not equal to expected_value (received \"$command_output\")"
+    exit 1
+fi

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

@@ -18,4 +18,9 @@ server {
     add_header Cache-Tag "davinci,spa,index-doc,${HTML_CDN_CACHE_TAG}";
     try_files $uri /index.html;
   }
+
+  # forbid environment files download
+  location ~ ^/\.env\. {
+    deny all;
+  }
 }