chore: local docker container dev (#7)

Author: alex-courtis

.github/workflows/ci.yml

@@ -23,34 +23,23 @@ jobs:
       DEBUGINFOD_URLS: "https://debuginfod.archlinux.org" # profile thus debuginfod.sh is not executed
 
     steps:
+      - uses: actions/checkout@v4
+
       - name: create user
         shell: sh -e {0}
         # magic numbers and names not available in environment
         run: |
           groupadd --gid 118 docker
           useradd -m -s /bin/sh --uid 1001 --gid docker runner
 
-      - name: install packages
-        shell: sh -e {0}
-        run: |
-          pacman --noconfirm -Sy \
-          clang \
-          cmake \
-          cmocka \
-          cppcheck \
-          git \
-          lib32-cmocka \
-          llvm \
-          llvm-libs \
-          ninja \
-          valgrind
-
-      - uses: actions/checkout@v4
-
       - name: set source permissions
         run: chown -R runner:docker .
         shell: sh -e {0}
 
+      - name: install packages
+        shell: sh -e {0}
+        run: .github/workflows/packages/base/install.sh
+
       - run: make CC=gcc               clean test
       - run: make CC=clang             clean test
       - run: make                      clean cppcheck
@@ -62,11 +51,9 @@ jobs:
       - run: make CC=clang MFLAGS=-m32 clean test-vg
 
       - name: build include-what-you-use package
-        run: |
-          git clone https://aur.archlinux.org/include-what-you-use.git /tmp/include-what-you-use
-          makepkg OPTIONS=-debug PKGEXT='.pkg.tar' --dir /tmp/include-what-you-use
+        run: .github/workflows/packages/include-what-you-use/build.sh
       - name: install include-what-you-use package
-        run: pacman -U --noconfirm /tmp/include-what-you-use/*.pkg.tar
+        run: .github/workflows/packages/include-what-you-use/install.sh
         shell: sh -e {0}
 
       - run: make clean iwyu

.github/workflows/packages/base/install.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+pacman --noconfirm -Syu \
+	clang \
+	cmake \
+	cmocka \
+	cppcheck \
+	git \
+	lib32-cmocka \
+	llvm \
+	llvm-libs \
+	ninja \
+	valgrind

.github/workflows/packages/include-what-you-use/build.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+# must be run as a user
+
+rm -rf /tmp/include-what-you-use
+
+git clone https://aur.archlinux.org/include-what-you-use.git /tmp/include-what-you-use
+
+makepkg OPTIONS=-debug PKGEXT='.pkg.tar' --dir /tmp/include-what-you-use

.github/workflows/packages/include-what-you-use/install.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+pacman -U --noconfirm /tmp/include-what-you-use/*.pkg.tar

Dockerfile

@@ -0,0 +1,14 @@
+# docker image for local dev
+# Keep this in sync with ci.yml
+# GH CI doesn't allow use of a Dockerfile, hence we maintain this separately
+
+FROM archlinux:multilib-devel
+
+COPY .github/workflows/packages/base/install.sh /usr/local/bin/packages-base-install.sh
+
+RUN packages-base-install.sh
+
+ENV DEBUGINFOD_URLS="https://debuginfod.archlinux.org"
+ENV DEBUGINFOD_CACHE_PATH="/tmp/debuginfod_client"
+
+ENTRYPOINT [ "sleep", "infinity" ]

GNUmakefile

@@ -21,6 +21,9 @@ $(TST_E): $(SRC_O) $(TST_O)
 clean:
 	rm -f $(SRC_O) $(TST_O) $(TST_E)
 
+#
+# valgrind
+#
 %-vg: VALGRIND = valgrind \
 	--error-exitcode=1 \
 	--leak-check=full \
@@ -29,12 +32,18 @@ clean:
 	--gen-suppressions=all
 %-vg: % ;
 
+#
+# test
+#
 test: $(TST_T)
 test-vg: $(TST_T)
 
 $(TST_T): $(TST_E)
 	$(VALGRIND) ./$(patsubst test-%,tst-%,$(@))
 
+#
+# iwyu
+#
 IWYU = include-what-you-use \
 	   -Xiwyu --no_fwd_decls \
 	   -Xiwyu --error=1 \
@@ -43,6 +52,9 @@ IWYU = include-what-you-use \
 iwyu: CC = $(IWYU) -Xiwyu --check_also="inc/*h"
 iwyu: clean $(SRC_O) $(TST_O)
 
+#
+# cppcheck
+#
 cppcheck: $(INC_H) $(SRC_C) $(TST_H) $(TST_C)
 	cppcheck $(^) \
 		--enable=warning,unusedFunction,performance,portability \
@@ -51,6 +63,28 @@ cppcheck: $(INC_H) $(SRC_C) $(TST_H) $(TST_C)
 		--error-exitcode=1 \
 		$(CPPFLAGS)
 
+#
+# local docker dev
+#
+docker-build:
+	docker build --tag "alex-c-collections:latest" .
+
+docker-stop:
+	docker rm -f alex-c-collections || true
+
+docker-run: docker-stop
+	docker run \
+		--name="alex-c-collections" \
+		--volume "${PWD}:/alex-c-collections" \
+		--workdir="/alex-c-collections" \
+		--user "`id -u`:`id -g`" \
+		--detach \
+		"alex-c-collections:latest"
+
+docker-packages:
+	docker exec                    alex-c-collections .github/workflows/packages/include-what-you-use/build.sh
+	docker exec --user "root:root" alex-c-collections .github/workflows/packages/include-what-you-use/install.sh
+
 .PHONY: all clean test test-vg $(TST_T) iwyu cppcheck
 
 .NOTPARALLEL: iwyu test test-vg