Added testing for entity manager in pool generation, showed message if generator handler is incorrect, fixed open file flag ignored

Author: bohdan-harniuk

Diff for: resources/magento2/exception.properties

@@ -0,0 +1,3 @@
+exception.common.checkLogg=Please, check logging console to get full exception stack trace.
+exception.reflection.cannotInstantiate=Couldn't instantiate class: {0}
+exception.NoSuchMethod=Method {0} not found for class {1}. You should implement it.

Diff for: src/com/magento/idea/magento2plugin/actions/generation/data/dialog/EntityManagerContextData.java

@@ -20,6 +20,7 @@ public class EntityManagerContextData implements GenerationContextData {
     private final Project project;
     private final String moduleName;
     private final String actionName;
+    private final boolean hasOpenFileFlag;
     private final String indexViewAction;
     private final String editViewAction;
     private final String newViewAction;
@@ -52,6 +53,7 @@ public class EntityManagerContextData implements GenerationContextData {
      * @param project Project
      * @param moduleName String
      * @param actionName String
+     * @param hasOpenFileFlag boolean
      * @param indexViewAction String
      * @param editViewAction String
      * @param newViewAction String
@@ -83,6 +85,7 @@ public EntityManagerContextData(
             final @NotNull Project project,
             final @NotNull String moduleName,
             final @NotNull String actionName,
+            final boolean hasOpenFileFlag,
             final @NotNull String indexViewAction,
             final @NotNull String editViewAction,
             final @NotNull String newViewAction,
@@ -112,6 +115,7 @@ public EntityManagerContextData(
         this.project = project;
         this.moduleName = moduleName;
         this.actionName = actionName;
+        this.hasOpenFileFlag = hasOpenFileFlag;
         this.indexViewAction = indexViewAction;
         this.editViewAction = editViewAction;
         this.newViewAction = newViewAction;
@@ -154,6 +158,11 @@ public String getActionName() {
         return actionName;
     }
 
+    @Override
+    public boolean hasOpenFileFlag() {
+        return hasOpenFileFlag;
+    }
+
     /**
      * Get index action.
      *

Diff for: src/com/magento/idea/magento2plugin/actions/generation/data/dialog/GenerationContextData.java

@@ -32,4 +32,11 @@ public interface GenerationContextData {
      * @return String
      */
     String getActionName();
+
+    /**
+     * Check if files should be opened after generation.
+     *
+     * @return boolean
+     */
+    boolean hasOpenFileFlag();
 }

Diff for: src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEntityDialog.java

@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.actions.generation.generator;
 
 import com.intellij.openapi.project.Project;
@@ -13,24 +14,32 @@ public abstract class FileGenerator {
     private final Project project;
     private final NavigateToCreatedFile navigateToCreatedFile;
 
-    public FileGenerator(Project project)
-    {
+    public FileGenerator(final Project project) {
         this.project = project;
         this.navigateToCreatedFile = NavigateToCreatedFile.getInstance();
     }
 
-    public abstract PsiFile generate(String actionName);
+    public abstract PsiFile generate(final String actionName);
+
+    /**
+     * Generate file.
+     *
+     * @param actionName String
+     * @param openFile boolean
+     *
+     * @return PsiFile
+     */
+    public PsiFile generate(final String actionName, final boolean openFile) {
+        final PsiFile file = this.generate(actionName);
 
-    public PsiFile generate(String actionName, boolean openFile) {
-        PsiFile file = this.generate(actionName);
-        if (file != null) {
+        if (file != null && openFile) {
             navigateToCreatedFile.navigate(project, file);
         }
         return file;
     }
 
     protected Properties getAttributes() {
-        Properties attributes = new Properties();
+        final Properties attributes = new Properties();
         this.fillAttributes(attributes);
         return attributes;
     }

Diff for: src/com/magento/idea/magento2plugin/actions/generation/generator/FileGenerator.java

@@ -8,14 +8,15 @@
 import com.intellij.openapi.project.Project;
 import com.magento.idea.magento2plugin.actions.generation.data.converter.DataObjectConverter;
 import com.magento.idea.magento2plugin.actions.generation.data.dialog.GenerationContextData;
-
+import com.magento.idea.magento2plugin.actions.generation.generator.FileGenerator;
 import org.jetbrains.annotations.NotNull;
 
 public abstract class GeneratorHandler {
 
     private final GenerationContextData contextData;
     private final DataObjectConverter dataObjectConverter;
     private final GeneratorRunnerValidator runnerValidator;
+    private FileGenerator generator;
 
     /**
      * Generator handler constructor.
@@ -60,9 +61,26 @@ public boolean validate() {
     }
 
     /**
-     * Run chain of generators.
+     * Instantiate and retrieve generator.
+     * Must be separated from generate method to test converter type casting.
+     */
+    public abstract void instantiateGenerator();
+
+    /**
+     * Set generator.
+     *
+     * @param generator FileGenerator
+     */
+    public void setGenerator(final FileGenerator generator) {
+        this.generator = generator;
+    }
+
+    /**
+     * Run generator.
      */
-    public abstract void generate();
+    public final void generate() {
+        generator.generate(getContextData().getActionName(), getContextData().hasOpenFileFlag());
+    }
 
     /**
      * Get project.

Diff for: src/com/magento/idea/magento2plugin/actions/generation/generator/pool/GeneratorHandler.java

@@ -5,17 +5,26 @@
 
 package com.magento.idea.magento2plugin.actions.generation.generator.pool;
 
+import com.intellij.openapi.diagnostic.Logger;
 import com.magento.idea.magento2plugin.actions.generation.data.converter.DataObjectConverter;
 import com.magento.idea.magento2plugin.actions.generation.data.dialog.GenerationContextData;
+import com.magento.idea.magento2plugin.bundles.ExceptionBundle;
 import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.concurrent.atomic.AtomicInteger;
+import java.util.stream.Collectors;
+import javax.swing.JOptionPane;
 import org.jetbrains.annotations.NotNull;
 
 public final class GeneratorPoolHandler {
 
+    private static final Logger LOGGER = Logger.getInstance(GeneratorPoolHandler.class);
     private final GenerationContextData contextData;
     private final List<GeneratorHandler> pool;
+    private final ExceptionBundle exceptionBundle;
+    private final List<String> errors;
 
     /**
      * Generator pool handler constructor.
@@ -25,6 +34,8 @@ public final class GeneratorPoolHandler {
     public GeneratorPoolHandler(final @NotNull GenerationContextData contextData) {
         this.contextData = contextData;
         pool = new LinkedList<>();
+        exceptionBundle = new ExceptionBundle();
+        errors = new LinkedList<>();
     }
 
     /**
@@ -85,9 +96,31 @@ public <T extends GeneratorHandler> GeneratorPoolHandler addNext(
                 pool.add(handlerClassConstructor
                         .newInstance(contextData, dataObjectConverter, runnerValidator));
             }
+        } catch (InstantiationException | IllegalAccessException
+                | InvocationTargetException exception) {
+            LOGGER.error(exception.getMessage());
+            errors.add(this.exceptionBundle.message(
+                    "exception.reflection.cannotInstantiate",
+                    handlerClass.getSimpleName()
+            ));
+        } catch (NoSuchMethodException noSuchMethodException) {
+            // This error can be caused if Handler class realization
+            // doesn't have constructor with all required arguments.
+            final String constructorDescWithTwoArgs = handlerClass.getSimpleName()
+                    + " with arguments " + GenerationContextData.class.getSimpleName()
+                    + ", " + DataObjectConverter.class.getSimpleName();
+            final String constructorDescWithThreeArgs = handlerClass.getSimpleName()
+                    + " with arguments " + GenerationContextData.class.getSimpleName() + ", "
+                    + DataObjectConverter.class.getSimpleName() + ", "
+                    + GeneratorRunnerValidator.class.getSimpleName();
 
-        } catch (Exception exception) {
-            //
+            LOGGER.error(noSuchMethodException.getMessage());
+            errors.add(this.exceptionBundle.message(
+                    "exception.NoSuchMethod",
+                    runnerValidator == null ? constructorDescWithTwoArgs
+                            : constructorDescWithThreeArgs,
+                    handlerClass.getSimpleName()
+            ));
         }
 
         return this;
@@ -97,10 +130,58 @@ public <T extends GeneratorHandler> GeneratorPoolHandler addNext(
      * Trigger generation process.
      */
     public void run() {
+        if (hasErrorMessages()) {
+            showErrorMessages();
+            return;
+        }
         for (final GeneratorHandler handler : pool) {
+            handler.instantiateGenerator();
+
             if (handler.validate()) {
                 handler.generate();
             }
         }
     }
+
+    /**
+     * Instantiate all generators.
+     */
+    public void instantiateAllGenerators() {
+        for (final GeneratorHandler handler : pool) {
+            handler.instantiateGenerator();
+        }
+    }
+
+    /**
+     * Check if Generator Pool Handler has any error messages.
+     *
+     * @return boolean
+     */
+    public boolean hasErrorMessages() {
+        return !errors.isEmpty();
+    }
+
+    /**
+     * Show error messages for the user.
+     * Those errors are system and must be processed by the dev during the testing.
+     * They cannot go to live.
+     */
+    private void showErrorMessages() {
+        if (!errors.isEmpty()) {
+            final String title = this.exceptionBundle.message(
+                    "exception.common.checkLogg"
+            );
+            final AtomicInteger messageNum = new AtomicInteger(1);
+            final String errorMessage = errors.stream()
+                    .map(message -> messageNum.getAndIncrement() + ". " + message)
+                    .collect(Collectors.joining("\n"));
+
+            JOptionPane.showMessageDialog(
+                    null,
+                    errorMessage,
+                    title,
+                    JOptionPane.ERROR_MESSAGE
+            );
+        }
+    }
 }

Diff for: src/com/magento/idea/magento2plugin/actions/generation/generator/pool/GeneratorPoolHandler.java

@@ -44,11 +44,11 @@ public AclXmlGeneratorHandler(
     }
 
     @Override
-    public void generate() {
-        new AclXmlGenerator(
+    public void instantiateGenerator() {
+        setGenerator(new AclXmlGenerator(
                 (AclXmlData) getDataObjectConverter(),
                 getContextData().getModuleName(),
                 getProject()
-        ).generate(getContextData().getActionName(), true);
+        ));
     }
 }

Diff for: src/com/magento/idea/magento2plugin/actions/generation/generator/pool/handler/AclXmlGeneratorHandler.java

@@ -44,10 +44,10 @@ public CollectionModelGeneratorHandler(
     }
 
     @Override
-    public void generate() {
-        new ModuleCollectionGenerator(
+    public void instantiateGenerator() {
+        setGenerator(new ModuleCollectionGenerator(
                 (CollectionData) getDataObjectConverter(),
                 getProject()
-        ).generate(getContextData().getActionName(), true);
+        ));
     }
 }

Diff for: src/com/magento/idea/magento2plugin/actions/generation/generator/pool/handler/CollectionModelGeneratorHandler.java

@@ -44,10 +44,10 @@ public DataModelGeneratorHandler(
     }
 
     @Override
-    public void generate() {
-        new DataModelGenerator(
+    public void instantiateGenerator() {
+        setGenerator(new DataModelGenerator(
                 getProject(),
                 (DataModelData) getDataObjectConverter()
-        ).generate(getContextData().getActionName(), true);
+        ));
     }
 }

Diff for: src/com/magento/idea/magento2plugin/actions/generation/generator/pool/handler/DataModelGeneratorHandler.java

@@ -44,10 +44,10 @@ public DataModelInterfaceGeneratorHandler(
     }
 
     @Override
-    public void generate() {
-        new DataModelInterfaceGenerator(
+    public void instantiateGenerator() {
+        setGenerator(new DataModelInterfaceGenerator(
                 getProject(),
                 (DataModelInterfaceData) getDataObjectConverter()
-        ).generate(getContextData().getActionName(), true);
+        ));
     }
 }

Diff for: src/com/magento/idea/magento2plugin/actions/generation/generator/pool/handler/DataModelInterfaceGeneratorHandler.java

@@ -44,10 +44,10 @@ public DataModelPreferenceGeneratorHandler(
     }
 
     @Override
-    public void generate() {
-        new PreferenceDiXmlGenerator(
+    public void instantiateGenerator() {
+        setGenerator(new PreferenceDiXmlGenerator(
                 (PreferenceDiXmFileData) getDataObjectConverter(),
                 getProject()
-        ).generate(getContextData().getActionName(), true);
+        ));
     }
 }

Diff for: src/com/magento/idea/magento2plugin/actions/generation/generator/pool/handler/DataModelPreferenceGeneratorHandler.java

@@ -44,11 +44,11 @@ public DataProviderGeneratorHandler(
     }
 
     @Override
-    public void generate() {
-        new UiComponentDataProviderGenerator(
+    public void instantiateGenerator() {
+        setGenerator(new UiComponentDataProviderGenerator(
                 (UiComponentDataProviderData) getDataObjectConverter(),
                 getContextData().getModuleName(),
                 getProject()
-        ).generate(getContextData().getActionName(), true);
+        ));
     }
 }

Diff for: src/com/magento/idea/magento2plugin/actions/generation/generator/pool/handler/DataProviderGeneratorHandler.java

@@ -44,11 +44,11 @@ public DbSchemaWhitelistGeneratorHandler(
     }
 
     @Override
-    public void generate() {
-        new DbSchemaWhitelistJsonGenerator(
+    public void instantiateGenerator() {
+        setGenerator(new DbSchemaWhitelistJsonGenerator(
                 getProject(),
                 (DbSchemaXmlData) getDataObjectConverter(),
                 getContextData().getModuleName()
-        ).generate(getContextData().getActionName(), true);
+        ));
     }
 }

Diff for: src/com/magento/idea/magento2plugin/actions/generation/generator/pool/handler/DbSchemaWhitelistGeneratorHandler.java

@@ -44,11 +44,11 @@ public DbSchemaXmlGeneratorHandler(
     }
 
     @Override
-    public void generate() {
-        new DbSchemaXmlGenerator(
+    public void instantiateGenerator() {
+        setGenerator(new DbSchemaXmlGenerator(
                 (DbSchemaXmlData) getDataObjectConverter(),
                 getProject(),
                 getContextData().getModuleName()
-        ).generate(getContextData().getActionName(), true);
+        ));
     }
 }