Merge split URL configuration properties to a single URL field (#748)

nabil-Tounarti · web-flow · commit 08cdeeeedaf2 · 2025-03-26T15:20:54.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,7 +20,6 @@ All notable changes to this project will be documented in this file.
 - Compute alive workers metrics in `WorkerService#updateMetrics` scheduled job. (#739 #745)
 - Fix Spring Security deprecations after Spring Boot 3.3.8 upgrade. (#740)
 - Remove code related to reopen PoCo feature in `IexecHubService` and `TaskUpdateManager`. (#743)
-- Harmonize YML internal variables to proper case. (#744)
 
 ### Breaking API changes
 
@@ -31,6 +30,8 @@ All notable changes to this project will be documented in this file.
 - Remove deprecated methods in `iexec-core-library`. (#737)
 - Remove unused `ContributionUtils` class. (#738)
 - Rework metrics to expose count of computing CPUs or GPUs instead of available ones. (#739)
+- Harmonize YML internal variables to proper case. (#744)
+- Merge split URL configuration properties (protocol, host, port) to a single URL field to offer URL validation at startup. (#748)
 
 ### Dependency Upgrades
 
diff --git a/README.md b/README.md
@@ -39,17 +39,11 @@ You can configure the _iExec Core Scheduler_ with the following properties:
 | `IEXEC_START_BLOCK_NUMBER` | Subscribe to new deal events from a specific block number. | Positive integer | `0` |
 | `IEXEC_GAS_PRICE_MULTIPLIER` | Transactions will be sent with `networkGasPrice * gasPriceMultiplier`. | Float | `1.0` |
 | `IEXEC_GAS_PRICE_CAP` | In Wei, will be used for transactions if `networkGasPrice * gasPriceMultiplier > gasPriceCap` | Integer | `22000000000` |
-| `IEXEC_CORE_CHAIN_ADAPTER_PROTOCOL` | _iExec Blockchain Adapter_ communication protocol. | String | `http` |
-| `IEXEC_CORE_CHAIN_ADAPTER_HOST` | _iExec Blockchain Adapter_ server host. | String | `localhost` |
-| `IEXEC_CORE_CHAIN_ADAPTER_PORT` | _iExec Blockchain Adapter_ server port. | Positive integer | `13010` |
+| `IEXEC_CORE_CHAIN_ADAPTER_URL` | _iExec Blockchain Adapter_ communication url. | String | `http://localhost:13010`|
 | `IEXEC_CORE_CHAIN_ADAPTER_USERNAME` | Username to connect to the _iExec Blockchain Adapter_ server. | String | `admin` |
 | `IEXEC_CORE_CHAIN_ADAPTER_PASSWORD` | Password to connect to the _iExec Blockchain Adapter_ server. | String | `whatever` |
-| `IEXEC_CONFIG_SERVER_PROTOCOL` | _iExec Config Server_ communication protocol. | String | `http` |
-| `IEXEC_CONFIG_SERVER_HOST` | _iExec Config Server_ host. | String | `localhost` |
-| `IEXEC_CONFIG_SERVER_PORT` | _iExec Config Server_ port. | Positive integer | `8888` |
-| `IEXEC_RESULT_REPOSITORY_PROTOCOL` | _iExec Result Proxy_ server communication protocol. | String | `http` |
-| `IEXEC_RESULT_REPOSITORY_HOST` | _iExec Result Proxy_ server host. | String | `localhost` |
-| `IEXEC_RESULT_REPOSITORY_PORT` | _iExec Result Proxy_ server port. | Positive integer | `13200` |
+| `IEXEC_CONFIG_SERVER_URL` | _iExec Config Server_ communication url. | String | `http://localhost:8888`|
+| `IEXEC_RESULT_REPOSITORY_URL` | _iExec Result Proxy_ server communication url. | String | `http://localhost:13200`|
 | `IEXEC_CORE_MANAGEMENT_ACTUATORS` | Endpoint IDs that should be included or `*` for all. | String | `health, info` |
 | `IEXEC_LOGS_PURGE_RATE_IN_DAYS` | Interval in days between 2 executions of the purge mechanism. | Positive integer | `1` |
 | `IEXEC_LOGS_AVAILABILITY_PERIOD_IN_DAYS` | Number of days to keep logs of past tasks. | Positive integer | `3` |
diff --git a/src/main/java/com/iexec/core/chain/adapter/BlockchainAdapterClientConfig.java b/src/main/java/com/iexec/core/chain/adapter/BlockchainAdapterClientConfig.java
@@ -20,42 +20,42 @@
 import com.iexec.blockchain.api.BlockchainAdapterApiClientBuilder;
 import com.iexec.blockchain.api.BlockchainAdapterService;
 import feign.Logger;
-import lombok.Data;
-import org.springframework.beans.factory.annotation.Value;
+import jakarta.validation.constraints.NotEmpty;
+import lombok.Value;
+import org.hibernate.validator.constraints.URL;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.annotation.Bean;
+import org.springframework.validation.annotation.Validated;
 
 import java.time.Duration;
 
-@Data
+@Value
+@Validated
 @ConfigurationProperties(prefix = "blockchain-adapter")
 public class BlockchainAdapterClientConfig {
 
     // TODO add configuration parameters for next major version
     public static final int WATCH_PERIOD_SECONDS = 2;
     public static final int MAX_ATTEMPTS = 25;
 
-    private final String protocol;
-    private final String host;
-    private final int port;
-    // TODO improve property names before next major version
-    @Value("${blockchain-adapter.user.name}")
-    private final String username;
-    @Value("${blockchain-adapter.user.password}")
-    private final String password;
-
-    private String buildHostUrl(String protocol, String host, int port) {
-        return protocol + "://" + host + ":" + port;
-    }
+    @URL(message = "URL must be a valid URL")
+    @NotEmpty(message = "URL must not be empty")
+    String url;
+
+    BlockchainAdapterAuth auth;
 
     @Bean
     public BlockchainAdapterApiClient blockchainAdapterClient() {
         return BlockchainAdapterApiClientBuilder.getInstanceWithBasicAuth(
-                Logger.Level.NONE, buildHostUrl(protocol, host, port), username, password);
+                Logger.Level.NONE, url, auth.username(), auth.password());
     }
 
     @Bean
     public BlockchainAdapterService blockchainAdapterService(BlockchainAdapterApiClient blockchainAdapterClient) {
         return new BlockchainAdapterService(blockchainAdapterClient, Duration.ofSeconds(WATCH_PERIOD_SECONDS), MAX_ATTEMPTS);
     }
+
+    record BlockchainAdapterAuth(String username, String password
+    ) {
+    }
 }
diff --git a/src/main/java/com/iexec/core/configuration/ConfigServerClientConfig.java b/src/main/java/com/iexec/core/configuration/ConfigServerClientConfig.java
@@ -20,26 +20,26 @@
 import com.iexec.common.config.ConfigServerClientBuilder;
 import com.iexec.common.config.PublicChainConfig;
 import feign.Logger;
-import lombok.Data;
+import jakarta.validation.constraints.NotEmpty;
+import lombok.Value;
+import org.hibernate.validator.constraints.URL;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.annotation.Bean;
+import org.springframework.validation.annotation.Validated;
 
-@Data
+@Value
+@Validated
 @ConfigurationProperties(prefix = "config-server")
 public class ConfigServerClientConfig {
 
-    private final String protocol;
-    private final String host;
-    private final int port;
-
-    public String getUrl() {
-        return protocol + "://" + host + ":" + port;
-    }
+    @URL(message = "URL must be a valid URL")
+    @NotEmpty(message = "URL must not be empty")
+    String url;
 
     @Bean
     public ConfigServerClient configServerClient() {
         return ConfigServerClientBuilder.getInstance(
-                Logger.Level.NONE, getUrl());
+                Logger.Level.NONE, url);
     }
 
     @Bean
diff --git a/src/main/java/com/iexec/core/configuration/PublicConfigurationService.java b/src/main/java/com/iexec/core/configuration/PublicConfigurationService.java
@@ -63,7 +63,7 @@ void buildPublicConfiguration() {
                 .workerPoolAddress(chainConfig.getPoolAddress())
                 .configServerUrl(configServerClientConfig.getUrl())
                 .schedulerPublicAddress(signerService.getAddress())
-                .resultRepositoryURL(resultRepoConfig.getResultRepositoryURL())
+                .resultRepositoryURL(resultRepoConfig.getUrl())
                 .askForReplicatePeriod(workerConfiguration.getAskForReplicatePeriod())
                 .requiredWorkerVersion(workerConfiguration.getRequiredWorkerVersion())
                 .build();
diff --git a/src/main/java/com/iexec/core/configuration/ResultRepositoryConfiguration.java b/src/main/java/com/iexec/core/configuration/ResultRepositoryConfiguration.java
@@ -19,26 +19,26 @@
 import com.iexec.resultproxy.api.ResultProxyClient;
 import com.iexec.resultproxy.api.ResultProxyClientBuilder;
 import feign.Logger;
+import jakarta.validation.constraints.NotEmpty;
 import lombok.Value;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
+import org.hibernate.validator.constraints.URL;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.validation.annotation.Validated;
 
 @Value
+@Validated
 @ConfigurationProperties(prefix = "result-repository")
 @Slf4j
 public class ResultRepositoryConfiguration {
-    String protocol;
-    String host;
-    String port;
-
-    public String getResultRepositoryURL() {
-        return protocol + "://" + host + ":" + port;
-    }
+    @URL(message = "URL must be a valid URL")
+    @NotEmpty(message = "URL must not be empty")
+    String url;
 
     public ResultProxyClient createResultProxyClientFromURL(final String url) {
         final boolean useDefaultUrl = StringUtils.isBlank(url);
-        final String resultProxyClientURL = useDefaultUrl ? getResultRepositoryURL() : url;
+        final String resultProxyClientURL = useDefaultUrl ? getUrl() : url;
         log.debug("result-proxy URL [url:{}, default-url:{}]", resultProxyClientURL, useDefaultUrl);
         return ResultProxyClientBuilder.getInstance(Logger.Level.NONE, resultProxyClientURL);
     }
diff --git a/src/main/java/com/iexec/core/sms/SmsService.java b/src/main/java/com/iexec/core/sms/SmsService.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2024 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2025 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.
@@ -199,7 +199,7 @@ private boolean isWorkerpoolResultProxyUrlPresent(final String smsURL) {
     public void pushWorkerpoolResultProxyUrl(final TaskInitializedEvent event) {
         log.debug("pushWorkerpoolResultProxyUrl [event:{}]", event);
         try {
-            final String resultProxyURL = resultRepositoryConfiguration.getResultRepositoryURL();
+            final String resultProxyURL = resultRepositoryConfiguration.getUrl();
             final String smsURL = getVerifiedSmsUrl(event.getChainTaskId()).orElseThrow();
             log.debug("Pushing result-proxy default URL to SMS [sms:{}, result-proxy:{}]", smsURL, resultProxyURL);
             final SmsClient smsClient = smsClientProvider.getSmsClient(smsURL);
diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml
@@ -58,22 +58,16 @@ chain:
   gas-price-cap: ${IEXEC_GAS_PRICE_CAP:22000000000} #in Wei, will be used for txs if networkGasPrice*gasPriceMultiplier > gasPriceCap
 
 blockchain-adapter:
-  protocol: ${IEXEC_CORE_CHAIN_ADAPTER_PROTOCOL:http}
-  host: ${IEXEC_CORE_CHAIN_ADAPTER_HOST:localhost}
-  port: ${IEXEC_CORE_CHAIN_ADAPTER_PORT:13010}
-  user:
-    name: ${IEXEC_CORE_CHAIN_ADAPTER_USERNAME:admin}
+  url: ${IEXEC_CORE_CHAIN_ADAPTER_URL:http://localhost:13010}
+  auth:
+    username: ${IEXEC_CORE_CHAIN_ADAPTER_USERNAME:admin}
     password: ${IEXEC_CORE_CHAIN_ADAPTER_PASSWORD:whatever}
 
 config-server:
-  protocol: ${IEXEC_CONFIG_SERVER_PROTOCOL:http}
-  host: ${IEXEC_CONFIG_SERVER_HOST:localhost}
-  port: ${IEXEC_CONFIG_SERVER_PORT:8888}
+  url: ${IEXEC_CONFIG_SERVER_URL:http://localhost:8888}
 
 result-repository:
-  protocol: ${IEXEC_RESULT_REPOSITORY_PROTOCOL:http}
-  host: ${IEXEC_RESULT_REPOSITORY_HOST:localhost}
-  port: ${IEXEC_RESULT_REPOSITORY_PORT:13200}
+  url: ${IEXEC_RESULT_REPOSITORY_URL:http://localhost:13200}
 
 management:
   endpoints:
diff --git a/src/test/java/com/iexec/core/chain/WebSocketBlockchainListenerTests.java b/src/test/java/com/iexec/core/chain/WebSocketBlockchainListenerTests.java
@@ -62,8 +62,10 @@ static void registerProperties(DynamicPropertyRegistry registry) {
                 environment.getServiceHost(CHAIN_SVC_NAME, CHAIN_SVC_PORT),
                 environment.getServicePort(CHAIN_SVC_NAME, CHAIN_SVC_PORT))
         );
-        registry.add("config-server.host", () -> environment.getServiceHost(CONFIG_SVC_NAME, CONFIG_SVC_PORT));
-        registry.add("config-server.port", () -> environment.getServicePort(CONFIG_SVC_NAME, CONFIG_SVC_PORT));
+        registry.add("config-server.url", () -> getServiceUrl(
+                environment.getServiceHost(CONFIG_SVC_NAME, CONFIG_SVC_PORT),
+                environment.getServicePort(CONFIG_SVC_NAME, CONFIG_SVC_PORT))
+        );
         registry.add("sprint.data.mongodb.host", () -> environment.getServiceHost(MONGO_SVC_NAME, MONGO_SVC_PORT));
         registry.add("spring.data.mongodb.port", () -> environment.getServicePort(MONGO_SVC_NAME, MONGO_SVC_PORT));
     }
diff --git a/src/test/java/com/iexec/core/chain/adapter/BlockchainAdapterClientConfigTests.java b/src/test/java/com/iexec/core/chain/adapter/BlockchainAdapterClientConfigTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2024 IEXEC BLOCKCHAIN TECH
+ * Copyright 2021-2025 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.
@@ -39,9 +39,9 @@ class BlockchainAdapterClientConfigTests {
 
     @DynamicPropertySource
     static void registerProperties(DynamicPropertyRegistry registry) {
-        registry.add("blockchain-adapter.protocol", () -> "http");
-        registry.add("blockchain-adapter.host", () -> "localhost");
-        registry.add("blockchain-adapter.port", () -> "13010");
+        registry.add("blockchain-adapter.url", () -> "http://localhost:13010");
+        registry.add("blockchain-adapter.auth.username", () -> "admin");
+        registry.add("blockchain-adapter.auth.password", () -> "whatever");
     }
 
     @Test
diff --git a/src/test/java/com/iexec/core/configuration/ConfigServerClientConfigTests.java b/src/test/java/com/iexec/core/configuration/ConfigServerClientConfigTests.java
@@ -54,9 +54,7 @@ class ConfigServerClientConfigTests {
 
     @DynamicPropertySource
     static void registerProperties(DynamicPropertyRegistry registry) {
-        registry.add("config-server.protocol", () -> "http");
-        registry.add("config-server.host", () -> "localhost");
-        registry.add("config-server.port", () -> wmServer.getMappedPort(WIREMOCK_PORT));
+        registry.add("config-server.url", () -> "http://localhost:" + wmServer.getMappedPort(WIREMOCK_PORT));
     }
 
     @Test
diff --git a/src/test/java/com/iexec/core/configuration/ResultRepositoryConfigurationTest.java b/src/test/java/com/iexec/core/configuration/ResultRepositoryConfigurationTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 IEXEC BLOCKCHAIN TECH
+ * Copyright 2024-2025 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.
@@ -32,23 +32,21 @@
 @ExtendWith(MockitoExtension.class)
 class ResultRepositoryConfigurationTest {
 
-    private final ResultRepositoryConfiguration config = new ResultRepositoryConfiguration(PROTOCOL, HOST, PORT);
+    private final ResultRepositoryConfiguration config = new ResultRepositoryConfiguration(URL);
 
-    private static final String PROTOCOL = "http";
-    private static final String HOST = "localhost";
-    private static final String PORT = "8080";
+    private static final String URL = "http://localhost:8080";
 
     @Test
     void shouldReturnCorrectResultRepositoryURL() {
         String expectedUrl = "http://localhost:8080";
-        assertEquals(expectedUrl, config.getResultRepositoryURL());
+        assertEquals(expectedUrl, config.getUrl());
     }
 
     @Test
     void shouldCreateResultProxyClientWithDefaultUrlWhenProxyUrlIsNullOrEmpty() {
         try (MockedStatic<ResultProxyClientBuilder> mockedBuilder = mockStatic(ResultProxyClientBuilder.class)) {
             ResultProxyClient mockClient = mock(ResultProxyClient.class);
-            String defaultUrl = config.getResultRepositoryURL();
+            String defaultUrl = config.getUrl();
 
             mockedBuilder.when(() -> ResultProxyClientBuilder.getInstance(eq(Logger.Level.NONE), eq(defaultUrl)))
                     .thenReturn(mockClient);
diff --git a/src/test/java/com/iexec/core/replicate/ReplicateSupplyServiceTests.java b/src/test/java/com/iexec/core/replicate/ReplicateSupplyServiceTests.java
@@ -433,7 +433,7 @@ void shouldGetReplicateWithNoTee() {
                 .thenReturn(Optional.of(runningTask));
         when(replicatesService.getReplicatesList(CHAIN_TASK_ID)).thenReturn(Optional.of(replicatesList));
         when(signatureService.createAuthorization(WALLET_WORKER_1, CHAIN_TASK_ID, BytesUtils.EMPTY_ADDRESS))
-                .thenReturn(new WorkerpoolAuthorization());
+                .thenReturn(WorkerpoolAuthorization.builder().build());
         when(replicatesList.hasWorkerAlreadyParticipated(WALLET_WORKER_1)).thenReturn(false);
         when(workerService.addChainTaskIdToWorker(CHAIN_TASK_ID, WALLET_WORKER_1))
                 .thenReturn(Optional.of(existingWorker));
@@ -475,7 +475,7 @@ void shouldGetReplicateWithTee() {
                 .thenReturn(Optional.of(runningTask));
         when(replicatesService.getReplicatesList(CHAIN_TASK_ID)).thenReturn(Optional.of(replicatesList));
         when(signatureService.createAuthorization(WALLET_WORKER_1, CHAIN_TASK_ID, ENCLAVE_CHALLENGE))
-                .thenReturn(new WorkerpoolAuthorization());
+                .thenReturn(WorkerpoolAuthorization.builder().build());
         when(workerService.addChainTaskIdToWorker(CHAIN_TASK_ID, WALLET_WORKER_1))
                 .thenReturn(Optional.of(existingWorker));
         when(replicatesService.addNewReplicate(replicatesList, WALLET_WORKER_1))
@@ -544,7 +544,7 @@ void shouldTeeNeededTaskBeGivenToTeeEnabledWorker() {
                 .thenReturn(Optional.of(runningTask));
         when(replicatesService.getReplicatesList(CHAIN_TASK_ID)).thenReturn(Optional.of(replicatesList));
         when(signatureService.createAuthorization(WALLET_WORKER_1, CHAIN_TASK_ID, ENCLAVE_CHALLENGE))
-                .thenReturn(new WorkerpoolAuthorization());
+                .thenReturn(WorkerpoolAuthorization.builder().build());
         when(workerService.addChainTaskIdToWorker(CHAIN_TASK_ID, WALLET_WORKER_1))
                 .thenReturn(Optional.of(existingWorker));
         when(replicatesService.addNewReplicate(replicatesList, WALLET_WORKER_1))
diff --git a/src/test/java/com/iexec/core/sms/SmsServiceTests.java b/src/test/java/com/iexec/core/sms/SmsServiceTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2024 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2025 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.
@@ -235,7 +235,7 @@ private void initEnclaveChallengeStubs() {
     }
 
     private void initResultProxyStubs() {
-        when(resultRepositoryConfiguration.getResultRepositoryURL()).thenReturn(RESULT_PROXY_URL);
+        when(resultRepositoryConfiguration.getUrl()).thenReturn(RESULT_PROXY_URL);
         when(iexecHubService.getTaskDescription(CHAIN_TASK_ID)).thenReturn(
                 TaskDescription.builder().teeFramework(TeeFramework.SCONE).build());
         when(registryConfiguration.getSconeSms()).thenReturn(SCONE_SMS_URL);
