Mercurial Repository: p/roundup/code: test/test

comparison test/test_config.py @ 6638:e1588ae185dc issue2550923_computed_property

merge from default branch. Fix travis.ci so CI builds don't error out

author	John Rouillard <rouilj@ieee.org>
date	Thu, 21 Apr 2022 16:54:17 -0400
parents	0d99ae7c8de6
children	ab2ed11c021e

comparison

equal deleted inserted replaced

-:85db90cc1705
+:e1588ae185dc
 import unittest
 import logging
 import fileinput
-import os, shutil, errno
+import os, shutil, errno, sys
 import pytest
 from roundup import configuration
 try:
 #   https://github.com/pytest-dev/pytest/issues/568
 from .pytest_patcher import mark_class
 skip_xapian = mark_class(pytest.mark.skip(
 "Skipping Xapian indexer tests: 'xapian' not installed"))
 include_no_xapian = lambda func, *args, **kwargs: func
+_py3 = sys.version_info[0] > 2
+if _py3:
+skip_py2 = lambda func, *args, **kwargs: func
+else:
+# FIX: workaround for a bug in pytest.mark.skip():
+#   https://github.com/pytest-dev/pytest/issues/568
+from .pytest_patcher import mark_class
+skip_py2 = mark_class(pytest.mark.skip(
+reason='Skipping test under python2.'))
 config = configuration.CoreConfig()
 config.DATABASE = "db"
 config.RDBMS_NAME = "rounduptest"
 config.RDBMS_HOST = "localhost"
 try:
 shutil.rmtree(self.dirname)
 except OSError as error:
 if error.errno not in (errno.ENOENT, errno.ESRCH): raise
-def munge_configini(self, mods = None):
+def munge_configini(self, mods = None, section=None):
 """ modify config.ini to meet testing requirements
 mods is a list of tuples:
-[ ( "a = ", "b" ), ("c = ", None) ]
+[ ( "a = ", "b" ), ("c = ", None), ("d = ", "b", "z = ") ]
 Match line with first tuple element e.g. "a = ". Note specify
 trailing "=" and space to delimit keyword and properly format
-replacement line. If first tuple element matches, the line is
+replacement line. If there are two elements in the tuple,
+and the first element matches, the line is
 replaced with the concatenation of the first and second elements.
 If second element is None ("" doesn't work), the line will be
-deleted.
+deleted. If there are three elements in the tuple, the line
+is replaced with the contcatentation of the third and second
-Note the key/first element of tuple must be unique in config.ini.
+elements (used to replace commented out parameters).
-It is possible to have duplicates in different sections. This
-method doesn't handle that. TBD option third element of tuple
+Note if the key/first element of tuple is not unique in
-defining section if needed.
+config.ini, you must set the section to match the bracketed
+section name.
 """
 if mods is None:
 return
+# if section is defined, the tests in the loop will turn
+# it off on [main] if section != '[main]'.
+in_section = True
 for line in fileinput.input(os.path.join(self.dirname, "config.ini"),
 inplace=True):
