SED-4539 automation package collection and accessor

step-automation-packages/pom.xml

@@ -42,9 +42,11 @@
     <module>step-automation-packages-manager</module>
     <module>step-automation-packages-client</module>
     <module>step-automation-packages-controller</module>
+    <module>step-automation-packages-collections</module>
   </modules>
 
   <properties>
   </properties>
 
 </project>
+

step-automation-packages/step-automation-packages-collections/pom.xml

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>ch.exense.step</groupId>
+        <artifactId>step-automation-packages</artifactId>
+        <version>0.0.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>step-automation-packages-collections</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>ch.exense.step</groupId>
+            <artifactId>step-plans-base-artefacts</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.exense.step</groupId>
+            <artifactId>step-automation-packages-yaml</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
+        <!-- Test dependencies -->
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>ch.exense.step</groupId>
+            <artifactId>step-plans-core</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>ch.exense.step</groupId>
+            <artifactId>step-functions-plugins-jmeter-def</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>ch.exense.step</groupId>
+            <artifactId>step-functions-plugins-node-def</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>ch.exense.step</groupId>
+            <artifactId>step-automation-packages-controller</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+</project>

step-automation-packages/step-automation-packages-collections/src/main/java/step/core/collections/AutomationPackageCollectionFactory.java

@@ -0,0 +1,70 @@
+/*******************************************************************************
+ * Copyright (C) 2026, exense GmbH
+ *
+ * This file is part of STEP
+ *
+ * STEP is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * STEP is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with STEP.  If not, see <http://www.gnu.org/licenses/>.
+ ******************************************************************************/
+package step.core.collections;
+
+import step.automation.packages.yaml.AutomationPackageYamlFragmentManager;
+import step.core.collections.inmemory.InMemoryCollectionFactory;
+import step.core.plans.Plan;
+import step.functions.Function;
+import step.parameter.Parameter;
+
+import java.io.IOException;
+import java.util.Map;
+import java.util.Properties;
+import java.util.concurrent.ConcurrentHashMap;
+
+public class AutomationPackageCollectionFactory implements CollectionFactory {
+
+    private final InMemoryCollectionFactory baseFactory;
+    private final AutomationPackageYamlFragmentManager fragmentManager;
+    private final Map<String, Collection<?>> collectionsByName = new ConcurrentHashMap<>();
+
+    public AutomationPackageCollectionFactory(Properties properties, AutomationPackageYamlFragmentManager fragmentManager) {
+        this.fragmentManager = fragmentManager;
+        this.baseFactory = new InMemoryCollectionFactory(properties);
+    }
+
+    @Override
+    @SuppressWarnings("unchecked")
+    public <T> Collection<T> getCollection(String name, Class<T> entityClass) {
+        return (Collection<T>) collectionsByName.computeIfAbsent(name, (_name) -> {
+            if (Plan.class.isAssignableFrom(entityClass)) {
+                return new AutomationPackagePlanCollection(fragmentManager);
+            } else if (Parameter.class.isAssignableFrom(entityClass)) {
+                return new AutomationPackageParameterCollection(fragmentManager);
+            } else if (Function.class.isAssignableFrom(entityClass)) {
+                return new AutomationPackageFunctionCollection(fragmentManager);
+            }
+            return baseFactory.getCollection(name, entityClass);
+        });
+    }
+
+    @SuppressWarnings("rawtypes")
+    @Override
+    public Collection<EntityVersion> getVersionedCollection(String name) {
+        // TODO: I'm pretty sure the previous implementation was incorrect.
+        // Fix this once we need it and know what the correct implementation is.
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public void close() throws IOException {
+        baseFactory.close();
+    }
+}

step-automation-packages/step-automation-packages-collections/src/main/java/step/core/collections/AutomationPackageFunctionCollection.java

@@ -0,0 +1,59 @@
+/*******************************************************************************
+ * Copyright (C) 2026, exense GmbH
+ *
+ * This file is part of STEP
+ *
+ * STEP is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * STEP is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with STEP.  If not, see <http://www.gnu.org/licenses/>.
+ ******************************************************************************/
+package step.core.collections;
+
+import step.automation.packages.model.YamlAutomationPackageKeyword;
+import step.automation.packages.yaml.AutomationPackageYamlFragmentManager;
+import step.core.collections.inmemory.InMemoryCollection;
+import step.functions.Function;
+
+public class AutomationPackageFunctionCollection extends InMemoryCollection<Function> implements Collection<Function>  {
+
+
+    private final AutomationPackageYamlFragmentManager fragmentManager;
+
+    public AutomationPackageFunctionCollection(AutomationPackageYamlFragmentManager fragmentManager) {
+        super(true, YamlAutomationPackageKeyword.KEYWORDS_ENTITY_NAME);
+        this.fragmentManager = fragmentManager;
+        initialzeRecordsFromFragments(fragmentManager);
+    }
+
+    private void initialzeRecordsFromFragments(AutomationPackageYamlFragmentManager fragmentManager) {
+        // initialization into the collection memory. Calls super save to avoid calling fragmentManager.savePlan
+        fragmentManager.getBusinessObjects(Function.class).forEach(super::save);
+    }
+
+    @Override
+    public Function save(Function p){
+        return super.save(fragmentManager.saveFunction(p));
+    }
+
+    @Override
+    public void save(Iterable<Function> iterable) {
+        for (Function p : iterable) {
+            save(p);
+        }
+    }
+
+    @Override
+    public void remove(Filter filter) {
+        find(filter, null, null, null, 0).forEach(fragmentManager::removeFunction);
+        super.remove(filter);
+    }
+}

step-automation-packages/step-automation-packages-collections/src/main/java/step/core/collections/AutomationPackageParameterCollection.java

@@ -0,0 +1,61 @@
+/*******************************************************************************
+ * Copyright (C) 2026, exense GmbH
+ *
+ * This file is part of STEP
+ *
+ * STEP is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * STEP is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with STEP.  If not, see <http://www.gnu.org/licenses/>.
+ ******************************************************************************/
+package step.core.collections;
+
+import step.automation.packages.yaml.AutomationPackageYamlFragmentManager;
+import step.core.collections.inmemory.InMemoryCollection;
+import step.parameter.Parameter;
+import step.parameter.automation.AutomationPackageParameter;
+
+public class AutomationPackageParameterCollection extends InMemoryCollection<Parameter> implements Collection<Parameter>  {
+
+
+    private final AutomationPackageYamlFragmentManager fragmentManager;
+
+    public AutomationPackageParameterCollection(AutomationPackageYamlFragmentManager fragmentManager) {
+        super(true, Parameter.ENTITY_NAME);
+        this.fragmentManager = fragmentManager;
+        initialzeRecordsFromFragments(fragmentManager);
+    }
+
+    private void initialzeRecordsFromFragments(AutomationPackageYamlFragmentManager fragmentManager) {
+        // initialization into the collection memory. Calls super save to avoid calling fragmentManager.savePlan
+        fragmentManager.getBusinessObjects(Parameter.class).forEach(super::save);
+    }
+
+    @Override
+    public Parameter save(Parameter parameter){
+        return super.save(fragmentManager.saveAdditionalFieldObject(parameter, context -> AutomationPackageParameter.forContext(context, parameter), Parameter.ENTITY_NAME));
+    }
+
+    @Override
+    public void save(Iterable<Parameter> iterable) {
+        for (Parameter p : iterable) {
+            save(p);
+        }
+    }
+
+    @Override
+    public void remove(Filter filter) {
+        find(filter, null, null, null, 0).forEach(parameter ->
+            fragmentManager.removeAdditionalFieldObject(parameter, Parameter.ENTITY_NAME)
+        );
+        super.remove(filter);
+    }
+}

step-automation-packages/step-automation-packages-collections/src/main/java/step/core/collections/AutomationPackagePlanCollection.java

@@ -0,0 +1,59 @@
+/*******************************************************************************
+ * Copyright (C) 2026, exense GmbH
+ *
+ * This file is part of STEP
+ *
+ * STEP is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * STEP is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with STEP.  If not, see <http://www.gnu.org/licenses/>.
+ ******************************************************************************/
+package step.core.collections;
+
+import step.automation.packages.yaml.AutomationPackageYamlFragmentManager;
+import step.core.collections.inmemory.InMemoryCollection;
+import step.core.plans.Plan;
+import step.plans.parser.yaml.YamlPlan;
+
+public class AutomationPackagePlanCollection extends InMemoryCollection<Plan> implements Collection<Plan>  {
+
+
+    private final AutomationPackageYamlFragmentManager fragmentManager;
+
+    public AutomationPackagePlanCollection(AutomationPackageYamlFragmentManager fragmentManager) {
+        super(true, YamlPlan.PLANS_ENTITY_NAME);
+        this.fragmentManager = fragmentManager;
+        initialzeRecordsFromFragments(fragmentManager);
+    }
+
+    private void initialzeRecordsFromFragments(AutomationPackageYamlFragmentManager fragmentManager) {
+        // initialization into the collection memory. Calls super save to avoid calling fragmentManager.savePlan
+        fragmentManager.getBusinessObjects(Plan.class).forEach(super::save);
+    }
+
+    @Override
+    public Plan save(Plan p){
+        return super.save(fragmentManager.savePlan(p));
+    }
+
+    @Override
+    public void save(Iterable<Plan> iterable) {
+        for (Plan p : iterable) {
+            save(p);
+        }
+    }
+
+    @Override
+    public void remove(Filter filter) {
+        find(filter, null, null, null, 0).forEach(fragmentManager::removePlan);
+        super.remove(filter);
+    }
+}

step-automation-packages/step-automation-packages-collections/src/test/java/step/core/collections/AutomationPackageCollectionFactoryTest.java

@@ -0,0 +1,20 @@
+package step.core.collections;
+
+import org.junit.Assert;
+import org.junit.Test;
+import step.core.plans.Plan;
+import step.plans.parser.yaml.YamlPlan;
+
+import java.util.Properties;
+
+public class AutomationPackageCollectionFactoryTest extends AutomationPackageCollectionTestBase {
+
+    @Test
+    public void testCollectionIdempotence() {
+        AutomationPackageCollectionFactory cf = new AutomationPackageCollectionFactory(new Properties(), fragmentManager);
+        Collection<Plan> c1 = cf.getCollection(YamlPlan.PLANS_ENTITY_NAME, Plan.class);
+        Assert.assertTrue(c1.estimatedCount() > 0); // just for good measure
+        Collection<Plan> c2 = cf.getCollection(YamlPlan.PLANS_ENTITY_NAME, Plan.class);
+        Assert.assertSame(c1, c2);
+    }
+}