Feat/keycloak

.github/labeler.yml

@@ -6,11 +6,13 @@
   - changed-files:
       - any-glob-to-any-file: 'spring-prometheus-grafana-example/**/*'
 
+"project: spring-keycloak-example":
+  - changed-files:
+      - any-glob-to-any-file: 'spring-keycloak-example/**/*'
+
 "type: dependency-upgrade":
   - changed-files:
-      - any-glob-to-any-file:
-          - spring-kafka-example/pom.xml
-          - spring-prometheus-grafana-example/pom.xml
+      - any-glob-to-any-file: "**/pom.xml"
 
 "ci: github-actions":
   - changed-files:

.github/workflows/spring-keycloak-example.yml

@@ -0,0 +1,68 @@
+name: spring-keycloak-example CI Build
+
+on:
+  pull_request:
+    branches: [master]
+    paths:
+      - "spring-keycloak-example/**"
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+jobs:
+
+  integration-tests:
+    name: Run Unit & Integration Tests
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: spring-keycloak-example
+    strategy:
+      matrix:
+        distribution: [ 'temurin' ]
+        java: [ '21' ]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up JDK ${{ matrix.java }}
+        uses: actions/setup-java@v4.7.1
+        with:
+          java-version: ${{ matrix.java }}
+          distribution: ${{ matrix.distribution }}
+          cache: 'maven'
+      - name: Build and analyze
+        run: ./mvnw clean verify
+
+  health-check:
+    name: Health Check on Services
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository and submodules
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Extract service names from docker compose
+        id: services
+        run: |
+          echo "services<<EOF" >> $GITHUB_OUTPUT
+          docker compose -f ./spring-keycloak-example/compose.yaml config --services >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Start containers with Compose Action
+        uses: hoverkraft-tech/compose-action@v2.3.0
+        with:
+          compose-file: './spring-keycloak-example/compose.yaml'
+          services: ${{ steps.services.outputs.services }}
+          up-flags: '--build'
+          down-flags: '--volumes'
+
+      - name: Wait for containers to initialize
+        run: sleep 10
+
+      - name: Check container health
+        run: |
+          ./.github/scripts/check-container-health.sh "${{ steps.services.outputs.services }}"

pom.xml

@@ -14,6 +14,7 @@
     <modules>
         <module>spring-kafka-example</module>
         <module>spring-prometheus-grafana-example</module>
+        <module>spring-keycloak-example</module>
     </modules>
 
 </project>

spring-keycloak-example/.dockerignore

@@ -0,0 +1,62 @@
+# Include any files or directories that you don't want to be copied to your
+# container here (e.g., local build artifacts, temporary files, etc.).
+#
+# For more help, visit the .dockerignore file reference guide at
+# https://docs.docker.com/go/build-context-dockerignore/
+
+**/.DS_Store
+**/.classpath
+**/.dockerignore
+**/.env
+**/.factorypath
+**/.git
+**/.gitignore
+**/.idea
+**/.project
+**/.sts4-cache
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/.next
+**/.cache
+**/*.dbmdl
+**/*.jfm
+**/charts
+**/docker-compose*
+**/compose.y*ml
+**/Dockerfile*
+**/secrets.dev.yaml
+**/values.dev.yaml
+**/vendor
+LICENSE
+README.md
+**/*.class
+**/*.iml
+**/*.ipr
+**/*.iws
+**/*.log
+**/.apt_generated
+**/.gradle
+**/.gradletasknamecache
+**/.nb-gradle
+**/.springBeans
+**/build
+**/dist
+**/gradle-app.setting
+**/nbbuild
+**/nbdist
+**/nbproject/private
+**/target
+*.ctxt
+.mtj.tmp
+.mvn/timing.properties
+buildNumber.properties
+dependency-reduced-pom.xml
+hs_err_pid*
+pom.xml.next
+pom.xml.releaseBackup
+pom.xml.tag
+pom.xml.versionsBackup
+release.properties
+replay_pid*

spring-keycloak-example/.gitattributes

@@ -0,0 +1,2 @@
+/mvnw text eol=lf
+*.cmd text eol=crlf

spring-keycloak-example/.gitignore

@@ -0,0 +1,32 @@
+target/
+.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/

