Improve error message for ruleset coverage checker.

jsha · jsha · commit f4f2c40756d9 · 2015-02-17T11:06:30.000-08:00
Indicates which docs to read for improvements.
diff --git a/test-ruleset-coverage.sh b/test-ruleset-coverage.sh
@@ -6,14 +6,25 @@
 cd $(dirname $0)
 TMP=`mktemp`
 trap 'rm "$TMP"' EXIT
+if ! [ -d https-everywhere-checker ] ; then
+  echo "Submodule https-everywhere-checker is missing. Run"
+  echo "./install-dev-dependencies.sh"
+  exit 1
+fi
 # Git log gives us all changed files. Pipe that through ls to eliminate files
 # that have been deleted.
 if ! git log --name-only --date=local --since="2015-02-12 6:00" --pretty=format: \
       src/chrome/content/rules/ | sort -u | \
       xargs ls 2>/dev/null | xargs python2.7 https-everywhere-checker/src/https_everywhere_checker/check_rules.py \
-      https-everywhere-checker/coverage.checker.config ; then
-  echo "Ruleset test coverage was insufficient. Please add <test url=...> tags " \
-       "to ruleset with additional HTTP URLs to test rewriting and fetching."
+      https-everywhere-checker/coverage.checker.config; then
+  echo "Ruleset test coverage was insufficient."
+  echo ""
+  echo "Under the new ruleset testing rules (February 2015), any modified ruleset"
+  echo "must have sufficient test coverage. You can often improve test coverage by"
+  echo "adding <test url='...' /> tags, or by restructuring the rule to avoid"
+  echo "wildcard <target> tags. See these documents:"
+  echo "https://github.com/EFForg/https-everywhere/blob/master/ruleset-testing.md"
+  echo "https://github.com/EFForg/https-everywhere/blob/master/ruleset-style.md"
   exit 1
 else
   exit 0
