feat(runner): integrate and extend with OSGi

src/main/java/com/swisscom/aem/tools/impl/HopProviderExtension.java

@@ -0,0 +1,32 @@
+package com.swisscom.aem.tools.impl;
+
+import java.util.List;
+
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.FieldOption;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.annotations.ReferenceCardinality;
+import org.osgi.service.component.annotations.ReferencePolicy;
+import org.osgi.service.component.annotations.ReferencePolicyOption;
+
+import com.swisscom.aem.tools.jcrhopper.Hop;
+import com.swisscom.aem.tools.jcrhopper.RunnerBuilder;
+import com.swisscom.aem.tools.jcrhopper.osgi.RunnerBuilderExtension;
+
+@Component(service = RunnerBuilderExtension.class)
+public class HopProviderExtension implements RunnerBuilderExtension {
+	@Reference(
+		service = Hop.class,
+		cardinality = ReferenceCardinality.MULTIPLE,
+		policy = ReferencePolicy.DYNAMIC,
+		policyOption = ReferencePolicyOption.GREEDY,
+		fieldOption = FieldOption.REPLACE
+	)
+	@SuppressWarnings("PMD.AvoidUsingVolatile")
+	private volatile List<Hop<?>> hops;
+
+	@Override
+	public void extend(RunnerBuilder builder) {
+		builder.addHops(hops);
+	}
+}

src/main/java/com/swisscom/aem/tools/impl/hops/ChildNodes.java

@@ -17,12 +17,14 @@
 import lombok.With;
 
 import org.apache.commons.lang3.StringUtils;
+import org.osgi.service.component.annotations.Component;
 
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.Hop;
 import com.swisscom.aem.tools.jcrhopper.HopConfig;
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
+@Component(service = Hop.class)
 public class ChildNodes implements Hop<ChildNodes.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/impl/hops/CopyNode.java

@@ -19,13 +19,16 @@
 import lombok.With;
 import lombok.extern.slf4j.Slf4j;
 
+import org.osgi.service.component.annotations.Component;
+
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.ConflictResolution;
 import com.swisscom.aem.tools.jcrhopper.Hop;
 import com.swisscom.aem.tools.jcrhopper.HopConfig;
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
 @Slf4j
+@Component(service = Hop.class)
 public class CopyNode implements Hop<CopyNode.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/impl/hops/CreateChildNode.java

@@ -14,13 +14,15 @@
 import lombok.With;
 
 import org.apache.jackrabbit.JcrConstants;
+import org.osgi.service.component.annotations.Component;
 
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.ConflictResolution;
 import com.swisscom.aem.tools.jcrhopper.Hop;
 import com.swisscom.aem.tools.jcrhopper.HopConfig;
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
+@Component(service = Hop.class)
 public class CreateChildNode implements Hop<CreateChildNode.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/impl/hops/Declare.java

@@ -14,12 +14,15 @@
 import lombok.ToString;
 import lombok.With;
 
+import org.osgi.service.component.annotations.Component;
+
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.Hop;
 import com.swisscom.aem.tools.jcrhopper.HopConfig;
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
 @RequiredArgsConstructor
+@Component(service = Hop.class)
 public class Declare implements Hop<Declare.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/impl/hops/Each.java

@@ -14,12 +14,15 @@
 import lombok.ToString;
 import lombok.With;
 
+import org.osgi.service.component.annotations.Component;
+
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.Hop;
 import com.swisscom.aem.tools.jcrhopper.HopConfig;
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
 @AllArgsConstructor
+@Component(service = Hop.class)
 public class Each implements Hop<Each.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/impl/hops/FilterNode.java

@@ -13,11 +13,14 @@
 import lombok.ToString;
 import lombok.With;
 
+import org.osgi.service.component.annotations.Component;
+
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.Hop;
 import com.swisscom.aem.tools.jcrhopper.HopConfig;
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
+@Component(service = Hop.class)
 public class FilterNode implements Hop<FilterNode.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/impl/hops/MoveNode.java

@@ -19,6 +19,7 @@
 import lombok.With;
 
 import org.apache.commons.lang3.StringUtils;
+import org.osgi.service.component.annotations.Component;
 
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.ConflictResolution;
@@ -27,6 +28,7 @@
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
 @AllArgsConstructor
