chore: test the image we build using semantic versioning

stop building the image in our integration tests' setup.
instead, expect the image to be already built and available, and receive its tag in an environment variable.

in local or pull-request runs, build a temporary image with the "local" tag, and use it for the tests. (called from "npm pretest" rule)

in merge-to-staging scenario, build an image, tag it as snyk/k8s-monitor:<new-semrel-version>-candidate, and test it.
if everything passes, re-tag it as snyk/k8s-monitor:<new-semrel-version>-approved.

in merge-to-master scenario, fetch the job commit's latest tag and re-tag it to just snyk/k8s-monitor:<new-semrel-version>.

Author: Shesekino

.travis.yml

@@ -19,30 +19,50 @@ install:
   - npm install
 jobs:
   include:
+######################## PR TO STAGING ########################
     # PR tests for staging branch
     - stage: Test-PR-staging
       if: branch = staging AND type = pull_request
       script: npm run test
       name: kubernetes-monitor PR tests
-    # merge tests before building the product on staging branch
-    - stage: Test-Merge-staging
+######################## MERGE TO STAGING ########################
+    - stage: test-and-build
       if: branch = staging AND type = push
-      script: npm run test # TODO: only check linting, unittest
-      name: kubernetes-monitor merge initial tests
-    # building the product on staging branch after merging
-    - stage: Build
-      if: branch = staging AND type = push
-      # we will need to change the tag to test-candidate, then use the image, then re-tag to test-approved
-      script: docker login --username ${DOCKERHUB_USER} --password ${DOCKERHUB_PASSWORD} && docker build -t snyk/kubernetes-monitor:test-approved --no-cache . && docker push snyk/kubernetes-monitor:test-approved && ./scripts/slack-notify-push.sh test-approved
-      name: build the kubernetes-monitor image
-      # TODO: run integration tests with the image we just built, then mark it as test-passed
+      script: npm run lint &&
+              npm run build &&
+              npm run test:unit &&
+              docker login --username ${DOCKERHUB_USER} --password ${DOCKERHUB_PASSWORD} &&
+              npx semantic-release &&
+              NEW_VERSION=`cat ./package.json | jq -r '.version'` &&
+              IMAGE_NAME_CANDIDATE=snyk/kubernetes-monitor:${NEW_VERSION}-candidate &&
+              ./scripts/build-image.sh ${IMAGE_NAME_CANDIDATE} &&
+              docker push ${IMAGE_NAME_CANDIDATE} &&
+              ./scripts/slack-notify-push.sh ${IMAGE_NAME_CANDIDATE} &&
+              KUBERNETES_MONITOR_IMAGE_NAME_AND_TAG=${IMAGE_NAME_CANDIDATE} npm run test:integration &&
+              IMAGE_NAME_APPROVED=snyk/kubernetes-monitor:${NEW_VERSION}-approved &&
+              docker tag ${IMAGE_NAME_CANDIDATE} ${IMAGE_NAME_APPROVED} &&
+              docker push ${IMAGE_NAME_APPROVED} &&
+              ./scripts/slack-notify-push.sh ${IMAGE_NAME_APPROVED}
+      name: Test and Build
+######################## PR TO MASTER ########################
     - stage: pre-publish
       if: branch = master AND type = pull_request AND head_branch = staging
       script: ./scripts/slack-notify-pr.sh
       name: pre-publish notification
+######################## MERGE TO MASTER ########################
     - stage: Publish
       if: branch = master AND type = push
-      script: docker login --username ${DOCKERHUB_USER} --password ${DOCKERHUB_PASSWORD} && docker pull snyk/kubernetes-monitor:test-approved && docker tag snyk/kubernetes-monitor:test-approved snyk/kubernetes-monitor:latest && docker push snyk/kubernetes-monitor:latest && ./scripts/slack-notify-push.sh latest
+      script: LATEST_TAG=`git describe --abbrev=0 --tags ${TRAVIS_COMMIT}` &&
+              IMAGE_NAME_APPROVED=snyk/kubernetes-monitor:${LATEST_TAG}-approved &&
+              IMAGE_NAME_PUBLISHED=snyk/kubernetes-monitor:${LATEST_TAG} &&
+              docker login --username ${DOCKERHUB_USER} --password ${DOCKERHUB_PASSWORD} &&
+              docker pull ${IMAGE_NAME_APPROVED} &&
+              docker tag ${IMAGE_NAME_APPROVED} ${IMAGE_NAME_PUBLISHED} &&
+              docker push ${IMAGE_NAME_PUBLISHED} &&
+              ./scripts/slack-notify-push.sh ${IMAGE_NAME_PUBLISHED} &&
+              docker tag ${IMAGE_NAME_APPROVED} snyk/kubernetes-monitor:latest &&
+              docker push ${IMAGE_NAME_PUBLISHED} &&
+              ./scripts/slack-notify-push.sh snyk/kubernetes-monitor:latest
       name: publish the kubernetes-monitor (npm, container, helm)
 branches:
   only:

package.json

