CONTRIBUTING.md

Contributing

It would be fantastic if you would create an issue or better, create a PR, or do a code review. Contributions are always welcome! Before doing a contribution please take a look at our guideline.

Architecture

The architecture is module based, like in Golang projects. A little inspiration was taken from PHP and Python to use Repository pattern.

Most of the modules are split into:

• entity: Structs containing domain logic
• repository: Interaction with data store via ConfigurationProvider or GORM (only private methods there)
• service: Public methods performing actual actions on the model, repository. There are defined actions that aggregates logic as much as it is possible

'http' module

It is a special module that defines all routes, it's authentication and security logic for every endpoint.

• auth: Endpoints related to authorization and users management
• collection: Endpoints for operations on collections
• responses: HTTP responses format standardization
• utils: Various utils for validating user input, checking session etc.
• main: Registers all the endpoints to the router

Development environment & testing

1. Application should be tested with all supported software listed in README.md if there is a risk that something could be broken
2. Unit tests coverage is required
3. API tests in PyTest should be written, especially when code is difficult to cover with unit tests

Manual testing helpers

Take a look at test.mk file, which contains Makefile tasks for manual testing, used at development time as handy shortcuts.

make dev
make -f test.mk import-examples

# at first login and export the retrieved token into the shell
make -f test.mk test_login
export TOKEN=...

# then use prepared curl snippets to test functionalities
make -f test.mk test_collection_health test_whoami # ...

Automated testing

Unit tests can be executed within:

make test

There are also E2E tests on a real application image:

make integration-test