ERP5: Fix regression when testrunner is not enabled

The case where test runner is not enabled got broken in
2a457867

This time, we had test to prevent regression.

/reviewed-on nexedi/slapos!440

software/erp5/test/README.md

+Tests for ERP5 software release

software/erp5/test/setup.py

+##############################################################################
+#
+# Copyright (c) 2018 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# guarantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 3
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+from setuptools import setup, find_packages
+
+version = '0.0.1.dev0'
+name = 'slapos.test.erp5'
+long_description = open("README.md").read()
+
+setup(name=name,
+      version=version,
+      description="Test for SlapOS' ERP5 software releae",
+      long_description=long_description,
+      long_description_content_type='text/markdown',
+      maintainer="Nexedi",
+      maintainer_email="info@nexedi.com",
+      url="https://lab.nexedi.com/nexedi/slapos",
+      packages=find_packages(),
+      install_requires=[
+        'slapos.core',
+        'supervisor',
+        'slapos.libnetworkcache',
+        'erp5.util',
+        'psutil',
+        'requests',
+        ],
+      zip_safe=True,
+      test_suite='test',
+    )

software/erp5/test/test/__init__.py

+##############################################################################
+#
+# Copyright (c) 2018 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# guarantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 3
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+import os
+import unittest
+import logging
+
+if os.environ.get('DEBUG'):
+  raise ValueError("Don't set DEBUG - it breaks postfix compilation - set SLAPOS_TEST_DEBUG instead.")
+
+debug_mode = os.environ.get('SLAPOS_TEST_DEBUG')
+# for development: debugging logs and install Ctrl+C handler
+if debug_mode:
+  logging.basicConfig(level=logging.DEBUG)
+  unittest.installHandler()

software/erp5/test/test/test_erp5.py

