diff --git a/spring-elastic/.gitignore b/spring-elastic/.gitignore new file mode 100644 index 00000000..581a6cbd --- /dev/null +++ b/spring-elastic/.gitignore @@ -0,0 +1,14 @@ +HELP.md +target/ +!.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### VS Code ### +.vscode/ \ No newline at end of file diff --git a/spring-elastic/.mvn/wrapper/maven-wrapper.properties b/spring-elastic/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000..d58dfb70 --- /dev/null +++ b/spring-elastic/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,19 @@ +# 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. +wrapperVersion=3.3.2 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip diff --git a/spring-elastic/README.md b/spring-elastic/README.md new file mode 100644 index 00000000..26cfec20 --- /dev/null +++ b/spring-elastic/README.md @@ -0,0 +1,145 @@ +# Spring Boot Elasticsearch Example + +This project is a simple Spring Boot application that demonstrates how to integrate with Elasticsearch using the Java High-Level REST Client. It provides REST endpoints to create and search books in an Elasticsearch index. + +## Prerequisites + +- **Java Development Kit (JDK) 8 or higher** +- **Maven** for building the project +- **Docker** for running Elasticsearch +- An API client like **Postman** or **cURL** for testing endpoints + +## Setting Up Elasticsearch with Docker + +To run Elasticsearch, we'll use Docker to pull and run the official Elasticsearch image. + +Execute the following command in your terminal: + +```bash +docker run -d \ + -p 9200:9200 \ + -p 9300:9300 \ + --name elasticsearch \ + -e "discovery.type=single-node" \ + -e "xpack.security.enabled=false" \ + docker.elastic.co/elasticsearch/elasticsearch:8.15.2 +``` + +## Explanation of the Docker Command: + +- `-d`: Run the container in detached mode (in the background). +- `-p 9200:9200`: Map port 9200 of the host to port 9200 of the container (HTTP API). +- `-p 9300:9300`: Map port 9300 of the host to port 9300 of the container (Transport API). +- `--name elasticsearch`: Assign the name "elasticsearch" to the container. +- `-e "discovery.type=single-node"`: Run Elasticsearch in single-node mode. +- `-e "xpack.security.enabled=false"`: Disable X-Pack security features for simplicity. !!! Not recommended for production +- `docker.elastic.co/elasticsearch/elasticsearch:8.15.2`: The Docker image to use. + +### Verify Elasticsearch is Running: + +After running the Docker command, verify that Elasticsearch is running by accessing [http://localhost:9200](http://localhost:9200) in your browser or using `curl`: + +```bash +curl http://localhost:9200 +``` + +You should receive a JSON response with cluster information. + +Running the Spring Boot Application +1. Clone the Repository + +```bash +git clone https://github.com/yourusername/your-repo-name.git +cd your-repo-name +``` + +2. Configure Application Properties + Ensure that your application.properties file is correctly set up. It should be located in src/main/resources/ and contain the following properties: + +```bash +spring.application.name=spring-elastic +server.port=8081 + +spring.elasticsearch.url=localhost +spring.elasticsearch.port=9200 + +# Credentials are optional if security is disabled +spring.elasticsearch.username= +spring.elasticsearch.password= +``` +3. Build the Project + Use Maven to build the project: + +```bash +mvn clean install +``` + +4. Run the Application + You can run the application using Maven: + + +```bash +mvn spring-boot:run +``` + +Or run the generated JAR file: + +```bash +java -jar target/your-app-name.jar +``` +The application will start on port 8081. + +Project Structure +- Controller +BookController: Handles HTTP requests for creating and searching books. +- Model +Book: Represents the book entity stored in Elasticsearch. +- Client +BookElasticsearchClient: Manages the connection to Elasticsearch. +- Service +BookElasticsearchService: Contains business logic for interacting with Elasticsearch. +Endpoints +1. Create a Book + - URL: /book/create + - Method: POST + - Description: Creates a new book in the Elasticsearch index. + - Request Body: + +```bash +{ + "id": "1", + "name": "Elasticsearch Basics", + "description": "An introductory guide to Elasticsearch.", + "price": 29.99 +} +``` +Sample cURL Request: + +```bash +curl -X POST \ + http://localhost:8081/book/create \ + -H 'Content-Type: application/json' \ + -d '{ + "id": "1", + "name": "Elasticsearch Basics", + "description": "An introductory guide to Elasticsearch.", + "price": 29.99 + }' +``` + +2. Find Books by Name + - URL: /book/find_by_name + - Method: GET + - Description: Searches for books by name in the Elasticsearch index. + - Query Parameter: + - name: The name or partial name of the book to search for. +```bash +curl -X GET "http://localhost:8081/book/find_by_name?name=Elasticsearch" +``` + +### Conclusion +You have successfully set up an Elasticsearch instance using Docker and run a Spring Boot application that interacts with it. This application demonstrates basic CRUD operations with Elasticsearch, providing a foundation for more complex integrations. + +Feel free to extend this application by adding more features like update and delete operations, or by integrating authentication and security features. + +Note: In a production environment, you should enable security features in Elasticsearch and handle credentials appropriately. \ No newline at end of file diff --git a/spring-elastic/keploy.yml b/spring-elastic/keploy.yml new file mode 100644 index 00000000..e1312f3b --- /dev/null +++ b/spring-elastic/keploy.yml @@ -0,0 +1,61 @@ +path: "" +appId: 0 +appName: spring-elastic +command: mvn spring-boot:run +templatize: + testSets: [] +port: 0 +dnsPort: 26789 +proxyPort: 16789 +debug: false +disableTele: false +disableANSI: false +containerName: "" +networkName: "" +buildDelay: 30 +test: + selectedTests: {} + globalNoise: + global: {} + test-sets: {} + delay: 5 + host: "" + port: 0 + apiTimeout: 5 + skipCoverage: false + coverageReportPath: "" + ignoreOrdering: true + mongoPassword: default@123 + language: "" + removeUnusedMocks: false + fallBackOnMiss: false + jacocoAgentPath: "" + basePath: "" + mocking: true + ignoredTests: {} + disableLineCoverage: false + disableMockUpload: true + useLocalMock: false + updateTemplate: false +record: + filters: [] + recordTimer: 0s +configPath: "" +bypassRules: [] +generateGithubActions: false +keployContainer: keploy-v2 +keployNetwork: keploy-network +cmdType: native +contract: + services: [] + tests: [] + path: "" + download: false + generate: false + driven: consumer + mappings: + servicesMapping: {} + self: "" +inCi: false + +# Visit [https://keploy.io/docs/running-keploy/configuration-file/] to learn about using keploy through configration file. diff --git a/spring-elastic/keploy/.gitignore b/spring-elastic/keploy/.gitignore new file mode 100644 index 00000000..30846059 --- /dev/null +++ b/spring-elastic/keploy/.gitignore @@ -0,0 +1 @@ +/reports/ diff --git a/spring-elastic/keploy/test-set-1/mocks.yaml b/spring-elastic/keploy/test-set-1/mocks.yaml new file mode 100644 index 00000000..50a940b6 --- /dev/null +++ b/spring-elastic/keploy/test-set-1/mocks.yaml @@ -0,0 +1,75 @@ +version: api.keploy.io/v1beta1 +kind: Http +name: mock-0 +spec: + metadata: + name: Http + operation: POST + type: HTTP_CLIENT + req: + method: POST + proto_major: 1 + proto_minor: 1 + url: /books/_search?typed_keys=true + url_params: + typed_keys: "true" + header: + Accept: application/vnd.elasticsearch+json; compatible-with=8 + Connection: Keep-Alive + Content-Type: application/vnd.elasticsearch+json; compatible-with=8 + User-Agent: elastic-java/8.11.0 (Java/21.0.4) + X-Elastic-Client-Meta: es=8.11.0,jv=21,t=8.11.0,hl=2,hc=4.1.5 + body: '{"query":{"match":{"name":{"query":"Great"}}}}' + timestamp: 0001-01-01T00:00:00Z + resp: + status_code: 200 + header: + Content-Length: "385" + Content-Type: application/vnd.elasticsearch+json;compatible-with=8 + X-Elastic-Product: Elasticsearch + body: '{"took":85,"timed_out":false,"_shards":{"total":1,"successful":1,"skipped":0,"failed":0},"hits":{"total":{"value":1,"relation":"eq"},"max_score":0.6407243,"hits":[{"_index":"books","_id":"1","_score":0.6407243,"_source":{"id":"1","name":"The Great Gatsby","description":"A novel set in the Jazz Age that tells the story of Jay Gatsby and his love for Daisy Buchanan.","price":30.0}}]}}' + status_message: "" + proto_major: 0 + proto_minor: 0 + timestamp: 0001-01-01T00:00:00Z + objects: [] + created: 1729798124 + reqTimestampMock: 2024-10-24T21:28:44.059763186+02:00 + resTimestampMock: 2024-10-24T21:28:44.059763186+02:00 +--- +version: api.keploy.io/v1beta1 +kind: Http +name: mock-1 +spec: + metadata: + name: Http + operation: PUT + type: HTTP_CLIENT + req: + method: PUT + proto_major: 1 + proto_minor: 1 + url: /books/_doc/2 + header: + Accept: application/vnd.elasticsearch+json; compatible-with=8 + Connection: Keep-Alive + Content-Type: application/vnd.elasticsearch+json; compatible-with=8 + User-Agent: elastic-java/8.11.0 (Java/21.0.4) + X-Elastic-Client-Meta: es=8.11.0,jv=21,t=8.11.0,hl=2,hc=4.1.5 + body: '{"id":"2","name":"Harry Potter","description":"A magical journey of a young wizard, Harry Potter, as he navigates his adventures in the wizarding world and faces his ultimate enemy, Lord Voldemort.","price":50.0}' + timestamp: 0001-01-01T00:00:00Z + resp: + status_code: 200 + header: + Content-Length: "138" + Content-Type: application/vnd.elasticsearch+json;compatible-with=8 + X-Elastic-Product: Elasticsearch + body: '{"_index":"books","_id":"2","_version":2,"result":"updated","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":2,"_primary_term":8}' + status_message: "" + proto_major: 0 + proto_minor: 0 + timestamp: 0001-01-01T00:00:00Z + objects: [] + created: 1729798145 + reqTimestampMock: 2024-10-24T21:29:05.714170448+02:00 + resTimestampMock: 2024-10-24T21:29:05.714170448+02:00 diff --git a/spring-elastic/keploy/test-set-1/tests/test-1.yaml b/spring-elastic/keploy/test-set-1/tests/test-1.yaml new file mode 100644 index 00000000..784f3897 --- /dev/null +++ b/spring-elastic/keploy/test-set-1/tests/test-1.yaml @@ -0,0 +1,47 @@ +version: api.keploy.io/v1beta1 +kind: Http +name: test-1 +spec: + metadata: {} + req: + method: GET + proto_major: 1 + proto_minor: 1 + url: http://localhost:8081/book/find_by_name?name=Great + url_params: + name: Great + header: + Accept: '*/*' + Accept-Encoding: gzip, deflate, br + Connection: keep-alive + Host: localhost:8081 + Postman-Token: 533f7ecd-38bc-432b-8288-4c65ac3feffd + User-Agent: PostmanRuntime/7.26.8 + body: "" + timestamp: 2024-10-24T21:28:43.206142562+02:00 + resp: + status_code: 200 + header: + Connection: keep-alive + Content-Type: application/json + Date: Thu, 24 Oct 2024 19:28:44 GMT + Keep-Alive: timeout=60 + body: '[{"id":"1","name":"The Great Gatsby","description":"A novel set in the Jazz Age that tells the story of Jay Gatsby and his love for Daisy Buchanan.","price":30.0}]' + status_message: OK + proto_major: 0 + proto_minor: 0 + timestamp: 2024-10-24T21:28:46.844302549+02:00 + objects: [] + assertions: + noise: + header.Date: [] + created: 1729798126 +curl: | + curl --request GET \ + --url http://localhost:8081/book/find_by_name?name=Great \ + --header 'Accept-Encoding: gzip, deflate, br' \ + --header 'Connection: keep-alive' \ + --header 'User-Agent: PostmanRuntime/7.26.8' \ + --header 'Accept: */*' \ + --header 'Postman-Token: 533f7ecd-38bc-432b-8288-4c65ac3feffd' \ + --header 'Host: localhost:8081' \ diff --git a/spring-elastic/keploy/test-set-1/tests/test-2.yaml b/spring-elastic/keploy/test-set-1/tests/test-2.yaml new file mode 100644 index 00000000..3906adbb --- /dev/null +++ b/spring-elastic/keploy/test-set-1/tests/test-2.yaml @@ -0,0 +1,51 @@ +version: api.keploy.io/v1beta1 +kind: Http +name: test-2 +spec: + metadata: {} + req: + method: POST + proto_major: 1 + proto_minor: 1 + url: http://localhost:8081/book/create + header: + Accept: '*/*' + Accept-Encoding: gzip, deflate, br + Authorization: Basic ZWxhc3RpYzo4ZkVHZ25FTm9zSz0yWlp2bjFiYQ== + Connection: keep-alive + Content-Length: "242" + Content-Type: application/json + Host: localhost:8081 + Postman-Token: 0853358a-4d38-4d65-882b-90615afde2fb + User-Agent: PostmanRuntime/7.26.8 + body: "{\r\n \"id\": \"2\",\r\n \"name\": \"Harry Potter\",\r\n \"description\": \"A magical journey of a young wizard, Harry Potter, as he navigates his adventures in the wizarding world and faces his ultimate enemy, Lord Voldemort.\",\r\n \"price\": 50\r\n}\r\n" + timestamp: 2024-10-24T21:29:05.587673534+02:00 + resp: + status_code: 200 + header: + Connection: keep-alive + Content-Type: application/json + Date: Thu, 24 Oct 2024 19:29:05 GMT + Keep-Alive: timeout=60 + body: '{"id":"2","name":"Harry Potter","description":"A magical journey of a young wizard, Harry Potter, as he navigates his adventures in the wizarding world and faces his ultimate enemy, Lord Voldemort.","price":50.0}' + status_message: OK + proto_major: 0 + proto_minor: 0 + timestamp: 2024-10-24T21:29:07.729124751+02:00 + objects: [] + assertions: + noise: + header.Date: [] + created: 1729798147 +curl: |- + curl --request POST \ + --url http://localhost:8081/book/create \ + --header 'Connection: keep-alive' \ + --header 'User-Agent: PostmanRuntime/7.26.8' \ + --header 'Host: localhost:8081' \ + --header 'Postman-Token: 0853358a-4d38-4d65-882b-90615afde2fb' \ + --header 'Accept: */*' \ + --header 'Content-Type: application/json' \ + --header 'Authorization: Basic ZWxhc3RpYzo4ZkVHZ25FTm9zSz0yWlp2bjFiYQ==' \ + --header 'Accept-Encoding: gzip, deflate, br' \ + --data "{\r\n \"id\": \"2\",\r\n \"name\": \"Harry Potter\",\r\n \"description\": \"A magical journey of a young wizard, Harry Potter, as he navigates his adventures in the wizarding world and faces his ultimate enemy, Lord Voldemort.\",\r\n \"price\": 50\r\n}\r\n" diff --git a/spring-elastic/mvnw b/spring-elastic/mvnw new file mode 100644 index 00000000..19529ddf --- /dev/null +++ b/spring-elastic/mvnw @@ -0,0 +1,259 @@ +#!/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.2 +# +# 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:]' +} + +# 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 <"${0%/*}/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in ${0%/*}/.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${0##*/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 +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/spring-elastic/mvnw.cmd b/spring-elastic/mvnw.cmd new file mode 100644 index 00000000..249bdf38 --- /dev/null +++ b/spring-elastic/mvnw.cmd @@ -0,0 +1,149 @@ +<# : 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.2 +@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) { "/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_HOME_PARENT = "$HOME/.m2/wrapper/dists/$distributionUrlNameMain" +if ($env:MAVEN_USER_HOME) { + $MAVEN_HOME_PARENT = "$env:MAVEN_USER_HOME/wrapper/dists/$distributionUrlNameMain" +} +$MAVEN_HOME_NAME = ([System.Security.Cryptography.MD5]::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 +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" -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-elastic/pom.xml b/spring-elastic/pom.xml new file mode 100644 index 00000000..f0bd3f56 --- /dev/null +++ b/spring-elastic/pom.xml @@ -0,0 +1,65 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.3.4 + + + com.example + spring-elastic + 0.0.1-SNAPSHOT + spring-elastic + Spring Elasticsearch sample app + + + + + + + + + + + + + + + 21 + + + + org.springframework.boot + spring-boot-starter-web + + + + + org.springframework.boot + spring-boot-starter-data-elasticsearch + + + + co.elastic.clients + elasticsearch-java + + + + org.springframework.boot + spring-boot-starter-test + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + diff --git a/spring-elastic/src/main/java/com/example/spring_elastic/SpringElasticApplication.java b/spring-elastic/src/main/java/com/example/spring_elastic/SpringElasticApplication.java new file mode 100644 index 00000000..ac6e1e02 --- /dev/null +++ b/spring-elastic/src/main/java/com/example/spring_elastic/SpringElasticApplication.java @@ -0,0 +1,13 @@ +package com.example.spring_elastic; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SpringElasticApplication { + + public static void main(String[] args) { + SpringApplication.run(SpringElasticApplication.class, args); + } + +} diff --git a/spring-elastic/src/main/java/com/example/spring_elastic/client/BookElasticsearchClient.java b/spring-elastic/src/main/java/com/example/spring_elastic/client/BookElasticsearchClient.java new file mode 100644 index 00000000..e02eb4e7 --- /dev/null +++ b/spring-elastic/src/main/java/com/example/spring_elastic/client/BookElasticsearchClient.java @@ -0,0 +1,42 @@ +package com.example.spring_elastic.client; + + +import org.apache.http.HttpHost; + +import org.elasticsearch.client.RestClient; + +import co.elastic.clients.elasticsearch.ElasticsearchClient; +import co.elastic.clients.json.jackson.JacksonJsonpMapper; +import co.elastic.clients.transport.ElasticsearchTransport; +import co.elastic.clients.transport.rest_client.RestClientTransport; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; + +@Component +public class BookElasticsearchClient { + private ElasticsearchClient client; + + @Value("${spring.elasticsearch.port}") + private String port; + + @Value("${spring.elasticsearch.url}") + private String url; + + public ElasticsearchClient getClient() + { + if (client == null) { + initClient(); + } + + return client; + } + + private void initClient() + { + RestClient restClient = RestClient.builder(new HttpHost(url, Integer.parseInt(port))).build(); + + ElasticsearchTransport transport = new RestClientTransport(restClient, new JacksonJsonpMapper()); + + client = new ElasticsearchClient(transport); + } +} \ No newline at end of file diff --git a/spring-elastic/src/main/java/com/example/spring_elastic/controller/BookController.java b/spring-elastic/src/main/java/com/example/spring_elastic/controller/BookController.java new file mode 100644 index 00000000..1e7ff00e --- /dev/null +++ b/spring-elastic/src/main/java/com/example/spring_elastic/controller/BookController.java @@ -0,0 +1,30 @@ +package com.example.spring_elastic.controller; + +import com.example.spring_elastic.models.Book; +import com.example.spring_elastic.service.BookElasticsearchService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + + +@RestController +@RequestMapping(value = "book") +public class BookController { + + @Autowired + BookElasticsearchService bookElasticsearchService; + + @GetMapping("/find_by_name") + ResponseEntity> getBooksByName(@RequestParam("name") String query) + { + Iterable booksFromElasticSearch = bookElasticsearchService.findBookByName(query); + + return ResponseEntity.ok(booksFromElasticSearch); + } + + @PostMapping("/create") + public ResponseEntity createBook(@RequestBody Book book) { + Book createdBook = bookElasticsearchService.createBook(book); + return ResponseEntity.ok(createdBook); + } +} \ No newline at end of file diff --git a/spring-elastic/src/main/java/com/example/spring_elastic/models/Book.java b/spring-elastic/src/main/java/com/example/spring_elastic/models/Book.java new file mode 100644 index 00000000..63d7a0af --- /dev/null +++ b/spring-elastic/src/main/java/com/example/spring_elastic/models/Book.java @@ -0,0 +1,56 @@ +package com.example.spring_elastic.models; + +import org.springframework.data.annotation.Id; +import org.springframework.data.elasticsearch.annotations.Document; + +@Document(indexName = "products") +public class Book { + + @Id + private String id; + private String name; + private String description; + private double price; + + public Book() {} + + public Book(String id, String name, String description, double price) { + this.id = id; + this.name = name; + this.description = description; + this.price = price; + } + + // Getters and setters + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public String getDescription() { + return description; + } + + public void setDescription(String description) { + this.description = description; + } + + public double getPrice() { + return price; + } + + public void setPrice(double price) { + this.price = price; + } +} \ No newline at end of file diff --git a/spring-elastic/src/main/java/com/example/spring_elastic/service/BookElasticsearchService.java b/spring-elastic/src/main/java/com/example/spring_elastic/service/BookElasticsearchService.java new file mode 100644 index 00000000..2a7abde2 --- /dev/null +++ b/spring-elastic/src/main/java/com/example/spring_elastic/service/BookElasticsearchService.java @@ -0,0 +1,64 @@ +package com.example.spring_elastic.service; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.example.spring_elastic.client.BookElasticsearchClient; +import com.example.spring_elastic.models.Book; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.annotation.Configuration; + + +import co.elastic.clients.elasticsearch._types.ElasticsearchException; +import co.elastic.clients.elasticsearch.core.SearchResponse; +import co.elastic.clients.elasticsearch.core.search.Hit; + +@Configuration +public class BookElasticsearchService { + @Autowired + private BookElasticsearchClient client; + private static final String BOOK_INDEX = "books"; + + public Book createBook(Book book) { + try { + client.getClient().index(i -> i + .index(BOOK_INDEX) + .id(book.getId()) + .document(book) + ); + return book; + } catch (ElasticsearchException | IOException e) { + e.printStackTrace(); + return null; + } + } + + public List findBookByName(String query) + { + List books = new ArrayList<>(); + + try { + SearchResponse search = client.getClient().search(s -> s + .index(BOOK_INDEX) + .query(q -> q + .match(t -> t + .field("name") + .query(query))), + Book.class); + + List> hits = search.hits().hits(); + for (Hit hit: hits) { + books.add(hit.source()); + } + + return books; + } catch (ElasticsearchException exception) { + exception.printStackTrace(); + } catch (IOException e) { + e.printStackTrace(); + } + + return null; + } +} \ No newline at end of file diff --git a/spring-elastic/src/main/resources/application.properties b/spring-elastic/src/main/resources/application.properties new file mode 100644 index 00000000..e56b9c0e --- /dev/null +++ b/spring-elastic/src/main/resources/application.properties @@ -0,0 +1,10 @@ +spring.application.name=spring-elastic +server.port=8081 + +spring.elasticsearch.url=localhost +spring.elasticsearch.port=9200 + +# Needed for client with credentials + +spring.elasticsearch.username= +spring.elasticsearch.password= diff --git a/spring-elastic/src/test/java/com/example/spring_elastic/SpringElasticApplicationTests.java b/spring-elastic/src/test/java/com/example/spring_elastic/SpringElasticApplicationTests.java new file mode 100644 index 00000000..56f838ed --- /dev/null +++ b/spring-elastic/src/test/java/com/example/spring_elastic/SpringElasticApplicationTests.java @@ -0,0 +1,13 @@ +package com.example.spring_elastic; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class SpringElasticApplicationTests { + + @Test + void contextLoads() { + } + +}