Database migration with alembic

[jean-pasquier]

Database migration implementation using Alembic tool: alter database schema (create table, add column, etc.) using SQLAlchemy syntax, more info in src/alembic/README.md

• src/alembic.ini is configuration (almost default one, generated by alembic)
• src/alembic/
  • versions/ contains migration scripts (so far empty)
  • env.py alembic migration skeletton (default adapted to retrieve database URL from the app config)
  • README.md alembic generated an empty readme, first draft here
  • script.py.mako script generation template (default one)

Open questions:

• alembic added to requirements.txt, afterward maybe it should be in requirements-dev.txt since it concerns CI/CD phase and not running docker image ?
• add a Github workflow to run the migration in production, only once it is merged to master ?
• how to test the scripts before merging to master ? There are libraries such as pytest-alembic
• encode (maintainers of async database package) use another but similar method to set database url config.set_main_option in there doc

resolves #107

[frgfm]

Thanks for this PR! I added a few comments, but I have no experience with alembic

[frgfm]

Thanks for the edits! I'm still having doubts for the Dockerfile modifications but it's nitpicking

[frgfm]

Just the copyright & license notice missing 👌

[frgfm]

All good now!

[codecov]

Codecov Report

Merging #112 (5271767) into master (a139a8c) will increase coverage by 0.16%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #112      +/-   ##
==========================================
+ Coverage   88.31%   88.47%   +0.16%     
==========================================
  Files          27       27              
  Lines         787      807      +20     
==========================================
+ Hits          695      714      +19     
- Misses         92       93       +1     

Flag	Coverage Δ
unittests	88.47% <ø> (+0.16%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/app/api/crud/base.py	98.14% <0.00%> (-1.86%)	⬇️
src/app/db/tables.py	100.00% <0.00%> (ø)
src/app/api/routes/sites.py	100.00% <0.00%> (ø)
src/app/api/routes/events.py	100.00% <0.00%> (ø)
src/app/api/routes/devices.py	100.00% <0.00%> (ø)
src/app/api/routes/accesses.py	100.00% <0.00%> (ø)
src/app/api/schemas.py	99.15% <0.00%> (+0.02%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a139a8c...5271767. Read the comment docs.

[frgfm]

@jeanpasquier75 I think we are ready to merge. Since we don't have a unittest or any CI integration yet, can you confirm that you tried to modify one of the table and used your alembic instructions to perform the migration, which was successful ? :)

[jean-pasquier]

@jeanpasquier75 I think we are ready to merge. Since we don't have a unittest or any CI integration yet, can you confirm that you tried to modify one of the table and used your alembic instructions to perform the migration, which was successful ? :)

Yes sir I confirm that it works fine in my postgres image 😉