Merge pull request #7 from fastapi-mvc/refactor_to_nix_flake

Refactor to nix flake

Author: rszamszur

.github/workflows/main.yml

@@ -45,7 +45,7 @@ jobs:
       - name: Install Nix ❄️
         uses: cachix/install-nix-action@v18
         with:
-          nix_path: nixpkgs=channel:nixos-22.05
+          nix_path: nixpkgs=channel:nixos-22.11
       - name: Setup Cachix ❄️
         uses: cachix/cachix-action@v12
         with:
@@ -64,7 +64,7 @@ jobs:
       - name: Generate poetry.lock
         if: steps.lock-cache.outputs.cache-hit != 'true'
         working-directory: ./example
-        run: nix-shell -p poetry --run "poetry lock --no-update"
+        run: NIXPKGS_ALLOW_INSECURE=1 nix-shell -p poetry --run "poetry lock --no-update"
       - name: Set short commit SHA
         run: echo "SHORT_SHA=${GITHUB_SHA::7}" >> $GITHUB_ENV
       - name: Push generated test project

template/Makefile.jinja

@@ -10,21 +10,73 @@ endif
 SHELL=/usr/bin/env bash -o pipefail -o errexit
 
 TAG ?= $(shell cat TAG)
-{%- if nix %}
-USE_NIX ?= $(shell command -v nix || echo "False")
-{% endif %}
+POETRY_HOME ?= ${HOME}/.local/share/pypoetry
+POETRY_BINARY ?= ${POETRY_HOME}/venv/bin/poetry
+POETRY_VERSION ?= 1.2.0
+
 help:  ## Display this help
 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
 .PHONY: show-version
 show-version:  ## Display version
 	echo -n "${TAG}"
-{% if nix %}
-ifeq ($(USE_NIX), False)
-include Poetry.mk
-else
-include Nix.mk
-endif
-{% else %}
-include Poetry.mk
+
+.PHONY: build
+build: ## Build {{project_name}} package
+	echo "[build] Build {{project_name}} package."
+	${POETRY_BINARY} build
+
+.PHONY: install
+install:  ## Install {{project_name}} with poetry
+	@build/install.sh
+
+.PHONY: image
+image:  ## Build {{container_image_name}} image
+	@build/image.sh
+
+.PHONY: metrics
+metrics: install ## Run {{project_name}} metrics checks
+	echo "[metrics] Run {{project_name}} PEP 8 checks."
+	${POETRY_BINARY} run flake8 --select=E,W,I --max-line-length 80 --import-order-style pep8 --statistics --count {{package_name}}
+	echo "[metrics] Run {{project_name}} PEP 257 checks."
+	${POETRY_BINARY} run flake8 --select=D --ignore D301 --statistics --count {{package_name}}
+	echo "[metrics] Run {{project_name}} pyflakes checks."
+	${POETRY_BINARY} run flake8 --select=F --statistics --count {{package_name}}
+	echo "[metrics] Run {{project_name}} code complexity checks."
+	${POETRY_BINARY} run flake8 --select=C901 --statistics --count {{package_name}}
+	echo "[metrics] Run {{project_name}} open TODO checks."
+	${POETRY_BINARY} run flake8 --select=T --statistics --count {{package_name}} tests
+	echo "[metrics] Run {{project_name}} black checks."
+	${POETRY_BINARY} run black -l 80 --check {{package_name}}
+
+.PHONY: unit-test
+unit-test: install ## Run {{project_name}} unit tests
+	echo "[unit-test] Run {{project_name}} unit tests."
+	${POETRY_BINARY} run pytest tests/unit
+
+.PHONY: integration-test
+integration-test: install ## Run {{project_name}} integration tests
+	echo "[unit-test] Run {{project_name}} integration tests."
+	${POETRY_BINARY} run pytest tests/integration
+
+.PHONY: coverage
+coverage: install  ## Run {{project_name}} tests coverage
+	echo "[coverage] Run {{project_name}} tests coverage."
+	${POETRY_BINARY} run pytest --cov-config=.coveragerc --cov={{package_name}} --cov-fail-under=90 --cov-report=xml --cov-report=term-missing tests
+
+.PHONY: test
+test: unit-test integration-test  ## Run {{project_name}} tests
+
+.PHONY: docs
+docs: install ## Build {{project_name}} documentation
+	echo "[docs] Build {{project_name}} documentation."
+	${POETRY_BINARY} run sphinx-build docs site
+{% if helm %}
+.PHONY: dev-env
+dev-env: image ## Start a local Kubernetes cluster using minikube and deploy application
+	@build/dev-env.sh
+
+.PHONY: clean
+clean: ## Remove .cache directory and cached minikube
+	minikube delete && rm -rf ~/.cache ~/.minikube
 {% endif %}

