Add Github CI and switch to Bitnami RabbitMQ container

Signed-off-by: Lance Drane <dranelt@ornl.gov>

Author: Lance-Drane

.github/workflows/ci.yml

@@ -0,0 +1,76 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Ruff linting, formating, MyPy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: "3.8"
+          cache: true
+      - name: Install dependencies
+        run: pdm sync --dev -G:all
+      - name: Lint
+        run: |
+          pdm run ruff format --check
+          pdm ruff check
+          pdm run lint-mypy
+
+  test:
+    name: Test with coverage
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        os:
+          - ubuntu-latest
+          # TODO - can't use service containers outside of Ubuntu
+          #- macos-latest
+          #- windows-latest
+    runs-on: ${{ matrix.os }}
+    services:
+      rabbitmq:
+        image: "bitnami/rabbitmq:3.13.3"
+        env:
+          # space-delimited list of plugins
+          RABBITMQ_PLUGINS: "rabbitmq_mqtt"
+          RABBITMQ_USERNAME: "intersect_username"
+          RABBITMQ_PASSWORD: "intersect_password"
+        ports:
+          - "1883:1883" # MQTT port
+          - "5672:5672" # AMQP port
+      minio:
+        image: "quay.io/minio/minio:latest"
+        env:
+          MINIO_ROOT_USER: AKIAIOSFODNN7EXAMPLE
+          MINIO_ROOT_PASSWORD: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+        ports:
+          - "9000:9000" # main MINIO API port
+          - "9001:9001" # web UI
+        options: 'server /mydata --console-address ":9001"'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: true
+      - name: Install dependencies
+        run: pdm sync --dev -G:all
+      - name: Test
+        run: pdm run test-all

docker-compose.yml

@@ -1,29 +1,21 @@
 # Simple docker-compose file which sets up all needed backing services
 # Note that for the broker, the default credentials are ` intersect_username / intersect_password `
 
-version: "3"
-
-x-broker-variables: &broker-variables
-  BROKER_HOST: broker
-  BROKER_PORT: 1883
-  BROKER_USERNAME: intersect_username
-  BROKER_PASSWORD: intersect_password
-
-x-minio-variables: &minio-variables
-  MINIO_HOST: minio
-  MINIO_PORT: 9000
-  MINIO_ACCESS_KEY: AKIAIOSFODNN7EXAMPLE
-  MINIO_SECRET_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
-
 services:
   broker:
-    image: code.ornl.gov:4567/intersect/sdk/broker/main:latest
+    image: "bitnami/rabbitmq:3.13.3"
     ports:
       - "1883:1883" # MQTT port
       - "5672:5672" # AMQP port
       - "15672:15672" # Web UI
+    environment:
+      # full list of env variables available at https://github.com/bitnami/containers/blob/main/bitnami/rabbitmq/README.md
+      RABBITMQ_PLUGINS: "rabbitmq_mqtt"
+      RABBITMQ_USERNAME: "intersect_username"
+      RABBITMQ_PASSWORD: "intersect_password"
+      RABBITMQ_MANAGEMENT_ALLOW_WEB_ACCESS: "yes"
     healthcheck:
-      test: rabbitmq-diagnostics -q ping
+      test: rabbitmq-diagnostics -q ping && rabbitmq-diagnostics -q check_running && rabbitmq-diagnostics -q check_local_alarms
       interval: 10s
       retries: 5
       start_period: 10s

docs/installation.rst

@@ -56,9 +56,9 @@ Docker
 Backing Services (Brokers, Data planes)
 ---------------------------------------
 
-A Docker Compose configuration for SDK development is included below. Note that the broker configuration requires access to the INTERSECT Gitlab, and is available at https://code.ornl.gov/intersect/sdk/broker.
+A Docker Compose configuration for SDK development is included below.
 
-Note that this broker image, and any data plane images, are meant for testing and should not be included in production.
+Note that this configuration is meant for testing, and should not be included in production.
 
 .. literalinclude:: ../docker-compose.yml
 
@@ -70,7 +70,7 @@ From the repository root, run the backing services using the Docker commands sho
    # if you are copypasting from this website instead of running from the repository root, you should make sure you copy the contents into docker-compose.yml.
    docker compose up -d
 
-To see the broker's management UI, you can navigate to ``localhost:15672`` in your browser. The login credentials will be those found in the broker's `definitions file <https://code.ornl.gov/intersect/sdk/broker/-/blob/0.2.0/definitions.json>`_.
+To see the broker's management UI, you can navigate to ``localhost:15672`` in your browser. The login credentials mirror `RABBITMQ_USERNAME` and `RABBITMQ_PASSWORD` from the docker-compose file.
 
 To cleanup: