chore(tests): add bats tests (xenial) (#619)

* chore: initial sketch using bats tests

* chore: jenkinsfile target the main stage

* chore: add node_modules to .dockerignore

* chore(ci): update the GH workflow

* chore(tests): make it possible to run the tests via `docker run`

* chore(tests): cleaning up tests and helper functions

* chore(tests): extra comments to our node tests

Author: JGAntunes

.dockerignore

@@ -1 +1,2 @@
 tmp/
+node_modules

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Build Docker image
-        run: docker build . --build-arg NF_IMAGE_VERSION=$GITHUB_SHA -t netlify/build:$GITHUB_SHA
+        run: docker build . --build-arg NF_IMAGE_VERSION=$GITHUB_SHA  --target build-image -t netlify/build:$GITHUB_SHA
       - uses: vbrown608/whalescale@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

Dockerfile

@@ -1,4 +1,4 @@
-FROM ubuntu:16.04
+FROM ubuntu:16.04 as build-image
 
 LABEL maintainer Netlify
 
@@ -262,6 +262,7 @@ RUN git clone https://github.com/creationix/nvm.git ~/.nvm && \
     git checkout v$NVM_VERSION && \
     cd /
 
+# Install node.js, yarn, bower and elm
 ENV ELM_VERSION=0.19.0-bugfix6
 ENV YARN_VERSION=1.22.10
 
@@ -499,3 +500,23 @@ ENV NF_IMAGE_VERSION ${NF_IMAGE_VERSION:-latest}
 
 ARG NF_IMAGE_TAG
 ENV NF_IMAGE_TAG ${NF_IMAGE_TAG:-latest}
+
+
+################################################################################
+#
+# Test stage Dockerfile
+#
+################################################################################
+
+FROM build-image as build-image-test
+
+USER buildbot
+SHELL ["/bin/bash", "-c"]
+
+ADD --chown=buildbot package.json /opt/buildhome/test-env/package.json
+RUN cd /opt/buildhome/test-env && . ~/.nvm/nvm.sh && npm i &&\
+    ln -s /opt/build-bin/run-build-functions.sh /opt/buildhome/test-env/run-build-functions.sh &&\
+    ln -s /opt/build-bin/build /opt/buildhome/test-env/run-build.sh
+ADD --chown=buildbot tests /opt/buildhome/test-env/tests
+WORKDIR /opt/buildhome/test-env
+CMD . ~/.nvm/nvm.sh && npm test

Jenkinsfile

@@ -16,7 +16,7 @@ pipeline {
         anyOf { branch 'staging' ; branch 'xenial' ; branch 'trusty' ; buildingTag() }
       }
       steps {
-        sh "docker build --build-arg NF_IMAGE_VERSION=${env.GIT_COMMIT} --build-arg NF_IMAGE_TAG=${env.BRANCH_NAME} -t netlify/build:${env.BRANCH_NAME} -t netlify/build:${env.GIT_COMMIT} ."
+        sh "docker build --build-arg NF_IMAGE_VERSION=${env.GIT_COMMIT} --build-arg NF_IMAGE_TAG=${env.BRANCH_NAME} -t netlify/build:${env.BRANCH_NAME} -t netlify/build:${env.GIT_COMMIT} --target build-image ."
       }
     }
 
@@ -25,7 +25,7 @@ pipeline {
         anyOf { buildingTag() }
       }
       steps {
-        sh "docker build --build-arg NF_IMAGE_VERSION=${env.GIT_COMMIT} --build-arg NF_IMAGE_TAG=${env.BRANCH_NAME} --squash -t netlify/build:${env.BRANCH_NAME}-squash ."
+        sh "docker build --build-arg NF_IMAGE_VERSION=${env.GIT_COMMIT} --build-arg NF_IMAGE_TAG=${env.BRANCH_NAME} --squash -t netlify/build:${env.BRANCH_NAME}-squash --target build-image ."
       }
     }
 

package.json

@@ -4,7 +4,9 @@
   "description": "This repository contains the tools to make the build image Netlify uses to build a site from git (for continuous deployment)",
   "main": "index.js",
   "private": "true",
