Skip to content

feat: Add back BATS for testing images #1588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MasonM wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: Add back BATS for testing images #1588

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8853c4
feat: Add back BATS for testing images
MasonM Oct 21, 2021
352a3b1
Remove submodule and use npx instead
MasonM Mar 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
feat: Add back BATS for testing images 
BATS was initially added to this repository in #802, but was then
removed in #1339. This adds it back, and hooks it up to Github Actions.

This also fixes #1583, which happened due to a bug in the "Build image"
step: the build context was set to the root project directory, which
meant the `COPY docker-entrypoint.sh /usr/local/bin/` instruction was
copying the base `docker-entrypoint.sh` file into the Docker image
instead of the one in the variant directory. Changing the context to the
variant directory solves that.
  • Loading branch information
@MasonM
MasonM committed Oct 23, 2021
commit f8853c456b11b13fbb21a7c6ce718186eedd87c5
30 changes: 9 additions & 21 deletions .github/workflows/build-test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ jobs:
strategy:
fail-fast: false
matrix: ${{ fromJson(needs.gen-matrix.outputs.matrix) }}
env:
NODE_VERSION: ${{ matrix.version }}
IMAGE_TAG: node:${{ matrix.version }}-${{ matrix.variant }}

steps:
- name: Get short node version
Expand All @@ -66,31 +69,16 @@ jobs:

- name: Checkout
uses: actions/checkout@v2
with:
submodules: true

- name: Build image
uses: docker/build-push-action@v2
with:
push: false
load: true
context: .
file: ./${{ steps.short-version.outputs.result }}/${{ matrix.variant }}/Dockerfile
tags: node:${{ matrix.version }}-${{ matrix.variant }}

- name: Test for node version
run: |
image_node_version=$(docker run --rm node:${{ matrix.version }}-${{ matrix.variant }} node --print "process.versions.node")
echo "Expected: \"${{ matrix.version }}\", Got: \"${image_node_version}\""
[ "${image_node_version}" == "${{ matrix.version }}" ]

- name: Verify entrypoint runs regular, non-executable files with node
run: |
tmp_file=$(mktemp)
echo 'console.log("success")' > "${tmp_file}"
output=$(docker run --rm -v "${tmp_file}:/app/index.js" node:${{ matrix.version }}-${{ matrix.variant }} app/index.js)
[ "${output}" = 'success' ]

- name: Test for npm
run: docker run --rm node:${{ matrix.version }}-${{ matrix.variant }} npm --version
context: ./${{ steps.short-version.outputs.result }}/${{ matrix.variant }}
Copy link
Copy Markdown
Contributor Author

@MasonM MasonM Oct 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's the fix for issue #1583, in case it wasn't clear from the PR description. The context should be the variant directory so it copies the right docker-entrypoint.sh file.

tags: ${{ env.IMAGE_TAG }}

- name: Test for yarn
run: docker run --rm node:${{ matrix.version }}-${{ matrix.variant }} yarn --version
- name: Run tests with BATS
run: test/bats/bin/bats --verbose-run test/docker-image.bats
3 changes: 3 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "test/bats"]
Comment thread
MasonM marked this conversation as resolved.
Outdated
path = test/bats
url = https://github.com/bats-core/bats-core.git
1 change: 1 addition & 0 deletions test/bats
Open in desktop
Submodule bats added at 99d64e
36 changes: 36 additions & 0 deletions test/docker-image.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Docs: https://bats-core.readthedocs.io/en/stable/writing-tests.html

setup() {
tmp_file=$(mktemp)
echo 'console.log("success")' > "${tmp_file}"
}

@test "Test for node version" {
run -0 docker run --rm "${IMAGE_TAG}" node --print "process.versions.node"
[ "$output" = "${NODE_VERSION}" ]
}

@test "Test for node version, without directly invoking node" {
run -0 docker run --rm "${IMAGE_TAG}" --print "process.versions.node"
[ "$output" = "${NODE_VERSION}" ]
}

@test "Test for npm" {
run -0 docker run --rm "${IMAGE_TAG}" npm --version
[ -n "$output" ]
}

@test "Test for yarn" {
run -0 docker run --rm "${IMAGE_TAG}" yarn --version
[ -n "$output" ]
}

@test "Verify entrypoint runs relative path pointing to regular, non-executable file with node" {
run -0 docker run --rm -v "${tmp_file}:/index.js" "${IMAGE_TAG}" index.js
[ "$output" = 'success' ]
}

@test "Verify entrypoint runs absolute path pointing to regular, non-executable file with node" {
run -0 docker run --rm -v "${tmp_file}:/index.js" "${IMAGE_TAG}" /index.js
[ "$output" = 'success' ]
}