SED-4539 automation package collection and accessor by cmisev · Pull Request #615 · exense/step

cmisev · 2026-03-19T08:56:30Z

No description provided.

…-accessor-2

gemini-code-assist · 2026-03-19T08:57:17Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a robust framework for managing automation package YAML files programmatically, particularly focusing on plans. By providing collection-like access and precise YAML patching capabilities, it lays the groundwork for more sophisticated tooling, such as IDE integrations, that can manipulate automation package definitions while preserving their integrity and structure.

Highlights

New Module Introduction: A new Maven module, step-automation-packages-ide, has been introduced to house functionalities related to IDE integration for automation packages.
YAML Fragment Management: A new AutomationPackageYamlFragmentManager class has been implemented to centralize the management of YAML fragments within automation packages, enabling programmatic saving, modification, and removal of entities like plans while preserving YAML structure.
Collection-like Access for Plans: New AutomationPackageCollectionFactory and AutomationPackagePlanCollection classes provide a collection-like interface for interacting with plans defined in automation package YAML files, facilitating CRUD operations.
Enhanced YAML Deserialization for Patching: The YAML deserialization process has been significantly enhanced with PatchableYamlArtefact, PatchingParserDelegate, and PatchableYamlArtefactDeserializer to capture precise source location information, which is crucial for making targeted modifications to YAML content.
Refactoring of YAML Model and Reader: Core YAML model classes (AbstractAutomationPackageFragmentYaml, AutomationPackageDescriptorYamlImpl, AutomationPackageFragmentYaml) and the AutomationPackageDescriptorReader have been refactored to support the new fragment management and deserialization capabilities, including Jackson injection for dependencies and dynamic handling of additional fields.
Comprehensive Testing: Extensive unit tests have been added for the new collection and fragment management features, covering various scenarios such as reading, modifying, renaming, adding, and removing plans within YAML files.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a new step-automation-packages-ide module, which provides a collection-based accessor for automation packages, particularly for plans stored in YAML. This is a significant feature that allows treating file-based plans as if they were in a database collection, with support for reading, creating, updating, and deleting. The implementation cleverly uses YAML patching to preserve formatting and comments, which is a great approach. The changes are extensive and well-tested.

My review has identified a few areas for improvement. The primary concern is the exception handling strategy in several new classes, where checked exceptions are wrapped in generic RuntimeException. This can obscure error details and should be addressed. I also found a bug in YamlPlainTextPlan where an incorrect collection name is returned. Additionally, there are a couple of minor code hygiene issues that I've pointed out.

...omation-packages-manager/src/main/java/step/automation/packages/AutomationPackageReader.java

...s-yaml/src/main/java/step/automation/packages/yaml/AutomationPackageYamlFragmentManager.java

step-plans/step-plans-parser/src/main/java/step/plans/automation/YamlPlainTextPlan.java

...ion-packages-manager/src/main/java/step/automation/packages/JavaAutomationPackageReader.java

...yaml/src/main/java/step/automation/packages/yaml/deserialization/PatchingParserDelegate.java

…-accessor

cl-exense

Looks mostly fine!

Don't be scared by the number of comments, this is actually a pretty good PR, and the requested changes are mostly simple.

Note that I have not understood all of the logic in deep detail, but the overall concept, and I've focused mostly on code understandability rather than implementation details.

cl-exense · 2026-03-24T09:28:24Z

...mation-packages-ide/src/main/java/step/core/collections/AutomationPackagePlanCollection.java

