From 04bebd8b606dad06b8be2ca727840372c2a1efa7 Mon Sep 17 00:00:00 2001 From: Tvrtko Sternak Date: Thu, 12 Oct 2023 09:17:04 +0200 Subject: [PATCH] Init project with cookiecutter --- .github/workflows/build_docker.yml | 26 +++ .github/workflows/deploy_docs.yml | 50 +++++ .github/workflows/test.yml | 40 ++++ .gitignore | 170 +++++++++++++++ Dockerfile | 11 + LICENSE | 201 ++++++++++++++++++ README.md | 205 +++++++++++++++++++ faststream_cookiecutter_test/application.py | 60 ++++++ pyproject.toml | 84 ++++++++ scripts/build_docker.sh | 3 + scripts/lint.sh | 10 + scripts/services.yml | 32 +++ scripts/start_kafka_broker_locally.sh | 3 + scripts/static-analysis.sh | 8 + scripts/stop_kafka_broker_locally.sh | 3 + scripts/subscribe_to_kafka_broker_locally.sh | 18 ++ tests/__init__.py | 0 tests/test_application.py | 17 ++ 18 files changed, 941 insertions(+) create mode 100644 .github/workflows/build_docker.yml create mode 100644 .github/workflows/deploy_docs.yml create mode 100644 .github/workflows/test.yml create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 README.md create mode 100644 faststream_cookiecutter_test/application.py create mode 100644 pyproject.toml create mode 100755 scripts/build_docker.sh create mode 100755 scripts/lint.sh create mode 100644 scripts/services.yml create mode 100755 scripts/start_kafka_broker_locally.sh create mode 100755 scripts/static-analysis.sh create mode 100755 scripts/stop_kafka_broker_locally.sh create mode 100755 scripts/subscribe_to_kafka_broker_locally.sh create mode 100644 tests/__init__.py create mode 100644 tests/test_application.py diff --git a/.github/workflows/build_docker.yml b/.github/workflows/build_docker.yml new file mode 100644 index 0000000..dc2754a --- /dev/null +++ b/.github/workflows/build_docker.yml @@ -0,0 +1,26 @@ +name: Build Docker Image +on: + push: + branches: + - '*' + +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: ./scripts/build_docker.sh $GITHUB_REPOSITORY_OWNER ${{ github.event.repository.name }} + - name: Push built image + if: github.ref_name == 'main' || github.ref_name == 'master' + run: docker push ghcr.io/$GITHUB_REPOSITORY_OWNER/${{ github.event.repository.name }} --all-tags diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml new file mode 100644 index 0000000..70e2a1e --- /dev/null +++ b/.github/workflows/deploy_docs.yml @@ -0,0 +1,50 @@ +name: Deploy FastStream AsyncAPI Docs +on: + push: + branches: + - master + - main + +permissions: + contents: write + +jobs: + deploy_docs: + name: Deploy FastStream AsyncAPI 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..a1339e5 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,40 @@ +name: Tests +on: [workflow_dispatch, pull_request, push] + +jobs: + static_analysis: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v4 + with: + python-version: 3.8 + - name: Install Dependencies and library + shell: bash + run: | + set -ux + python -m pip install --upgrade pip + pip install -e ".[static-analysis]" + - name: Run mypy + shell: bash + run: mypy faststream_cookiecutter_test + + - name: Run bandit + shell: bash + run: bandit -c pyproject.toml -r faststream_cookiecutter_test + + test: + 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 -e ".[dev]" + - name: Test with pytest + run: | + python -m pytest diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..08c4d88 --- /dev/null +++ b/.gitignore @@ -0,0 +1,170 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# ruff +.ruff_cache/ + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# 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 +asyncapi_docs +faststream-log.txt +**/rabbitmqadmin diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..4ea1003 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,11 @@ +FROM python:3.9-slim-bullseye + +SHELL ["/bin/bash", "-c"] +WORKDIR /project + +ADD faststream_cookiecutter_test /project/faststream_cookiecutter_test +COPY pyproject.toml /project/ + +RUN pip install --no-cache-dir . + +CMD ["faststream", "run", "--workers", "1", "faststream_cookiecutter_test.application:app"] 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/README.md b/README.md new file mode 100644 index 0000000..a15ed95 --- /dev/null +++ b/README.md @@ -0,0 +1,205 @@ +# Faststream Cookiecutter Test + +Application in this repository is developed using the [`FastStream`](https://github.com/airtai/faststream) framework. Below, you'll find a guide on how to get started, develop new features or bug fixes, and ensure the quality of your code through testing and linting, run the [`FastStream`](https://github.com/airtai/faststream) application locally, and view [`AsyncAPI`](https://www.asyncapi.com/) documentation. + +## Getting Started + +To set up your development environment, follow these steps: + +1. Clone this repository to your local machine: + + ```bash + git clone https://github.com/sternakt@gmail.com/faststream_cookiecutter_test.git + cd faststream_cookiecutter_test + ``` + +2. Install all development requirements using pip: + + ```bash + pip install -e ".[dev]" + ``` + +## Development + +The application code is located in the `app/` directory. You can add new features or fix bugs in this directory. However, remember that code changes must be accompanied by corresponding updates to the tests located in the `tests/` directory. + +## Running Tests + +Once you have updated tests, you can execute the tests using [`pytest`](https://pytest.org/): + +```bash +pytest +``` + +## Running FastStream Application Locally + +To run the [`FastStream`](https://github.com/airtai/faststream) application locally, follow these steps: + +1. Start the Kafka Docker container locally using the provided script: + + ```bash + ./scripts/start_kafka_broker_locally.sh + ``` + +2. Start the [`FastStream`](https://github.com/airtai/faststream) application with the following command: + + ```bash + faststream run faststream_cookiecutter_test.application:app --workers 1 + ``` + +3. You can now send messages to the Kafka and can test the application. Optionally, if you want to view messages in it, you can subscribe to it using the provided script: + + ```bash + ./scripts/subscribe_to_kafka_broker_locally.sh + ``` + +4. To stop the [`FastStream`](https://github.com/airtai/faststream) application, press `Ctrl+C`. + +5. Finally, stop the Kafka Docker container by running the script: + + ```bash + ./scripts/stop_kafka_broker_locally.sh + ``` + +## Building and Testing Docker Image Locally + +If you'd like to build and test the [`Docker`](https://www.docker.com/) image locally, follow these steps: + +1. Run the provided script to build the [`Docker`](https://www.docker.com/) image locally. Use the following command: + + ```bash + ./scripts/build_docker.sh sternakt@gmail.com faststream_cookiecutter_test + ``` + + This script will build the [`Docker`](https://www.docker.com/) image locally with the same name as the one built in `CI`. + +2. Before starting the [`Docker`](https://www.docker.com/) container, ensure that a Kafka [`Docker`](https://www.docker.com/) container is running locally. You can start it using the provided script: + + ```bash + ./scripts/start_kafka_broker_locally.sh + ``` + +3. Once Kafka is up and running, you can start the local [`Docker`](https://www.docker.com/) container using the following command: + + ```bash + docker run --rm --name faststream-app --net=host ghcr.io/sternakt@gmail.com/faststream_cookiecutter_test:latest + ``` + + * `--rm`: This flag removes the container once it stops running, ensuring that it doesn't clutter your system with unused containers. + + * `--name faststream-app`: Assigns a name to the running container, in this case, "faststream-app". + + * `--net=host`: This flag allows the [`Docker`](https://www.docker.com/) container to share the host's network namespace. + +4. To stop the local [`Docker`](https://www.docker.com/) container, simply press `Ctrl+C` in your terminal. + +5. Finally, stop the Kafka [`Docker`](https://www.docker.com/) container by running the provided script: + + ```bash + ./scripts/stop_kafka_broker_locally.sh + ``` + +## Code Linting + +After making changes to the code, it's essential to ensure it adheres to coding standards. We provide a script to help you with code formatting and linting. Run the following script to automatically fix linting issues: + +```bash +./scripts/lint.sh +``` + +## Static Analysis + +Static analysis tools [`mypy`](https://mypy.readthedocs.io/en/stable/) and [`bandit`](https://bandit.readthedocs.io/en/latest/) can help identify potential issues in your code. To run static analysis, use the following script: + +```bash +./scripts/static-analysis.sh +``` + +If there are any static analysis errors, resolve them in your code and rerun the script until it passes successfully. + +## Viewing AsyncAPI Documentation + +[`FastStream`](https://github.com/airtai/faststream) framework supports [`AsyncAPI`](https://www.asyncapi.com/) documentation. To ensure that your changes are reflected in the [`AsyncAPI`](https://www.asyncapi.com/) documentation, follow these steps: + +1. Run the following command to view the [`AsyncAPI`](https://www.asyncapi.com/) documentation: + + ```bash + faststream docs serve faststream_cookiecutter_test.application:app + ``` + + This command builds the [`AsyncAPI`](https://www.asyncapi.com/) specification file, generates [`AsyncAPI`](https://www.asyncapi.com/) documentation based on the specification, and serves it at `localhost:8000`. + +2. Open your web browser and navigate to to view the [`AsyncAPI`](https://www.asyncapi.com/) documentation reflecting your changes. + +3. To stop the [`AsyncAPI`](https://www.asyncapi.com/) documentation server, press `Ctrl+C`. + +## Contributing + +Once you have successfully completed all the above steps, you are ready to contribute your changes: + +1. Add and commit your changes: + + ```bash + git add . + git commit -m "Your commit message" + ``` + +2. Push your changes to GitHub: + + ```bash + git push origin your-branch + ``` + +3. Create a merge request on GitHub. + +## Continuous Integration (CI) + +This repository is equipped with GitHub Actions that automate static analysis and pytest in the CI pipeline. Even if you forget to perform any of the required steps, CI will catch any issues before merging your changes. + +This repository has three workflows, each triggered when code is pushed: + +1. **Tests Workflow**: This workflow is named "Tests" and consists of two jobs. The first job runs static analysis tools [`mypy`](https://mypy.readthedocs.io/en/stable/) and [`bandit`](https://bandit.readthedocs.io/en/latest/) to identify potential issues in the codebase. The second job runs tests using [`pytest`](https://pytest.org/) to ensure the functionality of the application. Both jobs run simultaneously to expedite the `CI` process. + +2. **Build Docker Image Workflow**: This workflow is named "Build Docker Image" and has one job. In this job, a [`Docker`](https://www.docker.com/) image is built based on the provided Dockerfile. The built image is then pushed to the [**GitHub Container Registry**](https://ghcr.io), making it available for deployment or other purposes. + +3. **Deploy FastStream AsyncAPI Docs Workflow**: The final workflow is named "Deploy FastStream AsyncAPI Docs" and also consists of a single job. In this job, the [`AsyncAPI`](https://www.asyncapi.com/) documentation is built from the specification, and the resulting documentation is deployed to [**GitHub Pages**](https://pages.github.com/). This allows for easy access and sharing of the [`AsyncAPI`](https://www.asyncapi.com/) documentation with the project's stakeholders. + +## Viewing AsyncAPI Documentation Hosted at GitHub Pages + +After the **Deploy FastStream AsyncAPI Docs** workflow in `CI` has been successfully completed, the [`AsyncAPI`](https://www.asyncapi.com/) documentation is automatically deployed to [**GitHub Pages**](https://pages.github.com/). This provides a convenient way to access and share the documentation with project stakeholders. + +To view the deployed [`AsyncAPI`](https://www.asyncapi.com/) documentation, open your web browser and navigate to the following URL: + +```txt +https://sternakt@gmail.com.github.io/faststream_cookiecutter_test/ +``` + +You will be directed to the [**GitHub Pages**](https://pages.github.com/) site where your [`AsyncAPI`](https://www.asyncapi.com/) documentation is hosted. This hosted documentation allows you to easily share your [`AsyncAPI`](https://www.asyncapi.com/) specifications with others and provides a centralized location for reviewing the [`AsyncAPI`](https://www.asyncapi.com/) documentation. + +## Deploying Docker Container + +Once the **Build Docker Image** workflow in `CI` has successfully completed, the built [`Docker`](https://www.docker.com/) image is pushed to the [**GitHub Container Registry**](https://ghcr.io). You can then deploy this image on your server by following these steps: + +1. Pull the [`Docker`](https://www.docker.com/) image from the [**GitHub Container Registry**](https://ghcr.io) to your server using the following command: + + ```bash + docker pull ghcr.io/sternakt@gmail.com/faststream_cookiecutter_test:latest + ``` + +2. After successfully pulling the image, start the [`Docker`](https://www.docker.com/) container using the following command: + + ```bash + docker run --rm --name faststream-app --env-file /path/to/env-file ghcr.io/sternakt@gmail.com/faststream_cookiecutter_test:latest + ``` + + * `--rm`: This flag removes the container once it stops running, ensuring that it doesn't clutter your system with unused containers. + + * `--name faststream-app`: Assigns a name to the running container, in this case, "faststream-app". + + * `--env-file /path/to/env-file`: Specifies the path to an environment file (commonly a `.env` file) that contains environment variables required by your [`FastStream`](https://github.com/airtai/faststream) application. Storing secrets and configuration in an environment file is a secure and best practice for handling sensitive information such as Kafka host, port, and authentication details. + +By following these steps, you can easily deploy your [`FastStream`](https://github.com/airtai/faststream) application as a [`Docker`](https://www.docker.com/) container on your server. Remember to customize the `env-file` and other environment variables as needed to suit your specific application requirements. + +--- + +Happy coding with [`FastStream`](https://github.com/airtai/faststream) Application! If you have any questions or encounter any problems, feel free to reach out to us. We appreciate your contributions and commitment to maintaining code quality. diff --git a/faststream_cookiecutter_test/application.py b/faststream_cookiecutter_test/application.py new file mode 100644 index 0000000..1cb3724 --- /dev/null +++ b/faststream_cookiecutter_test/application.py @@ -0,0 +1,60 @@ +import asyncio +import random + +from faststream import FastStream, Logger +from faststream.kafka import KafkaBroker +from pydantic import BaseModel, Field + +version = "0.1.0" +title = "My FastStream service" +description = "Description of my FastStream service" + + +class Name(BaseModel): + name: str = Field(..., description="Name of the person") + + +class Greeting(BaseModel): + greeting: str = Field(..., description="Greeting message") + + +broker = KafkaBroker() +app = FastStream(broker, title=title, version=version, description=description) + +to_greetings = broker.publisher( + "greetings", + description="Produces a message on greetings after receiving a meesage on names", +) + + +@broker.subscriber("names", description="Consumes messages from names topic and produces messages to greetings topic") +async def on_names(msg: Name, logger: Logger) -> None: + result = f"hello {msg.name}" + logger.info(result) + greeting = Greeting(greeting=result) + await to_greetings.publish(greeting) + + +@app.after_startup +async def publish_names() -> None: + async def _publish_names() -> None: + names = [ + "Ana", + "Mario", + "Pedro", + "João", + "Gustavo", + "Joana", + "Mariana", + "Juliana", + ] + while True: + name = random.choice(names) # nosec + + await broker.publish(Name(name=name), topic="names") + + + + await asyncio.sleep(2) + + asyncio.create_task(_publish_names()) diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..df0aa51 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,84 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] + +version = "0.1.0" +name = "faststream_cookiecutter_test" + +dependencies = [ + "faststream[kafka, docs]>=0.1.5", +] + +[project.optional-dependencies] +lint = [ + "black==23.9.1", + "ruff==0.0.291", + "pyupgrade-directories", +] + +static-analysis = [ + "types-PyYAML", + "types-setuptools", + "types-ujson", + "mypy==1.5.1", + "bandit==1.7.5", +] + +testing = [ + "pytest==7.4.2", + "pytest-asyncio==0.21.1", +] + +dev = ["faststream_cookiecutter_test[lint,static-analysis,testing]"] + +[tool.pytest.ini_options] +filterwarnings =["ignore::DeprecationWarning"] + +[tool.mypy] +strict = true +python_version = "3.8" +ignore_missing_imports = true +install_types = true +non_interactive = true + +# from https://blog.wolt.com/engineering/2021/09/30/professional-grade-mypy-configuration/ +disallow_untyped_defs = true +no_implicit_optional = true +check_untyped_defs = true +warn_return_any = true +show_error_codes = true +warn_unused_ignores = true + +disallow_incomplete_defs = true +disallow_untyped_decorators = true +disallow_any_unimported = false + +[tool.black] +line-length = 88 +target-version = ['py38'] +include = '\.pyi?$' + +[tool.ruff] +fix = true +line-length = 88 +target-version = "py38" +select = [ + "E", # pycodestyle errors + "W", # pycodestyle warnings + "F", # pyflakes + "I", # isort + "C", # flake8-comprehensions + "B", # flake8-bugbear + "Q", # flake8-quotes +] +ignore = [ + "E501", # line too long, handled by black + "C901", # too complex +] + +[tool.ruff.pydocstyle] +convention = "google" + +[tool.bandit] diff --git a/scripts/build_docker.sh b/scripts/build_docker.sh new file mode 100755 index 0000000..97954dd --- /dev/null +++ b/scripts/build_docker.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +docker build -t ghcr.io/sternakt@gmail.com/faststream_cookiecutter_test:latest . diff --git a/scripts/lint.sh b/scripts/lint.sh new file mode 100755 index 0000000..5fb8c75 --- /dev/null +++ b/scripts/lint.sh @@ -0,0 +1,10 @@ +#!/bin/bash + +echo "Running pyup_dirs..." +pyup_dirs --py38-plus --recursive faststream_cookiecutter_test tests + +echo "Running ruff..." +ruff faststream_cookiecutter_test tests --fix + +echo "Running black..." +black faststream_cookiecutter_test tests diff --git a/scripts/services.yml b/scripts/services.yml new file mode 100644 index 0000000..b6d5dcf --- /dev/null +++ b/scripts/services.yml @@ -0,0 +1,32 @@ +version: "3" +services: + # nosemgrep: yaml.docker-compose.security.writable-filesystem-service.writable-filesystem-service + + 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_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 + + + + # https://semgrep.dev/r?q=yaml.docker-compose.security.no-new-privileges.no-new-privileges + security_opt: + - no-new-privileges:true diff --git a/scripts/start_kafka_broker_locally.sh b/scripts/start_kafka_broker_locally.sh new file mode 100755 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/static-analysis.sh b/scripts/static-analysis.sh new file mode 100755 index 0000000..3da5ce6 --- /dev/null +++ b/scripts/static-analysis.sh @@ -0,0 +1,8 @@ +#!/bin/bash +set -e + +echo "Running mypy..." +mypy faststream_cookiecutter_test + +echo "Running bandit..." +bandit -c pyproject.toml -r faststream_cookiecutter_test diff --git a/scripts/stop_kafka_broker_locally.sh b/scripts/stop_kafka_broker_locally.sh new file mode 100755 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 100755 index 0000000..6cb37b1 --- /dev/null +++ b/scripts/subscribe_to_kafka_broker_locally.sh @@ -0,0 +1,18 @@ +#!/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/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_application.py b/tests/test_application.py new file mode 100644 index 0000000..8244aa8 --- /dev/null +++ b/tests/test_application.py @@ -0,0 +1,17 @@ +import pytest +from faststream.kafka import TestKafkaBroker + +from faststream_cookiecutter_test.application import Greeting, Name, 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")))