Merge pull request #67 from duncdrum/maintenance_24

Maintenance 24

.github/dependabot.yml

@@ -6,3 +6,13 @@ updates:
     interval: daily
     time: "03:00"
   open-pull-requests-limit: 10
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "03:00"
+  open-pull-requests-limit: 10
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: "weekly"

.github/workflows/ci.yml

@@ -0,0 +1,64 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    name: Exist ${{ matrix.exist-version }} (Java ${{ matrix.java-version }}) build and test
+    strategy:
+      fail-fast: true
+      matrix:
+        exist-version: [latest, 6.2.0]
+        java-version: ['8', '17']
+        os: [ubuntu-latest]
+        exclude:
+           - exist-version: 6.2.0
+             java-version: 17
+           - exist-version: latest
+             java-version: 8
+
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK ${{ matrix.java-version }}
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          cache: maven
+          java-version: ${{ matrix.java-version }}
+      - name: Install Test Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y bats
+      - name: Maven Build
+        run: mvn clean package
+
+      - name: Add expath dependencies
+        working-directory: target
+        run: |
+          wget http://exist-db.org/exist/apps/public-repo/public/templating-1.1.0.xar -O 001.xar
+
+
+      # Install
+      - name: Start exist-ci containers
+        run: |
+          docker run -dit -p 8080:8080 -v ${{ github.workspace }}/target:/exist/autodeploy \
+          --name exist --rm --health-interval=1s --health-start-period=1s \
+          duncdrum/existdb:${{ matrix.exist-version }}
+      
+      - name: wait for install to finish
+        timeout-minutes: 5
+        run: |
+          while ! docker logs exist | grep -q "Server has started"; \
+          do sleep 4s; \
+          done
+
+      # Test
+      - name: Run smoke test
+        run: bats --tap src/test/bats/*.bats
+
+      - name: Run e2e test
+        run: npx cypress run
+
+      # - name: Test
+      #   env:
+      #     CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+      #   run: mvn verify

README.md

@@ -1,33 +1,41 @@
 # eXist-db Function Documentation Browser App
-[![Build Status](https://travis-ci.com/eXist-db/function-documentation.svg?branch=master)](https://travis-ci.com/eXist-db/function-documentation)
-[![eXist-db version](https://img.shields.io/badge/eXist_db-4.0.0-blue.svg)](http://www.exist-db.org/exist/apps/homepage/index.html)
+
+[![CI](https://github.com/eXist-db/function-documentation/actions/workflows/ci.yml/badge.svg)](https://github.com/eXist-db/function-documentation/actions/workflows/ci.yml)
+[![eXist-db version](https://img.shields.io/badge/eXist_db-6.2.0-blue.svg)](http://www.exist-db.org/exist/apps/homepage/index.html)
 
 <img src="src/main/xar-resources/icon.png" align="left" width="15%"/>
 
-This repository contains the function documentation borwser app for the [eXist-db native XML database](http://www.exist-db.org).
+This repository contains the function documentation browser app for the [eXist-db native XML database](http://www.exist-db.org).
 
 ## Dependencies
--   [Maven](https://maven.apache.org): 3.5.2
--   [eXist-db](http://exist-db.org): 4.0.0
+
+- [Maven](https://maven.apache.org): `3.5.2`
+- [eXist-db](http://exist-db.org): `6.2.0`
 
 ## Installation
--   Just go to your eXist server's Dashboard and select Function Documentation.
--   Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at [http://exist-db.org/exist/apps/public-repo/](http://exist-db.org/exist/apps/public-repo/).
+
+- Just go to your eXist server's Dashboard and select Function Documentation.
+- Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at [http://exist-db.org/exist/apps/public-repo/](http://exist-db.org/exist/apps/public-repo/).
 
 ## Building from source
-1.  Clone the repository to your system:
-    ```bash
-    $ git clone https://github.com/exist-db/function-documentation.git
-    ```
 
-2.  Build the function documentation application:
-    ```bash
-    $ cd function-documentation
-    $ mvn clean package
-    ```
-    The compiled `.xar` file is located in the `/target` directory
+1. Clone the repository to your system:
+
+   ```bash
+   git clone https://github.com/exist-db/function-documentation.git
+   ```
 
-3.  Install this file via the Dashboard > Package Manager.
+2. Build the function documentation application:
+
+   ```bash
+   cd function-documentation
+   mvn clean package
+   ```
+
+   The compiled `.xar` file is located in the `/target` directory
+
+3. Install this file via the Dashboard > Package Manager.
 
 ## License
+
 LGPLv2.1 [eXist-db.org](http://exist-db.org/exist/apps/homepage/index.html)

cypress.config.js

@@ -0,0 +1,19 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  fileServerFolder: 'src/main/xar-resources',
+  fixturesFolder: 'src/test/cypress/fixtures',
+  screenshotsFolder: 'src/test/cypress/screenshots',
+  videosFolder: 'src/test/cypress/videos',
+  e2e: {
+    // We've imported your old cypress plugins here.
+    // You may want to clean this up later by importing these.
+    setupNodeEvents(on, config) {
+      return require('./src/test/cypress/plugins/index.js')(on, config)
+    },
+    baseUrl: 'http://localhost:8080/exist/apps/fundocs/',
+    excludeSpecPattern: 'src/test/cypress/integration/examples/*.js',
+    specPattern: 'src/test/cypress/integration/**/*.{js,jsx,ts,tsx}',
+    supportFile: 'src/test/cypress/support/index.js',
+  },
+})

gulpfile.js

@@ -28,20 +28,19 @@ const paths = {
   },
   vendor: {
     scripts: [
-      "src/main/xar-resources/resources/vendor/scripts/*",
-      "node_modules/bootstrap/dist/js/bootstrap.min.*",
-      "node_modules/jquery/dist/jquery.min.*",
-      "node_modules/prismjs/prism.js",
-      "node_modules/prismjs/components/prism-xquery.min.js",
-      "node_modules/prismjs/components/prism-java.min.js",
-      "node_modules/marked/lib/marked.js"
+      "src/main/xar-resources/resources/scripts/*",
+      "node_modules/bootstrap/dist/js/bootstrap.min.*", 
+      "node_modules/@popperjs/core/dist/umd/popper.min.*",
+      "node_modules/@highlightjs/cdn-assets/highlight.min.js", 
+      "node_modules/@highlightjs/cdn-assets/languages/xquery.min.js",
+      "node_modules/zero-md/dist/index.min.js"
     ],
     styles: [
-      "src/main/xar-resources/resources/vendor/styles/*",
+      "src/main/xar-resources/resources/css/*",
       "node_modules/bootstrap/dist/css/bootstrap.min.*",
-      // 'node_modules/prismjs/themes/*.css'
+      "node_modules/@highlightjs/cdn-assets/styles/atom-one-dark.min.css"
     ],
-    fonts: ["node_modules/bootstrap/dist/fonts/*"],
+    fonts: ["node_modules/@neos21/bootstrap3-glyphicons/dist/fonts/*"],
   },
 };