Merge pull request #3 from t10d/dev

Base DDD modeling (pre-release v0.3.0)

Author: williamabreu

.env.example

@@ -0,0 +1,15 @@
+# Used by "time.generate_now()". Follow the TZ Database format, for details,
+# see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+TIMEZONE_REGION=America/Sao_Paulo
+
+# If active, shows detailed error information, else shows only user friendly
+# codes.
+DEBUG=False
+
+# The connection URL to the database.
+DATABASE_URL = "postgresql://user:password@localhost:5432/database"
+
+# The credentials to connect to Redis message broker.
+REDIS_HOST = "127.0.0.1"
+REDIS_PORT = "6379"
+REDIS_PASSWORD = ""

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+#### 📝 Description
+
+Write a short paragraph explaining the reasons for this PR.
+
+#### 🛠️ Changes
+
+(OPTIONAL) You can make a short list describing the changes, if possible (and if you want) referencing the id's of the related commits.
+
+#### ⚠️ Notes
+
+(OPTIONAL) This section is especially useful in cases where you want to describe a more detailed view of any changes described or not in the previous section.

.github/workflows/release.yml

@@ -0,0 +1,31 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.9'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,77 @@
+# This workflow will run tests against a Postgres and Redis database on Ubuntu
+# For more information see: https://docs.github.com/en/actions/using-containerized-services/creating-postgresql-service-containers
+
+name: Run Test Suite
+
+on:
+  pull_request:
+    types: [ opened, synchronize, edited ]
+    branches:
+      - main
+      - dev
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: user
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: database
+        ports: [ "5432:5432" ]
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+      redis:
+        image: redis
+        env:
+          REDIS_HOST: 127.0.0.1
+          REDIS_PORT: 6379
+        ports: [ "6379:6379" ]
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: "3.9"
+      - name: Cache pip
+        uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip # This path is specific to Ubuntu
+          # Look to see if there is a cache hit for the corresponding requirements file
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.dev.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
+      - name: Install dependencies
+        run: pip install -r requirements.dev.txt
+
+      - name: Linting checks
+        run: make black flake8 isort pydocstyle
+
+      - name: Typing checks
+        run: make mypy
+
+      - name: Prepare test database
+        env:
+          PYTHONPATH: .
+        run: |
+          cd tests/poc/
+          alembic revision --autogenerate
+          alembic -x data=true -x test=true upgrade head
+
+      - name: Unit Tests
+        run: |
+          pytest tests/unit --color=yes --showlocals -v
+
+      - name: Integration Tests
+        run: |
+          pytest tests/integration --color=yes --showlocals -v

.gitignore

@@ -139,3 +139,6 @@ Thumbs.db
 # IDE
 .idea/
 .vscode/
+
+# Don't commit the alembic revision, it's part of test generate them.
+tests/poc/migration_example/versions/*.py

CHANGELOG.md

@@ -4,6 +4,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## UNRELEASED
+### Added
+- Added base implementation of CQRS Pattern.
+- Added base implementation of Unit of Work Pattern.
+- Added base implementation of Repository Pattern.
+- Added base implementation of Message Bus with dependency injection.
+- Added base implementation of Redis Message Broker.
+- Added higher-order functions to database mappers and factories.
+- Added abstract DDD Entity model.
+- Added generate now time utility.
+- Added root configuration handled by environment variables.
+- Added casting to bool from string utility.
+- Added json serializer utility.
+### Changed
+- Renamed project's name from `kingdom-core` to `kingdom-sdk`.
+- Increased MyPy rules to be more aggresive.
+
+## [0.2.0] - 2021-10-18
+### Added
+- Generic start mappers functions to load the ORM.
+
 ## [0.1.0] - 2021-10-14
 ### Added
 - Find files utility.

README.md

@@ -2,6 +2,20 @@
 
 Library containing the core modules for the kingdom-python-server.
 
+## Test
+
+To test the database package, you need do it manually, running a migration. Make sure the database is configured before.
+
+```bash
+cd tests/poc/
+alembic revision --autogenerate
+alembic upgrade head
+```
+
+The rest, run `pytest`.
+
+Don't commit the generated revision.
+
 ## Installation
 
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install `kingdom-core`.
@@ -19,7 +33,7 @@ poetry add kingdom-core
 ## Usage
 
 ```python
-from kingdom_core.utils import files
+from kingdom_sdk.utils import files
 
 orm_files = files.find("orm.py", "/")
 ```

kingdom_core/__init__.py kingdom_sdk/__init__.pykingdom_core/__init__.py renamed to kingdom_sdk/__init__.py

@@ -3,15 +3,15 @@
 # Define the package's version.
 # - Is used for indexing and distributing the package
 # - Follow the conventions defined by PEP440
-__version__ = "0.1.0"
+__version__ = "0.3.0dev1"
 
 
-def get_base_dir() -> str:
-    """Return the absolute path for projetct's root directory."""
+def _get_base_dir() -> str:
+    """Return the absolute path for kingdom_sdk's root directory."""
     path, _ = os.path.split(os.path.dirname(__file__))
     return path
 
 
-def get_src_dir() -> str:
-    """Return the absolute path for projetct's source directory."""
+def _get_src_dir() -> str:
+    """Return the absolute path for kingdom_sdk's source directory."""
     return os.path.dirname(__file__)

kingdom_core/utils/__init__.py kingdom_sdk/adapters/__init__.pykingdom_core/utils/__init__.py renamed to kingdom_sdk/adapters/__init__.py

@@ -0,0 +1,32 @@
+from typing import Dict, Iterator, Optional
+
+from redis import Redis
+
+from kingdom_sdk import config
+from kingdom_sdk.domain.message import Message
+from kingdom_sdk.ports.message_broker import AbstractMessageBroker
+from kingdom_sdk.utils.serializer import json_dumps
+
+
+class RedisMessageBroker(AbstractMessageBroker):
+    _redis: Redis
+
+    def __init__(self) -> None:
+        self._redis = Redis(
+            host=config.get_redis_host(),
+            port=config.get_redis_port(),
+            password=config.get_redis_password(),
+        )
+
+    def publish(
+        self, channel: str, message: Message, schedule: int = 0
+    ) -> None:
+        msg = message.__dict__
+        msg["schedule"] = schedule
+        del msg["raised_at"]  # doesn't make sense to be recreated
+        self._redis.publish(channel, json_dumps(msg))
+
+    def subscribe(self, *channels: str) -> Iterator[Optional[Dict]]:
+        pubsub = self._redis.pubsub(ignore_subscribe_messages=True)
+        pubsub.subscribe(*channels)
+        return pubsub.listen()  # type: ignore