[WFLY-17651] Add a new "Getting Started" archetype. #26

darranl · 2023-02-19T14:16:15Z

https://issues.redhat.com/browse/WFLY-17651

Starting off as a draft as a couple of additional points still to consider:

Check CDI works
Look at the test profiles
Consider do we need Helm charts?

jmesnil · 2023-02-21T08:17:55Z

Consider do we need Helm charts?

We would need a Helm Chart to deploy the application on Kubernetes (instead of a plain container image deployment).
However this implies that the user pushes the container image that is created by the wildfly:image plugin to a public container registry (ghcr.io or quay.io)

The Helm chart could be as simple as:

image:
  name: <name of the image in the container registry>
build:
  enabled: false
deploy:
  route:
    enabled: false

The underlying question is how far do you want to push the getting started experience?

If its's up to local development, the image is fine.
If it's up to kubernetes deployment, then we need the configuration/templating to push the image to a container registry and a Helm chart to deploy on a k8s cluster

darranl · 2023-02-21T10:03:40Z

@jmesnil I think after this the next discussion is documentation of user stories, as the Helm chart is so simple I don't think it fits in the archetype, instead it feels like it is a next user story re using a Helm Chart to deploy the project.

...resources/archetype-resources/src/test/java/org/wildfly/security/examples/test/SampleIT.java

wildfly-getting-started-archetype/src/test/resources/projects/basic/goal.txt

* Rely on the provisioned server + deployments to run the integration tests * Use a single managed Arquillian container to run the tests * Do not use profiles for testing, with this settings, there is no reason that integration tests should be skipped. Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Update testing strategy

darranl · 2023-08-09T12:20:47Z

Thanks @jmesnil I have merged that first PR

jmesnil · 2023-08-09T12:29:25Z

@darranl thanks! If you look at the GitHub action, you will now have the execution of the mvn verify for a generated project (eg https://github.com/wildfly/wildfly-archetypes/actions/runs/5808924000/job/15746706526#step:4:4206).

to use the same package and prefix that the application classes. Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

...resources/archetype-resources/src/test/java/org/wildfly/security/examples/test/SampleIT.java

Update packaging of the projects tests

darranl · 2023-08-09T13:18:09Z

@jmesnil second PR merged ;-) thank you

Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

* Use `org.wildfly.examples` for the `groupId` and `package` property * Use `getting-started` for the `artifactId` property * Use `1.0.0-SNAPSHOT` for the `version` property By default, the project will use these value to genereate the project and the command is simply: ``` mvn archetype:generate -DarchetypeGroupId=org.wildfly.archetype -DarchetypeArtifactId=wildfly-getting-started-archetype ``` It is still possible to update these values with a system property (eg `-DgroupId=org.acme`) or interactively by rejecting the properties configuration and specify new values. Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Use the artifactId instead of the hard-coded `login-form` Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Use name instead of runtimeName to deploy the application. RuntimeName is deprecated and would not work well with wildfly:dev goal Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

This lets the user know where that page is coming from. If their app is not a frontend, they will likely want to get rid of this page (and associated css resources). Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

this is so fast that it looks weird Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Add a CDI injection Add an unit test to test the CDI service This sets up the user to do both unit testing (before creating the war) and integration testing (against the deployed app) Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

jmesnil · 2023-08-16T06:35:52Z

@darranl you need to bump the wildfly-maven-plugin to 4.2.0.Final to be able to provision WildFly 29.

darranl · 2023-08-16T15:15:53Z

@jmesnil sorry I had made that change locally, hadn't pushed the last commit.

Update generated project README

Default properties

Update arquillian.xml

jmesnil · 2023-08-17T08:14:57Z

wildfly-getting-started-archetype/src/main/resources/archetype-resources/pom.xml

+        <!-- other plugin versions -->
+        <version.compiler.plugin>3.9.0</version.compiler.plugin>
+        <version.surefire.plugin>2.22.2</version.surefire.plugin>
+        <version.failsafe.plugin>2.22.2</version.failsafe.plugin>


can be bumped to 3.1.2

jmesnil · 2023-08-17T08:15:37Z

wildfly-getting-started-archetype/src/main/resources/archetype-resources/pom.xml

+        <version.compiler.plugin>3.9.0</version.compiler.plugin>
+        <version.surefire.plugin>2.22.2</version.surefire.plugin>
+        <version.failsafe.plugin>2.22.2</version.failsafe.plugin>
+        <version.war.plugin>3.3.2</version.war.plugin>


can be bumped to 3.4.0

jmesnil · 2023-08-17T08:16:28Z

wildfly-getting-started-archetype/src/main/resources/archetype-resources/pom.xml

+            </plugin>
+
+			<!--Build configuration for the WAR plugin: -->
+			<plugin>


@darranl the indentation is all over the place (I definitely mess it up in all my commits). Before merging, this pom.xml should be reindented.

done in jmesnil@d792dd3

jmesnil · 2023-08-17T08:19:41Z

wildfly-getting-started-archetype/src/main/resources/archetype-resources/pom.xml

+
+        <!-- other plugin versions -->
+        <version.compiler.plugin>3.9.0</version.compiler.plugin>
+        <version.surefire.plugin>2.22.2</version.surefire.plugin>


afaict, this version is useless as the surefire plugin is not explicitly configured in this pom.xml.

jmesnil · 2023-08-17T09:16:13Z

.../src/main/resources/archetype-resources/src/test/java/__defaultClassPrefix__ServiceTest.java

+ */
+public class ${defaultClassPrefix}ServiceTest {
+
+     ${defaultClassPrefix}Service service = new  ${defaultClassPrefix}Service();


This is actually a stupid idea of mine to write such unit test for a CDI bean. This will break if the bean use any injection itself.

We should remove this test file completely

or set it up as an Arquillian integration tests with a deployment, etc.

done in darranl#7

The changes in arquillian.xml was making the test fails but this was not captured by the verify goal Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Fix testing

jmesnil · 2023-09-05T08:45:20Z

@darranl starting with #40, all dependencies are configured in the parent pom.xml and propagated to the generated archetypes. This requires an update in your PR to move the generated pom.xml in a separate directory and some escaping of its variables. This should be very similar to what was done for the jakartaee-webapp archetype (starting from https://github.com/wildfly/wildfly-archetypes/pull/40/files#diff-03e5203acbea22fcd42193af53307eb5b7ac9ffd50ede79de2bf4ad7b4e4cd64)

jmesnil · 2023-09-06T13:13:41Z

@darranl starting with #40, all dependencies are configured in the parent pom.xml and propagated to the generated archetypes

done in jmesnil@d792dd3

yersan · 2023-09-29T09:05:50Z

wildfly-getting-started-archetype/src/main/resources/archetype-resources/pom.xml

+        <dependency>
+            <groupId>org.jboss.resteasy</groupId>
+            <artifactId>resteasy-client</artifactId>
+            <version>6.2.4.Final</version>


For consistency, I would move this version to the properties section

darranl · 2023-09-29T15:40:39Z

FYI I am going to close this PR as I opened #47 as a continuation after merging in main and syncing from Jeff's topic branch.

[WFLY-17651] Add a new "Getting Started" archetype.

16a596b

jmesnil reviewed Aug 9, 2023

View reviewed changes

...resources/archetype-resources/src/test/java/org/wildfly/security/examples/test/SampleIT.java Outdated Show resolved Hide resolved

jmesnil reviewed Aug 9, 2023

View reviewed changes

wildfly-getting-started-archetype/src/test/resources/projects/basic/goal.txt Outdated Show resolved Hide resolved

jmesnil and others added 2 commits August 9, 2023 13:53

Merge pull request #1 from jmesnil/darranl-WFLY-17651

0443f84

Update testing strategy

Update packaging of the projects tests

6d645b5

to use the same package and prefix that the application classes. Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

jmesnil reviewed Aug 9, 2023

View reviewed changes

...resources/archetype-resources/src/test/java/org/wildfly/security/examples/test/SampleIT.java Outdated Show resolved Hide resolved

Merge pull request #2 from jmesnil/darranl-WFLY-17651

233eaed

Update packaging of the projects tests

jmesnil and others added 13 commits August 9, 2023 15:19

Update generated project README

7bb3216

Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Fix name of the generated project in its pom.xml

52b21b5

Use the artifactId instead of the hard-coded `login-form` Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Configure the name of the deployment

15488b7

Use name instead of runtimeName to deploy the application. RuntimeName is deprecated and would not work well with wildfly:dev goal Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

bump wildfly and wildfly-maven-plugin versions

ccaf22e

Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Add a footer to the index.html page

9705b01

This lets the user know where that page is coming from. If their app is not a frontend, they will likely want to get rid of this page (and associated css resources). Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

remove the intermediate prompt

b87de3d

this is so fast that it looks weird Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

CDI + Unit tests

5731336

Add a CDI injection Add an unit test to test the CDI service This sets up the user to do both unit testing (before creating the war) and integration testing (against the deployed app) Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

remove unecessary dependencies

c7165f3

Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

fix endpoint code

3964dd2

Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Move the server / bom version to 29.0.0.Final

dd01068

Move the WildFly plugin to 4.2.0.Final

90cfbe6

Update arquillian.xml

523df06

darranl added 2 commits August 16, 2023 16:16

Merge pull request #3 from jmesnil/darranl-WFLY-17651

07537b2

Update generated project README

Merge pull request #4 from jmesnil/default_properties

b2f687b

Default properties

Merge pull request #5 from ehsavoie/WFLY-17651-1

6308a50

Update arquillian.xml

jmesnil reviewed Aug 17, 2023

View reviewed changes

jmesnil and others added 3 commits August 18, 2023 10:05

Add back verify goal to maven-failsafe-plugin

624988d

The changes in arquillian.xml was making the test fails but this was not captured by the verify goal Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Test CDI Bean with Arquillian

e7f4149

Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

Merge pull request #7 from jmesnil/verify

cc4c810

Fix testing

yersan reviewed Sep 29, 2023

View reviewed changes

darranl mentioned this pull request Sep 29, 2023

[WFLY-17651] Add a new "Getting Started" archetype. #47

Merged

darranl closed this Sep 29, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WFLY-17651] Add a new "Getting Started" archetype. #26

