diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c66d65c..8ac3ee5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,3 +20,11 @@ jobs: java-version: ${{ matrix.java }} cache: maven - run: mvn -B test + - name: Test Gradle packaged-JAR example + if: runner.os != 'Windows' + working-directory: examples/gradle-packaged-jar + run: ./gradlew --no-daemon test + - name: Test Gradle packaged-JAR example on Windows + if: runner.os == 'Windows' + working-directory: examples/gradle-packaged-jar + run: .\gradlew.bat --no-daemon test diff --git a/README.md b/README.md index 9fd96aa..d93ba19 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,8 @@ that is the `package` phase, which runs *after* surefire's `test` phase, so a te `target/*.jar` belongs under failsafe (`*IT`, `mvn verify` — and `maven-failsafe-plugin` has to be bound in your pom; it is not part of the default lifecycle, and surefire silently skips `*IT` classes). With Gradle, make the test task depend on whichever task builds the jar (`jar` or -`bootJar`). To stay inside the plain `test` run instead: a Spring Boot server can use the `spring:` +`bootJar`); see the [packaged-JAR Gradle example](examples/gradle-packaged-jar). To stay inside +the plain `test` run instead: a Spring Boot server can use the `spring:` mode below, and any server can be launched straight from the test classpath, no jar needed — `command = {"${java.home}/bin/java", "-cp", "${java.class.path}", "com.example.MyServerMain"}` (`${...}` expands system properties; this repo's own end-to-end test runs that way). diff --git a/examples/gradle-packaged-jar/.gitattributes b/examples/gradle-packaged-jar/.gitattributes new file mode 100644 index 0000000..d9aff10 --- /dev/null +++ b/examples/gradle-packaged-jar/.gitattributes @@ -0,0 +1,3 @@ +gradlew text eol=lf +gradlew.bat text eol=crlf +*.jar binary diff --git a/examples/gradle-packaged-jar/.gitignore b/examples/gradle-packaged-jar/.gitignore new file mode 100644 index 0000000..f85aef5 --- /dev/null +++ b/examples/gradle-packaged-jar/.gitignore @@ -0,0 +1,3 @@ +.gradle/ +build/ +!gradle/wrapper/gradle-wrapper.jar diff --git a/examples/gradle-packaged-jar/README.md b/examples/gradle-packaged-jar/README.md new file mode 100644 index 0000000..da905cf --- /dev/null +++ b/examples/gradle-packaged-jar/README.md @@ -0,0 +1,42 @@ +# Gradle packaged-JAR example + +A tiny Java stdio MCP server and one JUnit conformance test that launches its +executable JAR. Requires JDK 17+ with `java` on `PATH`; no Gradle or Maven installation +is needed. The checked-in wrapper downloads Gradle 9.7.1 and verifies its SHA-256 +checksum. Dependencies come from Maven Central, including the released testkit 0.7.0; +you do not need to build or install the parent project first. + +From this directory on Linux/macOS: + +```sh +./gradlew test +``` + +On Windows (PowerShell): + +```powershell +.\gradlew.bat test +``` + +Use `clean test` to repeat from an empty build directory. The test report is at +`build/reports/tests/test/index.html`. + +The important wiring in [build.gradle](build.gradle) is: + +```groovy +tasks.test { + dependsOn tasks.jar + useJUnitPlatform() +} +``` + +The `jar` task sets `Main-Class` and bundles Jackson into +`build/libs/gradle-packaged-jar.jar`. `PackagedJarConformanceTest` uses +`@McpServerTest(command = {"java", "-jar", "build/libs/gradle-packaged-jar.jar"})` +to start that artifact over stdio. Gradle runs tests from the project directory, +so the relative JAR path works on Linux and Windows. Without `dependsOn tasks.jar`, +`test` compiles the server but does not package it, and a clean run fails to launch it. + +For a Spring Boot project, depend on `tasks.bootJar` instead and point the annotation +at that task's executable JAR. This example uses the plain Java plugin to keep the +packaging dependency visible. diff --git a/examples/gradle-packaged-jar/build.gradle b/examples/gradle-packaged-jar/build.gradle new file mode 100644 index 0000000..db4b945 --- /dev/null +++ b/examples/gradle-packaged-jar/build.gradle @@ -0,0 +1,38 @@ +plugins { + id 'java' +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'com.fasterxml.jackson.core:jackson-databind:2.22.2' + testImplementation 'io.github.senor14:mcp-java-testkit:0.7.0' + testImplementation platform('org.junit:junit-bom:5.14.4') + testImplementation 'org.junit.jupiter:junit-jupiter' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' +} + +tasks.withType(JavaCompile).configureEach { + options.release = 17 + options.encoding = 'UTF-8' +} + +tasks.jar { + archiveFileName = 'gradle-packaged-jar.jar' + manifest { + attributes 'Main-Class': 'example.GreetingServer' + } + // Include Jackson so the server can run with just java -jar. + from { configurations.runtimeClasspath.collect { zipTree(it) } } + duplicatesStrategy = DuplicatesStrategy.EXCLUDE + exclude 'META-INF/*.SF', 'META-INF/*.RSA', 'META-INF/*.DSA', '**/module-info.class' + preserveFileTimestamps = false + reproducibleFileOrder = true +} + +tasks.test { + dependsOn tasks.jar + useJUnitPlatform() +} diff --git a/examples/gradle-packaged-jar/gradle/wrapper/gradle-wrapper.jar b/examples/gradle-packaged-jar/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..eddabd2 Binary files /dev/null and b/examples/gradle-packaged-jar/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/gradle-packaged-jar/gradle/wrapper/gradle-wrapper.properties b/examples/gradle-packaged-jar/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..760c459 --- /dev/null +++ b/examples/gradle-packaged-jar/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,10 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionSha256Sum=acd53f1edaf02f1a8ff99879f8a34b302661a057d9b063ae9e35b552f804d20a +distributionUrl=https\://services.gradle.org/distributions/gradle-9.7.1-bin.zip +networkTimeout=10000 +retries=0 +retryBackOffMs=500 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/gradle-packaged-jar/gradlew b/examples/gradle-packaged-jar/gradlew new file mode 100755 index 0000000..249efbb --- /dev/null +++ b/examples/gradle-packaged-jar/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# gradlew start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh gradlew +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/3d91ce3b8caaf77ad09f381f43615b715b53f72c/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/examples/gradle-packaged-jar/gradlew.bat b/examples/gradle-packaged-jar/gradlew.bat new file mode 100644 index 0000000..a51ec4f --- /dev/null +++ b/examples/gradle-packaged-jar/gradlew.bat @@ -0,0 +1,82 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem gradlew startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables, and ensure extensions are enabled +setlocal EnableExtensions + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:execute +@rem Setup the command line + + + +@rem Execute gradlew +@rem endlocal doesn't take effect until after the line is parsed and variables are expanded +@rem which allows us to clear the local environment before executing the java command +endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel + +:exitWithErrorLevel +@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts +"%COMSPEC%" /c exit %ERRORLEVEL% diff --git a/examples/gradle-packaged-jar/settings.gradle b/examples/gradle-packaged-jar/settings.gradle new file mode 100644 index 0000000..14b01be --- /dev/null +++ b/examples/gradle-packaged-jar/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'gradle-packaged-jar' diff --git a/examples/gradle-packaged-jar/src/main/java/example/GreetingServer.java b/examples/gradle-packaged-jar/src/main/java/example/GreetingServer.java new file mode 100644 index 0000000..f497972 --- /dev/null +++ b/examples/gradle-packaged-jar/src/main/java/example/GreetingServer.java @@ -0,0 +1,62 @@ +package example; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ObjectNode; + +import java.io.BufferedReader; +import java.io.BufferedWriter; +import java.io.InputStreamReader; +import java.io.OutputStreamWriter; +import java.nio.charset.StandardCharsets; + +/** Minimal stdio MCP server with one no-argument greeting tool. */ +public final class GreetingServer { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + public static void main(String[] args) throws Exception { + BufferedReader in = new BufferedReader(new InputStreamReader(System.in, StandardCharsets.UTF_8)); + BufferedWriter out = new BufferedWriter(new OutputStreamWriter(System.out, StandardCharsets.UTF_8)); + String line; + while ((line = in.readLine()) != null) { + if (line.isBlank()) { + continue; + } + JsonNode request = MAPPER.readTree(line); + // Notifications (including notifications/initialized) have no response. + if (!request.has("id")) { + continue; + } + ObjectNode response = MAPPER.createObjectNode(); + response.put("jsonrpc", "2.0"); + response.set("id", request.get("id")); + switch (request.path("method").asText()) { + case "initialize" -> response.set("result", MAPPER.readTree(""" + {"protocolVersion":"2025-11-25","capabilities":{"tools":{}}, + "serverInfo":{"name":"gradle-packaged-jar","version":"1.0.0"}} + """)); + case "ping" -> response.putObject("result"); + case "tools/list" -> response.set("result", MAPPER.readTree(""" + {"tools":[{"name":"greet","description":"Returns a friendly greeting.", + "inputSchema":{"type":"object","properties":{}}}]} + """)); + case "tools/call" -> { + if ("greet".equals(request.path("params").path("name").asText())) { + response.set("result", MAPPER.readTree(""" + {"content":[{"type":"text","text":"Hello from a packaged JAR!"}], + "isError":false} + """)); + } else { + response.putObject("error").put("code", -32602).put("message", "Unknown tool"); + } + } + default -> response.putObject("error").put("code", -32601).put("message", "Method not found"); + } + // Stdout carries only newline-delimited JSON-RPC messages. + out.write(MAPPER.writeValueAsString(response)); + out.write('\n'); + out.flush(); + } + } +} diff --git a/examples/gradle-packaged-jar/src/test/java/example/PackagedJarConformanceTest.java b/examples/gradle-packaged-jar/src/test/java/example/PackagedJarConformanceTest.java new file mode 100644 index 0000000..07a8acd --- /dev/null +++ b/examples/gradle-packaged-jar/src/test/java/example/PackagedJarConformanceTest.java @@ -0,0 +1,31 @@ +package example; + +import io.github.senor14.mcptestkit.McpAssertions; +import io.github.senor14.mcptestkit.McpServerTest; +import io.github.senor14.mcptestkit.McpTestClient; +import org.junit.jupiter.api.Test; + +import java.util.Map; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +@McpServerTest(command = {"java", "-jar", "build/libs/gradle-packaged-jar.jar"}, requestTimeoutSeconds = 10) +class PackagedJarConformanceTest { + + @Test + void packagedServerConforms(McpTestClient client) { + McpAssertions.assertThat(client) + .initializesSuccessfully() + .negotiatedProtocolVersionIsOneOf("2025-11-25") + .declaresToolsCapability() + .hasTools() + .toolsHaveDescriptions() + .toolSchemasAreValid() + .callToolSucceeds("greet", Map.of()) + .unknownMethodYieldsMethodNotFound() + .unknownToolHandledGracefully(); + + assertEquals("Hello from a packaged JAR!", + client.callTool("greet", Map.of()).path("content").get(0).path("text").asText()); + } +}