Merge pull request #14 from flipkart-incubator/tostring

Simple Flow toString
flipkart-incubator · Jan 26, 2024 · 48f6ed2 · 48f6ed2
2 parents 2e87bbb + 51f709b
commit 48f6ed2
Show file tree

Hide file tree

Showing 48 changed files with 137 additions and 57 deletions.
diff --git a/pom.xml b/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  ~ Copyright [2021] [The Original Author]
+  ~Copyright [2024] [The Original Author]
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.
@@ -107,7 +107,7 @@
     </build>
 
     <properties>
-        <revision>0.1.4</revision>
+        <revision>0.1.5</revision>
         <guava.version>19.0</guava.version>
         <guice.version>4.2.3</guice.version>
     </properties>
@@ -118,6 +118,13 @@
             <artifactId>guice</artifactId>
             <version>${guice.version}</version>
         </dependency>
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <distributionManagement>

diff --git a/tef-core/pom.xml b/tef-core/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  ~ Copyright [2021] [The Original Author]
+  ~Copyright [2024] [The Original Author]
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/FlowExecutionListener.java b/tef-core/src/main/java/flipkart/tef/FlowExecutionListener.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/annotations/DependsOn.java b/tef-core/src/main/java/flipkart/tef/annotations/DependsOn.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/annotations/EmitData.java b/tef-core/src/main/java/flipkart/tef/annotations/EmitData.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/annotations/InjectData.java b/tef-core/src/main/java/flipkart/tef/annotations/InjectData.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/bizlogics/DataAdapterKey.java b/tef-core/src/main/java/flipkart/tef/bizlogics/DataAdapterKey.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/bizlogics/DataAdapterResult.java b/tef-core/src/main/java/flipkart/tef/bizlogics/DataAdapterResult.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/bizlogics/IBizlogic.java b/tef-core/src/main/java/flipkart/tef/bizlogics/IBizlogic.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/bizlogics/IDataBizlogic.java b/tef-core/src/main/java/flipkart/tef/bizlogics/IDataBizlogic.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/bizlogics/TefContext.java b/tef-core/src/main/java/flipkart/tef/bizlogics/TefContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/exception/ErrorCode.java b/tef-core/src/main/java/flipkart/tef/exception/ErrorCode.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/exception/TefExecutionException.java b/tef-core/src/main/java/flipkart/tef/exception/TefExecutionException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-core/src/main/java/flipkart/tef/flow/SimpleFlow.java b/tef-core/src/main/java/flipkart/tef/flow/SimpleFlow.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,12 +24,13 @@
 import flipkart.tef.bizlogics.IDataBizlogic;
 
 import java.util.List;
+import java.util.stream.Collectors;
 
 /**
  * Simple Flow Represents an Execution DAG. The list of bizlogics are in strict order of execution.
  * Cycles are guaranteed to be not present.
  *
- * 
+ *
  * Date: 19/06/20
  * Time: 5:02 PM
  */
