[Patch] JOSM Validator CLI errors out when is run with --load-preferences argument

[emanuel_raymond@…]

Use case: would like to use --load-preferences argument to add custom mapcss rules for the validator when running in CLI mode.

Problem: When running with --load-preferences, JOSM Validator CLI errors out.

Description:

I notice the issue is coming from these lines:

• Config.setBaseDirectoriesProvider(JosmBaseDirectories.getInstance());
  • should be called before this.parseArguments(argArray);
• tempPreferences.getAllSettings().entrySet().stream().filter(entry -> entry.getValue().isNew())
  • I removed the isNew filter because I noticed that they were not set to true.

The following code snippet is the git diff for the fix that I applied to mitigate this error. Note: I have little knowledge to the whole source code and this is my first time debugging and exploring the code myself.

src/org/openstreetmap/josm/data/validation/ValidatorCLI.java

@@ -165 +165 @@
             // Ensure that preferences are only in memory
             Config.setPreferencesInstance(new MemoryPreferences());
             Logging.setLogLevel(Level.INFO);
+            Logging.setLogLevel(this.logLevel);
+            HttpClient.setFactory(Http1Client::new);
+            Config.setBaseDirectoriesProvider(JosmBaseDirectories.getInstance()); // for right-left-hand traffic cache file
+            Config.setUrlsProvider(JosmUrls.getInstance());
+            ProjectionRegistry.setProjection(Projections.getProjectionByCode("epsg:3857".toUpperCase(Locale.ROOT)));
+            
             this.parseArguments(argArray);
             if (this.input.isEmpty()) {
                 throw new IllegalArgumentException(tr("Missing argument - input data file ({0})", "--input|-i"));
             }
+            
             this.initialize();
             final ProgressMonitor fileMonitor = progressMonitorFactory.get();
             fileMonitor.beginTask(tr("Processing files..."), this.input.size());
@@ -345 +352 @@
      * Arguments may need to be parsed first.
      */
     void initialize() {
-        Logging.setLogLevel(this.logLevel);
-        HttpClient.setFactory(Http1Client::new);
-        Config.setBaseDirectoriesProvider(JosmBaseDirectories.getInstance()); // for right-left-hand traffic cache file
-        Config.setUrlsProvider(JosmUrls.getInstance());
-        ProjectionRegistry.setProjection(Projections.getProjectionByCode("epsg:3857".toUpperCase(Locale.ROOT)));
-
         Territories.initializeInternalData();
         OsmValidator.initialize();
         MapPaintStyles.readFromPreferences();
@@ -430 +431 @@
             final IPreferences pref = Config.getPref();
             if (pref instanceof MemoryPreferences) {
                 final MemoryPreferences memoryPreferences = (MemoryPreferences) pref;
-                tempPreferences.getAllSettings().entrySet().stream().filter(entry -> entry.getValue().isNew())
+                tempPreferences.getAllSettings().entrySet().stream()
                         .forEach(entry -> memoryPreferences.putSetting(entry.getKey(), entry.getValue()));
             } else {
                 throw new JosmRuntimeException(tr("Preferences are not the expected type"));

[taylor.smock]

@emanuel_raymond: Do you have a preference for how you will be given credit?

The commit message will look something like the following:

Fix #22898: JOSM Validator CLI errors out when is run with --load-preferences argument (patch by emanuel_raymond)

[taylor.smock]

Add non-regression test, simplify original patch

[emanuel_raymond@…]

Do you have a preference for how you will be given credit?
The commit message will look something like the following:

@taylor.smock: not really, the commit message looks good to me. thank you.

[taylor.smock]

In 18714/josm:

Fix #22898: JOSM Validator CLI errors out when is run with --load-preferences argument (patch by emanuel_raymond, modified)

[emanuel_raymond@…]

I still got this error when running the validator CLI (using josm-latest.jar with version 18715)

java.lang.NullPointerException: Cannot invoke "org.openstreetmap.josm.spi.preferences.IBaseDirectories.getPreferencesDirectory(boolean)" because the return value of "org.openstreetmap.josm.spi.preferences.Config.getDirs()" is null
        at org.openstreetmap.josm.gui.io.CustomConfigurator$XMLCommandProcessor.<init>(CustomConfigurator.java:415)
        at org.openstreetmap.josm.data.validation.ValidatorCLI.handleOption(ValidatorCLI.java:424)
        at org.openstreetmap.josm.data.validation.ValidatorCLI.lambda$parseArguments$8(ValidatorCLI.java:372)
        at org.openstreetmap.josm.tools.OptionParser$1.runFor(OptionParser.java:103)
        at org.openstreetmap.josm.tools.OptionParser.parseOptions(OptionParser.java:198)
        at org.openstreetmap.josm.tools.OptionParser.parseOptionsOrExit(OptionParser.java:116)
        at org.openstreetmap.josm.data.validation.ValidatorCLI.parseArguments(ValidatorCLI.java:380)
        at org.openstreetmap.josm.data.validation.ValidatorCLI.processArguments(ValidatorCLI.java:168)
        at org.openstreetmap.josm.gui.MainApplication.main(MainApplication.java:736)

This is how I run the validate command:

java -jar josm-latest.jar validate --load-preferences custom_josm_preferences.xml --input file.osm

[taylor.smock]

In 18718/josm:

See #22898: JOSM Validator CLI errors out when is run with --load-preferences argument

There was an additional problem related to the directories setup order.