feature: MongoDB support via beanie

[usefulalgorithm]

Adds support for MongoDB and Beanie. Probably fixes #119 ?

I did a simple crud app with virtually the same setup, seems to be working fine.

Demos

• project setup: https://asciinema.org/a/U5YaCeweA4vGqmNCv5zpBpwSc
• deploying MongoDB and starting the application: https://asciinema.org/a/XOq7NByeER8kC3tT0cLFsW2gO
• a simple crud app: https://github.com/usefulalgorithm/fastapi-mongo-demo-app/
  • some differences between this project and this PR:
    • db service is placed in docker-compose.dev.yaml instead of docker-compose.yml
    • Settings has a separate section for mongodb settings

Todos / caveats / things to note:

• MongoDB requires additional setup if you're not writing to the admin database
• Some docstring and comments are probably off, and flake is likely to complain.
• I have no idea how cookiecutter works, so I basically did it like how I use Jinja templates and tried to fill in as many gaps as possible. I'm guessing I probably missed a lot of places...
• The only setup I tested is the one in the clip.

[s3rius]

Hi and thanks for your AWESOME WORK! But I have some questions and suggestions regarding the PR.

Few things to add:

• Services for Github actions and Gitlab-Ci. It's used by generate CI option.
• Fix dummy for GraphQL in web/gql folder. Since it's the same as for REST right now.
• Can you please add test in fastapi_template/tests/test_generator.py? Because we need to be sure that after the project generation, all generated tests are passing.

Thank you very much. I really appreciate the work you did.

[s3rius]

Actually, you can easily test the project generations by creating one command and running it everytime you make changes. For example.

fastapi_template --name myproject --db mongo --api-type rest --orm beanie --dummy --routers --quite --force

This command will be overriding all files within myproject folder. It helps me fixing all flake errors.

[s3rius]

Also, you should not start DB separately from the project. The main point is that the up command will bring all services app, including your application.

docker compose up --build

[usefulalgorithm]

Hi @s3rius , I think I addressed all the things you suggested:

• Services for Github actions and Gitlab-Ci. It's used by generate CI option.
  • Added variables in test.yml and .gitlab-ci.yml.
• Fix dummy for GraphQL in web/gql folder. Since it's the same as for REST right now.
  • Done.
• Can you please add test in fastapi_template/tests/test_generator.py?
  • Added several tests in that file.

I also made sure all flake8 warnings are gone, mypy does not complain, and that I was able to create & read dummy models with the containers started by docker compose.

However I wasn't able to get pytest to run successfully (both in fastapi_template and in the generated myproject). In fastapi_template running poetry run pytest breaks:

FAILED fastapi_template/tests/test_generator.py::test_default_with_db[sqlalchemy-mysql] - AssertionError
FAILED fastapi_template/tests/test_generator.py::test_default_with_db[tortoise-mysql] - AssertionError
FAILED fastapi_template/tests/test_generator.py::test_default_with_db[ormar-mysql] - AssertionError
FAILED fastapi_template/tests/test_generator.py::test_default_with_nosql_db[beanie-mongodb] - AssertionError

and running tests in myproject would always end up with an unauthenticated client. Are the tests meant to be run only when triggered by github / gitlab pipelines?

Thanks!

[usefulalgorithm]

Hi @s3rius, I modified the PR per your suggestions, please check out the changes and see if they make sense when you have time, thanks a bunch!

[usefulalgorithm]

Hi @s3rius , sorry for the lack of response. I've addressed all your suggestions in the latest commit, please take a look when you have time.

There's something I don't get in the generated test_dummy.py file:

async def test_creation(
    fastapi_app: FastAPI,
    client: AsyncClient,
) -> None:
    """Tests dummy instance creation."""
    url = fastapi_app.url_path_for("create_dummy_model")
    test_name = uuid.uuid4().hex
    response = await client.put(
        url,
        json={
            "name": test_name,
        },
    )   # Inserts a Dummy into DB
# ... snipped ...
@pytest.mark.anyio
async def test_getting(
    fastapi_app: FastAPI,
    client: AsyncClient,
) -> None:
    """Tests dummy instance retrieval."""
    dao = DummyDAO()
    test_name = uuid.uuid4().hex
    await dao.create_dummy_model(name=test_name)  # XXX Inserts another Dummy into DB??
    url = fastapi_app.url_path_for("get_dummy_models")
    response = await client.get(url)
    dummies = response.json()

    assert response.status_code == status.HTTP_200_OK
    assert len(dummies) == 1   # XXX Should be 2?

This the only test that's failing. What I don't understand is that how come in test_getting it is testing that the object we inserted is indeed the only object in the database, while the object inserted in test_creation is never cleaned up?

Thanks in advance for taking a look and answering the question!

I decided to remove the inserted object in test_creation, so that in test_getting it's going to report only one object in the database. Now all tests are passing on my machine.

Thanks!

[usefulalgorithm]

Hi @s3rius , I believe this is complete now. Thanks!

[usefulalgorithm]

@s3rius ping

[s3rius]

Sorry. I couldn't find time to review. It takes a lot of time to review every request to this project.

But thank you very much for implementing it. I know how much effort it takes to implement something like this.

[s3rius]

Okay. I don't know what is happening, but now mypy seems to complain about some types. Can you fix it?

Just add an [Any] to every AsyncConnectionPool like AsyncConnectionPool[Any]. Don't forget to add any in imports if it doesn't exists yet in the file.

[usefulalgorithm]

Sorry I missed a AsyncConnectionPool... can you trigger the test again? Thanks

[usefulalgorithm]

I don't get it...

[s3rius]

@usefulalgorithm, that's fine. Happens sometimes. Will rerun tests.

[s3rius]

I will try to fix the problem on develop branch. Thanks for your outstanding contribution.