Merge remote-tracking branch 'origin/master' into edge

Author: jonasbardino

mig/install/MiGserver-template.conf

@@ -784,5 +784,5 @@ logo_right = /images/skin/__SKIN__/logo-right.png
 #credits_text = 2003-2023, <a href="https://www.migrid.org">The MiG Project</a>
 #credits_image = /images/copyright.png
 # Optional data safety notice and popup on Files page
-#datasafety_link = 
-#datasafety_text =
+datasafety_link = __DATASAFETY_LINK__
+datasafety_text = __DATASAFETY_TEXT__

mig/install/generateconfs.py

@@ -205,7 +205,9 @@ def usage(options):
         'quota_backend',
         'ca_fqdn',
         'ca_user',
-        'ca_smtp'
+        'ca_smtp',
+        'datasafety_link',
+        'datasafety_text',
     ]
     int_names = [
         'cert_valid_days',

mig/shared/install.py

@@ -498,6 +498,8 @@ def generate_confs(
     ca_fqdn='',
     ca_user='mig-ca',
     ca_smtp='localhost',
+    datasafety_link='',
+    datasafety_text='',
     _getpwnam=pwd.getpwnam,
     _prepare=None,
     _writefiles=None,
@@ -810,6 +812,8 @@ def _generate_confs_prepare(
     ca_fqdn,
     ca_user,
     ca_smtp,
+    datasafety_link,
+    datasafety_text,
 ):
     """Prepate conf generator run"""
     user_dict = {}
@@ -1056,6 +1060,8 @@ def _generate_confs_prepare(
     user_dict['__CA_FQDN__'] = ca_fqdn
     user_dict['__CA_USER__'] = ca_user
     user_dict['__CA_SMTP__'] = ca_smtp
+    user_dict['__DATASAFETY_LINK__'] = datasafety_link
+    user_dict['__DATASAFETY_TEXT__'] = datasafety_text
 
     user_dict['__MIG_USER__'] = "%s" % (options['user_uname'])
     user_dict['__MIG_GROUP__'] = "%s" % (options['user_group'])

tests/fixture/confs-stdlocal/MiGserver.conf

@@ -784,5 +784,5 @@ logo_right = /images/skin/migrid-basic/logo-right.png
 #credits_text = 2003-2023, <a href="https://www.migrid.org">The MiG Project</a>
 #credits_image = /images/copyright.png
 # Optional data safety notice and popup on Files page
-#datasafety_link = 
-#datasafety_text =
+datasafety_link = 
+datasafety_text = 

tests/support.py

@@ -273,6 +273,12 @@ def fixturepath(relative_path):
     return tmp_path
 
 
+def outputpath(relative_path):
+    assert not os.path.isabs(relative_path)
+    tmp_path = os.path.join(TEST_OUTPUT_DIR, relative_path)
+    return tmp_path
+
+
 def temppath(relative_path, test_case, skip_clean=False):
     assert isinstance(test_case, MigTestCase)
     tmp_path = os.path.join(TEST_OUTPUT_DIR, relative_path)

tests/test_mig_shared_install.py

@@ -27,16 +27,19 @@
 
 """Unit tests for the migrid module pointed to in the filename"""
 
+from past.builtins import basestring
 import binascii
+from configparser import ConfigParser, NoSectionError, NoOptionError
 import difflib
+import io
 import os
 import pwd
 import sys
 
 sys.path.append(os.path.realpath(os.path.join(os.path.dirname(__file__), "..")))
 
 from support import MIG_BASE, TEST_OUTPUT_DIR, MigTestCase, \
-    testmain, temppath, cleanpath, fixturepath, is_path_within
+    testmain, temppath, cleanpath, fixturepath, is_path_within, outputpath
 
 from mig.shared.defaults import keyword_auto
 from mig.shared.install import determine_timezone, generate_confs
@@ -113,6 +116,21 @@ class MigSharedInstall__generate_confs(MigTestCase):
     def before_each(self):
         self.output_path = TEST_OUTPUT_DIR
 
+    def assertConfigKey(self, generated, section, key, expected):
+        if isinstance(generated, basestring):
+            with io.open(generated) as config_file:
+                generated = ConfigParser()
+                generated.read_file(config_file)
+
+        try:
+            actual = generated.get(section, key)
+        except NoSectionError:
+            raise AssertionError("no such section: %s" % (section,))
+        except NoOptionError:
+            raise AssertionError("on such option: %s in %s" % (key, section))
+
+        self.assertEqual(actual, expected)
+
     def test_creates_output_directory_and_adds_active_symlink(self):
         symlink_path = temppath('confs', self)
         cleanpath('confs-foobar', self)
@@ -190,6 +208,29 @@ def capture_defaulted(*args, **kwargs):
         self.assertPathWithin(defaulted['mig_certs'], MIG_BASE)
         self.assertPathWithin(defaulted['mig_state'], MIG_BASE)
 
+    def test_creates_output_files_with_datasafety(self):
+        fixture_dir = fixturepath("confs-stdlocal")
+        expected_generated_dir = cleanpath('confs-stdlocal', self)
+        symlink_path = temppath('confs', self)
+
+        generate_confs(
+            self.output_path,
+            destination=symlink_path,
+            destination_suffix='-stdlocal',
+            datasafety_link='TEST_DATASAFETY_LINK',
+            datasafety_text='TEST_DATASAFETY_TEXT',
+            _getpwnam=create_dummy_gpwnam(4321, 1234),
+        )
+
+        relative_file = 'confs-stdlocal/MiGserver.conf'
+        self.assertPathExists('confs-stdlocal/MiGserver.conf')
+
+        actual_file = outputpath(relative_file)
+        self.assertConfigKey(
+            actual_file, 'SITE', 'datasafety_link', expected='TEST_DATASAFETY_LINK')
+        self.assertConfigKey(
+            actual_file, 'SITE', 'datasafety_text', expected='TEST_DATASAFETY_TEXT')
+
     def test_options_for_source_auto(self):
         options = generate_confs(
             '/some/arbitrary/path',