Added toString() methods and made sure that WindupRuleProvider subcla…

…sses call super.enhanceMetadata(...)
windup · Oct 6, 2014 · 12aa999 · 12aa999
1 parent e90b1ab
commit 12aa999
Show file tree

Hide file tree

Showing 69 changed files with 268 additions and 38 deletions.
diff --git a/config/api/src/main/java/org/jboss/windup/config/IteratingRuleProvider.java b/config/api/src/main/java/org/jboss/windup/config/IteratingRuleProvider.java
@@ -33,8 +33,19 @@ public void perform(GraphRewrite event, EvaluationContext context, PAYLOADTYPE p
         {
             IteratingRuleProvider.this.perform(event, context, payload);
         }
+
+        @Override
+        public String toString()
+        {
+            return IteratingRuleProvider.this.toStringPerform();
+        }
     }
 
+    /**
+     * This should return a string describing the operation to be performed by the subclass.
+     */
+    public abstract String toStringPerform();
+
     @Override
     public final Configuration getConfiguration(GraphContext context)
     {

diff --git a/config/api/src/main/java/org/jboss/windup/config/RuleSubset.java b/config/api/src/main/java/org/jboss/windup/config/RuleSubset.java
@@ -147,9 +147,6 @@ private void logTimeTakenByPhase(GraphContext graphContext, RulePhase phase, int
         }
     }
 
-    /*
-     * Executors
-     */
     @Override
     public void perform(Rewrite rewrite, EvaluationContext context)
     {
@@ -161,8 +158,6 @@ public void perform(Rewrite rewrite, EvaluationContext context)
          */
         GraphRewrite event = (GraphRewrite) rewrite;
 
-        List<Rule> rules = config.getRules();
-
         for (RuleLifecycleListener listener : listeners)
         {
             listener.beforeExecution();

diff --git a/config/api/src/main/java/org/jboss/windup/config/builder/WindupRuleProviderBuilder.java b/config/api/src/main/java/org/jboss/windup/config/builder/WindupRuleProviderBuilder.java
@@ -124,6 +124,7 @@ public Configuration getConfiguration(GraphContext context)
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         if (this.metadataEnhancer != null)
             metadataEnhancer.accept(context);
     }

diff --git a/config/api/src/main/java/org/jboss/windup/config/operation/Log.java b/config/api/src/main/java/org/jboss/windup/config/operation/Log.java
@@ -4,6 +4,7 @@
 
 import org.ocpsoft.logging.Logger;
 import org.ocpsoft.logging.Logger.Level;
+import org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder;
 import org.ocpsoft.rewrite.config.DefaultOperationBuilder;
 import org.ocpsoft.rewrite.context.EvaluationContext;
 import org.ocpsoft.rewrite.event.Rewrite;
@@ -102,4 +103,9 @@ public void setParameterStore(ParameterStore store)
         messageBuilder.setParameterStore(store);
     }
 
+    @Override
+    public String toString()
+    {
+        return "LOG[" + level + ", " + messageBuilder.toString() + "]";
+    }
 }
diff --git a/config/api/src/main/java/org/jboss/windup/config/query/Query.java b/config/api/src/main/java/org/jboss/windup/config/query/Query.java
@@ -243,12 +243,16 @@ public String toString()
         builder.append("Query");
         if (searchType != null)
         {
-            builder.append(".find(").append(searchType.getClass().getName()).append(")");
+            builder.append(".find(").append(searchType.getName()).append(")");
         }
 
-        for (QueryGremlinCriterion criterion : pipelineCriteria)
+        if (!pipelineCriteria.isEmpty())
         {
-            builder.append(".gremlin(" + criterion + ")");
+            builder.append(".gremlin()");
+            for (QueryGremlinCriterion criterion : pipelineCriteria)
+            {
+                builder.append(criterion);
+            }
         }
         builder.append(".as(" + outputVar + ")");
         return builder.toString();

diff --git a/config/tests/src/test/java/org/jboss/windup/config/TestGremlinQueryOnlyRuleProvider.java b/config/tests/src/test/java/org/jboss/windup/config/TestGremlinQueryOnlyRuleProvider.java
@@ -33,6 +33,7 @@ public RulePhase getPhase()
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/config/tests/src/test/java/org/jboss/windup/config/TestJavaExampleRuleProvider.java b/config/tests/src/test/java/org/jboss/windup/config/TestJavaExampleRuleProvider.java
@@ -47,6 +47,7 @@ public RulePhase getPhase()
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/...api/src/main/java/org/jboss/windup/reporting/freemarker/FreeMarkerIterationOperation.java b/...api/src/main/java/org/jboss/windup/reporting/freemarker/FreeMarkerIterationOperation.java
@@ -146,4 +146,10 @@ public void perform(GraphRewrite event, EvaluationContext context, ReportModel p
             throw new WindupException("FreeMarkerOperation TemplateException: " + e.getMessage(), e);
         }
     }
