[feature] Make Monex compatible with eXist-db and Elemental versions 6.x.x and 7.x.x

See evolvedbinary/elemental#6

Author: adamretter

.github/workflows/ci.yml

@@ -2,29 +2,60 @@ name: CI
 on: [push, pull_request]
 jobs:
   build:
-    name: Build and Test (${{ matrix.os }} / OpenJDK ${{ matrix.jdk }})
-    strategy:
-      fail-fast: true
-      matrix:
-        jdk: ['8', '11']
-        os: [ubuntu-latest]
-    runs-on: ${{ matrix.os }}
+    name: Build
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Set up JDK ${{ matrix.jdk }}
+      - name: Set up JDK
         uses: actions/setup-java@v4
         with:
           distribution: temurin
-          java-version: ${{ matrix.jdk }}
-      - name: Cache Maven packages
-        uses: actions/cache@v4
-        with:
-          path: ~/.m2
-          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
-          restore-keys: ${{ runner.os }}-m2
+          java-version: 21
+          cache: maven
       - name: Maven Build
         run: mvn clean package -DskipTests
-      - name: Test
-        env:
-          CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
-        run: mvn verify -P cypress-without-record
+      - uses: actions/upload-artifact@v4
+        with:
+          name: target
+          path: target/
+          retention-days: 1
+
+  test6:
+    name: Integration Test (DB API 6.x.x)
+    needs: build
+    runs-on: ubuntu-latest
+    env:
+      CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 21
+          cache: maven
+      - uses: actions/download-artifact@v4
+        with:
+          name: target
+      - name: Maven Test
+        run: mvn verify -Dgpg.skip -P docker-integration-test-db-api-6,cypress-with-recording-db-api-6
+
+  test7:
+    name: Integration Test (DB API 7.x.x)
+    needs: build
+    runs-on: ubuntu-latest
+    env:
+      CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 21
+          cache: maven
+      - uses: actions/download-artifact@v4
+        with:
+          name: target
+      - name: Maven Test
+        run: mvn verify -Dgpg.skip -P docker-integration-test-db-api-7,cypress-with-recording-db-api-7

.gitignore

@@ -1,16 +1,5 @@
 ##############################
-## Java
-##############################
-.mtj.tmp/
-*.class
-*.jar
-*.war
-*.ear
-*.nar
-hs_err_pid*
-
-##############################
-## Maven
+## Java / Maven
 ##############################
 target/
 pom.xml.tag
@@ -19,76 +8,25 @@ pom.xml.versionsBackup
 pom.xml.next
 pom.xml.bak
 release.properties
-dependency-reduced-pom.xml
-buildNumber.properties
-.mvn/timing.properties
-!.mvn/wrapper/maven-wrapper.jar
-node/
 
 ##############################
-## Gradle
+## Node.js
 ##############################
-bin/
-build/
-.gradle
-.gradletasknamecache
-gradle-app.setting
-!gradle-wrapper.jar
+node/
+node_modules/
 
 ##############################
-## IntelliJ
+## IntelliJ IDEA
 ##############################
-out/
 .idea/
-.idea_modules/
-*.iml
-*.ipr
-*.iws
-
-##############################
-## Eclipse
-##############################
-.settings/
-bin/
-tmp/
-.metadata
-.classpath
-.project
-*.tmp
-*.bak
-*.swp
-*~.nib
-local.properties
-.loadpath
-.factorypath
-
-##############################
-## NetBeans
-##############################
-nbproject/private/
-build/
-nbbuild/
-dist/
-nbdist/
-nbactions.xml
-nb-configuration.xml
 
 ##############################
 ## Visual Studio Code
 ##############################
 .vscode/
 .code-workspace
 
-
 ##############################
-## OS X
+## macOS
 ##############################
 .DS_Store
