#1454 - GUI for Template Set Management

.github/workflows/maven-build-test.yml

@@ -44,7 +44,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        javaVersion: [8, 11]
+        javaVersion: [11]
         os: [windows-latest, ubuntu-latest]
     runs-on: ${{ matrix.os }}
 
@@ -65,7 +65,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        javaVersion: [8, 11]
+        javaVersion: [11]
         os: [windows-latest, ubuntu-latest]
     runs-on: ${{ matrix.os }}
 
@@ -87,7 +87,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        javaVersion: [8]
+        javaVersion: [11]
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
 
@@ -114,7 +114,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        javaVersion: [8, 11]
+        javaVersion: [11]
         os: [windows-latest, ubuntu-latest]
     runs-on: ${{ matrix.os }}
 
@@ -134,7 +134,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        javaVersion: [8, 11]
+        javaVersion: [11]
         os: [windows-latest, ubuntu-latest]
     runs-on: ${{ matrix.os }}
 
@@ -169,7 +169,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        javaVersion: [8, 11]
+        javaVersion: [11]
         os: [windows-latest, ubuntu-latest]
     runs-on: ${{ matrix.os }}
 
@@ -213,7 +213,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        javaVersion: [8, 11]
+        javaVersion: [11]
         os: [windows-latest, ubuntu-latest]
     runs-on: ${{ matrix.os }}
 

build.sh

@@ -22,11 +22,11 @@ doRunCommand "mvn package $MVN_SETTINGS bundle:bundle -Pp2-build,p2-bundle -Dski
 doRunCommand "mvn install $MVN_SETTINGS bundle:bundle -Pp2-build,p2-bundle -DskipTests p2:site -f cobigen-plugins --projects !cobigen-javaplugin-parent/cobigen-javaplugin-model,!cobigen-openapiplugin-parent/cobigen-openapiplugin-model,!:plugins-parent,!cobigen-javaplugin-parent,!cobigen-openapiplugin-parent,!cobigen-templateengines $DEBUG $PARALLELIZED $BATCH_MODE -Dupdatesite.repository=$DEPLOY_UPDATESITE"
 
 log_step "Package & Run E2E Tests"
-doRunCommand "mvn integration-test $MVN_SETTINGS -f cobigen/cobigen-core-systemtest $COVERAGE $ENABLED_TEST $DEBUG $BATCH_MODE"
-doRunCommand "mvn install $MVN_SETTINGS -f cobigen-cli $COVERAGE $ENABLED_TEST $DEBUG $BATCH_MODE"
-doRunCommand "mvn install $MVN_SETTINGS -f cobigen-maven $COVERAGE $ENABLED_TEST $DEBUG $BATCH_MODE"
-doRunCommand "mvn install $MVN_SETTINGS -f cobigen-templates $COVERAGE $ENABLED_TEST $DEBUG $BATCH_MODE"
-doRunCommand "mvn install $MVN_SETTINGS -f cobigen-eclipse -Pp2-build $COVERAGE $ENABLED_TEST $DEBUG $BATCH_MODE"
+doRunCommand "mvn test $MVN_SETTINGS -f cobigen/cobigen-core-systemtest $ENABLED_TEST $DEBUG $BATCH_MODE"
+doRunCommand "mvn install $MVN_SETTINGS -f cobigen-cli $ENABLED_TEST $DEBUG $BATCH_MODE"
+doRunCommand "mvn install $MVN_SETTINGS -f cobigen-maven $ENABLED_TEST $DEBUG $BATCH_MODE"
+doRunCommand "mvn install $MVN_SETTINGS -f cobigen-templates $ENABLED_TEST $DEBUG $BATCH_MODE"
+doRunCommand "mvn install $MVN_SETTINGS -f cobigen-eclipse -Pp2-build $ENABLED_TEST $DEBUG $BATCH_MODE"
 
 if [[ -n "$COVERAGE" ]]
 then

cobigen-cli/cli-systemtest/src/test/java/com/devonfw/cobigen/cli/systemtest/AbstractCliTest.java

@@ -7,16 +7,22 @@
 import java.net.URISyntaxException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Stream;
 
+import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.codehaus.plexus.archiver.tar.TarGZipUnArchiver;
 import org.codehaus.plexus.logging.console.ConsoleLoggerManager;
 import org.codehaus.plexus.util.Os;
 import org.junit.Before;
 import org.junit.BeforeClass;
+import org.junit.ClassRule;
 import org.junit.Rule;
 import org.junit.rules.TemporaryFolder;
