updates the instrumentation engine interface and moves runseq instrum…

…entation engine related classes into a new package
failify · Mar 1, 2019 · 5e7731a · 5e7731a
1 parent ed0bddf
commit 5e7731a
Show file tree

Hide file tree

Showing 11 changed files with 35 additions and 24 deletions.
diff --git a/failify/src/main/java/io/failify/FailifyRunner.java b/failify/src/main/java/io/failify/FailifyRunner.java
@@ -38,7 +38,7 @@
 import io.failify.execution.RuntimeEngine;
 import io.failify.execution.LimitedRuntimeEngine;
 import io.failify.instrumentation.InstrumentationEngine;
-import io.failify.instrumentation.RunSequenceInstrumentationEngine;
+import io.failify.instrumentation.runseq.RunSequenceInstrumentationEngine;
 import io.failify.workspace.WorkspaceManager;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

diff --git a/failify/src/main/java/io/failify/dsl/events/internal/GarbageCollectionEvent.java b/failify/src/main/java/io/failify/dsl/events/internal/GarbageCollectionEvent.java
@@ -30,7 +30,7 @@
 import io.failify.dsl.entities.Node;
 import io.failify.instrumentation.InstrumentationDefinition;
 import io.failify.instrumentation.InstrumentationPoint;
-import io.failify.instrumentation.RunSeqRuntimeOperation;
+import io.failify.instrumentation.runseq.RunSeqRuntimeOperation;
 import io.failify.dsl.events.InternalEvent;
 
 import java.util.ArrayList;

diff --git a/failify/src/main/java/io/failify/dsl/events/internal/SchedulingEvent.java b/failify/src/main/java/io/failify/dsl/events/internal/SchedulingEvent.java
@@ -29,7 +29,7 @@
 import io.failify.dsl.entities.Node;
 import io.failify.instrumentation.InstrumentationDefinition;
 import io.failify.instrumentation.InstrumentationPoint;
-import io.failify.instrumentation.RunSeqRuntimeOperation;
+import io.failify.instrumentation.runseq.RunSeqRuntimeOperation;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/failify/src/main/java/io/failify/dsl/events/internal/StackTraceEvent.java b/failify/src/main/java/io/failify/dsl/events/internal/StackTraceEvent.java
@@ -29,7 +29,7 @@
 import io.failify.dsl.entities.Node;
 import io.failify.instrumentation.InstrumentationDefinition;
 import io.failify.instrumentation.InstrumentationPoint;
-import io.failify.instrumentation.RunSeqRuntimeOperation;
+import io.failify.instrumentation.runseq.RunSeqRuntimeOperation;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/failify/src/main/java/io/failify/instrumentation/InstrumentationDefinition.java b/failify/src/main/java/io/failify/instrumentation/InstrumentationDefinition.java
@@ -25,6 +25,8 @@
 
 package io.failify.instrumentation;
 
+import io.failify.instrumentation.runseq.RunSeqRuntimeOperation;
+
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;

diff --git a/failify/src/main/java/io/failify/instrumentation/InstrumentationEngine.java b/failify/src/main/java/io/failify/instrumentation/InstrumentationEngine.java
@@ -25,24 +25,20 @@
 package io.failify.instrumentation;
 
 import io.failify.dsl.entities.Deployment;
-import io.failify.dsl.entities.ServiceType;
 import io.failify.exceptions.InstrumentationException;
-import io.failify.instrumentation.java.JavaInstrumentor;
 import io.failify.workspace.NodeWorkspace;
 
 import java.util.Map;
 
