Add services api and github actions

Author: Jozef Volak

.github/scripts/bump-version

@@ -0,0 +1,80 @@
+#!/bin/env python3
+
+"""
+This script provides a utility for semantic versioning.
+
+It allows you to determine the version change type (MAJOR, MINOR, PATCH)
+based on comparing old and new versions, and also bump the version
+accordingly.
+
+Usage:
+    python bump-version --last-image 1.0.0  --new-image 2.0.1 --last-lib 1.0.0
+
+Output:
+    LEVEL=MAJOR
+    VERSION=2.0.0
+"""
+
+import argparse
+from enum import Enum
+
+
+class SemanticVersion(Enum):
+    PATCH = 'patch'
+    MINOR = 'minor'
+    MAJOR = 'major'
+
+
+def parse_version(version: str):
+    major, minor, patch = map(int, version.split('.'))
+    return major, minor, patch
+
+
+def get_version_change(old_version: str, new_version: str):
+    old_major, old_minor, old_patch = parse_version(old_version)
+    new_major, new_minor, new_patch = parse_version(new_version)
+
+    if new_major > old_major:
+        return SemanticVersion.MAJOR
+    elif new_minor > old_minor:
+        return SemanticVersion.MINOR
+    elif new_patch > old_patch:
+        return SemanticVersion.PATCH
+
+
+def bump_version(old_version: str, version_change: SemanticVersion):
+    major, minor, patch = parse_version(old_version)
+
+    if version_change is SemanticVersion.PATCH:
+        patch += 1
+    elif version_change is SemanticVersion.MINOR:
+        minor += 1
+        patch = 0
+    elif version_change is SemanticVersion.MAJOR:
+        major += 1
+        minor = 0
+        patch = 0
+
+    return f"{major}.{minor}.{patch}"
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Semantic Versioning Utility")
+    parser.add_argument("--last-image", type=str, required=True,  help="Old docker image version")
+    parser.add_argument("--new-image", type=str, required=True, help="New docker image version")
+    parser.add_argument("--last-lib", type=str, required=True, help="Old package version")
+    parser.add_argument("--output", type=str, default='VERSION', choices=['VERSION', 'LEVEL'],  help="Old package version")
+
+    args = parser.parse_args()
+
+    version_change = get_version_change(args.last_image, args.new_image)
+    bumped_version = bump_version(args.last_lib, version_change)
+
+    if args.output == "VERSION":
+        print(bumped_version)
+    elif args.output == "LEVEL":
+        print(version_change)
+
+
+if __name__ == "__main__":
+    main()

.github/scripts/find-nearest-lower-version

@@ -0,0 +1,77 @@
+#!/usr/bin/env python3
+
+"""
+This script finds the nearest lower version of a Docker image in the release matrix table
+based on the provided version.
+
+Usage:
+    python find_nearest_lower_version.py --version 4.5.2 --path RELEASE.md
+
+Example:
+    python find_nearest_lower_version.py --version 4.5.2 --path RELEASE.md
+
+Input:
+    --image-tag: Version to find the nearest lower version for.
+    --path: Path to the RELEASE.md file.
+
+Output:
+    The nearest lower version of the Docker image based on the provided version.
+"""
+
+import re
+import argparse
+import sys
+from typing import Any
+from enum import Enum
+
+
+class Exit(Enum):
+    OK = 0
+    ERROR = 1
+
+
+def find_lower_versions(version: str, release_file: str) -> Any:
+    table_pattern = re.compile(r'\| Docker Image Tag \| Python Library Version \|\n\|(.+)\n', re.DOTALL)
+    match = table_pattern.search(release_file)
+    if match:
+        table = match.group(1).strip().split("\n")
+        table = table[1:]
+        lower_version: dict[str, Any] = {}
+        for row in table:
+            docker_version = row.split('|')[1]
+            lib_version = row.split('|')[2]
+            if docker_version.strip() < version:
+                lower_version = dict(
+                        docker=docker_version.strip(),
+                        lib=lib_version.strip(),
+                )
+            elif docker_version.strip() == version:
+                print(f'Version {version} already exist')
+                raise Exception()
+        return lower_version
+
+
+def main() -> Exit:
+    parser = argparse.ArgumentParser(description="Find nearest lower version of Docker image")
+    parser.add_argument("--image-tag", type=str, required=True, help="Version")
+    parser.add_argument("--path", type=str, required=True, help="RELEASE.md path")
+
+    args = parser.parse_args()
+
+    try:
+        with open(args.path, 'r') as f:
+            content = f.read()
+
+        version = find_lower_versions(args.image_tag, content)
+
+        print(f'LAST_DOCKER_TAG={version.get("docker", args.image_tag)}')
+        print(f'LAST_LIB_VERSION={version.get("lib", "1.0.0")}')
+
+    except Exception:
+        return Exit.ERROR
+
+
+if __name__ == '__main__':
+    sys.exit(main())
+
+

