diff options
| author | Frederick Muriuki Muriithi | 2022-11-03 09:05:44 +0300 |
|---|---|---|
| committer | Frederick Muriuki Muriithi | 2022-11-03 09:25:50 +0300 |
| commit | ef70ddc1fb2800e340de50bcdb3cef2d34cc3b11 (patch) | |
| tree | 1a3735ad4db6f567c9f70f8160009e16b82e9019 /README.md | |
| parent | 6e58cb5ffe3b145aa6ba9b7a54672e7a7f18a0b7 (diff) | |
| download | genenetwork3-ef70ddc1fb2800e340de50bcdb3cef2d34cc3b11.tar.gz | |
Initialise the Auth(entic|oris)ation packages
Initialise the authentication/authorisation system packages and set up the
initial database migrations to set up the system.
* README.md: Add documentation on migrations
* gn3/auth/__init__.py: init package
* gn3/auth/authentication/__init__.py: init package
* gn3/auth/authorisation/__init__.py: init package
* gn3/migrations.py: provide migration utilities
* migrations/auth/20221103_01_js9ub-initialise-the-auth-entic-oris-ation-database.py:
new migration
* tests/unit/auth/test_init_database.py: test new migration applies and rolls
back as expected
* tests/unit/conftest.py: fixtures for unit tests
* yoyo.auth.ini: basic configuration for yoyo-migration for auth system
migrations
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
@@ -95,6 +95,36 @@ and try again. Also make sure your ~/guix-bioinformatics is up to date. See also instructions in [.guix.scm](.guix.scm). +## Migrations + +**NOTE**: Do not create migration scripts manually. Use the processes indicated below. + +### Authentication/Authorisation Migrations + +The migration scripts for the authentication and authorisation system are in the *migrations/auth* folder in the root of the repository. + +To create an new migration, do: + +```bash +$ yoyo new --config=yoyo.auth.ini -m "<description of the migration>" +``` + +That initialises an new migration script under the *migrations/auth* folder and gives it a name derived from the date, the sequence for that day, and the provided description. + +e.g. + +```bash +$ yoyo new --config=yoyo.auth.ini -m "testing a new migration" +Error: could not open editor! +Created file ./migrations/auth/20221103_02_HBzwk-testing-a-new-migration.py +``` + +Now you can open and edit the scripts to provide the appropriate SQL statements to update or rollback your schema. + +### Running the Migrations + +**TODO**: Document how to run the migrations + ## Running Tests (assuming you are in a guix container; otherwise use venv!) |