Add ini-path subcommand (#688)

Author: itzg

README.md

@@ -92,6 +92,8 @@ dependencies {
   implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-xml'
   implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-toml'
   implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310'
+  // http://www.ini4j.org/
+  implementation 'org.ini4j:ini4j:0.5.4'
   // https://github.com/mbknor/mbknor-jackson-jsonSchema
   implementation 'com.kjetland:mbknor-jackson-jsonschema_2.13:1.0.39'
   implementation 'com.jayway.jsonpath:json-path:2.10.0'

build.gradle

@@ -20,6 +20,7 @@
 import me.itzg.helpers.errors.ExceptionHandler;
 import me.itzg.helpers.errors.ExitCodeMapper;
 import me.itzg.helpers.fabric.InstallFabricLoaderCommand;
+import me.itzg.helpers.files.IniPathCommand;
 import me.itzg.helpers.files.TomlPathCommand;
 import me.itzg.helpers.files.YamlPathCommand;
 import me.itzg.helpers.find.FindCommand;
@@ -71,6 +72,7 @@
         GetCommand.class,
         GithubCommands.class,
         HashCommand.class,
+        IniPathCommand.class,
         InstallCurseForgeCommand.class,
         InstallFabricLoaderCommand.class,
         InstallForgeCommand.class,

src/main/java/me/itzg/helpers/McImageHelper.java

@@ -0,0 +1,84 @@
+package me.itzg.helpers.files;
+
+import com.jayway.jsonpath.Configuration;
+import com.jayway.jsonpath.DocumentContext;
+import com.jayway.jsonpath.JsonPath;
+import com.jayway.jsonpath.ParseContext;
+import com.jayway.jsonpath.spi.json.JacksonJsonProvider;
+import java.io.File;
+import java.util.concurrent.Callable;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import me.itzg.helpers.errors.InvalidParameterException;
+import org.ini4j.Config;
+import org.ini4j.Ini;
+import org.ini4j.Profile.Section;
+import picocli.CommandLine.Command;
+import picocli.CommandLine.ExitCode;
+import picocli.CommandLine.Option;
+import picocli.CommandLine.Parameters;
+
+@Command(name = "ini-path", description = "Extracts a field from an INI file")
+public class IniPathCommand implements Callable<Integer> {
+
+    private static final String EXPRESSION_SYNTAX_DESC = "section/option, section/option[index], /option, /option[index]";
+    private final static Pattern expressions = Pattern.compile(
+        "(?<section>.+?)?/(?<key>[^\\[]+?)(\\[(?<index>\\d+)])?"
+    );
+
+    @Option(names = "--file", paramLabel = "FILE", description = "An INI file to query. If not set, reads stdin")
+    File iniFile;
+
+    @Parameters(arity = "1",
+        paramLabel = "ref",
+        description = EXPRESSION_SYNTAX_DESC)
+    String query;
+
+
+    @Override
+    public Integer call() throws Exception {
+        final Matcher matcher = expressions.matcher(query);
+        if (!matcher.matches()) {
+            throw new InvalidParameterException("Query expression is invalid. Should be " +  EXPRESSION_SYNTAX_DESC);
+        }
+
+        final Ini ini = new Ini();
+        final Config iniCfg = Config.getGlobal().clone();
+        iniCfg.setGlobalSection(true);
+        ini.setConfig(iniCfg);
+        ini.load(iniFile);
+
+        final String sectionKey = matcher.group("section");
+        final String fieldKey = matcher.group("key");
+        final String indexStr = matcher.group("index");
+
+        final Section section = ini.get(sectionKey != null ? sectionKey : Config.DEFAULT_GLOBAL_SECTION_NAME);
+        if (section == null) {
+            throw new InvalidParameterException("Section not found: " + sectionKey);
+        }
+
+        if (indexStr == null) {
+            final String value = section.fetch(fieldKey);
+            if (value == null) {
+                throw new InvalidParameterException("Field not found: " + fieldKey + " in section: " + sectionKey);
+            }
+
+            System.out.println(value);
+        }
+        else {
+            final int index = Integer.parseInt(indexStr);
+            if (index <= 0) {
+                throw new InvalidParameterException("Index must be greater than 0.");
+            }
+            final String value = section.fetch(fieldKey, index);
+            if (value == null) {
+                throw new InvalidParameterException("Field not found: " + fieldKey + " with index: " + index + " in section: " + sectionKey);
+            }
+
+            System.out.println(value);
+        }
+
+        return ExitCode.OK;
+    }
+
+}

src/main/java/me/itzg/helpers/files/IniPathCommand.java

@@ -149,7 +149,7 @@ private Mono<ProjectResponse> getProjectVersions(String project) {
             );
     }
 
-    @RequiredArgsConstructor
+    @Data
     private static class VersionAndBuildResponse {
         final VersionResponse versionResponse;
         final BuildResponse buildResponse;

src/main/java/me/itzg/helpers/paper/PaperDownloadsClient.java

@@ -0,0 +1,74 @@
+package me.itzg.helpers.files;
+
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.junit.jupiter.params.provider.ValueSource;
+import picocli.CommandLine;
+import picocli.CommandLine.ExitCode;
+
+import java.nio.file.Paths;
+import java.util.stream.Stream;
+
+import static com.github.stefanbirkner.systemlambda.SystemLambda.*;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.params.provider.Arguments.arguments;
+
+class IniPathCommandTest {
+
+    public static Stream<Arguments> extractsFromUnsupConfig_args() {
+        return Stream.of(
+            arguments("/version", "1"),
+            arguments("/preset", "minecraft"),
+            arguments("flavors/flavor", "standard")
+        );
+    }
+
+    @ParameterizedTest
+    @MethodSource("extractsFromUnsupConfig_args")
+    void extractsFromUnsupConfig(String query, String expectedValue) throws Exception {
+        final String out = tapSystemOutNormalized(() -> {
+            final int exitCode = new CommandLine(new IniPathCommand())
+                .execute(
+                    "--file", Paths.get("src/test/resources/unsup.ini").toString(),
+                    query
+                );
+
+            assertThat(exitCode).isEqualTo(ExitCode.OK);
+        });
+
+        assertThat(out).isEqualTo(expectedValue + "\n");
+    }
+
+    @ParameterizedTest
+    @ValueSource(strings = {"/no1", "flavors/no3"})
+    void errorOnMissingFields(String query) throws Exception {
+        final String err = tapSystemErrNormalized(() -> {
+            final int exitCode = new CommandLine(new IniPathCommand())
+                .execute(
+                    "--file", Paths.get("src/test/resources/unsup.ini").toString(),
+                    query
+                );
+
+            assertThat(exitCode).isNotEqualTo(ExitCode.OK);
+        });
+
+        assertThat(err).contains("Field not found");
+    }
+
+    @ParameterizedTest
+    @ValueSource(strings = {"noglobal", "dangling/", "section/field["})
+    void invalidQuerySyntax(String query) throws Exception {
+        final String err = tapSystemErrNormalized(() -> {
+            final int exitCode = new CommandLine(new IniPathCommand())
+                .execute(
+                    "--file", Paths.get("src/test/resources/unsup.ini").toString(),
+                    query
+                );
+
+            assertThat(exitCode).isNotEqualTo(ExitCode.OK);
+        });
+
+        assertThat(err).contains("Query expression is invalid");
+    }
+}

src/test/java/me/itzg/helpers/files/IniPathCommandTest.java

@@ -0,0 +1,12 @@
+version=1
+preset=minecraft
+
+source_format=packwiz
+source=https://rewindmc.com/packwiz/upsilon/pack.toml
+
+force_env=server
+
+[flavors]
+flavor=standard
+gregtech=gregtech_on
+dartcraft=dartcraft_off