Add codestart data option in CLI and Maven plugin

[ia3andy]

Description

It would be nice extension codestart to have user customizable data. This is already possible in codestarts but not yet connected in the tooling.

It would behave like this:

quarkus create app -x=my-ext -d=my-ext-codestart.foo.bar=hello,my-ext-codestart.foo.hello=andy

The my-ext-codestart prefix is required by the codestart system to know the data is targeting this particular codestart data (and avoid conflicts)

The default value is in the codestart.yml:

name: my-ext-codestart
language:
  base:
    data:
      foo:
        bar: baz
        hello: world

FYI: I created this issue because @gsmet has a need for this.

[quarkus-bot[bot]]

/cc @ebullient, @maxandersen, @quarkusio/devtools

[arpitbhardwaj]

Let me know if i pick it up and start working on this.

[ebullient]

Does that mean you have to know each individual codestart's requirements to make this useful? There is already a way to pass in initial configuration with existing options. This seems like something that is useful if you write codestarts frequently, but is difficult to document (where the goal of the CLI, e.g., is to ensure it is generally useful without having to go look at docs).

[gsmet]

The idea is to be able to pass some additional data for a specific extension codestart. AFAIK there's no way to do that right now. And in the case of the GitHub Action extension, I'd like to have the ability to pass the GitHub repository where the action will be hosted.

[ebullient]

yes.. can't that be passed in using the existing config mechanism? Something like --app-config=whatever.github.repo=gsmet/awesomesauce?

[gsmet]

It's not a config property I want. It's something that I can actually use in the templates when generating the project.

[gsmet]

@arpitbhardwaj you can have a look if you can figure out where to do this.

[gsmet]

This might give you a good idea about where to poke: https://github.com/quarkusio/quarkus/pull/28325

[maxandersen]

@ia3andy would it not "just work" if you use -D to set properties today?

[maxandersen]

@gsmet I thought app config was available to codestarts ?

[gsmet]

I don't want to push these things to the app config.

[maxandersen]

but -D are just system properties - shouldn't be ending up in you generated app config.

[maxandersen]

i.e.

quarkus create app -x=my-ext -Dmy-ext-codestart.foo.bar=hello -Dmy-ext-codestart.foo.hello=andy

should be possible to make work.

[gsmet]

So that could work but is there a way to access system properties from the Qute template directly? I might be missing something obvious.

[ebullient]

https://github.com/quarkusio/quarkus/blob/f7509ba1e11f7522730fba3ef780b67b1761ef4a/devtools/cli/src/main/java/io/quarkus/cli/create/BaseCreateCommand.java#L213 -- we do set the system properties here..

We could also set them as template values by calling this: https://github.com/quarkusio/quarkus/blob/f7509ba1e11f7522730fba3ef780b67b1761ef4a/devtools/cli/src/main/java/io/quarkus/cli/create/BaseCreateCommand.java#L188

[gsmet]

But why would we do that instead of something cleaner with the data thing?

[maxandersen]

We already use -D to pass an arbitrary keys to maven/gradle/jbang so not sure how much value it brings to add yet-another open-ended key/value command option?

[ia3andy]

Ok, my concern using plain system properties is that we would have to find a way to filter them before passing them as data to codestarts if we don't want to have weird behaviors.

In the top level where we pass the data, we don't know how it will be consumed by codestarts.

[ia3andy]

IMO we should reproduce the same syntax as for config on another named option (data or whatever), parse it using the same code as the data and passing the map to codestart data.

We need a new key and setter in the CreateProject for this (like we do for config): https://github.com/quarkusio/quarkus/blob/main/independent-projects/tools/devtools-common/src/main/java/io/quarkus/devtools/commands/CreateProject.java#L43

Unlike the config this data needs to be directly passed to the builder here: https://github.com/quarkusio/quarkus/blob/main/independent-projects/tools/devtools-common/src/main/java/io/quarkus/devtools/commands/handlers/CreateProjectCommandHandler.java#L150

https://github.com/quarkusio/quarkus/blob/main/independent-projects/tools/codestarts/src/main/java/io/quarkus/devtools/codestarts/CodestartProjectInputBuilder.java#L46

[ia3andy]

@arpitbhardwaj would you give it a try?

[arpitbhardwaj]

Yeah I will it a try. Currently setting up the environment.

[ia3andy]

@arpitbhardwaj any update on this?

[gsmet]

I'd really like to have it for 2.15 so I think I will drive this puppy home.

[gsmet]

I created a PR here: https://github.com/quarkusio/quarkus/pull/29644 .

[maxandersen]

Just to be clear - my suggestion was not to use global system properties. Simply that -D is defining data keys for the command.

What is the difference now between --data and -D ?

[maxandersen]

so I now got to import the code and realize that -D already exist in more generic form. somehow I had in my head for codestarts we had separate dedicated command.

so all good - my only gripe is that it relies on command separated "blob" which limits what you can pass in but we can fix that if usecase arises by adding support for i.e. -QDkey=value or similar.