From 1ecbfcc183a1ae83ddd5ffd79f509c26cf0294f5 Mon Sep 17 00:00:00 2001 From: Kumaran Rajendhiran Date: Tue, 26 Sep 2023 15:07:31 +0530 Subject: [PATCH 1/5] Add faststream-gen generated files --- .github/workflows/deploy_docs.yml | 47 +++++ .github/workflows/test.yml | 20 ++ .gitignore | 5 + LICENSE | 201 +++++++++++++++++++ app/__init__.py | 0 app/application.py | 20 ++ pyproject.toml | 16 ++ scripts/services.yml | 26 +++ scripts/start_kafka_broker_locally.sh | 3 + scripts/stop_kafka_broker_locally.sh | 3 + scripts/subscribe_to_kafka_broker_locally.sh | 10 + tests/test_application.py | 18 ++ 12 files changed, 369 insertions(+) create mode 100644 .github/workflows/deploy_docs.yml create mode 100644 .github/workflows/test.yml create mode 100644 LICENSE create mode 100644 app/__init__.py create mode 100644 app/application.py create mode 100644 pyproject.toml create mode 100644 scripts/services.yml create mode 100644 scripts/start_kafka_broker_locally.sh create mode 100644 scripts/stop_kafka_broker_locally.sh create mode 100644 scripts/subscribe_to_kafka_broker_locally.sh create mode 100644 tests/test_application.py diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml new file mode 100644 index 0000000..66492ef --- /dev/null +++ b/.github/workflows/deploy_docs.yml @@ -0,0 +1,47 @@ +name: Build FastStream Docs +on: + push: + branches: + - master + - main + +jobs: + deploy_docs: + name: Deploy FastStream Docs to GitHub Pages + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: ${{ inputs.version }} + - name: Install Dependencies + shell: bash + run: | + set -ux + python -m pip install --upgrade pip + test -f pyproject.toml && pip install -e "." || echo "pyproject.toml doesn't exists" + test -f requirements.txt && pip install -r requirements.txt || echo "requirements.txt doesn't exists" + - uses: actions/setup-node@v3 + with: + node-version: 18 + - name: Generate asyncapi.yaml + shell: bash + run: | + faststream docs gen --yaml app.application:app + - name: Generate AsyncAPI Docs + shell: bash + run: | + npx --version + npx -y -p @asyncapi/generator ag --version + mkdir asyncapi_docs + npx -y -p @asyncapi/generator ag asyncapi.yaml @asyncapi/html-template -o asyncapi_docs + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + force_orphan: true + publish_dir: ./asyncapi_docs + # The following lines assign commit authorship to the official GH-Actions bot for deploys to `gh-pages` branch. + # You can swap them out with your own user credentials. + user_name: github-actions[bot] + user_email: 41898282+github-actions[bot]@users.noreply.github.com diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..4d2954c --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,20 @@ +name: CI +on: [workflow_dispatch, pull_request, push] + +jobs: + build: + + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: 3.9 + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r dev_requirements.txt + - name: Test with pytest + run: | + python -m pytest diff --git a/.gitignore b/.gitignore index 68bc17f..00d3428 100644 --- a/.gitignore +++ b/.gitignore @@ -158,3 +158,8 @@ cython_debug/ # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ + +# FastStream-gen +asyncapi.yaml +asyncapi.json +faststream-log.txt diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/application.py b/app/application.py new file mode 100644 index 0000000..82331f7 --- /dev/null +++ b/app/application.py @@ -0,0 +1,20 @@ +from pydantic import BaseModel, Field +from faststream import FastStream, Logger +from faststream.kafka import KafkaBroker + +class Name(BaseModel): + name: str = Field(..., description="Name of the person") + +class Greeting(BaseModel): + greeting: str = Field(..., description="Greeting message") + +broker = KafkaBroker("localhost:9092") +app = FastStream(broker) + +to_greetings = broker.publisher("greetings") + +@broker.subscriber("names") +async def on_names(msg: Name, logger: Logger) -> None: + result = f"hello {msg.name}" + greeting = Greeting(greeting=result) + await to_greetings.publish(greeting) diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..bd41ae7 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,16 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "app" +version = "0.0.1" + +dependencies = [ + "faststream[kafka, docs]>=0.1.3", +] + +[project.optional-dependencies] +dev = [ + "faststream[kafka, testing]>=0.1.3", +] diff --git a/scripts/services.yml b/scripts/services.yml new file mode 100644 index 0000000..6c344aa --- /dev/null +++ b/scripts/services.yml @@ -0,0 +1,26 @@ +version: "3" + +services: + kafka: + image: bitnami/kafka:3.5.0 + container_name: bitnami_kafka + ports: + - "9092:9092" + environment: + KAFKA_ENABLE_KRAFT: "true" + KAFKA_CFG_NODE_ID: "1" + KAFKA_CFG_PROCESS_ROLES: "broker,controller" + KAFKA_CFG_CONTROLLER_LISTENER_NAMES: "CONTROLLER" + KAFKA_CFG_LISTENERS: "PLAINTEXT://:9092,CONTROLLER://:9093" + KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP: "CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT" + KAFKA_CFG_ADVERTISED_LISTENERS: "PLAINTEXT://127.0.0.1:9092" + KAFKA_CFG_AUTO_CREATE_TOPICS_ENABLE: "true" + KAFKA_BROKER_ID: "1" + KAFKA_CFG_CONTROLLER_QUORUM_VOTERS: "1@kafka:9093" + ALLOW_PLAINTEXT_LISTENER: "true" + healthcheck: + test: ["CMD-SHELL", "kafka-topics.sh --bootstrap-server kafka:9092 --list"] + start_period: 10s + interval: 5s + timeout: 10s + retries: 5 diff --git a/scripts/start_kafka_broker_locally.sh b/scripts/start_kafka_broker_locally.sh new file mode 100644 index 0000000..80ccb58 --- /dev/null +++ b/scripts/start_kafka_broker_locally.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +docker-compose -f ./scripts/services.yml up -d --no-recreate diff --git a/scripts/stop_kafka_broker_locally.sh b/scripts/stop_kafka_broker_locally.sh new file mode 100644 index 0000000..25ee199 --- /dev/null +++ b/scripts/stop_kafka_broker_locally.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +docker-compose -f ./scripts/services.yml down diff --git a/scripts/subscribe_to_kafka_broker_locally.sh b/scripts/subscribe_to_kafka_broker_locally.sh new file mode 100644 index 0000000..e0456b5 --- /dev/null +++ b/scripts/subscribe_to_kafka_broker_locally.sh @@ -0,0 +1,10 @@ +#!/bin/bash + +if [ $# -ne 1 ]; then + echo "Usage: $0 " + exit 1 +fi + +topic="$1" + +docker exec -it bitnami_kafka /opt/bitnami/kafka/bin/kafka-console-consumer.sh --consumer.config /opt/bitnami/kafka/config/consumer.properties --bootstrap-server kafka:9092 --topic "$topic" --property print.key=true diff --git a/tests/test_application.py b/tests/test_application.py new file mode 100644 index 0000000..40ad637 --- /dev/null +++ b/tests/test_application.py @@ -0,0 +1,18 @@ +import pytest + +from faststream.kafka import TestKafkaBroker + +from app.application import Name, Greeting, broker, on_names + + +@broker.subscriber("greetings") +async def on_greetings(msg: Greeting) -> None: + pass + + +@pytest.mark.asyncio +async def test_on_names(): + async with TestKafkaBroker(broker): + await broker.publish(Name(name="John"), "names") + on_names.mock.assert_called_with(dict(Name(name="John"))) + on_greetings.mock.assert_called_with(dict(Greeting(greeting="hello John"))) From 6d32e9f02b69dd7863dc098a78f66deff63bdb74 Mon Sep 17 00:00:00 2001 From: Kumaran Rajendhiran Date: Tue, 26 Sep 2023 15:11:01 +0530 Subject: [PATCH 2/5] Add Dockerfile and action to build it --- .github/workflows/build_docker.yml | 26 ++++++++++++++++++++++++++ Dockerfile | 11 +++++++++++ 2 files changed, 37 insertions(+) create mode 100644 .github/workflows/build_docker.yml create mode 100644 Dockerfile diff --git a/.github/workflows/build_docker.yml b/.github/workflows/build_docker.yml new file mode 100644 index 0000000..a0a7091 --- /dev/null +++ b/.github/workflows/build_docker.yml @@ -0,0 +1,26 @@ +name: Build Docker Image +on: + push: + branches: + - master + - main + +jobs: + build_docker: + runs-on: ubuntu-22.04 + permissions: + contents: read + packages: write + steps: + - name: Checkout repository + uses: actions/checkout@v3 + - name: Log in to the Container registry + uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - run: docker build -t ghcr.io/$GITHUB_REPOSITORY:latest . + - name: Push built image + run: docker push ghcr.io/$GITHUB_REPOSITORY --all-tags \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..54793d5 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,11 @@ +FROM python:3.9-slim-bullseye + +SHELL ["/bin/bash", "-c"] +WORKDIR /project + +ADD app /project/app +COPY pyproject.toml /project/ + +RUN pip install --no-cache-dir . + +CMD ["faststream", "run", "--workers", "1", "app.application:app"] From aad50e4ac4bf6737f90519ec6b39709f5b5357ed Mon Sep 17 00:00:00 2001 From: Kumaran Rajendhiran Date: Tue, 26 Sep 2023 15:11:52 +0530 Subject: [PATCH 3/5] Add current branch for debugging --- .github/workflows/build_docker.yml | 1 + .github/workflows/deploy_docs.yml | 1 + 2 files changed, 2 insertions(+) diff --git a/.github/workflows/build_docker.yml b/.github/workflows/build_docker.yml index a0a7091..bc5ec3c 100644 --- a/.github/workflows/build_docker.yml +++ b/.github/workflows/build_docker.yml @@ -4,6 +4,7 @@ on: branches: - master - main + - add-template-files # ToDo: Remove this jobs: build_docker: diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index 66492ef..630e980 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -4,6 +4,7 @@ on: branches: - master - main + - add-template-files # ToDo: Remove this jobs: deploy_docs: From 4eee3aa4c357484ac4e8154172ceae5b99c4fede Mon Sep 17 00:00:00 2001 From: Kumaran Rajendhiran Date: Tue, 26 Sep 2023 15:14:14 +0530 Subject: [PATCH 4/5] Fix bug with installing dependencies --- .github/workflows/test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 4d2954c..447526c 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -14,7 +14,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install -r dev_requirements.txt + pip install -e ".[dev]" - name: Test with pytest run: | python -m pytest From 3638b10129ad0d456b22756861921ff050248caf Mon Sep 17 00:00:00 2001 From: Kumaran Rajendhiran Date: Tue, 26 Sep 2023 15:17:26 +0530 Subject: [PATCH 5/5] Remove debug statements --- .github/workflows/build_docker.yml | 1 - .github/workflows/deploy_docs.yml | 1 - 2 files changed, 2 deletions(-) diff --git a/.github/workflows/build_docker.yml b/.github/workflows/build_docker.yml index bc5ec3c..a0a7091 100644 --- a/.github/workflows/build_docker.yml +++ b/.github/workflows/build_docker.yml @@ -4,7 +4,6 @@ on: branches: - master - main - - add-template-files # ToDo: Remove this jobs: build_docker: diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index 630e980..66492ef 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -4,7 +4,6 @@ on: branches: - master - main - - add-template-files # ToDo: Remove this jobs: deploy_docs: