Investigate how to create a template for JBang to help with bug reports

[DavideD]

See https://github.com/jbangdev/jbang#init-templates

It would be nice if users could generate a basic test project using JBang so that they have a quick way to start creating a project for reproducing the issue they are having.

I haven't checked if this is feasible or helpful yet. In my head it should make it even easier than cloning a template from our repository.

[gavinking]

@maxandersen already played with this. What he didn't like, and what might also be a problem here, is that he couldn't easily use a testcontainers database.

[maxandersen]

It works but yeah users would need to manually setup the database.

But so should users using more complex setups :)

What you can do is to have the jbang script setup via test containers manually rather than using the jdbc url magic which does not work (yet) with hibernate reactive.

[gavinking]

I did look briefly at making the testcontainers bootstrap code in our test suite reusable, but it wasn't going to be that trivial.

[DavideD]

I mean... testcontainers is a great tool... but I'm going out on a limb here and say that we can expect people using Hibernate Reactive (or ORM) to be able to start a db without it :-)

[DavideD]

It's certainly not a deal breaker to me, most of the boring part is really the configuration of the project. If I have to start a db launching a script manually before being able to run the main of the app, it would already be a great improvement.

[gavinking]

Sure, that's fine. But it's a nice-to-have.

[DavideD]

Thinking about it, we probably don't even need a template to begin with, we could provide a java file with all the dependencies needed for JBang to run it.

[gavinking]

I figured by "template" you were hoping to parameterize by database type.

[DavideD]

I was talking about a JBang template, something that would allow the user to write:

jbang init --template=hibernate-reactive Issue456.java

but I guess this would also be possible:

jbang init --template=hibernate-reactive-db2 Issue456.java

Now I think we could achieve the same result providing a single file (or one per database) so that a user can run it with:

jbang HReactiveWithDb2.java

With the caveat that a Db2 instance with the right credentials must be already running.

Then they could start editing it with:

 jbang edit --open=idea  HReactiveWithDb2.java

We can think of ways to add all the bells and whistles we want, but this would be a good starting point for me.

[DavideD]

In my previous example, HReactiveWithDb2.java is somewhere on our GitHub repository and a user has to download it first.

Although, I expect JBang to have some way to run something like:

jbang https://github.com/hibernate/hibernate-reactive/HReactiveWithDb2.java

[gavinking]

Well jbang templates have some sort of support for parameters AFAIU, and I think that should be enough to say switch in a certain persistence.xml file.

[DavideD]

Sure, sounds great.

[Sanne]

Very interesting!

One additional thing that maybe you want to consider: very often Quarkus users are encouraged to create a "reproducer project" but in most cases this then ends up being something I have to re-adapt into a real integration test to be merged in Quarkus mainline.

I do wonder if we could structure our "reproducers" in such a way that it could be automatically promoted into a new integration test.