-for match, value in mods:
+if section:
-if line.startswith(match):
+if line.startswith('['):
-if value is not None:
+in_section = False
-print(match + value)
-break
+if line.startswith(section):
+in_section = True
+if in_section:
+for rule in mods:
+if len(rule) == 3:
+match, value, repl = rule
+else:
+match, value = rule
+repl = None
+if line.startswith(match):
+if value is not None:
+if repl:
+print(repl + value)
+else:
+print(match + value)
+break
+else:
+print(line[:-1]) # remove trailing \n
 else:
 print(line[:-1]) # remove trailing \n
 def testNoDBInConfig(self):
 """Arguably this should be tested in test_instance since it is
 with self.assertRaises(configuration.OptionUnsetError) as cm:
 instance.open(self.dirname)
 self.assertEqual("RDBMS_BACKEND is not set"
 " and has no default", cm.exception.__str__())
+def testUnsetMailPassword_with_set_username(self):
+""" Set [mail] username but don't set the
+[mail] password. Should get an OptionValueError.
+"""
+# SETUP: set mail username
+self.munge_configini(mods=[ ("username = ", "foo"), ],
+section="[mail]")
+config = configuration.CoreConfig()
+with self.assertRaises(configuration.OptionValueError) as cm:
+config.load(self.dirname)
+print(cm.exception)
+# test repr. The type is right since it passed assertRaises.
+self.assertIn("OptionValueError", repr(cm.exception))
+# look for 'not defined'
+self.assertEqual("not defined", cm.exception.args[1])
+def testUnsetMailPassword_with_unset_username(self):
+""" Set [mail] username but don't set the
+[mail] password. Should get an OptionValueError.
+"""
+config = configuration.CoreConfig()
+config.load(self.dirname)
+self.assertEqual(config['MAIL_USERNAME'], '')
+with self.assertRaises(configuration.OptionUnsetError) as cm:
+self.assertEqual(config['MAIL_PASSWORD'], 'NO DEFAULT')
+def testSecretMandatory_missing_file(self):
+# SETUP:
+self.munge_configini(mods=[ ("secret_key = ", "file://secret_key"), ])
+config = configuration.CoreConfig()
+with self.assertRaises(configuration.OptionValueError) as cm:
+config.load(self.dirname)
+print(cm.exception)
+self.assertEqual(cm.exception.args[0].setting, "secret_key")
+def testSecretMandatory_load_from_file(self):
+# SETUP:
+self.munge_configini(mods=[ ("secret_key = ", "file://secret_key"), ])
+secret = "ASDQWEZXCRFVBGTYHNMJU"
+with open(self.dirname + "/secret_key", "w") as f:
+f.write(secret + "\n")
+config = configuration.CoreConfig()
+config.load(self.dirname)
+self.assertEqual(config['WEB_SECRET_KEY'], secret)
+def testSecretMandatory_load_from_abs_file(self):
+abs_file = "/tmp/secret_key.%s"%os.getpid()
+# SETUP:
+self.munge_configini(mods=[ ("secret_key = ", "file://%s"%abs_file), ])
+secret = "ASDQWEZXCRFVBGTYHNMJU"
+with open(abs_file, "w") as f:
+f.write(secret + "\n")
+config = configuration.CoreConfig()
+config.load(self.dirname)
+self.assertEqual(config['WEB_SECRET_KEY'], secret)
+os.remove(abs_file)
+def testSecretMandatory_empty_file(self):
+self.munge_configini(mods=[ ("secret_key = ", "file:// secret_key"), ])
+# file with no value just newline.
+with open(self.dirname + "/secret_key", "w") as f:
+f.write("\n")
+config = configuration.CoreConfig()
+with self.assertRaises(configuration.OptionValueError) as cm:
+config.load(self.dirname)
+print(cm.exception.args)
+self.assertEqual(cm.exception.args[2],"Value must not be empty.")
+def testNullableSecret_empty_file(self):
+self.munge_configini(mods=[ ("password = ", "file://db_password"), ])
+# file with no value just newline.
+with open(self.dirname + "/db_password", "w") as f:
+f.write("\n")
+config = configuration.CoreConfig()
+config.load(self.dirname)
+v = config['RDBMS_PASSWORD']
+self.assertEqual(v, None)
+def testNullableSecret_with_file_value(self):
+self.munge_configini(mods=[ ("password = ", "file://db_password"), ])
+# file with no value just newline.
+with open(self.dirname + "/db_password", "w") as f:
+f.write("test\n")
+config = configuration.CoreConfig()
+config.load(self.dirname)
+v = config['RDBMS_PASSWORD']
+self.assertEqual(v, "test")
+def testNullableSecret_with_value(self):
+self.munge_configini(mods=[ ("password = ", "test"), ])
+config = configuration.CoreConfig()
+config.load(self.dirname)
+v = config['RDBMS_PASSWORD']
+self.assertEqual(v, "test")
+def testSetMailPassword_with_set_username(self):
+""" Set [mail] username and set the password.
+Should have both values set.
+"""
+# SETUP: set mail username
+self.munge_configini(mods=[ ("username = ", "foo"),
+("#password = ", "passwordfoo",
+"password = ") ],
+section="[mail]")
+config = configuration.CoreConfig()
+config.load(self.dirname)
+self.assertEqual(config['MAIL_USERNAME'], 'foo')
+self.assertEqual(config['MAIL_PASSWORD'], 'passwordfoo')
+def testSetMailPassword_from_file(self):
+""" Set [mail] username and set the password.
+Should have both values set.
+"""
+# SETUP: set mail username
+self.munge_configini(mods=[ ("username = ", "foo"),
+("#password = ", "file://password",
+"password = ") ],
+section="[mail]")
+with open(self.dirname + "/password", "w") as f:
+f.write("passwordfoo\n")
+config = configuration.CoreConfig()
+config.load(self.dirname)
+self.assertEqual(config['MAIL_USERNAME'], 'foo')
+self.assertEqual(config['MAIL_PASSWORD'], 'passwordfoo')
 @skip_xapian
 def testInvalidIndexerLanguage_w_empty(self):
 """ make sure we have a reasonable error message if
 invalid indexer language is specified. This uses
 # don't test exception content. Done in
 # testInvalidIndexerLanguage_w_empty
 # if exception not generated assertRaises
 # will generate failure.