spring-keycloak-example/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+wrapperVersion=3.3.2
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip

spring-keycloak-example/Dockerfile

@@ -0,0 +1,47 @@
+FROM eclipse-temurin:21-jdk-jammy as deps
+
+WORKDIR /build
+
+COPY --chmod=0755 mvnw mvnw
+COPY .mvn/ .mvn/
+
+RUN --mount=type=bind,source=pom.xml,target=pom.xml \
+    --mount=type=cache,target=/root/.m2 ./mvnw dependency:go-offline -DskipTests
+
+FROM deps as package
+
+WORKDIR /build
+
+COPY ./src src/
+RUN --mount=type=bind,source=pom.xml,target=pom.xml \
+    --mount=type=cache,target=/root/.m2 \
+    ./mvnw package -DskipTests && \
+    mv target/$(./mvnw help:evaluate -Dexpression=project.artifactId -q -DforceStdout)-$(./mvnw help:evaluate -Dexpression=project.version -q -DforceStdout).jar target/app.jar
+
+FROM package as extract
+
+WORKDIR /build
+
+RUN java -Djarmode=layertools -jar target/app.jar extract --destination target/extracted
+
+FROM eclipse-temurin:21-jre-jammy AS final
+
+ARG UID=10001
+RUN adduser \
+    --disabled-password \
+    --gecos "" \
+    --home "/nonexistent" \
+    --shell "/sbin/nologin" \
+    --no-create-home \
+    --uid "${UID}" \
+    appuser
+USER appuser
+
+COPY --from=extract build/target/extracted/dependencies/ ./
+COPY --from=extract build/target/extracted/spring-boot-loader/ ./
+COPY --from=extract build/target/extracted/snapshot-dependencies/ ./
+COPY --from=extract build/target/extracted/application/ ./
+
+EXPOSE 80
+
+ENTRYPOINT [ "java", "org.springframework.boot.loader.launch.JarLauncher" ]

spring-keycloak-example/Dockerfile.keycloak

@@ -0,0 +1,10 @@
+FROM quay.io/keycloak/keycloak:26.3 AS builder
+
+WORKDIR /opt/keycloak
+RUN /opt/keycloak/bin/kc.sh build
+
+FROM quay.io/keycloak/keycloak:26.3
+
+COPY --from=builder /opt/keycloak/ /opt/keycloak/
+
+ENTRYPOINT ["/opt/keycloak/bin/kc.sh", "start"]

spring-keycloak-example/compose.yaml

@@ -0,0 +1,36 @@
+
+services:
+
+  app:
+    container_name: app
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      SERVER_PORT: 80
+      SPRING_PROFILES_ACTIVE: "default"
+    ports:
+      - "80:80"
+    depends_on:
+      - keycloak
+
+  keycloak:
+    container_name: keycloak
+    build:
+      context: .
+      dockerfile: Dockerfile.keycloak
+    ports:
+      - "8080:8080"
+    environment:
+      KC_DB: dev-file
+      KC_HTTP_ENABLED: "true"
+      KC_HTTP_PORT: "8080"
+      KC_HOSTNAME: localhost
+      KC_HEALTH_ENABLED: "true"
+      KC_METRICS_ENABLED: "true"
+      KEYCLOAK_ADMIN: admin #⚠️ DO NOT USE IN PRODUCTION
+      KEYCLOAK_ADMIN_PASSWORD: admin #⚠️ DO NOT USE IN PRODUCTION
+      KC_HTTPS_CERTIFICATE_FILE: /opt/keycloak/certs/tls.crt
+      KC_HTTPS_CERTIFICATE_KEY_FILE: /opt/keycloak/certs/tls.key
+    volumes:
+      - ./docker/keycloak:/opt/keycloak/certs

spring-keycloak-example/docker/keycloak/cert-info.md

@@ -0,0 +1,7 @@
+TLS Certificates for Keycloak
+These certificates were manually generated using the following command:
+
+```bash
+openssl req -x509 -newkey rsa:4096 -keyout tls.key -out tls.crt -days 365 -nodes \
+  -subj "/CN=localhost"
+```

spring-keycloak-example/docker/keycloak/tls.crt

