Merge pull request #13 from qdrvm/feature/docker

Feature/docker

Author: zerg-su

.ci/.env

@@ -0,0 +1,34 @@
+LINUX_PACKAGES="make \
+  autoconf \
+  automake \
+  build-essential \
+  cargo \
+  curl \
+  git \
+  libtool \
+  ninja-build \
+  pkg-config \
+  python3.12 \
+  python3.12-dev \
+  python3.12-venv \
+  python3-pip \
+  unzip \
+  zip \
+  nano"
+
+MACOS_PACKAGES="make \
+  autoconf \
+  automake \
+  rust \
+  curl \
+  git \
+  libtool \
+  ninja \
+  pkg-config \
+  python@3.12 \
+  unzip \
+  zip"
+
+CMAKE_VERSION=3.31.1
+VCPKG_FORCE_SYSTEM_BINARIES=1
+DEBIAN_FRONTEND=noninteractive

.ci/scripts/detect_os.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -euo pipefail
+# set -x
+
+detect_os() {
+  if [[ "$OSTYPE" == "linux-gnu"* ]]; then
+    if command -v apt >/dev/null 2>&1; then
+      echo "linux_deb"
+    else
+      echo "linux_other"
+    fi
+  elif [[ "$OSTYPE" == "darwin"* ]]; then
+    echo "macos"
+  else
+    echo "unknown"
+  fi
+}
+
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+  echo "This script is intended to be sourced or used as a library."
+  echo "Exported functions: detect_os"
+  exit 1
+fi

.ci/scripts/init.sh

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+set -euo pipefail
+# set -x
+trap 'echo "=== Error on line $LINENO"; exit 1' ERR
+
+SCRIPT_DIR="$(dirname "${BASH_SOURCE[0]}")"
+OS_SELECT=$(source ${SCRIPT_DIR}/detect_os.sh && detect_os)
+
+set -o allexport && . ${SCRIPT_DIR}/../.env && set +o allexport
+
+main() {
+  case "$OS_SELECT" in
+    linux_deb)
+      echo "=== Detected Linux system with apt"
+      apt update && apt install -y  $LINUX_PACKAGES
+      ;;
+    linux_other)
+      echo "=== Detected Linux system without apt"
+      echo "=== Support for other package managers is not added"
+      ;;
+    macos)
+      echo "=== Detected macOS system"
+      if command -v brew >/dev/null 2>&1; then
+        echo "=== Homebrew found. Installing packages..."
+        brew update && brew install $MACOS_PACKAGES
+      else
+        echo "=== Homebrew is not installed. Install it before proceeding: https://brew.sh"
+      fi
+      ;;
+    *)
+      echo "=== Unknown system"
+      ;;
+  esac
+}
+
+main
+
+exit 0

.ci/scripts/init_py.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+set -euo pipefail
+# set -x
+
+init_py() {
+  echo "$VENV"
+  python3 -m venv "$VENV"
+  source $VENV/bin/activate
+  pip3 install cmake==${CMAKE_VERSION}
+  pip3 install --no-cache-dir -r ${PROJECT}/python/requirements.txt
+}
+
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+  echo "This script is intended to be sourced or used as a library."
+  echo "Exported functions: init_py"
+  exit 1
+fi

.ci/scripts/init_vcpkg.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+set -euo pipefail
+# set -x
+
+init_vcpkg() {
+  if [[ ! -e $VCPKG ]]; then
+    git clone https://github.com/microsoft/vcpkg.git $VCPKG
+  fi
+  if [[ ! -e $VCPKG/vcpkg ]]; then
+    $VCPKG/bootstrap-vcpkg.sh -disableMetrics
+  fi
+}
+
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+  echo "This script is intended to be sourced or used as a library."
+  echo "Exported functions: init_vcpkg"
+  exit 1
+fi

.gitignore

@@ -35,3 +35,6 @@
 .idea
 
 /build
+/.build
+/.venv
+/.vcpkg

Makefile

