#issue-203-204 Fixing static tests

Author: Sergiy Zhovnir

tests/com/magento/idea/magento2plugin/actions/generation/generator/PreferenceClassGeneratorTest.java

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
@@ -15,8 +15,10 @@ public class PreferenceClassGeneratorTest extends BaseGeneratorTestCase {
     private static final String targetSimpleModelOneClassFqn = "Foo\\Bar\\Model\\SimpleModelOne";
     private static final String targetSimpleModelTwoClassFqn = "Foo\\Bar\\Model\\SimpleModelTwo";
 
-    public void testGeneratePreferenceClassFile()
-    {
+    /**
+     * Test preference class file generation
+     */
+    public void testGeneratePreferenceClassFile() {
         PsiFile preferenceClassFile = createPreferenceClassFile(
                 targetSimpleModelOneClassFqn,
                 "Model/Override",
@@ -35,8 +37,10 @@ public void testGeneratePreferenceClassFile()
         );
     }
 
-    public void testGeneratePreferenceClassFileWithInheritance()
-    {
+    /**
+     * Test preference class file generation with inheritance
+     */
+    public void testGeneratePreferenceClassFileWithInheritance() {
         PsiFile preferenceClassFile = createPreferenceClassFile(
                 targetSimpleModelTwoClassFqn,
                 "Model/Override",
@@ -55,6 +59,17 @@ public void testGeneratePreferenceClassFileWithInheritance()
         );
     }
 
+    /**
+     * Create preference class file
+     *
+     * @param targetClassFnq Target Class FQN
+     * @param preferenceDirectory Preference Directory
+     * @param preferenceClassName Preference Class Name
+     * @param preferenceFqn Preference FQN
+     * @param namespace Namespace
+     * @param inheritClass Inherit target class
+     * @return PsiFile
+     */
     private PsiFile createPreferenceClassFile(
             String targetClassFnq,
             String preferenceDirectory,

tests/com/magento/idea/magento2plugin/actions/generation/generator/PreferenceDiXmlGeneratorTest.java

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
@@ -19,6 +19,9 @@ public class PreferenceDiXmlGeneratorTest extends BaseGeneratorTestCase {
     private static final String targetSimpleModelOneClassFqn = "Foo\\Bar\\Model\\SimpleModelOne";
     private static final String targetSimpleModelTwoClassFqn = "Foo\\Bar\\Model\\SimpleModelTwo";
 
+    /**
+     * Test preference DI XML file generation
+     */
     public void testGeneratePreferenceDiXml()
     {
         String area = Package.Areas.base.toString();
@@ -39,6 +42,9 @@ public void testGeneratePreferenceDiXml()
         );
     }
 
+    /**
+     * Test preference DI XML file generation for adminhtml area
+     */
     public void testGeneratePreferenceDiXmlForAdminhtmlArea()
     {
         String area = Package.Areas.adminhtml.toString();
@@ -59,6 +65,9 @@ public void testGeneratePreferenceDiXmlForAdminhtmlArea()
         );
     }
 
+    /**
+     * Test the adding of two preferences to one DI XML file
+     */
     public void testAddTwoPreferencesToOneDiXmlFile()
     {
         String area = Package.Areas.frontend.toString();
@@ -85,6 +94,15 @@ public void testAddTwoPreferencesToOneDiXmlFile()
         );
     }
 
+    /**
+     * Add preference to XML file
+     *
+     * @param targetClassFnq Target class FQN
+     * @param preferenceFqn Preference FQN
+     * @param area Area
+     * @param namespace Namespace
+     * @return PsiFile
+     */
     private PsiFile addPreferenceDiXml(
             String targetClassFnq,
             String preferenceFqn,
@@ -105,6 +123,12 @@ private PsiFile addPreferenceDiXml(
         return moduleXmlGenerator.generate("test");
     }
 
+    /**
+     * Get expected directory based on provided area
+     *
+     * @param area Area name
+     * @return String
+     */
     private String getExpectedDirectory(String area)
     {
         if (area.equals(Package.Areas.base.toString())) {