@@ -3,6 +3,7 @@
   "description": "Snyk kubernetes Monitioring Container",
   "main": "dist/index.js",
   "scripts": {
+    "pretest": "./scripts/build-image.sh",
     "test": "npm run lint && npm run test:unit && npm run test:integration",
     "test:unit": "./tap test/unit -R spec",
     "test:integration": "./tap test/integration -Rdot --timeout=600",
@@ -62,6 +63,7 @@
     "url": "https://github.com/snyk/kubernetes-monitor.git"
   },
   "release": {
+    "branch": "staging",
     "verifyConditions": [
       "@semantic-release/github"
     ],

scripts/build-image.sh

@@ -0,0 +1,11 @@
+#! /bin/bash
+
+# default value for our name and tag, when we don't want to push the image
+# for example when testing locally or on opening a PR
+LOCAL_DISCARDABLE_IMAGE=snyk/kubernetes-monitor:local
+
+# allow overriding name and tag, when we intend to push the image
+# should happen on merging to `staging`
+NAME_AND_TAG=${1:-$LOCAL_DISCARDABLE_IMAGE}
+
+docker build -t ${NAME_AND_TAG} .

scripts/slack-notify-push.sh

@@ -1,2 +1,2 @@
 #! /bin/bash
-curl -X POST -H 'Content-Type:application/json' -d '{"attachments": [{"color": "warning", "fallback": "Build Notification: $TRAVIS_BUILD_WEB_URL", "title": "Kubernetes-Monitor Publish Notification", "text": ":egg_fancy: Published Kubernetes-Monitor with tag: '$1' :egg_fancy:"}]}' $SLACK_WEBHOOK
+curl -X POST -H 'Content-Type:application/json' -d '{"attachments": [{"color": "warning", "fallback": "Build Notification: $TRAVIS_BUILD_WEB_URL", "title": "Kubernetes-Monitor Publish Notification", "text": ":egg_fancy: Published Kubernetes-Monitor: `'$1'` :egg_fancy:"}]}' $SLACK_WEBHOOK

test/setup.ts

@@ -98,13 +98,7 @@ async function exportKubeConfig(clusterName = 'kind'): Promise<void> {
   console.log('Exported K8s config!');
 }
 
-async function buildDockerImage(imageNameAndTag = 'snyk-k8s-monitor:test'): Promise<void> {
-  console.log('Building kubernetes-monitor Docker image...');
-  await exec(`docker build -t ${imageNameAndTag} --no-cache .`);
-  console.log('Built Docker image!');
-}
-
-async function loadImageInCluster(imageNameAndTag = 'snyk-k8s-monitor:test'): Promise<void> {
+async function loadImageInCluster(imageNameAndTag): Promise<void> {
   console.log(`Loading image ${imageNameAndTag} in cluster...`);
   await exec(`./kind load docker-image ${imageNameAndTag}`);
   console.log(`Loaded image ${imageNameAndTag}!`);
@@ -147,12 +141,12 @@ export async function getDeloymentJson(deploymentName: string, namespace: string
   return JSON.parse(getDeploymentResult.stdout);
 }
 
-function createTestYamlDeployment(newYamlPath: string, integrationId: string): void {
+function createTestYamlDeployment(newYamlPath: string, integrationId: string, imageNameAndTag: string): void {
   console.log('Creating test deployment...');
   const originalDeploymentYaml = readFileSync('./snyk-monitor-deployment.yaml', 'utf8');
   const deployment = parse(originalDeploymentYaml);
 
-  deployment.spec.template.spec.containers[0].image = 'snyk-k8s-monitor:test';
+  deployment.spec.template.spec.containers[0].image = imageNameAndTag;
   deployment.spec.template.spec.containers[0].imagePullPolicy = 'Never';
 
   // This is important due to an odd bug when running on Travis.
@@ -241,6 +235,12 @@ async function cleanUpMonitorSetup(): Promise<void> {
 }
 
 Test.prototype.deployMonitor = async (): Promise<string> => {
+  let imageNameAndTag = process.env['KUBERNETES_MONITOR_IMAGE_NAME_AND_TAG'];
+  if (imageNameAndTag === undefined || imageNameAndTag === '') {
+    // the default, determined by ./script/build-image.sh
+    imageNameAndTag = 'snyk/kubernetes-monitor:local';
+  }
+
   const k8sRelease = await getLatestStableK8sRelease();
   const osDistro = platform();
 
@@ -250,8 +250,7 @@ Test.prototype.deployMonitor = async (): Promise<string> => {
   await createKindCluster();
   await exportKubeConfig();
 
-  await buildDockerImage();
-  await loadImageInCluster();
+  await loadImageInCluster(imageNameAndTag);
 
   const namespace = 'snyk-monitor';
   await createNamespace(namespace);
@@ -270,7 +269,7 @@ Test.prototype.deployMonitor = async (): Promise<string> => {
   await createDeploymentFromImage('alpine-from-sha', someImageWithSha, servicesNamespace);
 
   const testYaml = 'snyk-monitor-test-deployment.yaml';
-  createTestYamlDeployment(testYaml, integrationId);
+  createTestYamlDeployment(testYaml, integrationId, imageNameAndTag);
 
   await applyK8sYaml('./snyk-monitor-cluster-permissions.yaml');
   await applyK8sYaml('./snyk-monitor-test-deployment.yaml');