-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Add missing config values to mapper (#405)
Signed-off-by: georgi-l95 <glazarov95@gmail.com>
- Loading branch information
1 parent
a81b59b
commit 6c75418
Showing
6 changed files
with
208 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletions
70
...c/main/java/com/hedera/block/simulator/config/SimulatorMappedConfigSourceInitializer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /* | ||
| * Copyright (C) 2024 Hedera Hashgraph, LLC | ||
| * | ||
| * 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.hedera.block.simulator.config; | ||
|
|
||
| import com.swirlds.config.extensions.sources.ConfigMapping; | ||
| import com.swirlds.config.extensions.sources.MappedConfigSource; | ||
| import com.swirlds.config.extensions.sources.SystemEnvironmentConfigSource; | ||
| import edu.umd.cs.findbugs.annotations.NonNull; | ||
| import java.util.List; | ||
|
|
||
| /** | ||
| * A class that extends {@link MappedConfigSource} in order to have project-relevant initialization. | ||
| */ | ||
| public final class SimulatorMappedConfigSourceInitializer { | ||
| private static final List<ConfigMapping> MAPPINGS = List.of( | ||
| // gRPC configuration | ||
| new ConfigMapping("grpc.serverAddress", "GRPC_SERVER_ADDRESS"), | ||
| new ConfigMapping("grpc.port", "GRPC_PORT"), | ||
|
|
||
| // Block stream configuration | ||
| new ConfigMapping("blockStream.simulatorMode", "BLOCK_STREAM_SIMULATOR_MODE"), | ||
| new ConfigMapping("blockStream.delayBetweenBlockItems", "BLOCK_STREAM_DELAY_BETWEEN_BLOCK_ITEMS"), | ||
| new ConfigMapping("blockStream.maxBlockItemsToStream", "BLOCK_STREAM_MAX_BLOCK_ITEMS_TO_STREAM"), | ||
| new ConfigMapping("blockStream.streamingMode", "BLOCK_STREAM_STREAMING_MODE"), | ||
| new ConfigMapping("blockStream.millisecondsPerBlock", "BLOCK_STREAM_MILLISECONDS_PER_BLOCK"), | ||
| new ConfigMapping("blockStream.blockItemsBatchSize", "BLOCK_STREAM_BLOCK_ITEMS_BATCH_SIZE"), | ||
|
|
||
| // Block generator configuration | ||
| new ConfigMapping("generator.generationMode", "GENERATOR_GENERATION_MODE"), | ||
| new ConfigMapping("generator.folderRootPath", "GENERATOR_FOLDER_ROOT_PATH"), | ||
| new ConfigMapping("generator.managerImplementation", "GENERATOR_MANAGER_IMPLEMENTATION"), | ||
| new ConfigMapping("generator.paddedLength", "GENERATOR_PADDED_LENGTH"), | ||
| new ConfigMapping("generator.fileExtension", "GENERATOR_FILE_EXTENSION"), | ||
| new ConfigMapping("generator.startBlockNumber", "GENERATOR_START_BLOCK_NUMBER"), | ||
| new ConfigMapping("generator.endBlockNumber", "GENERATOR_END_BLOCK_NUMBER"), | ||
|
|
||
| // Prometheus configuration | ||
| new ConfigMapping("prometheus.endpointEnabled", "PROMETHEUS_ENDPOINT_ENABLED"), | ||
| new ConfigMapping("prometheus.endpointPortNumber", "PROMETHEUS_ENDPOINT_PORT_NUMBER")); | ||
|
|
||
| private SimulatorMappedConfigSourceInitializer() {} | ||
|
|
||
| /** | ||
| * This method constructs, initializes and returns a new instance of {@link MappedConfigSource} | ||
| * which internally uses {@link SystemEnvironmentConfigSource} and maps relevant config keys to | ||
| * other keys so that they could be used within the application | ||
| * | ||
| * @return newly constructed fully initialized {@link MappedConfigSource} | ||
| */ | ||
| @NonNull | ||
| public static MappedConfigSource getMappedConfigSource() { | ||
| final MappedConfigSource config = new MappedConfigSource(SystemEnvironmentConfigSource.getInstance()); | ||
| MAPPINGS.forEach(config::addMapping); | ||
| return config; | ||
| } | ||
| } |
99 changes: 99 additions & 0 deletions
99
...st/java/com/hedera/block/simulator/config/SimulatorMappedConfigSourceInitializerTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| /* | ||
| * Copyright (C) 2024 Hedera Hashgraph, LLC | ||
| * | ||
| * 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.hedera.block.simulator.config; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| import com.swirlds.config.extensions.sources.ConfigMapping; | ||
| import com.swirlds.config.extensions.sources.MappedConfigSource; | ||
| import java.lang.reflect.Field; | ||
| import java.util.Queue; | ||
| import java.util.function.Predicate; | ||
| import org.junit.jupiter.api.BeforeAll; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| class SimulatorMappedConfigSourceInitializerTest { | ||
| private static final ConfigMapping[] SUPPORTED_MAPPINGS = { | ||
| // gRPC configuration | ||
| new ConfigMapping("grpc.serverAddress", "GRPC_SERVER_ADDRESS"), | ||
| new ConfigMapping("grpc.port", "GRPC_PORT"), | ||
|
|
||
| // Block stream configuration | ||
| new ConfigMapping("blockStream.simulatorMode", "BLOCK_STREAM_SIMULATOR_MODE"), | ||
| new ConfigMapping("blockStream.delayBetweenBlockItems", "BLOCK_STREAM_DELAY_BETWEEN_BLOCK_ITEMS"), | ||
| new ConfigMapping("blockStream.maxBlockItemsToStream", "BLOCK_STREAM_MAX_BLOCK_ITEMS_TO_STREAM"), | ||
| new ConfigMapping("blockStream.streamingMode", "BLOCK_STREAM_STREAMING_MODE"), | ||
| new ConfigMapping("blockStream.millisecondsPerBlock", "BLOCK_STREAM_MILLISECONDS_PER_BLOCK"), | ||
| new ConfigMapping("blockStream.blockItemsBatchSize", "BLOCK_STREAM_BLOCK_ITEMS_BATCH_SIZE"), | ||
|
|
||
| // Block generator configuration | ||
| new ConfigMapping("generator.generationMode", "GENERATOR_GENERATION_MODE"), | ||
| new ConfigMapping("generator.folderRootPath", "GENERATOR_FOLDER_ROOT_PATH"), | ||
| new ConfigMapping("generator.managerImplementation", "GENERATOR_MANAGER_IMPLEMENTATION"), | ||
| new ConfigMapping("generator.paddedLength", "GENERATOR_PADDED_LENGTH"), | ||
| new ConfigMapping("generator.fileExtension", "GENERATOR_FILE_EXTENSION"), | ||
| new ConfigMapping("generator.startBlockNumber", "GENERATOR_START_BLOCK_NUMBER"), | ||
| new ConfigMapping("generator.endBlockNumber", "GENERATOR_END_BLOCK_NUMBER"), | ||
|
|
||
| // Prometheus configuration | ||
| new ConfigMapping("prometheus.endpointEnabled", "PROMETHEUS_ENDPOINT_ENABLED"), | ||
| new ConfigMapping("prometheus.endpointPortNumber", "PROMETHEUS_ENDPOINT_PORT_NUMBER") | ||
| }; | ||
| private static MappedConfigSource toTest; | ||
|
|
||
| @BeforeAll | ||
| static void setUp() { | ||
| toTest = SimulatorMappedConfigSourceInitializer.getMappedConfigSource(); | ||
| } | ||
|
|
||
| /** | ||
| * This test aims to fail if we have added or removed any {@link ConfigMapping} that will be | ||
| * initialized by the {@link SimulatorMappedConfigSourceInitializer#getMappedConfigSource()} | ||
| * without reflecting it here in the test. The purpose is to bring attention to any changes to | ||
| * the developer so we can make sure we are aware of them in order to be sure we require the | ||
| * change. This test is more to bring attention than to test actual logic. So if this fails, we | ||
| * either change the {@link #SUPPORTED_MAPPINGS} here or the {@link | ||
| * SimulatorMappedConfigSourceInitializer#MAPPINGS} to make this pass. | ||
| */ | ||
| @Test | ||
| void test_VerifyAllSupportedMappingsAreAddedToInstance() throws ReflectiveOperationException { | ||
| final Queue<ConfigMapping> actual = extractConfigMappings(); | ||
|
|
||
| assertEquals(SUPPORTED_MAPPINGS.length, actual.size()); | ||
|
|
||
| for (final ConfigMapping current : SUPPORTED_MAPPINGS) { | ||
| final Predicate<ConfigMapping> predicate = | ||
| cm -> current.mappedName().equals(cm.mappedName()) | ||
| && current.originalName().equals(cm.originalName()); | ||
| assertTrue( | ||
| actual.stream().anyMatch(predicate), | ||
| () -> "when testing for: [%s] it is not contained in mappings of the actual initialized object %s" | ||
| .formatted(current, actual)); | ||
| } | ||
| } | ||
|
|
||
| private static Queue<ConfigMapping> extractConfigMappings() throws ReflectiveOperationException { | ||
| final Field configMappings = MappedConfigSource.class.getDeclaredField("configMappings"); | ||
| try { | ||
| configMappings.setAccessible(true); | ||
| return (Queue<ConfigMapping>) configMappings.get(toTest); | ||
| } finally { | ||
| configMappings.setAccessible(false); | ||
| } | ||
| } | ||
| } |