[WFLY-17651] Add a new "Getting Started" archetype. #26

darranl commented Feb 19, 2023

jmesnil commented Feb 21, 2023

darranl commented Feb 21, 2023

darranl commented Aug 9, 2023

jmesnil commented Aug 9, 2023

darranl commented Aug 9, 2023

jmesnil commented Aug 16, 2023

darranl commented Aug 16, 2023

jmesnil Aug 17, 2023

jmesnil Aug 17, 2023

jmesnil Aug 17, 2023

jmesnil Sep 6, 2023

jmesnil Aug 17, 2023

jmesnil Aug 17, 2023 •

edited

Loading

jmesnil Aug 17, 2023

jmesnil Aug 18, 2023

jmesnil commented Sep 5, 2023

jmesnil commented Sep 6, 2023

yersan Sep 29, 2023

darranl commented Sep 29, 2023

[WFLY-17651] Add a new "Getting Started" archetype. #26

[WFLY-17651] Add a new "Getting Started" archetype. #26

Conversation

darranl commented Feb 19, 2023

jmesnil commented Feb 21, 2023

darranl commented Feb 21, 2023

darranl commented Aug 9, 2023

jmesnil commented Aug 9, 2023

darranl commented Aug 9, 2023

jmesnil commented Aug 16, 2023

darranl commented Aug 16, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmesnil Aug 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmesnil commented Sep 5, 2023

jmesnil commented Sep 6, 2023

Choose a reason for hiding this comment

darranl commented Sep 29, 2023

jmesnil Aug 17, 2023 •

edited

Loading