For #1529: configurations and automated tests

- replication implementation
  - distributable WAR
  - listener
  - configuration property
  - bootstrap caches upon web app start
  - PE check
- configuration for replication setup
  - Orbeon Forms properties and logging
  - Ehcache
  - HAProxy
  - Tomcat
- tests
  - pull Docker images
  - use newer version of Docker and don't start default docker service
  - ability to start/stop Docker instances from integration tests
  - make `orbeon-war` a cross-project
  - add first integration tests
- misc
  - some utilities for Future
  - some Node.js facades
  - upgrade Scala.js to 0.6.19

Author: ebruchez

.travis.yml

@@ -40,6 +40,11 @@ before_cache:
 # Tricks to avoid unnecessary cache updates
 - find $HOME/.ivy2 -name "ivydata-*.properties" -delete
 - find $HOME/.sbt -name "*.lock" -delete
+before_install:
+  - curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
+  - sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
+  - sudo apt-get update
+  - sudo apt-get -y install docker-ce
 install:
 # From https://docs.travis-ci.com/user/languages/java/: "Because there is no single standard way of installing project dependencies with Ant, you need to
 # specify the exact command to run using install". Here we install npm dependencies for Node.js as we need them for integration tests.
@@ -51,5 +56,8 @@ before_script:
 - mysql --protocol=TCP --host=localhost --user root -e "GRANT ALL PRIVILEGES ON *.* TO 'orbeon'@'localhost' WITH GRANT OPTION"
 - createuser --superuser orbeon
 - createdb --owner=orbeon orbeon
+# Download other Docker images
+- if [ "$TARGET" == "test-unit" ]; then docker pull tomcat:8.0; fi
+- if [ "$TARGET" == "test-unit" ]; then docker pull haproxy:1.7; fi
 script:
 - "ant $TARGET"

build.sbt

@@ -1,6 +1,8 @@
 import sbt.Keys._
+import org.orbeon.sbt.OrbeonSupport
 import org.orbeon.sbt.OrbeonSupport._
 import org.orbeon.sbt.OrbeonWebappPlugin
+import org.scalajs.sbtplugin.ScalaJSPlugin.AutoImport.jsEnv
 //import sbtcross.{crossProject, CrossType} // until Scala.js 1.0.0 is released
 
 val DefaultOrbeonFormsVersion     = "2016.3-SNAPSHOT"
