#1454 - GUI for Template Set Management

cobigen-cli/cli/pom.xml

@@ -13,6 +13,7 @@
 
   <properties>
     <skip.deployment>false</skip.deployment>
+    <javafx.version>18</javafx.version>
   </properties>
 
   <dependencies>
@@ -24,6 +25,10 @@
       <groupId>com.devonfw.cobigen</groupId>
       <artifactId>core-api</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.devonfw.cobigen</groupId>
+      <artifactId>gui</artifactId>
+    </dependency>
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>core-externalprocess-api</artifactId>
@@ -52,6 +57,16 @@
       <artifactId>google-java-format</artifactId>
       <version>1.10.0</version>
     </dependency>
+    <dependency>
+      <groupId>org.openjfx</groupId>
+      <artifactId>javafx-controls</artifactId>
+      <version>${javafx.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.openjfx</groupId>
+      <artifactId>javafx-fxml</artifactId>
+      <version>${javafx.version}</version>
+    </dependency>
   </dependencies>
 
   <build>

cobigen-cli/cli/src/main/java/com/devonfw/cobigen/cli/commands/CobiGenCommand.java

@@ -11,7 +11,7 @@
 
 @Command(description = MessagesConstants.WELCOME_MESSAGE, name = "cobigen", aliases = {
 "cg" }, mixinStandardHelpOptions = true, subcommands = { GenerateCommand.class, UpdateCommand.class,
-AdaptTemplatesCommand.class }, versionProvider = CobiGenVersionProvider.class)
+AdaptTemplatesCommand.class, ManageCommand.class }, versionProvider = CobiGenVersionProvider.class)
 public class CobiGenCommand implements Runnable {
 
   @Override

cobigen-cli/cli/src/main/java/com/devonfw/cobigen/cli/commands/ManageCommand.java

@@ -0,0 +1,44 @@
+package com.devonfw.cobigen.cli.commands;
+
+import java.util.concurrent.TimeUnit;
+
+import com.devonfw.cobigen.gui.AppLauncher;
+
+import picocli.CommandLine.Command;
+
+/**
+ * This class handles the manage template sets command
+ */
+@Command(description = "Opens GUI for Template Set Management", name = "manage", aliases = {
+"m" }, mixinStandardHelpOptions = true)
+public class ManageCommand extends CommandCommons {
+
+  public AppLauncher launcher;
+
+  /**
+   * Constructor needed for Picocli
+   */
+  public ManageCommand() {
+
+    super();
+  }
+
+  @Override
+  public synchronized Integer doAction() throws Exception {
+
+    System.out.println("You just called the GUI");
+    this.launcher = new AppLauncher();
+    try {
+      wait(1337);
+    } catch (InterruptedException e) {
+      e.printStackTrace();
+    }
+
+    while (this.launcher.app.window.isShowing()) {
+      TimeUnit.SECONDS.sleep(1);
+    }
+
+    return 0;
+  }
+
+}

cobigen-eclipse/cobigen-eclipse-feature/pom.xml

@@ -11,4 +11,9 @@
     <artifactId>eclipse-parent</artifactId>
     <version>${revision}</version>
   </parent>
+
+  <properties>
+    <skip.deployment>false</skip.deployment>
+  </properties>
+
 </project>

cobigen-eclipse/cobigen-eclipse-test/pom.xml

@@ -12,7 +12,6 @@
 
   <properties>
     <tycho.testArgLine.enriched>${surefireArgLineIntegration} -Xms512m -Xmx2048m -XX:+DisableExplicitGC</tycho.testArgLine.enriched>
-    <enforcer.skip>true</enforcer.skip>
   </properties>
 
   <dependencies>
@@ -24,6 +23,10 @@
       <groupId>com.devonfw.cobigen</groupId>
       <artifactId>core-api</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.devonfw.cobigen</groupId>
+      <artifactId>gui</artifactId>
+    </dependency>
     <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-classic</artifactId>

cobigen-eclipse/cobigen-eclipse-test/src/main/java/com/devonfw/cobigen/eclipse/test/OpenGUITest.java

@@ -0,0 +1,59 @@
+package com.devonfw.cobigen.eclipse.test;
+
+import java.io.File;
+
+import org.apache.commons.io.FileUtils;
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.runtime.NullProgressMonitor;
+import org.eclipse.jdt.core.IJavaProject;
+import org.eclipse.swtbot.swt.finder.junit.SWTBotJunit4ClassRunner;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import com.devonfw.cobigen.eclipse.test.common.SystemTest;
+import com.devonfw.cobigen.eclipse.test.common.utils.EclipseCobiGenUtils;
+import com.devonfw.cobigen.eclipse.test.common.utils.EclipseUtils;
+
+/**
+ * Class for testing Manage Template Sets with a click on the Home Button
+ *
+ */
+@RunWith(SWTBotJunit4ClassRunner.class)
+public class OpenGUITest extends SystemTest {
+
+  /** Root path of the Test Resources */
+  private static final String resourcesRootPath = "src/main/resources/OpenAPITest/";
+
+  /**
+   * Setup workbench appropriately for tests
+   *
+   * @throws Exception test fails
+   */
+  @BeforeClass
+  public static void setupClass() throws Exception {
+
+    EclipseUtils.cleanWorkspace(bot, true);
+  }
+
+  /**
+   * Testing to open the Template Set Management GUI and clicking Home Button
+   *
+   * @throws Exception test fails
+   */
+  @Test
+  public void testOpenTemplateSetManagementGUI() throws Exception {
+
+    // copy sample project to external location and import it into the workspace
+    String testProjName = "ExtTestProj";
+    IJavaProject project = this.tmpMavenProjectRule.createProject(testProjName);
+    FileUtils.copyFile(new File(resourcesRootPath + "input/adapt-templates.yml"),
+        project.getUnderlyingResource().getLocation().append("adapt-templates.yml").toFile());
+    project.getProject().refreshLocal(IResource.DEPTH_INFINITE, new NullProgressMonitor());
+    this.tmpMavenProjectRule.updateProject();
+
+    // open GUI
+    EclipseCobiGenUtils.runAndCaptureManageTemplateSets(bot);
+  }
+
+}

cobigen-eclipse/cobigen-eclipse-test/src/main/java/com/devonfw/cobigen/eclipse/test/common/utils/EclipseCobiGenUtils.java

@@ -402,6 +402,28 @@ public static void runAndCaptureAdaptTemplates(SWTWorkbenchBot bot) throws Excep
     informationDialog.bot().button("Ok").click();
   }
 
