Changeset 8936 in josm

Timestamp:

2015-10-23T23:34:29+02:00 (9 years ago)

Author:

Don-vip

Message:

add unit test to check syntax validity of all MapCSSTagChecker rules

Location:

trunk

Files:

• src/org/openstreetmap/josm/data/validation/tests/MapCSSTagChecker.java (modified) (5 diffs)
• src/org/openstreetmap/josm/gui/preferences/SourceEditor.java (modified) (2 diffs)
• test/unit/org/openstreetmap/josm/data/validation/tests/MapCSSTagCheckerTest.java (modified) (5 diffs)
• test/unit/org/openstreetmap/josm/gui/preferences/validator (added)
• test/unit/org/openstreetmap/josm/gui/preferences/validator/ValidatorTagCheckerRulesPreferenceTest.java (added)

trunk/src/org/openstreetmap/josm/data/validation/tests/MapCSSTagChecker.java

@@ -234 +234 @@
     final MultiMap<String, TagCheck> checks = new MultiMap<>();
 
-    static class TagCheck implements Predicate<OsmPrimitive> {
+    /**
+     * Result of {@link TagCheck#readMapCSS}
+     * @since 8936
+     */
+    public static class ParseResult {
+        /** Checks successfully parsed */
+        public final List<TagCheck> parseChecks;
+        /** Errors that occured during parsing */
+        public final Collection<Throwable> parseErrors;
+
+        /**
+         * Constructs a new {@code ParseResult}.
+         * @param parseChecks Checks successfully parsed
+         * @param parseErrors Errors that occured during parsing
+         */
+        public ParseResult(List<TagCheck> parseChecks, Collection<Throwable> parseErrors) {
+            this.parseChecks = parseChecks;
+            this.parseErrors = parseErrors;
+        }
+    }
+
+    public static class TagCheck implements Predicate<OsmPrimitive> {
         protected final GroupedMapCSSRule rule;
         protected final List<FixCommand> fixCommands = new ArrayList<>();
@@ -320 +341 @@
         }
 
-        static List<TagCheck> readMapCSS(Reader css) throws ParseException {
+        static ParseResult readMapCSS(Reader css) throws ParseException {
             CheckParameterUtil.ensureParameterNotNull(css, "css");
 
@@ -329 +350 @@
             final MapCSSParser parser = new MapCSSParser(css, MapCSSParser.LexicalState.DEFAULT);
             parser.sheet(source);
-            assert source.getErrors().isEmpty();
+            Collection<Throwable> parseErrors = source.getErrors();
+            assert parseErrors.isEmpty();
             // Ignore "meta" rule(s) from external rules of JOSM wiki
             removeMetaRules(source);
@@ -343 +365 @@
                 }
             }
-            List<TagCheck> result = new ArrayList<>();
+            List<TagCheck> parseChecks = new ArrayList<>();
             for (Map.Entry<Declaration, List<Selector>> map : g.entrySet()) {
                 try {
-                    result.add(TagCheck.ofMapCSSRule(
+                    parseChecks.add(TagCheck.ofMapCSSRule(
                             new GroupedMapCSSRule(map.getValue(), map.getKey())));
                 } catch (IllegalDataException e) {
                     Main.error("Cannot add MapCss rule: "+e.getMessage());
-                }
-            }
-            return result;
+                    parseErrors.add(e);
+                }
+            }
+            return new ParseResult(parseChecks, parseErrors);
         }
 
@@ -669 +692 @@
      * Adds a new MapCSS config file from the given URL.
      * @param url The unique URL of the MapCSS config file
+     * @return List of tag checks and parsing errors, or null
      * @throws ParseException if the config file does not match MapCSS syntax
      * @throws IOException if any I/O error occurs
      * @since 7275
      */
