software/erp5: add control for PYTHONHASHSEED

See https://docs.python.org/3/using/cmdline.html#envvar-PYTHONHASHSEED

Setting a value will set the environment variable for all zope processes
and for the test runner.

Default behavior is:
  - for zope: do not set the variable, so default python behavior will
  be used ( equivalent to setting `0` on python2 and `random` on python3)
  - for test runner: generate a random value for each execution and
  print it, to make it easy to re-run a failing test with the same seed.

This means that ERP5 tests will likely reveal problems where code
depends on python2 behavior of deterministic hashing. To keep previous
behavior (and hide these problems), it's possible to set
python-hash-seed to 0 in test suite parameters.

software/erp5/instance-erp5-input-schema.json

@@ -107,6 +107,18 @@
       "description": "Set open file descriptors soft limit to hard limit",
       "type": "boolean"
     },
+    "python-hash-seed": {
+      "description": "Sets the value of `PYTHONHASHSEED` environment variable for zope processes and test runner. If not provided, zope processes use python default (`0` for python2, `random` for python3) and test runner choose a different `PYTHONHASHSEED` for each execution.",
+      "oneOf": [
+        {
+          "type": "number"
+        },
+        {
+          "const": "random",
+          "type": "string"
+        }
+      ]
+    },
     "family-override": {
       "description": "Family-wide options, possibly overriding global options",
       "default": {},

software/slapos-master/buildout.hash.cfg

@@ -14,7 +14,7 @@
 # not need these here).
 [template-erp5]
 filename = instance-erp5.cfg.in
-md5sum = 15744bc9aa87585a64cb0050263e3142
+md5sum = 5ef8d0afa5cd1f0ad6ee80b1a77f49bc
 
 [template-balancer]
 filename = instance-balancer.cfg.in

software/slapos-master/instance-erp5.cfg.in

@@ -253,6 +253,7 @@ config-memcached-url = ${request-memcached-volatile:connection-url}
 config-monitor-passwd = ${monitor-htpasswd:passwd}
 config-mysql-test-url-list = ${request-mariadb:connection-test-database-list}
 config-mysql-url-list = ${request-mariadb:connection-database-list}
+config-python-hash-seed = {{ dumps(slapparameter_dict.get('python-hash-seed', '')) }}
 config-site-id = {{ dumps(site_id) }}
 config-smtp-url = ${request-smtp:connection-url}
 config-timezone = {{ dumps(slapparameter_dict.get('timezone', 'UTC')) }}

stack/erp5/buildout.cfg

@@ -273,6 +273,7 @@ link-binary =
   ${sed:location}/bin/sed
   ${tesseract:location}/bin/tesseract
   ${w3m:location}/bin/w3m
+  ${coreutils:location}/bin/shuf
 fonts =
   ${liberation-fonts:location}
   ${ipaex-fonts:location}

stack/erp5/buildout.hash.cfg

@@ -74,7 +74,7 @@ md5sum = ca0cb83950dd9079cc289891cce08e76
 
 [template-erp5]
 filename = instance-erp5.cfg.in
-md5sum = 7318eb93f1abf4c07a54b89e4a710fa6
+md5sum = 6f57c834eb3f774d265c3fd6661429d8
 
 [template-zeo]
 filename = instance-zeo.cfg.in
@@ -86,7 +86,7 @@ md5sum = 0ac4b74436f554cd677f19275d18d880
 
 [template-zope]
 filename = instance-zope.cfg.in
-md5sum = 6178ba7b42848f9e2412ab898a7b026c
+md5sum = c6ad5d79f8524cacb7f29ceb97e49312
 
 [template-balancer]
 filename = instance-balancer.cfg.in

stack/erp5/instance-erp5.cfg.in

@@ -247,6 +247,7 @@ config-memcached-url = ${request-memcached-volatile:connection-url}
 config-monitor-passwd = ${monitor-htpasswd:passwd}
 config-mysql-test-url-list = ${request-mariadb:connection-test-database-list}
 config-mysql-url-list = ${request-mariadb:connection-database-list}
+config-python-hash-seed = {{ dumps(slapparameter_dict.get('python-hash-seed', '')) }}
 config-site-id = {{ dumps(site_id) }}
 config-smtp-url = ${request-smtp:connection-url}
 config-timezone = {{ dumps(slapparameter_dict.get('timezone', 'UTC')) }}

stack/erp5/instance-zope.cfg.in

@@ -85,6 +85,9 @@ environment +=
   JUPYTER_PATH=${directory:jupyter-dir}
   JUPYTER_CONFIG_DIR=${directory:jupyter-config-dir}
   JUPYTER_RUNTIME_DIR=${directory:jupyter-runtime-dir}
+{% if slapparameter_dict.get('python-hash-seed') %}
+  PYTHONHASHSEED={{ slapparameter_dict['python-hash-seed'] }}
+{% endif %}
 {% if slapparameter_dict.get('wendelin-core-zblk-fmt') %}
   WENDELIN_CORE_ZBLK_FMT={{ slapparameter_dict['wendelin-core-zblk-fmt'] }}
 {% endif %}
@@ -469,9 +472,24 @@ context =
 {% else -%}
 [{{ section('run-unit-test-userhosts-wrapper') }}]
 <= userhosts-wrapper-base
-wrapped-command-line = ${runUnitTest:wrapper-path}
+wrapped-command-line = ${run-unit-test-python-hash-seed-wrapper:output}
 wrapper-path = ${buildout:bin-directory}/runUnitTest
 
+[{{ section('run-unit-test-python-hash-seed-wrapper') }}]
+recipe = slapos.recipe.template
+inline =
+  #!/bin/sh
+  PYTHONHASHSEED={{ slapparameter_dict['python-hash-seed'] }}
+  if [ -z "$PYTHONHASHSEED" ]; then
+    PYTHONHASHSEED=$(${buildout:bin-directory}/shuf -i 1-1024 -n 1)
+    echo "Generated PYTHONHASHSEED: $PYTHONHASHSEED"
+  else
+    echo "Using PYTHONHASHSEED: $PYTHONHASHSEED"
+  fi
+  export PYTHONHASHSEED
+  exec ${runUnitTest:wrapper-path} "$@"
+output = ${buildout:bin-directory}/runUnitTest.python-hash-seed
+
 [{{ section('run-test-suite-userhosts-wrapper') }}]
 <= userhosts-wrapper-base
 wrapped-command-line = ${runTestSuite:wrapper-path}