Merge pull request #28 from bats-core/vz

Dockerfile and CI updates

Author: vincent-zurczak

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+on:
+- push
+- pull_request
+- workflow_dispatch
+
+jobs:
+  test-detik:
+    name: Test DETIK
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Install BATS
+      run: |
+        git clone https://github.com/bats-core/bats-core.git && \
+        cd bats-core && sudo ./install.sh /usr/local && \
+        cd ..
+    - uses: actions/checkout@v2
+    - name: Test with bats
+      run: bats tests/
+
+  test-docker-build:
+    name: Build the Docker image
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Execute the build script
+      run: docker build -t bats/bats-detik .

.travis.yml

@@ -0,0 +1,30 @@
+# Contributing Guidelines
+
+## Issues / PR / Ideas
+
+You can create issues to share ideas or report a problem.  
+Feel free also to submit pull requests.
+
+
+## Commit Signing
+
+All the commits need to be signed with a PGP key.  
+Your commit command should look like...
+
+```bash
+# "S" is upper-case
+commit -S -m "your commit message"
+```
+
+... unless you enabled the setting to automatically sign your commits.
+
+```bash
+# Verify signing is enabled by default
+git config commit.gpgsign
+```
+
+The following links will help you to configure your client:
+
+* [Signing commits](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits)
+* [Generating a new GPG key](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/generating-a-new-gpg-key)
+* [Telling Git about your key](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/telling-git-about-your-signing-key)

CONTRIBUTING.md

@@ -1,7 +1,8 @@
-FROM alpine:3.10
+FROM alpine:3.14
 
-ARG KUBECTL_VERSION=v1.14.1
-ARG HELM_VERSION=v2.13.1
+ARG KUBECTL_VERSION=v1.21.2
+ARG HELM_VERSION=v3.6.1
+ARG BATS_VERSION=1.3.0
 
 # Add packages
 RUN apk --no-cache add \
@@ -11,20 +12,20 @@ RUN apk --no-cache add \
     openssh-client \
     bash
 
-# Install BATS 1.1.0
-RUN curl -LO https://github.com/bats-core/bats-core/archive/v1.1.0.zip && \
-	unzip -q -d /tmp v1.1.0.zip && \
-	cd /tmp/bats-core-1.1.0 && \
+# Install BATS
+RUN curl -LO "https://github.com/bats-core/bats-core/archive/refs/tags/v$BATS_VERSION.zip" && \
+	unzip -q -d /tmp "v$BATS_VERSION.zip" && \
+	cd "/tmp/bats-core-$BATS_VERSION" && \
 	./install.sh /usr/local && \
-	rm -rf /tmp/bats-core-1.1.0
+	rm -rf "/tmp/bats-core-$BATS_VERSION"
 
 # Install kubectl
 RUN curl -LO "https://storage.googleapis.com/kubernetes-release/release/$KUBECTL_VERSION/bin/linux/amd64/kubectl" && \
 	chmod +x kubectl && \
 	mv kubectl /usr/local/bin/
 
 # Install Helm
-RUN curl -LO "https://kubernetes-helm.storage.googleapis.com/helm-$HELM_VERSION-linux-amd64.tar.gz" && \
+RUN curl -LO "https://get.helm.sh/helm-$HELM_VERSION-linux-amd64.tar.gz" && \
 	mkdir -p "/usr/local/helm-$HELM_VERSION" && \
 	tar -xzf "helm-$HELM_VERSION-linux-amd64.tar.gz" -C "/usr/local/helm-$HELM_VERSION" && \
 	ln -s "/usr/local/helm-$HELM_VERSION/linux-amd64/helm" /usr/local/bin/helm && \
@@ -37,8 +38,8 @@ RUN adduser -D -u 10000 testing
 USER testing
 WORKDIR /home/testing
 
-# Initialize the Helm client
-RUN helm init --client-only --skip-refresh
+# Initialize the Helm client (Helm 2.x)
+# RUN helm init --client-only --skip-refresh
 
 # Add the library
 COPY ./lib /home/testing/lib

Dockerfile

@@ -184,52 +184,76 @@ It includes...
 
 ## Usage
 