@@ -0,0 +1,53 @@
+SHELL := /bin/bash
+PROJECT := $(shell pwd)
+CI_DIR := $(PROJECT)/.ci
+
+VENV=$(PROJECT)/.venv
+BUILD=$(PROJECT)/.build
+VCPKG=$(PROJECT)/.vcpkg
+PATH=$(VENV)/bin:$(shell echo $$PATH)
+
+ifneq (,$(wildcard $(CI_DIR)/.env))
+    include $(CI_DIR)/.env
+    export
+endif
+
+OS_TYPE := $(shell bash -c 'source $(CI_DIR)/scripts/detect_os.sh && detect_os')
+
+
+all: init_all configure build test
+
+init_all: init init_py init_vcpkg
+
+os:
+	@echo "=== Detected OS: $(OS_TYPE)"
+
+init:
+	@echo "=== Initializing..."
+	$(CI_DIR)/scripts/init.sh
+
+init_py:
+	@echo "=== Initializing Python..."
+	source $(CI_DIR)/scripts/init_py.sh && init_py
+
+init_vcpkg:
+	@echo "=== Initializing Vcpkg..."
+	source $(CI_DIR)/scripts/init_vcpkg.sh && init_vcpkg
+
+configure:
+	@echo "=== Configuring..."
+	VCPKG_ROOT=$(VCPKG) cmake --preset=default -DPython3_EXECUTABLE="$(VENV)/bin/python3" -B $(BUILD) $(PROJECT)
+
+build:
+	@echo "=== Building..."
+	cmake --build $(BUILD) 
+
+test:
+	@echo "=== Testing..."
+	ctest --test-dir $(BUILD)
+
+clean_all:
+	@echo "=== Cleaning..."
+	rm -rf $(VENV) $(BUILD) $(VCPKG)	
+
+.PHONY: all init_all os init init_py init_vcpkg configure build test clean_all

docker/ci-docker

@@ -0,0 +1,71 @@
+#!/usr/bin/env -S bash -e
+
+
+
+# TODO(docker-volume): /root/.cache/pip
+# TODO(docker-volume): /root/.cache/vcpkg
+# TODO(docker-volume): /root/.cargo
+
+
+
+# paths
+PROJECT=/cpp-jam
+VENV=$PROJECT.venv
+BUILD=$PROJECT.build
+VCPKG=/vcpkg
+
+
+
+# DOCKER: FROM ubuntu:24.04 AS base
+
+# apt install
+apt update
+DEBIAN_FRONTEND=noninteractive apt install --no-install-recommends -y \
+  autoconf \
+  automake \
+  build-essential \
+  cargo \
+  curl \
+  git \
+  libtool \
+  ninja-build \
+  pkg-config \
+  python3 \
+  python3-dev \
+  python3-pip \
+  python3-venv \
+  unzip \
+  zip \
+
+# create python venv
+python3 -m venv $VENV
+PATH=$VENV/bin:$PATH
+
+# install cmake
+pip3 install cmake
+
+# install vcpkg
+export VCPKG_FORCE_SYSTEM_BINARIES=1
+if [[ ! -e $VCPKG ]]; then
+  git clone https://github.com/microsoft/vcpkg.git $VCPKG
+fi
+if [[ ! -e $VCPKG/vcpkg ]]; then
+  $VCPKG/bootstrap-vcpkg.sh -disableMetrics
+fi
+
+
+
+# DOCKER: FROM base AS ci
+
+# install project requirements
+pip3 install -r $PROJECT/python/requirements.txt
+
+# configure
+rm -rf $BUILD
+VCPKG_ROOT=$VCPKG cmake --preset=default -B $BUILD $PROJECT
+
+# build
+cmake --build $BUILD
+
+# run tests
+ctest --test-dir $BUILD

docker/ci-docker-run

@@ -0,0 +1,9 @@
+#!/usr/bin/env -S bash -e
+
+LOCAL=$PWD
+
+[[ -d $LOCAL/docker ]]
+
+docker run --rm -it \
+  -v $LOCAL:/cpp-jam \
+  ubuntu:24.04 /cpp-jam/docker/ci-docker