feat(ci): #39 add GitHub Actions workflow for build and test (#40)

Author: amerkurev

.github/workflows/ci.yml

@@ -0,0 +1,72 @@
+name: build
+
+on:
+    push:
+      branches:
+        - master
+        - 39-create-a-new-ciyml
+      tags:
+        - '*'
+      paths-ignore:
+        - '*.md'
+    pull_request:
+      paths-ignore:
+        - '*.md'
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: Set up Docker Buildx
+              id: buildx
+              uses: docker/setup-buildx-action@v3
+
+            - name: Build Docker image
+              env:
+                GITHUB_REF: ${{ github.ref }}
+              run: |
+                make info
+                make build
+
+            - name: Test and Lint
+              run: |
+                make test
+                make lint
+
+            - name: Report coverage
+              env:
+                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              run: |
+                pip install coveralls
+                cd app && coveralls --service=github
+
+            - name: Available platforms
+              run: |
+                echo "Name:      ${{ steps.buildx.outputs.name }}"
+                echo "Endpoint:  ${{ steps.buildx.outputs.endpoint }}"
+                echo "Status:    ${{ steps.buildx.outputs.status }}"
+                echo "Flags:     ${{ steps.buildx.outputs.flags }}"
+                echo "Platforms: ${{ steps.buildx.outputs.platforms }}"
+
+            - name: Deploy tagged (latest) to GitHub Packages (ghcr.io) and DockerHub
+              if: ${{ startsWith(github.ref, 'refs/tags/') }}
+              env:
+                GITHUB_PACKAGE_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                DOCKER_HUB_TOKEN: ${{ secrets.DOCKER_HUB_TOKEN }}
+                USERNAME: ${{ github.actor }}
+                GITHUB_SHA: ${{ github.sha }}
+                GITHUB_REF: ${{ github.ref }}
+              run: |
+                ref="$(echo ${GITHUB_REF} | cut -d'/' -f3)"
+                echo GITHUB_REF - $ref
+                echo ${GITHUB_PACKAGE_TOKEN} | docker login ghcr.io -u ${USERNAME} --password-stdin
+                echo ${DOCKER_HUB_TOKEN} | docker login -u ${USERNAME} --password-stdin
+                docker buildx build --push \
+                  --build-arg CI=github --build-arg GIT_SHA=${GITHUB_SHA} --build-arg GIT_TAG=${ref} \
+                  --platform linux/amd64,linux/arm/v7,linux/arm64 \
+                  -t ghcr.io/${USERNAME}/doku:${ref} \
+                  -t ${USERNAME}/doku:${ref} .

.github/workflows/docs.yml

@@ -16,7 +16,8 @@ COPY --from=builder /install /usr/local
 ARG APP_DIR=/usr/src/app
 ARG SUPERVISOR_CONF=/usr/local/etc/supervisord.conf
 ARG GITHUB_REPO=amerkurev/doku
-ARG REV
+ARG GIT_SHA
+ARG GIT_TAG
 
 # this is used in the code
 LABEL github.repo=$GITHUB_REPO
@@ -31,14 +32,14 @@ LABEL org.opencontainers.image.source="https://github.com/amerkurev/doku"
 ENV IN_DOCKER=1 \
 	# used in supervisord.conf
 	APP_DIR=$APP_DIR \
-	GITHUB_REPO=$GITHUB_REPO
+	GITHUB_REPO=$GITHUB_REPO \
+	GIT_SHA=$GIT_SHA \
+	GIT_TAG=$GIT_TAG
 
 
 COPY app $APP_DIR
 COPY conf/supervisord.conf $SUPERVISOR_CONF
 
-RUN echo "revision = '${REV}'" | tee $APP_DIR/version.py
-
 WORKDIR $APP_DIR
 
 CMD ["supervisord", "-c", "/usr/local/etc/supervisord.conf"]

Dockerfile

@@ -1,23 +1,27 @@
-GIT_BRANCH=$(shell git rev-parse --abbrev-ref HEAD)
-GIT_SHA=$(shell git rev-parse --short HEAD)
-GIT_TAG=$(shell git describe --tags --abbrev=0 2>/dev/null || echo "0.0.0")
-BUILD_DATE=$(shell date +%Y%m%d-%H:%M:%S)
-# If we're exactly on a tag, just show tag, otherwise show detailed version with commits
-GIT_DESCRIBE=$(shell git describe --tags 2>/dev/null)
-ifeq ($(GIT_TAG),$(GIT_DESCRIBE))
-    # We're exactly on a tag
-    REV=$(GIT_TAG) ($(BUILD_DATE))
+ifdef GITHUB_REF
+    # CI environment - use provided ref
+    GIT_TAG=$(shell echo $(GITHUB_REF) | cut -d'/' -f3)
 else
