# Deploy-guard voor projects.timfalken.com

Elke repository die naar `projects.timfalken.com` deployt staat in de BlueGit-groep `projects.timfalken.com` (pad `projects-timfalken-com`). De groep levert de gedeelde, beschermde geheimen `timftphost`, `timftpuser`, `timftppassword` en `timftproot`. Elk project zet zelf alleen `projectftp`, bijvoorbeeld `$timftproot/<project>`, ook beschermd.

Een deploy met een ontbrekende of verkeerde `projectftp` zou met `mirror --delete` de hele site kunnen wissen. Daarom draait elk project de guard vóór de upload.

## Gebruik

1. Kopieer [`ci/deploy_guard.py`](../ci/deploy_guard.py) ongewijzigd naar `ci/` van het project (alleen de Python-standaardbibliotheek).
2. Zet in de deploy-job een eigen stap vóór de upload:

   ```yaml
   ftp_upload:
     stage: deploy
     needs: [<alle testjobs>]
     rules:
       - if: '$CI_COMMIT_BRANCH == "master" && $CI_PIPELINE_SOURCE != "merge_request_event"'
     script:
       - python3 ci/deploy_guard.py
       - python3 ci/deploy.py
   ```

3. Gebruik in een Python-deployscript de gecontroleerde map in plaats van `projectftp` zelf:

   ```python
   from deploy_guard import project_dir
   target = project_dir(os.environ)   # gooit DeployGuardError (ValueError)
   ```

   Een shellscript doet `python3 ci/deploy_guard.py || exit 1` en gebruikt daarna de map.

## Wat de guard weigert

| `projectftp` | Uitkomst |
|---|---|
| niet gezet | geblokkeerd |
| leeg of alleen spaties | geblokkeerd |
| `/`, `.`, `./` | geblokkeerd |
| gelijk aan `timftproot` (ook `$timftproot`, met of zonder `/`) | geblokkeerd |
| bevat `..`, begint met `~`, of een andere `$`-verwijzing | geblokkeerd |
| absoluut pad buiten `timftproot` | geblokkeerd |
| `$timftproot` zonder dat `timftproot` gezet is | geblokkeerd |
| `$timftproot/<project>` of een relatieve submap | toegestaan |

Meldingen noemen alleen namen van variabelen, nooit waarden. De tests staan in `ci/test_deploy.py` (`DeployGuardTests`).
