This is an automated email from the ASF dual-hosted git repository.
bamaer pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hop.git
The following commit(s) were added to refs/heads/main by this push:
new 3b9d0214b0 Run configurations, samplers and other plugin-backed
metadata created in code keep their plugin id, fixes #9566 (#9569)
3b9d0214b0 is described below
commit 3b9d0214b05f6e238f933a9d5d754d592da5e043
Author: Hans Van Akelyen <[email protected]>
AuthorDate: Wed Nov 18 20:09:14 2026 +0100
Run configurations, samplers and other plugin-backed metadata created in
code keep their plugin id, fixes #9566 (#9569)
---
.../org/apache/hop/datacatalog/IDataCatalog.java | 17 ++++-
.../apache/hop/datastream/plugin/IDataStream.java | 16 +++-
.../hop/execution/IExecutionInfoLocation.java | 18 ++++-
.../execution/sampler/IExecutionDataSampler.java | 17 ++++-
.../hop/pipeline/anon/AnonymousPipelineRunner.java | 1 -
...elineRunConfigurationMetadataObjectFactory.java | 11 ++-
.../LoadBalancingPipelineRunConfiguration.java | 3 +
.../local/LocalPipelineRunConfiguration.java | 3 +
.../remote/RemotePipelineRunConfiguration.java | 3 +
...kflowRunConfigurationMetadataObjectFactory.java | 11 ++-
.../LoadBalancingWorkflowRunConfiguration.java | 3 +
.../local/LocalWorkflowRunConfiguration.java | 3 +
.../remote/RemoteWorkflowRunConfiguration.java | 3 +
.../hop/core/metadata/MetadataObjectIdTest.java | 86 +++++++++++++++++++++-
.../BeamDataFlowPipelineRunConfiguration.java | 3 +
.../flink/BeamFlinkPipelineRunConfiguration.java | 3 +
.../spark/BeamSparkPipelineRunConfiguration.java | 3 +
.../BeamPipelineRunConfigurationIdTest.java | 53 +++++++++++++
.../engine/ReplayWorkflowRunConfiguration.java | 3 +
.../ReplayWorkflowRunConfigurationIdTest.java | 41 +++++++++++
.../SingleThreadedPipelineRunConfiguration.java | 3 +
...ngleThreadedPipelineRunConfigurationIdTest.java | 39 ++++++++++
.../apache/hop/projects/gui/ProjectsGuiPlugin.java | 1 -
.../PipelineExecutionConfigurationDialog.java | 1 -
.../WorkflowExecutionConfigurationDialog.java | 1 -
25 files changed, 334 insertions(+), 12 deletions(-)
diff --git a/engine/src/main/java/org/apache/hop/datacatalog/IDataCatalog.java
b/engine/src/main/java/org/apache/hop/datacatalog/IDataCatalog.java
index 4f815fd097..4be2a04c96 100644
--- a/engine/src/main/java/org/apache/hop/datacatalog/IDataCatalog.java
+++ b/engine/src/main/java/org/apache/hop/datacatalog/IDataCatalog.java
@@ -21,6 +21,7 @@ import java.util.Optional;
import org.apache.hop.core.exception.HopException;
import org.apache.hop.core.plugins.IPlugin;
import org.apache.hop.core.plugins.PluginRegistry;
+import org.apache.hop.core.util.Utils;
import org.apache.hop.core.variables.IVariables;
import org.apache.hop.datacatalog.plugin.DataCatalogPluginType;
import org.apache.hop.metadata.api.HopMetadataObject;
@@ -97,7 +98,21 @@ public interface IDataCatalog extends Cloneable,
AutoCloseable {
throw new HopException(
"Object is not an IDataCatalog but a " +
object.getClass().getName());
}
- return catalog.getPluginId();
+ // An object created in code may not have its id yet: the registry knows
it by its class
+ String pluginId = catalog.getPluginId();
+ if (Utils.isEmpty(pluginId)) {
+ IPlugin plugin =
+
PluginRegistry.getInstance().getPlugin(DataCatalogPluginType.class, object);
+ if (plugin == null) {
+ throw new HopException(
+ "Unable to determine the plugin id of data catalog class "
+ + object.getClass().getName());
+ }
+ pluginId = plugin.getIds()[0];
+ catalog.setPluginId(pluginId);
+ catalog.setPluginName(plugin.getName());
+ }
+ return pluginId;
}
}
}
diff --git
a/engine/src/main/java/org/apache/hop/datastream/plugin/IDataStream.java
b/engine/src/main/java/org/apache/hop/datastream/plugin/IDataStream.java
index d377285812..a038f529de 100644
--- a/engine/src/main/java/org/apache/hop/datastream/plugin/IDataStream.java
+++ b/engine/src/main/java/org/apache/hop/datastream/plugin/IDataStream.java
@@ -22,6 +22,7 @@ import org.apache.hop.core.exception.HopException;
import org.apache.hop.core.plugins.IPlugin;
import org.apache.hop.core.plugins.PluginRegistry;
import org.apache.hop.core.row.IRowMeta;
+import org.apache.hop.core.util.Utils;
import org.apache.hop.core.variables.IVariables;
import org.apache.hop.datastream.metadata.DataStreamMeta;
import org.apache.hop.metadata.api.HopMetadataObject;
@@ -153,7 +154,20 @@ public interface IDataStream extends Cloneable {
throw new HopException(
"Object provided needs to be of class " +
IDataStream.class.getName());
}
- return dataStream.getPluginId();
+ // An object created in code may not have its id yet: the registry knows
it by its class
+ String pluginId = dataStream.getPluginId();
+ if (Utils.isEmpty(pluginId)) {
+ IPlugin plugin =
PluginRegistry.getInstance().getPlugin(DataStreamPluginType.class, object);
+ if (plugin == null) {
+ throw new HopException(
+ "Unable to determine the plugin id of data stream class "
+ + object.getClass().getName());
+ }
+ pluginId = plugin.getIds()[0];
+ dataStream.setPluginId(pluginId);
+ dataStream.setPluginName(plugin.getName());
+ }
+ return pluginId;
}
}
}
diff --git
a/engine/src/main/java/org/apache/hop/execution/IExecutionInfoLocation.java
b/engine/src/main/java/org/apache/hop/execution/IExecutionInfoLocation.java
index 03608dd277..105ad9f77e 100644
--- a/engine/src/main/java/org/apache/hop/execution/IExecutionInfoLocation.java
+++ b/engine/src/main/java/org/apache/hop/execution/IExecutionInfoLocation.java
@@ -25,6 +25,7 @@ import org.apache.hop.core.IProgressMonitor;
import org.apache.hop.core.exception.HopException;
import org.apache.hop.core.plugins.IPlugin;
import org.apache.hop.core.plugins.PluginRegistry;
+import org.apache.hop.core.util.Utils;
import org.apache.hop.core.variables.IVariables;
import org.apache.hop.execution.plugin.ExecutionInfoLocationPluginType;
import org.apache.hop.metadata.api.HopMetadataObject;
@@ -318,7 +319,22 @@ public interface IExecutionInfoLocation extends Cloneable {
+ object.getClass().getName()
+ "'");
}
- return ((IExecutionInfoLocation) object).getPluginId();
+ IExecutionInfoLocation location = (IExecutionInfoLocation) object;
+ // An object created in code may not have its id yet: the registry knows
it by its class
+ String pluginId = location.getPluginId();
+ if (Utils.isEmpty(pluginId)) {
+ IPlugin plugin =
+
PluginRegistry.getInstance().getPlugin(ExecutionInfoLocationPluginType.class,
object);
+ if (plugin == null) {
+ throw new HopException(
+ "Unable to determine the plugin id of execution information
location class "
+ + object.getClass().getName());
+ }
+ pluginId = plugin.getIds()[0];
+ location.setPluginId(pluginId);
+ location.setPluginName(plugin.getName());
+ }
+ return pluginId;
}
}
}
diff --git
a/engine/src/main/java/org/apache/hop/execution/sampler/IExecutionDataSampler.java
b/engine/src/main/java/org/apache/hop/execution/sampler/IExecutionDataSampler.java
index 28ed68c938..e5f6a51977 100644
---
a/engine/src/main/java/org/apache/hop/execution/sampler/IExecutionDataSampler.java
+++
b/engine/src/main/java/org/apache/hop/execution/sampler/IExecutionDataSampler.java
@@ -23,6 +23,7 @@ import org.apache.hop.core.exception.HopException;
import org.apache.hop.core.plugins.IPlugin;
import org.apache.hop.core.plugins.PluginRegistry;
import org.apache.hop.core.row.IRowMeta;
+import org.apache.hop.core.util.Utils;
import org.apache.hop.metadata.api.HopMetadataObject;
import org.apache.hop.metadata.api.IHopMetadataObjectFactory;
import org.apache.hop.pipeline.transform.stream.IStream;
@@ -100,7 +101,21 @@ public interface IExecutionDataSampler<Store extends
IExecutionDataSamplerStore>
+ object.getClass().getName()
+ "'");
}
- return ((IExecutionDataSampler<?>) object).getPluginId();
+ IExecutionDataSampler<?> sampler = (IExecutionDataSampler<?>) object;
+ // An object created in code may not have its id yet: the registry knows
it by its class
+ String pluginId = sampler.getPluginId();
+ if (Utils.isEmpty(pluginId)) {
+ IPlugin plugin =
+
PluginRegistry.getInstance().getPlugin(ExecutionDataSamplerPluginType.class,
object);
+ if (plugin == null) {
+ throw new HopException(
+ "Unable to determine the plugin id of sampler class " +
object.getClass().getName());
+ }
+ pluginId = plugin.getIds()[0];
+ sampler.setPluginId(pluginId);
+ sampler.setPluginName(plugin.getName());
+ }
+ return pluginId;
}
}
}
diff --git
a/engine/src/main/java/org/apache/hop/pipeline/anon/AnonymousPipelineRunner.java
b/engine/src/main/java/org/apache/hop/pipeline/anon/AnonymousPipelineRunner.java
index cbaa1a9dc2..8f699ad33c 100644
---
a/engine/src/main/java/org/apache/hop/pipeline/anon/AnonymousPipelineRunner.java
+++
b/engine/src/main/java/org/apache/hop/pipeline/anon/AnonymousPipelineRunner.java
@@ -58,7 +58,6 @@ public class AnonymousPipelineRunner {
new LocalPipelineRunConfiguration(),
null,
false);
- runConfiguration.getEngineRunConfiguration().setEnginePluginId("Local");
// To avoid classpath issues we need to serialize the pipeline metadata
to XML and re-inflate
// it.
diff --git
a/engine/src/main/java/org/apache/hop/pipeline/config/PipelineRunConfigurationMetadataObjectFactory.java
b/engine/src/main/java/org/apache/hop/pipeline/config/PipelineRunConfigurationMetadataObjectFactory.java
index 74332efa92..b3453a5908 100644
---
a/engine/src/main/java/org/apache/hop/pipeline/config/PipelineRunConfigurationMetadataObjectFactory.java
+++
b/engine/src/main/java/org/apache/hop/pipeline/config/PipelineRunConfigurationMetadataObjectFactory.java
@@ -21,6 +21,7 @@ import org.apache.hop.core.exception.HopException;
import org.apache.hop.core.exception.HopPluginException;
import org.apache.hop.core.plugins.IPlugin;
import org.apache.hop.core.plugins.PluginRegistry;
+import org.apache.hop.core.util.Utils;
import org.apache.hop.core.variables.IVariables;
import org.apache.hop.metadata.api.IHopMetadataObjectFactory;
import org.apache.hop.pipeline.engine.IPipelineEngine;
@@ -65,6 +66,14 @@ public class PipelineRunConfigurationMetadataObjectFactory
implements IHopMetada
"Object provided needs to be of class "
+ IPipelineEngineRunConfiguration.class.getName());
}
- return ((IPipelineEngineRunConfiguration) object).getEnginePluginId();
+ String pluginId = ((IPipelineEngineRunConfiguration)
object).getEnginePluginId();
+ if (Utils.isEmpty(pluginId)) {
+ // Written without it, the run configuration can't be read back
+ throw new HopException(
+ "The pipeline engine run configuration of class "
+ + object.getClass().getName()
+ + " has no engine plugin id");
+ }
+ return pluginId;
}
}
diff --git
a/engine/src/main/java/org/apache/hop/pipeline/engines/loadbalance/LoadBalancingPipelineRunConfiguration.java
b/engine/src/main/java/org/apache/hop/pipeline/engines/loadbalance/LoadBalancingPipelineRunConfiguration.java
index 662136afc0..54b013fb7f 100644
---
a/engine/src/main/java/org/apache/hop/pipeline/engines/loadbalance/LoadBalancingPipelineRunConfiguration.java
+++
b/engine/src/main/java/org/apache/hop/pipeline/engines/loadbalance/LoadBalancingPipelineRunConfiguration.java
@@ -243,6 +243,9 @@ public class LoadBalancingPipelineRunConfiguration extends
EmptyPipelineRunConfi
public LoadBalancingPipelineRunConfiguration() {
super();
+ // The engine it configures: needed to save it, also when it isn't created
from metadata
+ setEnginePluginId("LoadBalancing");
+ setEnginePluginName("Hop load-balancing pipeline engine");
this.servers = new ArrayList<>();
this.algorithm = LoadBalancingAlgorithm.EVEN_LOAD.getDescription();
this.maxRetries = "2";
diff --git
a/engine/src/main/java/org/apache/hop/pipeline/engines/local/LocalPipelineRunConfiguration.java
b/engine/src/main/java/org/apache/hop/pipeline/engines/local/LocalPipelineRunConfiguration.java
index 591298ce66..41b2eff8a1 100644
---
a/engine/src/main/java/org/apache/hop/pipeline/engines/local/LocalPipelineRunConfiguration.java
+++
b/engine/src/main/java/org/apache/hop/pipeline/engines/local/LocalPipelineRunConfiguration.java
@@ -223,6 +223,9 @@ public class LocalPipelineRunConfiguration extends
EmptyPipelineRunConfiguration
public LocalPipelineRunConfiguration() {
super();
+ // The engine it configures: needed to save it, also when it isn't created
from metadata
+ setEnginePluginId("Local");
+ setEnginePluginName("Hop local pipeline engine");
this.rowSetSize = Integer.toString(Const.ROWS_IN_ROWSET);
this.feedbackShown = false;
this.feedbackSize = Integer.toString(Const.ROWS_UPDATE);
diff --git
a/engine/src/main/java/org/apache/hop/pipeline/engines/remote/RemotePipelineRunConfiguration.java
b/engine/src/main/java/org/apache/hop/pipeline/engines/remote/RemotePipelineRunConfiguration.java
index a7b88df8ed..3874168a32 100644
---
a/engine/src/main/java/org/apache/hop/pipeline/engines/remote/RemotePipelineRunConfiguration.java
+++
b/engine/src/main/java/org/apache/hop/pipeline/engines/remote/RemotePipelineRunConfiguration.java
@@ -113,6 +113,9 @@ public class RemotePipelineRunConfiguration extends
EmptyPipelineRunConfiguratio
public RemotePipelineRunConfiguration() {
super();
+ // The engine it configures: needed to save it, also when it isn't created
from metadata
+ setEnginePluginId("Remote");
+ setEnginePluginName("Hop remote pipeline engine");
}
public RemotePipelineRunConfiguration(RemotePipelineRunConfiguration config)
{
diff --git
a/engine/src/main/java/org/apache/hop/workflow/config/WorkflowRunConfigurationMetadataObjectFactory.java
b/engine/src/main/java/org/apache/hop/workflow/config/WorkflowRunConfigurationMetadataObjectFactory.java
index 111dcad970..e32d2074d9 100644
---
a/engine/src/main/java/org/apache/hop/workflow/config/WorkflowRunConfigurationMetadataObjectFactory.java
+++
b/engine/src/main/java/org/apache/hop/workflow/config/WorkflowRunConfigurationMetadataObjectFactory.java
@@ -21,6 +21,7 @@ import org.apache.hop.core.exception.HopException;
import org.apache.hop.core.exception.HopPluginException;
import org.apache.hop.core.plugins.IPlugin;
import org.apache.hop.core.plugins.PluginRegistry;
+import org.apache.hop.core.util.Utils;
import org.apache.hop.core.variables.IVariables;
import org.apache.hop.metadata.api.IHopMetadataObjectFactory;
import org.apache.hop.workflow.engine.IWorkflowEngine;
@@ -65,6 +66,14 @@ public class WorkflowRunConfigurationMetadataObjectFactory
implements IHopMetada
"Object provided needs to be of class "
+ IWorkflowEngineRunConfiguration.class.getName());
}
- return ((IWorkflowEngineRunConfiguration) object).getEnginePluginId();
+ String pluginId = ((IWorkflowEngineRunConfiguration)
object).getEnginePluginId();
+ if (Utils.isEmpty(pluginId)) {
+ // Written without it, the run configuration can't be read back
+ throw new HopException(
+ "The workflow engine run configuration of class "
+ + object.getClass().getName()
+ + " has no engine plugin id");
+ }
+ return pluginId;
}
}
diff --git
a/engine/src/main/java/org/apache/hop/workflow/engines/loadbalance/LoadBalancingWorkflowRunConfiguration.java
b/engine/src/main/java/org/apache/hop/workflow/engines/loadbalance/LoadBalancingWorkflowRunConfiguration.java
index c825abd778..9cd6d1a9cc 100644
---
a/engine/src/main/java/org/apache/hop/workflow/engines/loadbalance/LoadBalancingWorkflowRunConfiguration.java
+++
b/engine/src/main/java/org/apache/hop/workflow/engines/loadbalance/LoadBalancingWorkflowRunConfiguration.java
@@ -242,6 +242,9 @@ public class LoadBalancingWorkflowRunConfiguration extends
EmptyWorkflowRunConfi
public LoadBalancingWorkflowRunConfiguration() {
super();
+ // The engine it configures: needed to save it, also when it isn't created
from metadata
+ setEnginePluginId("LoadBalancing");
+ setEnginePluginName("Hop load-balancing workflow engine");
this.servers = new ArrayList<>();
this.algorithm = LoadBalancingAlgorithm.EVEN_LOAD.getDescription();
this.maxRetries = "2";
diff --git
a/engine/src/main/java/org/apache/hop/workflow/engines/local/LocalWorkflowRunConfiguration.java
b/engine/src/main/java/org/apache/hop/workflow/engines/local/LocalWorkflowRunConfiguration.java
index 5b57bb5e3f..16ec7c1526 100644
---
a/engine/src/main/java/org/apache/hop/workflow/engines/local/LocalWorkflowRunConfiguration.java
+++
b/engine/src/main/java/org/apache/hop/workflow/engines/local/LocalWorkflowRunConfiguration.java
@@ -52,6 +52,9 @@ public class LocalWorkflowRunConfiguration extends
EmptyWorkflowRunConfiguration
public LocalWorkflowRunConfiguration() {
super();
+ // The engine it configures: needed to save it, also when it isn't created
from metadata
+ setEnginePluginId("Local");
+ setEnginePluginName("Hop local workflow engine");
safeModeEnabled = false;
}
diff --git
a/engine/src/main/java/org/apache/hop/workflow/engines/remote/RemoteWorkflowRunConfiguration.java
b/engine/src/main/java/org/apache/hop/workflow/engines/remote/RemoteWorkflowRunConfiguration.java
index c58aab249b..e798f2dbfc 100644
---
a/engine/src/main/java/org/apache/hop/workflow/engines/remote/RemoteWorkflowRunConfiguration.java
+++
b/engine/src/main/java/org/apache/hop/workflow/engines/remote/RemoteWorkflowRunConfiguration.java
@@ -109,6 +109,9 @@ public class RemoteWorkflowRunConfiguration extends
EmptyWorkflowRunConfiguratio
public RemoteWorkflowRunConfiguration() {
super();
+ // The engine it configures: needed to save it, also when it isn't created
from metadata
+ setEnginePluginId("Remote");
+ setEnginePluginName("Hop remote workflow engine");
}
public RemoteWorkflowRunConfiguration(RemoteWorkflowRunConfiguration config)
{
diff --git
a/engine/src/test/java/org/apache/hop/core/metadata/MetadataObjectIdTest.java
b/engine/src/test/java/org/apache/hop/core/metadata/MetadataObjectIdTest.java
index c15f7cb432..3cdac2fc28 100644
---
a/engine/src/test/java/org/apache/hop/core/metadata/MetadataObjectIdTest.java
+++
b/engine/src/test/java/org/apache/hop/core/metadata/MetadataObjectIdTest.java
@@ -19,6 +19,7 @@ package org.apache.hop.core.metadata;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertInstanceOf;
+import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.lang.reflect.Field;
@@ -30,10 +31,13 @@ import java.util.Map;
import java.util.TreeMap;
import org.apache.hop.core.database.DatabasePluginType;
import org.apache.hop.core.database.IDatabase;
+import org.apache.hop.core.exception.HopException;
import org.apache.hop.core.plugins.IPlugin;
import org.apache.hop.core.plugins.PluginRegistry;
import org.apache.hop.execution.ExecutionInfoLocation;
import org.apache.hop.execution.local.FileExecutionInfoLocation;
+import org.apache.hop.execution.sampler.IExecutionDataSampler;
+import
org.apache.hop.execution.sampler.plugins.first.FirstRowsExecutionDataSampler;
import org.apache.hop.junit.rules.RestoreHopEngineEnvironmentExtension;
import org.apache.hop.metadata.api.HopMetadata;
import org.apache.hop.metadata.api.HopMetadataDefaultObjectFactory;
@@ -44,8 +48,12 @@ import org.apache.hop.metadata.api.IHopMetadataObjectFactory;
import org.apache.hop.metadata.api.IHopMetadataSerializer;
import org.apache.hop.metadata.plugin.MetadataPluginType;
import org.apache.hop.pipeline.config.IPipelineEngineRunConfiguration;
+import
org.apache.hop.pipeline.config.PipelineRunConfigurationMetadataObjectFactory;
+import org.apache.hop.pipeline.engine.IPipelineEngine;
import org.apache.hop.pipeline.engine.PipelineEnginePluginType;
+import org.apache.hop.pipeline.engines.EmptyPipelineRunConfiguration;
import org.apache.hop.workflow.config.IWorkflowEngineRunConfiguration;
+import org.apache.hop.workflow.engine.IWorkflowEngine;
import org.apache.hop.workflow.engine.WorkflowEnginePluginType;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
@@ -83,6 +91,80 @@ class MetadataObjectIdTest {
@Test
void everyRegisteredPluginComesBackAsItselfWhenSavedAgain() throws Exception
{
+ // As read from a file
+ assertEveryRegisteredPluginComesBack(
+ (registry, factory, valueType, id) -> factory.createObject(id, null));
+ }
+
+ /**
+ * Created in code, as a default run configuration or with its own
constructor, without anybody
+ * setting its plugin ID: saved and read again it still comes back as itself.
+ */
+ @Test
+ void everyRegisteredPluginCreatedInCodeComesBackAsItself() throws Exception {
+ assertEveryRegisteredPluginComesBack(
+ (registry, factory, valueType, id) -> createdInCode(registry,
valueType, id));
+ }
+
+ /** Without an ID and of no registered plugin, saving fails instead of
writing a null key. */
+ @Test
+ void anObjectOfNoKnownPluginIsAnError() {
+ // A class of its own, which no plugin registers
+ FirstRowsExecutionDataSampler unknownSampler = new
FirstRowsExecutionDataSampler() {};
+ HopException samplerError =
+ assertThrows(
+ HopException.class,
+ () ->
+ new IExecutionDataSampler.ExecutionDataSamplerObjectFactory()
+ .getObjectId(unknownSampler));
+ assertTrue(samplerError.getMessage().contains("plugin id"),
samplerError.getMessage());
+
+ EmptyPipelineRunConfiguration noEngine = new
EmptyPipelineRunConfiguration();
+ HopException runConfigurationError =
+ assertThrows(
+ HopException.class,
+ () -> new
PipelineRunConfigurationMetadataObjectFactory().getObjectId(noEngine));
+ assertTrue(
+ runConfigurationError.getMessage().contains("engine plugin id"),
+ runConfigurationError.getMessage());
+ }
+
+ /** An object of a property type for one plugin ID. */
+ private interface IObjectCreator {
+ Object create(
+ PluginRegistry registry, IHopMetadataObjectFactory factory, Class<?>
valueType, String id)
+ throws Exception;
+ }
+
+ private static Object createdInCode(PluginRegistry registry, Class<?>
valueType, String id)
+ throws Exception {
+ if (valueType == IPipelineEngineRunConfiguration.class) {
+ IPlugin engine =
registry.findPluginWithId(PipelineEnginePluginType.class, id);
+ return registry
+ .loadClass(engine, IPipelineEngine.class)
+ .createDefaultPipelineEngineRunConfiguration();
+ }
+ if (valueType == IWorkflowEngineRunConfiguration.class) {
+ IPlugin engine =
registry.findPluginWithId(WorkflowEnginePluginType.class, id);
+ return registry
+ .loadClass(engine, IWorkflowEngine.class)
+ .createDefaultWorkflowEngineRunConfiguration();
+ }
+ if (valueType == IDatabase.class) {
+ // The database plugin type doesn't name its main type
+ return
registry.loadClass(registry.findPluginWithId(DatabasePluginType.class, id));
+ }
+ for (var pluginType : registry.getPluginTypes()) {
+ IPlugin plugin = registry.findPluginWithId(pluginType, id);
+ if (plugin != null && plugin.getMainType() == valueType) {
+ return registry.loadClass(plugin);
+ }
+ }
+ throw new IllegalStateException("No plugin with ID " + id + " for " +
valueType.getName());
+ }
+
+ private static void assertEveryRegisteredPluginComesBack(IObjectCreator
creator)
+ throws Exception {
PluginRegistry registry = PluginRegistry.getInstance();
List<String> failures = new ArrayList<>();
Map<String, Integer> roundTrips = new TreeMap<>();
@@ -99,8 +181,8 @@ class MetadataObjectIdTest {
.newInstance();
String property = holderClass.getSimpleName() + "." + field.getName();
for (String id : pluginIds(registry, valueType)) {
- // As read from a file, and as the copy an editor or a run works on
- Object read = factory.createObject(id, null);
+ // As created, and as the copy an editor or a run works on
+ Object read = creator.create(registry, factory, valueType, id);
List<Object> objects = new ArrayList<>(List.of(read));
Method clone = publicClone(read);
if (clone != null) {
diff --git
a/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/dataflow/BeamDataFlowPipelineRunConfiguration.java
b/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/dataflow/BeamDataFlowPipelineRunConfiguration.java
index 367c983be0..ac913f13b6 100644
---
a/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/dataflow/BeamDataFlowPipelineRunConfiguration.java
+++
b/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/dataflow/BeamDataFlowPipelineRunConfiguration.java
@@ -212,6 +212,9 @@ public class BeamDataFlowPipelineRunConfiguration extends
BeamPipelineRunConfigu
public BeamDataFlowPipelineRunConfiguration() {
super();
+ // The engine it configures: needed to save it, also when it isn't created
from metadata
+ setEnginePluginId("BeamDataFlowPipelineEngine");
+ setEnginePluginName("Beam DataFlow pipeline engine");
this.gcpAppName = "Hop";
this.gcpUsingPublicIps = true;
}
diff --git
a/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/flink/BeamFlinkPipelineRunConfiguration.java
b/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/flink/BeamFlinkPipelineRunConfiguration.java
index 652cf1bc91..046bad4de1 100644
---
a/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/flink/BeamFlinkPipelineRunConfiguration.java
+++
b/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/flink/BeamFlinkPipelineRunConfiguration.java
@@ -213,6 +213,9 @@ public class BeamFlinkPipelineRunConfiguration extends
BeamPipelineRunConfigurat
public BeamFlinkPipelineRunConfiguration() {
super();
+ // The engine it configures: needed to save it, also when it isn't created
from metadata
+ setEnginePluginId("BeamFlinkPipelineEngine");
+ setEnginePluginName("Beam Flink pipeline engine");
this.tempLocation = "file://" + System.getProperty("java.io.tmpdir");
// Batch pipelines can deadlock with Flink's default PIPELINED mode; see
FLINK-10672.
this.flinkExecutionModeForBatch = ExecutionMode.BATCH_FORCED.name();
diff --git
a/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/spark/BeamSparkPipelineRunConfiguration.java
b/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/spark/BeamSparkPipelineRunConfiguration.java
index 0f46671df0..ba36f1d903 100644
---
a/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/spark/BeamSparkPipelineRunConfiguration.java
+++
b/plugins/engines/beam/src/main/java/org/apache/hop/beam/engines/spark/BeamSparkPipelineRunConfiguration.java
@@ -177,6 +177,9 @@ public class BeamSparkPipelineRunConfiguration extends
BeamPipelineRunConfigurat
public BeamSparkPipelineRunConfiguration() {
super();
+ // The engine it configures: needed to save it, also when it isn't created
from metadata
+ setEnginePluginId("BeamSparkPipelineEngine");
+ setEnginePluginName("Beam Spark pipeline engine");
this.tempLocation = System.getProperty("java.io.tmpdir");
}
diff --git
a/plugins/engines/beam/src/test/java/org/apache/hop/beam/engines/BeamPipelineRunConfigurationIdTest.java
b/plugins/engines/beam/src/test/java/org/apache/hop/beam/engines/BeamPipelineRunConfigurationIdTest.java
new file mode 100644
index 0000000000..363d1bb421
--- /dev/null
+++
b/plugins/engines/beam/src/test/java/org/apache/hop/beam/engines/BeamPipelineRunConfigurationIdTest.java
@@ -0,0 +1,53 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.hop.beam.engines;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.util.Map;
+import org.apache.hop.beam.engines.dataflow.BeamDataFlowPipelineEngine;
+import
org.apache.hop.beam.engines.dataflow.BeamDataFlowPipelineRunConfiguration;
+import org.apache.hop.beam.engines.direct.BeamDirectPipelineEngine;
+import org.apache.hop.beam.engines.direct.BeamDirectPipelineRunConfiguration;
+import org.apache.hop.beam.engines.flink.BeamFlinkPipelineEngine;
+import org.apache.hop.beam.engines.flink.BeamFlinkPipelineRunConfiguration;
+import org.apache.hop.beam.engines.spark.BeamSparkPipelineEngine;
+import org.apache.hop.beam.engines.spark.BeamSparkPipelineRunConfiguration;
+import org.apache.hop.pipeline.engine.PipelineEnginePlugin;
+import org.junit.jupiter.api.Test;
+
+/** A run configuration created in code names its engine, so it can be saved
and read back. */
+class BeamPipelineRunConfigurationIdTest {
+
+ @Test
+ void eachDefaultRunConfigurationNamesItsEngine() {
+ Map<Class<?>, BeamPipelineRunConfiguration> configurations =
+ Map.of(
+ BeamDirectPipelineEngine.class, new
BeamDirectPipelineRunConfiguration(),
+ BeamDataFlowPipelineEngine.class, new
BeamDataFlowPipelineRunConfiguration(),
+ BeamFlinkPipelineEngine.class, new
BeamFlinkPipelineRunConfiguration(),
+ BeamSparkPipelineEngine.class, new
BeamSparkPipelineRunConfiguration());
+
+ configurations.forEach(
+ (engineClass, configuration) ->
+ assertEquals(
+ engineClass.getAnnotation(PipelineEnginePlugin.class).id(),
+ configuration.getEnginePluginId(),
+ engineClass.getSimpleName()));
+ }
+}
diff --git
a/plugins/engines/replay/src/main/java/org/apache/hop/replay/engine/ReplayWorkflowRunConfiguration.java
b/plugins/engines/replay/src/main/java/org/apache/hop/replay/engine/ReplayWorkflowRunConfiguration.java
index 77f5259380..658809dd90 100644
---
a/plugins/engines/replay/src/main/java/org/apache/hop/replay/engine/ReplayWorkflowRunConfiguration.java
+++
b/plugins/engines/replay/src/main/java/org/apache/hop/replay/engine/ReplayWorkflowRunConfiguration.java
@@ -53,6 +53,9 @@ public class ReplayWorkflowRunConfiguration extends
LocalWorkflowRunConfiguratio
public ReplayWorkflowRunConfiguration() {
super();
+ // The engine it configures: needed to save it, also when it isn't created
from metadata
+ setEnginePluginId("Replay");
+ setEnginePluginName("Hop replay workflow engine");
}
public ReplayWorkflowRunConfiguration(ReplayWorkflowRunConfiguration config)
{
diff --git
a/plugins/engines/replay/src/test/java/org/apache/hop/replay/engine/ReplayWorkflowRunConfigurationIdTest.java
b/plugins/engines/replay/src/test/java/org/apache/hop/replay/engine/ReplayWorkflowRunConfigurationIdTest.java
new file mode 100644
index 0000000000..02eb77f5d6
--- /dev/null
+++
b/plugins/engines/replay/src/test/java/org/apache/hop/replay/engine/ReplayWorkflowRunConfigurationIdTest.java
@@ -0,0 +1,41 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.hop.replay.engine;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.apache.hop.workflow.engine.WorkflowEnginePlugin;
+import org.junit.jupiter.api.Test;
+
+/**
+ * A run configuration created in code names its engine, so it can be saved
and read back. The
+ * replay configuration extends the local one, and still names the replay
engine.
+ */
+class ReplayWorkflowRunConfigurationIdTest {
+
+ @Test
+ void theDefaultRunConfigurationNamesItsEngine() {
+ WorkflowEnginePlugin engine =
+ ReplayWorkflowEngine.class.getAnnotation(WorkflowEnginePlugin.class);
+
+ ReplayWorkflowRunConfiguration configuration = new
ReplayWorkflowRunConfiguration();
+
+ assertEquals(engine.id(), configuration.getEnginePluginId());
+ assertEquals(engine.name(), configuration.getEnginePluginName());
+ }
+}
diff --git
a/plugins/engines/single-threaded/src/main/java/org/apache/hop/pipeline/engines/singlethreaded/SingleThreadedPipelineRunConfiguration.java
b/plugins/engines/single-threaded/src/main/java/org/apache/hop/pipeline/engines/singlethreaded/SingleThreadedPipelineRunConfiguration.java
index 025e8007e1..691266064d 100644
---
a/plugins/engines/single-threaded/src/main/java/org/apache/hop/pipeline/engines/singlethreaded/SingleThreadedPipelineRunConfiguration.java
+++
b/plugins/engines/single-threaded/src/main/java/org/apache/hop/pipeline/engines/singlethreaded/SingleThreadedPipelineRunConfiguration.java
@@ -63,6 +63,9 @@ public class SingleThreadedPipelineRunConfiguration extends
EmptyPipelineRunConf
public SingleThreadedPipelineRunConfiguration() {
super();
+ // The engine it configures: needed to save it, also when it isn't created
from metadata
+ setEnginePluginId("LocalSingle");
+ setEnginePluginName("Hop local single threaded pipeline engine");
this.sampleTypeInGui =
LocalPipelineRunConfiguration.SampleType.Last.name();
this.sampleSize = "100";
}
diff --git
a/plugins/engines/single-threaded/src/test/java/org/apache/hop/pipeline/engines/singlethreaded/SingleThreadedPipelineRunConfigurationIdTest.java
b/plugins/engines/single-threaded/src/test/java/org/apache/hop/pipeline/engines/singlethreaded/SingleThreadedPipelineRunConfigurationIdTest.java
new file mode 100644
index 0000000000..e10b481171
--- /dev/null
+++
b/plugins/engines/single-threaded/src/test/java/org/apache/hop/pipeline/engines/singlethreaded/SingleThreadedPipelineRunConfigurationIdTest.java
@@ -0,0 +1,39 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.hop.pipeline.engines.singlethreaded;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.apache.hop.pipeline.engine.PipelineEnginePlugin;
+import org.junit.jupiter.api.Test;
+
+/** A run configuration created in code names its engine, so it can be saved
and read back. */
+class SingleThreadedPipelineRunConfigurationIdTest {
+
+ @Test
+ void theDefaultRunConfigurationNamesItsEngine() {
+ PipelineEnginePlugin engine =
+
SingleThreadedPipelineEngine.class.getAnnotation(PipelineEnginePlugin.class);
+
+ SingleThreadedPipelineRunConfiguration configuration =
+ new SingleThreadedPipelineRunConfiguration();
+
+ assertEquals(engine.id(), configuration.getEnginePluginId());
+ assertEquals(engine.name(), configuration.getEnginePluginName());
+ }
+}
diff --git
a/plugins/misc/projects/src/main/java/org/apache/hop/projects/gui/ProjectsGuiPlugin.java
b/plugins/misc/projects/src/main/java/org/apache/hop/projects/gui/ProjectsGuiPlugin.java
index ec79d405c5..b1d1acd4b2 100644
---
a/plugins/misc/projects/src/main/java/org/apache/hop/projects/gui/ProjectsGuiPlugin.java
+++
b/plugins/misc/projects/src/main/java/org/apache/hop/projects/gui/ProjectsGuiPlugin.java
@@ -1343,7 +1343,6 @@ public class ProjectsGuiPlugin {
if ((answer & SWT.YES) != 0) {
LocalWorkflowRunConfiguration localWorkflowRunConfiguration =
new LocalWorkflowRunConfiguration();
- localWorkflowRunConfiguration.setEnginePluginId("Local");
WorkflowRunConfiguration local =
new WorkflowRunConfiguration(
"local",
diff --git
a/ui/src/main/java/org/apache/hop/ui/pipeline/dialog/PipelineExecutionConfigurationDialog.java
b/ui/src/main/java/org/apache/hop/ui/pipeline/dialog/PipelineExecutionConfigurationDialog.java
index 4d2de42cd6..08e9873fd2 100644
---
a/ui/src/main/java/org/apache/hop/ui/pipeline/dialog/PipelineExecutionConfigurationDialog.java
+++
b/ui/src/main/java/org/apache/hop/ui/pipeline/dialog/PipelineExecutionConfigurationDialog.java
@@ -355,7 +355,6 @@ public class PipelineExecutionConfigurationDialog extends
ConfigurationDialog {
if ((answer & SWT.YES) != 0) {
LocalPipelineRunConfiguration localPipelineRunConfiguration =
new LocalPipelineRunConfiguration();
- localPipelineRunConfiguration.setEnginePluginId("Local");
PipelineRunConfiguration local =
new PipelineRunConfiguration(
"local",
diff --git
a/ui/src/main/java/org/apache/hop/ui/workflow/dialog/WorkflowExecutionConfigurationDialog.java
b/ui/src/main/java/org/apache/hop/ui/workflow/dialog/WorkflowExecutionConfigurationDialog.java
index 898b8d8a48..e6e649aa30 100644
---
a/ui/src/main/java/org/apache/hop/ui/workflow/dialog/WorkflowExecutionConfigurationDialog.java
+++
b/ui/src/main/java/org/apache/hop/ui/workflow/dialog/WorkflowExecutionConfigurationDialog.java
@@ -400,7 +400,6 @@ public class WorkflowExecutionConfigurationDialog extends
ConfigurationDialog {
if ((answer & SWT.YES) != 0) {
LocalWorkflowRunConfiguration localWorkflowRunConfiguration =
new LocalWorkflowRunConfiguration();
- localWorkflowRunConfiguration.setEnginePluginId("Local");
WorkflowRunConfiguration local =
new WorkflowRunConfiguration(
"local",