Program now reads through an input file

Author: NicolasHuertas

java/com/engflow/internship/cycleexample/README.md

@@ -0,0 +1,39 @@
+# Cyclical Dependency Example
+
+## Overview
+
+This project is designed to evaluate and benchmark the performance of EngFlow's remote execution and caching services. It specifically focuses on testing scenarios involving cyclical-like structures in the dependency graph, which are handled through interfaces and constructor injection.
+
+## Purpose
+
+The primary objectives of this project are to:
+
+1. **Generate Performance Data**: Create examples with cyclical-like dependencies to test and gather performance data for EngFlow’s remote caching and execution services.
+2. **Benchmark Analysis**: Compare the performance of local versus remote execution and caching to evaluate the efficiency and effectiveness of the service.
+3. **Support Automation Development**: Contribute to the development of automation algorithms for resource assignment by providing valuable data on how cyclical dependencies impact performance.
+
+## Project Structure
+
+The project is organized into several packages, each representing different components of the cyclical dependency example:
+
+- `class_a`: Contains `ClassA` which depends on `ClassB` through an interface.
+- `class_b`: Contains `ClassB` which implements `InterfaceB` and depends on `ClassC`.
+- `class_c`: Contains `ClassC` which implements `InterfaceA` and can be initialized with a reference to `ClassA`.
+- `interface_a`: Defines the interface `InterfaceA` implemented by `ClassA` and `ClassC`.
+- `interface_b`: Defines the interface `InterfaceB` implemented by `ClassB`.
+- `main`: Contains the `Main` class which processes the input file.
+- `input`: Contains the input text file used by the `Main` class.
+
+## How the Program Works
+
+The program takes a text input file and recursively prints each word with each class (`ClassA` prints a word, then `ClassB`, and so on) until the string is empty. The input file should be specified in the `data` attribute of the `java_binary` rule in the `BUILD` file.
+
+Here is an example of how the `Main` class processes the input file:
+
+
+## How to Run Tests
+
+To run the tests and gather performance data, use the following Bazel command:
+
+```sh
+bazel test //java/com/engflow/internship/cycleexample/class_a:class_a_test

java/com/engflow/internship/cycleexample/class_a/BUILD

@@ -12,7 +12,7 @@ java_library(
 java_test(
     name = "class_a_test",
     srcs = ["ClassATest.java"],
-    test_class = "cycleexample",
+    test_class = "com.engflow.internship.cycleexample.class_a.ClassATest",
     deps = [
         ":class_a",
         "//java/com/engflow/internship/cycleexample/class_b:class_b",

java/com/engflow/internship/cycleexample/class_a/ClassA.java

@@ -4,22 +4,28 @@
 import com.engflow.internship.cycleexample.interface_a.InterfaceA;
 
 public class ClassA implements InterfaceA {
-    private static final int MAX_CALLS = 10;
-    private int callCount = 0;
     private ClassB classB;
 
     public ClassA(ClassB classB) {
         this.classB = classB;
     }
 
     @Override
-    public void methodA() {
-        if (callCount >= MAX_CALLS) {
-            System.out.println("ClassA.methodA() reached max calls");
+    public void methodA(String input) {
+        // If the input is null or empty, return immediately
+        if (input == null || input.isEmpty()) {
             return;
         }
-        System.out.println("ClassA.methodA()");
-        callCount++;
-        classB.methodB();
+
+        //Find the index of the first space character in the input string.
+        int spaceIndex = input.indexOf(' ');
+        //Extract the word from the beginning of the input string up to the space character.
+        String word = (spaceIndex == -1) ? input : input.substring(0, spaceIndex);
+        //Extract the remaining part of the input string after the space character.
+        String remaining = (spaceIndex == -1) ? "" : input.substring(spaceIndex + 1);
+
+        //Print the word extracted from the input string.
+        System.out.println("ClassA: " + word);
+        classB.methodB(remaining);
     }
-}
+}

java/com/engflow/internship/cycleexample/class_a/ClassATest.java

@@ -14,27 +14,27 @@ public TestClassB(ClassC classC) {
         }
 
         @Override
-        public void methodB() {
+        public void methodB(String input) {
             methodBCalled = true;
         }
     }
 
     @Test
     public void testMethodA() {
-        // Create an instance of ClassA
-        ClassA classA = new ClassA(null);
-
-        // Create a ClassC instance with the ClassA object
-        ClassC classC = new ClassC(classA);
+        // Create a ClassC instance with a null ClassA object
+        ClassC classC = new ClassC(null);
 
         // Create a TestClassB instance with the ClassC object
         TestClassB testClassB = new TestClassB(classC);
 
         // Create a new ClassA instance with the TestClassB object
-        classA = new ClassA(testClassB);
+        ClassA classA = new ClassA(testClassB);
+
+        // Properly initialize classC with classA
+        classC.setClassA(classA);
 
-        // Call methodA on classA
-        classA.methodA();
+        // Call methodA on classA with a sample input
+        classA.methodA("sample input");
 
         // Verify that methodB on the TestClassB was called
         assertTrue(testClassB.methodBCalled);

java/com/engflow/internship/cycleexample/class_b/BUILD

@@ -12,7 +12,7 @@ java_library(
 java_test(
     name = "class_b_test",
     srcs = ["ClassBTest.java"],
-    test_class = "cycleexample",
+    test_class = "com.engflow.internship.cycleexample.class_b.ClassBTest",
     deps = [
         ":class_b",
         "//java/com/engflow/internship/cycleexample/class_c:class_c",

java/com/engflow/internship/cycleexample/class_b/ClassB.java

@@ -11,8 +11,21 @@ public ClassB(ClassC classC) {
     }
 
     @Override
-    public void methodB() {
-        System.out.println("ClassB.methodB()");
-        classC.methodA();
+    public void methodB(String input) {
+        // If the input is null or empty, return immediately
+        if (input == null || input.isEmpty()) {
+            return;
+        }
+
+        //Find the index of the first space character in the input string.
+        int spaceIndex = input.indexOf(' ');
+        //Extract the word from the beginning of the input string up to the space character.
+        String word = (spaceIndex == -1) ? input : input.substring(0, spaceIndex);
+        //Extract the remaining part of the input string after the space character.
+        String remaining = (spaceIndex == -1) ? "" : input.substring(spaceIndex + 1);
+
+        //Print the word extracted from the input string.
+        System.out.println("ClassB: " + word);
+        classC.methodA(remaining);
     }
-}
+}

java/com/engflow/internship/cycleexample/class_b/ClassBTest.java

@@ -13,7 +13,7 @@ public TestClassC() {
         }
 
         @Override
-        public void methodA() {
+        public void methodA(String input) {
             methodACalled = true;
         }
     }
@@ -27,7 +27,7 @@ public void testMethodB() {
         ClassB classB = new ClassB(testClassC);
 
         // Call methodB on classB
-        classB.methodB();
+        classB.methodB("Sample input");
 
         // Verify that methodA on the TestClassC was called
         assertTrue(testClassC.methodACalled);

java/com/engflow/internship/cycleexample/class_c/BUILD

@@ -12,7 +12,7 @@ java_library(
 java_test(
     name = "class_c_test",
     srcs = ["ClassCTest.java"],
-    test_class = "cycleexample",
+    test_class = "com.engflow.internship.cycleexample.class_c.ClassCTest",
     deps = [
         ":class_c",
         "//java/com/engflow/internship/cycleexample/class_a:class_a",

java/com/engflow/internship/cycleexample/class_c/ClassC.java

@@ -10,20 +10,29 @@ public ClassC(InterfaceA classA) {
     }
 
     @Override
-    public void methodA() {
-        System.out.println("ClassC.methodA()");
-        if (classA != null) {
-            classA.methodA();
-        } else {
-            System.out.println("classA is null");
+    public void methodA(String input) {
+        // If the input is null or empty, return immediately
+        if (input == null || input.isEmpty()) {
+            return;
         }
+
+        // Find the index of the first space character in the input string.
+        int spaceIndex = input.indexOf(' ');
+        // Extract the word from the beginning of the input string up to the space character.
+        String word = (spaceIndex == -1) ? input : input.substring(0, spaceIndex);
+        // Extract the remaining part of the input string after the space character.
+        String remaining = (spaceIndex == -1) ? "" : input.substring(spaceIndex + 1);
+
+        // Print the word extracted from the input string.
+        System.out.println("ClassC: " + word);
+        classA.methodA(remaining);
     }
 
+    /**
+     * Set the classA field of this class.
+     * @param classA
+     */
     public void setClassA(InterfaceA classA) {
         this.classA = classA;
     }
-
-    public void methodC() {
-        System.out.println("ClassC.methodC()");
-    }
 }

java/com/engflow/internship/cycleexample/class_c/ClassCTest.java

@@ -13,7 +13,7 @@ public TestClassA() {
         }
 
         @Override
-        public void methodA() {
+        public void methodA(String input) {
             methodACalled = true;
         }
     }
@@ -27,7 +27,7 @@ public void testMethodA() {
         ClassC classC = new ClassC(testClassA);
 
         // Call methodA on classC
-        classC.methodA();
+        classC.methodA("sample input");
 
         // Verify that methodA on the TestClassA was called
         assertTrue(testClassA.methodACalled);