janmate/happy_bank_core

This repo contains the simple example of bank core backend app.

happy_bank_core's Issues

Add lint, code style, build and publish core app docker image on on-PR and on-merge (CI) pipelines

Set build and publish stages on CI pipeline.
Instead of poetry build and publish, set docker build command to build a new docker image.
Additionally, set pylint and black steps.

Source:

• https://docs.github.com/en/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#publishing-a-package-using-an-action
• https://github.com/MeStrak/dr-sven/blob/main/.github/workflows/ci.yml
• https://black.readthedocs.io/en/stable/integrations/github_actions.html

Set a logger for core app

Choose a convenient logger lib and use it in the python code

Add python typing check and code coverage stages on CI

Check out mypy: https://mypy.readthedocs.io/en/stable/

Check out coverage: https://coverage.readthedocs.io/en/6.3.1/

It requires only update pyproject.tom (dev-dependencies) - setup on CI is not needed because the dependency management is done by poetry.

Create unit tests for core logic layer

Use pytest convension and mocks from unittest package.

Add unit tests into tests folder.

(!!! High Priority !!!) Fix black python format checker on CI

This task must be solve ASAP because blocks all CI.

Source: https://github.com/marketplace/actions/black-check

Fix bash_exam.sh script by the shellcheck

The linter job in CI pipelines shows some findings that should be solved.

Create REST api endpoins in core app via Flask library

Create REST API endpoints in RestApi class in rest/api.py

Endpoints name: TBA (TODO)

Fix dockerfile to run core app in container

Add exception handling in RESTapi

In app.py, add exception handling on the RESTapi level.

Add logic call into RESTapi of the core app as a part of this task.

Source: https://flask.palletsprojects.com/en/2.0.x/errorhandling/#error-handlers

Create CLI layer in core app via Click library

Add CLI commands into Cli class in cli/cli.py and ensure running app from command line.

Parametrize unit test cases as much as possible to prevent code duplication

Source: https://realpython.com/pytest-python-testing/#parametrization-combining-tests

Create unit tests for core data layer and account data class

Setup core app

1. Refactor repo structure:
   1. create new folder "core" in root of the repo and move there all current folders in the root folder.
   2. set the moved folders as python module (hint: https://naucse.python.cz/course/mi-pyt/intro/distribution/)
2. Update "workdir" config in Dockerfile to created "core" folder to fetch correctly python code into the docker image.
3. Prepare python venv to enable to run the python code for anybody who faces the repo.

Hint: https://github.com/MeStrak/dr-sven/blob/main/pyproject.toml

Add account registration RESTapi endpoint and logic + unit tests

Add new endpoint with path "register" that receive only POST HTTP method and JSON HTTP body containing account properties.

For the logic create new "Registration" class in the module with the same name and "register" method within.

Create core app logic

Create new class Transaction in logic/transaction folder with following methods:

• init()
• check_account_balance(account_id, amount)
• transfer(sender_account, receiver_account, amount)
  • sender_account is Account instance
  • receiver_account is Account instance

Fix commitlint to respect sentence-case and move it to lint job

• https://github.com/wagoid/commitlint-github-action
• https://commitlint.js.org/#/reference-rules
• https://github.com/conventional-changelog/commitlint
• https://github.com/conventional-changelog/commitlint/#what-is-commitlint

Implement Dockerfile to build Alpine Linux

Implement bash_exam.sh script

Replace "TODOs" in the bash_exam.sh script with your implementation by the instruction above it.

If you have no clue by any of tasks, do not hesitate to open discussion, either in this issue or in a pull request that you would have opened.

Remember and don't forget to be up-to-date -> rebase yourself onto main branch and create a new branch for your task !!!

Create data layer in core app

Create general and uniform interface (create class Connector) in data/connector.py

Add following methods into class:

• read(account_id) -> Account
• update(account_id, account, amount) -> void/WriteException

• Create new class MemoryConnector in data/memory_connector.py that inherits behavior from Connector class. This class will contains list of Account instances - read() method returns the certain account by ID and update() method updates the existing list.
• Create new class FileConnector in data/file_connector.py that inherits behavior from Connector class. This class will contains file read logic - read() method returns the certain account by ID and update() method updates the existing list in json data file.

Set uid and gid for core user in core app Dockerfile

https://medium.com/@mccode/understanding-how-uid-and-gid-work-in-docker-containers-c37a01d01cf

Set WSGI python app server for running core app in production env mode

Create folder structure for core app