Merge pull request #54 from renanfranca/7-allow-external-configuration-file

load hidden resources configuration from external file

Author: pascalgrimaud

documentation/Commands.md

@@ -12,6 +12,7 @@ This document provides an overview of the JHipster Lite CLI commands available i
 - [Project Creation Workflow Example](#project-creation-workflow-example)
 - [Options and Parameters](#options-and-parameters)
   - [Parameters Reuse](#parameter-reuse)
+- [External Configuration](#external-configuration)
 
 ## Getting Started
 
@@ -141,3 +142,46 @@ jhlite apply maven-java --package-name com.example.myproject
 ```
 
 The CLI will automatically reuse the `project-name`, `base-name`, and `node-package-manager` values from your previous command.
+
+## External Configuration
+
+JHipster Lite CLI supports external configuration files to customize its behavior. The CLI automatically looks for a configuration file at:
+
+```
+~/.config/jhlite-cli.yml
+```
+
+If this file exists, it will be loaded automatically when the CLI starts.
+
+### Configuration Options
+
+#### Hidden Resources
+
+You can hide specific modules from being displayed in the `list` command and prevent them from being applied. This is useful for customizing which modules are available in different environments.
+
+Create a `~/.config/jhlite-cli.yml` file with the following structure:
+
+```yaml
+jhlite:
+  hidden-resources:
+    slugs:
+      - gradle-java
+      - module-slug-to-hide
+    tags:
+      - setup
+      - tag-to-hide
+```
+
+**Configuration properties:**
+
+- `slugs`: List of specific module slugs to hide
+- `tags`: List of module tags to hide (hides all modules with these tags)
+
+**Effects of hidden resources:**
+
+- Hidden modules will not appear in the output of `jhlite list`
+- Hidden modules cannot be applied using `jhlite apply <hidden-module>`
+- Attempting to apply a hidden module will result in an "Unmatched arguments" error
+
+**Example:**
+If you hide the `gradle-java` module, running `jhlite list` will not show it in the available modules, and running `jhlite apply gradle-java` will fail with an error.

src/main/java/tech/jhipster/lite/cli/JHLiteCliApp.java

@@ -1,5 +1,7 @@
 package tech.jhipster.lite.cli;
 
+import java.nio.file.Files;
+import java.nio.file.Path;
 import org.springframework.boot.Banner;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.WebApplicationType;
@@ -13,12 +15,34 @@
 @ExcludeFromGeneratedCodeCoverage(reason = "Not testing logs")
 public class JHLiteCliApp {
 
+  private static final String CONFIG_FILE_NAME = "/.config/jhlite-cli.yml";
+  private static final String SPRING_CONFIG_LOCATION_PROPERTY = "spring.config.location";
+  private static final String SPRING_CONFIG_LOCATION_VALUE = "classpath:/config/,file:";
+
   public static void main(String[] args) {
-    ConfigurableApplicationContext context = new SpringApplicationBuilder(JHLiteCliApp.class)
+    ConfigurableApplicationContext context = loadExternalConfigFile(createApplicationBuilder()).run(args);
+
+    System.exit(SpringApplication.exit(context));
+  }
+
+  private static SpringApplicationBuilder createApplicationBuilder() {
+    return new SpringApplicationBuilder(JHLiteCliApp.class)
       .bannerMode(Banner.Mode.OFF)
       .web(WebApplicationType.NONE)
-      .lazyInitialization(true)
-      .run(args);
-    System.exit(SpringApplication.exit(context));
+      .lazyInitialization(true);
+  }
+
+  private static SpringApplicationBuilder loadExternalConfigFile(SpringApplicationBuilder builder) {
+    String configPath = getConfigPath();
+
+    if (Files.exists(Path.of(configPath))) {
+      builder.properties(SPRING_CONFIG_LOCATION_PROPERTY + "=" + SPRING_CONFIG_LOCATION_VALUE + configPath);
+    }
+
+    return builder;
+  }
+
+  private static String getConfigPath() {
+    return System.getProperty("user.home") + CONFIG_FILE_NAME;
   }
 }

src/test/java/tech/jhipster/lite/cli/command/infrastructure/primary/CliFixture.java

@@ -0,0 +1,41 @@
+package tech.jhipster.lite.cli.command.infrastructure.primary;
+
+import static tech.jhipster.lite.TestProjects.newTestFolder;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.List;
+import picocli.CommandLine;
+import tech.jhipster.lite.module.application.JHipsterModulesApplicationService;
+import tech.jhipster.lite.module.infrastructure.secondary.git.GitTestUtil;
+import tech.jhipster.lite.project.application.ProjectsApplicationService;
+
+class CliFixture {
+
+  static Path setupProjectTestFolder() throws IOException {
+    String projectFolder = newTestFolder();
+    Path projectPath = Path.of(projectFolder);
+    Files.createDirectories(projectPath);
+    loadGitConfig(projectPath);
+
+    return projectPath;
+  }
+
+  static void loadGitConfig(Path project) {
+    GitTestUtil.execute(project, "init");
+    GitTestUtil.execute(project, "config", "init.defaultBranch", "main");
+    GitTestUtil.execute(project, "config", "user.email", "\"[email protected]\"");
+    GitTestUtil.execute(project, "config", "user.name", "\"Test\"");
+  }
+
+  static CommandLine commandLine(JHipsterModulesApplicationService modules, ProjectsApplicationService projects) {
+    ListModulesCommand listModulesCommand = new ListModulesCommand(modules);
+    ApplyModuleSubCommandsFactory subCommandsFactory = new ApplyModuleSubCommandsFactory(modules, projects);
+    ApplyModuleCommand applyModuleCommand = new ApplyModuleCommand(modules, subCommandsFactory);
+
+    JHLiteCommandsFactory jhliteCommandsFactory = new JHLiteCommandsFactory(List.of(listModulesCommand, applyModuleCommand), "1", "2");
+
+    return new CommandLine(jhliteCommandsFactory.buildCommandSpec());
+  }
+}

src/test/java/tech/jhipster/lite/cli/command/infrastructure/primary/ExternalConfigTest.java

@@ -0,0 +1,59 @@
+package tech.jhipster.lite.cli.command.infrastructure.primary;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static tech.jhipster.lite.cli.command.infrastructure.primary.CliFixture.commandLine;
+import static tech.jhipster.lite.cli.command.infrastructure.primary.CliFixture.setupProjectTestFolder;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.env.Environment;
+import org.springframework.test.context.TestPropertySource;
+import tech.jhipster.lite.cli.IntegrationTest;
+import tech.jhipster.lite.module.application.JHipsterModulesApplicationService;
+import tech.jhipster.lite.project.application.ProjectsApplicationService;
+
+@IntegrationTest
+@TestPropertySource(properties = { "spring.config.location=classpath:/cli/config/jhlite-cli-hidden-resources.yml" })
+class ExternalConfigTest {
+
+  @Autowired
+  private ProjectsApplicationService projects;
+
+  @Autowired
+  private JHipsterModulesApplicationService modules;
+
+  @Autowired
+  private Environment environment;
+
+  @Test
+  void shouldLoadExternalConfiguration() {
+    assertThat(environment.getProperty("jhlite.hidden-resources.slugs[0]")).isEqualTo("gradle-java");
+  }
+
+  @Test
+  void shouldHideModuleWhenLoadExternalConfigurationFile() {
+    String[] args = { "list" };
+
+    try (SystemOutputCaptor outputCaptor = new SystemOutputCaptor()) {
+      int exitCode = commandLine(modules, projects).execute(args);
+
+      assertThat(exitCode).isZero();
+      assertThat(outputCaptor.getOutput()).doesNotContain("gradle-java");
+    }
+  }
+
+  @Test
+  void shouldHideApplyCommandWhenLoadExternalConfigurationFile() throws IOException {
+    Path projectPath = setupProjectTestFolder();
+    String[] args = { "apply", "gitpod", "--project-path", projectPath.toString() };
+
+    try (SystemOutputCaptor outputCaptor = new SystemOutputCaptor()) {
+      int exitCode = commandLine(modules, projects).execute(args);
+
+      assertThat(exitCode).isEqualTo(2);
+      assertThat(outputCaptor.getOutput()).contains("Unmatched arguments from index");
+    }
+  }
+}