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

Expose version through prometheus endpoint and through VersionController

Author: thewhitewizard

CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file.
 
 - Share code between transaction types in `IexecHubService`. (#556)
 - Expose Pre, App & Post-Compute durations. (#559, #560, #561, #562, #563, #565)
+- Expose version through prometheus endpoint and through VersionController. (#569)
 
 ### Quality
 

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

@@ -25,8 +25,8 @@
 import com.iexec.worker.feign.CustomCoreFeignClient;
 import com.iexec.worker.tee.scone.TeeSconeService;
 import com.iexec.worker.utils.LoggingUtils;
-import com.iexec.worker.version.VersionService;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.boot.info.BuildProperties;
 import org.springframework.cloud.context.restart.RestartEndpoint;
 import org.springframework.context.annotation.Bean;
 import org.springframework.stereotype.Service;
@@ -43,7 +43,7 @@ public class WorkerService {
     private final CoreConfigurationService coreConfigService;
     private final PublicConfigurationService publicConfigService;
     private final CustomCoreFeignClient customCoreFeignClient;
-    private final VersionService versionService;
+    private final BuildProperties buildProperties;
     private final TeeSconeService teeSconeService;
     private final RestartEndpoint restartEndpoint;
     private final DockerService dockerService;
@@ -53,7 +53,7 @@ public WorkerService(
             CoreConfigurationService coreConfigService,
             PublicConfigurationService publicConfigService,
             CustomCoreFeignClient customCoreFeignClient,
-            VersionService versionService,
+            BuildProperties buildProperties,
             TeeSconeService teeSconeService,
             RestartEndpoint restartEndpoint,
             DockerService dockerService,
@@ -62,7 +62,7 @@ public WorkerService(
         this.coreConfigService = coreConfigService;
         this.publicConfigService = publicConfigService;
         this.customCoreFeignClient = customCoreFeignClient;
-        this.versionService = versionService;
+        this.buildProperties = buildProperties;
         this.teeSconeService = teeSconeService;
         this.restartEndpoint = restartEndpoint;
         this.dockerService = dockerService;
@@ -77,10 +77,10 @@ public boolean registerWorker() {
         log.info("Got public configuration from the core [config:{}]", publicConfigService.getPublicConfiguration());
 
         if (!publicConfigService.getRequiredWorkerVersion().isEmpty() &&
-                !versionService.getVersion().equals(publicConfigService.getRequiredWorkerVersion())) {
+                !buildProperties.getVersion().equals(publicConfigService.getRequiredWorkerVersion())) {
 
             String badVersion = String.format("Bad version! please upgrade your iexec-worker [current:%s, required:%s]",
-                    versionService.getVersion(), publicConfigService.getRequiredWorkerVersion());
+                    buildProperties.getVersion(), publicConfigService.getRequiredWorkerVersion());
 
             LoggingUtils.printHighlightedMessage(badVersion);
             return false;

src/main/java/com/iexec/worker/worker/WorkerService.java

@@ -0,0 +1,80 @@
+/*
+ * 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.worker.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());
+    }
+}
+

src/test/java/com/iexec/worker/version/VersionControllerTests.java

@@ -23,19 +23,26 @@
 import com.iexec.worker.docker.DockerService;
 import com.iexec.worker.feign.CustomCoreFeignClient;
 import com.iexec.worker.tee.scone.TeeSconeService;
-import com.iexec.worker.version.VersionService;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.ArgumentCaptor;
 import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration;
+import org.springframework.boot.info.BuildProperties;
 import org.springframework.cloud.context.restart.RestartEndpoint;
+import org.springframework.context.annotation.Import;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
 
 import java.util.Collections;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.*;
 
+@ExtendWith(SpringExtension.class)
+@Import(ProjectInfoAutoConfiguration.class)
 class WorkerServiceTests {
     private static final String WORKER_WALLET_ADDRESS = "0x2D29bfBEc903479fe4Ba991918bAB99B494f2bEf";
 
@@ -48,8 +55,8 @@ class WorkerServiceTests {
     private PublicConfigurationService publicConfigService;
     @Mock
     private CustomCoreFeignClient customCoreFeignClient;
-    @Mock
-    private VersionService versionService;
+    @Autowired
+    private BuildProperties buildProperties;
     @Mock
     private TeeSconeService teeSconeService;
     @Mock
@@ -66,7 +73,7 @@ void beforeEach() {
                 coreConfigService,
                 publicConfigService,
                 customCoreFeignClient,
-                versionService,
+                buildProperties,
                 teeSconeService,
                 restartEndpoint,
                 dockerService,
@@ -76,7 +83,7 @@ void beforeEach() {
 
     @Test
     void shouldRegisterWorker() {
-        String version = "version";
+        String version = buildProperties.getVersion();
         String name = "name";
         String os = "os";
         String cpu = "cpu";
@@ -85,7 +92,6 @@ void shouldRegisterWorker() {
         boolean isTee = true;
         boolean isGpu = true;
         when(publicConfigService.getRequiredWorkerVersion()).thenReturn(version);
-        when(versionService.getVersion()).thenReturn(version);
         when(workerConfigService.getWorkerName()).thenReturn(name);
         when(workerConfigService.getOS()).thenReturn(os);
         when(workerConfigService.getCPU()).thenReturn(cpu);
@@ -117,7 +123,6 @@ void shouldRegisterWorker() {
     void shouldNotRegisterWorkerSinceBadVersion() {
         String version = "version";
         when(publicConfigService.getRequiredWorkerVersion()).thenReturn(version);
-        when(versionService.getVersion()).thenReturn("someOtherVersion");
 
         assertThat(workerService.registerWorker()).isFalse();