Add test url formatting to https_everywhere_checker tests

Hainish · Hainish · commit dfb8898f47ff · 2016-05-12T17:44:35.000-07:00
diff --git a/test/rules/coverage.checker.config b/test/rules/coverage.checker.config
@@ -5,6 +5,7 @@
 rulesdir = src/chrome/content/rules
 check_coverage = true
 check_nonmatch_groups = true
+check_test_formatting = true
 include_default_off = false
 skiplist = utils/ruleset-coverage-whitelist.txt
 
diff --git a/test/rules/http.checker.config b/test/rules/http.checker.config
@@ -4,6 +4,8 @@
 # Directory with XML files describing HTTPS Everywhere rulesets
 rulesdir = src/chrome/content/rules
 check_coverage = false
+check_nonmatch_groups = false
+check_test_formatting = false
 auto_disable = false
 include_default_off = false
 
diff --git a/test/rules/src/https_everywhere_checker/check_rules.py b/test/rules/src/https_everywhere_checker/check_rules.py
@@ -282,9 +282,10 @@ def cli():
 	checkNonmatchGroups = False
 	if config.has_option("rulesets", "check_nonmatch_groups"):
 		checkNonmatchGroups = config.getboolean("rulesets", "check_nonmatch_groups")
+	checkTestFormatting = False
+	if config.has_option("rulesets", "check_test_formatting"):
+		checkTestFormatting = config.getboolean("rulesets", "check_test_formatting")
 	certdir = config.get("certificates", "basedir")
-	if config.has_option("rulesets", "check_coverage"):
-		checkCoverage = config.getboolean("rulesets", "check_coverage")
 	if config.has_option("rulesets", "skiplist"):
 		skiplist = config.get("rulesets", "skiplist")
 		with open(skiplist) as f:
@@ -326,6 +327,7 @@ def cli():
 	rulesets = []
 	coverageProblemsExist = False
 	nonmatchGroupProblemsExist = False
+	testFormattingProblemsExist = False
 	for xmlFname in xmlFnames:
 		logging.debug("Parsing %s", xmlFname)
 		if skipFile(xmlFname):
@@ -352,6 +354,12 @@ def cli():
 			for problem in problems:
 				nonmatchGroupProblemsExist = True
 				logging.error(problem)
+		if checkTestFormatting:
+			logging.debug("Checking test formatting for '%s'." % ruleset.name)
+			problems = ruleset.getTestFormattingProblems()
+			for problem in problems:
+				testFormattingProblemsExist = True
+				logging.error(problem)
 		trie.addRuleset(ruleset)
 		rulesets.append(ruleset)
 	
@@ -424,6 +432,9 @@ def cli():
 	if checkNonmatchGroups:
 		if nonmatchGroupProblemsExist:
 			return 1 # exit with error code
+	if checkTestFormatting:
+		if testFormattingProblemsExist:
+			return 1 # exit with error code
 	return 0 # exit with success
 
 if __name__ == '__main__':
diff --git a/test/rules/src/https_everywhere_checker/rules.py b/test/rules/src/https_everywhere_checker/rules.py
@@ -1,3 +1,5 @@
+from urlparse import urlparse
+
 import regex
 
 class Rule(object):
@@ -229,6 +231,18 @@ def getNonmatchGroupProblems(self):
 							self.filename, test.url))
 		return problems
 
+	def getTestFormattingProblems(self):
+		"""Verify that tests are formatted properly.  This ensures that no test url
+			will lack a '/' in the path."""
+		problems = []
+		for rule in self.rules:
+			for test in rule.tests:
+				parsed_url = urlparse(test.url)
+				if parsed_url.path == '':
+					problems.append("%s: Test url lacks a trailing /: %s" % (
+						self.filename, test.url))
+		return problems
+
 	def whatApplies(self, url):
 		for exclusion in self.exclusions:
 			if exclusion.matches(url):