+##############################################################################
+#
+# Copyright (c) 2018 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# guarantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 3
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+import os
+import json
+import glob
+import urlparse
+import logging
+import time
+
+import requests
+
+from utils import SlapOSInstanceTestCase
+
+
+class ERP5TestCase(SlapOSInstanceTestCase):
+  """Test the remote driver on a minimal web server.
+  """
+  logger = logging.getLogger(__name__)
+  @classmethod
+  def getSoftwareURLList(cls):
+    return (os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', 'software.cfg')), )
+
+  def getRootPartitionConnectionParameterDict(self):
+    """Return the output paramters from the root partition"""
+    return json.loads(
+        self.computer_partition.getConnectionParameterDict()['_'])
+
+
+class TestPublishedURLIsReachableMixin(object):
+  """Mixin that checks that default page of ERP5 is reachable.
+  """
+  def _checkERP5IsReachable(self, url):
+    # What happens is that instanciation just create the services, but does not
+    # wait for ERP5 to be initialized. When this test run ERP5 instance is
+    # instanciated, but zope is still busy creating the site and haproxy replies
+    # with 503 Service Unavailable.
+    # If we can move the "create site" in slapos node instance, then this retry loop
+    # would not be necessary.
+    for i in range(1, 20):
+      r = requests.get(url, verify=False) # XXX can we get CA from caucase already ?
+      if r.status_code == requests.codes.service_unavailable:
+        delay = i * 2
+        self.logger.warn("ERP5 was not available, sleeping for %ds and retrying", delay)
+        time.sleep(delay)
+        continue
+      if r.status_code != requests.codes.ok:
+        r.raise_for_status()
+      break
+
+    self.assertIn("ERP5", r.text)
+
+  def test_published_family_default_v6_is_reachable(self):
+    """Tests the IPv6 URL published by the root partition is reachable.
+    """
+    param_dict = self.getRootPartitionConnectionParameterDict()
+    self._checkERP5IsReachable(
+      urlparse.urljoin(param_dict['family-default-v6'], param_dict['site-id']))
+
+  def test_published_family_default_v4_is_reachable(self):
+    """Tests the IPv4 URL published by the root partition is reachable.
+    """
+    param_dict = self.getRootPartitionConnectionParameterDict()
+    self._checkERP5IsReachable(
+      urlparse.urljoin(param_dict['family-default'], param_dict['site-id']))
+
+
+class TestDefaultParameters(ERP5TestCase, TestPublishedURLIsReachableMixin):
+  """Test ERP5 can be instanciated with no parameters
+  """
+  __partition_reference__ = 'defp'
+
+
+class TestDisableTestRunner(ERP5TestCase, TestPublishedURLIsReachableMixin):
+  """Test ERP5 can be instanciated without test runner.
+  """
+  __partition_reference__ = 'distr'
+  @classmethod
+  def getInstanceParameterDict(cls):
+    return {'_': json.dumps({'test-runner': {'enabled': False}})}
+
+  def test_no_runUnitTestScript(self):
+    """No runUnitTest script should be generated in any partition.
+    """
+    # self.computer_partition_root_path is the path of root partition.
+    # we want to assert that no scripts exist in any partition.
+    bin_programs = [os.path.basename(path) for path in
+      glob.glob("{}/../*/bin/*".format(self.computer_partition_root_path))]
+
+    self.assertTrue(bin_programs) # just to check the glob was correct.
+    self.assertNotIn('runUnitTest', bin_programs)
+    self.assertNotIn('runTestSuite', bin_programs)

software/erp5testnode/testsuite/erp5/README.md

+# ERP5 test
+
+This software release is simply to run the test suite from `../erp5/test/setup.py`
+
+Nexedi staff can see the results of this test from the test suite
+`SLAPOS-ERP5-TEST` in test result module.
+

software/erp5testnode/testsuite/erp5/buildout.hash.cfg

+# THIS IS NOT A BUILDOUT FILE, despite purposedly using a compatible syntax.
+# The only allowed lines here are (regexes):
+# - "^#" comments, copied verbatim
+# - "^[" section beginings, copied verbatim
+# - lines containing an "=" sign which must fit in the following categorie.
+#   - "^\s*filename\s*=\s*path\s*$" where "path" is relative to this file
+#     Copied verbatim.
+#   - "^\s*hashtype\s*=.*" where "hashtype" is one of the values supported
+#     by the re-generation script.
+#     Re-generated.
+# - other lines are copied verbatim
+# Substitution (${...:...}), extension ([buildout] extends = ...) and
+# section inheritance (< = ...) are NOT supported (but you should really
+# not need these here).
+
+[template]
+filename = instance.cfg.in
+md5sum = 6d126917e17c00ee012c4cf0a52429d1
+

software/erp5testnode/testsuite/erp5/instance.cfg.in

+[buildout]
+parts =
+  slapos-test-runner
+
+eggs-directory = ${buildout:eggs-directory}
+develop-eggs-directory = ${buildout:develop-eggs-directory}
+offline = true
+
+[slap-configuration]
+recipe = slapos.cookbook:slapconfiguration
+computer = $${slap-connection:computer-id}
+partition = $${slap-connection:partition-id}
+url = $${slap-connection:server-url}
+key = $${slap-connection:key-file}
+cert = $${slap-connection:cert-file}
+
+[download-source]
+recipe = slapos.recipe.build:gitclone
+git-executable = ${git:location}/bin/git
+
+[slapos]
+<= download-source
+repository = ${slapos-repository:location}
+
+[create-directory]
+recipe = slapos.cookbook:mkdirectory
+bin = $${buildout:directory}/bin
+working-dir = $${buildout:directory}/tmp/
+
+[slapos-test-runner]
+recipe = slapos.cookbook:wrapper
+wrapper-path = $${create-directory:bin}/runTestSuite
+command-line =
+  ${buildout:bin-directory}/runTestSuite
+  --python_interpreter=${buildout:bin-directory}/${eggs:interpreter}
+  --source_code_path_list=$${slapos:location}/software/erp5/test
+
+
+# XXX we need "standard" path entries to compile softwares inside test
+# XXX can't we just inherit $PATH ?
+environment =
+  PATH=${buildout:bin-directory}:/bin/:/usr/bin/
+  LOCAL_IPV4=$${slap-configuration:ipv4-random}
+  GLOBAL_IPV6=$${slap-configuration:ipv6-random}
+  SLAPOS_TEST_WORKING_DIR=$${create-directory:working-dir}

software/erp5testnode/testsuite/erp5/software.cfg

+[buildout]
+
+extends =
+  ../../../../component/git/buildout.cfg
+  ../../../../stack/slapos.cfg
+  ./buildout.hash.cfg
+
+parts =
+  slapos-cookbook
+  eggs
+  template
+
+[setup-develop-egg]
+recipe = zc.recipe.egg:develop
+
+[slapos.test.erp5-setup]
+<= setup-develop-egg
+egg = slapos.test.erp5
+setup = ${slapos-repository:location}/software/erp5/test/
+
+[eggs]
+recipe = zc.recipe.egg
+eggs =
+  ${slapos.test.erp5-setup:egg}
+  slapos.core
+entry-points =
+  runTestSuite=erp5.util.testsuite:runTestSuite
+scripts =
+  runTestSuite
+  slapos
+interpreter=
+  python_for_test
+
+[git-clone-repository]
+recipe = slapos.recipe.build:gitclone
+git-executable = ${git:location}/bin/git
+forbid-download-cache = true
+branch = master
+
+[slapos-repository]
+<= git-clone-repository
+repository = https://lab.nexedi.com/nexedi/slapos.git
+
+[template]
+recipe = slapos.recipe.template
+url = ${:_profile_base_location_}/${:filename}
+output = ${buildout:directory}/template.cfg
+mode = 640
+
+[versions]
+erp5.util = 0.4.56
+slapos.recipe.template = 4.3
+

stack/erp5/buildout.hash.cfg

@@ -74,7 +74,7 @@ md5sum = d41d8cd98f00b204e9800998ecf8427e
 
 [template-erp5]
 filename = instance-erp5.cfg.in
-md5sum = 83e69244728a0d323f535dd3e8b734b6
+md5sum = f723acac5c081c7f9e5eff268d05cc54
 
 [template-zeo]
 filename = instance-zeo.cfg.in
@@ -86,7 +86,7 @@ md5sum = 9ddbba307b4df8ca316de940ba3b44f6
 
 [template-balancer]
 filename = instance-balancer.cfg.in
-md5sum = 461b39677d47b3410a4ca0e396110b96
+md5sum = 213e9b4ad6350a18a276200b03e50d0c
 
 [template-haproxy-cfg]
 filename = haproxy.cfg.in

stack/erp5/instance-balancer.cfg.in

@@ -130,7 +130,7 @@ ipv6 = {{ zope_address.split(']:')[0][1:] }}
 {%       set test_runner_apache_url_list = [] %}
 {%       set test_runner_external_port = next_port() %}
 {%       for i, (test_runner_internal_ip, test_runner_internal_port) in
-             enumerate(slapparameter_dict[parameter_id ~ '-test-runner-address-list']) %}
+             enumerate(slapparameter_dict.get(parameter_id ~ '-test-runner-address-list', [])) %}
 {%         do test_runner_backend_mapping.__setitem__(
                 'unit_test_' ~ i,
                 'http://' ~ test_runner_internal_ip ~ ':' ~ test_runner_internal_port ) %}

