Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .copyrightconfig
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ startyear: 2018
# - Use sparingly (third_party, generated, binary assets)
# - Dotfiles already skipped automatically
# Enable by removing the leading '# ' from the next line and editing values.
filesexcluded: .github/*, docs/*, README.md, Jenkinsfile, gradle/*, docker-compose.yml, *.gradle, gradle.properties, gradlew, gradlew.bat, **/test/resources/**, *.md, *.txt
filesexcluded: .github/*, docs/*, *.md, Jenkinsfile, gradle/*, *.yml, *.gradle, gradle.properties, gradlew, gradlew.bat, **/test/resources/**, *.md, *.txt, *version, *.lock
Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

filesexcluded conflicts with the rules documented just above it ("Simple * wildcard only (no recursive **)") but still includes a recursive **/test/resources/** pattern. It also includes duplicate entries (e.g., *.md appears twice). Consider rewriting the exclusions to only use supported wildcards and removing duplicates so it's clear what the config is actually doing.

Suggested change
filesexcluded: .github/*, docs/*, *.md, Jenkinsfile, gradle/*, *.yml, *.gradle, gradle.properties, gradlew, gradlew.bat, **/test/resources/**, *.md, *.txt, *version, *.lock
filesexcluded: .github/*, docs/*, *.md, Jenkinsfile, gradle/*, *.yml, *.gradle, gradle.properties, gradlew, gradlew.bat, test/resources/*, *.txt, *version, *.lock

Copilot uses AI. Check for mistakes.
38 changes: 25 additions & 13 deletions .github/workflows/jekyll-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll with GitHub Pages dependencies preinstalled
# Started with: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml .
# Have to use a custom Jekyll workflow as the default GitHub Jekyll workflow does not whitelist the
# "jekyll-tabs" plugin that lets us show code tabs in the documentation.

name: Deploy Jekyll site to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]

Expand All @@ -21,23 +23,33 @@ concurrency:
cancel-in-progress: true

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Setup Ruby and install Gemfile bundles
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.3.4' # Matches GH Pages; keep explicit to match .ruby-version and make CI intent clear
Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workflow comment says the Ruby version is kept explicit to match a .ruby-version file, but there is no .ruby-version (neither repo root nor docs/). Either add the file (so local/dev + CI stay aligned) or update the comment to avoid implying a source of truth that doesn't exist.

Suggested change
ruby-version: '3.3.4' # Matches GH Pages; keep explicit to match .ruby-version and make CI intent clear
ruby-version: '3.3.4' # Matches GH Pages; keep explicit to make CI intent clear

Copilot uses AI. Check for mistakes.
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
working-directory: ./docs
cache-version: 0 # Increment this number if you need to re-download cached gems
- name: Setup Pages
uses: actions/configure-pages@v3
id: pages
uses: actions/configure-pages@v5
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./docs/
destination: ./_site
working-directory: ./docs
# Outputs to the './_site' directory by default
run: bundle exec jekyll build --verbose --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v3
with:
path: "./docs/_site"

# Deployment job
deploy:
environment:
name: github-pages
Expand All @@ -47,4 +59,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
uses: actions/deploy-pages@v4
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ You can build and test the docs locally by
though you don't need to perform all of those steps since some files generated by doing so are already in the
`./docs` directory. You just need to do the following:

1. Install the latest Ruby (rbenv works well for this).
1. Install the latest Ruby 3.x (rbenv works well for this).
2. Install Jekyll.
3. Go to the docs directory - `cd ./docs` .
4. Run `bundle install` (this may not be necessary due to Gemfile.lock being in version control).
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![GitHub release](https://img.shields.io/github/release/marklogic-community/marklogic-unit-test.svg)
![GitHub last commit](https://img.shields.io/github/last-commit/marklogic-community/marklogic-unit-test.svg)
![GitHub release](https://img.shields.io/github/release/marklogic/marklogic-unit-test.svg)
![GitHub last commit](https://img.shields.io/github/last-commit/marklogic/marklogic-unit-test.svg)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# Easy testing of custom MarkLogic modules
Expand All @@ -19,5 +19,5 @@ marklogic-unit-test includes the following components:
popular Java testing frameworks. As of the 2.0.0 release, these now require Java 17 or higher.
4. A REST endpoint for integrating with testing frameworks in any language.

Please see [the user guide](https://marklogic-community.github.io/marklogic-unit-test/) to get started with adding
Please see [the user guide](https://marklogic.github.io/marklogic-unit-test/) to get started with adding
marklogic-unit-test to your project.
21 changes: 14 additions & 7 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ GEM
ffi (>= 1.15.0)
eventmachine (1.2.7)
execjs (2.8.1)
faraday (2.7.10)
faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.2)
faraday (2.14.1)
faraday-net_http (>= 2.0, < 3.5)
json
logger
faraday-net_http (3.4.2)
net-http (~> 0.5)
ffi (1.15.5)
forwardable-extended (2.6.0)
gemoji (3.0.1)
Expand Down Expand Up @@ -196,6 +198,7 @@ GEM
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0, < 5.0)
json (2.18.1)
kramdown (2.3.2)
rexml
kramdown-parser-gfm (1.1.0)
Expand All @@ -204,15 +207,18 @@ GEM
listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
logger (1.7.0)
mercenary (0.3.6)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.19.0)
nokogiri (1.18.9-arm64-darwin)
net-http (0.9.1)
uri (>= 0.11.1)
nokogiri (1.19.1-arm64-darwin)
racc (~> 1.4)
nokogiri (1.18.9-x86_64-linux-gnu)
nokogiri (1.19.1-x86_64-linux-gnu)
racc (~> 1.4)
octokit (4.25.1)
faraday (>= 1, < 3)
Expand All @@ -226,7 +232,6 @@ GEM
ffi (~> 1.0)
rexml (3.4.2)
rouge (3.26.0)
ruby2_keywords (0.0.5)
rubyzip (2.3.2)
safe_yaml (1.0.5)
sass (3.7.4)
Expand All @@ -249,11 +254,13 @@ GEM
unf_ext
unf_ext (0.0.8.2)
unicode-display_width (1.8.0)
uri (1.1.1)
webrick (1.8.2)

PLATFORMS
arm64-darwin-21
arm64-darwin-23
arm64-darwin-25
x86_64-linux

DEPENDENCIES
Expand Down
4 changes: 2 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ logo: "/assets/ProgressMarkLogic_PrimaryLogo_Stacked.svg"

# Aux links for the upper right navigation
aux_links:
"marklogic-community/marklogic-unit-test":
- "https://github.com/marklogic-community/marklogic-unit-test"
"marklogic/marklogic-unit-test":
- "https://github.com/marklogic/marklogic-unit-test"

# Makes Aux links open in a new tab. Default is false
aux_links_new_tab: false
Expand Down
2 changes: 1 addition & 1 deletion docs/assertion-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav_order: 7
---

The list below captures the assertion functions available in the marklogic-unit-test `/test/test-helper.xqy` module.
You can also [browse the source code](https://github.com/marklogic-community/marklogic-unit-test/blob/master/marklogic-unit-test-modules/src/main/ml-modules/root/test/test-helper.xqy)
You can also [browse the source code](https://github.com/marklogic/marklogic-unit-test/blob/master/marklogic-unit-test-modules/src/main/ml-modules/root/test/test-helper.xqy)
for this module to examine these functions.

```
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ running a simple test.

## Example project description

The [example project](https://github.com/marklogic-community/marklogic-unit-test/tree/master/examples/getting-started)
The [example project](https://github.com/marklogic/marklogic-unit-test/tree/master/examples/getting-started)
for this guide is a simple MarkLogic application with a
[custom REST endpoint](https://docs.marklogic.com/guide/rest-dev/extensions) named "thesaurus". The endpoint
returns thesaurus entries via the `/example/lib.sjs` module located at `src/main/ml-modules/root` in the project.
Expand Down Expand Up @@ -66,7 +66,7 @@ The above configuration enables the ml-gradle `mlUnitTest` task to access the `m
allowing it to run your marklogic-unit-test tests.

If you are not using ml-gradle, you will need to manually add the marklogic-unit-test modules to your project. Please
see [the marklogic-unit-test releases](https://github.com/marklogic-community/marklogic-unit-test/releases) for
see [the marklogic-unit-test releases](https://github.com/marklogic/marklogic-unit-test/releases) for
zip files containing these modules.

## Writing a test
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ If you have any questions or run into issues while using marklogic-unit-test, tr

1. Check for a similar question [on Stack Overflow](https://stackoverflow.com/questions/tagged/marklogic).
2. If you don't find a similar question, [ask one yourself](https://stackoverflow.com/questions/ask?tags=marklogic).
3. Or [submit an issue](https://github.com/marklogic-community/marklogic-unit-test/issues/new); expect a response
3. Or [submit an issue](https://github.com/marklogic/marklogic-unit-test/issues/new); expect a response
within a day or two.
4 changes: 2 additions & 2 deletions docs/running-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ tests. Any failed test will display a message capturing the assertion failure.

## Using JUnit5

The [marklogic-junit5 library](https://github.com/marklogic-community/marklogic-unit-test/tree/master/marklogic-junit5)
The [marklogic-junit5 library](https://github.com/marklogic/marklogic-unit-test/tree/master/marklogic-junit5)
within this project provides support for testing REST endpoints in MarkLogic. It also supports running your
marklogic-unit-test tests as part of a JUnit test suite. This allows for a single test run to execute and report on
all of your tests - both your JUnit5 tests that invoke REST endpoints in MarkLogic and each of your marklogic-unit-test
test modules.

For further information, see
[the marklogic-junit5 example project](https://github.com/marklogic-community/marklogic-unit-test/tree/master/marklogic-junit5/examples/simple-ml-gradle)
[the marklogic-junit5 example project](https://github.com/marklogic/marklogic-unit-test/tree/master/marklogic-junit5/examples/simple-ml-gradle)
that describes the configuration necessary.

## Using the marklogic-unit-test REST extension
Expand Down
2 changes: 1 addition & 1 deletion docs/writing-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 3
This guide is a reference on the different kinds of test modules, setup modules, and teardown modules you can write
and run with marklogic-unit-test. The examples shown in this page can be found
in the `src/test/ml-modules/root/test/suites/thesaurus` directory in the
[test-examples project](https://github.com/marklogic-community/marklogic-unit-test/tree/master/examples/test-examples).
[test-examples project](https://github.com/marklogic/marklogic-unit-test/tree/master/examples/test-examples).

## Location of test files

Expand Down
4 changes: 2 additions & 2 deletions marklogic-junit5/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This library makes that as simple as possible by providing the following support
configuration you've already defined in your project
1. Clear your test database before a test run so it always runs in a known state
1. Easily read and make assertions on JSON and XML documents, including support for XPath-based assertions
1. Easily integrate [marklogic-unit-test](https://github.com/marklogic-community/marklogic-unit-test) tests into a JUnit test suite
1. Easily integrate [marklogic-unit-test](https://github.com/marklogic/marklogic-unit-test) tests into a JUnit test suite

Below is a simple example of a JUnit test that writes a couple documents, runs a search on them, and then reads them
back and verifies the contents of each document:
Expand Down Expand Up @@ -45,7 +45,7 @@ As of DHF 5.5, support exists within DHF 5 for writing tests and should be used
See [this example project](https://github.com/marklogic/marklogic-data-hub/tree/master/examples/reference-entity-model#testing-support)
for more information.

If you're using DHF 4, see [the DHF 4 example project](https://github.com/marklogic-community/marklogic-unit-test/tree/1.0.0/marklogic-junit5/examples/simple-dhf4)
If you're using DHF 4, see [the DHF 4 example project](https://github.com/marklogic/marklogic-unit-test/tree/1.0.0/marklogic-junit5/examples/simple-dhf4)
from the 1.0.0 tag of this repository.

## Running the tests within this project
Expand Down
8 changes: 4 additions & 4 deletions marklogic-junit5/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ publishing {
name = "${group}:${project.name}"
description = "Supports testing MarkLogic applications"
packaging = "jar"
url = "https://github.com/marklogic-community/${project.name}"
url = "https://github.com/marklogic/${project.name}"
licenses {
license {
name = "The Apache License, Version 2.0"
Expand All @@ -61,9 +61,9 @@ publishing {
}
}
scm {
url = "git@github.com:marklogic-community/${project.name}.git"
connection = "scm:git@github.com:marklogic-community/${project.name}.git"
developerConnection = "scm:git@github.com:marklogic-community/${project.name}.git"
url = "git@github.com:marklogic/${project.name}.git"
connection = "scm:git@github.com:marklogic/${project.name}.git"
developerConnection = "scm:git@github.com:marklogic/${project.name}.git"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions marklogic-junit5/examples/simple-ml-gradle/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
This project shows a basic setup for writing JUnit tests with marklogic-junit5 against an application deployed
with [ml-gradle](https://github.com/marklogic-community/ml-gradle). In addition, it includes an example of executing
tests written using [marklogic-unit-test](https://github.com/marklogic-community/marklogic-unit-test) via JUnit.
with [ml-gradle](https://github.com/marklogic/ml-gradle). In addition, it includes an example of executing
tests written using [marklogic-unit-test](https://github.com/marklogic/marklogic-unit-test) via JUnit.

## Trying the project out locally

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
* Copyright (c) 2018-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
*/
package com.marklogic.junit5.dhf;