-    # We're off a tag
-    REV=$(shell git describe --tags) ($(BUILD_DATE))
+    # Local environment - calculate from git
+	GIT_TAG=$(shell git describe --tags --abbrev=0 2>/dev/null || git rev-parse --abbrev-ref HEAD)
 endif
+
+ifdef GITHUB_SHA
+	# CI environment - use provided sha
+	GIT_SHA=$(GITHUB_SHA)
+else
+	# Local environment - calculate from git
+	GIT_SHA=$(shell git rev-parse --short HEAD)
+endif
+
+REV=$(GIT_TAG)-$(GIT_SHA)
 PWD=$(shell pwd)
 
 info:
 	- @echo "revision $(REV)"
 
 build:
-	- @docker buildx build --build-arg REV="${REV}" -t amerkurev/doku:latest --progress=plain .
+	- @docker buildx build --load --build-arg GIT_SHA="${GIT_SHA}" --build-arg GIT_TAG="${GIT_TAG}" -t amerkurev/doku:latest --progress=plain .
 
 lint:
 	- @ruff check app
@@ -27,6 +31,8 @@ fmt: lint
 
 test:
 	- @docker run --rm -t -v $(PWD)/app:/usr/src/app amerkurev/doku ./pytest.sh
+
+cov:
 	- @docker run --rm -t -v $(PWD)/app:/usr/src/app amerkurev/doku coverage html
 
 dev: build
@@ -44,4 +50,4 @@ dev: build
 	  -p 9090:9090 \
 	  amerkurev/doku
 
-.PHONY: info build lint fmt dev
+.PHONY: info build lint fmt test cov dev

Makefile

@@ -27,6 +27,8 @@
 
 
 def total_size(items: Sequence | None, field_name='size') -> str:
+    if items is None:
+        return '0'
     total = sum(map(attrgetter(field_name), items))
     return pretty_size(total)
 

app/server/router/context.py

@@ -0,0 +1,34 @@
+from dataclasses import dataclass
+
+from server.router.context import total_size
+
+
+@dataclass
+class Item:
+    size: int
+
+
+@dataclass
+class ItemShared:
+    shared_size: int
+
+
+def test_total_size():
+    # Test total_size function
+    items = [
+        Item(size=1),
+        Item(size=2),
+        Item(size=3),
+    ]
+    assert total_size(items) == '6 Bytes'
+
+    items = [
+        ItemShared(shared_size=1024),
+        ItemShared(shared_size=1024 * 1024),
+        ItemShared(shared_size=1024 * 1024 * 1024),
+    ]
+    assert total_size(items, field_name='shared_size') == '1.1 GB'
+
+    assert total_size([]) == '0'
+
+    assert total_size(None) == '0'

app/server/tests/test_context.py

@@ -8,11 +8,6 @@
 from pydantic import Field, PositiveInt, ValidationError, field_validator
 from pydantic_settings import BaseSettings
 
-from version import revision
-
-
-REVISION = revision  # e.g. 'v1.0.0 (20250301-00:56:09)'
-VERSION = REVISION.split()[0]  # 'v1.0.0'
 
 load_dotenv()  # take environment variables from .env.
 
@@ -75,6 +70,10 @@ class Settings(BaseSettings):
     docker_max_pool_size: PositiveInt = Field(alias='DOCKER_MAX_POOL_SIZE', default=docker.DEFAULT_MAX_POOL_SIZE)
     docker_use_ssh_client: bool = Field(alias='DOCKER_USE_SSH_CLIENT', default=False)
 
+    # version settings
+    git_tag: str = Field(alias='GIT_TAG', default='v0.0.0')
+    git_sha: str = Field(alias='GIT_SHA', default='')
+
     @field_validator('log_level', mode='before')
     def lowercase_log_level(cls, v):
         if isinstance(v, str):
@@ -99,6 +98,9 @@ def log_level_num(self) -> int:
     raise SystemExit(err) from err
 
 
+VERSION = _settings.git_tag
+REVISION = f'{_settings.git_tag}-{_settings.git_sha[:7]}'
+
 # general settings
 HOST = _settings.host
 PORT = _settings.port