python-package.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Python package and Docker image

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]
  release:
    types: [created]

  workflow_dispatch:
    inputs:
      version_name:
        description: 'Version used on testPypi and dockerHub'
        required: true

env:
  IMAGE_NAME: 'wirepas/wmm_alpine_cpp'

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.9', '3.10', '3.11', '3.12']

    steps:
    - uses: actions/checkout@v3
      with:
        submodules: true

    - name: Set proto path
      run: echo "PROTO_FOLDER=backend-apis/gateway_to_backend/protocol_buffers_files" >> $GITHUB_ENV

    - name: Install Protoc
      uses: arduino/setup-protoc@v1.1.2
      with:
         version: '3.20.3'
         repo-token: ${{ secrets.GITHUB_TOKEN }}

    - name: Generate proto files
      run: |
        protoc -I ${{ env.PROTO_FOLDER }} --python_out=./wirepas_mesh_messaging/proto ${{ env.PROTO_FOLDER }}/*.proto

    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }}

    - name: Install dependencies
      run: |
        # Use sepcific version of pip as temporary fix for deprecation of setup.py install
        # being an error in 23.1
        python -m pip install pip==23.0
        python -m pip install flake8 pytest setuptools wheel
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

    - name: Lint with flake8
      run: |
        # stop the build if there are Python syntax errors or undefined names
        flake8 . --count --select=E9,F63,F7,F82 --ignore=F821 --show-source --statistics
        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

    - name: Install wheel locally
      run: pip install .

    - name: Test with pytest
      run: |
        pytest tests/

    - name: Get short sha
      uses: benjlevesque/short-sha@v2.1
      id: short-sha
      with:
        length: 6

    - name: Set Version for master push
      if: ${{ github.event_name == 'push' }}
      run: echo "VERSION=${{ steps.short-sha.outputs.sha }}" >> $GITHUB_ENV

    - name: Set Version for release
      if: ${{ github.event_name == 'release' }}
      run: echo "VERSION=${{ github.event.release.tag_name }}" >> $GITHUB_ENV

    - name: Set Version for PR
      if: ${{ github.event_name == 'pull_request' }}
      run: echo "VERSION=PR_${{ github.event.pull_request.number }}" >> $GITHUB_ENV

    - name: Set Version for manual triggering
      if: ${{ github.event_name == 'workflow_dispatch' }}
      run: echo "VERSION=${{ github.event.inputs.version_name }}" >> $GITHUB_ENV

    - name: Set the version
      run: |
        sed -i '/__version__ = /c\__version__ = "${{ env.VERSION }}"' wirepas_mesh_messaging/__about__.py

    - name: Build the wheel
      run: python setup.py sdist bdist_wheel

    - name: Save produced wheel name and path
      run: echo "WHEEL_FILE=$(ls dist/*-py3-none-any.whl)" >> $GITHUB_ENV

    - name: Store artifacts only for last matrix version
      if: ${{ matrix.python-version == '3.8' }}
      uses: actions/upload-artifact@v3
      with:
        path: ${{ env.WHEEL_FILE }}

    # Produced wheels is same independently of python version
    - name: Upload Wheel for releases only for last matrix version
      if: ${{ github.event_name == 'release' && matrix.python-version == '3.8' }}
      uses: actions/upload-release-asset@v1
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        upload_url: ${{ github.event.release.upload_url }}
        asset_path: ${{ env.WHEEL_FILE }}
        asset_content_type: application/zip
        asset_name: wirepas_mesh_messaging-${{ env.VERSION }}-py3-none-any.whl

    - name: Publish package to TestPyPI for push to master
      if: ${{ github.event_name == 'workflow_dispatch' && matrix.python-version == '3.8' }}
      uses: pypa/gh-action-pypi-publish@v1.4.1
      with:
        user: __token__
        password: ${{ secrets.PYPI_TEST_PWD }}
        repository_url: https://test.pypi.org/legacy/

    - name: Publish package to PyPI for release
      if: ${{ github.event_name == 'release' && matrix.python-version == '3.8' }}
      uses: pypa/gh-action-pypi-publish@v1.4.1
      with:
        user: __token__
        password: ${{ secrets.PYPI_PWD }}

  docker:
    runs-on: ubuntu-latest
    needs: build
    steps:
    - name: checkout code
      uses: actions/checkout@v3

    - name: Set up QEMU
      uses: docker/setup-qemu-action@v2

    - name: Set up Docker Buildx
      uses: docker/setup-buildx-action@v2

    - name: Retrieve wheel to be installed image
      uses: actions/download-artifact@v2

    - name: Set tag for push
      if: github.event_name == 'push'
      run: |
        echo "TAG1=$IMAGE_NAME:edge" >> $GITHUB_ENV
        echo "PUSH=true" >> $GITHUB_ENV

    - name: Set tag for manually triggered
      if: github.event_name == 'workflow_dispatch'
      run: |
        echo "TAG1=$IMAGE_NAME:${{ github.event.inputs.version_name }}" >> $GITHUB_ENV
        echo "PUSH=true" >> $GITHUB_ENV

    - name: Set tag for release version
      if: github.event_name == 'release'
      run: |
        echo "TAG1=$IMAGE_NAME:${{ github.event.release.tag_name }}" >> $GITHUB_ENV
        echo "PUSH=true" >> $GITHUB_ENV

    - name: Set additionnal latest tag also for official release
      if: github.event_name == 'release' && !contains(github.event.release.tag_name, 'rc')
      run: |
        echo "TAG2=$IMAGE_NAME:latest" >> $GITHUB_ENV
        echo "PUSH=true" >> $GITHUB_ENV

    - name: Do not push on docker hub for pull_request
      if: github.event_name == 'pull_request'
      run: |
        echo "PUSH=false" >> $GITHUB_ENV

    - name: Login to docker hub
      uses: docker/login-action@v2
      with:
        username: ${{ secrets.DOCKER_USERNAME }}
        password: ${{ secrets.DOCKER_PASSWORD }}

    - name: Build and push
      uses: docker/build-push-action@v3
      with:
        context: .
        file: docker/Dockerfile
        platforms: linux/amd64, linux/arm64, linux/arm/v7, linux/arm/v6
        push: ${{ env.PUSH }}
        build-args: WIREPAS_MESH_MESSAGING_BUIL_SHA1=${{ github.sha }}
        tags: |
          ${{ env.TAG1 }}
          ${{ env.TAG2 }}