+import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.zeroturnaround.exec.ProcessExecutor;
 import org.zeroturnaround.exec.ProcessResult;
@@ -30,30 +36,94 @@
 /** Common test implementation for CLI tests */
 public class AbstractCliTest {
 
+  /** Logger instance. */
+  private static final Logger LOG = LoggerFactory.getLogger(AbstractCliTest.class);
+
   /** Java tool options */
   private static final String JAVA_TOOL_OPTIONS = "CGCLI_JAVA_OPTIONS";
 
   /** Temporary files rule to create temporary folders or files */
   @Rule
   public TemporaryFolder tempFolder = new TemporaryFolder();
 
+  /** Temporary directory for the templates project */
+  @ClassRule
+  public static TemporaryFolder tempFolderTemplates = new TemporaryFolder();
+
   /** Current home directory */
   protected Path currentHome;
 
-  /** The devon4j-templates development folder */
+  /** The templates development folder */
   protected static Path devTemplatesPath;
 
+  /** A temp directory containing the templates development folder */
+  protected static Path devTemplatesPathTemp;
+
   /**
-   * Determine the devon4j-templates development folder
+   * Determine the templates development folder and create a copy of it in the temp directory
    *
    * @throws URISyntaxException if the path could not be created properly
+   * @throws IOException if accessing a template directory directory fails
    */
   @BeforeClass
-  public static void determineDevTemplatesPath() throws URISyntaxException {
+  public static void determineDevTemplatesPath() throws URISyntaxException, IOException {
 
     devTemplatesPath = new File(AbstractCliTest.class.getProtectionDomain().getCodeSource().getLocation().toURI())
+        .getParentFile().getParentFile().getParentFile().getParentFile().toPath().resolve("cobigen-templates");
+
+    Path utilsPom = new File(AbstractCliTest.class.getProtectionDomain().getCodeSource().getLocation().toURI())
         .getParentFile().getParentFile().getParentFile().getParentFile().toPath().resolve("cobigen-templates")
-        .resolve("templates-devon4j");
+        .resolve("templates-devon4j-tests/src/test/resources/utils/pom.xml");
+
+    // create a temporary directory cobigen-templates/template-sets/adapted containing the template sets
+    Path tempFolderPath = tempFolderTemplates.getRoot().toPath();
+    Path cobigenTemplatePath = tempFolderPath.resolve("cobigen-templates");
+    if (!Files.exists(cobigenTemplatePath)) {
+      Files.createDirectory(cobigenTemplatePath);
+
+      devTemplatesPathTemp = cobigenTemplatePath.resolve(ConfigurationConstants.TEMPLATE_SETS_FOLDER);
+      Path templateSetsAdaptedFolder = devTemplatesPathTemp.resolve(ConfigurationConstants.ADAPTED_FOLDER);
+      Files.createDirectory(devTemplatesPathTemp);
+      Files.createDirectory(templateSetsAdaptedFolder);
+
+      FileUtils.copyDirectory(devTemplatesPath.toFile(), templateSetsAdaptedFolder.toFile());
+
+      List<Path> devTemplateSets = new ArrayList<>();
+      try (Stream<Path> files = Files.list(templateSetsAdaptedFolder)) {
+        files.forEach(path -> {
+          devTemplateSets.add(path);
+        });
+      }
+
+      for (Path path : devTemplateSets) {
+        if (Files.isDirectory(path)) {
+          Path resourcesFolder = path.resolve("src/main/resources");
+          Path templatesFolder = path.resolve(ConfigurationConstants.TEMPLATE_RESOURCE_FOLDER);
+          if (Files.exists(resourcesFolder) && !Files.exists(templatesFolder)) {
+            try {
+              Files.move(resourcesFolder, templatesFolder);
+            } catch (IOException e) {
+              throw new IOException("Error moving directory " + resourcesFolder, e);
+            }
+          }
+
+          // Replace the pom.xml in the template sets. Needed so that the project in the temp directory is build
+          // properly
+          if (Files.exists(path.resolve("pom.xml"))) {
+            try {
+              Files.delete(path.resolve("pom.xml"));
+            } catch (IOException e) {
+              throw new IOException("Error deleting file " + path.resolve("pom.xml"), e);
+            }
+            try {
+              Files.copy(utilsPom, path.resolve("pom.xml"));
+            } catch (IOException e) {
+              throw new IOException("Error copying file " + utilsPom, e);
+            }
+          }
+        }
+      }
+    }
   }
 
   /**
@@ -76,7 +146,7 @@ public void runWithLatestTemplates() throws IOException {
 
     Path configFile = this.currentHome.resolve(ConfigurationConstants.COBIGEN_CONFIG_FILE);
     Files.write(configFile,
-        (ConfigurationConstants.CONFIG_PROPERTY_TEMPLATES_PATH + "=" + devTemplatesPath.toString()).getBytes());
+        (ConfigurationConstants.CONFIG_PROPERTY_TEMPLATES_PATH + "=" + devTemplatesPathTemp.toString()).getBytes());
   }
 
   /**
@@ -88,15 +158,27 @@ protected void execute(String[] args, boolean useDevTemplates) throws Exception
     execute(args, useDevTemplates, false);
   }
 
+  /**
+   * @see #execute(String[], boolean, boolean)
+   */
+  @SuppressWarnings("javadoc")
+  protected void execute(String[] args, boolean useDevTemplates, boolean assureFailure) throws Exception {
+
+    execute(args, useDevTemplates, assureFailure, false);
+  }
+
   /**
    * This method check the return code from picocli
    *
    * @param args execution arguments
    * @param useDevTemplates use development devon4j-templates
    * @param assureFailure assure failure instead of success of the command execution
+   * @param allowMonolithicConfiguration ignores deprecated monolithic template folder structure and if found does not
+   *        throw a DeprecatedMonolithicConfigurationException
    * @throws Exception error
    */
-  protected void execute(String[] args, boolean useDevTemplates, boolean assureFailure) throws Exception {
+  protected void execute(String[] args, boolean useDevTemplates, boolean assureFailure,
+      boolean allowMonolithicConfiguration) throws Exception {
 
     if (useDevTemplates) {
       runWithLatestTemplates();
@@ -130,11 +212,21 @@ protected void execute(String[] args, boolean useDevTemplates, boolean assureFai
       i++;
     }
 
-    if (useDevTemplates) {
+    if (useDevTemplates && !allowMonolithicConfiguration) {
       debugArgs = Arrays.copyOf(debugArgs, debugArgs.length + 3);
       debugArgs[debugArgs.length - 3] = "-v";
       debugArgs[debugArgs.length - 2] = "-tp";
-      debugArgs[debugArgs.length - 1] = devTemplatesPath.toString();
+      debugArgs[debugArgs.length - 1] = devTemplatesPathTemp.toString();
+    } else if (useDevTemplates && allowMonolithicConfiguration) {
+      debugArgs = Arrays.copyOf(debugArgs, debugArgs.length + 4);
+      debugArgs[debugArgs.length - 4] = "--force-mc";
+      debugArgs[debugArgs.length - 3] = "-v";
+      debugArgs[debugArgs.length - 2] = "-tp";
+      debugArgs[debugArgs.length - 1] = devTemplatesPathTemp.toString();
+    } else if (allowMonolithicConfiguration) {
+      debugArgs = Arrays.copyOf(debugArgs, debugArgs.length + 2);
+      debugArgs[debugArgs.length - 2] = "--force-mc";
+      debugArgs[debugArgs.length - 1] = "-v";
     } else {
       debugArgs = Arrays.copyOf(debugArgs, debugArgs.length + 1);
       debugArgs[debugArgs.length - 1] = "-v";
@@ -147,11 +239,16 @@ protected void execute(String[] args, boolean useDevTemplates, boolean assureFai
         .redirectOutput(Slf4jStream.of(LoggerFactory.getLogger(getClass().getName() + ".cliprocess")).asInfo());
 
     // enable jacoco coverage monitoring for external processes (especially for CI/CD)
-    if (!StringUtils.isEmpty(MavenMetadata.JACOCO_AGENT_ARGS)) {
+    if (!StringUtils.isEmpty(MavenMetadata.JACOCO_AGENT_ARGS)
+        && !StringUtils.startsWith(MavenMetadata.JACOCO_AGENT_ARGS, "$")) {
+      System.out.println(System.getenv(JAVA_TOOL_OPTIONS));
       pe.environment(JAVA_TOOL_OPTIONS, MavenMetadata.JACOCO_AGENT_ARGS
+
           // .replaceFirst("destfile=[^,]+(,)?", "")
           // + ",output=tcpclient,sessionid=test,inclnolocationclasses=true,inclbootstrapclasses=true "
           + "" + (System.getenv(JAVA_TOOL_OPTIONS) == null ? "" : " " + System.getenv(JAVA_TOOL_OPTIONS)));
+    } else {
+      LOG.warn("No value for JACOCO is set!");
     }
 
     new SystemExit().execute(() -> {

cobigen-cli/cli-systemtest/src/test/java/com/devonfw/cobigen/cli/systemtest/AdaptTemplatesCommandIT.java

@@ -3,9 +3,12 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import java.io.File;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.Paths;
 
+import org.junit.Before;
 import org.junit.Test;
 
 import com.devonfw.cobigen.api.constants.ConfigurationConstants;
@@ -15,6 +18,29 @@
  */
 public class AdaptTemplatesCommandIT extends AbstractCliTest {
 
+  /**
+   * Simulate the download of the template set jars, as this not yet implemented. This method can be removed later
+   *
+   * @throws URISyntaxException if the path could not be created properly
+   * @throws IOException if accessing a directory or file fails
+   */
+  @Before
+  public void initAdaptTemplatesTest() throws URISyntaxException, IOException {
+
+    Path cliSystemTestPath = new File(
+        AdaptTemplatesCommandIT.class.getProtectionDomain().getCodeSource().getLocation().toURI()).getParentFile()
+            .getParentFile().toPath();
+    Path templateJar = cliSystemTestPath.resolve("src/test/resources/testdata/crud-java-server-app.jar");
+    if (Files.exists(templateJar)) {
+      Path downloadedTemplateSetsPath = this.currentHome.resolve(ConfigurationConstants.TEMPLATE_SETS_FOLDER)
+          .resolve(ConfigurationConstants.DOWNLOADED_FOLDER);
+      if (!Files.exists(downloadedTemplateSetsPath)) {
+        Files.createDirectories(downloadedTemplateSetsPath);
+      }
+      Files.copy(templateJar, downloadedTemplateSetsPath.resolve(templateJar.getFileName()));
+    }
+  }
+
   /**
    * Checks if adapt-templates command successfully created cobigen templates folder and its sub folders
    *
@@ -23,24 +49,27 @@ public class AdaptTemplatesCommandIT extends AbstractCliTest {
   @Test
   public void adaptTemplatesTest() throws Exception {
 
-    String args[] = new String[1];
+    String args[] = new String[2];
     args[0] = "adapt-templates";
+    args[1] = "--all";
 
     execute(args, false);
 
-    Path cobigenTemplatesFolderPath = this.currentHome.resolve(ConfigurationConstants.TEMPLATES_FOLDER)
-        .resolve(ConfigurationConstants.COBIGEN_TEMPLATES);
-    assertThat(cobigenTemplatesFolderPath).exists();
-    // check if templates exist
-    assertThat(Paths
-        .get(cobigenTemplatesFolderPath.toString() + File.separator + ConfigurationConstants.TEMPLATE_RESOURCE_FOLDER))
-            .exists();
+    Path cobigenTemplateSetsFolderPath = this.currentHome.resolve(ConfigurationConstants.TEMPLATE_SETS_FOLDER);
+    Path downloadedTemplateSetsFolderPath = cobigenTemplateSetsFolderPath
+        .resolve(ConfigurationConstants.DOWNLOADED_FOLDER);
+    Path adaptedTemplateSetsFolderPath = cobigenTemplateSetsFolderPath.resolve(ConfigurationConstants.ADAPTED_FOLDER);
+
+    assertThat(cobigenTemplateSetsFolderPath).exists();
+    assertThat(downloadedTemplateSetsFolderPath).exists();
+    assertThat(adaptedTemplateSetsFolderPath).exists();
+
+    // check if adapted template set exists
+    Path templateSet = adaptedTemplateSetsFolderPath.resolve("crud-java-server-app");
+    assertThat(templateSet).exists();
     // check if context configuration exists
-    assertThat(Paths
-        .get(cobigenTemplatesFolderPath.toString() + File.separator + ConfigurationConstants.TEMPLATE_RESOURCE_FOLDER
-            + File.separator + ConfigurationConstants.CONTEXT_CONFIG_FILENAME)).exists();
-    // check if sources of utility classes exist
-    assertThat(Paths.get(cobigenTemplatesFolderPath.toString() + File.separator + "src" + File.separator + "main"
-        + File.separator + "java")).exists();
+    assertThat(templateSet.resolve(ConfigurationConstants.TEMPLATE_RESOURCE_FOLDER)).exists();
+    assertThat(templateSet.resolve(ConfigurationConstants.TEMPLATE_RESOURCE_FOLDER)
+        .resolve(ConfigurationConstants.CONTEXT_CONFIG_FILENAME)).exists();
   }
 }