thomasrosales / crehana

crehana

Run Application

Requirements

python >= 3.9
pipenv, version 2021.11.23

Install Dependecies

python -m pipenv sync --dev
or 
python -m pipenv sync
or
pipenv sync

PostgresDB Credentials

DB User = crehana
DB Password = crehana
DB server = localhost
DB Name = crehana

Run Migrations

python -m pipenv run alembic upgrade heads

Output:

INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO  [alembic.runtime.migration] Will assume transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade  -> ff0610ae2eb2, create posts and comments models
INFO  [alembic.runtime.migration] Running upgrade ff0610ae2eb2 -> 9338a9bec1e1, adding external id column to posts and comments models
INFO  [alembic.runtime.migration] Running upgrade 9338a9bec1e1 -> e84a82b1f90b, delete posts cascade
INFO  [alembic.runtime.migration] Running upgrade e84a82b1f90b -> 28ced816a423, delete posts cascade

Execute FastAPI Server

python -m pipenv run uvicorn src.main:app --reload
or
python -m pipenv shell
uvicorn src.main:app --reload

Output:

INFO:     Will watch for changes in these directories: ['D:\\GitHub\\crehana']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [13152] using WatchFiles
INFO:     Started server process [1072]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Execute integration from CLI

We can run the integration in two ways: (1) execute the integration via CLI:

python -m pipenv run python managment.py --help
python -m pipenv run python managment.py --confirm

Output:

{'posts_created': 100, 'posts_updated': 0, 'comments_created': 500, 'comments_updated': 0}

(2) go to the next endpoint: http://127.0.0.1:8000/call_integration/

Endpoints

• http://127.0.0.1:8000/call_integration/
• http://127.0.0.1:8000/graphql/
• http://127.0.0.1:8000/docs

GraphQl Examples

{
  getPost(postId: 100){
    id
    title
    body
  }
}

Output:

{
  listPosts{
    title
  }
}
---
{
  listPosts(skip:100, limit:150){
    title
    id
  }
}

Output:

{
  "data": {
    "listPosts": [
      {
        "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit"
      },
      {
        "title": "qui est esse"
      },
      {
        "title": "ea molestias quasi exercitationem repellat qui ipsa sit aut"
      },
      {
        "title": "eum et est occaecati"
      },
      {
        "title": "nesciunt quas odio"
      },
...

mutation {
  addPost(title:"I'm a new tittle", body:"I'm a new body"){
    id
    title
    body
    userId
  }
}

Output:

{
  "data": {
    "addPost": {
      "id": 101,
      "title": "I'm a new tittle",
      "body": "I'm a new body",
      "userId": 1
    }
  }
}

Run Test

python -m pipenv run pytest tests -v

Output:

============================================================================ test session starts =============================================================================
platform win32 -- Python 3.9.6, pytest-7.1.2, pluggy-1.0.0 -- C:\Users\thomas\.virtualenvs\crehana-GXkyuwey\Scripts\python.exe
cachedir: .pytest_cache
rootdir: D:\GitHub\crehana
plugins: anyio-3.6.1
collected 11 items

tests/test_integration.py::IntegrationAPITestClass::test_sync PASSED                                                                                                    [  9%]
tests/test_main.py::test_read_main PASSED                                                                                                                               [ 18%]
tests/test_main.py::test_read_call_integration PASSED                                                                                                                   [ 27%]
tests/test_provider.py::JSONPlaceHolderProviderTestClass::test_delete_model PASSED                                                                                      [ 36%]
tests/test_provider.py::JSONPlaceHolderProviderTestClass::test_get_model_and_comments PASSED                                                                            [ 45%]
tests/test_provider.py::JSONPlaceHolderProviderTestClass::test_get_model_by_id PASSED                                                                                   [ 54%]
tests/test_provider.py::JSONPlaceHolderProviderTestClass::test_get_models PASSED                                                                                        [ 63%]
tests/test_provider.py::JSONPlaceHolderProviderTestClass::test_insert_model PASSED                                                                                      [ 72%]
tests/test_provider.py::JSONPlaceHolderProviderTestClass::test_partial_update_model PASSED                                                                              [ 81%]
tests/test_provider.py::JSONPlaceHolderProviderTestClass::test_retrieve_data PASSED                                                                                     [ 90%]
tests/test_provider.py::JSONPlaceHolderProviderTestClass::test_update_model PASSED                                                                                      [100%]

Documentation

Create Migrations

alembic init --template generic ./scripts
alembic revision --autogenerate -m "create posts and comments models"

Handle Data iun DB Via Command Line

>>> from src.db import models
>>> from src.db.database import SessionLocal

>>> db = SessionLocal()
>>> db.query(models.Comment).filter(models.Comment.id > 0).delete()
>>> db.query(models.Post).filter(models.Post.id > 0).delete()
>>> db.commit()