Merge pull request #181 from magento/cover-cronjob-generator-by-integration-test

Vitaliy · web-flow · commit 2c966248c37c · 2020-04-20T16:33:22.000+03:00
Covered Cron Job Generator by an Integration test
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/CronjobClassGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/CronjobClassGenerator.java
@@ -8,18 +8,13 @@
 import com.intellij.psi.PsiDirectory;
 import com.intellij.psi.PsiFile;
 import com.jetbrains.php.lang.psi.PhpFile;
-import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.actions.generation.data.CronjobClassData;
 import com.magento.idea.magento2plugin.actions.generation.generator.util.DirectoryGenerator;
 import com.magento.idea.magento2plugin.actions.generation.generator.util.FileFromTemplateGenerator;
 import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
 import com.magento.idea.magento2plugin.indexes.ModuleIndex;
 import com.magento.idea.magento2plugin.magento.files.CronjobTemplate;
-import com.magento.idea.magento2plugin.util.GetPhpClassByFQN;
 import org.jetbrains.annotations.NotNull;
-
-import javax.swing.*;
-import java.io.File;
 import java.util.Properties;
 
 public class CronjobClassGenerator extends FileGenerator {
@@ -79,14 +74,14 @@ protected void fillAttributes(Properties attributes) {
     /**
      * Generate Cronjob Class according to data model
      *
-     * @param String actionName
+     * @param actionName
      *
      * @return PhpFile
      */
     private PhpFile createCronjobClass(String actionName) {
         String cronjobClassName = this.cronjobClassData.getClassName();
         String moduleName = this.cronjobClassData.getModuleName();
-        String[] cronjobSubDirectories = this.cronjobClassData.getDirectory().split(File.separator);
+        String[] cronjobSubDirectories = this.cronjobClassData.getDirectory().split("/");
         PsiDirectory parentDirectory = ModuleIndex.getInstance(project).getModuleDirectoryByModuleName(moduleName);
 
         for (String cronjobSubDirectory: cronjobSubDirectories) {
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/CrontabXmlGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/CrontabXmlGenerator.java
@@ -22,7 +22,6 @@
 import com.magento.idea.magento2plugin.magento.files.CrontabXmlTemplate;
 import com.magento.idea.magento2plugin.util.xml.XmlPsiTreeUtil;
 import org.jetbrains.annotations.NotNull;
-
 import java.io.IOException;
 import java.util.Collection;
 import java.util.Properties;
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/ModuleBlockClassGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/ModuleBlockClassGenerator.java
@@ -20,7 +20,6 @@
 import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
 import org.jetbrains.annotations.NotNull;
 import javax.swing.*;
-import java.io.File;
 import java.util.Properties;
 
 public class ModuleBlockClassGenerator extends FileGenerator {
@@ -69,7 +68,7 @@ private String getBlockFqn() {
     private PhpFile createBlockClass(String actionName) {
         PsiDirectory parentDirectory = ModuleIndex.getInstance(project)
                 .getModuleDirectoryByModuleName(getBlockModule());
-        String[] blockDirectories = blockFileData.getBlockDirectory().split(File.separator);
+        String[] blockDirectories = blockFileData.getBlockDirectory().split("/");
         for (String blockDirectory: blockDirectories) {
             parentDirectory = directoryGenerator.findOrCreateSubdirectory(parentDirectory, blockDirectory);
         }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/ModuleGraphQlResolverClassGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/ModuleGraphQlResolverClassGenerator.java
@@ -27,9 +27,7 @@
 import com.magento.idea.magento2plugin.util.GetPhpClassByFQN;
 import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
 import org.jetbrains.annotations.NotNull;
-
 import javax.swing.*;
-import java.io.File;
 import java.util.Properties;
 
 public class ModuleGraphQlResolverClassGenerator extends FileGenerator {
@@ -107,7 +105,7 @@ private int getInsertPos(PhpClass graphQlResolverClass) {
     private PhpClass createGraphQlResolverClass(String actionName) {
         PsiDirectory parentDirectory = ModuleIndex.getInstance(project)
                 .getModuleDirectoryByModuleName(graphQlResolverFileData.getGraphQlResolverModule());
-        String[] graphQlResolverDirectories = graphQlResolverFileData.getGraphQlResolverDirectory().split(File.separator);
+        String[] graphQlResolverDirectories = graphQlResolverFileData.getGraphQlResolverDirectory().split("/");
         for (String graphQlResolverDirectory: graphQlResolverDirectories) {
             parentDirectory = directoryGenerator.findOrCreateSubdirectory(parentDirectory, graphQlResolverDirectory);
         }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/ModuleViewModelClassGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/ModuleViewModelClassGenerator.java
@@ -19,7 +19,6 @@
 import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
 import org.jetbrains.annotations.NotNull;
 import javax.swing.*;
-import java.io.File;
 import java.util.Properties;
 
 public class ModuleViewModelClassGenerator extends FileGenerator {
@@ -66,7 +65,7 @@ private String getViewModelFqn() {
     private PhpFile createViewModelClass(String actionName) {
         PsiDirectory parentDirectory = ModuleIndex.getInstance(project)
                 .getModuleDirectoryByModuleName(getViewModelModule());
-        String[] viewModelDirectories = viewModelFileData.getViewModelDirectory().split(File.separator);
+        String[] viewModelDirectories = viewModelFileData.getViewModelDirectory().split("/");
         for (String viewModelDirectory: viewModelDirectories) {
             parentDirectory = directoryGenerator.findOrCreateSubdirectory(parentDirectory, viewModelDirectory);
         }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/ObserverClassGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/ObserverClassGenerator.java
@@ -1,3 +1,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.command.WriteCommandAction;
@@ -23,7 +27,6 @@
 import com.magento.idea.magento2plugin.util.GetPhpClassByFQN;
 import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
 import javax.swing.*;
-import java.io.File;
 import java.util.Properties;
 
 public class ObserverClassGenerator extends FileGenerator {
@@ -109,7 +112,7 @@ private int getInsertPos(PhpClass observerClass) {
     private PhpClass createObserverClass(String actionName) {
         PsiDirectory parentDirectory = ModuleIndex.getInstance(project)
                 .getModuleDirectoryByModuleName(observerFileData.getObserverModule());
-        String[] observerDirectories = observerFileData.getObserverDirectory().split(File.separator);
+        String[] observerDirectories = observerFileData.getObserverDirectory().split("/");
         for (String observerDirectory: observerDirectories) {
             parentDirectory = directoryGenerator.findOrCreateSubdirectory(parentDirectory, observerDirectory);
         }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/ObserverEventsXmlGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/ObserverEventsXmlGenerator.java
@@ -1,3 +1,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.command.WriteCommandAction;
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/PluginClassGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/PluginClassGenerator.java
@@ -38,7 +38,6 @@
 import gnu.trove.THashSet;
 import org.jetbrains.annotations.NotNull;
 import javax.swing.*;
-import java.io.File;
 import java.util.Collection;
 import java.util.List;
 import java.util.Properties;
@@ -142,7 +141,7 @@ private boolean checkIfMethodExist(PhpClass pluginClass, PluginMethodData[] plug
 
     private PhpClass createPluginClass(String actionName) {
         PsiDirectory parentDirectory = ModuleIndex.getInstance(project).getModuleDirectoryByModuleName(getPluginModule());
-        String[] pluginDirectories = pluginFileData.getPluginDirectory().split(File.separator);
+        String[] pluginDirectories = pluginFileData.getPluginDirectory().split("/");
         for (String pluginDirectory: pluginDirectories) {
             parentDirectory = directoryGenerator.findOrCreateSubdirectory(parentDirectory, pluginDirectory);
         }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/PreferenceClassGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/PreferenceClassGenerator.java
@@ -19,7 +19,6 @@
 import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
 import org.jetbrains.annotations.NotNull;
 import javax.swing.*;
-import java.io.File;
 import java.util.Properties;
 
 public class PreferenceClassGenerator extends FileGenerator {
@@ -59,7 +58,7 @@ public PsiFile generate(String actionName) {
 
     private PhpClass createPluginClass(String actionName) {
         PsiDirectory parentDirectory = ModuleIndex.getInstance(project).getModuleDirectoryByModuleName(getPreferenceModule());
-        String[] pluginDirectories = preferenceFileData.getPreferenceDirectory().split(File.separator);
+        String[] pluginDirectories = preferenceFileData.getPreferenceDirectory().split("/");
         for (String pluginDirectory: pluginDirectories) {
             parentDirectory = directoryGenerator.findOrCreateSubdirectory(parentDirectory, pluginDirectory);
         }
diff --git a/testData/actions/generation/generator/CronjobClassGenerator/generateFile/CleanTableCronjob.php b/testData/actions/generation/generator/CronjobClassGenerator/generateFile/CleanTableCronjob.php
@@ -0,0 +1,18 @@
+<?php
+
+
+namespace Foo\Bar\Cron\Test;
+
+
+class CleanTableCronjob
+{
+    /**
+     * Cronjob Description
+     *
+     * @return void
+     */
+    public function execute(): void
+    {
+        // todo: implement cronjob logic here
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/actions/generation/generator/BaseGeneratorTestCase.java b/tests/com/magento/idea/magento2plugin/actions/generation/generator/BaseGeneratorTestCase.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.actions.generation.generator;
+
+import com.intellij.psi.PsiFile;
+import com.magento.idea.magento2plugin.BaseProjectTestCase;
+import java.io.File;
+
+abstract public class BaseGeneratorTestCase extends BaseProjectTestCase {
+    private static final String testDataFolderPath = "testData" + File.separator + "actions" + File.separator;
+    private static final String fixturesFolderPath = "generation" + File.separator + "generator" + File.separator;
+
+    @Override
+    protected void setUp() throws Exception {
+        super.setUp();
+        myFixture.setTestDataPath(testDataFolderPath);
+    }
+
+    protected String getFixturePath(String fileName) {
+        return prepareFixturePath(fileName, fixturesFolderPath);
+    }
+
+    protected void assertGeneratedFileIsCorrect(
+        PsiFile expectedFile,
+        String expectedDirectory,
+        PsiFile resultFile) {
+
+        assertTrue(resultFile.getContainingDirectory().getVirtualFile().getPath()
+            .endsWith(expectedDirectory));
+        assertEquals(expectedFile.getText(), resultFile.getText());
+        assertEquals(expectedFile.getName(), resultFile.getName());
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/actions/generation/generator/CronjobClassGeneratorTest.java b/tests/com/magento/idea/magento2plugin/actions/generation/generator/CronjobClassGeneratorTest.java
@@ -0,0 +1,29 @@
+/*
+ * 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;
+import com.intellij.psi.PsiFile;
+import com.magento.idea.magento2plugin.actions.generation.data.CronjobClassData;
+
+public class CronjobClassGeneratorTest extends BaseGeneratorTestCase {
+
+    public void testGenerateFile() {
+        String filePath = this.getFixturePath("CleanTableCronjob.php");
+        PsiFile expectedFile = myFixture.configureByFile(filePath);
+
+        Project project = myFixture.getProject();
+        CronjobClassData cronjobClassData = new CronjobClassData(
+            "CleanTableCronjob",
+            "Cron/Test",
+            "Foo\\Bar\\Cron\\Test",
+            "Foo_Bar"
+        );
+        CronjobClassGenerator cronjobClassGenerator = new CronjobClassGenerator(project, cronjobClassData);
+        PsiFile cronJobFile = cronjobClassGenerator.generate("test");
+
+        assertGeneratedFileIsCorrect(expectedFile, "src/app/code/Foo/Bar/Cron/Test", cronJobFile);
+    }
+}