@@ -147,7 +149,7 @@ val JarFilesToExcludeFromLiferayWar = Set(
 
 val TestResourceManagerPaths = List(
   "src/test/resources", // so that Java processor tests work
-  "orbeon-war/src/main/webapp/WEB-INF/resources"
+  "orbeon-war/jvm/src/main/webapp/WEB-INF/resources"
 )
 
 def resourceManagerProperties(buildBaseDirectory: File): List[String] = {
@@ -246,7 +248,7 @@ lazy val unmanagedJarsSettings = Seq(
 
 lazy val commonSettings = Seq(
 
-  jsEnv                         := JSDOMNodeJSEnv().value,
+  jsEnv                         := new org.scalajs.jsenv.jsdomnodejs.JSDOMNodeJSEnv(),
 
   javacOptions                  ++= Seq(
     "-encoding", "utf8",
@@ -340,6 +342,7 @@ lazy val common = (crossProject.crossType(CrossType.Full) in file("common"))
     )
   )
   .jsSettings(
+    libraryDependencies += "org.scala-lang.modules" %%  "scala-async" % "0.9.7" % "provided"
   )
 
 lazy val commonJVM = common.jvm
@@ -492,7 +495,7 @@ lazy val formBuilderJVM = formBuilder.jvm
 lazy val formBuilderJS: Project = formBuilder.js
   .dependsOn(
     commonJS,
-    xformsJS  % "test->test;compile->compile",
+    xformsJS % "test->test;compile->compile",
     formRunnerJS
   )
   .settings(
@@ -507,11 +510,8 @@ lazy val formBuilderJS: Project = formBuilder.js
 
     jsDependencies      in Test    += ProvidedJS / "ops/javascript/orbeon/util/jquery-orbeon.js" dependsOn "jquery.js",
 
-    scalaJSUseMainModuleInitializer in Compile := true,
-    scalaJSUseMainModuleInitializer in Test    := false,
-
-    testOptions         in Test    += Tests.Setup(() ⇒ println("Setup")),
-    testOptions         in Test    += Tests.Cleanup(() ⇒ println("Cleanup")),
+    scalaJSUseMainModuleInitializer in Compile := false,
+    scalaJSUseMainModuleInitializer in Test := false,
 
     fastOptJSToLocalResources := copyScalaJSToExplodedWar(
       (fastOptJS in Compile).value.data,
@@ -589,6 +589,19 @@ lazy val xformsJS: Project = xforms.js
     )
   )
 
+lazy val nodeFacades = (project in file("node-facades"))
+  .enablePlugins(ScalaJSPlugin)
+  .settings(commonSettings: _*)
+  .settings(
+    name := "orbeon-node-facades",
+
+    parallelExecution               in Test := false,
+    scalaJSUseMainModuleInitializer in Test := false,
+    jsEnv                           in Test := new org.scalajs.jsenv.nodejs.NodeJSEnv(),
+
+    scalaJSLinkerConfig                     ~= { _.withModuleKind(ModuleKind.CommonJSModule) }
+  )
+
 lazy val core = (project in file("src"))
   .enablePlugins(BuildInfoPlugin, SbtCoffeeScript, SbtWeb)
   .dependsOn(commonJVM, dom, xupdate)
@@ -615,10 +628,13 @@ lazy val core = (project in file("src"))
     libraryDependencies                ++= CoreLibraryDependencies
   )
 
-lazy val orbeonWar = (project in file("orbeon-war"))
+lazy val orbeonWar = (crossProject.crossType(CrossType.Dummy) in file("orbeon-war"))
   .settings(
-    name := "orbeon-war"
+    name := "orbeon-war",
+    exportJars := false
   )
+
+lazy val orbeonWarJVM = orbeonWar.jvm
   .dependsOn(
     commonJVM,
     dom,
@@ -635,6 +651,41 @@ lazy val orbeonWar = (project in file("orbeon-war"))
   .settings(OrbeonWebappPlugin.projectSettings: _*)
   .settings(commonSettings: _*)
 
+
+lazy val orbeonWarJS = orbeonWar.js
+  .enablePlugins(BuildInfoPlugin)
+  .settings(commonSettings: _*)
+  .dependsOn(
+    commonJS,
+    xformsJS,
+    nodeFacades
+  )
+  .settings(
+
+    // Poor man's way to pass parameters to the test suite
+    buildInfoPackage               := "org.orbeon.fr",
+    buildInfoObject                := "TestParametersFromSbt",
+    buildInfoKeys                  := Seq[BuildInfoKey](
+      "baseDirectory" → (baseDirectory  in ThisBuild).value.getAbsolutePath
+    ),
+
+    libraryDependencies            ++= Seq(
+      "org.scala-js"           %%% "scalajs-dom"    % ScalaJsDomVersion,
+      "be.doeraene"            %%% "scalajs-jquery" % ScalaJsJQueryVersion,
+      "fr.hmil"                %%% "roshttp"        % "2.0.2" % Test,
+      "org.scala-lang.modules" %%  "scala-async"    % "0.9.7" % "provided"
+    ),
+
+    parallelExecution               in Test := false,
+    scalaJSUseMainModuleInitializer in Test := false,
+    jsEnv                           in Test := new org.scalajs.jsenv.nodejs.NodeJSEnv(),
+    scalaJSLinkerConfig                     ~= { _.withModuleKind(ModuleKind.CommonJSModule) },
+
+    testOptions                     in Test +=
+      Tests.Setup(() ⇒ OrbeonSupport.dummyDependency((Keys.`package` in orbeonWarJVM).value))
+  )
+
+
 lazy val root = (project in file("."))
   .aggregate(
     commonJVM,
@@ -652,7 +703,8 @@ lazy val root = (project in file("."))
     portletSupport,
     formRunnerProxyPortlet,
     fullPortlet,
-    orbeonWar
+    orbeonWarJVM,
+    orbeonWarJS
   )
   .settings(
     // TEMP: override so that root project doesn't search under src

build.xml

@@ -157,12 +157,12 @@
             -ignorewarnings
             -forceprocessing
 
-            -injars      orbeon-war/target/webapp/WEB-INF/lib/(!slf4j-api-1.7.21.jar,**.jar;)
+            -injars      orbeon-war/jvm/target/webapp/WEB-INF/lib/(!slf4j-api-1.7.21.jar,**.jar;)
             -outjars     ${temp.jar}(**.class,!**)
 
             -libraryjars ${java.home}/lib/rt.jar
 
-            -libraryjars orbeon-war/target/webapp/WEB-INF/lib/slf4j-api-1.7.21.jar
+            -libraryjars orbeon-war/jvm/target/webapp/WEB-INF/lib/slf4j-api-1.7.21.jar
 
             -libraryjars lib/provided/javax.servlet-api-3.0.1.jar
             -libraryjars lib/provided/portlet-api_2.0.jar
@@ -206,12 +206,12 @@
             -ignorewarnings
             -forceprocessing
 
-            -injars      orbeon-war/target/webapp/WEB-INF/lib/(!slf4j-api-1.7.21.jar,**.jar;)
+            -injars      orbeon-war/jvm/target/webapp/WEB-INF/lib/(!slf4j-api-1.7.21.jar,**.jar;)
             -outjars     ${temp.jar}(**.class,!**)
 
             -libraryjars ${java.home}/lib/rt.jar
 
-            -libraryjars orbeon-war/target/webapp/WEB-INF/lib/slf4j-api-1.7.21.jar
+            -libraryjars orbeon-war/jvm/target/webapp/WEB-INF/lib/slf4j-api-1.7.21.jar
 
             -libraryjars lib/provided/javax.servlet-api-3.0.1.jar
             -libraryjars lib/provided/portlet-api_2.0.jar
@@ -257,12 +257,12 @@
             -ignorewarnings
             -forceprocessing
 
-            -injars      orbeon-war/target/webapp/WEB-INF/lib/(!slf4j-api-1.7.21.jar,**.jar;)
+            -injars      orbeon-war/jvm/target/webapp/WEB-INF/lib/(!slf4j-api-1.7.21.jar,**.jar;)
             -outjars     ${temp.jar}(**.class,!**)
 
             -libraryjars ${java.home}/lib/rt.jar
 
-            -libraryjars orbeon-war/target/webapp/WEB-INF/lib/slf4j-api-1.7.21.jar
+            -libraryjars orbeon-war/jvm/target/webapp/WEB-INF/lib/slf4j-api-1.7.21.jar
 
             -libraryjars lib/provided/javax.servlet-api-3.0.1.jar
             -libraryjars lib/provided/portlet-api_2.0.jar
@@ -295,8 +295,8 @@
         </exec>
 
         <!-- Make sure we remove PathMap from Saxon as we have our own implementation -->
-        <delete file="orbeon-war/target/webapp/WEB-INF/lib/${saxon.jar}"/>
-        <jar destfile="orbeon-war/target/webapp/WEB-INF/lib/${saxon.jar}">
+        <delete file="orbeon-war/jvm/target/webapp/WEB-INF/lib/${saxon.jar}"/>
+        <jar destfile="orbeon-war/jvm/target/webapp/WEB-INF/lib/${saxon.jar}">
             <zipfileset src="lib/runtime/${saxon.jar}" excludes="org/orbeon/saxon/expr/PathMap*.class"/>
         </jar>
 
@@ -327,7 +327,7 @@
 
     <target name="orbeon-dev-war" depends="war-common" description="Create exploded WAR">
         <copy todir="build/orbeon-war">
-            <fileset dir="orbeon-war/target/webapp">
+            <fileset dir="orbeon-war/jvm/target/webapp">
                 <!-- Filter local eXist that that might (but shouldn't) be in there -->
                 <exclude name="WEB-INF/exist-data/**"/>
             </fileset>
@@ -339,7 +339,7 @@
         <mkdir dir="build/distrib"/>
 
         <zip zipfile="build/distrib/${versioned-name}.war">
-            <zipfileset dir="orbeon-war/target/webapp">
+            <zipfileset dir="orbeon-war/jvm/target/webapp">
                 <!-- Filter local eXist that that might (but shouldn't) be in there -->
                 <exclude name="WEB-INF/exist-data/**"/>
             </zipfileset>
@@ -723,7 +723,7 @@
         <!-- http://exist-db.org/ant-tasks.html -->
         <typedef resource="org/exist/ant/antlib.xml" uri="http://exist-db.org/ant">
             <classpath>
-                <fileset dir="orbeon-war/target/webapp/WEB-INF/lib">
+                <fileset dir="orbeon-war/jvm/target/webapp/WEB-INF/lib">
                     <include name="**/*.jar"/>
                 </fileset>
             </classpath>

common/js/src/main/scala/org/orbeon/oxf/util/FutureUtils.scala

@@ -0,0 +1,68 @@
+/**
+  * Copyright (C) 2017 Orbeon, Inc.
+  *
+  * This program is free software; you can redistribute it and/or modify it under the terms of the
+  * GNU Lesser General Public License as published by the Free Software Foundation; either version
+  *  2.1 of the License, or (at your option) any later version.
+  *
+  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  * See the GNU Lesser General Public License for more details.
+  *
+  * The full text of the license is available at http://www.gnu.org/copyleft/lesser.html
+  */
+package org.orbeon.oxf.util
+
+import scala.concurrent.duration.FiniteDuration
+import scala.concurrent.{ExecutionContext, Future, Promise}
+import scala.scalajs.js.timers.setTimeout
+import scala.util.{Failure, Success, Try}
+import scala.async.Async._
+import scala.concurrent.duration._
+
+object FutureUtils {
+
+  def delay(delay: FiniteDuration): Future[Unit] = {
+    val p = Promise[Unit]()
+    setTimeout(delay) {
+      p.success(())
+    }
+    p.future
+  }
+
+  def eventually[T](
+    interval    : FiniteDuration,
+    timeout     : FiniteDuration)(
+    block       : ⇒ Future[T])(implicit
+    execContext : ExecutionContext
+  ): Future[Try[T]] = async {
+
+    val startTime = System.currentTimeMillis
+
+    var result: Try[T] = null
+
+    var done = false
+    while(! done) {
+      await(block.toTry) match {
+        case v @ Success(value) ⇒
+          result = v
+          done = true
+        case v @ Failure(_) ⇒
+          if ((System.currentTimeMillis - startTime).millis > timeout) {
+            result = v
+            done = true
+          } else {
+            await(delay(interval))
+          }
+      }
+    }
+
+    result
+  }
+
+  implicit class FutureOps[T](val f: Future[T]) extends AnyVal {
+    def toTry(implicit executor: ExecutionContext): Future[Try[T]] =
+      f map Success.apply recover PartialFunction(Failure.apply)
+  }
+
+}