Change the packaging to jar and configure a war profile #9034

PierreBesson · 2019-01-09T18:09:31Z

This needs review and a lot of testing to make sure it works for every case.

In order to build the war, you can run:
./mvnw -Pprod,war verify

In my testing, running the produced war file in tomcat and deploying to GAE worked well.

Travis tests are green
Tests are added where necessary
Documentation is added/updated where necessary
Coding Rules & Commit Guidelines as per our CONTRIBUTING.md document are followed

PierreBesson · 2019-01-09T18:10:32Z

For gradle I have had a look at it but I'm not sure how to do it : @atomfrede do you have an idea ?

atomfrede · 2019-01-09T20:08:25Z

@PierreBesson Just to make sure, the title of this PR is wrong, right? You mean Change the packaging to **jar** for maven and configure a war profile?
For gradle would not use a -P switch. Need to check but I think we can just change the default packing to jar. As we still apply the war plugin there is bootWar task available. Everything that needs a war file must just call bootWar instead bootJar or assemble, but will have look to check if thats correct.

loosebazooka · 2019-01-09T20:27:28Z

@atomfrede If I recall correctly, using war will explicitly disable the jar task for gradle.

You can still do some switching based on a flag though. Whether that is a system property using -D or a project property using -P, perhaps something like:

build.gradle

// if using -Dpackaging=war
if ("war".equals(System.getProperty("packaging"))) {
  apply plugin 'war'
}

// if using -Ppackaging=war (although I think you might have to check for existence) 
if ("war".equals(project.ext.packaging)) {
  apply plugin 'war'
}

chanseokoh · 2019-01-09T22:34:50Z

The title says "Change the packaging to war" and I was confused until I actually see the code. It should say "Change the packaging to jar".

PierreBesson · 2019-01-09T22:47:35Z

Sorry about the typo. In this case it's really misleading...

atomfrede · 2019-01-10T06:00:29Z

@loosebazooka We currently have war and jar packaging available, just a matter of calling bootJar directly. I would prefer not to add more hidden flags as they are not discoverable via gradle tasks, but maybe that needs a vote.

loosebazooka · 2019-01-10T14:26:51Z

Aye, I must have misunderstood the problem.

chanseokoh · 2019-01-10T18:43:32Z

@atomfrede @PierreBesson is it possible to remove the WAR Plugin for Gradle?

 apply plugin: 'maven'
 apply plugin: 'org.springframework.boot'
-apply plugin: 'war'
 apply plugin: 'propdeps'
 apply plugin: 'com.moowork.node'
 apply plugin: 'io.spring.dependency-management'

chanseokoh · 2019-01-10T18:50:09Z

Actually, more places with WAR:

diff --git a/build.gradle b/build.gradle
index 6e4c913..798935d 100644
--- a/build.gradle
+++ b/build.gradle
@@ -34,7 +34,6 @@ assert System.properties['java.specification.version'] == '1.8'
 
 apply plugin: 'maven'
 apply plugin: 'org.springframework.boot'
-apply plugin: 'war'
 apply plugin: 'propdeps'
 apply plugin: 'com.moowork.node'
 apply plugin: 'io.spring.dependency-management'
@@ -54,14 +53,6 @@ version = '0.0.1-SNAPSHOT'
 
 description = ''
 