-    public synchronized void addMapCSS(String url) throws ParseException, IOException {
+    public synchronized ParseResult addMapCSS(String url) throws ParseException, IOException {
         CheckParameterUtil.ensureParameterNotNull(url, "url");
         CachedFile cache = new CachedFile(url);
         InputStream zip = cache.findZipEntryInputStream("validator.mapcss", "");
+        ParseResult result;
         try (InputStream s = zip != null ? zip : cache.getInputStream()) {
-            List<TagCheck> tagchecks = TagCheck.readMapCSS(new BufferedReader(UTFInputStreamReader.create(s)));
+            result = TagCheck.readMapCSS(new BufferedReader(UTFInputStreamReader.create(s)));
             checks.remove(url);
-            checks.putAll(url, tagchecks);
+            checks.putAll(url, result.parseChecks);
             // Check assertions, useful for development of local files
             if (Main.pref.getBoolean("validator.check_assert_local_rules", false) && Utils.isLocalUrl(url)) {
-                for (String msg : checkAsserts(tagchecks)) {
+                for (String msg : checkAsserts(result.parseChecks)) {
                     Main.warn(msg);
                 }
             }
         }
+        return result;
     }
 

trunk/src/org/openstreetmap/josm/gui/preferences/SourceEditor.java

@@ -447 +447 @@
     /**
      * Synchronously loads available sources and returns the parsed list.
+     * @return list of available sources
      */
-    Collection<ExtendedSourceEntry> loadAndGetAvailableSources() {
+    public final Collection<ExtendedSourceEntry> loadAndGetAvailableSources() {
         try {
             final SourceLoader loader = new SourceLoader(availableSourcesUrl, sourceProviders);
@@ -466 +467 @@
     }
 
+    /**
+     * Performs the initial loading of source providers. Does nothing if already done.
+     */
     public void initiallyLoadAvailableSources() {
         if (!sourcesInitiallyLoaded) {

trunk/test/unit/org/openstreetmap/josm/data/validation/tests/MapCSSTagCheckerTest.java

@@ -28 +28 @@
 import org.openstreetmap.josm.data.validation.Severity;
 import org.openstreetmap.josm.data.validation.TestError;
+import org.openstreetmap.josm.data.validation.tests.MapCSSTagChecker.ParseResult;
 import org.openstreetmap.josm.data.validation.tests.MapCSSTagChecker.TagCheck;
 import org.openstreetmap.josm.gui.mappaint.mapcss.parsergen.ParseException;
@@ -46 +47 @@
     static MapCSSTagChecker buildTagChecker(String css) throws ParseException {
         final MapCSSTagChecker test = new MapCSSTagChecker();
-        test.checks.putAll("test", TagCheck.readMapCSS(new StringReader(css)));
+        test.checks.putAll("test", TagCheck.readMapCSS(new StringReader(css)).parseChecks);
         return test;
     }
@@ -52 +53 @@
     @Test
     public void testNaturalMarsh() throws Exception {
-        final List<MapCSSTagChecker.TagCheck> checks = MapCSSTagChecker.TagCheck.readMapCSS(new StringReader("" +
+        ParseResult result = MapCSSTagChecker.TagCheck.readMapCSS(new StringReader("" +
                 "*[natural=marsh] {\n" +
                 "   throwWarning: tr(\"{0}={1} is deprecated\", \"{0.key}\", tag(\"natural\"));\n" +
@@ -59 +60 @@
                 "   fixAdd: \"wetland=marsh\";\n" +
                 "}"));
+        final List<MapCSSTagChecker.TagCheck> checks = result.parseChecks;
         assertEquals(1, checks.size());
+        assertTrue(result.parseErrors.isEmpty());
         final MapCSSTagChecker.TagCheck check = checks.get(0);
         assertNotNull(check);
@@ -87 +90 @@
                 "fixChangeKey: \"highway => construction\";\n" +
                 "fixAdd: \"highway=construction\";\n" +
-                "}")).get(0);
+                "}")).parseChecks.get(0);
         final Command command = check.fixPrimitive(p);
         assertTrue(command instanceof SequenceCommand);