Merge pull request #879 from amazeeio/841-disable-git-sha-injection

841 disable git sha injection

docs/using_lagoon/lagoon_yml.md

@@ -14,6 +14,9 @@ The `.lagoon.yml` file must be placed at the root of your git repository.
 ```
 docker-compose-yaml: docker-compose.yml
 
+environment_variables:
+  git_sha: 'true'
+
 tasks:
   pre-rollout:
     - run:
@@ -77,6 +80,9 @@ This allows you to define the behaviour of the automatic creates routes (NOT the
 * `Redirect` will redirect any http requests to https
 * `None` will mean a route for http will _not_ be created, and no redirect
 
+### `environment_variables.git_sha`
+This setting allows you to enable injecting the deployed git SHA into your project as an environment variable. By default this is disabled, setting the value to `true` then sets the SHA as the environment variable `LAGOON_GIT_SHA`.
+
 ## Tasks
 
 There are different type of tasks you can define, they differ when exactly they are executed in a build flow:

images/oc-build-deploy-dind/build-deploy.sh

@@ -18,8 +18,6 @@ else
   /oc-build-deploy/scripts/git-checkout-pull.sh "$SOURCE_REPOSITORY" "$GIT_REF"
 fi
 
-LAGOON_GIT_SHA=`git rev-parse HEAD`
-
 if [[ -n "$SUBFOLDER" ]]; then
   cd $SUBFOLDER
 fi
@@ -28,6 +26,14 @@ if [ ! -f .lagoon.yml ]; then
   echo "no .lagoon.yml file found"; exit 1;
 fi
 
+INJECT_GIT_SHA=$(cat .lagoon.yml | shyaml get-value environment_variables.git_sha false)
+if [ "$INJECT_GIT_SHA" == "true" ]
+then
+  LAGOON_GIT_SHA=`git rev-parse HEAD`
+else
+  LAGOON_GIT_SHA="0000000000000000000000000000000000000000"
+fi
+
 DOCKER_REGISTRY_TOKEN=$(cat /var/run/secrets/kubernetes.io/serviceaccount/token)
 
 docker login -u=jenkins -p="${DOCKER_REGISTRY_TOKEN}" ${OPENSHIFT_REGISTRY}

tests/files/drupal8-mariadb/.lagoon.yml

@@ -3,6 +3,9 @@ docker-compose-yaml: docker-compose.yml
 endpoint: 192.168.99.1:2020
 api: 192.168.99.1:3000
 
+environment_variables:
+  git_sha: 'true'
+
 tasks:
   post-rollout:
     - run:
@@ -47,4 +50,4 @@ environments:
         - name: drush cron
           schedule: "1 * * * *"
           command: drush cron
-          service: cli
+          service: cli

tests/files/drupal8-postgres/.lagoon.yml

@@ -3,6 +3,9 @@ docker-compose-yaml: docker-compose.yml
 endpoint: 192.168.99.1:2020
 api: 192.168.99.1:3000
 
+environment_variables:
+  git_sha: 'true'
+
 tasks:
   post-rollout:
     - run:
@@ -40,4 +43,4 @@ environments:
         - name: drush cron
           schedule: "1 * * * *"
           command: drush cron
-          service: cli
+          service: cli

tests/files/elasticsearch-cluster/.lagoon.yml

@@ -1 +1,4 @@
 docker-compose-yaml: docker-compose.yml
+
+environment_variables:
+  git_sha: 'true'

tests/files/elasticsearch/.lagoon.yml

@@ -1 +1,4 @@
 docker-compose-yaml: docker-compose.yml
+
+environment_variables:
+  git_sha: 'true'

tests/files/features-autogenerated-routes-disabled/.lagoon.yml

@@ -1,5 +1,8 @@
 docker-compose-yaml: docker-compose.yml
 
+environment_variables:
+  git_sha: 'true'
+
 routes:
   autogenerate:
     enabled: 'false'

tests/files/features-disable-inject-git-sha/.dockerignore

@@ -0,0 +1 @@
+node_modules

tests/files/features-disable-inject-git-sha/.lagoon.yml

@@ -0,0 +1 @@
+docker-compose-yaml: docker-compose.yml

tests/files/features-disable-inject-git-sha/Dockerfile

@@ -0,0 +1,18 @@
+ARG IMAGE_REPO
+FROM ${IMAGE_REPO:-amazeeio}/node:8-builder as builder
+COPY package.json yarn.lock /app/
+RUN yarn install
+
+FROM ${IMAGE_REPO:-amazeeio}/node:8
+COPY --from=builder /app/node_modules /app/node_modules
+COPY . /app/
+
+ARG LAGOON_GIT_SHA=0000000000000000000000000000000000000000
+ENV LAGOON_GIT_SHA_BUILDTIME ${LAGOON_GIT_SHA}
+
+ARG LAGOON_GIT_BRANCH=undefined
+ENV LAGOON_GIT_BRANCH_BUILDTIME ${LAGOON_GIT_BRANCH}
+
+EXPOSE 3000
+
+CMD ["yarn", "run", "start"]

tests/files/features-disable-inject-git-sha/docker-compose.yml

@@ -0,0 +1,23 @@
+version: '2'
+services:
+  node:
+    networks:
+      - amazeeio-network
+      - default
+    build:
+      context: .
+      dockerfile: Dockerfile
+    labels:
+      lagoon.type: node-persistent
+      lagoon.persistent: /files
+    volumes:
+      - ./index.js:/app/index.js:delegated
+    expose:
+      - "3000"
+    environment:
+      - AMAZEEIO_URL=node.docker.amazee.io
+      - AMAZEEIO=AMAZEEIO
+      - AMAZEEIO_HTTP_PORT=3000
+networks:
+  amazeeio-network:
+    external: true

tests/files/features-disable-inject-git-sha/index.js

@@ -0,0 +1,24 @@
+const express = require('express')
+const fs = require('fs');
+const app = express()
+
+app.get('/', async function (req, res) {
+  let result = []
+  Object.keys(process.env).map(key => {
+    result.push(`${key}=${process.env[key]}`)
+  })
+  result.sort()
+
+  try {
+    result.push(fs.readFileSync('/files/cron.txt').toString());
+  } catch (e) {
+    // intentionally left empty
+  }
+
+  res.send(result.join("<br />"))
+
+})
+
+app.listen(3000, function () {
+  console.log('Example app listening on port 3000!')
+})

tests/files/features-disable-inject-git-sha/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "node",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "express": "^4.15.3"
+  },
+  "scripts": {
+    "start": "node index.js"
+  }
+}