.github/scripts/release-update

@@ -0,0 +1,68 @@
+#!/bin/env python3
+
+"""
+This script updates the release matrix table in a RELEASE.md file
+by adding a new row with the specified Docker image tag and Python library version.
+
+Usage:
+    python release-update.py --image-tag 4.0.0 --lib-version 2.0.0 --path RELEASE.md
+
+Example:
+    python release-update.py --image-tag 4.0.0 --lib-version 2.0.0 --path RELEASE.md
+
+Input:
+    --image-tag: Docker image tag.
+    --lib-version: Python library version.
+    --path: Path to the RELEASE.md file.
+
+Output:
+    The specified RELEASE.md file will be updated with the new row in the release matrix table.
+"""
+
+
+import re
+import argparse
+
+
+def find_insertion_index(table, version):
+    for i, row in enumerate(table):
+        docker_version = row.split('|')[1].strip()
+        if docker_version >= version:
+            return i
+    return len(table)
+
+
+def update_release_matrix(release_file: str, image_tag: str, lib_version: str) -> None:
+    with open(release_file, 'r') as f:
+        content = f.read()
+
+    table_pattern = re.compile(r'\| Docker Image Tag \| Python Library Version \|\n\|(.+)', re.DOTALL)
+    match = table_pattern.search(content)
+
+    if match:
+        table = match.group(1).strip().split("\n")
+        new_row = f"| {image_tag} | {lib_version} |"
+        insertion_index = find_insertion_index(table, image_tag)
+
+        table.insert(insertion_index, new_row)
+        updated_table = "\n".join(table)
+        updated_content = content.replace(table_pattern.search(content).group(1), updated_table)
+        with open(release_file, 'w') as f:
+            f.write(updated_content)
+
+    else:
+        print("Table not found in the release file.")
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Update release table with new package")
+    parser.add_argument("--image-tag", type=str, required=True,  help="Docker tag")
+    parser.add_argument("--lib-version", type=str, required=True, help="Python library version")
+    parser.add_argument("--path", type=str, required=True, help="RELEASE.md path")
+
+    args = parser.parse_args()
+    update_release_matrix(release_file=args.path, image_tag=args.image_tag, lib_version=args.lib_version)
+
+
+if __name__ == "__main__":
+    main()

.github/workflows/pr-check.yml

@@ -0,0 +1,32 @@
+name: pr-check
+
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  codespell:
+    name: Codespell
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+      - name: Codespell
+        uses: codespell-project/actions-codespell@master
+        with:
+          ignore_words_list: test
+          check_filenames: true
+          check_hidden: false
+
+  code-validate:
+    name: Validate code
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+    - run: pip3 install -r requirements.txt
+    - run: python3 -m ruff .

.github/workflows/pr-create.yml