+def testInvalidIndexerLanguage_w_native_fts(self):
+""" Use explicit native-fts indexer. Verify exception is
+generated.
+"""
+self.munge_configini(mods=[ ("indexer = ", "native-fts"),
+("indexer_language = ", "NO_LANG") ])
+with self.assertRaises(configuration.OptionValueError) as cm:
+config.load(self.dirname)
+# test repr. The type is right since it passed assertRaises.
+self.assertIn("OptionValueError", repr(cm.exception))
+# look for failing language
+self.assertIn("NO_LANG", cm.exception.args[1])
+# look for supported language
+self.assertIn("basque", cm.exception.args[2])
 def testLoadConfig(self):
 """ run load to validate config """
 config = configuration.CoreConfig()
 config_copy = config.copy()
 # this should work
 self.assertEqual(config_copy['HTML_VERSION'], 'xhtml')
+@skip_py2
+def testConfigValueInterpolateError(self):
+''' error is not raised using ConfigParser under Python 2.
+Unknown cause, so skip it if running python 2.
+'''
+self.munge_configini(mods=[ ("admin_email = ", "a bare % is invalid") ])
+config = configuration.CoreConfig()
+# load config generates:
+'''
+E           roundup.configuration.ParsingOptionError: Error in _test_instance/config.ini with section [main] at option admin_email: '%' must be followed by '%' or '(', found: '% is invalid'
+'''
+with self.assertRaises(configuration.ParsingOptionError) as cm:
+config.load(self.dirname)
+print(cm.exception)
+self.assertIn("'%' must be followed by '%' or '(', found: '% is invalid'", cm.exception.args[0])
+self.assertIn("_test_instance/config.ini with section [main] at option admin_email", cm.exception.args[0])
+from roundup.admin import AdminTool
+from .test_admin import captured_output
+admin=AdminTool()
+with captured_output() as (out, err):
+sys.argv=['main', '-i', self.dirname, 'get', 'tile', 'issue1']
+ret = admin.main()
+expected_err = "Error in _test_instance/config.ini with section [main] at option admin_email: '%' must be followed by '%' or '(', found: '% is invalid'"
+self.assertEqual(ret, 1)
+out = out.getvalue().strip()
+self.assertEqual(out, expected_err)
 def testInvalidIndexerValue(self):
 """ Mistype native indexer. Verify exception is
 generated.
 """
 # verify that args show up in string representaton
 string_rep = cm.exception.__str__()
 print(string_rep)
 self.assertIn("nati", string_rep)
 self.assertIn("'whoosh'", string_rep)

Mercurial > p > roundup > code

comparison test/test_config.py @ 6638:e1588ae185dc issue2550923_computed_property