generated from 2martens/template-service
Initial commit
This commit is contained in:
commit
22af33852e
|
@ -0,0 +1,6 @@
|
||||||
|
mongo/.env filter=git-crypt diff=git-crypt
|
||||||
|
/template-server/src/main/resources/application.yaml filter=git-crypt diff=git-crypt
|
||||||
|
/template-server/src/integration-test/resources/application.yaml filter=git-crypt diff=git-crypt
|
||||||
|
/template-server/src/main/resources/application-prod.yaml filter=git-crypt diff=git-crypt
|
||||||
|
/template-server/src/main/resources/application-qs.yaml filter=git-crypt diff=git-crypt
|
||||||
|
/template-server/src/main/resources/application-test.yaml filter=git-crypt diff=git-crypt
|
|
@ -0,0 +1,34 @@
|
||||||
|
# ---> Java
|
||||||
|
# Compiled class file
|
||||||
|
*.class
|
||||||
|
|
||||||
|
# Log file
|
||||||
|
*.log
|
||||||
|
|
||||||
|
# BlueJ files
|
||||||
|
*.ctxt
|
||||||
|
|
||||||
|
# Mobile Tools for Java (J2ME)
|
||||||
|
.mtj.tmp/
|
||||||
|
|
||||||
|
# Package Files #
|
||||||
|
*.jar
|
||||||
|
*.war
|
||||||
|
*.nar
|
||||||
|
*.ear
|
||||||
|
*.zip
|
||||||
|
*.tar.gz
|
||||||
|
*.rar
|
||||||
|
|
||||||
|
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
|
||||||
|
hs_err_pid*
|
||||||
|
|
||||||
|
/.*
|
||||||
|
!/.gitignore
|
||||||
|
!/.gitattributes
|
||||||
|
.gradle
|
||||||
|
build/
|
||||||
|
!gradle/wrapper/gradle-wrapper.jar
|
||||||
|
!**/src/main/**
|
||||||
|
!**/src/test/**
|
||||||
|
**/lombok.config
|
|
@ -0,0 +1,208 @@
|
||||||
|
Apache License
|
||||||
|
|
||||||
|
Version 2.0, January 2004
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION,
|
||||||
|
AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction, and distribution
|
||||||
|
as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by the copyright
|
||||||
|
owner that is granting the License.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all other entities
|
||||||
|
that control, are controlled by, or are under common control with that entity.
|
||||||
|
For the purposes of this definition, "control" means (i) the power, direct
|
||||||
|
or indirect, to cause the direction or management of such entity, whether
|
||||||
|
by contract or otherwise, or (ii) ownership of fifty percent (50%) or more
|
||||||
|
of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions
|
||||||
|
granted by this License.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications, including
|
||||||
|
but not limited to software source code, documentation source, and configuration
|
||||||
|
files.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical transformation
|
||||||
|
or translation of a Source form, including but not limited to compiled object
|
||||||
|
code, generated documentation, and conversions to other media types.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or Object form,
|
||||||
|
made available under the License, as indicated by a copyright notice that
|
||||||
|
is included in or attached to the work (an example is provided in the Appendix
|
||||||
|
below).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object form,
|
||||||
|
that is based on (or derived from) the Work and for which the editorial revisions,
|
||||||
|
annotations, elaborations, or other modifications represent, as a whole, an
|
||||||
|
original work of authorship. For the purposes of this License, Derivative
|
||||||
|
Works shall not include works that remain separable from, or merely link (or
|
||||||
|
bind by name) to the interfaces of, the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including the original version
|
||||||
|
of the Work and any modifications or additions to that Work or Derivative
|
||||||
|
Works thereof, that is intentionally submitted to Licensor for inclusion in
|
||||||
|
the Work by the copyright owner or by an individual or Legal Entity authorized
|
||||||
|
to submit on behalf of the copyright owner. For the purposes of this definition,
|
||||||
|
"submitted" means any form of electronic, verbal, or written communication
|
||||||
|
sent to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems, and
|
||||||
|
issue tracking systems that are managed by, or on behalf of, the Licensor
|
||||||
|
for the purpose of discussing and improving the Work, but excluding communication
|
||||||
|
that is conspicuously marked or otherwise designated in writing by the copyright
|
||||||
|
owner as "Not a Contribution."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
|
||||||
|
of whom a Contribution has been received by Licensor and subsequently incorporated
|
||||||
|
within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of this
|
||||||
|
License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
|
||||||
|
no-charge, royalty-free, irrevocable copyright license to reproduce, prepare
|
||||||
|
Derivative Works of, publicly display, publicly perform, sublicense, and distribute
|
||||||
|
the Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of this License,
|
||||||
|
each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
|
||||||
|
no-charge, royalty-free, irrevocable (except as stated in this section) patent
|
||||||
|
license to make, have made, use, offer to sell, sell, import, and otherwise
|
||||||
|
transfer the Work, where such license applies only to those patent claims
|
||||||
|
licensable by such Contributor that are necessarily infringed by their Contribution(s)
|
||||||
|
alone or by combination of their Contribution(s) with the Work to which such
|
||||||
|
Contribution(s) was submitted. If You institute patent litigation against
|
||||||
|
any entity (including a cross-claim or counterclaim in a lawsuit) alleging
|
||||||
|
that the Work or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses granted to You
|
||||||
|
under this License for that Work shall terminate as of the date such litigation
|
||||||
|
is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the Work or
|
||||||
|
Derivative Works thereof in any medium, with or without modifications, and
|
||||||
|
in Source or Object form, provided that You meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or Derivative Works a copy
|
||||||
|
of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices stating that
|
||||||
|
You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works that You distribute,
|
||||||
|
all copyright, patent, trademark, and attribution notices from the Source
|
||||||
|
form of the Work, excluding those notices that do not pertain to any part
|
||||||
|
of the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its distribution,
|
||||||
|
then any Derivative Works that You distribute must include a readable copy
|
||||||
|
of the attribution notices contained within such NOTICE file, excluding those
|
||||||
|
notices that do not pertain to any part of the Derivative Works, in at least
|
||||||
|
one of the following places: within a NOTICE text file distributed as part
|
||||||
|
of the Derivative Works; within the Source form or documentation, if provided
|
||||||
|
along with the Derivative Works; or, within a display generated by the Derivative
|
||||||
|
Works, if and wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and do not modify the
|
||||||
|
License. You may add Your own attribution notices within Derivative Works
|
||||||
|
that You distribute, alongside or as an addendum to the NOTICE text from the
|
||||||
|
Work, provided that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and may provide
|
||||||
|
additional or different license terms and conditions for use, reproduction,
|
||||||
|
or distribution of Your modifications, or for any such Derivative Works as
|
||||||
|
a whole, provided Your use, reproduction, and distribution of the Work otherwise
|
||||||
|
complies with the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise, any
|
||||||
|
Contribution intentionally submitted for inclusion in the Work by You to the
|
||||||
|
Licensor shall be under the terms and conditions of this License, without
|
||||||
|
any additional terms or conditions. Notwithstanding the above, nothing herein
|
||||||
|
shall supersede or modify the terms of any separate license agreement you
|
||||||
|
may have executed with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade names,
|
||||||
|
trademarks, service marks, or product names of the Licensor, except as required
|
||||||
|
for reasonable and customary use in describing the origin of the Work and
|
||||||
|
reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or agreed to
|
||||||
|
in writing, Licensor provides the Work (and each Contributor provides its
|
||||||
|
Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||||
|
KIND, either express or implied, including, without limitation, any warranties
|
||||||
|
or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness
|
||||||
|
of using or redistributing the Work and assume any risks associated with Your
|
||||||
|
exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory, whether
|
||||||
|
in tort (including negligence), contract, or otherwise, unless required by
|
||||||
|
applicable law (such as deliberate and grossly negligent acts) or agreed to
|
||||||
|
in writing, shall any Contributor be liable to You for damages, including
|
||||||
|
any direct, indirect, special, incidental, or consequential damages of any
|
||||||
|
character arising as a result of this License or out of the use or inability
|
||||||
|
to use the Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all other commercial
|
||||||
|
damages or losses), even if such Contributor has been advised of the possibility
|
||||||
|
of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing the Work
|
||||||
|
or Derivative Works thereof, You may choose to offer, and charge a fee for,
|
||||||
|
acceptance of support, warranty, indemnity, or other liability obligations
|
||||||
|
and/or rights consistent with this License. However, in accepting such obligations,
|
||||||
|
You may act only on Your own behalf and on Your sole responsibility, not on
|
||||||
|
behalf of any other Contributor, and only if You agree to indemnify, defend,
|
||||||
|
and hold each Contributor harmless for any liability incurred by, or claims
|
||||||
|
asserted against, such Contributor by reason of your accepting any such warranty
|
||||||
|
or additional liability. END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following boilerplate
|
||||||
|
notice, with the fields enclosed by brackets "[]" replaced with your own identifying
|
||||||
|
information. (Don't include the brackets!) The text should be enclosed in
|
||||||
|
the appropriate comment syntax for the file format. We also recommend that
|
||||||
|
a file or class name and description of purpose be included on the same "printed
|
||||||
|
page" as the copyright notice for easier identification within third-party
|
||||||
|
archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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.
|
|
@ -0,0 +1,28 @@
|
||||||
|
# Instructions for using the template
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
This template is based upon best practices and uses Spring Boot to implement
|
||||||
|
REST APIs.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
* clone the project and create a new repository
|
||||||
|
* replace all occurences of 'template' with your service name, 'Template' accordingly (mind the cases)
|
||||||
|
* import the project in your IDE
|
||||||
|
* run initial `gradlew build`
|
||||||
|
|
||||||
|
**============ // todo: Ab hier die Doku überprüfen und ggf. ergänzen ==========**
|
||||||
|
|
||||||
|
# Template
|
||||||
|
**// todo: Hier sollte das Projekt etwas beschrieben werden**
|
||||||
|
|
||||||
|
## Git
|
||||||
|
|
||||||
|
The repository of ... is located under https://git.2martens.de/2martens/template-service.git
|
||||||
|
|
||||||
|
It is partially encrypted with git-crypt and has to be decrypted first:
|
||||||
|
```bash
|
||||||
|
git-crypt unlock %USERPROFILE%/.git-crypt-key
|
||||||
|
```
|
||||||
|
|
|
@ -0,0 +1,70 @@
|
||||||
|
plugins {
|
||||||
|
id 'java'
|
||||||
|
id 'idea'
|
||||||
|
id 'eclipse'
|
||||||
|
id 'jacoco' // for linecoverage
|
||||||
|
id 'nebula.release' version '14.0.3'
|
||||||
|
id 'nebula.maven-publish' version '15.0.3'
|
||||||
|
id 'org.owasp.dependencycheck' version '5.3.0' // checking dependencies for known vulnerabilities
|
||||||
|
id 'io.freefair.lombok' version '4.1.6'
|
||||||
|
}
|
||||||
|
|
||||||
|
subprojects {
|
||||||
|
apply plugin: 'java'
|
||||||
|
apply plugin: 'idea'
|
||||||
|
apply plugin: 'eclipse'
|
||||||
|
apply plugin: 'jacoco'
|
||||||
|
apply plugin: 'nebula.release'
|
||||||
|
apply plugin: 'nebula.maven-publish'
|
||||||
|
apply plugin: 'io.freefair.lombok'
|
||||||
|
|
||||||
|
sourceCompatibility = projectSourceCompatibility
|
||||||
|
targetCompatibility = projectSourceCompatibility
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
implementation 'org.slf4j:slf4j-api:1.7.30'
|
||||||
|
|
||||||
|
testImplementation "org.junit.jupiter:junit-jupiter:5.5.2"
|
||||||
|
testImplementation 'org.assertj:assertj-core:3.11.1'
|
||||||
|
}
|
||||||
|
|
||||||
|
test {
|
||||||
|
useJUnitPlatform()
|
||||||
|
}
|
||||||
|
|
||||||
|
configurations {
|
||||||
|
developmentOnly
|
||||||
|
runtimeClasspath {
|
||||||
|
extendsFrom developmentOnly
|
||||||
|
}
|
||||||
|
compileOnly {
|
||||||
|
extendsFrom annotationProcessor
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
allprojects {
|
||||||
|
|
||||||
|
group = projectgroup
|
||||||
|
|
||||||
|
nebulaRelease {
|
||||||
|
addReleaseBranchPattern(/master/)
|
||||||
|
}
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencyCheck {
|
||||||
|
formats = ['XML', 'HTML']
|
||||||
|
suppressionFile = "$rootProject.projectDir/gradle/config/suppression.xml"
|
||||||
|
analyzers {
|
||||||
|
assemblyEnabled = false // no warning for .NET in gradle output - we don't use .NET
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
clean {
|
||||||
|
delete 'out'
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,6 @@
|
||||||
|
projectname=template-service
|
||||||
|
projectgroup=de.twomartens
|
||||||
|
projectSourceCompatibility=11
|
||||||
|
org.gradle.daemon=true
|
||||||
|
org.gradle.configureondemand=true
|
||||||
|
org.gradle.jvmargs=-Xmx4g -XX:MaxPermSize=2048m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8
|
|
@ -0,0 +1,22 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<suppressions xmlns="https://jeremylong.github.io/DependencyCheck/dependency-suppression.1.3.xsd">
|
||||||
|
|
||||||
|
<!-- grpc-netty-shaded-1.22.2 isn't netty in version 1.22.2 -->
|
||||||
|
<suppress>
|
||||||
|
<notes><![CDATA[
|
||||||
|
file name: grpc-netty-shaded-1.22.2.jar
|
||||||
|
]]></notes>
|
||||||
|
<packageUrl regex="true">^pkg:maven/io\.grpc/grpc\-netty\-shaded@.*$</packageUrl>
|
||||||
|
<cpe>cpe:/a:netty:netty</cpe>
|
||||||
|
</suppress>
|
||||||
|
|
||||||
|
<!-- grpc-netty-1.22.2 isn't netty in version 1.22.2 -->
|
||||||
|
<suppress>
|
||||||
|
<notes><![CDATA[
|
||||||
|
file name: grpc-netty-1.22.2.jar
|
||||||
|
]]></notes>
|
||||||
|
<packageUrl regex="true">^pkg:maven/io\.grpc/grpc\-netty@.*$</packageUrl>
|
||||||
|
<cpe>cpe:/a:netty:netty</cpe>
|
||||||
|
</suppress>
|
||||||
|
|
||||||
|
</suppressions>
|
|
@ -0,0 +1,5 @@
|
||||||
|
distributionBase=GRADLE_USER_HOME
|
||||||
|
distributionPath=wrapper/dists
|
||||||
|
distributionUrl=https\://services.gradle.org/distributions/gradle-6.3-all.zip
|
||||||
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
|
zipStorePath=wrapper/dists
|
|
@ -0,0 +1,183 @@
|
||||||
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
|
#
|
||||||
|
# Copyright 2015 the original author or 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.
|
||||||
|
#
|
||||||
|
|
||||||
|
##############################################################################
|
||||||
|
##
|
||||||
|
## Gradle start up script for UN*X
|
||||||
|
##
|
||||||
|
##############################################################################
|
||||||
|
|
||||||
|
# Attempt to set APP_HOME
|
||||||
|
# Resolve links: $0 may be a link
|
||||||
|
PRG="$0"
|
||||||
|
# Need this for relative symlinks.
|
||||||
|
while [ -h "$PRG" ] ; do
|
||||||
|
ls=`ls -ld "$PRG"`
|
||||||
|
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
PRG="$link"
|
||||||
|
else
|
||||||
|
PRG=`dirname "$PRG"`"/$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
SAVED="`pwd`"
|
||||||
|
cd "`dirname \"$PRG\"`/" >/dev/null
|
||||||
|
APP_HOME="`pwd -P`"
|
||||||
|
cd "$SAVED" >/dev/null
|
||||||
|
|
||||||
|
APP_NAME="Gradle"
|
||||||
|
APP_BASE_NAME=`basename "$0"`
|
||||||
|
|
||||||
|
# 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"'
|
||||||
|
|
||||||
|
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||||
|
MAX_FD="maximum"
|
||||||
|
|
||||||
|
warn () {
|
||||||
|
echo "$*"
|
||||||
|
}
|
||||||
|
|
||||||
|
die () {
|
||||||
|
echo
|
||||||
|
echo "$*"
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# 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
|
||||||
|
;;
|
||||||
|
MINGW* )
|
||||||
|
msys=true
|
||||||
|
;;
|
||||||
|
NONSTOP* )
|
||||||
|
nonstop=true
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||||
|
|
||||||
|
# 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"
|
||||||
|
which java >/dev/null 2>&1 || 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
|
||||||
|
|
||||||
|
# Increase the maximum file descriptors if we can.
|
||||||
|
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
|
||||||
|
MAX_FD_LIMIT=`ulimit -H -n`
|
||||||
|
if [ $? -eq 0 ] ; then
|
||||||
|
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
|
||||||
|
MAX_FD="$MAX_FD_LIMIT"
|
||||||
|
fi
|
||||||
|
ulimit -n $MAX_FD
|
||||||
|
if [ $? -ne 0 ] ; then
|
||||||
|
warn "Could not set maximum file descriptor limit: $MAX_FD"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# For Darwin, add options to specify how the application appears in the dock
|
||||||
|
if $darwin; then
|
||||||
|
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
|
||||||
|
fi
|
||||||
|
|
||||||
|
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||||
|
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
|
||||||
|
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
|
||||||
|
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
|
||||||
|
JAVACMD=`cygpath --unix "$JAVACMD"`
|
||||||
|
|
||||||
|
# We build the pattern for arguments to be converted via cygpath
|
||||||
|
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
|
||||||
|
SEP=""
|
||||||
|
for dir in $ROOTDIRSRAW ; do
|
||||||
|
ROOTDIRS="$ROOTDIRS$SEP$dir"
|
||||||
|
SEP="|"
|
||||||
|
done
|
||||||
|
OURCYGPATTERN="(^($ROOTDIRS))"
|
||||||
|
# Add a user-defined pattern to the cygpath arguments
|
||||||
|
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
|
||||||
|
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
|
||||||
|
fi
|
||||||
|
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||||
|
i=0
|
||||||
|
for arg in "$@" ; do
|
||||||
|
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
|
||||||
|
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
|
||||||
|
|
||||||
|
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
|
||||||
|
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
|
||||||
|
else
|
||||||
|
eval `echo args$i`="\"$arg\""
|
||||||
|
fi
|
||||||
|
i=`expr $i + 1`
|
||||||
|
done
|
||||||
|
case $i in
|
||||||
|
0) set -- ;;
|
||||||
|
1) set -- "$args0" ;;
|
||||||
|
2) set -- "$args0" "$args1" ;;
|
||||||
|
3) set -- "$args0" "$args1" "$args2" ;;
|
||||||
|
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
|
||||||
|
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
|
||||||
|
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
|
||||||
|
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
|
||||||
|
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
|
||||||
|
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Escape application args
|
||||||
|
save () {
|
||||||
|
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
|
||||||
|
echo " "
|
||||||
|
}
|
||||||
|
APP_ARGS=`save "$@"`
|
||||||
|
|
||||||
|
# Collect all arguments for the java command, following the shell quoting and substitution rules
|
||||||
|
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
|
||||||
|
|
||||||
|
exec "$JAVACMD" "$@"
|
|
@ -0,0 +1,100 @@
|
||||||
|
@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
|
||||||
|
|
||||||
|
@if "%DEBUG%" == "" @echo off
|
||||||
|
@rem ##########################################################################
|
||||||
|
@rem
|
||||||
|
@rem Gradle startup script for Windows
|
||||||
|
@rem
|
||||||
|
@rem ##########################################################################
|
||||||
|
|
||||||
|
@rem Set local scope for the variables with windows NT shell
|
||||||
|
if "%OS%"=="Windows_NT" setlocal
|
||||||
|
|
||||||
|
set DIRNAME=%~dp0
|
||||||
|
if "%DIRNAME%" == "" set DIRNAME=.
|
||||||
|
set APP_BASE_NAME=%~n0
|
||||||
|
set APP_HOME=%DIRNAME%
|
||||||
|
|
||||||
|
@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%" == "0" goto init
|
||||||
|
|
||||||
|
echo.
|
||||||
|
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
echo.
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
echo location of your Java installation.
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:findJavaFromJavaHome
|
||||||
|
set JAVA_HOME=%JAVA_HOME:"=%
|
||||||
|
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||||
|
|
||||||
|
if exist "%JAVA_EXE%" goto init
|
||||||
|
|
||||||
|
echo.
|
||||||
|
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
|
||||||
|
echo.
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
echo location of your Java installation.
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:init
|
||||||
|
@rem Get command-line arguments, handling Windows variants
|
||||||
|
|
||||||
|
if not "%OS%" == "Windows_NT" goto win9xME_args
|
||||||
|
|
||||||
|
:win9xME_args
|
||||||
|
@rem Slurp the command line arguments.
|
||||||
|
set CMD_LINE_ARGS=
|
||||||
|
set _SKIP=2
|
||||||
|
|
||||||
|
:win9xME_args_slurp
|
||||||
|
if "x%~1" == "x" goto execute
|
||||||
|
|
||||||
|
set CMD_LINE_ARGS=%*
|
||||||
|
|
||||||
|
:execute
|
||||||
|
@rem Setup the command line
|
||||||
|
|
||||||
|
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||||
|
|
||||||
|
@rem Execute Gradle
|
||||||
|
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
|
||||||
|
|
||||||
|
:end
|
||||||
|
@rem End local scope for the variables with windows NT shell
|
||||||
|
if "%ERRORLEVEL%"=="0" goto mainEnd
|
||||||
|
|
||||||
|
:fail
|
||||||
|
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||||
|
rem the _cmd.exe /c_ return code!
|
||||||
|
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
|
||||||
|
exit /b 1
|
||||||
|
|
||||||
|
:mainEnd
|
||||||
|
if "%OS%"=="Windows_NT" endlocal
|
||||||
|
|
||||||
|
:omega
|
|
@ -0,0 +1,7 @@
|
||||||
|
rootProject.name = projectname
|
||||||
|
|
||||||
|
include 'template-server'
|
||||||
|
|
||||||
|
rootProject.children.each { subproject ->
|
||||||
|
subproject.buildFileName = "${subproject.name}.gradle"
|
||||||
|
}
|
|
@ -0,0 +1,62 @@
|
||||||
|
package de.twomartens.templateservice;
|
||||||
|
|
||||||
|
import de.twomartens.templateservice.entity.Greeting;
|
||||||
|
import de.twomartens.templateservice.interceptors.RequestTypeInterceptor;
|
||||||
|
import de.twomartens.templateservice.interceptors.TraceIdInterceptor;
|
||||||
|
import org.junit.jupiter.api.BeforeEach;
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
import org.springframework.beans.factory.annotation.Autowired;
|
||||||
|
import org.springframework.boot.test.context.SpringBootTest;
|
||||||
|
import org.springframework.boot.web.server.LocalServerPort;
|
||||||
|
import org.springframework.http.ResponseEntity;
|
||||||
|
import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
|
||||||
|
import org.springframework.web.client.RestTemplate;
|
||||||
|
|
||||||
|
import static org.assertj.core.api.Assertions.assertThat;
|
||||||
|
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;
|
||||||
|
|
||||||
|
@SpringJUnitConfig
|
||||||
|
@SpringBootTest(webEnvironment = RANDOM_PORT)
|
||||||
|
class TemplateServiceRestTests {
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
private RestTemplate restTemplate;
|
||||||
|
|
||||||
|
@LocalServerPort
|
||||||
|
int randomServerPort;
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
private RequestTypeInterceptor requestTypeInterceptor;
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
private TraceIdInterceptor traceIdInterceptor;
|
||||||
|
|
||||||
|
@BeforeEach
|
||||||
|
void setup() {
|
||||||
|
traceIdInterceptor.createNewTraceId();
|
||||||
|
requestTypeInterceptor.markAsIntegrationTest();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void testRestService() {
|
||||||
|
ResponseEntity<Greeting> result = restTemplate.getForEntity(getEndpoint(), Greeting.class);
|
||||||
|
assertThat(result.getStatusCode().is2xxSuccessful()).isTrue();
|
||||||
|
assertThat(result.getBody()).isNotNull();
|
||||||
|
assertThat(result.getBody().getMessage()).isEqualTo("Hello RestCheck!");
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This method is so complicated because it uses the local-grpc-server configuration for grpc to create
|
||||||
|
* a correct link for the rest endpoints in the cloud
|
||||||
|
*/
|
||||||
|
private String getEndpoint() {
|
||||||
|
String hostNameForGrpcServer = "127.0.0.1";
|
||||||
|
int port = randomServerPort;
|
||||||
|
String protocol = "http";
|
||||||
|
|
||||||
|
return String.format("%s://%s:%d/greeting?name=RestCheck",
|
||||||
|
protocol,
|
||||||
|
hostNameForGrpcServer,
|
||||||
|
port);
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,29 @@
|
||||||
|
package de.twomartens.templateservice;
|
||||||
|
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.boot.SpringApplication;
|
||||||
|
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||||
|
import org.springframework.scheduling.annotation.EnableScheduling;
|
||||||
|
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
@Slf4j
|
||||||
|
@SpringBootApplication
|
||||||
|
@EnableScheduling
|
||||||
|
public class TemplateServiceApplication {
|
||||||
|
|
||||||
|
public static void main(String[] args) {
|
||||||
|
log.info(">>> {}:{} <<<", getTitle(), getVersion());
|
||||||
|
SpringApplication.run(TemplateServiceApplication.class, args);
|
||||||
|
}
|
||||||
|
|
||||||
|
private static String getTitle() {
|
||||||
|
return Optional.ofNullable(TemplateServiceApplication.class.getPackage().getImplementationTitle())
|
||||||
|
.orElse("start");
|
||||||
|
}
|
||||||
|
|
||||||
|
private static String getVersion() {
|
||||||
|
return Optional.ofNullable(TemplateServiceApplication.class.getPackage().getImplementationVersion())
|
||||||
|
.orElse("snapshot");
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,68 @@
|
||||||
|
package de.twomartens.templateservice.actuator;
|
||||||
|
|
||||||
|
import de.twomartens.templateservice.interceptors.RequestTypeInterceptor;
|
||||||
|
import de.twomartens.templateservice.interceptors.TraceIdInterceptor;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.boot.actuate.health.Health;
|
||||||
|
import org.springframework.boot.actuate.health.HealthIndicator;
|
||||||
|
|
||||||
|
@Slf4j
|
||||||
|
public abstract class AbstractHealthCheck implements HealthIndicator {
|
||||||
|
|
||||||
|
private static final String DEFAULT_HOST = "localhost";
|
||||||
|
private static final String HEALTH_KEY_ENDPOINT = "endpoint";
|
||||||
|
|
||||||
|
private final String endpoint;
|
||||||
|
|
||||||
|
private final TraceIdInterceptor traceIdInterceptor;
|
||||||
|
|
||||||
|
private final RequestTypeInterceptor requestTypeInterceptor;
|
||||||
|
|
||||||
|
private final int port;
|
||||||
|
|
||||||
|
public AbstractHealthCheck(int port,
|
||||||
|
TraceIdInterceptor traceIdInterceptor,
|
||||||
|
RequestTypeInterceptor requestTypeInterceptor) {
|
||||||
|
this.traceIdInterceptor = traceIdInterceptor;
|
||||||
|
this.requestTypeInterceptor = requestTypeInterceptor;
|
||||||
|
this.port = port;
|
||||||
|
this.endpoint = mkEndpoint();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Health health() {
|
||||||
|
requestTypeInterceptor.markAsHealthCheck();
|
||||||
|
traceIdInterceptor.createNewTraceId();
|
||||||
|
Health result;
|
||||||
|
try {
|
||||||
|
if (isEndpointAvailable()) {
|
||||||
|
result = Health.up().withDetail(HEALTH_KEY_ENDPOINT, getEndpoint()).build();
|
||||||
|
} else {
|
||||||
|
result = Health.down().withDetail(HEALTH_KEY_ENDPOINT, getEndpoint()).build();
|
||||||
|
}
|
||||||
|
} catch (Exception e) {
|
||||||
|
result = Health.down().withDetail(HEALTH_KEY_ENDPOINT, getEndpoint()).withException(e).build();
|
||||||
|
}
|
||||||
|
log.info("health check invoked for '{}' with status '{}'", getMethodName(), result.getStatus());
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
String getHost() {
|
||||||
|
return DEFAULT_HOST;
|
||||||
|
}
|
||||||
|
|
||||||
|
int getPort() {
|
||||||
|
return this.port;
|
||||||
|
}
|
||||||
|
|
||||||
|
String getEndpoint() {
|
||||||
|
return this.endpoint;
|
||||||
|
}
|
||||||
|
|
||||||
|
abstract boolean isEndpointAvailable();
|
||||||
|
|
||||||
|
abstract String getMethodName();
|
||||||
|
|
||||||
|
abstract String mkEndpoint();
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,56 @@
|
||||||
|
package de.twomartens.templateservice.actuator;
|
||||||
|
|
||||||
|
import de.twomartens.templateservice.entity.Greeting;
|
||||||
|
import de.twomartens.templateservice.interceptors.RequestTypeInterceptor;
|
||||||
|
import de.twomartens.templateservice.interceptors.TraceIdInterceptor;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.boot.actuate.health.HealthIndicator;
|
||||||
|
import org.springframework.boot.autoconfigure.web.ServerProperties;
|
||||||
|
import org.springframework.http.ResponseEntity;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
import org.springframework.web.client.RestClientException;
|
||||||
|
import org.springframework.web.client.RestTemplate;
|
||||||
|
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A Health check which checks if the rest services are working.]
|
||||||
|
*/
|
||||||
|
@Slf4j
|
||||||
|
@Component
|
||||||
|
public class RestHealthCheck extends AbstractHealthCheck implements HealthIndicator {
|
||||||
|
|
||||||
|
private final RestTemplate restTemplate;
|
||||||
|
|
||||||
|
public RestHealthCheck(ServerProperties serverProperties,
|
||||||
|
TraceIdInterceptor traceIdInterceptor,
|
||||||
|
RequestTypeInterceptor requestTypeInterceptor,
|
||||||
|
RestTemplate restTemplate) {
|
||||||
|
super(Optional.ofNullable(serverProperties.getPort()).orElse(8080),
|
||||||
|
traceIdInterceptor, requestTypeInterceptor);
|
||||||
|
this.restTemplate = restTemplate;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
boolean isEndpointAvailable() {
|
||||||
|
try {
|
||||||
|
ResponseEntity<Greeting> result = restTemplate.getForEntity(getEndpoint(), Greeting.class);
|
||||||
|
Greeting body = result.getBody();
|
||||||
|
if (body == null) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return !body.getMessage().isEmpty();
|
||||||
|
} catch (RestClientException e) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
String getMethodName() {
|
||||||
|
return "template-service-rest";
|
||||||
|
}
|
||||||
|
|
||||||
|
String mkEndpoint() {
|
||||||
|
return String.format("http://%s:%d/greeting?name=RestHealthCheck", getHost(), getPort());
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,19 @@
|
||||||
|
package de.twomartens.templateservice.configs;
|
||||||
|
|
||||||
|
import lombok.Data;
|
||||||
|
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@Configuration
|
||||||
|
@ConfigurationProperties(prefix = "de.twomartens.templateservice")
|
||||||
|
public class TemplateServiceProperties {
|
||||||
|
|
||||||
|
private final Template template = new Template();
|
||||||
|
|
||||||
|
@Data
|
||||||
|
public static class Template {
|
||||||
|
|
||||||
|
private String greeting;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,47 @@
|
||||||
|
package de.twomartens.templateservice.configs;
|
||||||
|
|
||||||
|
import de.twomartens.templateservice.interceptors.RequestTypeInterceptor;
|
||||||
|
import de.twomartens.templateservice.interceptors.TraceIdInterceptor;
|
||||||
|
import org.springframework.context.annotation.Bean;
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
import org.springframework.http.client.ClientHttpRequestInterceptor;
|
||||||
|
import org.springframework.util.CollectionUtils;
|
||||||
|
import org.springframework.web.client.RestTemplate;
|
||||||
|
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
|
||||||
|
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
|
||||||
|
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
|
||||||
|
import org.springframework.web.servlet.view.InternalResourceViewResolver;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
@EnableWebMvc
|
||||||
|
@Configuration
|
||||||
|
public class WebConfig implements WebMvcConfigurer {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void addInterceptors(InterceptorRegistry registry) {
|
||||||
|
registry.addInterceptor(new TraceIdInterceptor());
|
||||||
|
registry.addInterceptor(new RequestTypeInterceptor());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
public InternalResourceViewResolver defaultViewResolver() {
|
||||||
|
return new InternalResourceViewResolver();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
public RestTemplate restTemplate() {
|
||||||
|
RestTemplate restTemplate = new RestTemplate();
|
||||||
|
|
||||||
|
List<ClientHttpRequestInterceptor> interceptors
|
||||||
|
= restTemplate.getInterceptors();
|
||||||
|
if (CollectionUtils.isEmpty(interceptors)) {
|
||||||
|
interceptors = new ArrayList<>();
|
||||||
|
}
|
||||||
|
interceptors.add(new TraceIdInterceptor());
|
||||||
|
interceptors.add(new RequestTypeInterceptor());
|
||||||
|
restTemplate.setInterceptors(interceptors);
|
||||||
|
return restTemplate;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,24 @@
|
||||||
|
package de.twomartens.templateservice.control;
|
||||||
|
|
||||||
|
import de.twomartens.templateservice.entity.Greeting;
|
||||||
|
import de.twomartens.templateservice.service.GreetingService;
|
||||||
|
import org.springframework.web.bind.annotation.GetMapping;
|
||||||
|
import org.springframework.web.bind.annotation.RequestParam;
|
||||||
|
import org.springframework.web.bind.annotation.ResponseBody;
|
||||||
|
import org.springframework.web.bind.annotation.RestController;
|
||||||
|
|
||||||
|
@RestController
|
||||||
|
public class GreetingController {
|
||||||
|
|
||||||
|
private final GreetingService service;
|
||||||
|
|
||||||
|
GreetingController(GreetingService service) {
|
||||||
|
this.service = service;
|
||||||
|
}
|
||||||
|
|
||||||
|
@GetMapping("/greeting")
|
||||||
|
@ResponseBody
|
||||||
|
public Greeting greeting(@RequestParam(value = "name", defaultValue = "World") String name) {
|
||||||
|
return Greeting.builder().message(service.createGreeting(name)).build();
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,18 @@
|
||||||
|
package de.twomartens.templateservice.entity;
|
||||||
|
|
||||||
|
import io.swagger.v3.oas.annotations.media.Schema;
|
||||||
|
import lombok.*;
|
||||||
|
|
||||||
|
@Builder
|
||||||
|
@Getter
|
||||||
|
@ToString
|
||||||
|
@EqualsAndHashCode
|
||||||
|
@AllArgsConstructor(access = AccessLevel.PRIVATE)
|
||||||
|
@NoArgsConstructor(force = true, access = AccessLevel.PRIVATE)
|
||||||
|
public class Greeting {
|
||||||
|
|
||||||
|
@NonNull
|
||||||
|
@Schema(description = "This message is displayed")
|
||||||
|
private final String message;
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,52 @@
|
||||||
|
package de.twomartens.templateservice.interceptors;
|
||||||
|
|
||||||
|
import lombok.NoArgsConstructor;
|
||||||
|
import org.slf4j.MDC;
|
||||||
|
import org.springframework.http.HttpRequest;
|
||||||
|
import org.springframework.http.client.ClientHttpRequestExecution;
|
||||||
|
import org.springframework.http.client.ClientHttpRequestInterceptor;
|
||||||
|
import org.springframework.http.client.ClientHttpResponse;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
|
||||||
|
|
||||||
|
import javax.servlet.http.HttpServletRequest;
|
||||||
|
import javax.servlet.http.HttpServletResponse;
|
||||||
|
import java.io.IOException;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* marks requests of certain types like health check or integration test for better logging
|
||||||
|
*/
|
||||||
|
@Component
|
||||||
|
@NoArgsConstructor
|
||||||
|
public class RequestTypeInterceptor extends HandlerInterceptorAdapter
|
||||||
|
implements ClientHttpRequestInterceptor {
|
||||||
|
|
||||||
|
private static final String LOGGER_ID = "REQTYPE";
|
||||||
|
private static final String HEADER_FIELD_ID = "x-type";
|
||||||
|
|
||||||
|
public void markAsHealthCheck() {
|
||||||
|
MDC.put(LOGGER_ID, "HEALTH_CHECK");
|
||||||
|
}
|
||||||
|
|
||||||
|
public void markAsIntegrationTest() {
|
||||||
|
MDC.put(LOGGER_ID, "INTEGRATION_TEST");
|
||||||
|
}
|
||||||
|
|
||||||
|
// web client interceptor
|
||||||
|
@Override
|
||||||
|
public ClientHttpResponse intercept(
|
||||||
|
HttpRequest request,
|
||||||
|
byte[] body,
|
||||||
|
ClientHttpRequestExecution execution) throws IOException {
|
||||||
|
request.getHeaders().add(HEADER_FIELD_ID, MDC.get(LOGGER_ID));
|
||||||
|
return execution.execute(request, body);
|
||||||
|
}
|
||||||
|
|
||||||
|
// web server interceptor
|
||||||
|
@Override
|
||||||
|
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
|
||||||
|
MDC.put(LOGGER_ID, request.getHeader(HEADER_FIELD_ID));
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,87 @@
|
||||||
|
package de.twomartens.templateservice.interceptors;
|
||||||
|
|
||||||
|
import lombok.NoArgsConstructor;
|
||||||
|
import org.slf4j.MDC;
|
||||||
|
import org.springframework.http.HttpRequest;
|
||||||
|
import org.springframework.http.client.ClientHttpRequestExecution;
|
||||||
|
import org.springframework.http.client.ClientHttpRequestInterceptor;
|
||||||
|
import org.springframework.http.client.ClientHttpResponse;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
|
||||||
|
|
||||||
|
import javax.servlet.http.HttpServletRequest;
|
||||||
|
import javax.servlet.http.HttpServletResponse;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.util.UUID;
|
||||||
|
|
||||||
|
@Component
|
||||||
|
@NoArgsConstructor
|
||||||
|
public class TraceIdInterceptor extends HandlerInterceptorAdapter
|
||||||
|
implements ClientHttpRequestInterceptor {
|
||||||
|
|
||||||
|
private static final String LOGGER_TRACE_ID = "TraceID";
|
||||||
|
private static final String HEADER_FIELD_TRACE_ID = "X-TraceId";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the TraceId from the MDC or create a new one and put it to the MDC
|
||||||
|
*/
|
||||||
|
public String getTraceId() {
|
||||||
|
String traceId = MDC.get(LOGGER_TRACE_ID);
|
||||||
|
if (traceId == null || traceId.trim().isEmpty()) {
|
||||||
|
traceId = UUID.randomUUID().toString();
|
||||||
|
MDC.put(LOGGER_TRACE_ID, traceId);
|
||||||
|
}
|
||||||
|
return traceId;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A failsafe method to set a TraceId to the MDC.
|
||||||
|
*
|
||||||
|
* @param traceId should be a traceId, if it is null or empty a new one will be created.
|
||||||
|
* @return the traceId param, or a new one, if it was empty
|
||||||
|
*/
|
||||||
|
public String setOrCreateTraceId(String traceId) {
|
||||||
|
if (traceId == null || traceId.trim().isEmpty()) {
|
||||||
|
traceId = UUID.randomUUID().toString();
|
||||||
|
}
|
||||||
|
MDC.put(LOGGER_TRACE_ID, traceId);
|
||||||
|
return traceId;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes the traceId from the MDC.
|
||||||
|
*/
|
||||||
|
public void resetTraceId() {
|
||||||
|
MDC.remove(LOGGER_TRACE_ID);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new traceId for this thread.
|
||||||
|
*
|
||||||
|
* An old one will be overwritten!
|
||||||
|
*/
|
||||||
|
public void createNewTraceId() {
|
||||||
|
resetTraceId();
|
||||||
|
getTraceId();
|
||||||
|
}
|
||||||
|
|
||||||
|
// client interceptor web
|
||||||
|
@Override
|
||||||
|
public ClientHttpResponse intercept(
|
||||||
|
HttpRequest request,
|
||||||
|
byte[] body,
|
||||||
|
ClientHttpRequestExecution execution) throws IOException {
|
||||||
|
request.getHeaders().add(HEADER_FIELD_TRACE_ID, getTraceId());
|
||||||
|
return execution.execute(request, body);
|
||||||
|
}
|
||||||
|
|
||||||
|
// server interceptor web
|
||||||
|
@Override
|
||||||
|
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
|
||||||
|
String traceId = request.getHeader(HEADER_FIELD_TRACE_ID);
|
||||||
|
setOrCreateTraceId(traceId);
|
||||||
|
response.addHeader(HEADER_FIELD_TRACE_ID, getTraceId());
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,30 @@
|
||||||
|
package de.twomartens.templateservice.service;
|
||||||
|
|
||||||
|
import de.twomartens.templateservice.configs.TemplateServiceProperties;
|
||||||
|
import io.micrometer.core.instrument.Counter;
|
||||||
|
import io.micrometer.core.instrument.MeterRegistry;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
import org.springframework.stereotype.Service;
|
||||||
|
|
||||||
|
@Slf4j
|
||||||
|
@Service
|
||||||
|
public class GreetingService {
|
||||||
|
|
||||||
|
private final MeterRegistry meterRegistry;
|
||||||
|
private final TemplateServiceProperties properties;
|
||||||
|
private final Counter counter;
|
||||||
|
|
||||||
|
public GreetingService(MeterRegistry meterRegistry, TemplateServiceProperties properties) {
|
||||||
|
this.meterRegistry = meterRegistry;
|
||||||
|
this.properties = properties;
|
||||||
|
counter = meterRegistry.counter("infodb.callCounter");
|
||||||
|
}
|
||||||
|
|
||||||
|
public String createGreeting(String name) {
|
||||||
|
log.info("Create greeting for '{}'", name);
|
||||||
|
counter.increment();
|
||||||
|
meterRegistry.gauge("infodb.nameLength", name.length());
|
||||||
|
String greeting = properties.getTemplate().getGreeting();
|
||||||
|
return String.format(greeting, name);
|
||||||
|
}
|
||||||
|
}
|
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
@ -0,0 +1,15 @@
|
||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<Configuration status="warn" monitorInterval="30">
|
||||||
|
<Appenders>
|
||||||
|
<Console name="console" target="SYSTEM_OUT">
|
||||||
|
<PatternLayout pattern="%5p %d{HH:mm:ss.SSS} (%F:%L) [%X{REQTYPE}] %m%n%xEx{full}"
|
||||||
|
alwaysWriteExceptions="true"/>
|
||||||
|
</Console>
|
||||||
|
</Appenders>
|
||||||
|
<Loggers>
|
||||||
|
<Root level="WARN">
|
||||||
|
<AppenderRef ref="console"/>
|
||||||
|
</Root>
|
||||||
|
<Logger name="de.twomartens" level="TRACE" additivity="true"/>
|
||||||
|
</Loggers>
|
||||||
|
</Configuration>
|
|
@ -0,0 +1,37 @@
|
||||||
|
package de.twomartens.templateservice.control;
|
||||||
|
|
||||||
|
import de.twomartens.templateservice.service.GreetingService;
|
||||||
|
import org.hamcrest.Matchers;
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
import org.mockito.BDDMockito;
|
||||||
|
import org.springframework.beans.factory.annotation.Autowired;
|
||||||
|
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
|
||||||
|
import org.springframework.boot.test.mock.mockito.MockBean;
|
||||||
|
import org.springframework.http.MediaType;
|
||||||
|
import org.springframework.test.web.servlet.MockMvc;
|
||||||
|
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
|
||||||
|
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
|
||||||
|
|
||||||
|
@WebMvcTest(GreetingController.class)
|
||||||
|
class GreetingControllerTests {
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
private MockMvc mvc;
|
||||||
|
|
||||||
|
@MockBean
|
||||||
|
private GreetingService service;
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void testGreetingRest() throws Exception {
|
||||||
|
BDDMockito.given(service.createGreeting("Template"))
|
||||||
|
.willReturn("Hello Template!");
|
||||||
|
|
||||||
|
mvc.perform(MockMvcRequestBuilders.get("/greeting")
|
||||||
|
.param("name", "Template")
|
||||||
|
.contentType(MediaType.APPLICATION_JSON))
|
||||||
|
.andExpect(MockMvcResultMatchers.status().isOk())
|
||||||
|
.andExpect(MockMvcResultMatchers.jsonPath("$", Matchers.aMapWithSize(1)))
|
||||||
|
.andExpect(MockMvcResultMatchers.jsonPath("$.message", Matchers.is("Hello Template!")))
|
||||||
|
.andReturn();
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,37 @@
|
||||||
|
package de.twomartens.templateservice.service;
|
||||||
|
|
||||||
|
import de.twomartens.templateservice.configs.TemplateServiceProperties;
|
||||||
|
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
|
||||||
|
import org.assertj.core.api.Assertions;
|
||||||
|
import org.junit.jupiter.api.BeforeEach;
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
import org.junit.jupiter.api.extension.ExtendWith;
|
||||||
|
import org.mockito.Mock;
|
||||||
|
import org.mockito.junit.jupiter.MockitoExtension;
|
||||||
|
|
||||||
|
import static org.mockito.BDDMockito.given;
|
||||||
|
|
||||||
|
@ExtendWith(MockitoExtension.class)
|
||||||
|
class GreetingServiceTest {
|
||||||
|
|
||||||
|
private GreetingService service;
|
||||||
|
|
||||||
|
@Mock
|
||||||
|
private TemplateServiceProperties properties;
|
||||||
|
|
||||||
|
@Mock
|
||||||
|
private TemplateServiceProperties.Template template;
|
||||||
|
|
||||||
|
@BeforeEach
|
||||||
|
void beforeEach() {
|
||||||
|
given(template.getGreeting()).willReturn("Hello %s");
|
||||||
|
given(properties.getTemplate()).willReturn(template);
|
||||||
|
service = new GreetingService(new SimpleMeterRegistry(), properties);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void createGreeting() {
|
||||||
|
String result = service.createGreeting("Test");
|
||||||
|
Assertions.assertThat(result).isEqualTo("Hello Test");
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,85 @@
|
||||||
|
plugins {
|
||||||
|
id 'com.google.cloud.tools.jib' version '1.8.0' // jib build our docker images
|
||||||
|
id 'org.springframework.boot' version '2.2.4.RELEASE'
|
||||||
|
id 'io.spring.dependency-management' version '1.0.9.RELEASE'
|
||||||
|
}
|
||||||
|
|
||||||
|
configurations {
|
||||||
|
all {
|
||||||
|
exclude group: 'org.springframework.boot', module: 'spring-boot-starter-logging'
|
||||||
|
}
|
||||||
|
integrationTestImplementation.extendsFrom testImplementation
|
||||||
|
}
|
||||||
|
|
||||||
|
sourceSets {
|
||||||
|
integrationTest {
|
||||||
|
java {
|
||||||
|
compileClasspath += main.output + test.output
|
||||||
|
runtimeClasspath += main.output + test.output
|
||||||
|
srcDir file('src/integration-test/java')
|
||||||
|
}
|
||||||
|
resources.srcDir file('src/integration-test/resources')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
implementation 'org.springframework.boot:spring-boot-starter-actuator'
|
||||||
|
implementation 'org.springframework.boot:spring-boot-starter-websocket'
|
||||||
|
implementation 'org.springframework.boot:spring-boot-starter-log4j2'
|
||||||
|
implementation 'io.micrometer:micrometer-registry-prometheus'
|
||||||
|
implementation 'org.springdoc:springdoc-openapi-ui:1.3.9'
|
||||||
|
|
||||||
|
annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
|
||||||
|
developmentOnly 'org.springframework.boot:spring-boot-devtools'
|
||||||
|
testImplementation('org.springframework.boot:spring-boot-starter-test') {
|
||||||
|
// no support for junit 4 Tests
|
||||||
|
exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
|
||||||
|
// exclude hamcrest, we use asAbbringerFahrtLoeschenTypesertj in unit tests
|
||||||
|
exclude group: 'org.hamcrest', module: 'hamcrestv'
|
||||||
|
}
|
||||||
|
testImplementation 'org.testcontainers:testcontainers:1.12.5'
|
||||||
|
// add hamcrest only for mockMvcTest
|
||||||
|
// see https://github.com/spring-projects/spring-framework/issues/21178
|
||||||
|
testImplementation 'org.hamcrest:hamcrest:2.2'
|
||||||
|
}
|
||||||
|
|
||||||
|
bootJar {
|
||||||
|
manifest {
|
||||||
|
attributes 'Implementation-Title': archiveBaseName.get(),
|
||||||
|
'Implementation-Version': archiveVersion.get(),
|
||||||
|
'Implementation-Vendor': "Jim Martens"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
task integrationTest(type: Test) {
|
||||||
|
useJUnitPlatform()
|
||||||
|
maxHeapSize = "4g"
|
||||||
|
group = 'verification'
|
||||||
|
workingDir = rootProject.projectDir
|
||||||
|
testClassesDirs = sourceSets.integrationTest.output.classesDirs
|
||||||
|
classpath = sourceSets.integrationTest.runtimeClasspath
|
||||||
|
}
|
||||||
|
|
||||||
|
tasks.jib.dependsOn(build)
|
||||||
|
tasks.jibDockerBuild.dependsOn(build)
|
||||||
|
|
||||||
|
jib {
|
||||||
|
from {
|
||||||
|
image = 'amazoncorretto:11'
|
||||||
|
}
|
||||||
|
to {
|
||||||
|
image = '2martens/oparl'
|
||||||
|
tags = ['latest', getProperty('version').toString().replace('+', '-')]
|
||||||
|
}
|
||||||
|
container {
|
||||||
|
jvmFlags = ['-Xms1g', '-Xmx1g', '-Dlog4j.configurationFile=log4j2-docker.xml']
|
||||||
|
mainClass = "org.springframework.boot.loader.JarLauncher"
|
||||||
|
// 8080 spring boot web, 8081 actuators (prometheus, healthchecks, ...), 9090 grpc
|
||||||
|
ports = ['8080', '8081', '9090']
|
||||||
|
}
|
||||||
|
containerizingMode = 'packaged'
|
||||||
|
}
|
||||||
|
|
||||||
|
tasks.build.dependsOn(integrationTest)
|
||||||
|
tasks.integrationTest.mustRunAfter(test)
|
||||||
|
|
Loading…
Reference in New Issue