Improve the task construct by specifying its ultimate goal: generate the web.xml descriptor (among others JEE ones)

Author: mmoqui

src/main/groovy/org/silverpeas/setup/SilverpeasSetupPlugin.groovy

@@ -182,7 +182,7 @@ class SilverpeasSetupPlugin implements Plugin<Project> {
   /**
    * Setup the predefined Build Gradle task to the peculiar behaviour of the plugin that is to
    * generate the Silverpeas Collaborative portal application from the extracted content of the
-   * software bundles that made up a Silverpeas distribution.
+   * software bundles that make up a Silverpeas distribution.
    * @param project the Gradle project
    * @param extension the project extension of the plugin
    */
@@ -196,8 +196,8 @@ class SilverpeasSetupPlugin implements Plugin<Project> {
           extension.installation.distDir.get().exists()
         }
         outputs.upToDateWhen {
-          boolean ok = extension.installation.distDir.get().exists() &&
-                  Files.exists(Paths.get(extension.installation.distDir.get().path, 'WEB-INF', 'web.xml'))
+          Path webDescriptor = Paths.get(extension.installation.distDir.get().path, 'WEB-INF', 'web.xml')
+          boolean ok = Files.exists(webDescriptor)
           if (!extension.installation.developmentMode.get()) {
             ok = ok && Files.exists(
                     Paths.get(project.buildDir.path, SilverpeasConstructionTask.SILVERPEAS_WAR))

src/main/groovy/org/silverpeas/setup/construction/SilverpeasBuilder.groovy

@@ -220,7 +220,7 @@ class SilverpeasBuilder {
             fileName.endsWith('war.xml')
       }
     })
-    if (mainWebXmlFiles.size() != 1) {
+    if (mainWebXmlFiles == null || mainWebXmlFiles.size() != 1) {
       throw new IllegalStateException('No main web descriptor found!')
     }
 

src/main/groovy/org/silverpeas/setup/construction/SilverpeasConstructionTask.groovy

@@ -23,15 +23,13 @@
  */
 package org.silverpeas.setup.construction
 
-
-import org.gradle.api.tasks.Internal
-import org.gradle.api.tasks.Nested
-import org.gradle.api.tasks.TaskAction
+import org.gradle.api.tasks.*
 import org.silverpeas.setup.SilverpeasInstallationProperties
 import org.silverpeas.setup.api.FileLogger
 import org.silverpeas.setup.api.SilverpeasSetupTask
 
 import java.nio.file.Files
+import java.nio.file.Path
 import java.nio.file.Paths
 
 /**
@@ -54,25 +52,34 @@ class SilverpeasConstructionTask extends SilverpeasSetupTask {
     description = 'Assemble and build the Silverpeas Collaborative Web Application'
     group = 'Build'
     onlyIf {
-      precondition()
+      preconditionSatisfied()
     }
     outputs.upToDateWhen {
-      isUpToDate()
+      allIsGenerated()
     }
   }
 
-  def precondition() {
-    !installation.distDir.get().exists() && !installation.dsDriversDir.get().exists()
+  def preconditionSatisfied() {
+    !areBundlesAssembled() || !isWebDescriptorGenerated()
   }
 
-  def isUpToDate() {
-    boolean ok = installation.distDir.get().exists() && installation.dsDriversDir.get().exists()
+  def allIsGenerated() {
+    boolean ok = areBundlesAssembled() && isWebDescriptorGenerated()
     if (!installation.developmentMode.get()) {
       ok = ok && Files.exists(Paths.get(project.buildDir.path, SILVERPEAS_WAR))
     }
     return ok
   }
 
+  private boolean isWebDescriptorGenerated() {
+    Path webDescriptor = Paths.get(installation.distDir.get().path, 'WEB-INF', 'web.xml')
+    return Files.exists(webDescriptor)
+  }
+
+  private boolean areBundlesAssembled() {
+    return installation.distDir.get().exists() && installation.dsDriversDir.get().exists()
+  }
+
   @TaskAction
   void construct() {
     if (!installation.distDir.get().exists()) {
@@ -81,11 +88,13 @@ class SilverpeasConstructionTask extends SilverpeasSetupTask {
     if (!installation.dsDriversDir.get().exists()) {
       installation.dsDriversDir.get().mkdirs()
     }
+
     SilverpeasBuilder builder = new SilverpeasBuilder(project, log)
     builder.driversDir = installation.dsDriversDir.get()
     builder.silverpeasHome = silverpeasHome
     builder.developmentMode = installation.developmentMode.get()
     builder.settings = settings
+
     builder.extractSoftwareBundles(installation.bundles, installation.distDir.get())
     builder.generateSilverpeasApplication(installation.distDir.get())
   }

src/test/groovy/org/silverpeas/setup/configuration/SilverpeasConfigurationTaskTest.groovy

@@ -19,7 +19,7 @@ class SilverpeasConfigurationTaskTest {
 
   @Before
   void setUp() {
-    context = TestContext.create().setUpSystemEnv().initGradleProject()
+    context = TestContext.create().setUpSystemEnv().initGradleProject(['construct'])
   }
 
   @After
@@ -43,7 +43,7 @@ class SilverpeasConfigurationTaskTest {
     assertTheConfigContextIsCorrectlySaved(testProperties)
   }
 
-  void assertTheCustomerWorkflowIsCorrectlyConfigured(TestProperties props) {
+  static void assertTheCustomerWorkflowIsCorrectlyConfigured(TestProperties props) {
     def before = props.xmlconf.before
     def after = props.xmlconf.after
     assert after.adefCreateSupplier.actions.action.find { it.@name == 'Archiver'}
@@ -127,7 +127,7 @@ class SilverpeasConfigurationTaskTest {
         after.scheduler['timeoutSchedule'] != before.scheduler['timeoutSchedule']
   }
 
-  void assertTheConfigContextIsCorrectlySaved(TestProperties props) {
+  static void assertTheConfigContextIsCorrectlySaved(TestProperties props) {
     assert props.configContext.before['status is'] == props.configContext.after['status is']
     assert props.configContext.before['installed at'] == props.configContext.after['installed at']
     assert props.configContext.before['updated at'] == props.configContext.after['updated at']

src/test/groovy/org/silverpeas/setup/test/TestContext.groovy

@@ -81,11 +81,20 @@ class TestContext {
   /**
    * Initializes in the filesystem a Gradle project that uses the plugin. The Gradle project
    * can then be ran by using the Gradle runner returned by the TestContext#getGradleRunner method.
+   * @param previousInvokedTasks a list of task names that have to be considered as yet invoked. As such, the resources
+   * these tasks should created will be set up in order to avoid them to be again invoked through tasks dependency
+   * graph.
    * @return itself.
    */
-  TestContext initGradleProject() {
-    Files.createDirectories(Paths.get(resourcesDir, 'build', 'drivers'))
-    Files.createDirectories(Paths.get(resourcesDir, 'build', 'dist'))
+  TestContext initGradleProject(List<String> previousInvokedTasks) {
+    if (previousInvokedTasks.contains("assemble") || previousInvokedTasks.contains("construct")) {
+      Files.createDirectories(Paths.get(resourcesDir, 'build', 'drivers'))
+      Files.createDirectories(Paths.get(resourcesDir, 'build', 'dist', 'WEB-INF'))
+    }
+    if (previousInvokedTasks.contains("build") || previousInvokedTasks.contains("construct")) {
+      Files.createFile(Paths.get(resourcesDir, 'build', 'dist', 'WEB-INF', 'web.xml'))
+    }
+
     Files.createFile(Paths.get(resourcesDir, 'settings.gradle'))
         .toFile()
         .text = """