-public abstract class InstrumentationEngine {
-
-    protected Instrumentor getInstrumentor(ServiceType serviceType) {
-        if (serviceType == ServiceType.JAVA) {
-            return new JavaInstrumentor();
-        } else {
-            return null;
-        }
-    }
-
-    // This method shouldn't change any of the application paths
-    public abstract void instrumentNodes(Deployment deployment, Map<String, NodeWorkspace> nodeWorkspaceMap)
+public interface InstrumentationEngine {
+    /**
+     * This method should instrument the nodes based on the given definition and node workspaces. It is important that
+     * this method doesn't change any of the application paths
+     * @param deployment the deployment definition object
+     * @param nodeWorkspaceMap the map of node name to the node's workspace information
+     * @throws InstrumentationException if something goes wrong during instrumentation
+     */
+    void instrumentNodes(Deployment deployment, Map<String, NodeWorkspace> nodeWorkspaceMap)
             throws InstrumentationException;
+
 }
diff --git a/failify/src/main/java/io/failify/instrumentation/InstrumentationOperation.java b/failify/src/main/java/io/failify/instrumentation/InstrumentationOperation.java
@@ -25,6 +25,8 @@
 
 package io.failify.instrumentation;
 
+import io.failify.instrumentation.runseq.RunSeqRuntimeOperation;
+
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;

diff --git a/...strumentation/RunSeqRuntimeOperation.java → ...tation/runseq/RunSeqRuntimeOperation.java b/...strumentation/RunSeqRuntimeOperation.java → ...tation/runseq/RunSeqRuntimeOperation.java
@@ -23,7 +23,7 @@
  *
  */
 
-package io.failify.instrumentation;
+package io.failify.instrumentation.runseq;
 
 public enum RunSeqRuntimeOperation {
     ALLOW_BLOCKING,

diff --git a/...ion/RunSequenceInstrumentationEngine.java → ...seq/RunSequenceInstrumentationEngine.java b/...ion/RunSequenceInstrumentationEngine.java → ...seq/RunSequenceInstrumentationEngine.java
@@ -23,9 +23,12 @@
  *
  */
 
-package io.failify.instrumentation;
+package io.failify.instrumentation.runseq;
 
 import io.failify.Constants;
+import io.failify.dsl.entities.ServiceType;
+import io.failify.instrumentation.*;
+import io.failify.instrumentation.runseq.java.JavaInstrumentor;
 import io.failify.workspace.NodeWorkspace;
 import io.failify.dsl.entities.Deployment;
 import io.failify.dsl.entities.Node;
@@ -40,9 +43,17 @@
 /**
  * Only non-lib binary instrumentation is possible
  */
-public class RunSequenceInstrumentationEngine extends InstrumentationEngine {
+public class RunSequenceInstrumentationEngine implements InstrumentationEngine {
     private final static Logger logger = LoggerFactory.getLogger(RunSequenceInstrumentationEngine.class);
 
+    protected Instrumentor getInstrumentor(ServiceType serviceType) {
+        if (serviceType == ServiceType.JAVA) {
+            return new JavaInstrumentor();
+        } else {
+            return null;
+        }
+    }
+
     @Override
     public void instrumentNodes(Deployment deployment, Map<String, NodeWorkspace> nodeWorkspaceMap) throws InstrumentationException {
         String[] eventNames = deployment.getRunSequence().split("\\W+");

diff --git a/...instrumentation/java/AspectGenerator.java → ...entation/runseq/java/AspectGenerator.java b/...instrumentation/java/AspectGenerator.java → ...entation/runseq/java/AspectGenerator.java
@@ -23,13 +23,13 @@
  *
  */
 
-package io.failify.instrumentation.java;
+package io.failify.instrumentation.runseq.java;
 
 import io.failify.Constants;
 import io.failify.instrumentation.InstrumentationDefinition;
 import io.failify.instrumentation.InstrumentationOperation;
 import io.failify.instrumentation.InstrumentationPoint;
-import io.failify.instrumentation.RunSeqRuntimeOperation;
+import io.failify.instrumentation.runseq.RunSeqRuntimeOperation;
 import io.failify.util.HashingUtil;
 import org.apache.commons.io.IOUtils;
 import org.slf4j.Logger;

diff --git a/...nstrumentation/java/JavaInstrumentor.java → ...ntation/runseq/java/JavaInstrumentor.java b/...nstrumentation/java/JavaInstrumentor.java → ...ntation/runseq/java/JavaInstrumentor.java
@@ -23,7 +23,7 @@
  *
  */
 
-package io.failify.instrumentation.java;
+package io.failify.instrumentation.runseq.java;
 
 import io.failify.exceptions.InstrumentationException;
 import io.failify.instrumentation.InstrumentationDefinition;