-  "scripts": {},
+  "scripts": {
+    "test": "bats --recursive --timing --tap tests"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/netlify/build-image.git"
@@ -15,5 +17,11 @@
     "url": "https://github.com/netlify/build-image/issues"
   },
   "homepage": "https://github.com/netlify/build-image#readme",
-  "devDependencies": {}
+  "devDependencies": {
+    "bats": "^1.3.0-alpha.0",
+    "bats-assert": "^2.0.0",
+    "bats-support": "^0.3.0",
+    "bats-file": "git+https://github.com/bats-core/bats-file.git#v0.3.0"
+  },
+  "dependencies": {}
 }

tests/helpers.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Sets a given fixture as the project to be used as the target repository for our build-image scripts.
+# It expects a fixture name which should be present in a relative dir named `./fixtures` from the bats test executing it.
+# It sets the global `NETLIFY_BUILD_BASE`, `NETLIFY_CACHE_DIR` and `NETLIFY_REPO_DIR` variables based on the provided directory.
+
+# Arguments:
+#   $1 - fixture name
+#   $2 - path to use as the repo base (ideally a temporary dir)
+set_fixture_as_repo() {
+  local fixture="$1"
+  local tmp_dir="$2"
+  NETLIFY_BUILD_BASE=$tmp_dir
+  NETLIFY_CACHE_DIR="$NETLIFY_BUILD_BASE/cache"
+  NETLIFY_REPO_DIR="$NETLIFY_BUILD_BASE/repo"
+  rm -rf "$NETLIFY_REPO_DIR"
+  cp -r "$BATS_TEST_DIRNAME/fixtures/$fixture" "$NETLIFY_REPO_DIR"
+
+  # Change to the repo dir
+  cd "$NETLIFY_REPO_DIR" || exit 1
+}
+
+# Setups a tmp dir to be used for test purposes.
+setup_tmp_dir() {
+  mktemp -d
+}

tests/node/base.bats

@@ -0,0 +1,27 @@
+#!/usr/bin/env bats
+
+load "../helpers.sh"
+
+load '../../node_modules/bats-support/load'
+load '../../node_modules/bats-assert/load'
+
+
+NODE_VERSION=12.18.0
+
+#Note: These binaries are accessible because we source `~/.nvm/nvm.sh` before running the `bats` tests
+
+@test 'node version ${NODE_VERSION} is installed and available at startup' {
+  run node --version
+  assert_success
+  assert_output --partial $NODE_VERSION
+}
+
+@test 'grunt-cli is installed and available at startup' {
+  run grunt --version
+  assert_success
+}
+
+@test 'bower is installed and available at startup' {
+  run bower --version
+  assert_success
+}

tests/node/fixtures/simple-node/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "simple-node-project",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "UNLICENSED",
+  "dependencies": {
+    "@netlify/plugins-list": "^3.6.0"
+  }
+}

tests/node/yarn.bats

@@ -0,0 +1,34 @@
+#!/usr/bin/env bats
+
+load "../helpers.sh"
+
+load '../../node_modules/bats-support/load'
+load '../../node_modules/bats-assert/load'
+load '../../node_modules/bats-file/load'
+
+YARN_CACHE_DIR=/opt/buildhome/.yarn_cache
+
+setup() {
+  TMP_DIR=$(setup_tmp_dir)
+  set_fixture_as_repo 'simple-node' "$TMP_DIR"
+
+  # Load functions
+  load '../../run-build-functions.sh'
+}
+
+teardown() {
+  rm -rf "$TMP_DIR"
+  # Return to original dir
+  cd - || return
+}
+
+@test 'run_yarn sets up new yarn version if different from the one installed, installs deps and creates cache dir' {
+  local newYarnVersion=1.21.0
+  run run_yarn $newYarnVersion
+  assert_success
+  assert_output --partial "Installing yarn at version $newYarnVersion"
+  assert_dir_exist $YARN_CACHE_DIR
+
+  # The cache dir is actually being used
+  assert_dir_exist "$YARN_CACHE_DIR/v6"
+}