+  /**
+   * Checks the CobiGen Manage Template Sets and takes screenshots of it.
+   *
+   * @param bot to process the Manage Template Sets command
+   * @throws Exception test fails
+   */
+  public static void runAndCaptureManageTemplateSets(SWTWorkbenchBot bot) throws Exception {
+
+    ResourcesPlugin.getWorkspace().build(IncrementalProjectBuilder.FULL_BUILD, new NullProgressMonitor());
+    bot.waitUntil(new AllJobsAreFinished(), DEFAULT_TIMEOUT); // build might take some time
+
+    SWTBotView view = bot.viewById(JavaUI.ID_PACKAGES);
+    view.bot().tree().contextMenu("CobiGen").menu("Manage Template Sets...").click();
+
+    // TODO
+    // bot.waitUntil(new AnyShellIsActive("Template Set Manager"), DEFAULT_TIMEOUT);
+    // takeScreenshot(bot, "Template Set Manager");
+    // SWTBotShell gui = bot.shell("Template Set Manager");
+    // gui.bot().button("#homeButton").click();
+
+  }
+
   /**
    * Takes a screenshot (*.jpeg) of the current screen encoding test method and class and appends the given identifier
    * to the file name

cobigen-eclipse/cobigen-eclipse/build.properties

@@ -53,4 +53,13 @@ bin.includes = .,\
                lib/plexus-utils.jar,\
                lib/slf4j-api.jar,\
                lib/txw2.jar,\
-               lib/zt-exec.jar
+               lib/zt-exec.jar,\
+               lib/gui.jar,\
+               lib/javafx-base.jar,\
+               lib/javafx-base-win.jar,\
+               lib/javafx-controls.jar,\
+               lib/javafx-controls-win.jar,\
+               lib/javafx-fxml.jar,\
+               lib/javafx-fxml-win.jar,\
+               lib/javafx-graphics.jar,\
+               lib/javafx-graphics-win.jar

cobigen-eclipse/cobigen-eclipse/plugin.xml

@@ -19,6 +19,10 @@
             id="com.devonfw.cobigen.eclipseplugin.adapt_template"
             name="Adapt Template">
       </command>
+      <command
+            id="com.devonfw.cobigen.eclipseplugin.manage_template_sets"
+            name="Manage Template Sets">
+      </command>
    </extension>
    <extension
          point="org.eclipse.ui.handlers">
@@ -38,6 +42,10 @@
             class="com.devonfw.cobigen.eclipse.workbenchcontrol.handler.AdaptTemplatesHandler"
             commandId="com.devonfw.cobigen.eclipseplugin.adapt_template">
       </handler>
+      <handler
+            class="com.devonfw.cobigen.eclipse.workbenchcontrol.handler.ManageTemplateSetsHandler"
+            commandId="com.devonfw.cobigen.eclipseplugin.manage_template_sets">
+      </handler>
    </extension>
    <extension
          point="org.eclipse.ui.menus">
@@ -70,6 +78,11 @@
                    label="Adapt Templates..."
                    style="push">
              </command>
+             <command
+                   commandId="com.devonfw.cobigen.eclipseplugin.manage_template_sets"
+                   label="Manage Template Sets..."
+                   style="push">
+             </command>
           </menu>
           <separator
                 name="com.devonfw.cobigen.eclipseplugin.separator2"
@@ -105,6 +118,11 @@
                    label="Adapt Templates..."
                    style="push">
              </command>
+             <command
+                   commandId="com.devonfw.cobigen.eclipseplugin.manage_template_sets"
+                   label="Manage Template Sets..."
+                   style="push">
+             </command>
           </menu>
           <separator
                 name="com.devonfw.cobigen.eclipseplugin.separator4"
@@ -140,6 +158,11 @@
                    label="Adapt Templates..."
                    style="push">
              </command>
+             <command
+                   commandId="com.devonfw.cobigen.eclipseplugin.manage_template_sets"
+                   label="Manage Template Sets..."
+                   style="push">
+             </command>
              <visibleWhen
                    checkEnabled="false">
                    <with variable="selection">

cobigen-eclipse/cobigen-eclipse/pom.xml

@@ -24,6 +24,10 @@
       <groupId>com.devonfw.cobigen</groupId>
       <artifactId>core-externalprocess-api</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.devonfw.cobigen</groupId>
+      <artifactId>gui</artifactId>
+    </dependency>
     <dependency>
       <groupId>com.devonfw.cobigen</groupId>
       <artifactId>javaplugin-model</artifactId>

cobigen-eclipse/cobigen-eclipse/src/com/devonfw/cobigen/eclipse/workbenchcontrol/handler/ManageTemplateSetsHandler.java

@@ -0,0 +1,52 @@
+package com.devonfw.cobigen.eclipse.workbenchcontrol.handler;
+
+import java.util.concurrent.TimeUnit;
+
+import org.eclipse.core.commands.AbstractHandler;
+import org.eclipse.core.commands.ExecutionEvent;
+import org.eclipse.core.commands.ExecutionException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.devonfw.cobigen.gui.AppLauncher;
+
+/**
+ * Handler for the Package-Explorer Event
+ *
+ */
+public class ManageTemplateSetsHandler extends AbstractHandler {
+
+  /**
+   * Assigning logger to ManageTemplateSetsHandler
+   */
+  private static final Logger LOG = LoggerFactory.getLogger(ManageTemplateSetsHandler.class);
+
+  /**
+   * Launcher for GUI
+   */
+  public AppLauncher launcher;
+
+  @Override
+  public Object execute(ExecutionEvent event) throws ExecutionException {
+
+    System.out.println("You just called the GUI");
+    this.launcher = new AppLauncher();
+    try {
+      wait(1337);
+    } catch (InterruptedException e) {
+      e.printStackTrace();
+    }
+
+    while (this.launcher.app.window.isShowing()) {
+      try {
+        TimeUnit.SECONDS.sleep(1);
+      } catch (InterruptedException e) {
+        e.printStackTrace();
+      }
+    }
+
+    return null;
+
+  }
+
+}

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

