Automatic devcontainers.json Verify

.devcontainer/devcontainer.json

@@ -1,8 +1,8 @@
 {
-  "image": "docker:20.10.22-dind-alpine3.17",
-  "name": "airscript-blog-environment",
   "overrideCommand": false,
-  "postCreateCommand": "sh scripts/environment/setup.sh",
+  "name": "airscript-devcontainer",
+  "image": "docker:20.10.22-dind-alpine3.17",
+  "postCreateCommand": "sh scripts/devcontainer/setup.sh",
 
   "forwardPorts": [
     25001
@@ -11,7 +11,7 @@
   "runArgs": [
     "--init",
     "--privileged",
-    "--name", "airscript-blog-environment"
+    "--name", "airscript-devcontainer"
   ],
 
   "extensions": [

.docker/dockerfiles/blog.Dockerfile

@@ -13,7 +13,7 @@ FROM alpine:3.17 AS builder
     make git-submodules environment=${BLOG_BUILD_ENVIRONMENT}
 
 FROM alpine:3.17 AS runner
-  LABEL maintainer="Airscript <[email protected]>"
+  LABEL maintainer="Airscript <[email protected]>"
   ENV BLOG_PORT=25001
   ENV BLOG_INTERFACE=0.0.0.0
   WORKDIR /home

.docker/dockerfiles/ci.Dockerfile

@@ -1,5 +1,5 @@
 FROM alpine:3.17 AS runner
-  LABEL maintainer="Airscript <[email protected]>"
+  LABEL maintainer="Airscript <[email protected]>"
   WORKDIR /tmp
   COPY tmp/ /tmp/
 

.docker/dockerfiles/devcontainer.Dockerfile

@@ -0,0 +1,16 @@
+FROM docker:20.10.22-dind-alpine3.17 AS runner
+  LABEL maintainer="Airscript <[email protected]>"
+  WORKDIR /home
+  COPY tmp/ /home/
+
+  RUN \
+    sh scripts/update.sh && \
+    sh scripts/install/bash.sh && \
+    bash scripts/install/make.sh && \
+    make install-npm && \
+    make install-python3 && \
+    make install-gpp && \
+    make install-devcontainer-cli
+
+  ENTRYPOINT [ ".docker/scripts/devcontainer.docker-entrypoint.sh" ]
+  CMD ["devcontainer"]

.docker/dockerfiles/tests.Dockerfile

@@ -1,5 +1,5 @@
 FROM alpine:3.17 AS runner
-  LABEL maintainer="Airscript <[email protected]>"
+  LABEL maintainer="Airscript <[email protected]>"
   WORKDIR /tmp
   COPY tmp/ /tmp/
 

.docker/scripts/devcontainer.docker-entrypoint.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+set -e
+
+if [ "$1" = 'devcontainer' ]; then
+  bash ./scripts/devcontainer/verify.sh
+
+else 
+  exec "$@"
+fi

.githooks/pre-commit

@@ -3,6 +3,7 @@ PREFIX="pre-commit:"
 STAGED_FILES=$(git diff --diff-filter=d --cached --name-only)
 CI_FILES=$(echo "$STAGED_FILES" | grep .circleci)
 TESTS_FILES=$(echo "$STAGED_FILES" | grep tests)
+DEVCONTAINER_FILES=$(echo "$STAGED_FILES" | grep .devcontainer)
 
 if [ ${#CI_FILES} -gt 0 ]; then
   if ! make all-ci; then
@@ -18,4 +19,11 @@ if [ ${#TESTS_FILES} -gt 0 ]; then
   fi
 fi
 
+if [ ${#DEVCONTAINER_FILES} -gt 0 ]; then
+  if ! make all-devcontainer; then
+    echo "$PREFIX Error during devcontainer validation."
+    exit 1
+  fi
+fi
+
 echo "$PREFIX Run successfully."

Makefile

@@ -3,12 +3,17 @@ SHELL = /bin/sh
 CI_IMAGE_NAME = airscript/ci:base
 TESTS_IMAGE_NAME = airscript/tests:base
 BLOG_IMAGE_NAME = airscript/blog:compose
+DIND_IMAGE_NAME = docker:20.10.22-dind-alpine3.17
+
+DEVCONTAINER_NAME = airscript-devcontainer-base
+DEVCONTAINER_IMAGE_NAME = airscript/devcontainer:base
+DEVCONTAINER_CLI_IMAGE_NAME = airscript/devcontainer:cli
 
 .SUFFIXES:
 .SUFFIXES: .sh
 
 .PHONY: all
-all: build run
+all: setup build run
 
 .PHONY: setup
 setup:
@@ -76,9 +81,39 @@ run-ci:
 	docker run --rm $(CI_IMAGE_NAME) && \
 	docker rmi $(CI_IMAGE_NAME)
 
+.PHONY: all-devcontainer
+all-devcontainer: build-devcontainer run-devcontainer
+
+.PHONY: build-devcontainer
+build-devcontainer:
+	mkdir -p tmp
+	cp -r  .devcontainer .docker scripts Makefile tmp
+
+	docker build \
+		-f .docker/dockerfiles/devcontainer.Dockerfile \
+		-t $(DEVCONTAINER_IMAGE_NAME) .
+
+	rm -rf tmp
+
+.PHONY: run-devcontainer
+run-devcontainer:
+	docker run \
+		--rm \
+		--name $(DEVCONTAINER_NAME) \
+		--volume /var/run/docker.sock:/var/run/docker.sock \
+		$(DEVCONTAINER_IMAGE_NAME)
+
+	make clean-devcontainer
+
 .PHONY: clean-devcontainer
 clean-devcontainer:
-	sh ./scripts/environment/teardown.sh
+	docker rmi $(DIND_IMAGE_NAME) || true
+	docker rmi $(DEVCONTAINER_IMAGE_NAME)
+	docker rmi $(DEVCONTAINER_CLI_IMAGE_NAME)
+
+.PHONY: teardown-devcontainer
+teardown-devcontainer:
+	sh ./scripts/devcontainer/teardown.sh
 
 .PHONY: install-bash
 install-bash:
@@ -116,6 +151,18 @@ install-circleci-cli:
 install-netlify-cli:
 	bash ./scripts/install/netlify-cli.sh
 
+.PHONY: install-python3
+install-python3:
+	bash ./scripts/install/python3.sh
+
+.PHONY: install-gpp
+install-gpp:
+	bash ./scripts/install/gpp.sh
+
+.PHONY: install-devcontainer-cli
+install-devcontainer-cli:
+	bash ./scripts/install/devcontainer-cli.sh
+
 .PHONY: ci-verify
 ci-verify:
 	bash ./scripts/ci/verify.sh $(environment)

README.md

@@ -26,7 +26,6 @@ Please note that only one path between *Classic* and *Dev Container* has to be f
 
 3. Run the following commands in the repository's root folder:
     ```bash
-    make setup
     make all
     ```
 
@@ -52,7 +51,6 @@ To make it work here, be sure to have installed *Dev Containers* extension.
 
 4. Run the following commands in the repository's root folder:
     ```bash
-    make setup
     make all
     ```
 

scripts/environment/setup.sh → scripts/devcontainer/setup.sh

@@ -5,4 +5,4 @@ sh scripts/install/bash.sh && \
 bash scripts/install/git.sh && \
 bash scripts/install/make.sh && \
 
-bash scripts/environment/safeness.sh
+bash scripts/devcontainer/safeness.sh

scripts/devcontainer/teardown.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+DEVCONTAINER_NAME="airscript-devcontainer"
+DIND_IMAGE_NAME="docker:20.10.22-dind-alpine3.17"
+
+docker stop $DEVCONTAINER_NAME
+docker rm $DEVCONTAINER_NAME
+docker rmi $DIND_IMAGE_NAME

scripts/devcontainer/verify.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+devcontainer build --workspace-folder . --image-name airscript/devcontainer:cli

scripts/install/devcontainer-cli.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+npm install -g @devcontainers/cli && \
+echo "devcontainer CLI installed successfully."

scripts/install/gpp.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+apk add g++ && \
+echo "gpp installed successfully."

scripts/install/python3.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+apk add python3 && \
+echo "python3 installed successfully."

tests/install.bats

@@ -38,6 +38,18 @@ setup() {
     refute_output --partial "ERROR"
 }
 
+@test "Install gpp" {
+    run ./scripts/install/gpp.sh
+    assert_output --partial "$INSTALL_GPP"
+    refute_output --partial "ERROR"
+}
+
+@test "Install python3" {
+    run ./scripts/install/python3.sh
+    assert_output --partial "$INSTALL_PYTHON3"
+    refute_output --partial "ERROR"
+}
+
 @test "Install npm" {
     run ./scripts/install/npm.sh
     assert_output --partial "$INSTALL_NPM"
@@ -50,6 +62,12 @@ setup() {
     refute_output --partial "ERR!"
 }
 
+@test "Install devcontainer CLI" {
+    run ./scripts/install/devcontainer-cli.sh
+    assert_output --partial "$INSTALL_DEVCONTAINER_CLI"
+    refute_output --partial "ERR!"
+}
+
 @test "Install Bats" {
     run ./scripts/install/bats.sh
     assert_output --partial "$INSTALL_BATS"

tests/mocks.sh

@@ -1,14 +1,18 @@
 #!/bin/bash
 readonly INSTALL_NPM="npm installed successfully."
 readonly INSTALL_GIT="Git installed successfully."
+readonly INSTALL_GPP="gpp installed successfully."
 readonly INSTALL_BATS="Bats installed successfully."
 readonly INSTALL_HUGO="Hugo installed successfully."
 readonly INSTALL_MAKE="Make installed successfully."
 readonly INSTALL_CURL="curl installed successfully."
 readonly INSTALL_BASH="Bash installed successfully."
-readonly SKIP_INSTALL_GIT="Git installation has been skipped."
+readonly INSTALL_PYTHON3="python3 installed successfully."
 readonly INSTALL_DOCKER_CLI="Docker CLI installed successfully."
 readonly INSTALL_NETLIFY_CLI="Netlify CLI installed successfully."
-readonly ADD_GIT_SUBMODULE_SKIPPED="Git submodule update skipped."
 readonly INSTALL_CIRCLECI_CLI="CircleCI CLI installed successfully."
+readonly INSTALL_DEVCONTAINER_CLI="devcontainer CLI installed successfully."
+
+readonly SKIP_INSTALL_GIT="Git installation has been skipped."
+readonly ADD_GIT_SUBMODULE_SKIPPED="Git submodule update skipped."
 readonly ADD_GIT_SUBMODULE_EXECUTED="Git submodule update executed."