stack/erp5/instance-erp5.cfg.in

@@ -194,7 +194,9 @@ config-longrequest-logger-timeout = {{ dumps(zope_parameter_dict.get('longreques
 config-large-file-threshold = {{ dumps(zope_parameter_dict.get('large-file-threshold', "10MB")) }}
 config-port-base = {{ dumps(zope_parameter_dict.get('port-base', 2200)) }}
 config-webdav = {{ dumps(zope_parameter_dict.get('webdav', False)) }}
+{%   if test_runner_enabled -%}
 config-test-runner-apache-url-list = ${publish-early:{{ zope_family }}-test-runner-url-list}
+{%   endif -%}
 {% endfor -%}
 
 {# if not explicitly configured, connect jupyter to first zope family, which  -#}
@@ -322,9 +324,11 @@ hosts-dict = {{ '${' ~ zope_address_list_id_dict.keys()[0] ~ ':connection-hosts-
 {% for name, value in publish_dict.items() -%}
 {{   name }} = {{ value }}
 {% endfor -%}
+{% if test_runner_enabled -%}
 {%   for zope_family_name in zope_family_name_list -%}
 {{ zope_family_name }}-test-runner-url-list = ${request-balancer:connection-{{ zope_family_name }}-test-runner-url-list}
 {%   endfor -%}
+{% endif -%}
 
 
 [publish-early]
@@ -335,9 +339,11 @@ recipe = slapos.cookbook:publish-early
 {%- if has_posftix %}
   smtpd-sasl-password gen-smtpd-sasl-password:passwd
 {%- endif %}
+{% if test_runner_enabled -%}
 {%   for zope_family_name in zope_family_name_list %}
   {{ zope_family_name }}-test-runner-url-list default-balancer-test-runner-url-list:default
 {%   endfor -%}
+{% endif -%}
 {%- if neo %}
   neo-cluster gen-neo-cluster:name
 {%-  if neo[0] %}