@@ -39,6 +40,12 @@ public class SimpleFlow {
      */
     private final List<Class<? extends IBizlogic>> bizlogics;
 
+    /**
+     * toString method triggers the population of this variable. It contains the ordered classnames
+     * of the list of bizlogics that represent this flow.
+     */
+    private String stringRepresentation;
+
     /**
      * Map keyed by the Data Object against the Data Adapter that is responsible for producing it.
      */
@@ -57,4 +64,12 @@ public List<Class<? extends IBizlogic>> getBizlogics() {
     public BiMap<DataAdapterKey<?>, Class<? extends IDataBizlogic<?>>> getDataAdapterMap() {
         return dataAdapterMap;
     }
+
+    public String toString() {
+        if (stringRepresentation == null) {
+            stringRepresentation = "bizlogics ->\n" + bizlogics.stream().map(Class::getName).collect(Collectors.joining("\n"));
+        }
+
+        return stringRepresentation;
+    }
 }
diff --git a/tef-core/src/test/java/flipkart/tef/flow/SimpleFlowTest.java b/tef-core/src/test/java/flipkart/tef/flow/SimpleFlowTest.java
@@ -0,0 +1,66 @@
+/*
+ *Copyright [2024] [The Original Author]
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package flipkart.tef.flow;
+
+
+import com.google.common.collect.HashBiMap;
+import flipkart.tef.bizlogics.IBizlogic;
+import flipkart.tef.bizlogics.TefContext;
+import org.junit.Test;
+
+import java.util.Arrays;
+import java.util.Collections;
+
+import static org.junit.Assert.assertEquals;
+
+public class SimpleFlowTest {
+
+
+    @Test
+    public void testToStringForEmptyFlow() {
+        SimpleFlow instance = new SimpleFlow(Collections.emptyList(), HashBiMap.create());
+        String expResult = "bizlogics ->\n";
+        String result = instance.toString();
+        assertEquals(expResult, result);
+    }
+
+    @Test
+    public void testToStringForNonEmptyFlow() {
+        SimpleFlow instance = new SimpleFlow(Arrays.asList(Bizlogic1.class, Bizlogic2.class), HashBiMap.create());
+        String expResult = "bizlogics ->\n" +
+                "flipkart.tef.flow.SimpleFlowTest$Bizlogic1\n" +
+                "flipkart.tef.flow.SimpleFlowTest$Bizlogic2";
+        String result = instance.toString();
+        assertEquals(expResult, result);
+    }
+
+    static class Bizlogic1 implements IBizlogic {
+
+        @Override
+        public void execute(TefContext tefContext) {
+
+        }
+    }
+
+    static class Bizlogic2 implements IBizlogic {
+
+        @Override
+        public void execute(TefContext tefContext) {
+
+        }
+    }
+}
diff --git a/tef-impl/pom.xml b/tef-impl/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  ~ Copyright [2021] [The Original Author]
+  ~Copyright [2024] [The Original Author]
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.
@@ -33,13 +33,6 @@
             <version>${revision}</version>
             <artifactId>tef-core</artifactId>
         </dependency>
-
-        <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <version>4.12</version>
-            <scope>test</scope>
-        </dependency>
     </dependencies>
 
 </project>
diff --git a/tef-impl/src/main/java/flipkart/tef/TefGuiceModule.java b/tef-impl/src/main/java/flipkart/tef/TefGuiceModule.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/bizlogics/AsyncDataAdapterBizlogic.java b/tef-impl/src/main/java/flipkart/tef/bizlogics/AsyncDataAdapterBizlogic.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/bizlogics/BasicEnrichmentBizlogic.java b/tef-impl/src/main/java/flipkart/tef/bizlogics/BasicEnrichmentBizlogic.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/bizlogics/BasicValidationBizlogic.java b/tef-impl/src/main/java/flipkart/tef/bizlogics/BasicValidationBizlogic.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/bizlogics/DataAdapterBizlogic.java b/tef-impl/src/main/java/flipkart/tef/bizlogics/DataAdapterBizlogic.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/capability/AdapterConflictRuntimeException.java b/tef-impl/src/main/java/flipkart/tef/capability/AdapterConflictRuntimeException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/capability/BizlogicDependency.java b/tef-impl/src/main/java/flipkart/tef/capability/BizlogicDependency.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/capability/CapabilityDefinition.java b/tef-impl/src/main/java/flipkart/tef/capability/CapabilityDefinition.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/capability/EmptyCapabilityDefinition.java b/tef-impl/src/main/java/flipkart/tef/capability/EmptyCapabilityDefinition.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/capability/model/EnrichmentResultData.java b/tef-impl/src/main/java/flipkart/tef/capability/model/EnrichmentResultData.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/capability/model/MapBaseData.java b/tef-impl/src/main/java/flipkart/tef/capability/model/MapBaseData.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/capability/model/ValidationResultData.java b/tef-impl/src/main/java/flipkart/tef/capability/model/ValidationResultData.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...src/main/java/flipkart/tef/exceptions/UnableToResolveDataFromAdapterRuntimeException.java b/...src/main/java/flipkart/tef/exceptions/UnableToResolveDataFromAdapterRuntimeException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/execution/DataContext.java b/tef-impl/src/main/java/flipkart/tef/execution/DataContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/execution/DataDependencyException.java b/tef-impl/src/main/java/flipkart/tef/execution/DataDependencyException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/execution/DataInjector.java b/tef-impl/src/main/java/flipkart/tef/execution/DataInjector.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/execution/DefaultDataInjector.java b/tef-impl/src/main/java/flipkart/tef/execution/DefaultDataInjector.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,7 +16,6 @@
 
 package flipkart.tef.execution;
 
-import com.google.common.reflect.Reflection;
 import flipkart.tef.annotations.InjectData;
 import flipkart.tef.exception.TefExecutionException;
 

diff --git a/tef-impl/src/main/java/flipkart/tef/execution/FlowBuilder.java b/tef-impl/src/main/java/flipkart/tef/execution/FlowBuilder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/tef-impl/src/main/java/flipkart/tef/execution/FlowExecutor.java b/tef-impl/src/main/java/flipkart/tef/execution/FlowExecutor.java
@@ -1,5 +1,5 @@
 /*
- * Copyright [2021] [The Original Author]
+ *Copyright [2024] [The Original Author]
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.