Merge branch 'issues/208' of https://github.com/mwvgroup/Pitt-Google-…

…Broker into issues/208

.github/workflows/BrokerTest.yml

@@ -0,0 +1,66 @@
+name: Test Broker
+
+on:
+  workflow_dispatch:
+  workflow_call:
+  push:
+
+env:
+  PYTHON_VERSION: 3.11
+
+jobs:
+  discover:
+    name: Discover Microservices
+    runs-on: ubuntu-latest
+
+    outputs:
+      matrix: ${{ steps.find_tests.outputs.matrix }}
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+
+      - name: Find testable apps
+        id: find_tests
+        run: |
+          # Find application directories containing a 'tests' subdirectory nd format the result as JSON
+          test_dirs=$(find broker/cloud_functions -type d -name "tests" -exec dirname {} \; | jq -R . | jq -s . | tr -d '\n')
+          echo "found $test_dirs"
+          echo "matrix={\"app_dir\":$test_dirs}" >> $GITHUB_OUTPUT
+
+  test:
+    name: Test Microservices
+    runs-on: ubuntu-latest
+    needs: [ discover ]
+
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJSON(needs.discover.outputs.matrix) }}
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install dependencies
+        run: |
+          pip install coverage
+          pip install -r ${{ matrix.app_dir }}/requirements.txt
+
+      - name: Test ${{ matrix.app_dir }} app
+        run: coverage run -m unittest discover  ${{ matrix.app_dir }}
+
+  report-status:
+    name: Report Test Status
+    if: always()
+    needs: [ test ]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check build status
+        if: ${{ contains(needs.*.result, 'failure') }}
+        run: exit 1

broker/cloud_functions/tag/tests/test_cloud_fnc.py

@@ -0,0 +1,10 @@
+"""This test module is an example placeholder put in place while deveoping the CI toolchain."""
+
+from unittest import TestCase
+
+
+class Placeholder(TestCase):
+    """A set of placeholder tests"""
+
+    def test_pass(self) -> None:
+        """This test will always pass"""

broker/setup_broker/setup_gcp.py

@@ -142,6 +142,8 @@ def _resources(service, survey='ztf', testid='test', versiontag="v3_3"):
 
     if service == 'GCS':
         buckets = {  # '<bucket-name>': ['<file-name to upload>',]
+            # the avro bucket f'{PROJECT_ID}-{survey}_alerts_{versiontag}'
+            # is managed in broker/cloud_functions/ps_to_gcs/deploy.sh
             f'{PROJECT_ID}-{survey}-broker_files': [],
             f'{PROJECT_ID}-{survey}-testing_bucket':
                 ['ztf_3.3_validschema_1154446891615015011.avro'],