@@ -0,0 +1,29 @@
+-----BEGIN CERTIFICATE-----
+MIIFCTCCAvGgAwIBAgIUIyugoLVFZznlfIT1+VwNY7TKaH0wDQYJKoZIhvcNAQEL
+BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTI1MDgwMjAwNDYzM1oXDTI2MDgw
+MjAwNDYzM1owFDESMBAGA1UEAwwJbG9jYWxob3N0MIICIjANBgkqhkiG9w0BAQEF
+AAOCAg8AMIICCgKCAgEA59ml/0oqbcJ1JnLoPCKtkma7mSow0hFLZDE26N52R+4K
+Xw3trgNW2JL2Z3xQTMnRwHdMwKduTjQQob69bP0K7x4F6nNsrix4u88pOio8r+D6
+cJX3eRnfDqDclGCUy76qqpe5WUnQBsOKVfV2dvAKLb1aNttw8E2hM0/RGW1m9mKH
+KJlvjS/4qTH8tmm5AI7eEJZfHYsONAzw/xsKhFkPwX2FkGn+/efqmJ7ufHMsD5tD
+zN9fjvt9iYhhWKuJA2pFwol+NDz+25w8ksyxnH8HKREqSkpg3l2owuwrBRG+F3vh
+IAFxJaC0CGvUY3suqIAUCYcaPxecxjWS08ySZuojh27s3/9dufDx1CSXCX1+iS+U
+lYOEI7SaLq6KIbo8BfrkqDNrUI6wJxLOYrokv1s2XSg4gEeCXh8VcjK2rbUs8QAI
+6lakr1hAuvCq6PqEsRcioMzUBLeb3r0klfr3sGW3S/PtidvvtBRDnQ07pysvntGq
+FQXd9BFS0+36B2SmbZPdx6nvS1EXwXwHCxzhsMMcRgP9W9rZekLfAhqKVqrRfLWN
+r4Oq9TCeYGrcUB8unvKP2irVMoKnUD+PyUErzg/ZLLCnjEleNp83QuAYPTTpe0xE
+Os+KCkuw4Mb5s4BbWGm7jeOAvGrjLLMzdaDRYaMp4mCL5wfbGTVxodk9LqP4D8cC
+AwEAAaNTMFEwHQYDVR0OBBYEFO/90I29W64gE7TsZLYRQm/AafCoMB8GA1UdIwQY
+MBaAFO/90I29W64gE7TsZLYRQm/AafCoMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZI
+hvcNAQELBQADggIBAL9SLQ+Get1P7WMv4EAaxaktKgAvNpoSu8C57Cp0Gm07wkYP
+wx+iQ65NsZZgqXDkzHdsV1Qp4ETNFrd/zhgYx0LEVCVDkHGcxFeadDm5biSm942b
+7l4hBXQbDP83FyedVyUimRsyC1xacBZUmFN6E2w1H+fDsWSFP4PbawXo6AldWZkh
+pM5CC36cyXeTUb2qhLnX0qJy29O2ixmNlSGDR0cH6cyK0Qorh7NiS3c4M5l7FRTC
+dwcQxKY1pTQ8KLTTeDNBqXwegl2UbH4SPMIBUnpYUcRaHiFOGKa0CZLe4nr/Jjaj
+rNcRq7ddeastfYEzBn9oympmkTuKkNYBjiGYYPBYFy9XpxjqCxC++YmR1rzdt91w
+RJ3pPopRm0RHx4lX9o9sqNn9xYb0wCJRq4A5Tez7Q0lUY8uAQGQdLFnikIS/GSAT
+avSR4O3pgyj9Ua0BxXKOkXmLDpMurF5a9LB1eyoFV8H80Uj4lqmrYpgA6BUyy6By
+G85ca6K9UZczGUHFtttqMZrSqOqBJxkipfktlcqNBqUqNvgk1JjsWysjL2fcQ7Xq
+fXIdSd5OWf2Gq6pPFCWo4Qff7Bx8kfTNsaYcEuA0dsJysjYv9uQ3T4FmRSJuDNAZ
+ceq3T5dzNHSP0cp9fb7WxZCfMsQuZUyYJy/O6g3xIrykPS076Mgn+KLVoKJ9
+-----END CERTIFICATE-----