Spring Boot Admin Integration

.github/workflows/build.yml

@@ -85,6 +85,8 @@ jobs:
       run: npm i -g typescript
     - name: Maven Build
       run: mvn -T 1C clean install -D maven.test.skip=true -D skipTests -D maven.javadoc.skip=true -D license.skip=true -U
+    - if: runner.os == 'Windows'
+      run: Set-DisplayResolution -Width 1920 -Height 1080 -Force
     - name: Integration tests
       run: mvn -f tests/pom.xml verify -P integration-tests
     - name: Upload selenide screenshots
@@ -94,3 +96,58 @@ jobs:
         retention-days: 1
         name: selenide-screenshots
         path: tests/build/reports/tests
+
+  integration-tests-spring-boot: 
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: true
+    strategy:
+      matrix:
+        os: [windows]
+    steps:
+    - name: Setup Chrome
+      uses: browser-actions/setup-chrome@v1.3.0
+      with:
+        chrome-version: stable
+    - if: runner.os == 'Linux'
+      run: chrome --version
+    - if: runner.os == 'macOS'
+      run: chromium --version
+    - if: runner.os == 'Windows'
+      run: (Get-Item (Get-Command chrome).Source).VersionInfo.ProductVersion
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - name: Cache local Maven repository
+      uses: actions/cache@v3
+      with:
+        path: ~/.m2/repository
+        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+        restore-keys: ${{ runner.os }}-maven-
+    - name: Set up JDK Corretto 21
+      uses: actions/setup-java@v3
+      with:
+        distribution: 'corretto'
+        java-version: '21'
+        architecture: x64
+    - name: Install NodeJS
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18
+    - name: Install esbuild
+      run: npm i -g esbuild
+    - name: Install TypeScript compiler
+      run: npm i -g typescript
+    - name: Maven Build
+      run: mvn -T 1C clean install -P spring-boot-admin -D maven.test.skip=true -D skipTests -D maven.javadoc.skip=true -D license.skip=true -U
+    - if: runner.os == 'Windows'
+      run: Set-DisplayResolution -Width 1920 -Height 1080 -Force
+    - name: Integration tests
+      run: mvn -f tests/pom.xml verify -P integration-tests-spring-boot-admin -D spring.profiles.active=spring-boot-admin
+    - name: Upload selenide screenshots
+      uses: actions/upload-artifact@v3.1.3
+      if: always()
+      with:
+        retention-days: 1
+        name: selenide-screenshots-spring-boot
+        path: tests/build/reports/tests
+

.github/workflows/pull-request.yml

@@ -83,6 +83,8 @@ jobs:
       run: npm i -g typescript
     - name: Maven Build
       run: mvn -T 1C clean install -D maven.test.skip=true -D skipTests -D maven.javadoc.skip=true -D license.skip=true -U
+    - if: runner.os == 'Windows'
+      run: Set-DisplayResolution -Width 1920 -Height 1080 -Force
     - name: Integration tests
       run: mvn -f tests/pom.xml verify -P integration-tests
     - name: Upload selenide screenshots
@@ -92,3 +94,56 @@ jobs:
         retention-days: 1
         name: selenide-screenshots
         path: tests/build/reports/tests
+
+  integration-tests-spring-boot:       
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: true
+    strategy:
+      matrix:
+        os: [windows]
+    steps:
+    - name: Setup Chrome
+      uses: browser-actions/setup-chrome@v1.3.0
+      with:
+        chrome-version: stable
+    - if: runner.os == 'Linux'
+      run: chrome --version
+    - if: runner.os == 'macOS'
+      run: chromium --version
+    - if: runner.os == 'Windows'
+      run: (Get-Item (Get-Command chrome).Source).VersionInfo.ProductVersion
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - name: Cache local Maven repository
+      uses: actions/cache@v3
+      with:
+        path: ~/.m2/repository
+        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+        restore-keys: ${{ runner.os }}-maven-
+    - name: Set up JDK Corretto 21
+      uses: actions/setup-java@v3
+      with:
+        distribution: 'corretto'
+        java-version: 21
+    - name: Install NodeJS
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18
+    - name: Install esbuild
+      run: npm i -g esbuild
+    - name: Install TypeScript compiler
+      run: npm i -g typescript
+    - name: Maven Build
+      run: mvn -T 1C clean install -P spring-boot-admin -D maven.test.skip=true -D skipTests -D maven.javadoc.skip=true -D license.skip=true -U
+    - if: runner.os == 'Windows'
+      run: Set-DisplayResolution -Width 1920 -Height 1080 -Force
+    - name: Integration tests
+      run: mvn -f tests/pom.xml verify -P integration-tests-spring-boot-admin -D spring.profiles.active=spring-boot-admin
+    - name: Upload selenide screenshots
+      uses: actions/upload-artifact@v3.1.3
+      if: always()
+      with:
+        retention-days: 1
+        name: selenide-screenshots-spring-boot
+        path: tests/build/reports/tests