Expand All @@ -10,7 +10,7 @@

/**
* This is a JUnit 5 parameterized test that invokes every test module defined by the REST endpoint provided by the
* marklogic-unit-test framework - https://github.com/marklogic-community/marklogic-unit-test . This class is abstract
* marklogic-unit-test framework - https://github.com/marklogic/marklogic-unit-test . This class is abstract
* so that it is not run when executing tests for the marklogic-junit5 project - it is instead expected to be extended
* in a project that depends on marklogic-junit5.
* <p>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
* Copyright (c) 2018-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
*/
package com.marklogic.junit5.spring;

Expand All @@ -10,7 +10,7 @@

/**
* This is a JUnit 5 parameterized test that invokes every test module defined by the REST endpoint provided by the
* marklogic-unit-test framework - https://github.com/marklogic-community/marklogic-unit-test . This class is abstract
* marklogic-unit-test framework - https://github.com/marklogic/marklogic-unit-test . This class is abstract
* so that it is not run when executing tests for the marklogic-junit5 project - it is instead expected to be extended
* in a project that depends on marklogic-junit5.
* <p>
Expand Down
8 changes: 4 additions & 4 deletions marklogic-unit-test-client/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ publishing {
name = "${group}:${project.name}"
description = "Supports testing MarkLogic applications"
packaging = "jar"
url = "https://github.com/marklogic-community/${project.name}"
url = "https://github.com/marklogic/${project.name}"
licenses {
license {
name = "The Apache License, Version 2.0"
Expand All @@ -42,9 +42,9 @@ publishing {
}
}
scm {
url = "git@github.com:marklogic-community/${project.name}.git"
connection = "scm:git@github.com:marklogic-community/${project.name}.git"
developerConnection = "scm:git@github.com:marklogic-community/${project.name}.git"
url = "git@github.com:marklogic/${project.name}.git"
connection = "scm:git@github.com:marklogic/${project.name}.git"
developerConnection = "scm:git@github.com:marklogic/${project.name}.git"
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions marklogic-unit-test-modules/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ publishing {
name = "${group}:${project.name}"
description = "Supports testing MarkLogic applications"
packaging = "jar"
url = "https://github.com/marklogic-community/${project.name}"
url = "https://github.com/marklogic/${project.name}"
licenses {
license {
name = "The Apache License, Version 2.0"
Expand All @@ -52,9 +52,9 @@ publishing {
}
}
scm {
url = "git@github.com:marklogic-community/${project.name}.git"
connection = "scm:git@github.com:marklogic-community/${project.name}.git"
developerConnection = "scm:git@github.com:marklogic-community/${project.name}.git"
url = "git@github.com:marklogic/${project.name}.git"
connection = "scm:git@github.com:marklogic/${project.name}.git"
developerConnection = "scm:git@github.com:marklogic/${project.name}.git"
}
}
artifact sourcesJar
Expand Down
Loading