Update README.md #3
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Endpoint CI | |
| # Controls when the workflow will run | |
| on: | |
| # Triggers the workflow on push or pull request events but only for the "main" branch | |
| push: | |
| branches: [ "main" ] | |
| tags: [ "v*" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # This workflow contains a single job called "build" | |
| tests: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: [ "3.9", "3.10", "3.11" ] | |
| services: | |
| # Label used to access the service container | |
| kafka: | |
| # Docker Hub image | |
| image: bitnami/kafka:3.4 | |
| # Provide the password for postgres | |
| env: | |
| ALLOW_PLAINTEXT_LISTENER: "yes" | |
| KAFKA_CFG_AUTO_CREATE_TOPICS_ENABLE: "true" | |
| # Set health checks to wait until postgres has started | |
| options: >- | |
| --health-cmd "kafka-topics.sh --bootstrap-server kafka:9092 --topic hc --create --if-not-exists && kafka-topics.sh --bootstrap-server kafka:9092 --topic hc --describe" --health-interval 10s --health-timeout 5s --health-retries 5 | |
| ports: | |
| # Tests run directly on the runner so we have to map the port | |
| - 9092:9092 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: 'pip' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip setuptools wheel | |
| pip install ruff pytest requests | |
| pip install -r requirements.txt | |
| - name: Lint with ruff | |
| run: | | |
| # stop the build if there are Python syntax errors or undefined names | |
| ruff --format=github --select=E9,F63,F7,F82 --target-version=py37 . | |
| # default set of ruff rules with GitHub Annotations | |
| ruff --format=github --target-version=py37 . | |
| - name: Test with pytest | |
| env: | |
| PYTEST_ADDOPTS: "--color=yes" | |
| ALLOWED_IP_ADDRESSES: "127.0.0.1" | |
| AUTH_TOKEN: "abcd1234" | |
| DATA_SOURCE_NAME: "digita.thingpark.http" | |
| ENDPOINT_PATH: "/digita/v2" | |
| HTTP_REQUESTHANDLER: "endpoints.digita.aiothingpark" | |
| KAFKA_HOST: "localhost" | |
| KAFKA_PORT: 9092 | |
| KAFKA_BOOTSTRAP_SERVERS: "localhost:9092" | |
| KAFKA_GROUP_ID: "digita_dev" | |
| KAFKA_PARSED_DATA_TOPIC_NAME: "digita.parseddata" | |
| KAFKA_RAW_DATA_TOPIC_NAME: "digita.rawdata" | |
| LOG_LEVEL: "DEBUG" | |
| DEBUG: 1 | |
| run: | | |
| uvicorn app:app --host 0.0.0.0 --port 8000 --proxy-headers & | |
| sleep 10 && | |
| pytest -v tests/test_api.py |