Merge pull request #155 from ProblemSetters/tests-implementation

Tests implementation + Ubuntu 24.04 bugfixes

Author: ya-developer

blackbox

@@ -38,25 +38,26 @@
 blackbox() {
   export BLACKBOX_DIR=/blackbox
   # shellcheck disable=SC2155
-  export BLACKBOX_SPAWN=$(awk -v master="$(</proc/sys/kernel/random/uuid)" -v user="$BLACKBOX_SPAWN" 'END { print ($0 == "systemd") ? master : user }' <(ps -p 1 -o comm=))
+#  export BLACKBOX_SPAWN=$(awk -v master="$(awk -v master="$(</proc/sys/kernel/random/uuid)" -v user="blackbox-spawn" 'END { print ($0 == "blackbox") ? user : master }' <(findmnt -n --mountpoint="/blackbox" --output="SOURCE"))" -v user="" 'END { print ($0 == "systemd") ? master : user }' <(ps -p 1 -o comm=))
+  export BLACKBOX_SPAWN=$(awk -v master="$(</proc/sys/kernel/random/uuid)" -v user="blackbox-spawn" 'END { print ($0 == "blackbox") ? user : master }' <(findmnt -n --mountpoint="/blackbox" --output="SOURCE"))
   # shellcheck disable=SC2155
-  export BLACKBOX_USER=$(awk -v master="1000:1000" -v user="$BLACKBOX_USER" 'END { print ($0 == "systemd") ? master : user }' <(ps -p 1 -o comm=))
+  export BLACKBOX_USER="1000:1000"
   # shellcheck disable=SC2155
-  export BLACKBOX_USER_NAME=$(awk -v master="ubuntu" -v user="$BLACKBOX_USER_NAME" 'END { print ($0 == "systemd") ? master : user }' <(ps -p 1 -o comm=))
+  export BLACKBOX_USER_NAME="ubuntu"
   # shellcheck disable=SC2155
-  export BLACKBOX_USER_HOME=$(awk -v master="/home/${BLACKBOX_USER_NAME}" -v user="$BLACKBOX_USER_HOME" 'END { print ($0 == "systemd") ? master : user }' <(ps -p 1 -o comm=))
+  export BLACKBOX_USER_HOME="/home/${BLACKBOX_USER_NAME}"
   # shellcheck disable=SC2155
-  export BLACKBOX_USER_QUESTION_DIR=$(awk -v master="${BLACKBOX_USER_HOME}/${3}" -v user="$BLACKBOX_USER_QUESTION_DIR" 'END { print ($0 == "systemd") ? master : user }' <(ps -p 1 -o comm=))
+  export BLACKBOX_USER_QUESTION_DIR=$(awk -v master="${BLACKBOX_USER_HOME}/${3}" -v user="" 'END { print ($0 == "systemd") ? master : user }' <(ps -p 1 -o comm=))
   # shellcheck disable=SC2155
-  export BLACKBOX_VERSION=$(awk -v master="2404" -v user="$BLACKBOX_VERSION" 'END { print ($0 == "systemd") ? master : user }' <(ps -p 1 -o comm=))
+  export BLACKBOX_VERSION="2404"
 
   export BLACKBOX_FLAG__DEBUG_MODE=${BLACKBOX_FLAG__DEBUG_MODE:-no}
   # shellcheck disable=SC2155
-  export BLACKBOX_FLAG__STEP_PROVISION=$(awk -v master="yes" -v user="$BLACKBOX_FLAG__STEP_PROVISION" 'END { print ($0 == "systemd") ? master : user }' <(ps -p 1 -o comm=))
+  export BLACKBOX_FLAG__STEP_PROVISION=$(awk -v master="yes" -v user="${BLACKBOX_FLAG__STEP_PROVISION:-yes}" 'END { print ($0 == "blackbox") ? user : master }' <(findmnt -n --mountpoint="/blackbox" --output="SOURCE"))
   # shellcheck disable=SC2155
-  export BLACKBOX_FLAG__STEP_BUILD=$(awk -v master="yes" -v user="$BLACKBOX_FLAG__STEP_BUILD" 'END { print ($0 == "systemd") ? master : user }' <(ps -p 1 -o comm=))
+  export BLACKBOX_FLAG__STEP_BUILD=$(awk -v master="yes" -v user="${BLACKBOX_FLAG__STEP_BUILD:-yes}" 'END { print ($0 == "blackbox") ? user : master }' <(findmnt -n --mountpoint="/blackbox" --output="SOURCE"))
   # shellcheck disable=SC2155
-  export BLACKBOX_FLAG__STEP_EVALUATE=$(awk -v master="yes" -v user="$BLACKBOX_FLAG__STEP_EVALUATE" 'END { print ($0 == "systemd") ? master : user }' <(ps -p 1 -o comm=))
+  export BLACKBOX_FLAG__STEP_EVALUATE=$(awk -v master="yes" -v user="${BLACKBOX_FLAG__STEP_EVALUATE:-yes}" 'END { print ($0 == "blackbox") ? user : master }' <(findmnt -n --mountpoint="/blackbox" --output="SOURCE"))
 
   # shellcheck disable=SC2155
   export BLACKBOX_PROVISION_WITH_OPTS=$(sed "s/\({\);/\1/g; s/\(;\)\{2\}/\1/g" <(awk 'ORS="; "' <(sed '1,2d; $d; s/[[:space:]]$//g; s/^[[:space:]]\+//g' <(declare -f BLACKBOX_PROVISION_WITH_OPTS))))
@@ -192,7 +193,7 @@ blackbox() {
 
       source_definition=$(sed '1,2d; $d' <<<"$source_definition")
       # shellcheck disable=SC2016
-      destination_definition=$(sed "$(printf '1,2d; $d; /%s/d' "$destination_definition_source_placeholder")" <<<"$destination_definition")
+      destination_definition=$(sed "$(printf '1,2d; $d; /%s/d; s/&/\\\&/g' "$destination_definition_source_placeholder")" <<<"$destination_definition")
 
       blackbox.framework.trace "${FUNCNAME[0]}" "$*" "$(printf '&%s %s' "$source_namespace_name" "$destination_namespace_name")" <<<""
 
@@ -270,7 +271,7 @@ blackbox() {
 
     if [ ! -e "$BLACKBOX_DIR" ]; then
       wget -S --output-document="/tmp/blackbox.zip" "https://codeload.github.com/ProblemSetters/devops-blackbox/zip/refs/heads/${BLACKBOX_VERSION}" && {
-        unzip /tmp/blackbox.zip -x "devops-blackbox-2404/.github/*" "devops-blackbox-2404/docs/*" "devops-blackbox-2404/.gitignore" "devops-blackbox-2404/Makefile.*" "devops-blackbox-2404/README.md" "devops-blackbox-2404/Vagrantfile" -d /tmp && {
+        unzip /tmp/blackbox.zip -x "devops-blackbox-2404/.github/*" "devops-blackbox-2404/docs/*" "devops-blackbox-2404/tests/*" "devops-blackbox-2404/.gitignore" "devops-blackbox-2404/Makefile.*" "devops-blackbox-2404/README.md" "devops-blackbox-2404/Vagrantfile" -d /tmp && {
           mv "/tmp/devops-blackbox-${BLACKBOX_VERSION}" "$BLACKBOX_DIR"
           rm -rf /tmp/*blackbox*
         }

framework/inventory/ansible.inventory

@@ -36,7 +36,7 @@ blackbox.framework.inventory.ansible() {
   fi
 
   DEBIAN_FRONTEND=noninteractive apt install -y --no-install-recommends software-properties-common gpg-agent wget && {
-    wget -S --output-document="/tmp/ansible.deb" --no-verbose https://launchpad.net/~ansible/+archive/ubuntu/ansible/+files/ansible_11.11.0-1ppa~noble_all.deb && {
+    wget -S --output-document="/tmp/ansible.deb" --no-verbose "https://launchpad.net/~ansible/+archive/ubuntu/ansible-11/+files/ansible_11.12.0-1ppa~noble_all.deb" && {
       DEBIAN_FRONTEND=noninteractive apt install -y /tmp/ansible.deb "${with_packages[@]}" && {
         rm -f /tmp/ansible.deb
       }

framework/inventory/jenkins.inventory

@@ -41,10 +41,10 @@ blackbox.framework.inventory.jenkins() {
     wget -S --output-document="/usr/share/keyrings/jenkins-keyring.asc" --no-verbose https://pkg.jenkins.io/debian-stable/jenkins.io-2023.key
     tee /etc/apt/sources.list.d/jenkins.list <<<"deb [signed-by=/usr/share/keyrings/jenkins-keyring.asc] https://pkg.jenkins.io/debian-stable binary/"
 
-    local version=2.492.2
+    local version=2.528.2
 
     apt update
-    DEBIAN_FRONTEND=noninteractive apt install -y --no-install-recommends openjdk-17-jre-headless jenkins="$version" "${with_packages[@]}" && {
+    DEBIAN_FRONTEND=noninteractive apt install -y openjdk-21-jre-headless jenkins="$version" "${with_packages[@]}" && {
       install -m 0644 -D /blackbox/framework/inventory/jenkins/rootfs/etc/systemd/system/jenkins.service.d/override.conf /etc/systemd/system/jenkins.service.d/override.conf
     }
   }

module/aws/setup/provision.step

@@ -11,6 +11,8 @@ blackbox.module.aws.setup.provision() {
     sleep 30
   }
 
+  rm -f /usr/local/bin/solve
+
   tee -a /etc/hosts < <(printf "127.0.0.1\teu-central-1.hackerrankaws.local\n")
   tee -a /etc/environment < <(printf "AWS_ENDPOINT_URL=%s\n" "eu-central-1.hackerrankaws.local")
 }

module/ceph-stdl/setup/provision.step

@@ -32,6 +32,8 @@ blackbox.module.ceph-stdl.setup.provision() {
     microceph.ceph status
   }
 
+  blackbox.framework.inventory.provision awscli
+
   rm -f /usr/local/bin/solve
 
   if [ -n "$BLACKBOX_PROVISION_WITH_OPTS" ]; then

module/git/setup/provision.step

@@ -10,9 +10,11 @@ blackbox.module.git.setup.provision() {
   blackbox.framework.inventory.provision git
   sudo -u "$BLACKBOX_USER_NAME" git init
   {
+    git config --global --add safe.directory "$BLACKBOX_USER_QUESTION_DIR"
     sudo -u "$BLACKBOX_USER_NAME" git config --global --add safe.directory "$BLACKBOX_USER_QUESTION_DIR"
     sudo -u "$BLACKBOX_USER_NAME" git remote add origin "$BLACKBOX_USER_QUESTION_DIR"
     sudo -u "$BLACKBOX_USER_NAME" git config --global --list
     sudo -u "$BLACKBOX_USER_NAME" git config --list
   }
+  rm -f /usr/local/bin/solve
 }

tests/Makefile.tests

@@ -0,0 +1,83 @@
+#!/usr/bin/env make
+override blackbox/:=*
+
+ifeq ($(origin .FEATURES),undefined)
+  $(error `make` executable version `$(MAKE_VERSION)` is not supported. GNU Make 4.3 or above is required)
+endif
+
+ifeq ($(words $(MAKEFILE_LIST)),1)
+  $(error `Makefile` should be included, direct usage is not allowed)
+endif
+
+ifeq ($(shell which docker),)
+  $(error `docker` executable is required)
+endif
+
+override SHELL:=/usr/bin/env bash -e +o pipefail
+
+ifeq ($(shell echo $$BASH),)
+  $(error current shell executable is not supported. GNU Bash 5.1 or above is required)
+endif
+
+ifeq ($(origin .FEATURES),undefined)
+  $(error `make` executable version "$(MAKE_VERSION)" is not supported. GNU Make 3.82 or above is required)
+endif
+
+override SHELL:=/bin/bash
+
+ifneq ($(value SHELL),$(shell echo $$BASH))
+  $(error current shell executable is not supported. GNU Bash 4.3 or above is required)
+endif
+
+override blackbox/host/tests/dir:=$(abspath $(dir $(lastword $(MAKEFILE_LIST))))
+override blackbox/host/test/dir:=$(abspath $(dir $(firstword $(MAKEFILE_LIST))))
+override blackbox/spawn/username:=ubuntu
+override blackbox/spawn/test/dir:=/test
+
+export BLACKBOX_HOST_TEST_DIR=$(blackbox/host/test/dir)
+export BLACKBOX_FLAG__DEBUG_MODE=no
+export VAGRANT_VAGRANTFILE=$(blackbox/host/tests/dir)/Vagrantfile
+
+debug: ;@:
+	$(eval BLACKBOX_FLAG__DEBUG_MODE:=yes)
+	$(foreach variable,BLACKBOX_FLAG__DEBUG_MODE,$(info $(shell printf "\033[0;37m%s = %s\033[0m" "$(variable)" "$($(variable))")))
+	$(info $(shell printf "\033[0;37m%s\033[0m" \\))
+	$(foreach variable,$(filter-out BLACKBOX_FLAG__%,$(filter BLACKBOX_%,$(sort $(.VARIABLES)))),$(info $(shell printf "\033[0;37m%s = %s\033[0m" "$(variable)" "$($(variable))")))
+	$(if $(and $(filter-out $(words $(MAKECMDGOALS)),0),$(filter-out $(words $(MAKECMDGOALS)),1)),$(info $(shell printf "\033[0;37m%s\033[0m" --)))
+
+all: install setup save check
+	$(MAKE) restore solve check
+
+install:
+	vagrant up
+
+setup:
+	vagrant ssh --command="sudo BLACKBOX_FLAG__DEBUG_MODE=$(BLACKBOX_FLAG__DEBUG_MODE) bash $(blackbox/spawn/test/dir)/setup.sh"
+
+solve:
+	vagrant ssh --command="sudo -i -u $(blackbox/spawn/username) bash $(blackbox/spawn/test/dir)/solve.sh"
+
+check:
+	vagrant ssh --command="sudo BLACKBOX_FLAG__DEBUG_MODE=$(BLACKBOX_FLAG__DEBUG_MODE) bash $(blackbox/spawn/test/dir)/check.sh" | tee >(awk '/Partial Credit/ { if (!reset) { reset = 1; next }; total_score += $$3; ok += ($$3 > 0); failed += ($$3 == 0) } END { printf("\nSuccess: %d\nFail: %d\nTotal: %d\n--\nTotal Credit: %d\n", ok, failed, ok + failed, total_score) }')
+
+check\:evaluate:
+	vagrant ssh --command="sudo BLACKBOX_FLAG__DEBUG_MODE=no BLACKBOX_FLAG__STEP_PROVISION=no BLACKBOX_FLAG__STEP_BUILD=no BLACKBOX_FLAG__STEP_EVALUATE=yes bash $(blackbox/spawn/test/dir)/check.sh" | tee >(awk '/Partial Credit/ { if (!reset) { reset = 1; next }; total_score += $$3; ok += ($$3 > 0); failed += ($$3 == 0) } END { printf("\nSuccess: %d\nFail: %d\nTotal: %d\n--\nTotal Credit: %d\n", ok, failed, ok + failed, total_score) }')
+
+shell:
+	vagrant ssh --command="sudo su - $(blackbox/spawn/username)"
+
+shell\:spawn:
+	vagrant ssh --command="sudo docker exec -it -w /home/ubuntu/test blackbox-spawn bash"
+
+save:
+	vagrant snapshot save current
+
+restore:
+	vagrant snapshot restore current
+
+prune:
+	vagrant snapshot delete current
+
+uninstall:
+	vagrant destroy -f
+	rm -rf .vagrant

tests/Vagrantfile

@@ -0,0 +1,20 @@
+Vagrant.configure("2") do |config|
+  config.vm.box = "bento/ubuntu-24.04"
+  config.vm.hostname = "taskserver"
+  config.vm.synced_folder ".", "/vagrant", disabled: true
+  if ENV["BLACKBOX_FLAG__DEBUG_MODE"] == "yes"
+    config.vm.synced_folder ENV["BLACKBOX_DIR"], "/blackbox", mount_options: ["uid=0", "gid=0", "ro"]
+  end
+  config.vm.synced_folder ENV["BLACKBOX_HOST_TEST_DIR"], "/test", mount_options: ["uid=0", "gid=0", "ro"]
+  config.vm.provision "shell", inline: <<-SHELL
+    apt update && {
+      DEBIAN_FRONTEND=noninteractive apt install -y unzip
+    }
+    {
+      groupadd -g 1001 ubuntu
+      useradd -u 1001 -g 1001 -s /bin/bash -m ubuntu
+      cat >/etc/sudoers.d/ubuntu <<<"ubuntu ALL=(ALL) NOPASSWD:ALL"
+      usermod -aG vagrant ubuntu
+    }
+  SHELL
+end

tests/module/ansible-aws/@sandbox/Makefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env make
+include ../../../Makefile.tests