@@ -134,4 +134,6 @@ public class ConfigurationConstants {
    */
   public static final String CONFIG_PROPERTY_TEMPLATE_SETS_DEFAULT_VERSION = "2021.12.007";
 
+  public static final String TEMPLATE_SET_ARTIFACT_CACHE_FOLDER = "template-set-list";
+
 }

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

@@ -1,11 +1,12 @@
 package com.devonfw.cobigen.api.util;
 
+import java.util.Arrays;
 import java.util.Objects;
 
 /**
  * This MavenCoordinate class is just a dataholder with maven coordinates.
  */
-public class MavenCoordinate {
+public class MavenCoordinate implements Comparable<MavenCoordinate> {
 
   /**
    * the groupId of the maven artifact
@@ -86,4 +87,22 @@ public boolean equals(Object obj) {
         && Objects.equals(this.version, other.version);
   }
 
+  @Override
+  public int compareTo(MavenCoordinate other) {
+
+    if (!this.artifactId.equals(other.artifactId)) {
+      throw new ClassCastException("The artifactID of the comprarable should be the same");
+      // TODO
+    }
+    int[] versionNumbersCurrent = Arrays.stream(this.version.split("\\.")).mapToInt(Integer::parseInt).toArray();
+    int[] versionNumbersOther = Arrays.stream(other.getVersion().split("\\.")).mapToInt(Integer::parseInt).toArray();
+    for (int i = 0; i < versionNumbersCurrent.length; i++) {
+      if (versionNumbersCurrent[i] > versionNumbersOther[i]) {
+        return 1;
+      } else if (versionNumbersCurrent[i] < versionNumbersOther[i])
+        return -1;
+    }
+    return 0;
+  }
+
 }