small cleanup and documentation for the julieops controller

Author: purbon

core/src/main/java/com/purbon/kafka/topology/model/Plan.java

@@ -7,6 +7,8 @@
 
 public class Plan {
 
+  public static final String DEFAULT_VALUE = "default";
+
   @JsonInclude(Include.NON_EMPTY)
   private String alias;
 

service/src/main/java/com/purbon/kafka/topology/JulieOps.java

@@ -11,6 +11,7 @@
 import com.purbon.kafka.topology.api.mds.MDSApiClientBuilder;
 import com.purbon.kafka.topology.audit.Auditor;
 import com.purbon.kafka.topology.exceptions.ValidationException;
+import com.purbon.kafka.topology.model.Plan;
 import com.purbon.kafka.topology.model.Topology;
 import com.purbon.kafka.topology.schemas.SchemaRegistryManager;
 import com.purbon.kafka.topology.serviceAccounts.VoidPrincipalProvider;
@@ -35,6 +36,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
+/** JulieOps Main Controller class */
 @Getter
 @Setter
 public class JulieOps implements AutoCloseable {
@@ -51,30 +53,15 @@ public class JulieOps implements AutoCloseable {
   private final Configuration config;
   private final PrintStream outputStream;
 
-  private JulieOps(
-      Map<String, Topology> topologies,
-      Configuration config,
-      TopicManager topicManager,
-      AccessControlManager accessControlManager,
-      PrincipalUpdateManager principalUpdateManager,
-      PrincipalDeleteManager principalDeleteManager,
-      KafkaConnectArtefactManager connectorManager,
-      KSqlArtefactManager kSqlArtefactManager) {
-    this.topologies = topologies;
-    this.config = config;
-    this.topicManager = topicManager;
-    this.accessControlManager = accessControlManager;
-    this.principalUpdateManager = principalUpdateManager;
-    this.principalDeleteManager = principalDeleteManager;
-    this.connectorManager = connectorManager;
-    this.kSqlArtefactManager = kSqlArtefactManager;
-    this.outputStream = System.out;
-  }
-
-  public static JulieOps build(String topologyFile, Map<String, String> config) throws Exception {
-    return build(topologyFile, "default", config);
-  }
-
+  /**
+   * Builder method for the controller
+   *
+   * @param topologyFile A topology file or directory
+   * @param plansFile A file describing the plans to be used with the application
+   * @param config A set of configuration properties for the application
+   * @return JulieOps
+   * @throws Exception Any error detected during the building process
+   */
   public static JulieOps build(String topologyFile, String plansFile, Map<String, String> config)
       throws Exception {
 
@@ -98,7 +85,20 @@ public static JulieOps build(String topologyFile, String plansFile, Map<String,
         principalProviderFactory.get());
   }
 
-  public static JulieOps build(
+  /**
+   * Simplified builder method, only used for tests
+   *
+   * @param topologyFileOrDir A topology file with the desired state description, could be single
+   *     file or a directory
+   * @param config A set of configuration properties for the application
+   * @param adminClient And instance of TopologyBuilderAdminClient to be used for admin ops by
+   *     JulieOps
+   * @param accessControlProvider An instance of a valid provider for access control rules
+   * @param bindingsBuilderProvider An instance of a valid provider for building bindings maps
+   * @return JulieOps
+   * @throws Exception Any error detected during the building process
+   */
+  static JulieOps build(
       String topologyFileOrDir,
       Configuration config,
       TopologyBuilderAdminClient adminClient,
@@ -107,7 +107,7 @@ public static JulieOps build(
       throws Exception {
     return build(
         topologyFileOrDir,
-        "default",
+        Plan.DEFAULT_VALUE,
         config,
         adminClient,
         accessControlProvider,
@@ -127,7 +127,7 @@ public static JulieOps build(
       throws Exception {
 
     Map<String, Topology> topologies;
-    if (plansFile.equals("default")) {
+    if (plansFile.equals(Plan.DEFAULT_VALUE)) {
       topologies = TopologyObjectBuilder.build(topologyFileOrDir, config);
     } else {
       topologies = TopologyObjectBuilder.build(topologyFileOrDir, plansFile, config);
@@ -190,6 +190,26 @@ public static JulieOps build(
         kSqlArtefactManager);
   }
 
+  private JulieOps(
+      Map<String, Topology> topologies,
+      Configuration config,
+      TopicManager topicManager,
+      AccessControlManager accessControlManager,
+      PrincipalUpdateManager principalUpdateManager,
+      PrincipalDeleteManager principalDeleteManager,
+      KafkaConnectArtefactManager connectorManager,
+      KSqlArtefactManager kSqlArtefactManager) {
+    this.topologies = topologies;
+    this.config = config;
+    this.topicManager = topicManager;
+    this.accessControlManager = accessControlManager;
+    this.principalUpdateManager = principalUpdateManager;
+    this.principalDeleteManager = principalDeleteManager;
+    this.connectorManager = connectorManager;
+    this.kSqlArtefactManager = kSqlArtefactManager;
+    this.outputStream = System.out;
+  }
+
   void run(BackendController backendController, PrintStream printStream, Auditor auditor)
       throws IOException {
     ExecutionPlan plan = ExecutionPlan.init(backendController, printStream, auditor);

service/src/test/java/com/purbon/kafka/topology/JulieOpsTest.java

@@ -16,6 +16,7 @@
 import com.purbon.kafka.topology.backend.BackendState;
 import com.purbon.kafka.topology.backend.RedisBackend;
 import com.purbon.kafka.topology.exceptions.TopologyParsingException;
+import com.purbon.kafka.topology.model.Plan;
 import com.purbon.kafka.topology.utils.TestUtils;
 import java.io.IOException;
 import java.util.HashMap;
@@ -147,7 +148,7 @@ public void builderRunTestAsFromCLI() throws Exception {
     config.put(QUIET_OPTION, "false");
     config.put(CLIENT_CONFIG_OPTION, clientConfigFile);
 
-    JulieOps builder = JulieOps.build(fileOrDirPath, config);
+    JulieOps builder = JulieOps.build(fileOrDirPath, Plan.DEFAULT_VALUE, config);
 
     builder.setTopicManager(topicManager);
     builder.setAccessControlManager(accessControlManager);
@@ -177,7 +178,7 @@ public void builderRunTestAsFromCLIWithARedisBackend() throws Exception {
     config.put(QUIET_OPTION, "false");
     config.put(CLIENT_CONFIG_OPTION, clientConfigFile);
 
-    JulieOps builder = JulieOps.build(fileOrDirPath, config);
+    JulieOps builder = JulieOps.build(fileOrDirPath, Plan.DEFAULT_VALUE, config);
 
     builder.setTopicManager(topicManager);
     builder.setAccessControlManager(accessControlManager);

service/src/test/java/com/purbon/kafka/topology/integration/JulieOpsIT.java

@@ -8,6 +8,7 @@
 import com.purbon.kafka.topology.JulieOps;
 import com.purbon.kafka.topology.integration.containerutils.ContainerFactory;
 import com.purbon.kafka.topology.integration.containerutils.SaslPlaintextKafkaContainer;
+import com.purbon.kafka.topology.model.Plan;
 import com.purbon.kafka.topology.utils.TestUtils;
 import java.io.IOException;
 import java.util.HashMap;
@@ -43,7 +44,7 @@ public void testSetupKafkaTopologyBuilderWithWrongCredentialsHC() throws Excepti
     config.put(QUIET_OPTION, "true");
     config.put(CLIENT_CONFIG_OPTION, clientConfigFile);
 
-    JulieOps.build(fileOrDirPath, config);
+    JulieOps.build(fileOrDirPath, Plan.DEFAULT_VALUE, config);
   }
 
   @Test
@@ -58,6 +59,6 @@ public void testSetupKafkaTopologyBuilderWithGoodCredentialsHC() throws Exceptio
     config.put(QUIET_OPTION, "true");
     config.put(CLIENT_CONFIG_OPTION, clientConfigFile);
 
-    JulieOps.build(fileOrDirPath, config);
+    JulieOps.build(fileOrDirPath, Plan.DEFAULT_VALUE, config);
   }
 }

service/src/test/java/com/purbon/kafka/topology/integration/containerutils/ContainerTestUtils.java

@@ -5,8 +5,10 @@
 import com.purbon.kafka.topology.Configuration;
 import com.purbon.kafka.topology.JulieOps;
 import com.purbon.kafka.topology.api.adminclient.TopologyBuilderAdminClient;
+import com.purbon.kafka.topology.model.Plan;
 import com.purbon.kafka.topology.roles.SimpleAclsProvider;
 import com.purbon.kafka.topology.roles.acls.AclsBindingsBuilder;
+import com.purbon.kafka.topology.serviceAccounts.VoidPrincipalProvider;
 import com.purbon.kafka.topology.utils.TestUtils;
 import com.typesafe.config.ConfigFactory;
 import java.io.IOException;
@@ -95,10 +97,12 @@ private static JulieOps getKafkaTopologyBuilder(
     try {
       return JulieOps.build(
           fileOrDirPath,
+          Plan.DEFAULT_VALUE,
           builderConfig,
           topologyAdminClient,
           accessControlProvider,
-          bindingsBuilderProvider);
+          bindingsBuilderProvider,
+          new VoidPrincipalProvider());
     } catch (final Exception e) {
       throw new RuntimeException(e);
     }