commit 8a3ee868a96a53c366c72b0cc9998703b3f42b65 Author: STlab bot Date: Thu Oct 5 11:42:24 2023 +0200 Initial commit diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..09b94f0 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,16 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# IntelliJ IDEA supports it out of the box. Eclipse users need +# to install a plugin: https://marketplace.eclipse.org/node/2506426 + +root = true + +[*] +end_of_line = lf +charset = utf-8 + +[*.java] +indent_style = tab + +[pom.xml] +indent_style = tab diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..1403685 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,40 @@ +# This file is managed by the ST lab crew, please don't change it! + +name: CI build + +on: + push: + paths-ignore: + - 'src/main/asciidoc/**' + - 'readme.adoc' + +env: + MAVEN_OPTS: -Xmx1G + +jobs: + build: + name: Build and test + + runs-on: self-hosted + + steps: + - name: Print version information + run: | + java -version + javac --version + git --version + + - name: Checkout sources + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Build and test with Maven + run: ./mvnw clean verify -Pci -B + + - name: Run and publish SonarQube analysis + if: github.ref == 'refs/heads/main' + run: ./mvnw sonar:sonar -B + env: + STLAB_SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }} + STLAB_SONAR_LOGIN: ${{ secrets.SONAR_LOGIN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3052a68 --- /dev/null +++ b/.gitignore @@ -0,0 +1,41 @@ +# Java and Maven +*.class +*.jar +target/ + +# Un-ignore maven wrapper jar +!/.mvn/wrapper/maven-wrapper.jar + +# Eclipse +bin/ +.settings/ +.project +.classpath +.factorypath + +# Eclipse STS plugin +.springBeans + +# IntelliJ +out/ +.idea/ +*.iml + +# VS Code +.vscode/ + +# MagicDraw +*.mdzip.bak + +# OS specific +.DS_Store +Thumbs.db +Desktop.ini + +# H2 database files +*.mv.db +*.h2.db + +# Misc +hs_err_*.log +~$* diff --git a/.mvn/wrapper/maven-wrapper.jar b/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..bf82ff0 Binary files /dev/null and b/.mvn/wrapper/maven-wrapper.jar differ diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..9527f33 --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,18 @@ +# 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 +# +# 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. +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.4/apache-maven-3.9.4-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar diff --git a/mvnw b/mvnw new file mode 100755 index 0000000..b7f0646 --- /dev/null +++ b/mvnw @@ -0,0 +1,287 @@ +#!/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.1.1 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "`uname`" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="`/usr/libexec/java_home`"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=`java-config --jre-home` + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --unix "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --unix "$CLASSPATH"` +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="`which javac`" + if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=`which readlink` + if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then + if $darwin ; then + javaHome="`dirname \"$javaExecutable\"`" + javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" + else + javaExecutable="`readlink -f \"$javaExecutable\"`" + fi + javaHome="`dirname \"$javaExecutable\"`" + javaHome=`expr "$javaHome" : '\(.*\)/bin'` + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + 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 + else + JAVACMD="`\\unset -f command; \\command -v java`" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=`cd "$wdir/.."; pwd` + fi + # end of workaround + done + printf '%s' "$(cd "$basedir"; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + echo "$(tr -s '\n' ' ' < "$1")" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname $0)") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +if [ "$MVNW_VERBOSE" = true ]; then + echo $MAVEN_PROJECTBASEDIR +fi + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found .mvn/wrapper/maven-wrapper.jar" + fi +else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." + fi + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar" + fi + while IFS="=" read key value; do + case "$key" in (wrapperUrl) wrapperUrl="$value"; break ;; + esac + done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" + if [ "$MVNW_VERBOSE" = true ]; then + echo "Downloading from: $wrapperUrl" + fi + wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" + if $cygwin; then + wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` + fi + + if command -v wget > /dev/null; then + QUIET="--quiet" + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found wget ... using wget" + QUIET="" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" + fi + [ $? -eq 0 ] || rm -f "$wrapperJarPath" + elif command -v curl > /dev/null; then + QUIET="--silent" + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found curl ... using curl" + QUIET="" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L + fi + [ $? -eq 0 ] || rm -f "$wrapperJarPath" + else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Falling back to using Java to download" + fi + javaSource="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=`cygpath --path --windows "$javaSource"` + javaClass=`cygpath --path --windows "$javaClass"` + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Compiling MavenWrapperDownloader.java ..." + fi + # Compiling the Java class + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + # Running the downloader + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Running MavenWrapperDownloader.java ..." + fi + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --windows "$CLASSPATH"` + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 0000000..cba1f04 --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,187 @@ +@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.1.1 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..2446177 --- /dev/null +++ b/pom.xml @@ -0,0 +1,59 @@ + + + 4.0.0 + + + + swt23w23 + 1.0.0.BUILD-SNAPSHOT + + swt23w23 + ST lab project of group swt23w23 + https://github.com/st-tu-dresden-praktikum/swt23w23 + + https://github.com/st-tu-dresden-praktikum/swt23w23 + + + + de.tudresden.inf.st.lab + st-lab-parent + 4.0.0 + + + + + 17 + 9.0.0 + ${env.STLAB_SONAR_HOST_URL} + ${env.STLAB_SONAR_LOGIN} + -Xmx1G + + + + + + + + + + + + salespointframework + https://www.st.inf.tu-dresden.de/SalesPoint/repository + + + + + diff --git a/readme.adoc b/readme.adoc new file mode 100644 index 0000000..55f68e0 --- /dev/null +++ b/readme.adoc @@ -0,0 +1,44 @@ +image:https://github.com/st-tu-dresden-praktikum/swt23w23/workflows/CI%20build/badge.svg["CI Build", link="https://github.com/st-tu-dresden-praktikum/swt23w23/actions"] +image:https://img.shields.io/badge/SonarQube-checked-blue?logo=sonarqube["SonarQube status", link="https://st-lab-ci.inf.tu-dresden.de/sonarqube/"] + +// Hi there! We've already included some generally useful information in here. +// Feel free to edit the first section to add a short description of your task and your project. + += Kickstart + +The kickstart module is a template project to bootstrap the Java project in the Software Engineering lab. +Each group's repository is initialized with this template. +It contains the following features: + +* a skeleton Java 17 web application based on Spring Boot and Salespoint framework (see `src/main/java` and `src/test/java`) +* Asciidoc documentation templates in `src/main/asciidoc` + +== Important documents in this repo + +* link:src/main/asciidoc/protocols[Meeting Protocols] +* link:src/main/asciidoc/time_recording.adoc[Time recording (Zeiterfassung)] +* link:src/main/asciidoc/pflichtenheft.adoc[Requirements specification (Pflichtenheft)] +* link:src/main/asciidoc/developer_documentation.adoc[Developer documentation (Entwicklerdokumentation)] + +== The repository layout + +The repository follows the standard Maven project layout. Nearly all artifacts are stored in a subdirectory of `src/`: + + src/ + ├── main/ + │   ├── asciidoc/ -- Documentation of the development process and application (Asciidoc format) + │   ├── java/ -- Main source code of the application, separated into packages + │   └── resources/ -- Static assets (images, stylesheets), Thymeleaf templates, etc. + └── test/ + └── java/ -- Source code of JUnit tests is stored separately + +**Pro tip:** In GitHub, press *t* and a "fuzzy file finder" will appear, making it easy to navigate to a file. + +== How to run the application? + +* In the IDE: find `Application.java`, right-click project, select "Run As > Java Application" +* From the command line: run `./mvnw spring-boot:run` + +== How to package the application? + +* Run `./mvnw clean package`. The packaged application (a JAR in `target/`) can be run with `java -jar $jarName`. diff --git a/src/main/asciidoc/cross_testing_report_for_gNN.adoc b/src/main/asciidoc/cross_testing_report_for_gNN.adoc new file mode 100644 index 0000000..e4b130a --- /dev/null +++ b/src/main/asciidoc/cross_testing_report_for_gNN.adoc @@ -0,0 +1,23 @@ += Cross-Testing Feedback + +__Durchführende Gruppe:__ +__Anwendung von Gruppe:__ + +== Getestetes System +Welche Aufgabe/Problemstellung löst die Anwendung. + +== Fehler-Report +// See http://asciidoctor.org/docs/user-manual/#tables +[options="header"] +|=== +|Pfad |Parameter |Beschreibung |Rückgabe +| … | … | … | … | +|=== + +== Sonstiges +* Optik der Anwendung +* Fehlende Features +* Interaktion mit der Anwendung (Usability) + +== Verbesserungsvorschläge +* Was kann noch weiter verbessert werden? diff --git a/src/main/asciidoc/developer_documentation.adoc b/src/main/asciidoc/developer_documentation.adoc new file mode 100644 index 0000000..53b8f64 --- /dev/null +++ b/src/main/asciidoc/developer_documentation.adoc @@ -0,0 +1,67 @@ +[options="header"] +[cols="1, 3, 3"] +|=== +|Version | Bearbeitungsdatum | Autor +|... | ... | ... +|=== + += Entwicklerdokumentation + +== Einführung und Ziele +* Aufgabenstellung +* Qualitätsziele + +== Randbedingungen +* Hardware-Vorgaben +* Software-Vorgaben +* Vorgaben zum Betrieb des Software + +== Kontextabgrenzung +* Kontextdiagramm + +== Lösungsstrategie +=== Erfüllung der Qualitätsziele +[options="header"] +|=== +|Qualitätsziel |Lösungsansatz +|... |... +|=== + +=== Softwarearchitektur +* Beschreibung der Architektur anhand der Top-Level-Architektur oder eines Client-Server-Diagramms + +=== Entwurfsentscheidungen +* Verwendete Muster +* Persistenz +* Benutzeroberfläche +* Verwendung externer Frameworks + +[options="header", cols="1,2,3"] +|=== +|Externes Package |Verwendet von |Warum +|... |... |... +|=== + +== Bausteinsicht +* Package-Diagramm +* Entwurfsklassendiagramme der einzelnen Packages + +[options="header"] +|=== +|Klasse/Enumeration |Description +|... |... +|=== + +=== Rückverfolgbarkeit zwischen Analyse- und Entwurfsmodell +_Die folgende Tabelle zeigt die Rückverfolgbarkeit zwischen Entwurfs- und Analysemodell._ + +[options="header"] +|=== +|Klasse/Enumeration (Analysemodell) |Klasse/Enumeration (Entwurfsmodell) +|... |... +|=== + +== Laufzeitsicht +* Darstellung der Komponenteninteraktion anhand eines Sequenzdiagramms, welches die relevantesten Interaktionen darstellt. + + diff --git a/src/main/asciidoc/evaluations/evaluation_sheet.adoc b/src/main/asciidoc/evaluations/evaluation_sheet.adoc new file mode 100644 index 0000000..c3d2aa7 --- /dev/null +++ b/src/main/asciidoc/evaluations/evaluation_sheet.adoc @@ -0,0 +1,26 @@ += Persönliches Feedback eines Teammitgliedes des Softwarepraktikums 2021/22 +// Auch wenn der Bogen nicht anonymisiert ist, dürfen Sie gern Ihre Meinung offen kundtun. +// Sowohl positive als auch negative Anmerkungen werden gern gesehen und zur stetigen Verbesserung genutzt. +// Versuchen Sie in dieser Auswertung also stets sowohl Positives wie auch Negatives zu erwähnen. + +**Von:** + +**Gruppe:** + +== Was habe ich gelernt / was habe ich nicht gelernt? +// Ausführung der positiven und negativen Erfahrungen, die im Softwarepraktikum gesammelt wurden + +== Welche Erfahrungen habe ich mit der Zusammenarbeit im Team gemacht? +// Kurze Beschreibung der Zusammenarbeit im Team. Was lief gut? Was war verbesserungswürdig? Was würden Sie das nächste Mal anders machen? + +== Welche Erfahrungen habe ich bei der Wiederverwendung von Bibliotheken/Frameworks (insbesondere SalesPoint) gemacht? +// Einschätzung der Arbeit mit den bereitgestellten und zusätzlich genutzten Frameworks. Was War gut? Was war verbesserungswürdig? + +== Welche Vorschläge zur weiteren Verbesserung des Softwarepraktikums gibt es? +// Möglichst mit Beschreibung, warum die Umsetzung des von Ihnen angebrachten Vorschlages nötig ist. + +== Feedback für den Tutor +// Fühlten Sie sich durch den vom Lehrstuhl bereitgestellten Tutor gut betreut? Was war positiv? Was war verbesserungswürdig? + +== Sonstiges und Anmerkungen +// Welche Aspekte fanden in den oben genannten Punkten keine Erwähnung? diff --git a/src/main/asciidoc/models/analysis/readme.adoc b/src/main/asciidoc/models/analysis/readme.adoc new file mode 100644 index 0000000..7262074 --- /dev/null +++ b/src/main/asciidoc/models/analysis/readme.adoc @@ -0,0 +1,3 @@ += Artefaktsammlung der Analysephase + +In diesem Ordner sind alle in der Analysephase erstellten Diagramme als Bild und zusätzlich das zugrundeliegende Modell zu hinterlegen. diff --git a/src/main/asciidoc/models/design/readme.adoc b/src/main/asciidoc/models/design/readme.adoc new file mode 100644 index 0000000..ee30336 --- /dev/null +++ b/src/main/asciidoc/models/design/readme.adoc @@ -0,0 +1,3 @@ += Artefaktsammlung der Entwurfsphase + +In diesem Ordner sind alle in der Entwurfsphase erstellten Diagramme als Bild und zusätzlich das zugrundeliegende Modell zu hinterlegen. diff --git a/src/main/asciidoc/models/readme.adoc b/src/main/asciidoc/models/readme.adoc new file mode 100644 index 0000000..d28eea2 --- /dev/null +++ b/src/main/asciidoc/models/readme.adoc @@ -0,0 +1,6 @@ += Modelle Ordner + +In diesem Ordner sollen die erstellten Diagramme (Bilder) sowie das zugehörige Modell (je eines für Analyse und Entwurf) abgelegt werden. +Achten Sie auf eine Benennung, welche die Art des Diagramms beinhaltet. + +Die erstellten Diagramme können somit einfach in der Dokumentation referenziert werden. diff --git a/src/main/asciidoc/pflichtenheft.adoc b/src/main/asciidoc/pflichtenheft.adoc new file mode 100644 index 0000000..c872791 --- /dev/null +++ b/src/main/asciidoc/pflichtenheft.adoc @@ -0,0 +1,123 @@ += Pflichtenheft +:project_name: Projektname +== __{project_name}__ + +[options="header"] +[cols="1, 1, 1, 1, 4"] +|=== +|Version | Status | Bearbeitungsdatum | Autoren(en) | Vermerk +|0.1 | In Arbeit | 10.10.2021 | Autor | Initiale Version +|=== + +== Inhaltsverzeichnis +Dieses Dokument benötigt ein Inhaltsverzeichnis. Es existieren mehrere Einbindungsmöglichkeiten. + +== Zusammenfassung +Eine kurze Beschreibung des Dokuments. Wenige Absätze. + +== Aufgabenstellung und Zielsetzung +Text aus Aufgabenstellung kopieren und ggfs. präzisieren. +Insbesondere ergänzen, welche Ziele mit dem Abschluss des Projektes erreicht werden sollen. + +== Produktnutzung +In welchem Kontext soll das System später genutzt werden? Welche Rahmenbedingungen gelten? +Zusätzlich kurze Einleitung für fachfremde Personen + +== Interessensgruppen (Stakeholders) +Welche realen und juristischen Personen(-gruppen) haben Einfluss auf die Anforderungen im Projekt? + +== Systemgrenze und Top-Level-Architektur + +=== Kontextdiagramm +Das Kontextdiagramm zeigt das geplante Software-System in seiner Umgebung. Zur Umgebung gehören alle Nutzergruppen des Systems und Nachbarsysteme. Die Grafik kann auch informell gehalten sein. Überlegen Sie sich dann geeignete Symbole. Die Grafik kann beispielsweise mit Visio erstellt werden. Wenn nötig, erläutern Sie diese Grafik. + +=== Top-Level-Architektur +Dokumentieren Sie ihre Top-Level-Architektur mit Hilfe eines Komponentendiagramm. + +== Anwendungsfälle + +=== Akteure + +Akteure sind die Benutzer des Software-Systems oder Nachbarsysteme, welche darauf zugreifen. Dokumentieren Sie die Akteure in einer Tabelle. Diese Tabelle gibt einen Überblick über die Akteure und beschreibt sie kurz. Die Tabelle hat also mindestens zwei Spalten (Akteur Name und Kommentar). +Weitere relevante Spalten können bei Bedarf ergänzt werden. + +// See http://asciidoctor.org/docs/user-manual/#tables +[options="header"] +[cols="1,4"] +|=== +|Name |Beschreibung +|... |... +|=== + +=== Überblick Anwendungsfalldiagramm +Anwendungsfall-Diagramm, das alle Anwendungsfälle und alle Akteure darstellt + +=== Anwendungsfallbeschreibungen +Dieser Unterabschnitt beschreibt die Anwendungsfälle. In dieser Beschreibung müssen noch nicht alle Sonderfälle und Varianten berücksichtigt werden. Schwerpunkt ist es, die wichtigsten Anwendungsfälle des Systems zu finden. Wichtig sind solche Anwendungsfälle, die für den Auftraggeber, den Nutzer den größten Nutzen bringen. +Für komplexere Anwendungsfälle ein UML-Sequenzdiagramm ergänzen. +Einfache Anwendungsfälle mit einem Absatz beschreiben. +Die typischen Anwendungsfälle (Anlegen, Ändern, Löschen) können zu einem einzigen zusammengefasst werden. + +== Funktionale Anforderungen + +=== Muss-Kriterien +Was das zu erstellende Programm auf alle Fälle leisten muss. + +=== Kann-Kriterien +Anforderungen die das Programm leisten können soll, aber für den korrekten Betrieb entbehrlich sind. + +== Nicht-Funktionale Anforderungen + +=== Qualitätsziele + +Dokumentieren Sie in einer Tabelle die Qualitätsziele, welche das System erreichen soll, sowie deren Priorität. + +=== Konkrete Nicht-Funktionale Anforderungen + +Beschreiben Sie Nicht-Funktionale Anforderungen, welche dazu dienen, die zuvor definierten Qualitätsziele zu erreichen. +Achten Sie darauf, dass deren Erfüllung (mindestens theoretisch) messbar sein muss. + +== GUI Prototyp + +In diesem Kapitel soll ein Entwurf der Navigationsmöglichkeiten und Dialoge des Systems erstellt werden. +Idealerweise entsteht auch ein grafischer Prototyp, welcher dem Kunden zeigt, wie sein System visuell umgesetzt werden soll. +Konkrete Absprachen - beispielsweise ob der grafische Prototyp oder die Dialoglandkarte höhere Priorität hat - sind mit dem Kunden zu treffen. + +=== Überblick: Dialoglandkarte +Erstellen Sie ein Übersichtsdiagramm, das das Zusammenspiel Ihrer Masken zur Laufzeit darstellt. Also mit welchen Aktionen zwischen den Masken navigiert wird. +//Die nachfolgende Abbildung zeigt eine an die Pinnwand gezeichnete Dialoglandkarte. Ihre Karte sollte zusätzlich die Buttons/Funktionen darstellen, mit deren Hilfe Sie zwischen den Masken navigieren. + +=== Dialogbeschreibung +Für jeden Dialog: + +1. Kurze textuelle Dialogbeschreibung eingefügt: Was soll der jeweilige Dialog? Was kann man damit tun? Überblick? +2. Maskenentwürfe (Screenshot, Mockup) +3. Maskenelemente (Ein/Ausgabefelder, Aktionen wie Buttons, Listen, …) +4. Evtl. Maskendetails, spezielle Widgets + +== Datenmodell + +=== Überblick: Klassendiagramm +UML-Analyseklassendiagramm + +=== Klassen und Enumerationen +Dieser Abschnitt stellt eine Vereinigung von Glossar und der Beschreibung von Klassen/Enumerationen dar. Jede Klasse und Enumeration wird in Form eines Glossars textuell beschrieben. Zusätzlich werden eventuellen Konsistenz- und Formatierungsregeln aufgeführt. + +// See http://asciidoctor.org/docs/user-manual/#tables +[options="header"] +|=== +|Klasse/Enumeration |Beschreibung | +|… |… | +|=== + +== Akzeptanztestfälle +Mithilfe von Akzeptanztests wird geprüft, ob die Software die funktionalen Erwartungen und Anforderungen im Gebrauch erfüllt. Diese sollen und können aus den Anwendungsfallbeschreibungen und den UML-Sequenzdiagrammen abgeleitet werden. D.h., pro (komplexen) Anwendungsfall gibt es typischerweise mindestens ein Sequenzdiagramm (welches ein Szenarium beschreibt). Für jedes Szenarium sollte es einen Akzeptanztestfall geben. Listen Sie alle Akzeptanztestfälle in tabellarischer Form auf. +Jeder Testfall soll mit einer ID versehen werde, um später zwischen den Dokumenten (z.B. im Test-Plan) referenzieren zu können. + +== Glossar +Sämtliche Begriffe, die innerhalb des Projektes verwendet werden und deren gemeinsames Verständnis aller beteiligten Stakeholder essentiell ist, sollten hier aufgeführt werden. +Insbesondere Begriffe der zu implementierenden Domäne wurden bereits beschrieben, jedoch gibt es meist mehr Begriffe, die einer Beschreibung bedürfen. + +Beispiel: Was bedeutet "Kunde"? Ein Nutzer des Systems? Der Kunde des Projektes (Auftraggeber)? + +== Offene Punkte +Offene Punkte werden entweder direkt in der Spezifikation notiert. Wenn das Pflichtenheft zum finalen Review vorgelegt wird, sollte es keine offenen Punkte mehr geben. diff --git a/src/main/asciidoc/protocols/protocol_template.adoc b/src/main/asciidoc/protocols/protocol_template.adoc new file mode 100644 index 0000000..01d309f --- /dev/null +++ b/src/main/asciidoc/protocols/protocol_template.adoc @@ -0,0 +1,48 @@ += Protokoll Gruppe XX + +Treffen am XX.XX.20XX + +Ort: Ort des Treffens + +Beginn: xx:xx Uhr + +Ende: xx:xx Uhr + +__Schriftführer:__ + +*Nächstes Treffen:* + +XX.XX.20XX, xx:xx Uhr, Ort des nächsten Treffens + +__Teilnehmer:__ +//Tabellarisch oder Aufzählung, Kennzeichnung von Teilnehmern mit besonderer Rolle (z.B. Kunde) + +- Teilnehmer 1 +- Teilnehmer 2 +- ... + +== Bemerkungen +Verwarnungen, besondere Vorfälle, Organisatorisches, wichtige getroffene Entscheidungen + +== Retrospektive des letzten Sprints +*Issue referenziert die Issue ID von GitHub* +// Wie ist der Status der im letzten Sprint erstellten Issues/veteilten Aufgaben? + +// See http://asciidoctor.org/docs/user-manual/=tables +[option="headers"] +|=== +|Issue |Aufgabe |Status |Bemerkung +|… |… |… |… +|=== + + +== Aktueller Stand +Anmerkungen und Kritik zum aktuellen Stand der Software, den Diagrammen und den +Dokumenten. + +== Planung des nächsten Sprints +*Issue referenziert die Issue ID von GitHub* + +// See http://asciidoctor.org/docs/user-manual/=tables +[option="headers"] +|=== +|Issue |Titel |Beschreibung |Verantwortlicher |Status +|… |… |… |… |… +|=== diff --git a/src/main/asciidoc/time_recording.adoc b/src/main/asciidoc/time_recording.adoc new file mode 100644 index 0000000..1156026 --- /dev/null +++ b/src/main/asciidoc/time_recording.adoc @@ -0,0 +1,35 @@ += Zeiterfassung für Gruppe XX + +Notieren Sie die Zeit in Minuten für jeden Entwickler und – getrennt davon – für Team-Treffen pro Woche (Wochengranularität). +Die individuell erfasste Zeit beinhaltet auch das Lesen von Dokumentationen, Besprechungen mit Teamkollegen und sonstige auf das Praktikum bezogene Aufgaben, jedoch *nicht* das Team-Treffen (= letzte Spalte). + +// See http://asciidoctor.org/docs/user-manual/#tables +[option="headers"] +|=== +|Woche |Dev1 |Dev2 |Dev3 |Dev4 |Dev5 |Dev6 |Meeting +|1 |… |… |… |… |… |… |… +|2 |… |… |… |… |… |… |… +|3 |… |… |… |… |… |… |… +|4 |… |… |… |… |… |… |… +|5 |… |… |… |… |… |… |… +|6 |… |… |… |… |… |… |… +|7 |… |… |… |… |… |… |… +|8 |… |… |… |… |… |… |… +|9 |… |… |… |… |… |… |… +|10 |… |… |… |… |… |… |… +|11 |… |… |… |… |… |… |… +|12 |… |… |… |… |… |… |… +|=== + +Bitte tragen Sie am Ende des Praktikums noch folgende weitere Werte ein: +Summe der Arbeitsstunden pro Student: + +SUMME(SPALTE(DevX)) + +Arbeitsstunden pro Woche pro Student: + +SUMME(SPALTE(DevX)) / 12 + +Durchschnittliche Arbeitzeit aller Studenten pro Woche: + +(SUMME(SPALTE(Dev1)) + SUMME(SPALTE(Dev2)) + SUMME(SPALTE(Dev3)) + SUMME(SPALTE(Dev4)) + SUMME(SPALTE(Dev5)) +SUMME(SPALTE(Dev6))) / 6 diff --git a/src/main/java/kickstart/Application.java b/src/main/java/kickstart/Application.java new file mode 100644 index 0000000..432fc78 --- /dev/null +++ b/src/main/java/kickstart/Application.java @@ -0,0 +1,55 @@ +/* + * Copyright 2014-2023 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 + * + * 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. + */ +package kickstart; + +import org.salespointframework.EnableSalespoint; +import org.springframework.boot.SpringApplication; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.security.config.annotation.web.builders.HttpSecurity; +import org.springframework.security.config.annotation.web.configurers.HeadersConfigurer.FrameOptionsConfig; +import org.springframework.security.web.SecurityFilterChain; + +/** + * The main application class. + */ +@EnableSalespoint +public class Application { + + /** + * The main application method + * + * @param args application arguments + */ + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } + + @Configuration + static class WebSecurityConfiguration { + + @Bean + SecurityFilterChain videoShopSecurity(HttpSecurity http) throws Exception { + + return http + .headers(headers -> headers.frameOptions(FrameOptionsConfig::sameOrigin)) + .csrf(csrf -> csrf.disable()) + .formLogin(login -> login.loginProcessingUrl("/login")) + .logout(logout -> logout.logoutUrl("/logout").logoutSuccessUrl("/")) + .build(); + } + } +} diff --git a/src/main/java/kickstart/welcome/WelcomeController.java b/src/main/java/kickstart/welcome/WelcomeController.java new file mode 100644 index 0000000..b63af5e --- /dev/null +++ b/src/main/java/kickstart/welcome/WelcomeController.java @@ -0,0 +1,28 @@ +/* + * Copyright 2014-2023 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 + * + * 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. + */ +package kickstart.welcome; + +import org.springframework.stereotype.Controller; +import org.springframework.web.bind.annotation.GetMapping; + +@Controller +public class WelcomeController { + + @GetMapping("/") + public String index() { + return "welcome"; + } +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties new file mode 100644 index 0000000..5ce43f5 --- /dev/null +++ b/src/main/resources/application.properties @@ -0,0 +1,5 @@ +# Uncomment these two lines of configuration to +# enable persistent storage in db/kickstart. +################################################ +# spring.datasource.url=jdbc:h2:./db/kickstart +# spring.jpa.hibernate.ddl-auto=update diff --git a/src/main/resources/messages.properties b/src/main/resources/messages.properties new file mode 100644 index 0000000..fa4fc1b --- /dev/null +++ b/src/main/resources/messages.properties @@ -0,0 +1,11 @@ +# ATTENTION: +# Spring Boot expects this file to be UTF-8 encoded 👍 However, some IDEs will open it in +# the wrong mode. For example, IntelliJ users must go to Preferences > Editor > File Encodings +# and set "Default encoding for properties files" to "UTF-8". +# +# HINT: +# Values from here will be used as a default if no entry was found in the language specific +# message file or if a language specific file could not be found. + +welcome.title = Welcome back! +welcome.text = If umlauts such as äöü are not displayed correctly, something is broken diff --git a/src/main/resources/messages_de.properties b/src/main/resources/messages_de.properties new file mode 100644 index 0000000..0d4a959 --- /dev/null +++ b/src/main/resources/messages_de.properties @@ -0,0 +1,9 @@ +# ATTENTION: +# Spring Boot expects this file to be UTF-8 encoded 👍 However, some IDEs will open it in +# the wrong mode. For example, IntelliJ users must go to Preferences > Editor > File Encodings +# and set "Default encoding for properties files" to "UTF-8". +# +# HINT: Entries that are missing here are looked up in messages.properties + +welcome.title = Willkommen zurück! +welcome.text = Wenn Umlaute (äöü) falsch dargestellt werden, ist irgendwas kaputt diff --git a/src/main/resources/messages_en.properties b/src/main/resources/messages_en.properties new file mode 100644 index 0000000..5c2be64 --- /dev/null +++ b/src/main/resources/messages_en.properties @@ -0,0 +1,6 @@ +# ATTENTION: +# Spring Boot expects this file to be UTF-8 encoded 👍 However, some IDEs will open it in +# the wrong mode. For example, IntelliJ users must go to Preferences > Editor > File Encodings +# and set "Default encoding for properties files" to "UTF-8". +# +# HINT: Entries that are missing here are looked up in messages.properties diff --git a/src/main/resources/static/resources/css/style.css b/src/main/resources/static/resources/css/style.css new file mode 100644 index 0000000..ed03f7e --- /dev/null +++ b/src/main/resources/static/resources/css/style.css @@ -0,0 +1,19 @@ +/* CSS RESET */ + +* { + margin: 0; + padding: 0; +} + +body { + margin: 0 auto; + width: 940px; + font: 13px/22px Helvetica, Arial, sans-serif; + background: #f0f0f0; +} + +h1 { + font-size: 3em; + line-height: 3.2em; + text-align:center; +} diff --git a/src/main/resources/templates/welcome.html b/src/main/resources/templates/welcome.html new file mode 100644 index 0000000..f556a99 --- /dev/null +++ b/src/main/resources/templates/welcome.html @@ -0,0 +1,12 @@ + + + + + + Welcome! + + +

