Feature #10762

Define a new object in SilverpeasConfigurationProperties: Context.
This object defines a configuration context that can be used by any components
implied in a task of SilverSetup as well by any scripts executed by those
tasks. The context is publicly available in the settings global variable and it
is represented by a Map. Once the build is finished, the properties set in the
context are then persisted into the file SILVERPEAS_HOME/configuration/.config.

The goal of the Context object is to allow any scripts and components used in
tasks to keep track of any configuration, migration or installation context so
that they can adapt their behaviour at the next execution.

Author: mmoqui

build.gradle

@@ -37,6 +37,7 @@ buildscript {
 }
 
 plugins {
+  id 'java-gradle-plugin'
   id 'org.ajoberstar.grgit' version '3.0.0' apply true
   id 'idea'
   id 'maven'
@@ -112,13 +113,17 @@ dependencies {
   compile 'org.apache.commons:commons-dbcp2:2.2.0'
   compile 'commons-codec:commons-codec:1.10'
   compile 'javax.jcr:jcr:2.0'
-  compile 'org.apache.jackrabbit:jackrabbit-core:2.8.0'
+  compile 'org.apache.jackrabbit:jackrabbit-core:2.18.2'
   runtime 'org.eclipse.jetty:jetty-jndi:9.4.8.v20171121'
   runtime 'org.eclipse.jetty:jetty-util:9.4.8.v20171121'
   runtime 'com.h2database:h2:1.4.196'
   runtime 'org.postgresql:postgresql:42.1.4'
   runtime 'net.sourceforge.jtds:jtds:1.3.1'
+  testCompile gradleTestKit()
   testCompile 'junit:junit:4.12'
+  testImplementation('org.spockframework:spock-core:1.1-groovy-2.4') {
+    exclude module: 'groovy-all'
+  }
 }
 
 ext {

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

@@ -26,6 +26,7 @@ package org.silverpeas.setup
 import org.gradle.api.Project
 
 import javax.inject.Inject
+import java.nio.file.Files
 
 /**
  * Properties for the configuration of Silverpeas. Such properties include the location of the
@@ -73,15 +74,62 @@ class SilverpeasConfigurationProperties {
    */
   final Map settings = [:]
 
+  /**
+   * Context of a configuration process of Silverpeas: it is a set of context properties left to the
+   * discretion of the different steps executed in the configuration. The context is serialized so
+   * that it can be retrieved in the next configuration process by the different steps so that they
+   * can adapt their behaviour according to the properties they have set.
+   */
+  final Context context
+
   @Inject
   SilverpeasConfigurationProperties(Project project, File silverpeasHome) {
     configurationHome = project.file("${silverpeasHome.path}/configuration")
     jbossConfigurationDir = project.file("${silverpeasHome.path}/configuration/jboss")
     silverpeasConfigurationDir = project.file("${silverpeasHome.path}/configuration/silverpeas")
     jbossModulesDir = project.file("${jbossConfigurationDir.path}/modules")
+    context = new Context(configurationHome, settings)
   }
 
   void setSettings(final Map configProperties) {
     this.settings.putAll(configProperties)
   }
+
+  /**
+   * Context of a configuration process. It sets in the settings variable (that is shared by all
+   * the steps implied within a configuration of Silverpeas) the peculiar <code>context</code>
+   * attribute that is a dictionary of all the context properties the steps can set for their usage.
+   */
+  static class Context {
+    final private File file
+    final private Map props = [:]
+
+    /**
+     * Constructs a new configuration context.
+     * @param storageDir the directory into which the context will be saved.
+     * @param settings the dictionary to use to store the context properties. A peculiar
+     * <code>context</code> key will be put with as values a Map object.
+     */
+    private Context(File storageDir, final Map settings) {
+      file = new File(storageDir, '.context')
+      settings.context = props
+      if (Files.exists(file.toPath())) {
+        file.text.eachLine { line ->
+          String[] keyValue = line.trim().split(':')
+          props[keyValue[0].trim()] = keyValue[1].trim()
+        }
+      }
+    }
+
+    void save() {
+      if (!Files.exists(file.toPath())) {
+        Files.createFile(file.toPath())
+      }
+      file.withWriter('UTF-8') { w ->
+        props.each { k, v ->
+          w.println("${k}: ${v}")
+        }
+      }
+    }
+  }
 }

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

@@ -65,6 +65,10 @@ class SilverpeasSetupPlugin implements Plugin<Project> {
     def extension = project.extensions.create(EXTENSION, SilverpeasSetupExtension, project)
     initSilverpeasSetupExtention(extension)
 
+    project.gradle.buildFinished {
+      extension.config.context.save()
+    }
+
     SilverpeasSetupService setupService = new SilverpeasSetupService(extension.config.settings)
     ManagedBeanContainer.registry()
         .register(new DataSourceProvider(extension.config.settings))
@@ -118,7 +122,7 @@ class SilverpeasSetupPlugin implements Plugin<Project> {
     Task migration = project.tasks.create(MIGRATE.name, SilverpeasMigrationTask) {
       it.migrationHome = extension.migrationHome
       it.config        = extension.config
-    }.dependsOn(configuration)
+    }.dependsOn(construction)
 
     project.tasks.create(INSTALL.name, SilverpeasInstallationTask) {
       it.deploymentDir   = extension.deploymentDir

src/main/groovy/org/silverpeas/setup/api/ManagedBeanContainer.groovy

@@ -32,7 +32,7 @@ class ManagedBeanContainer {
   static class Registry {
 
     Registry register(def bean, String name) {
-      beans.put(name, bean)
+      beans.putIfAbsent(name, bean)
       return this
     }
 

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

@@ -1,50 +1,51 @@
 package org.silverpeas.setup.configuration
 
-import org.gradle.api.Project
-import org.gradle.testfixtures.ProjectBuilder
-import org.silverpeas.setup.test.TestSetUp
 
-import static org.silverpeas.setup.api.SilverpeasSetupTaskNames.CONFIGURE_SILVERPEAS
+import org.silverpeas.setup.test.TestContext
+
+import java.time.LocalDate
+
+import static org.gradle.testkit.runner.TaskOutcome.SUCCESS
 
 /**
  * Test the case of the configuration of Silverpeas performed by a dedicated Gradle task.
  * @author mmoquillon
  */
 class SilverpeasConfigurationTaskTest extends GroovyTestCase {
 
-  private TestSetUp testSetUp
-  private Project project
+  private TestContext context
 
   @Override
   void setUp() {
     super.setUp()
-    testSetUp = TestSetUp.setUp()
-
-    System.setProperty('SILVERPEAS_HOME', testSetUp.resourcesDir)
-    System.setProperty('JBOSS_HOME', testSetUp.resourcesDir)
-
-    project = ProjectBuilder.builder().build()
-    project.apply plugin: 'silversetup'
+    context = TestContext.create().setUpSystemEnv().initGradleProject()
+  }
 
-    project.silversetup.logging.logDir = new File(project.buildDir, 'log')
-    project.silversetup.logging.useLogger = false
+  @Override
+  void tearDown() throws Exception {
+    super.tearDown()
+    context.cleanUp()
   }
 
   void testSilverpeasConfiguration() {
-    TestContext context = new TestContext().before()
+    TestProperties testProperties = new TestProperties().before()
 
-    project.tasks.findByPath(CONFIGURE_SILVERPEAS.name).configureSilverpeas()
+    def result = context.getGradleRunner(true)
+        .withArguments('configure_silverpeas')
+        .build()
+    assert result.task(':configure_silverpeas').outcome == SUCCESS
 
-    context.after()
+    testProperties.after()
 
-    assertThePropertiesFileAreCorrectlyConfigured(context)
-    assertTheCustomerWorkflowIsCorrectlyConfigured(context)
-    assertTheWorkflowEngineIsCorrectlyConfiguredByGroovyScript(context)
+    assertThePropertiesFileAreCorrectlyConfigured(testProperties)
+    assertTheCustomerWorkflowIsCorrectlyConfigured(testProperties)
+    assertTheWorkflowEngineIsCorrectlyConfiguredByGroovyScript(testProperties)
+    assertTheConfigContextIsCorrectlySaved(testProperties)
   }
 
-  void assertTheCustomerWorkflowIsCorrectlyConfigured(TestContext context) {
-    def before = context.xmlconf.before
-    def after = context.xmlconf.after
+  void assertTheCustomerWorkflowIsCorrectlyConfigured(TestProperties props) {
+    def before = props.xmlconf.before
+    def after = props.xmlconf.after
     assert after.adefCreateSupplier.actions.action.find { it.@name == 'Archiver'}
           .consequences.consequence.find { it.@value == 'achats'}
           .triggers.trigger.param.find { it.@name == 'targetComponentId'}.@value !=
@@ -106,14 +107,14 @@ class SilverpeasConfigurationTaskTest extends GroovyTestCase {
           .consequences.consequence.triggers.trigger.param.find { it.@name == 'targetTopicId'}.@value == '100'
   }
 
-  void assertThePropertiesFileAreCorrectlyConfigured(TestContext context) {
-    def before = context.settings.before
-    def after = context.settings.after
+  void assertThePropertiesFileAreCorrectlyConfigured(TestProperties props) {
+    def before = props.settings.before
+    def after = props.settings.after
 
     assert after.autDomainSQL['fallbackType'] == 'always' &&
         after.autDomainSQL['fallbackType'] == before.autDomainSQL['fallbackType']
     assert after.autDomainSQL['autServer0.SQLJDBCUrl'] ==
-        "jdbc:h2:file:${testSetUp.resourcesDir}/h2/test;MV_STORE=FALSE;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE" &&
+        "jdbc:h2:file:${context.resourcesDir}/h2/test;MV_STORE=FALSE;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE" &&
         after.autDomainSQL['autServer0.SQLJDBCUrl'] != before.autDomainSQL['autServer0.SQLJDBCUrl']
     assert after.autDomainSQL['autServer0.SQLAccessLogin'] == 'sa' &&
         after.autDomainSQL['autServer0.SQLAccessLogin'] != before.autDomainSQL['autServer0.SQLAccessLogin']
@@ -129,10 +130,10 @@ class SilverpeasConfigurationTaskTest extends GroovyTestCase {
         !after.castorSettings['CastorJDODatabaseFileURL'].empty
   }
 
-  void assertTheWorkflowEngineIsCorrectlyConfiguredByGroovyScript(TestContext context) {
+  void assertTheWorkflowEngineIsCorrectlyConfiguredByGroovyScript(TestProperties props) {
     // the JDO Castor doesn't support H2, so the engine is set up by default to postgresql
-    def before = context.xmlconf.before
-    def after = context.xmlconf.after
+    def before = props.xmlconf.before
+    def after = props.xmlconf.after
 
     assert after.workflowDatabaseConf.@engine == 'postgresql' &&
         after.workflowDatabaseConf.@engine.text() != before.workflowDatabaseConf.@engine.text()
@@ -147,4 +148,11 @@ class SilverpeasConfigurationTaskTest extends GroovyTestCase {
         "file:///${System.getProperty('SILVERPEAS_HOME')}/resources/instanceManager/fast_mapping.xml"
   }
 
+  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']
+    assert props.configContext.after['context handled at'] == LocalDate.now().toString()
+  }
+
 }

src/test/groovy/org/silverpeas/setup/configuration/TestContext.groovy renamed to src/test/groovy/org/silverpeas/setup/configuration/TestProperties.groovy

@@ -3,10 +3,10 @@ package org.silverpeas.setup.configuration
 import groovy.util.slurpersupport.GPathResult
 
 /**
- * A context of a unit test on the Silverpeas configuration.
+ * A set of properties to use in the tests on the Silverpeas configuration.
  * @author mmoquillon
  */
-class TestContext {
+class TestProperties {
 
   def settings = [
       before: [
@@ -38,10 +38,15 @@ class TestContext {
       ]
   ]
 
-  TestContext() {
+  def configContext = [
+      before: [:],
+      after: [:]
+  ]
+
+  TestProperties() {
   }
 
-  TestContext before() {
+  TestProperties before() {
     settings.before.autDomainSQL = loadPropertiesFrom('authentication/autDomainSQL.properties')
     settings.before.system = loadPropertiesFrom('systemSettings.properties')
     settings.before.scheduler = loadPropertiesFrom('workflow/engine/schedulerSettings.properties')
@@ -51,10 +56,12 @@ class TestContext {
     xmlconf.before.adefCreateProduct = loadXmlFileFrom('/data/workflowRepository/ADEFCreateProduct.xml')
     xmlconf.before.workflowDatabaseConf = loadXmlFileFrom('/resources/instanceManager/database.xml')
     xmlconf.before.workflowFastDatabaseConf = loadXmlFileFrom('/resources/instanceManager/fast_database.xml')
+
+    configContext.before = loadKeyValuesFileFrom('/configuration/.context')
     return this
   }
 
-  TestContext after() {
+  TestProperties after() {
     settings.after.autDomainSQL = loadPropertiesFrom('authentication/autDomainSQL.properties')
     settings.after.system = loadPropertiesFrom('systemSettings.properties')
     settings.after.scheduler = loadPropertiesFrom('workflow/engine/schedulerSettings.properties')
@@ -64,6 +71,8 @@ class TestContext {
     xmlconf.after.adefCreateProduct = loadXmlFileFrom('/data/workflowRepository/ADEFCreateProduct.xml')
     xmlconf.after.workflowDatabaseConf = loadXmlFileFrom('/resources/instanceManager/database.xml')
     xmlconf.after.workflowFastDatabaseConf = loadXmlFileFrom('/resources/instanceManager/fast_database.xml')
+
+    configContext.after = loadKeyValuesFileFrom('/configuration/.context')
     return this
   }
 
@@ -81,4 +90,13 @@ class TestContext {
     is.close()
     return result
   }
+
+  private Map loadKeyValuesFileFrom(String path) {
+    final Map keyValuePairs = [:]
+    getClass().getResourceAsStream(path).text.eachLine { line ->
+      String[] keyValue = line.trim().split(':')
+      keyValuePairs[keyValue[0].trim()] = keyValue[1].trim()
+    }
+    return keyValuePairs
+  }
 }

src/test/groovy/org/silverpeas/setup/installation/SilverpeasInstallationTaskTest.groovy

@@ -4,7 +4,7 @@ import groovy.mock.interceptor.MockFor
 import org.gradle.api.Project
 import org.gradle.testfixtures.ProjectBuilder
 import org.silverpeas.setup.api.JBossServer
-import org.silverpeas.setup.test.TestSetUp
+import org.silverpeas.setup.test.TestContext
 
 import static org.silverpeas.setup.api.SilverpeasSetupTaskNames.INSTALL
 /**
@@ -14,16 +14,13 @@ import static org.silverpeas.setup.api.SilverpeasSetupTaskNames.INSTALL
 class SilverpeasInstallationTaskTest extends GroovyTestCase {
 
   private Project project
-  protected TestSetUp testSetUp
+  protected TestContext context
 
   @Override
   void setUp() {
     super.setUp()
 
-    testSetUp = TestSetUp.setUp()
-
-    System.setProperty('SILVERPEAS_HOME', testSetUp.resourcesDir)
-    System.setProperty('JBOSS_HOME', testSetUp.resourcesDir)
+    context = TestContext.create().setUpSystemEnv()
 
     project = ProjectBuilder.builder().build()
     project.apply plugin: 'silversetup'

src/test/groovy/org/silverpeas/setup/migration/AbstractDatabaseTest.groovy

@@ -27,15 +27,15 @@ import groovy.sql.Sql
 import org.silverpeas.setup.api.ManagedBeanContainer
 import org.silverpeas.setup.api.SilverpeasSetupService
 import org.silverpeas.setup.test.DatabaseSetUp
-import org.silverpeas.setup.test.TestSetUp
+import org.silverpeas.setup.test.TestContext
 /**
  * The common class for all test cases about a database migration.
  * @author mmoquillon
  */
 abstract class AbstractDatabaseTest extends GroovyTestCase {
 
   protected DatabaseSetUp databaseSetUp
-  protected TestSetUp testSetUp
+  protected TestContext context
 
   DatabaseSetUp initDatabaseSetUp() {
     return DatabaseSetUp.setUp(withDatasource: true).createSrPackagesTable()
@@ -44,7 +44,7 @@ abstract class AbstractDatabaseTest extends GroovyTestCase {
   @Override
   void setUp() {
     super.setUp()
-    testSetUp = TestSetUp.setUp()
+    context = TestContext.create()
     databaseSetUp = initDatabaseSetUp()
     ManagedBeanContainer.registry().register(new SilverpeasSetupService([:]))
   }
@@ -57,7 +57,7 @@ abstract class AbstractDatabaseTest extends GroovyTestCase {
 
   def prepareInitialData(String module, String version) {
     databaseSetUp.prepare { Sql sql ->
-      sql.executeScript("${testSetUp.migrationHome}/db/h2/${module}/${version}/create_table.sql")
+      sql.executeScript("${context.migrationHome}/db/h2/${module}/${version}/create_table.sql")
       sql.executeUpdate("INSERT INTO sr_packages (sr_package, sr_version) VALUES (:module, :version)",
           [module: module, version: version])
     }