Merge pull request #349 from eXist-db/5.0.0-RC1

5.0.0 rc1

Author: adamretter

.travis.yml

@@ -13,9 +13,8 @@ services:
   - docker
 
 env:
-  # Deactivated for RC releases beween 4.7.1 and 5.0.0
-  # - img=existdb/existdb:latest
-  - img=existdb/existdb:release
+  - img=existdb/existdb:latest
+  # - img=existdb/existdb:release
 
 cache:
   directories:
@@ -37,7 +36,7 @@ before_script:
 script:
   - mvn validate
   - mvn test
-  - npm run cypress
+  - npm run cypress -- --record
 
 after_success:
   - docker ps

README.md

@@ -48,5 +48,7 @@ The full test-suite consists of validation, unit, and integration tests, it runs
 
 Both unit and integration tests, expect a running instance of exist with a copy of the documentation app installed reachable at `localhost:8080` and an empty admin password. It might be necessary to skip test execution during building from time to time, use: `mvn clean package -DskipTests`.
 
+You can view recordings of the previous integration test runs on our [Cypress Dashboard](https://dashboard.cypress.io/#/projects/h8zx19/runs)
+
 ## License
 LGPLv2.1 [eXist-db.org](http://exist-db.org/exist/apps/homepage/index.html)

cypress.json

@@ -1,11 +1,13 @@
 {
   "baseUrl": "http://localhost:8080/exist/apps/doc",
+  "projectId": "h8zx19",
   "fileServerFolder": "src/main/xar-resources",
   "ignoreTestFiles": "src/test/cypress/integration/examples/*.js",
   "fixturesFolder": "src/test/cypress/fixtures",
   "integrationFolder": "src/test/cypress/integration",
   "pluginsFile": "src/test/cypress/plugins/index.js",
   "screenshotsFolder": "src/test/cypress/screenshots",
   "supportFile": "src/test/cypress/support/index.js",
-  "videosFolder": "src/test/cypress/videos"
+  "videosFolder": "src/test/cypress/videos",
+  "projectId": "h8zx19"
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "exist-documentation",
-  "version": "4.2.0",
+  "version": "5.0.0-RC3",
   "description": "Documentation package for eXist-db",
   "scripts": {
     "test": "standard 'src/test/**/*.js' && mocha src/test/mocha/ --recursive --exit",

package.json

@@ -12,7 +12,7 @@
 
   <groupId>org.exist-db</groupId>
   <artifactId>exist-documentation</artifactId>
-  <version>4.2.2-SNAPSHOT</version>
+  <version>5.0.0-SNAPSHOT</version>
 
   <name>eXist-db Documentation</name>
   <description>Documentation package for eXist-db</description>
@@ -48,7 +48,7 @@
     <project.build.source>1.8</project.build.source>
     <project.build.target>1.8</project.build.target>
 
-    <exist.version>4.7.0</exist.version>
+    <exist.version>5.0.0-RC7</exist.version>
     <node.version>v11.15.0</node.version>
     <npm.version>6.9.0</npm.version>
 
@@ -109,13 +109,14 @@
               <goal>install-node-and-npm</goal>
             </goals>
             <!-- optional: default phase is "generate-resources" -->
-            <phase>generate-resources</phase>
+            <phase>compile</phase>
           </execution>
           <execution>
             <id>npm version bump</id>
             <goals>
               <goal>npm</goal>
             </goals>
+            <phase>compile</phase>
             <configuration>
               <arguments>version --no-git-tag-version --allow-same-version=true ${project.version}</arguments>
             </configuration>
@@ -125,6 +126,7 @@
             <goals>
               <goal>npm</goal>
             </goals>
+            <phase>compile</phase>
             <!-- Optional configuration which provides for running any npm command -->
             <configuration>
               <arguments>ci</arguments>
@@ -135,6 +137,7 @@
             <goals>
               <goal>gulp</goal>
             </goals>
+            <phase>compile</phase>
           </execution>
           <execution>
             <id>mocha tests</id>

pom.xml

@@ -8,7 +8,7 @@
 
     <info>
         <title>Advanced Installation Methods</title>
-        <date>1Q18</date>
+        <date>2Q19</date>
         <keywordset>
             <keyword>installation</keyword>
             <keyword>operations</keyword>
@@ -46,25 +46,6 @@
             background service which is automatically launched during system start-up. This can be
             convenient, especially for servers. eXist-db continues to run even after users have
             logged off.</para>
-        <para>eXist-db comes with pre-configured scripts that use <link condition="_blank"
-            xlink:href="http://yajsw.sourceforge.net/">YAJSW (Yet Another Java Service
-            Wrapper)</link> to handle the setup procedure. The scripts for this are contained in the
-            directory <literal>tools/yajsw</literal>. </para>
-        <para>Out of the box the following mainstream platforms are supported:</para>
-        <itemizedlist>
-            <listitem>
-                <para>Windows x86 (32bit/64bit)</para>
-            </listitem>
-            <listitem>
-                <para>Linux x86 (32bit/64bit) &amp; IA (64bit) </para>
-            </listitem>
-            <listitem>
-                <para>macOS x86 (32bit/64bit) </para>
-            </listitem>
-            <listitem>
-                <para>Solaris x86 (32bit/64bit) &amp; SPARC (32bit/64bit)</para>
-            </listitem>
-        </itemizedlist>
 
         <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
 
@@ -81,10 +62,6 @@
                     <para>Choose <guimenuitem>Install eXist-db as Service</guimenuitem> from
                         eXist-db's entry in the Windows start menu.</para>
                 </listitem>
-                <listitem>
-                    <para>Run <literal>tools/yajsw/bin/installService.bat</literal> from the command
-                        line.</para>
-                </listitem>
             </itemizedlist>
             <para>Installing eXist-db as a service on Windows requires full administrator
                 rights.</para>
@@ -98,9 +75,6 @@
                     </imageobject>
                 </mediaobject>
             </informalfigure>
-            <para>Launch it via the service manager (as shown in the screenshot above) or from the
-                command line:</para>
-            <programlisting>tools\yaysw\bin\startService.bat</programlisting>
         </sect2>
 
         <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
@@ -109,7 +83,7 @@
             <title>Unix/Linux</title>
 
             <para>The scripts for running eXist-db as a service for Unix and Linux based system
-                (among which MacOS)can be found in the <literal>tools/yajsw/bin/</literal>
+                (among which MacOS) can be found in the <literal>tools/serviced/</literal>
                 sub-directory.</para>
             <para>Run the following command to get eXist-db started during initialization of the
                 system:</para>
@@ -168,17 +142,6 @@
             </sect3>
 
         </sect2>
-
-        <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-
-        <sect2 xml:id="other">
-            <title>Other platforms</title>
-
-            <para>Support for additional platforms can be bootstrapped by looking at templates in
-                the <code>tools/yajsw/templates</code> sub-directory. Consult the <link
-                condition="_blank" xlink:href="http://yajsw.sourceforge.net/">YAJSW
-                documentation</link> for more information.</para>
-        </sect2>
     </sect1>
 
     <!-- ================================================================== -->
@@ -187,8 +150,8 @@
         <title>Alternatives for scripts in the bin Directory</title>
 
         <para>Included in the distribution are a number of useful <literal>.sh</literal> (Unix
-            Shell) and <literal>.bat</literal> (DOS batch) programs located in the
-            <literal>bin</literal> sub-directory. Their names speak for themselves.</para>
+            Shell) and <literal>.bat</literal> (Windows batch) programs located in the
+                <literal>bin</literal> sub-directory. Their names speak for themselves.</para>
         <para>However, if you find that programs do not launch, you can try to manually launch them
             on the command-line without the scripting wrapper. This often provides useful debugging
             information.</para>
@@ -197,7 +160,6 @@
             <varlistentry>
                 <term> <code>startup.sh</code> (Unix) / <code>startup.bat</code> (Windows)</term>
                 <listitem>
-                    <programlisting>java -jar start.jar jetty</programlisting>
                     <para>Starts the included Jetty web server at port 8080. eXist runs as a web
                         application, located at <link xlink:href="http://localhost:8080/exist/"
                         >http://localhost:8080/exist/</link>. </para>
@@ -206,7 +168,7 @@
             <varlistentry>
                 <term> <code>shutdown.sh</code> (Unix) / <code>shutdown.bat</code> (Windows)</term>
                 <listitem>
-                    <programlisting>java -jar start.jar shutdown -p youradminpassword</programlisting>
+                    <programlisting>shutdown.sh -p youradminpassword</programlisting>
                     <para>Closes the running instance of eXist. If eXist has been started with
                         <literal>startup.sh</literal>, calling <literal>shutdown.sh</literal> will
                         also stop the Jetty web server. Otherwise, only the database is stopped by
@@ -215,22 +177,11 @@
                         <literal>shutdown</literal> before killing the server process.</para>
                 </listitem>
             </varlistentry>
-            <varlistentry>
-                <term> <code>server.sh</code> (Unix) / <code>server.bat</code> (Windows)</term>
-                <listitem>
-                    <programlisting>java -jar start.jar standalone</programlisting>
-                    <para>Launches eXist as a stand-alone server process. In this setup, eXist is
-                        only accessible through the XMLRPC and the built-in HTTP interface.</para>
-                </listitem>
-            </varlistentry>
             <varlistentry>
                 <term> <code>client.sh</code> (Unix) / <code>client.bat</code> (Windows)</term>
                 <listitem>
-                    <programlisting>java -jar start.jar client</programlisting>
                     <para>Launches the <link xlink:href="java-admin-client">Java Admin
-                        Client</link>. This application is also launched if no application is
-                        selected on the command-line, like this:</para>
-                    <programlisting>java -jar start.jar</programlisting>
+                        Client</link>.</para>
                 </listitem>
             </varlistentry>
         </variablelist>

src/main/xar-resources/data/advanced-installation/advanced-installation.xml

@@ -1,11 +1,11 @@
-Wolfgangs-MacBook-Air:eXist wolf$ java -jar installer/eXist-db-setup-2.0RC2-rev17974.jar -console
+$ java -jar exist-installer/target/exist-installer-5.0.0-RC8-SNAPSHOT.jar
 Select target path [/Users/wolf/Source/trunk/eXist] 
 /Applications/eXist/
 press 1 to continue, 2 to quit, 3 to redisplay
 1
 Set Data Directory
 Please select a directory where eXist will keep its data files. On Vista and Windows 7, this should be outside the usual 'Program Files' directory:
-Data dir:  [webapp/WEB-INF/data] 
+Data dir:  [data] 
 
 press 1 to continue, 2 to quit, 3 to redisplay
 1
@@ -40,12 +40,12 @@ press 1 to continue, 2 to quit, 3 to redisplay
 [ Starting processing ]
 Starting process Setting admin password ... (1/1)
 --- Starting embedded database instance ---
-File lock last access timestamp: 30.12.2012 /Applications/eXist/webapp/WEB-INF/data/dbx_dir.lck
-Found a stale lockfile. Trying to remove it:  /Applications/eXist/webapp/WEB-INF/data/dbx_dir.lck
-File lock last access timestamp: 30.12.2012 /Applications/eXist/webapp/WEB-INF/data/journal.lck
-Found a stale lockfile. Trying to remove it:  /Applications/eXist/webapp/WEB-INF/data/journal.lck
+File lock last access timestamp: 30.12.2012 /Applications/eXist/data/dbx_dir.lck
+Found a stale lockfile. Trying to remove it:  /Applications/eXist/data/dbx_dir.lck
+File lock last access timestamp: 30.12.2012 /Applications/eXist/data/journal.lck
+Found a stale lockfile. Trying to remove it:  /Applications/eXist/data/journal.lck
 Dez 30, 2012 10:13:26 PM org.expath.pkg.repo.util.Logger info
-INFO: Create a new repository with storage: File system storage in /Applications/eXist/webapp/WEB-INF/expathrepo
+INFO: Create a new repository with storage: File system storage in /Applications/eXist/data/expathrepo
 Setting admin user password...
 --- Initialization complete. Shutdown embedded database instance ---
 [ Console installation done ]