-bootWar {
-   mainClassName = 'com.example.demoapp.JhipsterApp'
-}
-
-war {
-
-}
-
 springBoot {
     mainClassName = 'com.example.demoapp.JhipsterApp'
     buildInfo()
@@ -255,9 +246,6 @@ wrapper {
     gradleVersion = '4.10.2'
 }
 
-task stage(dependsOn: 'bootWar') {
-}
-
 if (project.hasProperty('nodeInstall')) {
     node {
         version = "${node_version}"
diff --git a/gradle/profile_dev.gradle b/gradle/profile_dev.gradle
index a1b1eb5..22bbce8 100644
--- a/gradle/profile_dev.gradle
+++ b/gradle/profile_dev.gradle
@@ -28,10 +28,6 @@ task webpackBuildDev(type: NpmTask, dependsOn: 'npm_install') {
     args = ["run", "webpack:build"]
 }
 
-war {
-    webAppDirName = 'build/www/'
-}
-
 task copyIntoStatic (type: Copy) {
     from 'build/www/'
     into 'build/resources/main/static'
diff --git a/gradle/profile_prod.gradle b/gradle/profile_prod.gradle
index 26a2978..1eec73c 100644
--- a/gradle/profile_prod.gradle
+++ b/gradle/profile_prod.gradle
@@ -27,10 +27,6 @@ task webpack(type: NpmTask, dependsOn: 'npm_install') {
     args = ["run", "webpack:prod"]
 }
 
-war {
-    webAppDirName = 'build/www/'
-}
-
 task copyIntoStatic (type: Copy) {
     from 'build/www/'
     into 'build/resources/main/static'

PierreBesson · 2019-01-14T13:08:22Z

@chanseokoh will correct me if I'm wrong but I think the problem is as long as there is the war plugin enabled in build.gradle, jib (starting with v0.10) will assume that we want war packaging.

In my tests I have been able to work around that by removing all the war code highlighted above and added this to the build.gradle :

if (project.hasProperty('war')) {
    apply plugin: 'war'
    war {
        enabled = true
    }
}

In this regard it will work similarly to maven. Should I go forward with this change ?

chanseokoh · 2019-01-14T15:45:21Z

as long as there is the war plugin enabled in build.gradle, jib (starting with v0.10) will assume that we want war packaging.

That is correct.

Should I go forward with this change ?

From the perspective of a Jib developer, that (not applying the WAR Plugin) is the way we want.

Just from my personal curiosity, is war.enabled = true necessary?

atomfrede · 2019-01-14T16:02:47Z

@PierreBesson I would like to remove most -P flags, but in that case it seems we need to have it.

PierreBesson · 2019-01-14T16:19:33Z

@chanseokoh No it is actually not required. I'm not sure why it was there but it could very well be because it was needed for older Spring Boot versions. JHipster actually started with very early versions of Spring Boot.

atomfrede · 2019-01-14T17:18:42Z

@chanseokoh No I think I didn't remove it. According to the boot documentation this is supposed to enable war creation in addition to jar creation, but I realized is has no effect (maybe because the war plugin is already applied). If jib can handle executable jars and we do not support container deploymend anymore we can definitl;y remove the war plugin as there are bootJar and bootWar available via the boot plugin.

PierreBesson · 2019-01-14T17:22:07Z

@atomfrede That is not correct, if you don't add the apply plugin: war then the spring boot plugin won't expose a bootWar task so I think the solution using -Pwar is required.

atomfrede · 2019-01-14T17:26:30Z

+1 was not sure to be honest.

…

On Mon, Jan 14, 2019, 18:22 Pierre Besson ***@***.*** wrote: @atomfrede <https://github.com/atomfrede> That is not correct, if you don't add the apply plugin: war then the spring boot plugin won't show the bootWar task so I think the solution using -Pwar is required. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#9034 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAMaiXNCoO2i5m8YWyI_0Z65vBtCvBbPks5vDLzCgaJpZM4Z4BcH> .

chanseokoh · 2019-01-14T18:07:47Z

generators/common/templates/README.md.ejs

@@ -293,7 +302,7 @@ To stop it and remove the container, run:
 You can also fully dockerize your application and all the services that it depends on.
 To achieve this, first build a docker image of your app by running:

-    <% if (buildTool === 'maven') { %>./mvnw package -Pprod verify jib:dockerBuild<% } %><% if (buildTool === 'gradle') { %>./gradlew bootWar -Pprod jibDockerBuild<% } %>
+    <% if (buildTool === 'maven') { %>./mvnw package -Pprod verify jib:dockerBuild<% } %><% if (buildTool === 'gradle') { %>./gradlew bootJar -Pprod jibDockerBuild<% } %>


FYI: bootJar may not be necessary. Jib doesn't look into a packaged JAR, so normally it's enough to do ./gradlew jibDockerBuild, unless you wired up extra tasks with bootJar.

I wished our build could be as fast as just compiling the sources but we have a complex builds with resource copying and filtering and in some case even a front-end nodejs build to run. However I wish we could create a special mode to speed up everything and have a fast dev workflow with jib + scaffold. Anyway thanks a lot for your help !

chanseokoh · 2019-01-14T18:07:53Z

generators/docker-base.js

@@ -49,7 +49,7 @@ function checkImages() {
            runCommand = './mvnw package -Pprod verify jib:dockerBuild';
        } else {
            imagePath = this.destinationPath(`${this.directoryPath + appsFolder}/build/jib-cache`);
-            runCommand = './gradlew bootWar -Pprod jibDockerBuild';
+            runCommand = './gradlew bootJar -Pprod jibDockerBuild';


chanseokoh · 2019-01-14T18:10:06Z

generators/docker-base.js

@@ -49,7 +49,7 @@ function checkImages() {
            runCommand = './mvnw package -Pprod verify jib:dockerBuild';


Related, package is no longer required for the Jib standard (non-WAR) containerization. Normally, ./mvnw compile jib:dockerBuild should work (although if we were to do the WAR containerization, package is required.)

… war

…foundry)

pascalgrimaud · 2019-02-12T10:55:34Z

I'll start to review this, but as there are some conflicts, can you rebase your branch plz @PierreBesson ?
Tell me when it's done

PierreBesson · 2019-02-12T13:27:41Z

The rebase is done.

pascalgrimaud · 2019-02-12T16:38:42Z

Tested and it works well.
I'm going to merge this, waiting the CI to finish

pascalgrimaud · 2019-02-12T18:19:35Z

good job @PierreBesson !

DanielFran · 2019-04-09T09:03:28Z

@PierreBesson @pascalgrimaud @jdubois Did not found any update in documentation about those changes...

pascalgrimaud · 2019-04-09T09:46:19Z

@DanielFran : maybe we forgot to do it... Can you open a new ticket plz ? So we won't forget to do it

DanielFran · 2019-04-09T16:56:57Z

@pascalgrimaud Done!

PierreBesson added the status: work in progress label Jan 9, 2019

PierreBesson mentioned this pull request Jan 9, 2019

Upgrade to jib 0.10.0 #8891

Closed

4 tasks

PierreBesson added the pr: needs-review label Jan 9, 2019

loosebazooka mentioned this pull request Jan 9, 2019

Allow forcing containerization type GoogleContainerTools/jib#1374

Closed

PierreBesson changed the title ~~Change the packaging to war for maven and configure a war profile~~ Change the packaging to jar for maven and configure a war profile Jan 9, 2019

PierreBesson force-pushed the make-jar-not-war branch from c081460 to 28ee251 Compare January 14, 2019 17:45

chanseokoh reviewed Jan 14, 2019

View reviewed changes

PierreBesson force-pushed the make-jar-not-war branch 5 times, most recently from f3ecd6a to 2d31df8 Compare January 16, 2019 13:14

PierreBesson changed the title ~~Change the packaging to jar for maven and configure a war profile~~ Change the packaging to jar and configure a war profile Jan 16, 2019

PierreBesson removed the status: work in progress label Jan 16, 2019

jdubois removed the v6 label Jan 29, 2019

deepu105 added the v6 label Feb 9, 2019

PierreBesson added 8 commits February 12, 2019 11:31

change the packaging to jar for maven and configure a war profile

8ecca4f

change the packaging to jar for gradle and add a war profile

e0ff9de

document the jar/war change in the generated README

cb995db

change mentions of war packaging -> jar in several places

35d8501

migrate travis tests to jar packaging and add new tests to package as…

a7f7ff6

… war

don't add frond-end assets to war for --skip-client apps

9819a28

change packaging war -> jar in deployment subgens (aws, heroku, cloud…

5da786a

…foundry)

change packaging war -> jar in ci-cd subgen

288ba6f

PierreBesson force-pushed the make-jar-not-war branch from 91a60c4 to 288ba6f Compare February 12, 2019 13:26

PierreBesson added 2 commits February 12, 2019 15:08

fix UAA packaging as jart

81c8cdb

fix Heroku deploy

76642d9

PierreBesson force-pushed the make-jar-not-war branch from 4a0f794 to 76642d9 Compare February 12, 2019 16:22

pascalgrimaud added pr: ready-to-merge-on-ci-pass and removed pr: needs-review labels Feb 12, 2019

pascalgrimaud merged commit cf33f1d into jhipster:master Feb 12, 2019

pascalgrimaud mentioned this pull request Feb 14, 2019

Microservice APIs returning empty response (master) #9261

Closed

1 task

DanielFran mentioned this pull request Apr 9, 2019

Change the packaging to jar and configure a war profile #9547

Closed

1 task

This was referenced Apr 18, 2019

Update documentation about JAR / WAR jhipster/jhipster.github.io#724

Merged

Update alias for JAR - remove Rancher jhipster/jhipster-oh-my-zsh-plugin#32

Merged

Update alias for JAR - remove Rancher jhipster/jhipster-fisher-plugin#21

Merged

JorisNobre mentioned this pull request May 31, 2019

War generated seems to not work in 6.0.1 (standalone and tomcat) #9829

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change the packaging to jar and configure a war profile #9034

Change the packaging to jar and configure a war profile #9034

PierreBesson commented Jan 9, 2019 •

edited

PierreBesson commented Jan 9, 2019

atomfrede commented Jan 9, 2019

loosebazooka commented Jan 9, 2019

chanseokoh commented Jan 9, 2019

PierreBesson commented Jan 9, 2019

atomfrede commented Jan 10, 2019

loosebazooka commented Jan 10, 2019

chanseokoh commented Jan 10, 2019

chanseokoh commented Jan 10, 2019

PierreBesson commented Jan 14, 2019

chanseokoh commented Jan 14, 2019 •

edited

atomfrede commented Jan 14, 2019

PierreBesson commented Jan 14, 2019

atomfrede commented Jan 14, 2019

PierreBesson commented Jan 14, 2019 •

edited

atomfrede commented Jan 14, 2019 via email

chanseokoh Jan 14, 2019

PierreBesson Jan 14, 2019

chanseokoh Jan 14, 2019

chanseokoh Jan 14, 2019

pascalgrimaud commented Feb 12, 2019

PierreBesson commented Feb 12, 2019

pascalgrimaud commented Feb 12, 2019

pascalgrimaud commented Feb 12, 2019

DanielFran commented Apr 9, 2019

pascalgrimaud commented Apr 9, 2019

DanielFran commented Apr 9, 2019

		@@ -49,7 +49,7 @@ function checkImages() {
		runCommand = './mvnw package -Pprod verify jib:dockerBuild';

Change the packaging to jar and configure a war profile #9034

Change the packaging to jar and configure a war profile #9034

Conversation

PierreBesson commented Jan 9, 2019 • edited

PierreBesson commented Jan 9, 2019

atomfrede commented Jan 9, 2019

loosebazooka commented Jan 9, 2019

chanseokoh commented Jan 9, 2019

PierreBesson commented Jan 9, 2019

atomfrede commented Jan 10, 2019

loosebazooka commented Jan 10, 2019

chanseokoh commented Jan 10, 2019

chanseokoh commented Jan 10, 2019

PierreBesson commented Jan 14, 2019

chanseokoh commented Jan 14, 2019 • edited

atomfrede commented Jan 14, 2019

PierreBesson commented Jan 14, 2019

atomfrede commented Jan 14, 2019

PierreBesson commented Jan 14, 2019 • edited

atomfrede commented Jan 14, 2019 via email

chanseokoh Jan 14, 2019

Choose a reason for hiding this comment

PierreBesson Jan 14, 2019

Choose a reason for hiding this comment

chanseokoh Jan 14, 2019

Choose a reason for hiding this comment

chanseokoh Jan 14, 2019

Choose a reason for hiding this comment

pascalgrimaud commented Feb 12, 2019

PierreBesson commented Feb 12, 2019

pascalgrimaud commented Feb 12, 2019

pascalgrimaud commented Feb 12, 2019

DanielFran commented Apr 9, 2019

pascalgrimaud commented Apr 9, 2019

DanielFran commented Apr 9, 2019

PierreBesson commented Jan 9, 2019 •

edited

chanseokoh commented Jan 14, 2019 •

edited

PierreBesson commented Jan 14, 2019 •

edited