template/Poetry.mk.jinja

@@ -2,7 +2,11 @@ name: CI
 
 on:
   push:
+    branches:
+      - master
   pull_request:
+    branches:
+      - master
 
 env:
   POETRY_HOME: /opt/poetry
@@ -54,7 +58,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python
+      - name: Set up Python 3.9
         uses: actions/setup-python@v4
         with:
           python-version: 3.9
@@ -74,22 +78,18 @@ jobs:
   metrics:
     needs: install
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: [ '3.8', '3.9', '3.10' ]
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python 3.9
         uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: 3.9
       - name: Load Poetry cache
         uses: actions/cache@v3
         with:
           path: ${{ env.POETRY_HOME }}
-          key: ${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('./pyproject.toml') }}-{{ hashFiles('./poetry.lock') }}
+          key: ${{ runner.os }}-3.9-${{ hashFiles('./pyproject.toml') }}-{{ hashFiles('./poetry.lock') }}
       - name: Run metrics checks
         run: make metrics
   unit-tests:
@@ -140,7 +140,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python 3.9
         uses: actions/setup-python@v4
         with:
           python-version: 3.9

template/{% if github_actions %}.github{% endif %}/workflows/main.yml

@@ -1,12 +1,6 @@
 {% raw %}name: K8s integration
 
 on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
   workflow_dispatch:
 
 jobs:

template/{% if github_actions %}.github{% endif %}/workflows/{% if helm %}integration.yml{% endif %}.jinja

@@ -10,7 +10,7 @@ on:
       - master
 
 env:
-  NIX_CHANNEL: nixpkgs=channel:nixos-22.05
+  NIX_CHANNEL: nixpkgs=channel:nixos-22.11
 
 jobs:
   # This job checks if an identical workflow is being triggered by different
@@ -27,7 +27,7 @@ jobs:
           skip_after_successful_duplicate: 'true'
           concurrent_skipping: same_content
           do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]'
-  nixpkgs-fmt:
+  nix-checks:
     needs: pre_job
     if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
     runs-on: ubuntu-latest
@@ -39,9 +39,19 @@ jobs:
       - uses: actions/checkout@v3
       - name: Check format
         run: nix-shell -p nixpkgs-fmt --run 'nixpkgs-fmt --check .'
+      - name: Run nix flake check
+        run: nix flake check
+      - name: Run metrics checks
+        run: nix run .#metrics
+      - name: Run tests
+        run: nix run .#test
   nix-build:
     needs: pre_job
     if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ '38', '39', '310' ]
     runs-on: ubuntu-latest
 
     steps:
@@ -59,43 +69,6 @@ jobs:
         with:
           name: fastapi-mvc
           authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-      - name: Install make
-        run: nix-env -i gnumake -f '<nixpkgs>'
-      - name: Build package
-        run: make build
-      - name: Build container image
-        run: make image
-  nix-ci:
-    needs: pre_job
-    if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: [ 'python38', 'python39', 'python310' ]
-    env:
-      PYTHON_NIXPKG: ${{ matrix.python-version }}
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install Nix
-        uses: cachix/install-nix-action@v17
-        with:
-          nix_path: ${{ env.NIX_CHANNEL }}
-      # Remove bellow step if you do not want to use Cachix - Nix binary cache.
-      # For OpenSource projects there is free 5GB of storage.
-      # https://www.cachix.org
-      - name: Setup Cachix Nix cache
-        uses: cachix/cachix-action@v10
-        with:
-          name: fastapi-mvc
-          authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-      - name: Install make
-        run: nix-env -i gnumake -f '<nixpkgs>'
-      - name: Run metrics checks
-        run: make metrics
-      - name: Run test
-        run: make test
-      - name: Run coverage
-        run: make coverage
+      - name: {% endraw %}Build {{project_name}}
+        run: nix build .#{{project_name}}-py{% raw %}${{ matrix.python-version }}
 {%- endraw %}