-
-##############################
-## Node / JS
-##############################
-node_modules/
-
-src/test/cypress/videos/*
-src/test/cypress/screenshots/*

README.md

@@ -1,10 +1,12 @@
-# Monex (Monitoring for eXist)
+# Monex (Monitoring for eXist-db and Elemental)
 
 [![Build Status](https://github.com/eXist-db/monex/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/eXist-db/exist/monex/workflows/ci.yml)
+[![Java 21](https://img.shields.io/badge/java-21-blue.svg)](https://adoptopenjdk.net/)
+[![License](https://img.shields.io/badge/license-LGPL%202.1-blue.svg)](https://www.gnu.org/licenses/lgpl-2.1.html)
 
 ![Image](src/main/xar-resources/resources/img/screenshot.png?raw=true)
 
-An application for monitoring, profiling and inspecting a running eXist-db instance.
+An application for monitoring, profiling and inspecting a running eXist-db or Elemental instance.
 
 ## Features
 
@@ -13,50 +15,33 @@ The app includes:
 - **Monitoring dashboard**: shows memory usage, running queries, locked threads, cache usage and more
 - **Query profiling** page: essential for tuning queries and indexes
 - **Index browser**: inspect existing indexes
-- **Remote console**: send log messages from any query in eXist to the remote console.
+- **Remote console**: send log messages from any query to the remote console.
 Uses web sockets for real-time updates.
 - **Data visualizer**: get a quick overview of the frequency of elements in a collection.
-- **Remote Monitoring**: monitor multiple remote eXistdb instances. Provides timelines for long term monitoring.
+- **Remote Monitoring**: monitor multiple remote instances. Provides timelines for long term monitoring.
 
 ## Configure Monex
 
 ### Enable Remote Monitoring
 
 #### Preconditions
 
-Monex remote monitoring requires the eXistdb scheduler module to be enabled. Make sure it is enabled in `$eXistdb_home/extensions/build.properties`
-
-```txt
-# Scheduler module
-include.module.scheduler = true
-```
-
-and in `$eXistdb_home/conf.xml` make sure the Scheduler module is not commented out:
+Monex remote monitoring requires the Scheduler Module to be enabled. Make sure the Scheduler module is not commented out in `etc/conf.xml`:
 
 ```xml
 <module uri="http://exist-db.org/xquery/scheduler"
 	class="org.exist.xquery.modules.scheduler.SchedulerModule" />
 ```
 
-##### Rebuilding eXistdb
-
-This needs only to be done if `include.module.scheduler` in `extensions/build.properties` was set to `false`. Then eXistdb has to be rebuild to enable the scheduler module. Shutdown the database and in the root of the eXistdb project simply call
-
-```shell
-./build.sh
-```
-
-After starting the database again, the remote monitoring tab should show no more error warnings.
+#### Adding an instance to monitor
 
-#### Adding an eXistdb instance to monitor
-
-For each eXistdb instance to monitor its url and its unique token is needed. The token can be found in the data directory on the filesystem . The file is called `jmxservlet.token`. The path to the data directory can be found in `$existdb_home/conf.xml`
+For each instance to monitor its URL and its unique token is needed. The token can be found in the data directory on the filesystem . The file is called `jmxservlet.token`. The path to the data directory can be found in `etc/conf.xml`
 
 ```xml
 <db-connection files="path-to-your-data-dir" ... />
 ```
 
-Each eXistdb installation to monitor is added as an instance entry at `/db/apps/monex/instances.xml`.
+Each installation to monitor is added as an instance entry at `/db/apps/monex/instances.xml`.
 
 #### Sample Monex Instances
 
@@ -81,31 +66,45 @@ In the Monex Remote Monitoring tab click "Run" to start all remote monitoring jo
 
 If you wish to build Monex from source code you should follow these steps:
 
-1. Ensure you have Git, Apache Maven 3.3+, and Java JDK 8 installed and available:
+1. Ensure you have Git, GnuPG, Apache Maven 3.3+, and Java JDK 21 installed and available. If you wish to run the test suite, you will also need to have Docker installed.
 
 ```bash
 $ git --version
-git version 2.20.0
+git version 2.49.0
 
 $ mvn --version
 
-Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-18T02:33:14+08:00)
-Maven home: /usr/local/maven
-Java version: 1.8.0_192, vendor: Azul Systems, Inc., runtime: /Library/Java/JavaVirtualMachines/zulu8.33.0.1-jdk8.0.192-macosx_x64/jre
+Apache Maven 3.9.10 (5f519b97e944483d878815739f519b2eade0a91d)
+Maven home: /usr/local/Cellar/maven/3.9.10/libexec
+Java version: 21.0.7, vendor: Eclipse Adoptium, runtime: /Library/Java/JavaVirtualMachines/temurin-21.jdk/Contents/Home
 Default locale: en_GB, platform encoding: UTF-8
-OS name: "mac os x", version: "10.14.1", arch: "x86_64", family: "mac"
+OS name: "mac os x", version: "15.4.1", arch: "x86_64", family: "mac"
 ```
 
-1. Clone and build an EXPath package by running:
+2. Clone and build an EXPath package of Monex by running:
 
 ```bash
-git clone https://github.com/eXist-db/monex.git
+git clone https://github.com/exist-db/monex.git
 cd monex
 mvn package
 ```
 
 The resulting XAR will be in the `target/` folder.
 
+
+3. Running the Test Suite:
+
+  1. Against eXist-db 6.x.x:
+
+  ```bash
+  mvn verify -P docker-integration-test-db-api-6,cypress-with-recording-db-api-6
+  ```
+
+  2. Against Elemental 7.x.x:
+  ```bash
+  mvn verify -P docker-integration-test-db-api-7,cypress-with-recording-db-api-7
+  ```
+
 ## Release Procedure
 
 This project is configured to use the [Maven Release Plugin](https://maven.apache.org/maven-release/maven-release-plugin/) to make creating and subsequently publishing a release easy.
@@ -126,17 +125,24 @@ Only users with push access to the GitHub repo can act as release manager.
 Before creating the release, check if:
 
 - [ ] the changelog is up-to-date for the planned release?
-- [ ] the target versions for eXistdb are correctly declared in `pom.xml`?
+- [ ] the target versions for the Database API and Implementation are correctly declared in `monex-parent/pom.xml`?
 
    ```xml
-   <exist.java-api.version>5.4.0</exist.java-api.version>
-   <exist.processor.version>7.0.0-SNAPSHOT</exist.processor.version> 
+        <!-- Version of eXist-db and Elemental 6.x.x that Monex is compatible with -->
+        <db.api.6.version>6.0.0</db.api.6.version>
+        <db.api.6.impl.version>6.1.0</db.api.6.impl.version>
+        <db.api.6.java.version>1.8</db.api.6.java.version>
+
+        <!-- Version of eXist-db and Elemental 7.x.x that Monex is compatible with -->
+        <db.api.7.version>7.0.0</db.api.7.version>
+        <db.api.7.impl.version>7.0.0</db.api.7.impl.version>
+        <db.api.7.java.version>21</db.api.7.java.version>
    ```
 
 
 #### Changelog
 
-To edit release notes for the planned release within `xar-assembly.xml` located in the root of this repo, e.g.:
+To edit the release notes for the planned release within `xar-assembly.xml` located in the root of this repo, e.g.:
 
 ```xml
 <changelog>
@@ -160,9 +166,9 @@ mvn release:prepare && mvn release:perform
 You will be prompted for the answers to a few questions along the way. The default response will be provided for you, and you can simply press "Enter" (or "Return") to accept it. Alternatively you may enter your own value and press "Enter" (or "Return").
 
 ```bash
-What is the release version for "monex"? (org.exist-db.apps:monex) 2.3.1: : 2.4.0
-What is SCM release tag or label for "monex"? (org.exist-db.apps:monex) 2.4.0: :
-What is the new development version for "monex"? (org.exist-db.apps:monex) 2.4.1-SNAPSHOT: :
+What is the release version for "monex"? (org.exist-db.apps:monex) 4.3.0:
+What is SCM release tag or label for "monex"? (org.exist-db.apps:monex) 4.3.0:
+What is the new development version for "monex"? (org.exist-db.apps:monex) 4.3.1-SNAPSHOT:
 ```
 
 - For the `release version`, please sensibly consider using the next appropriate [SemVer 2.0.0](https://semver.org/) version number.

cypress.json

@@ -1,12 +1,13 @@
 {
-  "baseUrl": "http://localhost:8080/exist",
+  "baseUrl": "http://localhost:10086/exist",
   "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",
+  "downloadsFolder": "target/cypress/downloads",
+  "videosFolder": "target/cypress/videos",
+  "screenshotsFolder": "target/cypress/screenshots",
   "projectId": "snavwf"
 }