diff --git a/.github/workflows/example-shadow-api-detector-request-mapping-composed-build.yml b/.github/workflows/example-shadow-api-detector-request-mapping-composed-build.yml new file mode 100644 index 0000000..36c3b25 --- /dev/null +++ b/.github/workflows/example-shadow-api-detector-request-mapping-composed-build.yml @@ -0,0 +1,37 @@ +name: Example - Shadow API Detector Request Mapping Composed Build +on: + push: + paths: + - 'examples/shadow-api-detector/request-mapping-composed/**/*.java' + - 'examples/shadow-api-detector/request-mapping-composed/**/*.yaml' + - 'examples/shadow-api-detector/request-mapping-composed/**/*.gradle' + - 'examples/shadow-api-detector/request-mapping-composed/**/*.properties' + - 'examples/shadow-api-detector/request-mapping-composed/**/libs.versions.toml' + - '.github/workflows/example-shadow-api-detector-request-mapping-composed-build.yml' + +jobs: + Build-Example: + name: Build Example + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + fetch-depth: 1 + persist-credentials: false + + - name: Setup Java + uses: actions/setup-java@ad2b38190b15e4d6bdf0c97fb4fca8412226d287 # v5.3.0 + with: + distribution: 'temurin' + java-version: 21 + + - name: Setup Gradle + uses: gradle/actions/setup-gradle@3f131e8634966bd73d06cc69884922b02e6faf92 # v6.2.0 + + - name: Build example + run: | + cd examples/shadow-api-detector/request-mapping-composed + chmod +x ./gradlew + ./gradlew detectShadowApis --no-daemon diff --git a/examples/README.adoc b/examples/README.adoc index 8035c95..b337c3e 100644 --- a/examples/README.adoc +++ b/examples/README.adoc @@ -45,3 +45,5 @@ include::shadow-api-detector/with-shadow-apis/README.adoc[leveloffset=+1] include::shadow-api-detector/multi-file-openapi/README.adoc[leveloffset=+1] include::shadow-api-detector/openapi-3-2/README.adoc[leveloffset=+1] + +include::shadow-api-detector/request-mapping-composed/README.adoc[leveloffset=+1] diff --git a/examples/shadow-api-detector/request-mapping-composed/README.adoc b/examples/shadow-api-detector/request-mapping-composed/README.adoc new file mode 100644 index 0000000..050a8cc --- /dev/null +++ b/examples/shadow-api-detector/request-mapping-composed/README.adoc @@ -0,0 +1,68 @@ += Shadow API Detector — Composed RequestMapping Example +:toc: left + +== Description + +This example applies the Shadow API Detector plugin to a small `LibraryController` that uses `@RequestMapping` at both levels. +The controller has a class-level `@RequestMapping("/library")` and method-level `@RequestMapping(path = ..., method = ...)` declarations. +The accompanying OpenAPI document describes every composed endpoint. +`rootDocument` is the only property configured because every other property already defaults correctly for this example's layout. + +== Intent + +This example demonstrates that endpoint composition from class-level and handler-level `@RequestMapping` is detected correctly. +It also demonstrates that no false positives are reported when those composed endpoints are fully documented. + +== The Controller + +[source,java] +---- +@RestController +@RequestMapping("/library") +public class LibraryController { + + @RequestMapping(path = "/books", method = RequestMethod.GET) + public String listBooks() { ... } + + @RequestMapping(path = "/books/{id}", method = RequestMethod.GET) + public String getBook(@PathVariable Long id) { ... } + + @RequestMapping(path = "/books", method = RequestMethod.POST) + public String addBook(@RequestBody String book) { ... } +} +---- + +Full source: `src/main/java/com/arc_e_tect/example/library/LibraryController.java`. +The matching OpenAPI document is `src/main/resources/openapi/openapi.yaml`. +The described paths are `/library/books` and `/library/books/{id}`. + +== Build And Run + +[source,bash] +---- +cd examples/shadow-api-detector/request-mapping-composed +./gradlew detectShadowApis +---- + +== What To Expect + +The build is expected to pass. +The plugin writes `build/reports/shadow-api-detector/shadow-apis.adoc`. +The report opens with a preamble explaining what a shadow API is (omitted below for brevity). +See link:../../../shadow-api-detector/README.adoc[the plugin README]'s "Report output" section for the full preamble text. +The summary then confirms that all composed endpoints are documented: + +[source,asciidoc] +---- += Shadow API Report +:toc: +:toclevels: 2 + +Generated: ... + +Scanned 3 endpoint(s) exposed by `@RestController` classes. 0 of them are not described in the OpenAPI documentation. + +== Shadow APIs + +None found. Every endpoint exposed by the scanned controllers is described in the OpenAPI documentation. +---- diff --git a/examples/shadow-api-detector/request-mapping-composed/build.gradle b/examples/shadow-api-detector/request-mapping-composed/build.gradle new file mode 100644 index 0000000..8c99dc8 --- /dev/null +++ b/examples/shadow-api-detector/request-mapping-composed/build.gradle @@ -0,0 +1,24 @@ +plugins { + id 'java' + alias(libs.plugins.shadow.api.detector) +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(21) + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation libs.spring.web +} + +shadowApiDetector { + // The only property that must be set: the root OpenAPI document. Every other + // property already defaults correctly for this example's layout. + rootDocument = file('src/main/resources/openapi/openapi.yaml') +} diff --git a/examples/shadow-api-detector/request-mapping-composed/gradle.properties b/examples/shadow-api-detector/request-mapping-composed/gradle.properties new file mode 100644 index 0000000..4183829 --- /dev/null +++ b/examples/shadow-api-detector/request-mapping-composed/gradle.properties @@ -0,0 +1,8 @@ +org.gradle.daemon=true +org.gradle.parallel=true +org.gradle.caching=true +org.gradle.configuration-cache=true +org.gradle.jvmargs=-Xmx8192m -Dfile.encoding=UTF-8 + +group=com.arc-e-tect +version = 0.0.1 diff --git a/examples/shadow-api-detector/request-mapping-composed/gradle/libs.versions.toml b/examples/shadow-api-detector/request-mapping-composed/gradle/libs.versions.toml new file mode 100644 index 0000000..729683d --- /dev/null +++ b/examples/shadow-api-detector/request-mapping-composed/gradle/libs.versions.toml @@ -0,0 +1,15 @@ +## Generated by $ ./gradlew refreshVersionsCatalog + +[plugins] + +shadow-api-detector = { id = "com.arc-e-tect.shadow-api-detector", version.ref = "shadow-api-detector" } + +[versions] + +shadow-api-detector = "0.4.0" +spring-web = "7.0.8" + +[libraries] + +spring-web = { module = "org.springframework:spring-web", version.ref = "spring-web" } + diff --git a/examples/shadow-api-detector/request-mapping-composed/gradle/wrapper/gradle-wrapper.jar b/examples/shadow-api-detector/request-mapping-composed/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..b1b8ef5 Binary files /dev/null and b/examples/shadow-api-detector/request-mapping-composed/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/shadow-api-detector/request-mapping-composed/gradle/wrapper/gradle-wrapper.properties b/examples/shadow-api-detector/request-mapping-composed/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..a9db115 --- /dev/null +++ b/examples/shadow-api-detector/request-mapping-composed/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,9 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.6.1-bin.zip +networkTimeout=10000 +retries=0 +retryBackOffMs=500 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/shadow-api-detector/request-mapping-composed/gradlew b/examples/shadow-api-detector/request-mapping-composed/gradlew new file mode 100755 index 0000000..249efbb --- /dev/null +++ b/examples/shadow-api-detector/request-mapping-composed/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/shadow-api-detector/request-mapping-composed/gradlew.bat b/examples/shadow-api-detector/request-mapping-composed/gradlew.bat new file mode 100644 index 0000000..a51ec4f --- /dev/null +++ b/examples/shadow-api-detector/request-mapping-composed/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/shadow-api-detector/request-mapping-composed/settings.gradle b/examples/shadow-api-detector/request-mapping-composed/settings.gradle new file mode 100644 index 0000000..7734b9c --- /dev/null +++ b/examples/shadow-api-detector/request-mapping-composed/settings.gradle @@ -0,0 +1,18 @@ +pluginManagement { + repositories { + gradlePluginPortal() + } +} + +plugins { + id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0' + id "de.fayard.refreshVersions" version "0.60.6" +} + +refreshVersions { + rejectVersionIf { + candidate.stabilityLevel.isLessStableThan(current.stabilityLevel) + } +} + +rootProject.name = 'shadow-api-detector-request-mapping-composed-example' diff --git a/examples/shadow-api-detector/request-mapping-composed/src/main/java/com/arc_e_tect/example/library/LibraryController.java b/examples/shadow-api-detector/request-mapping-composed/src/main/java/com/arc_e_tect/example/library/LibraryController.java new file mode 100644 index 0000000..0b0d933 --- /dev/null +++ b/examples/shadow-api-detector/request-mapping-composed/src/main/java/com/arc_e_tect/example/library/LibraryController.java @@ -0,0 +1,27 @@ +package com.arc_e_tect.example.library; + +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@RequestMapping("/library") +public class LibraryController { + + @RequestMapping(path = "/books", method = RequestMethod.GET) + public String listBooks() { + return "[]"; + } + + @RequestMapping(path = "/books/{id}", method = RequestMethod.GET) + public String getBook(@PathVariable Long id) { + return "{}"; + } + + @RequestMapping(path = "/books", method = RequestMethod.POST) + public String addBook(@RequestBody String book) { + return book; + } +} diff --git a/examples/shadow-api-detector/request-mapping-composed/src/main/resources/openapi/openapi.yaml b/examples/shadow-api-detector/request-mapping-composed/src/main/resources/openapi/openapi.yaml new file mode 100644 index 0000000..85c97f0 --- /dev/null +++ b/examples/shadow-api-detector/request-mapping-composed/src/main/resources/openapi/openapi.yaml @@ -0,0 +1,28 @@ +openapi: 3.0.3 +info: + title: Library API + version: "1.0" +paths: + /library/books: + get: + operationId: listBooks + responses: + '200': + description: OK + post: + operationId: addBook + responses: + '201': + description: Created + /library/books/{id}: + get: + operationId: getBook + parameters: + - name: id + in: path + required: true + schema: + type: integer + responses: + '200': + description: OK diff --git a/examples/shadow-api-detector/request-mapping-composed/versions.properties b/examples/shadow-api-detector/request-mapping-composed/versions.properties new file mode 100644 index 0000000..a07c552 --- /dev/null +++ b/examples/shadow-api-detector/request-mapping-composed/versions.properties @@ -0,0 +1,10 @@ +#### Dependencies and Plugin versions with their available updates. +#### Generated by `./gradlew refreshVersions` version 0.60.6 +#### +#### Don't manually edit or split the comments that start with four hashtags (####), +#### they will be overwritten by refreshVersions. +#### +#### suppress inspection "SpellCheckingInspection" for whole file +#### suppress inspection "UnusedProperty" for whole file +#### +#### NOTE: Some versions are filtered by the rejectVersionIf predicate. See the settings.gradle.kts file.