Amend check rules python for Fetch Test (EFForg#18865)

zoracon · web-flow · commit 1dcbae798a1e · 2020-02-20T14:54:07.000-08:00
* Amend Rule Checker

- More granular detail like time and if whole ruleset was disabled
- Amend the config to check for TLS 1.2 or above
* Amend message for disabling rulesets in both cases
* Change variable name to be more consistent
* Adjust timestamp
diff --git a/test/rules/disable-broken-rulesets.checker.config b/test/rules/disable-broken-rulesets.checker.config
@@ -18,6 +18,7 @@ read_timeout = 30
 redirect_depth = 10
 threads = 20
 fetch_in_subprocess = false
+ssl_version = TLSv1_2
 
 [log]
 logfile = -
diff --git a/test/rules/src/https_everywhere_checker/check_rules.py b/test/rules/src/https_everywhere_checker/check_rules.py
@@ -23,7 +23,9 @@
 import urllib.parse
 from rules import Ruleset
 from rule_trie import RuleTrie
+from datetime import datetime
 
+timestamp = datetime.now().replace(microsecond=0)
 
 def convertLoglevel(levelString):
     """Converts string 'debug', 'info', etc. into corresponding
@@ -143,7 +145,7 @@ def fetchUrl(self, plainUrl, transformedUrl, fetcherPlain, fetcherRewriting, rul
         except Exception as e:
             errno, message = e.args
             if errno == 6:
-                message = "Fetch error: {} => {}: {}".format(
+                message = "Time: {}\n Fetch error: {} => {}: {}".format(timestamp,
                     plainUrl, transformedUrl, e)
                 self.queue_result("error", "fetch-error {}".format(e),
                                   ruleFname, plainUrl, https_url=transformedUrl)
@@ -226,11 +228,13 @@ def disableRuleset(ruleset, problemRules, urlCount):
     # Go ahead and disable rulset if all targets are problematic
     if urlCount == len(problemRules):
         logging.info("Disabling ruleset {}".format(ruleset.filename))
+        disableMessage = "Entire ruleset disabled at {}\n".format(timestamp)
         contents = re.sub("(<ruleset [^>]*)>",
             "\\1 default_off=\"failed ruleset test\">", contents);
     # If not all targets, just the target
     else:
         for rule in rules:
+            disableMessage = "The following targets have been disabled at {}:\n".format(timestamp)
             host = urllib.parse.urlparse(rule)
             logging.info("Disabling target {}".format(host.netloc))
             contents = re.sub('<[ \n]*target[ \n]+host[ \n]*=[ \n]*"{}"[ \n]*\/?[ \n]*>'.format(host.netloc),
@@ -245,9 +249,9 @@ def disableRuleset(ruleset, problemRules, urlCount):
         contents = "<!--\n-->\n" + contents
     problemStatement = ("""
 <!--
-Disabled by https-everywhere-checker because:
 {}
-""".format("\n".join(problems)))
+{}
+""".format(disableMessage, "\n".join(problems)))
     contents = re.sub("^<!--", problemStatement, contents)
     with open(ruleset.filename, "w") as f:
         f.write(contents)
