Revert changes for custom exclude patterns and only leave default ones

Author: Crivella

easybuild/tools/testing.py

@@ -59,7 +59,6 @@
 
 _log = fancylogger.getLogger('testing', fname=False)
 
-_exclude_env_from_report = []
 DEFAULT_EXCLUDE_FROM_TEST_REPORT_ENV_VAR_NAMES = [
     'KEY',
     'SECRET',
@@ -81,7 +80,8 @@
     r'xox[baprs]-[A-Za-z0-9-]+',  # Slack token
 
     # https://github.com/odomojuli/regextokens
-    r'^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$',  # Base64
+    # This is too aggressive and can end up excluding any alphanumeric string with length multiple of 4
+    # r'^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$',  # Base64
     r'[1-9][0-9]+-[0-9a-zA-Z]{40}',  # Twitter token
     r'EAACEdEose0cBA[0-9A-Za-z]+',  # Facebook token
     r'[0-9a-fA-F]{7}.[0-9a-fA-F]{32}',  # Instagram token
@@ -183,21 +183,6 @@ def session_state():
     }
 
 
-def exclude_env_from_report_add(key):
-    """
-    Exclude key from test report if an environment variables contains key.
-    :param key: environment variable to exclude
-    """
-    _exclude_env_from_report.append(key.upper())
-
-
-def exclude_env_from_report_clear():
-    """
-    Clear list of environment variables to exclude from test report.
-    """
-    _exclude_env_from_report.clear()
-
-
 def create_test_report(msg, ecs_with_res, init_session_state, pr_nrs=None, gist_log=False, easyblock_pr_nrs=None,
                        ec_parse_error=None):
     """
@@ -323,7 +308,7 @@ def create_test_report(msg, ecs_with_res, init_session_state, pr_nrs=None, gist_
     for key in sorted(environ_dump.keys()):
         if env_filter is not None and env_filter.search(key):
             continue
-        if any(x in key.upper() for x in DEFAULT_EXCLUDE_FROM_TEST_REPORT_ENV_VAR_NAMES + _exclude_env_from_report):
+        if any(x in key.upper() for x in DEFAULT_EXCLUDE_FROM_TEST_REPORT_ENV_VAR_NAMES):
             continue
         value = environ_dump[key]
         if any(re.match(rgx, value) for rgx in DEFAULT_EXCLUDE_FROM_TEST_REPORT_VALUE_REGEX):

test/framework/github.py

@@ -55,7 +55,6 @@
 from easybuild.tools.github import det_pr_title, fetch_easyconfigs_from_commit, fetch_files_from_commit
 from easybuild.tools.github import is_patch_for, pick_default_branch
 from easybuild.tools.testing import create_test_report, post_pr_test_report, session_state
-from easybuild.tools.testing import exclude_env_from_report_add, exclude_env_from_report_clear
 import easybuild.tools.github as gh
 
 try:
@@ -1320,15 +1319,11 @@ def test_github_create_test_report(self):
         ]
         environ = {
             'USER': 'test',
-            'DONT_REMOVE_ME': 'test-123',
         }
         JWT_HDR = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'
         JWT_PLD = 'eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNzA4MzQ1MTIzLCJleHAiOjE3MDgzNTUxMjN9'
         JWT_SIG = 'SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
         secret_environ = {
-            'REMOVEME': 'test-abc',
-            'ReMoVeMe2': 'TeSt-xyz',
-
             # Test default removal based on variable value
             'TOTALLYPUBLICVAR1': 'AKIAIOSFODNN7EXAMPLE',  # AWS_ACCESS_KEY
             'TOTALLYPUBLICVAR2': 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',  # AWS_SECRET_KEY
@@ -1355,27 +1350,19 @@ def test_github_create_test_report(self):
             'time': gmtime(0),
         }
 
-        # Test exclude_env_from_report_add/clear
-        exclude_env_from_report_add('REMOVEME'.lower())  # Also check that the name is uppercased in the check
-
         res = create_test_report("just a test", ecs_with_res, init_session_state)
         patterns = [
             "**SUCCESS** _test.eb_",
             "**FAIL (build issue)** _fail.eb_",
             "01 Jan 1970 00:00:00",
             "EASYBUILD_DEBUG=1",
-            "DONT_REMOVE_ME = test-123",
+            "USER = test",
         ]
         for pattern in patterns:
             self.assertIn(pattern, res['full'])
 
-        # Test that excluded patterns works by matching also partial strings
-        exclude_patterns1 = [
-            'REMOVEME',
-            'ReMoVeMe2',
-        ]
         # Test that known token regexes for ENV vars are excluded by default
-        exclude_patterns2 = [
+        exclude_patterns = [
             'TOTALLYPUBLICVAR1',
             'TOTALLYPUBLICVAR2',
             'TOTALLYPUBLICVAR3',
@@ -1392,21 +1379,18 @@ def test_github_create_test_report(self):
             'SECRET_SECRET',
             'INFO_CREDENTIALS',
         ]
-        for pattern in exclude_patterns1 + exclude_patterns2:
+        for pattern in exclude_patterns:
             # .lower() test that variable name is not case sensitive for excluding
             self.assertNotIn(pattern.lower(), res['full'])
 
-        exclude_env_from_report_clear()
-        patterns += exclude_patterns1
-
         res = create_test_report("just a test", ecs_with_res, init_session_state)
         for pattern in patterns:
             self.assertIn(pattern, res['full'])
 
         for pattern in patterns[:2]:
             self.assertIn(pattern, res['overview'])
 
-        for pattern in exclude_patterns2:
+        for pattern in exclude_patterns:
             # .lower() test that variable name is not case sensitive for excluding
             self.assertNotIn(pattern.lower(), res['full'])