+    private final AutomationPackageYamlFragmentManager fragmentManager;
+
+    public AutomationPackagePlanCollection(AutomationPackageYamlFragmentManager fragmentManager) {
+        super(true, "plans");


These kinds of names should always be declared as public static final String constants, instead of using magic literal Strings.

cl-exense · 2026-03-24T09:29:48Z

...mation-packages-ide/src/main/java/step/core/collections/AutomationPackagePlanCollection.java

+    public AutomationPackagePlanCollection(AutomationPackageYamlFragmentManager fragmentManager) {
+        super(true, "plans");
+        this.fragmentManager = fragmentManager;
+        fragmentManager.getPlans().forEach(super::save);


This is some unexpected logic here. Add a comment on why it is needed.

cl-exense · 2026-03-24T09:35:02Z

...mation-packages-ide/src/main/java/step/core/collections/AutomationPackagePlanCollection.java

+
+    @Override
+    public void remove(Filter filter) {
+        find(filter, null, null, null, Integer.MAX_VALUE).forEach(fragmentManager::removePlan);


Even if the maxTime isn't actually used in the InMemoryCollection implementation - use 0 to indicate no limit as in all other invocations across the codebase.

cl-exense · 2026-03-24T09:45:02Z

...mation-packages-ide/src/test/java/step/core/collections/AutomationPackageCollectionTest.java

+        List<Plan> plans = planCollection.find(Filters.empty(), null, null, null, 100).collect(Collectors.toList());
+
+        assertEquals(2, count);
+        Set<String> names = plans.stream().map(p -> p.getAttributes().get("name")).collect(Collectors.toUnmodifiableSet());


These are just test classes, so it's less critical, but: prefer to use constants instead of repeatedly using magic strings. "name" is AbstractOrganizableObject.NAME. This also applies to all other such occurrences.

cl-exense · 2026-03-24T09:57:29Z

...mation-packages-ide/src/test/java/step/core/collections/AutomationPackageCollectionTest.java

+
+        planCollection.save(plan);
+
+        Sequence sequence = new Sequence();


This block is repeated many times in the test class (Sequence, plan, plan name). Consider refactoring it into a helper method. This will make the individual tests more focused and more readable.

cl-exense · 2026-03-24T15:19:11Z

step-core-model/src/main/java/step/core/yaml/PatchableYamlList.java

+    private int startOffset = -1;
+
+    @JsonIgnore
+    private int startColumn = -1;


cl-exense · 2026-03-24T15:30:04Z

step-core/src/main/java/step/automation/packages/AutomationPackageArchive.java


    abstract public boolean hasAutomationPackageDescriptor();

+    abstract public URL getDescriptorYamlUrl();


Heads up: this method is not implemented in the DotNetAutomationPackageArchive, it's therefore currently not possible to build an enterprise distribution for this branch.

Judging from the other methods, I guess the correct implementation there is simply

@Override public URL getDescriptorYamlUrl() { throw new UnsupportedOperationException(NOT_SUPPORTED_WITH_DOT_NET_DLL_AUTOMATION_PACKAGE); }

:-)

cl-exense · 2026-03-24T15:59:51Z

step-core/src/main/java/step/automation/packages/JavaAutomationPackageArchive.java

+    }
+
    @Override
    public InputStream getDescriptorYaml() {


Since this method and the new getDescriptorYamlUrl are practivally identical, it should actually be possible to implement the getDescriptorYaml() in terms of getDescriptorYamlUrl(), for instance:

@Override public InputStream getDescriptorYaml() { URL url = getDescriptorYamlUrl(); if (url == null) { return null; } try { return url.openStream(); } catch (IOException e) { return null; } }

This could be directly done in the base class, eliminating the need for separate implementations in derived classes.

cl-exense · 2026-03-24T16:01:00Z

step-core/src/main/java/step/core/yaml/deserializers/StepYamlDeserializersScanner.java

     * Scans and returns all {@link StepYamlDeserializer} classes annotated with {@link StepYamlDeserializerAddOn}
     */
-    public static List<DeserializerBind<?>> scanDeserializerAddons(ObjectMapper yamlObjectMapper, List<Consumer<StepYamlDeserializer<?>>> configurators) {
+    public static List<DeserializerBind<?>> scanDeserializerAddons(ObjectMapper yamlObjectMapper) {


I'm all for simplification, yay! But why is this not needed anymore?

This was only used for one modification of a deserializer, to set a serializer registry to the YamlAutomationPackageFragmentDeserializer.java.

On multiple levels, Jackson provides neat design patterns for the use case in question:

any singleton can be made accessible in a deserializer by using injectables and ctxt.findInjectableValue(...)

should any different modification of a deserializer be.necessary during initialization, there is already an example of that in AutomationPackageDescriptorReader.java, context.addBeanDeserializerModifier(...)

In the particular example, the serializer awareness in the (now removed YamlAutomationPackageFragmentDeserializer.java) was only needed to do the custom handling of the additonalFields map. For such cases, Jackson equally has a design pattern mean for this, it is the custom @JsonAnySetter in AbstractAutomationPackageFragmentYaml.java

cl-exense · 2026-03-24T16:06:43Z

step-plans/step-plans-base-artefacts/src/main/java/step/plans/parser/yaml/YamlPlan.java

-    public void setCategories(List<String> categories) {
-        this.categories = categories;
-    }
+	public void setCategories(List<String> categories) {


Please make sure that your IntelliJ has the "use editorconfig" setting enabled and obeys it (and that you're reformatting files if necessary before commit).

For some reason, you have reformatted these lines with tabs instead of 4 spaces, which is against the coding guidelines and, more importantly, messes up the commit history. (Correctly reformatting again now will fix it as the squash-merge at the end of the PR should be fine)

…-accessor

cmisev and others added 12 commits February 12, 2026 09:14

SED-4429 initial draft of mapping fragments to plans

58e52f0

Merge branch 'master' into SED-4429-step-ap-ide

d14ca08

SED-4429 fix: remove unused dependencies, gemini code review inputs

fbad6b5

SED-4429 fix: dependencies

0a7306a

Merge branch 'master' into SED-4429-step-ap-ide

12349f4

SED-4539 basic plan add, remove, modify

7911b28

SED-4539 refactor additional field handling

99c2105

SED-4539 simplify Fragment structure

364d3b4

Merge branch 'master' into SED-4539-automation-package-collection-and…

9ee49db

…-accessor-2

SED-4539 cleaner string manipulations

b9ace31

SED-4539 generic PatchableYamlArtefactDeserializer

6b3ad60

Merge branch 'master' into SED-4539-automation-package-collection-and…

289beaa

…-accessor-2

gemini-code-assist bot reviewed Mar 19, 2026

View reviewed changes

cmisev added 2 commits March 19, 2026 10:24

SED-4539 fix trivial review issues

177b99d

SED-4539 fix trivial review issues

9caa1f5

cmisev marked this pull request as draft March 19, 2026 09:57

cmisev and others added 4 commits March 19, 2026 12:22

SED-4539 remove unnecessary serializationregistryaware

12b840a

SED-4539 Exception handling

3b47d4c

SED-4539 Exception handling

a0507b4

Merge branch 'master' into SED-4539-automation-package-collection-and…

5a19c9b

…-accessor

cmisev marked this pull request as ready for review March 20, 2026 10:55

cmisev requested a review from cl-exense March 20, 2026 10:56

cmisev changed the title ~~Sed 4539 automation package collection and accessor~~ SED-4539 automation package collection and accessor Mar 20, 2026

cmisev and others added 3 commits March 20, 2026 16:31

SED-4539 Define Collections as Patchable

3169fc0

SED-4539 Define Collections as Patchable

9db55ab

Merge branch 'master' into SED-4539-automation-package-collection-and…

c07d009

…-accessor

cl-exense requested changes Mar 24, 2026

View reviewed changes

cmisev and others added 2 commits April 2, 2026 12:34

Merge branch 'master' into SED-4539-automation-package-collection-and…

26ca44e

…-accessor

SED-4539 WIP Refactor

e3200c3

cmisev and others added 5 commits April 13, 2026 09:16

SED-4539 refactor: introduce PatchingContext

1d0de2c

Merge branch 'master' into SED-4539-automation-package-collection-and…

fbaf665

…-accessor

SED-4539 fix: unit tests

d007114

SED-4539 feat: extend patchable to additionalFields

1a591b3

SED-4539 remove superfluous location aware tree parser

dc93ae4


		planCollection.save(plan);

		Sequence sequence = new Sequence();


		abstract public boolean hasAutomationPackageDescriptor();

		abstract public URL getDescriptorYamlUrl();

Conversation

cmisev commented Mar 19, 2026

Uh oh!

gemini-code-assist bot commented Mar 19, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cl-exense left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants