Enable model extensions (#359)

* Allow alternative ModelFactory implementations

* Table name for ModelClasses are now defined explicitely instead of implicitely from class name

* Enable copying of additional extension specific files when creating project file structure with "-wiz" option.

* Describe steps to extend Solicitor data model in user guide.

* clean up

* Add new entries to solicitor.dict

* Update release notes.

Author: ohecker

core/src/main/java/com/devonfw/tools/solicitor/ModelFactoryConfiguration.java

@@ -0,0 +1,44 @@
+package com.devonfw.tools.solicitor;
+
+import java.lang.reflect.InvocationTargetException;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import com.devonfw.tools.solicitor.common.SolicitorRuntimeException;
+import com.devonfw.tools.solicitor.model.ModelFactory;
+import com.devonfw.tools.solicitor.model.impl.ModelFactoryImpl;
+
+/**
+ * Configuration class to instantiate the ModelFactory implementation class configured via property
+ * "solicitor.modelfactory-classname". The configured class must be a subclass of {@link ModelFactoryImpl} and must have
+ * a default constructor. The instantiated ModelFactory is registered as a Spring bean and can thus be injected in other
+ * classes.
+ *
+ */
+@Configuration
+public class ModelFactoryConfiguration {
+
+  private String modelFactoryClassName;
+
+  @Value("${solicitor.modelfactory-classname}")
+  public void setModelFactoryClassName(String modelFactoryClassName) {
+
+    this.modelFactoryClassName = modelFactoryClassName;
+  }
+
+  @Bean
+  public ModelFactory modelFactory() {
+
+    try {
+      ModelFactoryImpl modelFactory = (ModelFactoryImpl) Class.forName(this.modelFactoryClassName).getConstructor()
+          .newInstance();
+      return modelFactory;
+    } catch (InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException
+        | NoSuchMethodException | SecurityException | ClassNotFoundException e) {
+      throw new SolicitorRuntimeException("Could not instantiate ModelFactory implementation class", e);
+    }
+  }
+
+}

core/src/main/java/com/devonfw/tools/solicitor/common/ResourceToFileCopier.java

@@ -36,6 +36,12 @@ public class ResourceToFileCopier {
   @Value("${solicitor.extension-userguide-target}")
   String extensionUserguideTarget;
 
+  @Value("${solicitor.extension-additionalprojectfiles-sources}")
+  String[] extensionAdditionalProjectFilesSources;
+
+  @Value("${solicitor.extension-additionalprojectfiles-targets}")
+  String[] extensionAdditionalProjectFilesTargets;
+
   /**
    * Represents a single copy operation to be performed
    */
@@ -226,7 +232,8 @@ public String copyReourcesToFile(ResourceGroup resourceGroup, String targetDir)
         returnString = "solicitor.cdx.json";
         break;
       case PROJECT_FILES:
-        new CopySequenceBuilder().withCopyOperation("classpath:starters/solicitor.cfg", "new_project/solicitor.cfg")
+        CopySequenceBuilder csb2 = new CopySequenceBuilder()
+            .withCopyOperation("classpath:starters/solicitor.cfg", "new_project/solicitor.cfg")
             .withCopyOperation("classpath:starters/input/licenses_starter.xml",
                 "new_project/input/licenses_starter.xml")
             .withCopyOperation("classpath:starters/rules/LegalEvaluationProject.xls",
@@ -241,8 +248,9 @@ public String copyReourcesToFile(ResourceGroup resourceGroup, String targetDir)
                 "new_project/rules/LicenseSelectionProject.xls")
             .withCopyOperation("classpath:starters/rules/MultiLicenseSelectionProject.xls",
                 "new_project/rules/MultiLicenseSelectionProject.xls")
-            .withCopyOperation("classpath:starters/readme.txt", "new_project/readme.txt")
-            .replaceInTarget("new_project", targetDir).execute();
+            .withCopyOperation("classpath:starters/readme.txt", "new_project/readme.txt");
+        optionallyAddExtensionFiles(csb2);
+        csb2.replaceInTarget("new_project", targetDir).execute();
         returnString = targetDir + "/readme.txt";
         break;
       case FULL_BASE_CONFIG:
@@ -282,6 +290,31 @@ private void optionallyAddExtensionUserguide(CopySequenceBuilder csb) {
     }
   }
 
+  /**
+   * Optionally add specific files from an existing Extension.
+   *
+   * @param csb builder to add the files to
+   */
+  private void optionallyAddExtensionFiles(CopySequenceBuilder csb) {
+
+    int sourcesCount = this.extensionAdditionalProjectFilesSources != null
+        ? this.extensionAdditionalProjectFilesSources.length
+        : 0;
+    int targetsCount = this.extensionAdditionalProjectFilesTargets != null
+        ? this.extensionAdditionalProjectFilesTargets.length
+        : 0;
+
+    if (sourcesCount != targetsCount) {
+      throw new SolicitorRuntimeException(
+          "Properties solicitor.extension-additionalprojectfiles-sources and solicitor.extension-additionalprojectfiles-targets "
+              + "need to contain the same number of comma separated values");
+    }
+    for (int i = 0; i < sourcesCount; i++) {
+      csb.withCopyOperation(this.extensionAdditionalProjectFilesSources[i],
+          this.extensionAdditionalProjectFilesTargets[i]);
+    }
+  }
+
   /**
    * Copies a single resource to the file system.
    *

core/src/main/java/com/devonfw/tools/solicitor/model/ModelFactory.java

@@ -2,6 +2,7 @@
 
 import java.util.Collection;
 
+import com.devonfw.tools.solicitor.model.impl.AbstractModelObject;
 import com.devonfw.tools.solicitor.model.inventory.ApplicationComponent;
 import com.devonfw.tools.solicitor.model.inventory.NormalizedLicense;
 import com.devonfw.tools.solicitor.model.inventory.RawLicense;
@@ -11,7 +12,7 @@
 /**
  * An abstract factory for creating objects of the Solicitor data model.
  */
-public abstract class ModelFactory {
+public interface ModelFactory {
 
   /**
    * Returns the collection of all objects of the model tree starting from the given
@@ -21,56 +22,64 @@ public abstract class ModelFactory {
    * @return a collection of {@link Object}s representing all objects of the model
    * @param modelRoot a {@link ModelRoot} object.
    */
-  public abstract Collection<Object> getAllModelObjects(ModelRoot modelRoot);
+  Collection<Object> getAllModelObjects(ModelRoot modelRoot);
+
+  /**
+   * Determine the table name for the given {@link AbstractModelObject} subtype.
+   *
+   * @param modelClass a class name of the {@link AbstractModelObject} subtype
+   * @return the table name for storing this to the reporting database
+   */
+  String determineTableName(Class<? extends AbstractModelObject> modelClass);
 
   /**
    * Creates a new {@link Application}
    *
    * @return the new instance
    */
-  public abstract Application newApplication();
+  Application newApplication();
 
   /**
    * Creates a new {@link ApplicationComponent}
    *
    * @return the new instance
    */
-  public abstract ApplicationComponent newApplicationComponent();
+  ApplicationComponent newApplicationComponent();
 
   /**
    * Creates a new {@link Engagement}
    *
    * @return the new instance
    */
-  public abstract Engagement newEngagement();
+  Engagement newEngagement();
 
   /**
    * Creates a {@link ModelRoot}.
    *
    * @return the new instance
    */
-  public abstract ModelRoot newModelRoot();
+  ModelRoot newModelRoot();
 
   /**
    * Creates a {@link NormalizedLicense}.
    *
    * @return the new instance
    */
-  public abstract NormalizedLicense newNormalizedLicense();
+  NormalizedLicense newNormalizedLicense();
 
   /**
    * Creates a {@link NormalizedLicense}.
    *
    * @param rawLicense a {@link RawLicense} object.
    * @return the new instance
    */
-  public abstract NormalizedLicense newNormalizedLicense(RawLicense rawLicense);
+  NormalizedLicense newNormalizedLicense(RawLicense rawLicense);
 
   /**
    * Creates a new {@link RawLicense}
    *
    * @return the new instance
    */
-  public abstract RawLicense newRawLicense();
+  RawLicense newRawLicense();
 
 }

core/src/main/java/com/devonfw/tools/solicitor/model/impl/ModelFactoryImpl.java

@@ -5,15 +5,16 @@
 
 import java.util.Collection;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.Map;
 import java.util.TreeMap;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.stereotype.Component;
 
 import com.devonfw.tools.solicitor.SolicitorVersion;
+import com.devonfw.tools.solicitor.common.SolicitorRuntimeException;
 import com.devonfw.tools.solicitor.common.content.InMemoryMapContentProvider;
 import com.devonfw.tools.solicitor.common.content.web.WebContent;
 import com.devonfw.tools.solicitor.model.ModelFactory;
@@ -32,16 +33,64 @@
  * Implementation of the {@link ModelFactory} interface. All model object created by this factory will be extensions of
  * {@link AbstractModelObject}.
  */
-@Component
-public class ModelFactoryImpl extends ModelFactory {
+public class ModelFactoryImpl implements ModelFactory {
   private static final Logger LOG = LoggerFactory.getLogger(ModelFactoryImpl.class);
 
-  @Autowired
   private InMemoryMapContentProvider<WebContent> licenseContentProvider;
 
-  @Autowired
   private SolicitorVersion solicitorVersion;
 
+  /** Map for looking up the table name for each model object class. */
+  private Map<Class<? extends AbstractModelObject>, String> tableNameMap = new HashMap<>();
+
+  /**
+   * The constructor.
+   */
+  public ModelFactoryImpl() {
+
+    super();
+    registerModelClass(ModelRootImpl.class, "MODELROOT");
+    registerModelClass(EngagementImpl.class, "ENGAGEMENT");
+    registerModelClass(ApplicationImpl.class, "APPLICATION");
+    registerModelClass(ApplicationComponentImpl.class, "APPLICATIONCOMPONENT");
+    registerModelClass(RawLicenseImpl.class, "RAWLICENSE");
+    registerModelClass(NormalizedLicenseImpl.class, "NORMALIZEDLICENSE");
+  }
+
+  /**
+   * This method registers the given model class with the given table name. This allows to use custom model classes
+   * (e.g. extensions of the default model classes) with custom (or preexisting) table names.
+   *
+   * @param modelClass the model class to register
+   * @param tableName the table name to register for this model class
+   */
+  public void registerModelClass(Class<? extends AbstractModelObject> modelClass, String tableName) {
+
+    this.tableNameMap.put(modelClass, tableName);
+  }
+
+  @Autowired
+  public void setLicenseContentProvider(InMemoryMapContentProvider<WebContent> licenseContentProvider) {
+
+    this.licenseContentProvider = licenseContentProvider;
+  }
+
+  public InMemoryMapContentProvider<WebContent> getLicenseContentProvider() {
+
+    return this.licenseContentProvider;
+  }
+
+  @Autowired
+  public void setSolicitorVersion(SolicitorVersion solicitorVersion) {
+
+    this.solicitorVersion = solicitorVersion;
+  }
+
+  public SolicitorVersion getSolicitorVersion() {
+
+    return this.solicitorVersion;
+  }
+
   /** {@inheritDoc} */
   @Override
   public Collection<Object> getAllModelObjects(ModelRoot modelRoot) {
@@ -71,6 +120,18 @@ public Collection<Object> getAllModelObjects(ModelRoot modelRoot) {
     return Collections.unmodifiableCollection(resultMap.values());
   }
 
+  /** {@inheritDoc} */
+  @Override
+  public String determineTableName(Class<? extends AbstractModelObject> modelClass) {
+
+    String tableName = this.tableNameMap.get(modelClass);
+    if (tableName == null) {
+      throw new SolicitorRuntimeException(
+          "No table name defined in ModelFactory for model class '" + modelClass.getName() + "'");
+    }
+    return tableName;
+  }
+
   /** {@inheritDoc} */
   @Override
   public ApplicationImpl newApplication() {

core/src/main/java/com/devonfw/tools/solicitor/writer/ResultDatabaseFactory.java

@@ -67,7 +67,7 @@ public class ResultDatabaseFactory {
   private void createTable(AbstractModelObject modelObject) {
 
     StringBuilder sb = new StringBuilder();
-    String name = determineTableName(modelObject.getClass());
+    String name = modelFactory.determineTableName(modelObject.getClass());
     sb.append("create table ").append(name).append(" ( ");
     for (String fields : modelObject.getHeadElements()) {
       sb.append("\"").append(fields).append("\" ").append("LONGVARCHAR, ");
@@ -93,17 +93,6 @@ private void createTable(AbstractModelObject modelObject) {
 
   }
 
-  /**
-   * Determine the table name for the given {@link AbstractModelObject} subtype.
-   *
-   * @param tableClass a class name of the {@link AbstractModelObject} subtype
-   * @return the table name for storing this to the reporting database
-   */
-  public String determineTableName(Class<? extends AbstractModelObject> tableClass) {
-
-    return tableClass.getSimpleName().toUpperCase().replace("IMPL", "");
-  }
-
   /**
    * Drop the database table which corresponds to the given {@link AbstractModelObject}.
    *
@@ -112,7 +101,7 @@ public String determineTableName(Class<? extends AbstractModelObject> tableClass
   private void dropExistingTable(Class<? extends AbstractModelObject> oneTable) {
 
     StringBuilder sb = new StringBuilder();
-    String name = determineTableName(oneTable);
+    String name = modelFactory.determineTableName(oneTable);
     sb.append("drop table ").append(name).append(";");
     LOG.debug("Dropping Reporting table '{}'", name);
     String sql = sb.toString();
@@ -270,7 +259,7 @@ public void saveToDatabase(AbstractModelObject modelObject) {
       createTable(modelObject);
     }
     StringBuilder sb = new StringBuilder();
-    String name = determineTableName(modelObject.getClass());
+    String name = modelFactory.determineTableName(modelObject.getClass());
     sb.append("insert into ").append(name).append(" values ( ");
     for (String fields : modelObject.getDataElements()) {
       sb.append("?").append(", ");

core/src/main/resources/application.properties

@@ -33,6 +33,9 @@ packageurls.nuget.repobaseurl=https://www.nuget.org/api/v2/package/
 # Base URL for accessing cran packages
 packageurls.cran.repobaseurl=https://cran.r-project.org/
 
+# The ModelFactory implementation class
+solicitor.modelfactory-classname=com.devonfw.tools.solicitor.model.impl.ModelFactoryImpl
+
 # the URL of the base config file
 solicitor.base-config-url=classpath:com/devonfw/tools/solicitor/config/solicitor_base.cfg
 
@@ -114,3 +117,8 @@ solicitor.extension-message-2=
 solicitor.extension-userguide-source=
 solicitor.extension-userguide-target=
 
+# source and target location of additional files to be copied from the extension if a project file structure
+# is created using the "-wiz" option. (comma separated list of source and target paths)
+solicitor.extension-additionalprojectfiles-sources=
+solicitor.extension-additionalprojectfiles-targets=
+