Add basic tox test workflow (#22)

* Remove various legacy files

* Remove unused code

* Fix up unit tests and linter

* Add tox workflow

* Slight update to the readme

* Always run the tox job

* Update container build

Author: JohnGarbutt

.github/workflows/docker.yaml

@@ -3,54 +3,43 @@ name: Docker image
 on: push
 jobs:
   build_push_api:
-    name: Build and push execution environment
+    name: Build and push image
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write         # needed for signing the images with GitHub OIDC Token
+      packages: write         # required for pushing container images
+      security-events: write  # required for pushing SARIF files
+
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: actions/checkout@v4
 
-      - name: Set up Docker layer caching
-        uses: actions/cache@v2
-        with:
-          path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-buildx-
       - name: Login to GitHub Container Registry
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Calculate metadata for image
         id: image-meta
-        uses: docker/metadata-action@v3
+        uses: docker/metadata-action@v5
         with:
           images: ghcr.io/stackhpc/os-capacity
           # Produce the branch name or tag and the SHA as tags
           tags: |
             type=ref,event=branch
             type=ref,event=tag
             type=sha,prefix=
+
       - name: Build and push image
-        uses: docker/build-push-action@v2
+        uses: azimuth-cloud/github-actions/docker-multiarch-build-push@master
         with:
+          cache-key: os-capacity
           context: .
+          platforms: linux/amd64,linux/arm64
           push: true
           tags: ${{ steps.image-meta.outputs.tags }}
           labels: ${{ steps.image-meta.outputs.labels }}
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache-new,mode=max
-
-      # Temp fix
-      # https://github.com/docker/build-push-action/issues/252
-      # https://github.com/moby/buildkit/issues/1896
-      # https://github.com/docker/buildx/pull/535
-      - name: Move cache
-        run: |
-          rm -rf /tmp/.buildx-cache
-          mv /tmp/.buildx-cache-new /tmp/.buildx-cache
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/tox.yaml

@@ -0,0 +1,27 @@
+name: Tox unit tests
+
+on: push
+
+jobs:
+  build:
+    name: Tox unit tests and linting
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox
+
+    - name: Test with tox
+      run: tox

README.rst

@@ -1,7 +1,11 @@
 os-capacity
 ===========
 
-This is a prototype tool to extract capacity information.
+This is a prototype prometheus exporter
+to extract capacity information from OpenStack Placement.
+
+It includes support for both baremetal flavors
+and flavors with PCPU resources implied.
 
 Install
 -------