@@ -0,0 +1,108 @@
+name: pr-create
+
+on:
+  workflow_dispatch:
+    inputs:
+      image:
+        description: 'Docker image name, eg: frinx/schellar:3.0.0'
+        required: true
+
+jobs:
+  generate-api-from-image:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Parse docker
+        run: |
+          echo "IMAGE_NAMESPACE=$(echo $IMAGE | cut -d '/' -f 1)" >> "$GITHUB_ENV"
+          echo "IMAGE_REPO=$(echo $IMAGE | cut -d '/' -f 2 | cut -d ':' -f 1)" >> "$GITHUB_ENV"
+          echo "IMAGE_TAG=$(echo $IMAGE | cut -d ':' -f 2)" >> "$GITHUB_ENV"
+        env:
+          IMAGE: ${{ inputs.image }}
+      - name: Validate input
+        run: |                  
+          echo ${IMAGE_NAMESPACE}
+          if [[ "${IMAGE_NAMESPACE}" != "frinx" ]]; then
+            echo "Only images from frinx namespace can be used!"
+            exit 1
+          fi
+          
+          # Semantic version regex pattern
+          semantic_version_pattern='^[0-9]+\.[0-9]+\.[0-9]+$'
+          
+          if [[ "${IMAGE_TAG}" =~ $semantic_version_pattern ]]; then
+            echo "Valid semantic version: ${IMAGE_TAG}"
+          else
+            echo "Invalid semantic version: ${IMAGE_TAG}"
+            exit 1
+          fi
+
+      - name: Start service
+        run: |
+          echo "${IMAGE_NAMESPACE} ${IMAGE_REPO} ${IMAGE_TAG}"
+          docker compose -f ${IMAGE_REPO}/python/docker-compose.yml up -d
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Run image
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: "1.4.2"
+
+      - name: Formatting and validating
+        run: |
+          pushd ${IMAGE_REPO}/python/ || exit 1
+            poetry install
+            poetry run ruff --fix .
+            poetry run mypy .
+            poetry run pyright .
+          popd || exit 1
+
+      - name: Check changed files
+        uses: tj-actions/verify-changed-files@v16
+        id: verify-changed-files
+
+      - name: Update changelog
+        if: steps.verify-changed-files.outputs.files_changed == 'true'
+        run: |
+          SCRIPT_PATH=".github/scripts"
+          
+          export $(${SCRIPT_PATH}/find-nearest-lower-version \
+              --image-tag ${IMAGE_TAG} \
+              --path ${IMAGE_REPO}/python/RELEASE.md)
+          
+          echo $LAST_DOCKER_TAG $LAST_LIB_VERSION
+          
+          LIB_VERSION=$(${SCRIPT_PATH}/bump-version \
+              --last-image ${LAST_DOCKER_TAG} \
+              --new-image ${IMAGE_TAG} \
+              --last-lib ${LAST_LIB_VERSION})
+          
+          ${SCRIPT_PATH}/release-update \
+              --image-tag ${IMAGE_TAG} \
+              --lib-version ${LIB_VERSION} \
+              --path ${IMAGE_REPO}/python/RELEASE.md
+          
+          sed -i "s/^version = \"[^\"]*\"/version = \"${LIB_VERSION}\"/g" ${IMAGE_REPO}/python/pyproject.toml
+
+      - uses: tibdex/github-app-token@v1
+        if: steps.verify-changed-files.outputs.files_changed == 'true'
+        id: generate-token
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+      - name: Create Pull Request
+        if: steps.verify-changed-files.outputs.files_changed == 'true'
+        uses: peter-evans/create-pull-request@v5
+        with:
+          title: "[${{ env.IMAGE_REPO }}] Release package for ${{ inputs.image }}"
+          commit-message: "[${{ env.IMAGE_REPO }}] Create and publish packages for ${{ env.IMAGE_TAG }}"
+          branch-suffix: timestamp
+          labels: automated-pr
+          delete-branch: true
+          reviewers: Jozefiel
+          body: |
+            Create and publish packages for ${{ env.IMAGE_REPO }}
+          token: ${{ steps.generate-token.outputs.token }}