1510 allow template sets to be installed

cobigen-eclipse/cobigen-eclipse-test/src/main/resources/OpenAPITest/templates/context.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<contextConfiguration xmlns="http://capgemini.com/devonfw/cobigen/ContextConfiguration" version="3.0">
+<contextConfiguration xmlns="http://capgemini.com/devonfw/cobigen/ContextConfiguration" version="2.1">
 
   <trigger id="crud_openapi_java_server_app" type="openapi" templateFolder="templates">
     <containerMatcher type="element" value="openAPIFile"/>
@@ -29,7 +29,5 @@
       <variableAssignment type="property" key="entityName" value="name"/>
     </matcher>
   </trigger>
-  <tags>
-    <tag name="bla" />
-  </tags>
+
 </contextConfiguration>

cobigen/cobigen-core-api/src/main/java/com/devonfw/cobigen/api/constants/ConfigurationConstants.java

@@ -98,6 +98,11 @@ public class ConfigurationConstants {
    */
   public static final String CONFIG_PROPERTY_TEMPLATE_SETS_HIDE = "template-sets.hide";
 
+  /**
+   * Name of configuration key to preinstall specific template sets
+   */
+  public static final String CONFIG_PROPERTY_TEMPLATE_SETS_INSTALLED = "template-sets.installed";
+
   /**
    * Default (public) cobigen GroupId
    */

cobigen/cobigen-core-api/src/main/java/com/devonfw/cobigen/api/constants/TemplatesJarConstants.java

@@ -9,6 +9,12 @@ public class TemplatesJarConstants {
    */
   public static final String DOWNLOADED_JAR_FOLDER = "/.metadata/cobigen_jars";
 
+  /**
+   * Regular expression to check the correct definition of maven coordinates to download a template-set with the
+   * configuration key template-sets.installed in the properties.
+   */
+  public static final String MAVEN_COORDINATES_CHECK = "([a-zA-Z0-9_\\-\\.]+):([a-zA-Z0-9_-]+)(:([0-9]+(\\.[0-9]+)*(-SNAPSHOT)?|LATEST))?";
+
   /**
    * Jar regular expression name to be used in a file name filter, so that we can check whether the templates are
    * already downloaded. Checks "templates-anystring-anydigitbetweendots.jar"

cobigen/cobigen-core-api/src/main/java/com/devonfw/cobigen/api/util/MavenCoordinate.java

@@ -0,0 +1,36 @@
+package com.devonfw.cobigen.api.util;
+
+/**
+ * TODO
+ */
+public class MavenCoordinate {
+
+  private String groupID;
+
+  private String artifactID;
+
+  private String version;
+
+  public MavenCoordinate(String groupID, String artifactID, String version) {
+
+    this.groupID = groupID;
+    this.artifactID = artifactID;
+    this.version = version;
+  }
+
+  public String getArtifactID() {
+
+    return this.artifactID;
+  }
+
+  public String getGroupID() {
+
+    return this.groupID;
+  }
+
+  public String getVersion() {
+
+    return this.version;
+  }
+
+}

cobigen/cobigen-core-api/src/main/java/com/devonfw/cobigen/api/util/TemplatesJarUtil.java

@@ -12,7 +12,9 @@
 import java.nio.file.StandardCopyOption;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Set;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -21,6 +23,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.devonfw.cobigen.api.constants.ConfigurationConstants;
 import com.devonfw.cobigen.api.constants.TemplatesJarConstants;
 import com.devonfw.cobigen.api.exception.CobiGenRuntimeException;
 
@@ -45,7 +48,8 @@ private static String downloadJar(String groupId, String artifactId, String vers
       File templatesDirectory) {
 
     // By default the version should be latest
-    if (version.isEmpty() || version == null) {
+    if (version == null || version.isEmpty()) {
+
       version = "LATEST";
     }
 
@@ -84,7 +88,9 @@ private static String downloadJar(String groupId, String artifactId, String vers
     return fileName;
   }
 
+  // TODO
   /**
+   *
    * @param isDownloadSource true if downloading source jar file
    * @param templatesDirectory directory where the templates jar are located
    * @return fileName Name of the file downloaded
@@ -95,6 +101,53 @@ public static String downloadLatestDevon4jTemplates(boolean isDownloadSource, Fi
         TemplatesJarConstants.DEVON4J_TEMPLATES_ARTIFACTID, "LATEST", isDownloadSource, templatesDirectory);
   }
 
+  // TODO
+  /**
+   * @param templatesDirectory directory where the templates jar are located
+   * @return fileName Name of the file downloaded
+   */
+  public static void downloadTemplatesByMavenCoordinates(File templatesDirectory,
+      List<MavenCoordinate> mavenCoordinates) {
+
+    if (mavenCoordinates == null || mavenCoordinates.isEmpty()) {
+      return;
+      // no templates specified
+    }
+    Set<MavenCoordinate> afterExistanceCheckList = new HashSet();
+    // File adapted = new File(templatesDirectory, ConfigurationConstants.ADAPTED_FOLDER);
+    // File downloaded = new File(templatesDirectory, ConfigurationConstants.DOWNLOADED_FOLDER);
+    if (templatesDirectory.getName().equals(ConfigurationConstants.ADAPTED_FOLDER)) {
+      LOG.info("Found adapted folder no download of templates needed");
+      return;
+    }
+    // check if templates already exist
+    for (
+
+    MavenCoordinate mcoordinate : mavenCoordinates) {
+      if (templatesDirectory.listFiles().length > 0) {
+        for (File downloadedFile : templatesDirectory.listFiles()) {
+          if (!(downloadedFile.getName().contains(mcoordinate.getArtifactID()))) {
+            afterExistanceCheckList.add(mcoordinate);
+            LOG.info("Template specified in the properties file with ArtifactID: " + mcoordinate.getArtifactID()
+                + " GroupID:" + mcoordinate.getGroupID() + " will be loaded");
+          }
+        }
+      } else {
+        afterExistanceCheckList.add(mcoordinate);
+      }
+    }
+    // download templates
+    afterExistanceCheckList.toArray();
+    for (
+
+    MavenCoordinate mavenCoordinate : afterExistanceCheckList) {
+      downloadJar(mavenCoordinate.getGroupID(), mavenCoordinate.getArtifactID(), mavenCoordinate.getVersion(), false,
+          templatesDirectory);
+      downloadJar(mavenCoordinate.getGroupID(), mavenCoordinate.getArtifactID(), mavenCoordinate.getVersion(), true,
+          templatesDirectory);
+    }
+  }
+
   /**
    * Checks whether there is a newer version of the templates on Maven
    *

cobigen/cobigen-core-systemtest/src/test/java/com/devonfw/cobigen/systemtest/TemplatesInstallationTest.java

@@ -0,0 +1,98 @@
+package com.devonfw.cobigen.systemtest;
+
+import static com.github.stefanbirkner.systemlambda.SystemLambda.withEnvironmentVariable;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertThat;
+
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileWriter;
+import java.nio.file.Files;
+
+import org.hamcrest.Matchers;
+import org.junit.Test;
+
+import com.devonfw.cobigen.api.CobiGen;
+import com.devonfw.cobigen.api.constants.ConfigurationConstants;
+import com.devonfw.cobigen.impl.CobiGenFactory;
+import com.devonfw.cobigen.systemtest.common.AbstractApiTest;
+
+/**
+ * TODO
+ *
+ */
+public class TemplatesInstallationTest extends AbstractApiTest {
+
+  /**
+   * Tests that sources get overwritten if merge strategy override is configured.
+   *
+   * @throws Exception test fails.
+   */
+  @Test
+  public void testInstallTemplatesAtStartupOLD() throws Exception {
+
+    File folder = this.tmpFolder.newFolder("TemplateSetsInstalledTest");
+    withEnvironmentVariable(ConfigurationConstants.CONFIG_ENV_HOME, folder.getAbsolutePath()).execute(() -> {
+      File templates = this.tmpFolder.newFolder("TemplateSetsInstalledTest", ConfigurationConstants.TEMPLATES_FOLDER);
+      File cobigenDir = templates.toPath().resolve(ConfigurationConstants.COBIGEN_TEMPLATES).toFile();
+      Files.createDirectories(cobigenDir.toPath());
+      File target = new File(folder, ".cobigen");
+      BufferedWriter writer = new BufferedWriter(new FileWriter(target));
+      writer.write("template-sets.installed=com.devonfw.cobigen:templates-devon4j:2021.12.005");
+      writer.close();
+      CobiGen cobigen = CobiGenFactory.create(templates.toURI(), true);
+      assertEquals(2, cobigenDir.listFiles().length);
+      for (File f : cobigenDir.listFiles()) {
+        assertThat(f.getName(), Matchers.either(Matchers.is("templates-devon4j-2021.12.005.jar"))
+            .or(Matchers.is("templates-devon4j-2021.12.005-sources.jar")));
+      }
+    });
+  }
+
+  /**
+   * Tests that sources get overwritten if merge strategy override is configured.
+   *
+   * @throws Exception test fails.
+   */
+  @Test
+  public void testInstallTemplatesAtStartupNEW() throws Exception {
+
+    File folder = this.tmpFolder.newFolder("TemplateSetsInstalledTest");
+    withEnvironmentVariable(ConfigurationConstants.CONFIG_ENV_HOME, folder.getAbsolutePath()).execute(() -> {
+      File templateSets = this.tmpFolder.newFolder("TemplateSetsInstalledTest",
+          ConfigurationConstants.TEMPLATE_SETS_FOLDER);
+      File downloaded = this.tmpFolder.newFolder("TemplateSetsInstalledTest",
+          ConfigurationConstants.TEMPLATE_SETS_FOLDER, "downloaded");
+      File target = new File(folder, ".cobigen");
+      BufferedWriter writer = new BufferedWriter(new FileWriter(target));
+      writer.write("template-sets.installed=com.devonfw.cobigen:templates-devon4j:2021.12.006");
+      writer.close();
+      CobiGen cobigen = CobiGenFactory.create(templateSets.toURI());
+      assertEquals(2, downloaded.listFiles().length);
+      for (File f : downloaded.listFiles()) {
+        assertThat(f.getName(), Matchers.either(Matchers.is("templates-devon4j-2021.12.006.jar"))
+            .or(Matchers.is("templates-devon4j-2021.12.006-sources.jar")));
+      }
+    });
+
+  }
+
+  // ohne downloaded Ordner
+  // /**
+  // * Tests that sources get overwritten if merge strategy override is configured.
+  // *
+  // * @throws Exception test fails.
+  // */
+  // @Test
+  // public void testNOInstallAtStartup() throws Exception {
+  //
+  // File folder = this.tmpFolder.newFolder("TemplateSetsInstalledTest");
+  // withEnvironmentVariable(ConfigurationConstants.CONFIG_ENV_HOME, folder.getAbsolutePath()).execute(() -> {
+  // CobiGen cobigen = CobiGenFactory.create();
+  // Path templateSets = folder.toPath().resolve(ConfigurationConstants.TEMPLATE_SETS_FOLDER);
+  // assertEquals(templateSets.toFile().listFiles().length, 1);
+  // assertEquals(templateSets.resolve(ConfigurationConstants.DOWNLOADED_FOLDER).toFile().listFiles().length, 0);
+  // });
+  // }
+
+}

cobigen/cobigen-core/src/main/java/com/devonfw/cobigen/impl/CobiGenFactory.java

@@ -1,19 +1,28 @@
 package com.devonfw.cobigen.impl;
 
+import java.io.File;
+import java.io.IOException;
 import java.net.URI;
 import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Paths;
 import java.util.Objects;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import com.devonfw.cobigen.api.CobiGen;
 import com.devonfw.cobigen.api.HealthCheck;
+import com.devonfw.cobigen.api.constants.ConfigurationConstants;
+import com.devonfw.cobigen.api.exception.CobiGenRuntimeException;
 import com.devonfw.cobigen.api.exception.DeprecatedMonolithicConfigurationException;
 import com.devonfw.cobigen.api.exception.InvalidConfigurationException;
+import com.devonfw.cobigen.api.util.CobiGenPaths;
+import com.devonfw.cobigen.api.util.TemplatesJarUtil;
 import com.devonfw.cobigen.impl.aop.BeanFactory;
 import com.devonfw.cobigen.impl.aop.ProxyFactory;
 import com.devonfw.cobigen.impl.config.ConfigurationHolder;
+import com.devonfw.cobigen.impl.config.TemplateSetConfiguration;
 import com.devonfw.cobigen.impl.extension.PluginRegistry;
 import com.devonfw.cobigen.impl.healthcheck.HealthCheckImpl;
 import com.devonfw.cobigen.impl.util.ConfigurationClassLoaderUtil;
@@ -89,8 +98,25 @@ public static CobiGen create(URI configFileOrFolder, boolean allowMonolithicConf
     // Notifies all plugins of new template root path
     PluginRegistry.notifyPlugins(configurationHolder.getConfigurationPath());
 
-    if (!allowMonolithicConfiguration && !configurationHolder.isTemplateSetConfiguration())
+    if (!allowMonolithicConfiguration && !configurationHolder.isTemplateSetConfiguration()) {
       throw new DeprecatedMonolithicConfigurationException();
+    }
+    // install Template Sets defined in .properties file
+    TemplateSetConfiguration config = ConfigurationFinder.loadTemplateSetConfigurations(
+        CobiGenPaths.getCobiGenHomePath().resolve(ConfigurationConstants.COBIGEN_CONFIG_FILE));
+    URI templatesLocation = ConfigurationFinder.findTemplatesLocation();
+    File downloadPath = new File(templatesLocation);
+    if (configurationHolder.isTemplateSetConfiguration()) {
+      downloadPath = Paths.get(templatesLocation).resolve(ConfigurationConstants.DOWNLOADED_FOLDER).toFile();
+      if (!downloadPath.exists()) {
+        try {
+          Files.createDirectory(downloadPath.toPath());
+        } catch (IOException e) {
+          throw new CobiGenRuntimeException("Could not create Download Folder", e);
+        }
+      }
+      TemplatesJarUtil.downloadTemplatesByMavenCoordinates(downloadPath, config.getMavenCoordinates());
+    }
     return createBean;
   }
 
@@ -109,6 +135,7 @@ public static CobiGen create(boolean allowMonolithicConfiguration) throws Invali
       throw new InvalidConfigurationException(
           "No valid templates can be found. Please configure your cobigen configuration file properly or place the templates in cobigen home directory. Creating CobiGen instance aborted.");
     }
+
     return create(configFileOrFolder, allowMonolithicConfiguration);
   }