.gitignore

@@ -8,7 +8,9 @@ bin/
 .history
 .vscode
 node_modules
-build/
+**/build
+build/application/dirigible
+!/build
 
 # files
 .DS_Store

README.md

@@ -36,7 +36,8 @@ The project started as an internal SAP initiative to address the extension and a
 	- [Run](#run)
 		- [Standalone](#standalone)
 		- [Docker](#docker)
-  	- [Code formatting](#code-formatting)	 
+  	- [Code formatting](#code-formatting)
+  	- [Spring Boot Admin](#spring-boot-admin)
 - [Additional Information](#additional-information)
 	- [License](#license)
 	- [Contributors](#contributors)
@@ -237,6 +238,15 @@ To format the code using Maven execute the following in the root dir of the proj
 
 	mvn formatter:format
 
+### Spring Boot Admin
+If you want to enable [Spring Boot Admin](https://docs.spring-boot-admin.com/current/) for the Dirigible project, you need to build the project with maven profile `spring-boot-admin` and then activate spring profile `spring-boot-admin`.
+To do this, you have to execute the following commands:
+```
+mvn -T 1C clean install -P spring-boot-admin -D maven.test.skip=true -D skipTests -D maven.javadoc.skip=true -D license.skip=true
+
+java -jar -Dspring.profiles.active=spring-boot-admin build/application/target/dirigible-application-*-executable.jar
+```
+
 ## Additional Information
 
 ### License
@@ -264,4 +274,3 @@ Unicons by IconScout: [https://github.com/Iconscout/unicons](https://github.com/
 - Mailing List: [https://dev.eclipse.org/mailman/listinfo/dirigible-dev](https://dev.eclipse.org/mailman/listinfo/dirigible-dev)
 - Issues: [https://github.com/eclipse/dirigible/issues](https://github.com/eclipse/dirigible/issues)
 - Eclipse Foundation Help Desk: https://gitlab.eclipse.org/eclipsefdn/helpdesk
-

build/application/pom.xml

@@ -15,7 +15,6 @@
 	<packaging>jar</packaging>
 
 	<dependencies>
-
 		<!-- Platform -->
 		<dependency>
 			<groupId>org.slf4j</groupId>
@@ -114,7 +113,6 @@
 		<dependency>
 			<groupId>com.h2database</groupId>
 			<artifactId>h2</artifactId>
-			<version>${h2database.version}</version>
 		</dependency>
 
 		<!-- WebJars -->
@@ -126,16 +124,10 @@
 
 		<!-- Olingo -->
 		<dependency>
-			<groupId>org.apache.olingo</groupId>
+			<groupId>com.codbex.olingo</groupId>
 			<artifactId>olingo-odata2-lib</artifactId>
 			<version>${olingo.version}</version>
 			<type>pom</type>
-			<exclusions>
-				<exclusion>
-					<groupId>javax.ws.rs</groupId>
-					<artifactId>javax.ws.rs-api</artifactId>
-				</exclusion>
-			</exclusions>
 		</dependency>
 
 		<!-- Core -->
@@ -212,7 +204,7 @@
 			<groupId>org.postgresql</groupId>
 			<artifactId>postgresql</artifactId>
 		</dependency>
-		
+
 		<dependency>
 			<groupId>org.eclipse.dirigible</groupId>
 			<artifactId>dirigible-database-mongodb-jdbc</artifactId>
@@ -236,6 +228,12 @@
 			<scope>runtime</scope>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>de.codecentric</groupId>
+			<artifactId>spring-boot-admin-starter-server</artifactId>
+			<version>${spring.admin.version}</version>
+			<scope>provided</scope>
+		</dependency>
 	</dependencies>
 
 	<dependencyManagement>
@@ -255,7 +253,6 @@
 			<plugin>
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-maven-plugin</artifactId>
-				<version>${spring.boot.version}</version>
 				<configuration>
 					<mainClass>org.eclipse.dirigible.DirigibleApplication</mainClass>
 				</configuration>
@@ -273,7 +270,6 @@
 			<plugin>
 				<groupId>pl.project13.maven</groupId>
 				<artifactId>git-commit-id-plugin</artifactId>
-				<version>${git-commit-id-plugin.version}</version>
 				<executions>
 					<execution>
 						<id>get-the-git-infos</id>
@@ -300,4 +296,28 @@
 		<parent.pom.folder>../../</parent.pom.folder>
 	</properties>
 
-</project>
+	<profiles>
+		<profile>
+			<id>default</id>
+			<activation>
+				<activeByDefault>true</activeByDefault>
+			</activation>
+		</profile>
+		<profile>
+			<id>spring-boot-admin</id>
+			<dependencies>
+				<dependency>
+					<groupId>de.codecentric</groupId>
+					<artifactId>spring-boot-admin-starter-server</artifactId>
+					<version>${spring.admin.version}</version>
+				</dependency>
+				<dependency>
+					<groupId>de.codecentric</groupId>
+					<artifactId>spring-boot-admin-starter-client</artifactId>
+					<version>${spring.admin.version}</version>
+				</dependency>
+			</dependencies>
+		</profile>
+	</profiles>
+
+</project>

build/application/src/main/java/org/eclipse/dirigible/DirigibleApplication.java

@@ -23,7 +23,9 @@
 import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
 import org.springframework.scheduling.annotation.EnableScheduling;
 import org.springframework.web.client.RestTemplate;
+import de.codecentric.boot.admin.server.config.EnableAdminServer;
 
+@EnableAdminServer
 @EnableJpaAuditing
 @EnableJpaRepositories
 @SpringBootApplication
@@ -37,17 +39,17 @@ public static void main(String[] args) {
     }
 
     @Bean
-    public RestTemplate restTemplate(RestTemplateBuilder builder) {
+    RestTemplate restTemplate(RestTemplateBuilder builder) {
         return builder.build();
     }
 
     @EventListener
-    public void onStartup(ApplicationReadyEvent event) {
+    void onStartup(@SuppressWarnings("unused") ApplicationReadyEvent event) {
         LOGGER.info("------------------------ Dirigible started ------------------------");
     }
 
     @EventListener
-    public void onShutdown(ContextClosedEvent event) {
+    void onShutdown(@SuppressWarnings("unused") ContextClosedEvent event) {
         LOGGER.info("------------------------ Dirigible stopped ------------------------");
     }
 }

build/application/src/main/resources/application-keycloak.properties

@@ -0,0 +1,11 @@
+basic.enabled=false
+
+# example https://keycloak.apps.dirigible.io/auth/realms/dirigible
+spring.security.oauth2.client.provider.keycloak.issuer-uri=${DIRIGIBLE_KEYCLOAK_AUTH_SERVER_URL}
+
+spring.security.oauth2.client.registration.keycloak.provider=keycloak
+spring.security.oauth2.client.registration.keycloak.client-id=${DIRIGIBLE_KEYCLOAK_CLIENT_ID}
+spring.security.oauth2.client.registration.keycloak.scope=openid,profile,roles,microprofile-jwt,email,phone,web-origins,address,offline_access
+spring.security.oauth2.client.registration.keycloak.authorization-grant-type=authorization_code
+
+spring.security.oauth2.client.provider.keycloak.user-name-attribute=preferred_username

build/application/src/main/resources/application-oauth.properties

@@ -0,0 +1,4 @@
+basic.enabled=false
+
+spring.security.oauth2.client.registration.github.clientId=${GITHUB_CLIENT_ID}
+spring.security.oauth2.client.registration.github.clientSecret=${GITHUB_CLIENT_SECRET}

build/application/src/main/resources/application-spring-boot-admin.properties

@@ -0,0 +1,9 @@
+spring.boot.admin.context-path=spring-admin
+spring.boot.admin.ui.title=${spring.application.name} Admin
+spring.boot.admin.ui.brand=<img src="/services/web/resources/images/dirigible.svg"><span>Eclipse Dirigible Admin</span>
+
+spring.boot.admin.client.url=http://localhost:${server.port}/spring-admin
+spring.boot.admin.client.username=${DIRIGIBLE_SPRING_ADMIN_USERNAME:admin}
+spring.boot.admin.client.password=${DIRIGIBLE_SPRING_ADMIN_PASSWORD:admin}
+spring.boot.admin.client.instance.metadata.user.name=${spring.boot.admin.client.username}
+spring.boot.admin.client.instance.metadata.user.password=${spring.boot.admin.client.password}

build/application/src/main/resources/application.properties

@@ -1,5 +1,9 @@
+spring.application.name=Eclipse Dirigible
+
 spring.main.allow-bean-definition-overriding=true
+
 server.error.include-message=always
+server.port=8080
 
 spring.servlet.multipart.enabled=true
 spring.servlet.multipart.file-size-threshold=2KB
@@ -12,24 +16,15 @@ spring.mvc.async.request-timeout=3600000
 
 basic.enabled=${DIRIGIBLE_BASIC_ENABLED:true}
 
-keycloak.enabled=${DIRIGIBLE_KEYCLOAK_ENABLED:false}
-keycloak.realm=${DIRIGIBLE_KEYCLOAK_REALM:null}
-keycloak.auth-server-url=${DIRIGIBLE_KEYCLOAK_AUTH_SERVER_URL:null}
-keycloak.ssl-required=${DIRIGIBLE_KEYCLOAK_SSL_REQUIRED:external}
-keycloak.resource=${DIRIGIBLE_KEYCLOAK_CLIENT_ID:null}
-keycloak.public-client=true
-keycloak.principal-attribute=preferred_username
-keycloak.confidential-port=${DIRIGIBLE_KEYCLOAK_CONFIDENTIAL_PORT:443}
-keycloak.use-resource-role-mappings=true
-
-oauth2.enabled=${DIRIGIBLE_OAUTH2_ENABLED:false}
-spring.security.oauth2.client.registration.github.clientId=${GITHUB_CLIENT_ID}
-spring.security.oauth2.client.registration.github.clientSecret=${GITHUB_CLIENT_SECRET}
-
 terminal.enabled=${DIRIGIBLE_TERMINAL_ENABLED:false}
 
 management.metrics.mongo.command.enabled=false
 management.metrics.mongo.connectionpool.enabled=false
 
 spring.devtools.restart.poll-interval=6s
-spring.devtools.restart.quiet-period=5s
+spring.devtools.restart.quiet-period=5s
+
+cxf.path=/odata/v2
+
+management.endpoints.web.exposure.include=mappings,caches,configprops,camelroutes,metrics,threaddump,heapdump,loggers,health,quartz,scheduledtasks,env,beans,conditions,info
+management.endpoints.health.show-details=always

build/application/src/main/resources/dirigible.properties

@@ -19,4 +19,6 @@ DIRIGIBLE_DATABASE_PROVIDER=local
 DIRIGIBLE_JAVASCRIPT_HANDLER_CLASS_NAME=org.eclipse.dirigible.graalium.handler.GraaliumJavascriptHandler
 DIRIGIBLE_GRAALIUM_ENABLE_DEBUG=true
 DIRIGIBLE_HOME_URL=services/web/ide/
-DIRIGIBLE_DATABASE_NAMES_CASE_SENSITIVE=true
+DIRIGIBLE_DATABASE_NAMES_CASE_SENSITIVE=true
+DIRIGIBLE_SPRING_ADMIN_USERNAME=admin
+DIRIGIBLE_SPRING_ADMIN_PASSWORD=admin