diff --git a/.github/labeler.yml b/.github/labeler.yml index ed4aebe..47595f6 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -26,6 +26,10 @@ - changed-files: - any-glob-to-any-file: 'spring-batch-file-examples/**/*' +"project: springwolf-example": + - changed-files: + - any-glob-to-any-file: 'spring-wolf-example/**/*' + "type: dependency-upgrade": - changed-files: - any-glob-to-any-file: "**/pom.xml" diff --git a/.github/workflows/springwolf-example.yml b/.github/workflows/springwolf-example.yml new file mode 100644 index 0000000..e536021 --- /dev/null +++ b/.github/workflows/springwolf-example.yml @@ -0,0 +1,68 @@ +name: springwolf-example CI Build + +on: + pull_request: + branches: [master] + paths: + - "springwolf-example/**" + types: + - opened + - synchronize + - reopened + +jobs: + + integration-tests: + name: Run Unit & Integration Tests + runs-on: ubuntu-latest + defaults: + run: + working-directory: springwolf-example + strategy: + matrix: + distribution: [ 'temurin' ] + java: [ '21' ] + steps: + - uses: actions/checkout@v6 + with: + fetch-depth: 0 + + - name: Set up JDK ${{ matrix.java }} + uses: actions/setup-java@v5.1.0 + with: + java-version: ${{ matrix.java }} + distribution: ${{ matrix.distribution }} + cache: 'maven' + - name: Build and analyze + run: ./mvnw clean verify + + health-check: + name: Health Check on Services + runs-on: ubuntu-latest + steps: + - name: Checkout repository and submodules + uses: actions/checkout@v6 + with: + submodules: true + + - name: Extract service names from docker compose + id: services + run: | + echo "services<> $GITHUB_OUTPUT + docker compose -f ./springwolf-example/compose.yaml config --services >> $GITHUB_OUTPUT + echo "EOF" >> $GITHUB_OUTPUT + + - name: Start containers with Compose Action + uses: hoverkraft-tech/compose-action@v2.4.2 + with: + compose-file: './springwolf-example/compose.yaml' + services: ${{ steps.services.outputs.services }} + up-flags: '--build' + down-flags: '--volumes' + + - name: Wait for containers to initialize + run: sleep 10 + + - name: Check container health + run: | + ./.github/scripts/check-container-health.sh "${{ steps.services.outputs.services }}" \ No newline at end of file diff --git a/README.md b/README.md index a8df429..7f42dc5 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Below you will find a summary table of each subproject. For more details, please | [Spring Boot + Postgres](./spring-postgres-example) | Demonstrates a basic integration between Spring Boot and Postgres. | | [Spring Boot + Mysql](./spring-mysql-example) | Demonstrates a basic integration between Spring Boot and Mysql. | | [Spring Boot + Grafana + Prometheus](./spring-prometheus-grafana-example) | Demonstrates a basic integration between Spring Boot With Grafana and Prometheus. | - +| [Spring Boot + Spring Wolf](./spring-wolf-example) | Demonstrates a basic integration between Spring Boot and Spring Wolf. | --- ## Tech Stack diff --git a/pom.xml b/pom.xml index ef9a7c8..ae84268 100644 --- a/pom.xml +++ b/pom.xml @@ -22,6 +22,7 @@ spring-oracle-example spring-batch-file-examples spring-batch-db-examples + spring-wolf-example diff --git a/spring-wolf-example/.dockerignore b/spring-wolf-example/.dockerignore new file mode 100644 index 0000000..8893889 --- /dev/null +++ b/spring-wolf-example/.dockerignore @@ -0,0 +1,62 @@ +# Include any files or directories that you don't want to be copied to your +# container here (e.g., local build artifacts, temporary files, etc.). +# +# For more help, visit the .dockerignore file reference guide at +# https://docs.docker.com/go/build-context-dockerignore/ + +**/.DS_Store +**/.classpath +**/.dockerignore +**/.env +**/.factorypath +**/.git +**/.gitignore +**/.idea +**/.project +**/.sts4-cache +**/.settings +**/.toolstarget +**/.vs +**/.vscode +**/.next +**/.cache +**/*.dbmdl +**/*.jfm +**/charts +**/docker-compose* +**/compose.y*ml +**/Dockerfile* +**/secrets.dev.yaml +**/values.dev.yaml +**/vendor +LICENSE +README.md +**/*.class +**/*.iml +**/*.ipr +**/*.iws +**/*.log +**/.apt_generated +**/.gradle +**/.gradletasknamecache +**/.nb-gradle +**/.springBeans +**/build +**/dist +**/gradle-app.setting +**/nbbuild +**/nbdist +**/nbproject/private +**/target +*.ctxt +.mtj.tmp +.mvn/timing.properties +buildNumber.properties +dependency-reduced-pom.xml +hs_err_pid* +pom.xml.next +pom.xml.releaseBackup +pom.xml.tag +pom.xml.versionsBackup +release.properties +replay_pid* \ No newline at end of file diff --git a/spring-wolf-example/.gitattributes b/spring-wolf-example/.gitattributes new file mode 100644 index 0000000..3b41682 --- /dev/null +++ b/spring-wolf-example/.gitattributes @@ -0,0 +1,2 @@ +/mvnw text eol=lf +*.cmd text eol=crlf diff --git a/spring-wolf-example/.github/maven.yml b/spring-wolf-example/.github/maven.yml new file mode 100644 index 0000000..73c830b --- /dev/null +++ b/spring-wolf-example/.github/maven.yml @@ -0,0 +1,30 @@ +name: CI Build + +on: + push: + branches: + - "**" + +jobs: + build: + name: Build + runs-on: ubuntu-latest + strategy: + matrix: + distribution: [ 'temurin' ] + java: [ '21' ] + steps: + - uses: actions/checkout@v6 + + - name: Setup Java 21 + uses: actions/setup-java@v5 + with: + java-version: ${{ matrix.java }} + distribution: ${{ matrix.distribution }} + cache: 'maven' + + - name: Grant execute permission for mvnw + run: chmod +x mvnw + + - name: Build with Maven + run: ./mvnw clean verify \ No newline at end of file diff --git a/spring-wolf-example/.gitignore b/spring-wolf-example/.gitignore new file mode 100644 index 0000000..667aaef --- /dev/null +++ b/spring-wolf-example/.gitignore @@ -0,0 +1,33 @@ +HELP.md +target/ +.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/spring-wolf-example/.mvn/wrapper/maven-wrapper.properties b/spring-wolf-example/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..c0bcafe --- /dev/null +++ b/spring-wolf-example/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,3 @@ +wrapperVersion=3.3.4 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip diff --git a/spring-wolf-example/Dockerfile b/spring-wolf-example/Dockerfile new file mode 100644 index 0000000..0b085e2 --- /dev/null +++ b/spring-wolf-example/Dockerfile @@ -0,0 +1,47 @@ +FROM eclipse-temurin:21-jdk-jammy as deps + +WORKDIR /build + +COPY --chmod=0755 mvnw mvnw +COPY .mvn/ .mvn/ + +RUN --mount=type=bind,source=pom.xml,target=pom.xml \ + --mount=type=cache,target=/root/.m2 ./mvnw dependency:go-offline -DskipTests + +FROM deps as package + +WORKDIR /build + +COPY ./src src/ +RUN --mount=type=bind,source=pom.xml,target=pom.xml \ + --mount=type=cache,target=/root/.m2 \ + ./mvnw package -DskipTests && \ + mv target/$(./mvnw help:evaluate -Dexpression=project.artifactId -q -DforceStdout)-$(./mvnw help:evaluate -Dexpression=project.version -q -DforceStdout).jar target/app.jar + +FROM package as extract + +WORKDIR /build + +RUN java -Djarmode=layertools -jar target/app.jar extract --destination target/extracted + +FROM eclipse-temurin:21-jre-jammy AS final + +ARG UID=10001 +RUN adduser \ + --disabled-password \ + --gecos "" \ + --home "/nonexistent" \ + --shell "/sbin/nologin" \ + --no-create-home \ + --uid "${UID}" \ + appuser +USER appuser + +COPY --from=extract build/target/extracted/dependencies/ ./ +COPY --from=extract build/target/extracted/spring-boot-loader/ ./ +COPY --from=extract build/target/extracted/snapshot-dependencies/ ./ +COPY --from=extract build/target/extracted/application/ ./ + +EXPOSE 7075 + +ENTRYPOINT [ "java", "org.springframework.boot.loader.launch.JarLauncher" ] diff --git a/spring-wolf-example/README.md b/spring-wolf-example/README.md new file mode 100644 index 0000000..ea37acd --- /dev/null +++ b/spring-wolf-example/README.md @@ -0,0 +1,50 @@ +# spring-wolf-example + +## Overview + +This project demonstrates how to use **Spring Wolf** to document and expose asynchronous APIs built with Spring Boot. +It includes examples of asynchronous communication using **Kafka**, and will later include **Google Pub/Sub** and **AWS SQS**. + +Spring Wolf automatically generates an **AsyncAPI specification** and provides a UI to visualize producers, consumers, +and message schemas in real time. + +--- + +## Tech Stack + +- Spring Boot +- Spring Wolf +- Java 21 +- Docker +- Kafka (implemented) +- Google Pub/Sub (pending) +- AWS SQS (pending) + +--- + +## Current Progress + +| Tool / Integration | Status | Notes | +|--------------------|---------------|----------------------------------------| +| Kafka | ✔ Implemented | Consumer + Producer examples completed | +| Google Pub/Sub | ⏳ Pending | Planned for future implementation | +| AWS SQS | ⏳ Pending | Planned for future implementation | + +--- + +## Endpoints + +| Environment | URL | +|-------------|----------------------------------------------------------------| +| Docker | http://localhost:7075/springwolf/asyncapi-ui.html | +| Local | http://localhost:8080/springwolf/asyncapi-ui.html | + +--- + +## Related Resources + +| Description | Link | +|--------------------------------|----------------------------------------------------------------------------------------------------------------| +| Spring Wolf Documentation | https://springwolf.dev | +| AsyncAPI Specification | https://www.asyncapi.com | +| Spring Wolf With Kafka Example | [here](https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples/springwolf-kafka-example) | diff --git a/spring-wolf-example/compose.yaml b/spring-wolf-example/compose.yaml new file mode 100644 index 0000000..20afa39 --- /dev/null +++ b/spring-wolf-example/compose.yaml @@ -0,0 +1,61 @@ +services: + + app: + container_name: app + build: + context: . + ports: + - "7075:7075" + environment: + SERVER_PORT: 7075 + SPRING_WOLF_ENABLED: true + KAFKA_SIMPLE_TOPIC: spring-kafka-simple-topic + KAFKA_SERVER: kafka:9092 + depends_on: + - kafka + networks: + - kafka-net + + kafka: + image: apache/kafka:4.1.1 + container_name: kafka + ports: + - "9092:9092" + - "9093:9093" + environment: + KAFKA_NODE_ID: 1 + KAFKA_PROCESS_ROLES: broker,controller + KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:9092,PLAINTEXT_HOST://localhost:9093 + KAFKA_LISTENERS: CONTROLLER://0.0.0.0:9094,PLAINTEXT://0.0.0.0:9092,PLAINTEXT_HOST://0.0.0.0:9093 + KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT + KAFKA_INTER_BROKER_LISTENER_NAME: PLAINTEXT + KAFKA_CONTROLLER_LISTENER_NAMES: CONTROLLER + KAFKA_CONTROLLER_QUORUM_VOTERS: 1@kafka:9094 + KAFKA_LOG_DIRS: /tmp/kraft-combined-logs + KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1 + KAFKA_AUTO_CREATE_TOPICS_ENABLE: 'false' + networks: + - kafka-net + + kafka-init: + container_name: kafka-init + image: apache/kafka:4.1.1 + depends_on: + kafka: + condition: service_started + command: [ "/bin/bash", "-c", "/create_topic.sh" ] + environment: + KAFKA_HOST: kafka + KAFKA_PORT: 9092 + KAFKA_TOPIC_CREATE: spring-kafka-simple-topic + volumes: + - type: bind + source: ./docker/kafka/create_topic.sh + target: /create_topic.sh + init: true + networks: + - kafka-net + +networks: + kafka-net: + driver: bridge \ No newline at end of file diff --git a/spring-wolf-example/docker/kafka/create_topic.sh b/spring-wolf-example/docker/kafka/create_topic.sh new file mode 100755 index 0000000..58e18e4 --- /dev/null +++ b/spring-wolf-example/docker/kafka/create_topic.sh @@ -0,0 +1,15 @@ +#!/bin/bash + +echo "Waiting for Kafka on port $KAFKA_PORT..." +while ! nc -z $KAFKA_HOST $KAFKA_PORT; do + sleep 2 +done + +/opt/kafka/bin/kafka-topics.sh \ + --create \ + --topic "$KAFKA_TOPIC_CREATE" \ + --bootstrap-server $KAFKA_HOST:$KAFKA_PORT \ + --partitions 1 \ + --replication-factor 1 + +echo "Topic $KAFKA_TOPIC_CREATE created successfully!" \ No newline at end of file diff --git a/spring-wolf-example/mvnw b/spring-wolf-example/mvnw new file mode 100755 index 0000000..bd8896b --- /dev/null +++ b/spring-wolf-example/mvnw @@ -0,0 +1,295 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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 +# +# http://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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.4 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + 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" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +scriptDir="$(dirname "$0")" +scriptName="$(basename "$0")" + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +actualDistributionDir="" + +# First try the expected directory name (for regular distributions) +if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then + if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then + actualDistributionDir="$distributionUrlNameMain" + fi +fi + +# If not found, search for any directory with the Maven executable (for snapshots) +if [ -z "$actualDistributionDir" ]; then + # enable globbing to iterate over items + set +f + for dir in "$TMP_DOWNLOAD_DIR"/*; do + if [ -d "$dir" ]; then + if [ -f "$dir/bin/$MVN_CMD" ]; then + actualDistributionDir="$(basename "$dir")" + break + fi + fi + done + set -f +fi + +if [ -z "$actualDistributionDir" ]; then + verbose "Contents of $TMP_DOWNLOAD_DIR:" + verbose "$(ls -la "$TMP_DOWNLOAD_DIR")" + die "Could not find Maven distribution directory in extracted archive" +fi + +verbose "Found extracted Maven distribution directory: $actualDistributionDir" +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/spring-wolf-example/mvnw.cmd b/spring-wolf-example/mvnw.cmd new file mode 100644 index 0000000..92450f9 --- /dev/null +++ b/spring-wolf-example/mvnw.cmd @@ -0,0 +1,189 @@ +<# : batch portion +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.4 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' + +$MAVEN_M2_PATH = "$HOME/.m2" +if ($env:MAVEN_USER_HOME) { + $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" +} + +if (-not (Test-Path -Path $MAVEN_M2_PATH)) { + New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null +} + +$MAVEN_WRAPPER_DISTS = $null +if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { + $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" +} else { + $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" +} + +$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" +$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +$actualDistributionDir = "" + +# First try the expected directory name (for regular distributions) +$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" +$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" +if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { + $actualDistributionDir = $distributionUrlNameMain +} + +# If not found, search for any directory with the Maven executable (for snapshots) +if (!$actualDistributionDir) { + Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { + $testPath = Join-Path $_.FullName "bin/$MVN_CMD" + if (Test-Path -Path $testPath -PathType Leaf) { + $actualDistributionDir = $_.Name + } + } +} + +if (!$actualDistributionDir) { + Write-Error "Could not find Maven distribution directory in extracted archive" +} + +Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/spring-wolf-example/pom.xml b/spring-wolf-example/pom.xml new file mode 100644 index 0000000..95da2ba --- /dev/null +++ b/spring-wolf-example/pom.xml @@ -0,0 +1,102 @@ + + + + 4.0.0 + + + org.springframework.boot + spring-boot-starter-parent + 3.5.8 + + + + com.io + springwolf-example + springwolf-example + 1.0.0 + Demo project for Spring Boot + + + 21 + + + + + + org.springframework.boot + spring-boot-starter-web + + + + org.springframework.cloud + spring-cloud-starter-stream-kafka + 4.3.0 + + + + org.projectlombok + lombok + true + + + + io.github.springwolf + springwolf-ui + 1.20.0 + + + + io.github.springwolf + springwolf-kafka + 1.20.0 + + + + org.springframework.boot + spring-boot-starter-test + test + + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + + + org.projectlombok + lombok + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.projectlombok + lombok + + + + + + + + + + + confluent + https://packages.confluent.io/maven/ + + + + diff --git a/spring-wolf-example/src/main/java/com/io/example/SpringWolfExampleApplication.java b/spring-wolf-example/src/main/java/com/io/example/SpringWolfExampleApplication.java new file mode 100644 index 0000000..46c3109 --- /dev/null +++ b/spring-wolf-example/src/main/java/com/io/example/SpringWolfExampleApplication.java @@ -0,0 +1,13 @@ +package com.io.example; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SpringWolfExampleApplication { + + public static void main(String[] args) { + SpringApplication.run(SpringWolfExampleApplication.class, args); + } + +} diff --git a/spring-wolf-example/src/main/java/com/io/example/consumer/KafkaConsumer.java b/spring-wolf-example/src/main/java/com/io/example/consumer/KafkaConsumer.java new file mode 100644 index 0000000..1a3e39c --- /dev/null +++ b/spring-wolf-example/src/main/java/com/io/example/consumer/KafkaConsumer.java @@ -0,0 +1,39 @@ +package com.io.example.consumer; + +import com.io.example.dto.KafkaDto; +import com.io.example.util.ConstantsUtil; +import io.github.springwolf.bindings.kafka.annotations.KafkaAsyncOperationBinding; +import io.github.springwolf.core.asyncapi.annotations.AsyncListener; +import io.github.springwolf.core.asyncapi.annotations.AsyncOperation; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.stereotype.Component; +import java.util.function.Consumer; + +import static org.springframework.kafka.support.mapping.AbstractJavaTypeMapper.DEFAULT_CLASSID_FIELD_NAME; + +@Slf4j +@Component +public class KafkaConsumer implements Consumer { + + @KafkaAsyncOperationBinding(bindingVersion = "1.0.0") + @AsyncListener(operation = @AsyncOperation( + channelName = ConstantsUtil.KAFKA_TOPIC, + description = "Tópico que recebe dados de exemplo do kafka", + servers = {"kafka"}, + headers = @AsyncOperation.Headers( + schemaName = "SpringKafkaDefaultHeaders-KafkaDto", + values = { + @AsyncOperation.Headers.Header( + name = DEFAULT_CLASSID_FIELD_NAME, + value = "com.io.example.dto.KafkaDto", + description = "Type ID") + }) + )) + @Override + public void accept(KafkaDto kafkaDto) { + log.info("receive: {}", kafkaDto.message()); + } + + +} \ No newline at end of file diff --git a/spring-wolf-example/src/main/java/com/io/example/dto/KafkaDto.java b/spring-wolf-example/src/main/java/com/io/example/dto/KafkaDto.java new file mode 100644 index 0000000..906d11d --- /dev/null +++ b/spring-wolf-example/src/main/java/com/io/example/dto/KafkaDto.java @@ -0,0 +1,3 @@ +package com.io.example.dto; + +public record KafkaDto(String message) {} \ No newline at end of file diff --git a/spring-wolf-example/src/main/java/com/io/example/producer/KafkaProducer.java b/spring-wolf-example/src/main/java/com/io/example/producer/KafkaProducer.java new file mode 100644 index 0000000..cd022ec --- /dev/null +++ b/spring-wolf-example/src/main/java/com/io/example/producer/KafkaProducer.java @@ -0,0 +1,42 @@ +package com.io.example.producer; + +import com.io.example.util.ConstantsUtil; +import com.io.example.dto.KafkaDto; +import io.github.springwolf.bindings.kafka.annotations.KafkaAsyncOperationBinding; +import io.github.springwolf.core.asyncapi.annotations.AsyncOperation; +import io.github.springwolf.core.asyncapi.annotations.AsyncPublisher; +import lombok.RequiredArgsConstructor; +import org.springframework.cloud.stream.function.StreamBridge; +import org.springframework.stereotype.Component; + +import static org.springframework.kafka.support.mapping.AbstractJavaTypeMapper.DEFAULT_CLASSID_FIELD_NAME; + +@Component +@RequiredArgsConstructor +public class KafkaProducer { + + private final StreamBridge bridge; + + @AsyncPublisher( + operation = @AsyncOperation( + servers = {"kafka"}, + channelName = ConstantsUtil.KAFKA_TOPIC, + description = "Tópico de exemplo pra envio de mensagens", + payloadType = KafkaDto.class, + headers = @AsyncOperation.Headers( + schemaName = "SpringKafkaDefaultHeaders-KafkaDto", + values = { + @AsyncOperation.Headers.Header( + name = DEFAULT_CLASSID_FIELD_NAME, + value = "com.io.example.dto.KafkaDto", + description = "Type ID") + }) + ) + ) + @KafkaAsyncOperationBinding(bindingVersion = "1.0.0") + public void send(String text) { + KafkaDto message = new KafkaDto(text); + bridge.send("sendMessage-out-0", message); + } + +} \ No newline at end of file diff --git a/spring-wolf-example/src/main/java/com/io/example/util/ConstantsUtil.java b/spring-wolf-example/src/main/java/com/io/example/util/ConstantsUtil.java new file mode 100644 index 0000000..ea5b58f --- /dev/null +++ b/spring-wolf-example/src/main/java/com/io/example/util/ConstantsUtil.java @@ -0,0 +1,5 @@ +package com.io.example.util; + +public class ConstantsUtil { + public static final String KAFKA_TOPIC = "spring-kafka-simple-topic"; +} \ No newline at end of file diff --git a/spring-wolf-example/src/main/resources/application-prd.yaml b/spring-wolf-example/src/main/resources/application-prd.yaml new file mode 100644 index 0000000..7fde973 --- /dev/null +++ b/spring-wolf-example/src/main/resources/application-prd.yaml @@ -0,0 +1,58 @@ +spring: + application: + name: springwolf-example-prd + + cloud: + function: + definition: kafkaConsumer + + stream: + kafka: + binder: + brokers: ${kafka.server} + + bindings: + + # PRODUCER + sendMessage-out-0: + destination: ${kafka.topics.simple-topic} + + # CONSUMER + kafkaConsumer-in-0: + destination: ${kafka.topics.simple-topic} + group: spring-kafka-simple-group + +springwolf: + + enabled: ${SPRING_WOLF_ENABLED} + + docket: + base-package: com.io.example + info: + title: "${spring.application.name}" + version: "1.0.0" + + servers: + kafka: + protocol: kafka + host: ${kafka.server} + + plugin: + kafka: + publishing: + enabled: ${SPRING_WOLF_ENABLED} + producer: + bootstrap-servers: ${kafka.server} + key-serializer: org.apache.kafka.common.serialization.StringSerializer + value-serializer: org.springframework.kafka.support.serializer.JsonSerializer + security: + protocol: PLAINTEXT + ui: + defaults: + show-bindings: true + show-headers: true + +kafka: + topics: + simple-topic: ${KAFKA_SIMPLE_TOPIC} + server: ${KAFKA_SERVER} diff --git a/spring-wolf-example/src/main/resources/application.yaml b/spring-wolf-example/src/main/resources/application.yaml new file mode 100644 index 0000000..66cd4eb --- /dev/null +++ b/spring-wolf-example/src/main/resources/application.yaml @@ -0,0 +1,58 @@ +spring: + application: + name: springwolf-example-local + + cloud: + function: + definition: kafkaConsumer + + stream: + kafka: + binder: + brokers: ${kafka.server} + + bindings: + + # PRODUCER + sendMessage-out-0: + destination: ${kafka.topics.simple-topic} + + # CONSUMER + kafkaConsumer-in-0: + destination: ${kafka.topics.simple-topic} + group: spring-kafka-simple-group + +springwolf: + + enabled: ${SPRING_WOLF_ENABLED:true} + + docket: + base-package: com.io.example + info: + title: "${spring.application.name}" + version: "1.0.0" + + servers: + kafka: + protocol: kafka + host: ${kafka.server} + + plugin: + kafka: + publishing: + enabled: ${SPRING_WOLF_ENABLED:true} + producer: + bootstrap-servers: ${kafka.server} + key-serializer: org.apache.kafka.common.serialization.StringSerializer + value-serializer: org.springframework.kafka.support.serializer.JsonSerializer + security: + protocol: PLAINTEXT + ui: + defaults: + show-bindings: true + show-headers: true + +kafka: + topics: + simple-topic: ${KAFKA_SIMPLE_TOPIC:spring-kafka-simple-topic} + server: ${KAFKA_SERVER:localhost:9093}