+
+    @Override
+    public String toString()
+    {
+        return "RenderFreeMarkerTemplate";
+    }
 }
diff --git a/reporting/api/src/main/java/org/jboss/windup/reporting/freemarker/FreeMarkerOperation.java b/reporting/api/src/main/java/org/jboss/windup/reporting/freemarker/FreeMarkerOperation.java
@@ -105,4 +105,10 @@ public void perform(GraphRewrite event, EvaluationContext context)
             throw new WindupException("FreeMarkerOperation TemplateException: " + e.getMessage(), e);
         }
     }
+
+    @Override
+    public String toString()
+    {
+        return "FreeMarkerOperation[template=" + templatePath + ", output=" + outputFilename + "]";
+    }
 }
diff --git a/...in/java/org/jboss/windup/reporting/rules/AttachApplicationReportsToIndexRuleProvider.java b/...in/java/org/jboss/windup/reporting/rules/AttachApplicationReportsToIndexRuleProvider.java
@@ -54,5 +54,11 @@ public void perform(GraphRewrite event, EvaluationContext context, ApplicationRe
                 index.addApplicationReportModel(payload);
             }
         }
+
+        @Override
+        public String toString()
+        {
+            return "AddToApplicationIndex";
+        }
     }
 }
diff --git a/.../main/java/org/jboss/windup/reporting/rules/CreateApplicationReportIndexRuleProvider.java b/.../main/java/org/jboss/windup/reporting/rules/CreateApplicationReportIndexRuleProvider.java
@@ -49,6 +49,12 @@ public void perform(GraphRewrite event, EvaluationContext context, WindupConfigu
                 }
                 createApplicationReportIndex(event.getGraphContext(), projectModel);
             }
+
+            @Override
+            public String toString()
+            {
+                return "AddApplicationReportIndex";
+            }
         };
 
         return ConfigurationBuilder.begin()

diff --git a/...main/java/org/jboss/windup/reporting/rules/generation/CreateSourceReportRuleProvider.java b/...main/java/org/jboss/windup/reporting/rules/generation/CreateSourceReportRuleProvider.java
@@ -78,6 +78,12 @@ public void perform(GraphRewrite event, EvaluationContext context, FileModel pay
                 ReportService reportService = new ReportService(event.getGraphContext());
                 reportService.setUniqueFilename(sm, payload.getFileName(), "html");
             }
+
+            @Override
+            public String toString()
+            {
+                return "AddSourceReport";
+            }
         };
 
         return ConfigurationBuilder.begin()

diff --git a/...n/java/org/jboss/windup/reporting/rules/rendering/CssJsResourceRenderingRuleProvider.java b/...n/java/org/jboss/windup/reporting/rules/rendering/CssJsResourceRenderingRuleProvider.java
@@ -61,6 +61,12 @@ public void perform(GraphRewrite event, EvaluationContext context)
                 String outputPath = cfg.getOutputPath().getFilePath();
                 copyCssResourcesToOutput(event.getGraphContext(), outputPath);
             }
+
+            @Override
+            public String toString()
+            {
+                return "CopyCSSToOutput";
+            }
         };
 
         Configuration configuration = ConfigurationBuilder.begin()

diff --git a/...mpl/src/main/java/org/jboss/windup/reporting/rules/rendering/RenderGraphRuleProvider.java b/...mpl/src/main/java/org/jboss/windup/reporting/rules/rendering/RenderGraphRuleProvider.java
@@ -46,6 +46,12 @@ public void perform(GraphRewrite event, EvaluationContext context)
                                 renderer.renderGraph(graphContext);
                             }
                         }
+
+                        @Override
+                        public String toString()
+                        {
+                            return "RenderGraphForDebugging";
+                        }
                     });
     }
 }
diff --git a/.../java/org/jboss/windup/reporting/rules/rendering/RuleExecutionTimeReportRuleProvider.java b/.../java/org/jboss/windup/reporting/rules/rendering/RuleExecutionTimeReportRuleProvider.java
@@ -138,6 +138,12 @@ public int compare(RulePhaseExecutionStatisticsModel o1,
                             }
 
                         }
+
+                        @Override
+                        public String toString()
+                        {
+                            return "RenderRuleExecutionTimeReport";
+                        }
                     });
     }
 }
diff --git a/...ava/org/jboss/windup/rules/apps/javaee/rules/DiscoverEjbConfigurationXmlRuleProvider.java b/...ava/org/jboss/windup/rules/apps/javaee/rules/DiscoverEjbConfigurationXmlRuleProvider.java
@@ -62,6 +62,12 @@ public List<Class<? extends WindupRuleProvider>> getExecuteAfter()
         return asClassList(DiscoverXmlFilesRuleProvider.class);
     }
 