-### Setup
+### Manual Setup
 
 * Install [BATS](https://github.com/bats-core/bats-core), a testing framework for scripts.  
 BATS is a test framework for BASH and other scripts.
-* Download the **lib/detik.bash** script.  
+* Download the **lib/detik.bash** script.
+
 ```bash
 wget https://raw.githubusercontent.com/bats-core/bats-detik/master/lib/detik.bash
 wget https://raw.githubusercontent.com/bats-core/bats-detik/master/lib/linter.bash
 wget https://raw.githubusercontent.com/bats-core/bats-detik/master/lib/utils.bash
 chmod +x *.bash
 ```
-* Write bats scripts with assertions.  
+
+* Write BATS scripts with assertions.  
 Make sure they import the **lib/utils.bash** and **lib/detik.bash** files.
 * Import the **lib/linter.bash** file to verify the linting of DETIK assertions.
+* Use the BATS command to run your tests: `bats sources/tests/main.bats`
+
+
+### Docker Setup
 
+This project does not provide any official Docker image.  
+This is because you may need various clients (kubectl, oc, kustomize...
+whatever) and it all depends on your requirements.
 
-### Executing Tests by Hand
+A sample Dockerfile is provided in this project.  
+To build a Docker image from it:
 
-Assuming you have built the image from the sample Dockerfile...
+```bash
+# Tag it with LATEST
+docker build -t bats/bats-detik:LATEST .
+
+# Overwrite the default versions
+docker build \
+	--build-arg KUBECTL_VERSION=v1.21.2 \
+	--build-arg HELM_VERSION=v3.6.1 \
+	--build-arg BATS_VERSION=1.3.0 \
+	-t bats/bats-detik:LATEST \
+	.    
+```
+
+On a development machine, you can use it this way:
 
 ```bash
 # Run the image with a volume for your project.
 # In this example, we show how to specify the proxy
 # if your organization is using one.
 docker run -ti \
-        -v $(pwd):/home/testing/sources \
-        -e http_proxy="proxy.local:3128" \
-        -e https_proxy="proxy.local:3128" \
-        bats-detik:LATEST
+	-v $(pwd):/home/testing/sources \
+	-e http_proxy="proxy.local:3128" \
+	-e https_proxy="proxy.local:3128" \
+	bats-detik:LATEST
 
 # Log into the cluster
 echo "It all depends on your cluster configuration"
 
 # Export the namespace for Helm (v2)
-export TILLER_NAMESPACE=<your namespace>
+# export TILLER_NAMESPACE=<your namespace>
 
 # Execute the tests
 bats sources/tests/main.bats
 ```
 
+It can also be used in a continuous integration platform.
+
 
 ### Continuous Integration
 
 An example is given for Jenkins in [the examples](examples/ci).  
-The syntax is quite simple and may be easily adapted for other solutions, such as GitLab CI,
-Tracis CI, etc.
+The syntax is quite simple and may be easily adapted for other solutions, such as GitLab CI, Tracis CI, etc.
 
 
 ## Syntax Reference
@@ -251,7 +275,7 @@ See [https://kubernetes.io/docs/reference/kubectl/overview/#resource-types](http
 
 This simple assertion may fail sometimes.  
 As an example, if you count the number of PODs, run your test and then kill the POD, they will still
-be listed, with the TERMINATING state. So, moest of the time, you will want to verify the number of instances
+be listed, with the TERMINATING state. So, most of the time, you will want to verify the number of instances
 with a given property value. Example: count the number of PODs with a given name pattern and having the `started` status.
 Hence this additional syntax.
 

README.md

@@ -70,17 +70,17 @@ try() {
 		# Start the loop
 		echo "Valid expression. Verification in progress..."
 		code=0
-		for ((i=1; i<=$times; i++)); do
+		for ((i=1; i<=times; i++)); do
 
 			# Verify the value
-			verify_value $property $expected_value $resource $name "$expected_count" && code=$? || code=$?
+			verify_value "$property" "$expected_value" "$resource" "$name" "$expected_count" && code=$? || code=$?
 
 			# Break the loop prematurely?
 			if [[ "$code" == "0" ]]; then
 				break
 			elif [[ "$i" != "1" ]]; then
 				code=3
-				sleep $delay
+				sleep "$delay"
 			else
 				code=3
 			fi
@@ -158,7 +158,7 @@ verify() {
 		name="${BASH_REMATCH[4]}"
 
 		echo "Valid expression. Verification in progress..."
-		verify_value $property $expected_value $resource $name
+		verify_value "$property" "$expected_value" "$resource" "$name"
 
 		if [[ "$?" != "0" ]]; then
 			return 3
@@ -190,7 +190,7 @@ verify_value() {
 	expected_count="$5"
 
 	# List the items and remove the first line (the one that contains the column names)
-	query=$(build_k8s_request $property)
+	query=$(build_k8s_request "$property")
 	client_with_options=$(build_k8s_client_with_options)
 	result=$(eval $client_with_options get $resource $query | grep $name | tail -n +1)
 
@@ -266,7 +266,7 @@ build_k8s_request() {
 		req="$req,PROP:'$1'"
 	fi
 
-	echo $req
+	echo "$req"
 }
 
 
@@ -275,10 +275,10 @@ build_k8s_request() {
 build_k8s_client_with_options() {
 
 	client_with_options="$DETIK_CLIENT_NAME"
-	if [[ ! -z "$DETIK_CLIENT_NAMESPACE" ]]; then
+	if [[ -n "$DETIK_CLIENT_NAMESPACE" ]]; then
 		# eval does not like '-n'
 		client_with_options="$DETIK_CLIENT_NAME --namespace=$DETIK_CLIENT_NAMESPACE"
 	fi
 
-	echo $client_with_options
+	echo "$client_with_options"
 }

docker-build.sh

@@ -43,7 +43,7 @@ lint() {
 		detik_debug "Read line $current_line_number: $line"
 
 		# Skip empty lines and comments
-		if [[ ! -n "$line" ]] || [[ "$line" =~ ^[[:space:]]*#.* ]]; then
+		if [[ -z "$line" ]] || [[ "$line" =~ ^[[:space:]]*#.* ]]; then
 			if [[ "$multi_line" == "0" ]]; then
 				handle_error "Incomplete multi-line statement at $current_line_number."
 				current_line=""

lib/detik.bash

@@ -40,7 +40,7 @@ trim_ansi_codes() {
 # @param {string} The debug message.
 # @return 0
 debug() {
-	debug_filename=$(basename -- $BATS_TEST_FILENAME)
+	debug_filename=$(basename -- "$BATS_TEST_FILENAME")
 	mkdir -p /tmp/detik
 	echo -e "$1" >> "/tmp/detik/$debug_filename.debug"
 }
@@ -49,7 +49,7 @@ debug() {
 # Deletes the file that contains debug messages for a given test.
 # @return 0
 reset_debug() {
-	debug_filename=$(basename -- $BATS_TEST_FILENAME)
+	debug_filename=$(basename -- "$BATS_TEST_FILENAME")
 	rm -f "/tmp/detik/$debug_filename.debug"
 }
 

lib/linter.bash

@@ -239,7 +239,7 @@ mytest_with_namespace() {
 
 @test "trying to find of a POD with the lower-case syntax (debug)" {
 
-	debug_filename=$(basename -- $BATS_TEST_FILENAME)
+	debug_filename=$(basename -- "$BATS_TEST_FILENAME")
 	path="/tmp/detik/$debug_filename.debug"
 	[ -f "$path" ] && mv "$path" "$path.backup"
 	[ ! -f "$path" ]
@@ -293,7 +293,7 @@ mytest_with_namespace() {
 	DETIK_CLIENT_NAME="mytest_with_namespace"
 	DETIK_CLIENT_NAMESPACE="test_ns"
 
-	debug_filename=$(basename -- $BATS_TEST_FILENAME)
+	debug_filename=$(basename -- "$BATS_TEST_FILENAME")
 	path="/tmp/detik/$debug_filename.debug"
 	[ -f "$path" ] && mv "$path" "$path.backup"
 	[ ! -f "$path" ]
@@ -354,7 +354,7 @@ my_consul_test() {
 		echo -e "NAME  PROP\nconsul-for-vault-0  Running\nconsul-for-vault-1  Running\nconsul-for-vault-2  Running"
 	fi
 
-	consul_cpt=$(($consul_cpt + 1))
+	consul_cpt=$((consul_cpt + 1))
 	echo "$consul_cpt" > /tmp/my-consul-test.txt
 }
 

lib/utils.bash

@@ -164,7 +164,7 @@ mytest() {
 
 @test "trying to verify the status of a POD with the lower-case syntax (debug)" {
 
-	debug_filename=$(basename -- $BATS_TEST_FILENAME)
+	debug_filename=$(basename -- "$BATS_TEST_FILENAME")
 	path="/tmp/detik/$debug_filename.debug"
 	[[ -f "$path" ]] && mv "$path" "$path.backup"
 	[ ! -f "$path" ]

tests/test.detik.try.to.find.bats

@@ -170,7 +170,7 @@ mytest_with_namespace() {
 
 @test "verifying the number of PODs with the lower-case syntax (debug)" {
 
-	debug_filename=$(basename -- $BATS_TEST_FILENAME)
+	debug_filename=$(basename -- "$BATS_TEST_FILENAME")
 	path="/tmp/detik/$debug_filename.debug"
 	[ -f "$path" ] && mv "$path" "$path.backup"
 	[ ! -f "$path" ]
@@ -220,7 +220,7 @@ mytest_with_namespace() {
 	DETIK_CLIENT_NAME="mytest_with_namespace"
 	DETIK_CLIENT_NAMESPACE="test_ns"
 
-	debug_filename=$(basename -- $BATS_TEST_FILENAME)
+	debug_filename=$(basename -- "$BATS_TEST_FILENAME")
 	path="/tmp/detik/$debug_filename.debug"
 	[ -f "$path" ] && mv "$path" "$path.backup"
 	[ ! -f "$path" ]
@@ -376,7 +376,7 @@ mytest_with_namespace() {
 
 @test "verifying the status of a POD with the lower-case syntax (debug)" {
 
-	debug_filename=$(basename -- $BATS_TEST_FILENAME)
+	debug_filename=$(basename -- "$BATS_TEST_FILENAME")
 	path="/tmp/detik/$debug_filename.debug"
 	[ -f "$path" ] && mv "$path" "$path.backup"
 	[ ! -f "$path" ]

tests/test.detik.try.to.verify.bats

@@ -2,7 +2,7 @@
 
 load "../lib/utils"
 
-debug_filename=$(basename -- $BATS_TEST_FILENAME)
+debug_filename=$(basename -- "$BATS_TEST_FILENAME")
 target="/tmp/detik/$debug_filename.debug"
 
 @test "testing debug" {