Merge pull request #122 from iExecBlockchainComputing/feature/expose-version-through-prometheus-endpoint

Expose version through prometheus endpoint and through VersionController

Author: thewhitewizard

CHANGELOG.md

@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
 - Send up to 2 blockchain transactions per block.
   With a big enough latency, the nonce is properly computed in web3j library against the pending block. (#111)
 - Add `BlockchainAdapterService` class to implement interactions with REST API. (#117 #118 #119)
+- Expose version through prometheus endpoint and through VersionController. (#122)
 
 ### Bug Fixes
 
@@ -27,6 +28,7 @@ All notable changes to this project will be documented in this file.
 - Upgrade to `eclipse-temurin:11.0.21_9-jre-focal`. (#121)
 - Upgrade to Spring Boot 2.7.17. (#120)
 - Upgrade to Spring Dependency Management Plugin 1.1.4. (#120)
+- Upgrade to Spring Doc OpenAPI 1.7.0. (#122)
 - Upgrade to `jenkins-library` 2.7.4. (#116)
 
 ## [[8.2.0]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/v8.2.0) 2023-09-28

build.gradle

@@ -69,7 +69,7 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-web'
 
     // Spring Doc
-    implementation 'org.springdoc:springdoc-openapi-ui:1.6.3'
+    implementation 'org.springdoc:springdoc-openapi-ui:1.7.0'
 
     // iexec
     implementation "com.iexec.commons:iexec-commons-poco:$iexecCommonsPocoVersion"

src/main/java/com/iexec/blockchain/swagger/OpenApiConfig.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,23 +16,25 @@
 
 package com.iexec.blockchain.swagger;
 
-
-import com.iexec.blockchain.version.VersionService;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Info;
 import io.swagger.v3.oas.models.security.SecurityScheme;
+import org.springframework.boot.info.BuildProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 @Configuration
 public class OpenApiConfig {
     public static final String SWAGGER_BASIC_AUTH = "basicAuth";
+    public static final String SWAGGER_SECURITY_SCHEME_KEY = "basicScheme";
+    public static final String SWAGGER_SECURITY_SCHEME = "basic";
+    public static final String TITLE = "iExec Blockchain Adapter";
 
-    private final VersionService versionService;
+    private final BuildProperties buildProperties;
 
-    public OpenApiConfig(VersionService versionService) {
-        this.versionService = versionService;
+    public OpenApiConfig(BuildProperties buildProperties) {
+        this.buildProperties = buildProperties;
     }
 
     /*
@@ -43,14 +45,14 @@ public OpenAPI api() {
         return new OpenAPI()
                 .info(
                         new Info()
-                                .title("iExec Blockchain Adapter")
-                                .version(versionService.getVersion())
+                                .title(TITLE)
+                                .version(buildProperties.getVersion())
                 )
                 .components(
                         new Components().addSecuritySchemes(
-                                "basicScheme", new SecurityScheme()
+                                SWAGGER_SECURITY_SCHEME_KEY, new SecurityScheme()
                                         .type(SecurityScheme.Type.HTTP)
-                                        .scheme("basic")
+                                        .scheme(SWAGGER_SECURITY_SCHEME)
                                         .in(SecurityScheme.In.HEADER)
                                         .name(SWAGGER_BASIC_AUTH)
                         )

src/main/java/com/iexec/blockchain/version/VersionController.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2023-2023 IEXEC BLOCKCHAIN TECH
+ *
+ * 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 com.iexec.blockchain.version;
+
+
+import io.micrometer.core.instrument.Gauge;
+import io.micrometer.core.instrument.Metrics;
+import org.springframework.boot.info.BuildProperties;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import javax.annotation.PostConstruct;
+
+@RestController
+public class VersionController {
+
+    public static final String METRIC_INFO_GAUGE_NAME = "iexec.version.info";
+    public static final String METRIC_INFO_GAUGE_DESC = "A metric to expose version and application name.";
+    public static final String METRIC_INFO_LABEL_APP_NAME = "iexecAppName";
+    public static final String METRIC_INFO_LABEL_APP_VERSION = "iexecAppVersion";
+
+    private final BuildProperties buildProperties;
+
+    public VersionController(BuildProperties buildProperties) {
+        this.buildProperties = buildProperties;
+    }
+
+    @PostConstruct
+    void initializeGaugeVersion() {
+        Gauge.builder(METRIC_INFO_GAUGE_NAME, 1.0, n -> n)
+                .description(METRIC_INFO_GAUGE_DESC)
+                .tags(METRIC_INFO_LABEL_APP_VERSION, buildProperties.getVersion(),
+                        METRIC_INFO_LABEL_APP_NAME, buildProperties.getName())
+                .register(Metrics.globalRegistry);
+    }
+
+    @GetMapping("/version")
+    public ResponseEntity<String> getVersion() {
+        return ResponseEntity.ok(buildProperties.getVersion());
+    }
+}

src/main/java/com/iexec/blockchain/version/VersionService.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2023-2023 IEXEC BLOCKCHAIN TECH
+ *
+ * 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 com.iexec.blockchain.swagger;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration;
+import org.springframework.boot.info.BuildProperties;
+import org.springframework.context.annotation.Import;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@ExtendWith(SpringExtension.class)
+@Import(ProjectInfoAutoConfiguration.class)
+class OpenApiConfigTests {
+
+    @Autowired
+    private BuildProperties buildProperties;
+
+    private OpenApiConfig openApiConfig;
+
+    @BeforeEach
+    void setUp() {
+        openApiConfig = new OpenApiConfig(buildProperties);
+    }
+
+    @Test
+    void shouldReturnOpenAPIObjectWithCorrectInfo() {
+        OpenAPI api = openApiConfig.api();
+        assertThat(api).isNotNull();
+
+        assertThat(api.getInfo()).isNotNull().
+                extracting(
+                        Info::getVersion,
+                        Info::getTitle
+                )
+                .containsExactly(buildProperties.getVersion(), OpenApiConfig.TITLE);
+
+        assertThat(api.getComponents()).isNotNull();
+        SecurityScheme securityScheme = api.getComponents().getSecuritySchemes().get(OpenApiConfig.SWAGGER_SECURITY_SCHEME_KEY);
+
+        assertThat(securityScheme)
+                .isNotNull()
+                .extracting(
+                        SecurityScheme::getType,
+                        SecurityScheme::getScheme,
+                        SecurityScheme::getIn,
+                        SecurityScheme::getName
+                )
+                .containsExactly(SecurityScheme.Type.HTTP, OpenApiConfig.SWAGGER_SECURITY_SCHEME, SecurityScheme.In.HEADER, OpenApiConfig.SWAGGER_BASIC_AUTH);
+    }
+}

src/test/java/com/iexec/blockchain/swagger/OpenApiConfigTests.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2023-2023 IEXEC BLOCKCHAIN TECH
+ *
+ * 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 com.iexec.blockchain.version;
+
+import io.micrometer.core.instrument.Gauge;
+import io.micrometer.core.instrument.Metrics;
+import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration;
+import org.springframework.boot.info.BuildProperties;
+import org.springframework.context.annotation.Import;
+import org.springframework.http.ResponseEntity;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@ExtendWith(SpringExtension.class)
+@Import(ProjectInfoAutoConfiguration.class)
+class VersionControllerTests {
+
+    private VersionController versionController;
+
+    @Autowired
+    private BuildProperties buildProperties;
+
+    @BeforeAll
+    static void initRegistry() {
+        Metrics.globalRegistry.add(new SimpleMeterRegistry());
+    }
+
+    @BeforeEach
+    void init() {
+        versionController = new VersionController(buildProperties);
+        versionController.initializeGaugeVersion();
+    }
+
+    @AfterEach
+    void afterEach() {
+        Metrics.globalRegistry.clear();
+    }
+
+    @Test
+    void testVersionController() {
+        assertEquals(ResponseEntity.ok(buildProperties.getVersion()), versionController.getVersion());
+    }
+
+    @Test
+    void shouldReturnInfoGauge() {
+        final Gauge info = Metrics.globalRegistry.find(VersionController.METRIC_INFO_GAUGE_NAME).gauge();
+        assertThat(info)
+                .isNotNull()
+                .extracting(Gauge::getId)
+                .isNotNull()
+                .extracting(
+                        id -> id.getTag(VersionController.METRIC_INFO_LABEL_APP_NAME),
+                        id -> id.getTag(VersionController.METRIC_INFO_LABEL_APP_VERSION)
+                )
+                .containsExactly(buildProperties.getName(), buildProperties.getVersion());
+    }
+}