SLT-17: Fallback to standard drush sql-dump when the gdpr.json file can't be located; Documentation;

Author: Jancis

README.md

@@ -8,7 +8,7 @@ This project template is an opinionated fork of the popular [Drupal-composer tem
 
 - Copy this repository and push it to our organization. 
 - Log in to CircleCI using your Github account and add the new project.
-
+- Create and maintain a Personal Data mapping list for automatic data sanitization in `gdpr.json` file. See GDPR sanitization section for more information.
 
 ## How it works
 
@@ -21,3 +21,35 @@ Have a look at the file for details, but in short this is how it works:
 - Create a custom docker image for Drupal and nginx, and push those to a docker registry (typically that of your cloud provider).
 - Install or update our helm chart while passing our custom images as parameters.
 - The helm chart executes the usual drush deployment commands.
+
+## GDPR sanitization
+
+SQL data dump for developers is parsed with [GDPR Tools](https://github.com/machbarmacher/gdpr-dump) project.
+You can create a `/gdpr.json` file with [Faker](https://packagist.org/packages/fzaninotto/faker) formatters that will allow replacing data as it's dumped from database using `mysqldump` / `drush sql-dump` command.  
+
+```
+{
+  "users_field_data": {
+    "name": {"formatter": "name"},
+    "pass": {"formatter": "password"},
+    "mail": {"formatter": "email"},
+    "init": {"formatter": "clear"}
+  }
+} 
+```
+Available formatters:
+```
+**name** - generates a name
+**phoneNumber** - generates a phone number
+**username** - generates a random user name
+**password** - generates a random password
+**email** - generates a random email address
+**date** - generates a date
+**longText** - generates a sentence
+**number** - generates a number
+**randomText** - generates a sentence
+**text** - generates a paragraph
+**uri** - generates a URI
+**clear** - generates an empty string
+```
+You can also add extra elements and attributes, like `_cookies`, `_description` or `_purpose` to enrich the Personal Data information. Just make sure it's marked or prefixed so that it does not mess up GDPR dump when it looks for table data replacements.

chart/values.yaml

@@ -18,13 +18,18 @@ drupal:
         then
           drush cron;
         fi;'
-    - schedule: '0 3 * * *'
+    - schedule: '*/5 * * * *'
       command: 'bootstrapped=$(drush status --field=bootstrap);
         if [[ $bootstrapped = "Successful" ]] && [[ "$BRANCHNAME" = "$PRODUCTION_BRANCHNAME" ]];
         then
-          export PATH=../vendor/bin:$PATH;
-          rm /var/backups/db/${BRANCHNAME//[^[:alnum:]]/-}-latest.sql;
-          drush sql-dump --extra-dump="--gdpr-replacements-file=../gdpr.json" --result-file /var/backups/db/${BRANCHNAME//[^[:alnum:]]/-}-latest.sql;
+          DUMP_PATH=/var/backups/db/${BRANCHNAME//[^[:alnum:]]/-}-latest.sql;
+          rm $DUMP_PATH;
+          if [ -f ../gdpr.json ]; then
+            export PATH=../vendor/bin:$PATH;
+            drush sql-dump --extra-dump="--gdpr-replacements-file=../gdpr.json" --result-file $DUMP_PATH;
+          else
+            drush sql-dump --result-file $DUMP_PATH;
+          fi
         fi;'
 
   # will be generated random hashsalt if not provided here
@@ -88,4 +93,4 @@ clusterDomain: "silta.wdr.io"
 imagePullSecrets: []
 
 branchname: "default"
-production_branchname: "master"
+production_branchname: "feature/SLT-17-gdpr-dump"