Running multiple codestarts yields Multiple files found for path with "fail-on-duplicate"

[zanozbot]

Hi!

We are developing multiple codestarts, each dedicated to a specific functionality, such as:

• codestart for Kafka
• codestart for data sources
• codestart for OpenAPI
  ...

Since not all services require all the functionalities mentioned, the codestarts need to be independent. This means that each codestart has its own docker-compose.yml file located in runtime/src/main/codestarts/NAME/base.

The issue arises when we try to chain multiple codestarts together while preserving the code generated from each codestart.
We expected the Quarkus CLI to merge the duplicate files, but instead, we encounter the following error:

[ERROR] ❗  Unable to create project: Multiple files found for path with 'fail-on-duplicate' FileStrategy: docker-compose.yml

We are using:

• Quarkus CLI 3.12.0
• Quarkus 3.8.5
• Maven 3.9.8
• Java 21

Any ideas on how to fix this?

[quarkus-bot[bot]]

/cc @ia3andy (codestart), @quarkusio/devtools (codestart)

[aloubyansky]

There would have to be an implementation of https://github.com/quarkusio/quarkus/blob/main/independent-projects/tools/codestarts/src/main/java/io/quarkus/devtools/codestarts/core/strategy/CodestartFileStrategyHandler.java to handle it. Merging is currently implemented for a couple of resource types. Would you be willing to contribute one for docker-compose.yml?

[maxandersen]

first: codestarts are NOT intended to be generally mergable. it is very deliberate that the codestarts we have are not overlapping :)

second: as @aloubyansky you'll need some way to merge docker-compose.yml - but I doubt that is possible/feasible. Lots of things can go very wrong with that. which of the possible 4 files do you want to "win" ?

[aloubyansky]

What would happen if one extension contains the docker-compose.yml file? Should we rename it and treat it as an include?

I don't think so. docker-compose-<name>-include.yml would mean a codestart developer expects this docker-compose yaml to be a part of a composite docker-compose yaml.
If <name>-include isn't present in the name, the developer probably expects it to be a standalone docker-compose yaml.
If it happens that both docker-compose.yml and docker-compose-<name>-include.yml are found, we could throw an error, as the current implementation does. It seems like it could be a good start to me.
Alternatively, we could name the docker-compose yaml that aggregates various includes something else, such as docker-compose-all.yml but then it should probably be called that whether docker-compose.yml was found or not for consistency reasons.

[zanozbot]

Let's proceed with the first approach and throw an error if a duplicate is found. I think I have enough information to get things started.

[aloubyansky]

Let's use docker-compose-include-<name>.yml instead, it reads better and more straightforward to capture in code.

[zanozbot]

Noted.

[zanozbot]

@aloubyansky I prepared the PR #42512.