Welcome!

+

+ + diff --git a/src/test/java/kickstart/welcome/ModularityTests.java b/src/test/java/kickstart/welcome/ModularityTests.java new file mode 100644 index 0000000..9c34e69 --- /dev/null +++ b/src/test/java/kickstart/welcome/ModularityTests.java @@ -0,0 +1,51 @@ +/* + * Copyright 2022-2023 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. + */ +package kickstart.welcome; + +import kickstart.Application; + +import java.io.IOException; + +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; +import org.springframework.modulith.core.ApplicationModules; +import org.springframework.modulith.docs.Documenter; +import org.springframework.modulith.docs.Documenter.CanvasOptions; +import org.springframework.modulith.docs.Documenter.DiagramOptions; + +/** + * Test case to verify the modular structure of the application. + * + * @author Oliver Drotbohm + */ +class ModularityTests { + + ApplicationModules modules = ApplicationModules.of(Application.class); + + @Test + @Disabled + void verifyModularity() { + modules.verify(); + } + + @Test + @Disabled + void generateDocs() throws IOException { + + new Documenter(modules) + .writeDocumentation(DiagramOptions.defaults(), CanvasOptions.defaults()); + } +} diff --git a/src/test/java/kickstart/welcome/WelcomeControllerIntegrationTests.java b/src/test/java/kickstart/welcome/WelcomeControllerIntegrationTests.java new file mode 100644 index 0000000..f9f2bed --- /dev/null +++ b/src/test/java/kickstart/welcome/WelcomeControllerIntegrationTests.java @@ -0,0 +1,40 @@ +/* + * Copyright 2014-2023 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 + * + * 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. + */ +package kickstart.welcome; + +import static org.hamcrest.CoreMatchers.*; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; + +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.web.servlet.MockMvc; + +@SpringBootTest +@AutoConfigureMockMvc +class WelcomeControllerIntegrationTests { + + @Autowired MockMvc mvc; + + @Test + void showsWelcomeMessage() throws Exception { + mvc.perform(get("/")) // + .andExpect(status().isOk()) + .andExpect(content().string(containsString("Welcome back!"))); + } +}