Add workflows for testing and lint.

EdgePi-Cloud · Sep 15, 2023 · 6d318ac · 6d318ac
1 parent 01a6b1e
commit 6d318ac
Show file tree

Hide file tree

Showing 14 changed files with 171 additions and 21 deletions.
diff --git a/.github/workflows/python-integration-test.yml b/.github/workflows/python-integration-test.yml
@@ -0,0 +1,48 @@
+name: Python Integration Test
+
+on:
+  push:
+    branches:
+      - dev
+      - staging
+      - main
+    paths-ignore:
+      - version
+  pull_request:
+    branches:
+      - dev
+      - staging
+      - main
+    paths-ignore:
+      - version
+
+jobs:
+  test:
+    name: Integration Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9"]
+
+    steps:
+      - name: Checkout
+        if: ${{ github.event_name  == 'pull_request'}}
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+      - name: Checkout
+        if: ${{ github.event_name  == 'push'}}
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref_name }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m venv venv_test
+          source venv_test/bin/activate
+          python -m pip install -r requirements_test.txt
+      - name: Test with pytest
+        run: |
+          source venv_test/bin/activate
+          pytest ./tests/integration -vvs
diff --git a/.github/workflows/python-lint.yml b/.github/workflows/python-lint.yml
@@ -0,0 +1,47 @@
+# This workflow will lint all files in repo using pylint
+
+name: pylint
+
+on:
+  push:
+    branches:
+      - dev
+      - staging
+      - main
+    paths-ignore:
+      - version
+  pull_request:
+    branches:
+      - dev
+      - staging
+      - main
+    paths-ignore:
+      - version
+
+jobs:
+  lint:
+    name: Linter
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9"]
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Dependencies
+      run: |
+          git config --global url."https://${{ secrets.BOT_OSENSA_TOKEN }}@github".insteadOf ssh://git@github
+          python -m pip install --upgrade pip
+          python -m venv venv_test
+          source venv_test/bin/activate
+          python -m pip install -r requirements_test.txt
+    - name: Analysing the code with pylint
+      run: |
+        source venv_test/bin/activate
+        pylint $(git ls-files '*.py')
diff --git a/.github/workflows/python-unit-test.yml b/.github/workflows/python-unit-test.yml
@@ -0,0 +1,45 @@
+name: PyTest Unit Test
+
+on:
+  push:
+    branches:
+      - dev
+      - staging
+      - main
+    paths-ignore:
+      - version
+  pull_request:
+    branches:
+      - dev
+      - staging
+      - main
+    paths-ignore:
+      - version
+
+jobs:
+  test:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          git config --global url."https://${{ secrets.BOT_OSENSA_TOKEN }}@github".insteadOf ssh://git@github
+          python -m pip install --upgrade pip
+          python -m venv venv_test
+          source venv_test/bin/activate
+          python -m pip install -r requirements_test.txt
+      - name: Test with pytest
+        run: |
+          source venv_test/bin/activate
+          pytest ./tests/unit -vvs
diff --git a/client_rpc_channel/client_rpc_channel.py b/client_rpc_channel/client_rpc_channel.py
@@ -1,4 +1,3 @@
-"""Client to use for integration tests"""
 import logging
 from google.protobuf import service
 import zmq

diff --git a/client_services/adc/client_adc_service.py b/client_services/adc/client_adc_service.py
@@ -3,11 +3,11 @@
 """
 import logging
 from edgepirpc.protos import adc_pb2 as adc_pb
-from client.client_rpc_channel.client_rpc_channel import ClientRpcChannel
-from client.util.helpers import (
+from client_rpc_channel.client_rpc_channel import ClientRpcChannel
+from util.helpers import (
     filter_arg_values, create_config_request_from_args, get_server_response
 )
-from client.client_services.adc.adc_pb_enums import (
+from client_services.adc.adc_pb_enums import (
     AnalogIn, ConvMode, ADC1DataRate, ADC2DataRate, FilterMode, ADCNum, DiffMode
 )
 

diff --git a/client_services/dac/client_dac_service.py b/client_services/dac/client_dac_service.py
@@ -3,9 +3,9 @@
 serialize/deserialize messages
 """
 from edgepirpc.protos import dac_pb2 as dac_pb