+    @Override
+    public String toStringPerform()
+    {
+        return "Discover EJB-JAR XML Files";
+    }
+
     @Override
     public ConditionBuilder when()
     {

diff --git a/.../org/jboss/windup/rules/apps/javaee/rules/DiscoverHibernateConfigurationRuleProvider.java b/.../org/jboss/windup/rules/apps/javaee/rules/DiscoverHibernateConfigurationRuleProvider.java
@@ -52,6 +52,12 @@ public List<Class<? extends WindupRuleProvider>> getExecuteAfter()
         return asClassList(DiscoverXmlFilesRuleProvider.class);
     }
 
+    @Override
+    public String toStringPerform()
+    {
+        return "Discover hibernate.cfg.xml files";
+    }
+
     @Override
     public ConditionBuilder when()
     {

diff --git a/...n/java/org/jboss/windup/rules/apps/javaee/rules/DiscoverHibernateMappingRuleProvider.java b/...n/java/org/jboss/windup/rules/apps/javaee/rules/DiscoverHibernateMappingRuleProvider.java
@@ -58,6 +58,12 @@ public List<Class<? extends WindupRuleProvider>> getExecuteAfter()
         return asClassList(DiscoverXmlFilesRuleProvider.class);
     }
 
+    @Override
+    public String toStringPerform()
+    {
+        return "Discover hibernate.hbm.xml files";
+    }
+
     @Override
     public ConditionBuilder when()
     {

diff --git a/...rg/jboss/windup/rules/apps/javaee/rules/DiscoverSpringConfigurationFilesRuleProvider.java b/...rg/jboss/windup/rules/apps/javaee/rules/DiscoverSpringConfigurationFilesRuleProvider.java
@@ -53,6 +53,12 @@ public List<Class<? extends WindupRuleProvider>> getExecuteAfter()
         return asClassList(DiscoverXmlFilesRuleProvider.class);
     }
 
+    @Override
+    public String toStringPerform()
+    {
+        return "Discover Spring Config Files";
+    }
+
     @Override
     public ConditionBuilder when()
     {

diff --git a/...ee/src/main/java/org/jboss/windup/rules/apps/javaee/rules/DiscoverWebXmlRuleProvider.java b/...ee/src/main/java/org/jboss/windup/rules/apps/javaee/rules/DiscoverWebXmlRuleProvider.java
@@ -55,6 +55,12 @@ public List<Class<? extends WindupRuleProvider>> getExecuteAfter()
         return asClassList(DiscoverXmlFilesRuleProvider.class);
     }
 
+    @Override
+    public String toStringPerform()
+    {
+        return "Discover web.xml files";
+    }
+
     @Override
     public ConditionBuilder when()
     {

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/BaseConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/BaseConfig.java
@@ -21,6 +21,7 @@ public class BaseConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/Config.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/Config.java
@@ -15,6 +15,7 @@ public class Config extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/EjbConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/EjbConfig.java
@@ -15,6 +15,7 @@ public class EjbConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/JBossConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/JBossConfig.java
@@ -16,6 +16,7 @@ public class JBossConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/JBossEsbConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/JBossEsbConfig.java
@@ -15,6 +15,7 @@ public class JBossEsbConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/JBossJBPMConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/JBossJBPMConfig.java
@@ -15,6 +15,7 @@ public class JBossJBPMConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/JDKConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/JDKConfig.java
@@ -17,6 +17,7 @@ public class JDKConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/JPPConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/JPPConfig.java
@@ -15,6 +15,7 @@ public class JPPConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/PersistenceConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/PersistenceConfig.java
@@ -15,6 +15,7 @@ public class PersistenceConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/SeamToCDI.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/SeamToCDI.java
@@ -17,6 +17,7 @@ public class SeamToCDI extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/SonicESBConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/SonicESBConfig.java
@@ -17,6 +17,7 @@ public class SonicESBConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/WebLogicConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/WebLogicConfig.java
@@ -17,6 +17,7 @@ public class WebLogicConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/WebServiceConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/WebServiceConfig.java
@@ -17,6 +17,7 @@ public class WebServiceConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/WebsphereConfig.java b/rules-java-ee/src/main/java/org/jboss/windup/rules/apps/legacy/java/WebsphereConfig.java
@@ -17,6 +17,7 @@ public class WebsphereConfig extends WindupRuleProvider
     @Override
     public void enhanceMetadata(Context context)
     {
+        super.enhanceMetadata(context);
         context.put(RuleMetadata.CATEGORY, "Java");
     }
 

diff --git a/...ava/src/main/java/org/jboss/windup/rules/apps/java/binary/ProcyonDecompilerOperation.java b/...ava/src/main/java/org/jboss/windup/rules/apps/java/binary/ProcyonDecompilerOperation.java
@@ -130,4 +130,10 @@ public void perform(final GraphRewrite event, final EvaluationContext context, f
             }
         }
     }
+
+    @Override
+    public String toString()
+    {
+        return "DecompileWithProcyon";
+    }
 }