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

Feature/expose version through prometheus endpoint

Author: thewhitewizard

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 ## [[NEXT]](https://github.com/iExecBlockchainComputing/iexec-result-proxy/releases/tag/vNEXT) 2023
 
+### New Features
+
+- Expose version through prometheus endpoint and through VersionController. (#111)
+
 ### Bug Fixes
 
 - Remove duplicated call to blockchain in `ProxyService`. (#110)
@@ -17,6 +21,7 @@ All notable changes to this project will be documented in this file.
 - Upgrade to `eclipse-temurin:11.0.21_9-jre-focal`. (#109)
 - Upgrade to Spring Boot 2.7.17. (#108)
 - Upgrade to Spring Dependency Management Plugin 1.1.4. (#108)
+- Upgrade to Spring Doc OpenAPI 1.7.0. (#111)
 - Upgrade to `jenkins-library` 2.7.4. (#107)
 
 ## [[8.2.0]](https://github.com/iExecBlockchainComputing/iexec-result-proxy/releases/tag/v8.2.0) 2023-09-28

build.gradle

@@ -61,7 +61,7 @@ dependencies {
     runtimeOnly 'io.micrometer:micrometer-registry-prometheus'
 
     // Spring Doc
-    implementation 'org.springdoc:springdoc-openapi-ui:1.6.3'
+    implementation 'org.springdoc:springdoc-openapi-ui:1.7.0'
 
     // ipfs
     implementation 'com.github.ipfs:java-ipfs-http-client:1.4.0'

src/main/java/com/iexec/resultproxy/OpenApiConfig.java

@@ -1,18 +1,35 @@
+/*
+ * 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.resultproxy;
 
-import com.iexec.resultproxy.version.VersionService;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Info;
+import org.springframework.boot.info.BuildProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 @Configuration
 public class OpenApiConfig {
 
-    private final VersionService versionService;
+    public static final String TITLE = "iExec Result Proxy";
 
-    public OpenApiConfig(VersionService versionService) {
-        this.versionService = versionService;
+    private final BuildProperties buildProperties;
+
+    public OpenApiConfig(BuildProperties buildProperties) {
+        this.buildProperties = buildProperties;
     }
 
     /*
@@ -22,8 +39,8 @@ public OpenApiConfig(VersionService versionService) {
     public OpenAPI api() {
         return new OpenAPI().info(
                 new Info()
-                        .title("iExec Result Proxy")
-                        .version(versionService.getVersion())
+                        .title(TITLE)
+                        .version(buildProperties.getVersion())
         );
     }
-}
+}

src/main/java/com/iexec/resultproxy/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.resultproxy.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/resultproxy/version/VersionService.java

@@ -0,0 +1,56 @@
+/*
+ * 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.resultproxy;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+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().
+                extracting(OpenAPI::getInfo).isNotNull().
+                extracting(
+                        Info::getVersion,
+                        Info::getTitle
+                )
+                .containsExactly(buildProperties.getVersion(), OpenApiConfig.TITLE);
+    }
+}

src/test/java/com/iexec/resultproxy/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.resultproxy.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());
+    }
+}