+@Component(service = Hop.class)
 public class MoveNode implements Hop<MoveNode.Config> {
 	/**
 	 * Resolve the path to a new node, creating the parent nodes if necessary.

src/main/java/com/swisscom/aem/tools/impl/hops/NodeQuery.java

@@ -21,12 +21,14 @@
 import lombok.With;
 
 import org.apache.commons.lang3.StringUtils;
+import org.osgi.service.component.annotations.Component;
 
+import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.Hop;
 import com.swisscom.aem.tools.jcrhopper.HopConfig;
 import com.swisscom.aem.tools.jcrhopper.HopperException;
-import com.swisscom.aem.tools.impl.HopContext;
 
+@Component(service = Hop.class)
 public class NodeQuery implements Hop<NodeQuery.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/impl/hops/RenameProperty.java

@@ -14,6 +14,7 @@
 
 import org.apache.commons.lang3.StringUtils;
 import org.apache.jackrabbit.spi.commons.conversion.IllegalNameException;
+import org.osgi.service.component.annotations.Component;
 
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.ConflictResolution;
@@ -22,6 +23,7 @@
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
 @AllArgsConstructor
+@Component(service = Hop.class)
 public class RenameProperty implements Hop<RenameProperty.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/impl/hops/ReorderNode.java

@@ -11,6 +11,7 @@
 import lombok.With;
 
 import org.apache.commons.lang3.StringUtils;
+import org.osgi.service.component.annotations.Component;
 
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.ConflictResolution;
@@ -19,6 +20,7 @@
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
 @AllArgsConstructor
+@Component(service = Hop.class)
 public class ReorderNode implements Hop<ReorderNode.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/impl/hops/ResolveNode.java

@@ -13,12 +13,15 @@
 import lombok.ToString;
 import lombok.With;
 
+import org.osgi.service.component.annotations.Component;
+
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.ConflictResolution;
 import com.swisscom.aem.tools.jcrhopper.Hop;
 import com.swisscom.aem.tools.jcrhopper.HopConfig;
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
+@Component(service = Hop.class)
 public class ResolveNode implements Hop<ResolveNode.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/impl/hops/RunScript.java

@@ -26,13 +26,15 @@
 
 import org.apache.commons.jexl3.MapContext;
 import org.apache.commons.lang3.StringUtils;
+import org.osgi.service.component.annotations.Component;
 
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.Hop;
 import com.swisscom.aem.tools.jcrhopper.HopConfig;
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
 @RequiredArgsConstructor
+@Component(service = Hop.class)
 public class RunScript implements Hop<RunScript.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/impl/hops/SetProperty.java

@@ -16,13 +16,16 @@
 import lombok.ToString;
 import lombok.With;
 
+import org.osgi.service.component.annotations.Component;
+
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.ConflictResolution;
 import com.swisscom.aem.tools.jcrhopper.Hop;
 import com.swisscom.aem.tools.jcrhopper.HopConfig;
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
 @AllArgsConstructor
+@Component(service = Hop.class)
 public class SetProperty implements Hop<SetProperty.Config> {
 	/**
 	 * Converts a property to a string representation.

src/main/java/com/swisscom/aem/tools/impl/hops/Try.java

@@ -13,12 +13,15 @@
 import lombok.ToString;
 import lombok.With;
 
+import org.osgi.service.component.annotations.Component;
+
 import com.swisscom.aem.tools.impl.HopContext;
 import com.swisscom.aem.tools.jcrhopper.Hop;
 import com.swisscom.aem.tools.jcrhopper.HopConfig;
 import com.swisscom.aem.tools.jcrhopper.HopperException;
 
 @AllArgsConstructor
+@Component(service = Hop.class)
 public class Try implements Hop<Try.Config> {
 	@Override
 	public void run(Config config, Node node, HopContext context) throws RepositoryException, HopperException {

src/main/java/com/swisscom/aem/tools/jcrhopper/Runner.java

@@ -11,6 +11,7 @@
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
+import lombok.With;
 
 import org.apache.commons.jexl3.JexlBuilder;
 import org.apache.commons.jexl3.JexlEngine;
@@ -20,6 +21,7 @@
 import com.swisscom.aem.tools.impl.JcrFunctions;
 
 @Getter
+@With
 @RequiredArgsConstructor
 public class Runner {
 	private final Script script;
@@ -58,7 +60,10 @@ public void run(Node node, boolean isDryRun) throws HopperException, RepositoryE
 			jcrFunctions,
 			variables
 		);
+		final long ts = System.currentTimeMillis();
+		context.trace("Starting JCR Hopper script on node {}", node.getPath());
 		context.runHops(node, script.getHops());
+		context.info("JCR Hopper script finished after {}ms", System.currentTimeMillis() - ts);
 		if (isDryRun) {
 			context.warn("Not saving changes as dry run is enabled");
 		}

src/main/java/com/swisscom/aem/tools/jcrhopper/osgi/RunnerBuilderExtension.java

@@ -0,0 +1,7 @@
+package com.swisscom.aem.tools.jcrhopper.osgi;
+
+import com.swisscom.aem.tools.jcrhopper.RunnerBuilder;
+
+public interface RunnerBuilderExtension {
+	void extend(RunnerBuilder builder);
+}

src/main/java/com/swisscom/aem/tools/jcrhopper/osgi/RunnerService.java

@@ -0,0 +1,36 @@
+package com.swisscom.aem.tools.jcrhopper.osgi;
+
+import java.util.List;
+
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.FieldOption;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.annotations.ReferenceCardinality;
+import org.osgi.service.component.annotations.ReferencePolicy;
+import org.osgi.service.component.annotations.ReferencePolicyOption;
+
+import com.swisscom.aem.tools.jcrhopper.Runner;
+import com.swisscom.aem.tools.jcrhopper.RunnerBuilder;
+
+@Component(service = RunnerService.class)
+public class RunnerService {
+	@Reference(
+		service = RunnerBuilderExtension.class,
+		cardinality = ReferenceCardinality.MULTIPLE,
+		policy = ReferencePolicy.DYNAMIC,
+		policyOption = ReferencePolicyOption.GREEDY,
+		fieldOption = FieldOption.REPLACE
+	)
+	@SuppressWarnings("PMD.AvoidUsingVolatile")
+	private volatile List<RunnerBuilderExtension> extensions;
+
+	public RunnerBuilder builder() {
+		RunnerBuilder runnerBuilder = Runner.builder();
+
+		for (RunnerBuilderExtension extension : extensions) {
+			extension.extend(runnerBuilder);
+		}
+
+		return runnerBuilder;
+	}
+}

src/test/java/com/swisscom/aem/tools/jcrhopper/ScriptTest.java

@@ -18,7 +18,11 @@
 
 import org.skyscreamer.jsonassert.JSONAssert;
 
+import io.wcm.testing.mock.aem.junit5.AemContext;
+import io.wcm.testing.mock.aem.junit5.JcrOakAemContext;
+
 class ScriptTest {
+	public final AemContext context = new JcrOakAemContext();
 	@Test
 	public void fromJson() throws IOException {
 		final String json = IOUtils.resourceToString("/json/pipeline-config.json", StandardCharsets.UTF_8);