-from client.client_rpc_channel.client_rpc_channel import ClientRpcChannel
-from client.client_services.dac.dac_pb_enums import DACChannel
-from client.util.helpers import get_server_response
+from client_rpc_channel.client_rpc_channel import ClientRpcChannel
+from client_services.dac.dac_pb_enums import DACChannel
+from util.helpers import get_server_response
 
 # pylint: disable=no-member
 class ClientDacService():

diff --git a/client_services/din/client_din_service.py b/client_services/din/client_din_service.py
@@ -3,9 +3,9 @@
 serialize/deserialize messages
 """
 from edgepirpc.protos import din_pb2 as din_pb
-from client.client_rpc_channel.client_rpc_channel import ClientRpcChannel
-from client.client_services.din.din_pb_enums import DinPins
-from client.util.helpers import get_server_response
+from client_rpc_channel.client_rpc_channel import ClientRpcChannel
+from client_services.din.din_pb_enums import DinPins
+from util.helpers import get_server_response
 
 # pylint: disable=no-member
 # pylint: disable=too-few-public-methods

diff --git a/client_services/dout/client_dout_service.py b/client_services/dout/client_dout_service.py
@@ -3,9 +3,9 @@
 serialize/deserialize messages
 """
 from edgepirpc.protos import dout_pb2 as dout_pb
-from client.client_rpc_channel.client_rpc_channel import ClientRpcChannel
-from client.client_services.dout.dout_pb_enums import DoutPins, DoutTriState
-from client.util.helpers import get_server_response
+from client_rpc_channel.client_rpc_channel import ClientRpcChannel
+from client_services.dout.dout_pb_enums import DoutPins, DoutTriState
+from util.helpers import get_server_response
 
 # pylint: disable=no-member, too-few-public-methods
 class ClientDoutService():

diff --git a/client_services/led/client_led_service.py b/client_services/led/client_led_service.py
@@ -3,9 +3,9 @@
 serialize/deserialize messages
 """
 from edgepirpc.protos import led_pb2 as led_pb
-from client.client_rpc_channel.client_rpc_channel import ClientRpcChannel
-from client.client_services.led.led_pb_enums import LEDPins
-from client.util.helpers import get_server_response
+from client_rpc_channel.client_rpc_channel import ClientRpcChannel
+from client_services.led.led_pb_enums import LEDPins
+from util.helpers import get_server_response
 
 # pylint: disable=no-member
 class ClientLEDService():

diff --git a/client_services/relay/client_relay_service.py b/client_services/relay/client_relay_service.py
@@ -2,8 +2,8 @@
 Client for Relay Service
 """
 from edgepirpc.protos import relay_pb2 as relay_pb
-from client.client_rpc_channel.client_rpc_channel import ClientRpcChannel
-from client.util.helpers import get_server_response
+from client_rpc_channel.client_rpc_channel import ClientRpcChannel
+from util.helpers import get_server_response
 
 
 # pylint: disable=no-member

diff --git a/client_services/tc/client_tc_service.py b/client_services/tc/client_tc_service.py
@@ -4,11 +4,11 @@
 """
 import logging
 from edgepirpc.protos import tc_pb2 as tc_pb
-from client.util.helpers import (
+from util.helpers import (
     create_config_request_from_args, filter_arg_values, get_server_response
 )
-from client.client_rpc_channel.client_rpc_channel import ClientRpcChannel
-from client.client_services.tc.tc_pb_enums import (
+from client_rpc_channel.client_rpc_channel import ClientRpcChannel
+from client_services.tc.tc_pb_enums import (
     AvgMode,
     CJHighMask,
     CJLowMask,

diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,5 @@
+protobuf==3.20.3
+python-periphery==2.4.1
+pyzmq==25.1.0
+edgepi-python-sdk==1.2.6
+edgepi-rpc-protobuf==1.0.15
diff --git a/requirements_test.txt b/requirements_test.txt
@@ -0,0 +1,3 @@
+-r requirements.txt
+pylint==2.17.4
+pytest==7.3.1
diff --git a/setup.cfg b/setup.cfg
@@ -14,3 +14,6 @@ packages = find:
 install_requires = 
     protobuf==3.20.3
     edgepi-rpc-protobuf==1.0.15
+    python-periphery==2.4.1
+    pyzmq==25.1.0
+    edgepi-python-sdk==1.2.6