BlueGit

projects-timfalken-com verhalenboek

Files

verhalenboek / docs / deploy-guard.md

deploy-guard.md

deploy-guard.md 1.9 KiB Download Raw

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 ongewijzigd naar ci/ van het project (alleen de Python-standaardbibliotheek). 2. Zet in de deploy-job een eigen stap vóór de upload:

   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:

   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

projectftpUitkomst
niet gezetgeblokkeerd
leeg of alleen spatiesgeblokkeerd
/, ., ./geblokkeerd
gelijk aan timftproot (ook $timftproot, met of zonder /)geblokkeerd
bevat .., begint met ~, of een andere $-verwijzinggeblokkeerd
absoluut pad buiten timftprootgeblokkeerd
$timftproot zonder dat timftproot gezet isgeblokkeerd
$timftproot/<project> of een relatieve submaptoegestaan

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

Source
1# Deploy-guard voor projects.timfalken.com
2
3Elke 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.
4
5Een 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.
6
7## Gebruik
8
91. Kopieer [`ci/deploy_guard.py`](../ci/deploy_guard.py) ongewijzigd naar `ci/` van het project (alleen de Python-standaardbibliotheek).
102. Zet in de deploy-job een eigen stap vóór de upload:
11
12 ```yaml
13 ftp_upload:
14 stage: deploy
15 needs: [<alle testjobs>]
16 rules:
17 - if: '$CI_COMMIT_BRANCH == "master" && $CI_PIPELINE_SOURCE != "merge_request_event"'
18 script:
19 - python3 ci/deploy_guard.py
20 - python3 ci/deploy.py
21 ```
22
233. Gebruik in een Python-deployscript de gecontroleerde map in plaats van `projectftp` zelf:
24
25 ```python
26 from deploy_guard import project_dir
27 target = project_dir(os.environ) # gooit DeployGuardError (ValueError)
28 ```
29
30 Een shellscript doet `python3 ci/deploy_guard.py || exit 1` en gebruikt daarna de map.
31
32## Wat de guard weigert
33
34| `projectftp` | Uitkomst |
35|---|---|
36| niet gezet | geblokkeerd |
37| leeg of alleen spaties | geblokkeerd |
38| `/`, `.`, `./` | geblokkeerd |
39| gelijk aan `timftproot` (ook `$timftproot`, met of zonder `/`) | geblokkeerd |
40| bevat `..`, begint met `~`, of een andere `$`-verwijzing | geblokkeerd |
41| absoluut pad buiten `timftproot` | geblokkeerd |
42| `$timftproot` zonder dat `timftproot` gezet is | geblokkeerd |
43| `$timftproot/<project>` of een relatieve submap | toegestaan |
44
45Meldingen noemen alleen namen van variabelen, nooit waarden. De tests staan in `ci/test_deploy.py` (`DeployGuardTests`).