chore: 13093: Validator - migrate to java module and fix build (#19183)

Signed-off-by: Artur Kugal <[email protected]>

Author: akugal

hedera-node/hedera-app/src/main/java/module-info.java

@@ -67,7 +67,8 @@
     exports com.hedera.node.app.workflows;
     exports com.hedera.node.app.state.merkle to
             com.hedera.node.app.test.fixtures,
-            com.hedera.node.test.clients;
+            com.hedera.node.test.clients,
+            com.swirlds.state.validator;
     exports com.hedera.node.app.workflows.dispatcher;
     exports com.hedera.node.app.workflows.standalone;
     exports com.hedera.node.app.config;

hedera-node/hedera-consensus-service-impl/src/main/java/module-info.java

@@ -27,7 +27,8 @@
 
     exports com.hedera.node.app.service.consensus.impl to
             com.hedera.node.app,
-            com.hedera.node.test.clients;
+            com.hedera.node.test.clients,
+            com.swirlds.state.validator;
     exports com.hedera.node.app.service.consensus.impl.handlers;
     exports com.hedera.node.app.service.consensus.impl.handlers.customfee;
     exports com.hedera.node.app.service.consensus.impl.records;

hedera-state-validator/build.gradle.kts

@@ -4,29 +4,6 @@ plugins {
     id("org.hiero.gradle.feature.shadow")
 }
 
-dependencies {
-
-    implementation("info.picocli:picocli:4.7.0")
-    implementation("org.apache.logging.log4j:log4j-api:2.17.2")
-    implementation("org.apache.logging.log4j:log4j-core:2.17.2")
-
-    // used to write json report
-    implementation("com.google.code.gson:gson:2.10")
-}
-
-mainModuleInfo {
-    requires ("com.hedera.node.app")
-    requires ("com.hedera.node.app.test.fixtures")
-
-    requires ("com.swirlds.merkledb")
-
-
-    // Define the individual libraries
-    // JUnit Bundle
-    requires("org.junit.jupiter.api")
-    requires("org.junit.jupiter.engine")
-    requires("org.junit.platform.launcher")
-
-}
+mainModuleInfo { runtimeOnly("org.junit.jupiter.engine") }
 
 application.mainClass = "com.hedera.statevalidation.StateOperatorCommand"

hedera-state-validator/src/main/java/com/hedera/statevalidation/Constants.java

@@ -1,19 +1,4 @@
-/*
- * Copyright (C) 2023 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.
- */
-
+// SPDX-License-Identifier: Apache-2.0
 package com.hedera.statevalidation;
 
 import java.nio.file.Path;

hedera-state-validator/src/main/java/com/hedera/statevalidation/IntrospectCommand.java

@@ -1,18 +1,18 @@
+// SPDX-License-Identifier: Apache-2.0
 package com.hedera.statevalidation;
 
+import static picocli.CommandLine.*;
+
 import com.hedera.statevalidation.introspectors.KvIntrospector;
 import com.hedera.statevalidation.introspectors.SingletonIntrospector;
 import com.hedera.statevalidation.parameterresolver.StateResolver;
 import com.swirlds.platform.state.snapshot.DeserializedSignedState;
 import com.swirlds.state.State;
-import picocli.CommandLine.ParentCommand;
-
 import java.io.IOException;
-
-import static picocli.CommandLine.*;
+import picocli.CommandLine.ParentCommand;
 
 @Command(name = "introspect", description = "Introspects the state")
-public class IntrospectCommand implements Runnable{
+public class IntrospectCommand implements Runnable {
 
     @ParentCommand
     private StateOperatorCommand parent;
@@ -38,14 +38,13 @@ public void run() {
             throw new RuntimeException(e);
         }
 
-        if(keyInfo == null) {
+        if (keyInfo == null) {
             // we assume it's a singleton
             final SingletonIntrospector introspector = new SingletonIntrospector(state, serviceName, stateName);
             introspector.introspect();
         } else {
             final KvIntrospector introspector = new KvIntrospector(state, serviceName, stateName, keyInfo);
             introspector.introspect();
         }
-
     }
 }

hedera-state-validator/src/main/java/com/hedera/statevalidation/StateOperatorCommand.java

@@ -1,20 +1,17 @@
+// SPDX-License-Identifier: Apache-2.0
 package com.hedera.statevalidation;
 
-
+import java.io.File;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import picocli.CommandLine;
 import picocli.CommandLine.Parameters;
 
-import java.io.File;
-import java.util.concurrent.Callable;
-
 @CommandLine.Command(
         name = "operator",
         mixinStandardHelpOptions = true,
-        subcommands = { ValidateCommand.class, IntrospectCommand.class },
-        description = "CLI tool with validation and introspection modes"
-)
+        subcommands = {ValidateCommand.class, IntrospectCommand.class},
+        description = "CLI tool with validation and introspection modes")
 public class StateOperatorCommand implements Runnable {
 
     private static final Logger log = LogManager.getLogger(StateOperatorCommand.class);
@@ -26,7 +23,6 @@ File getStateDir() {
         return stateDir;
     }
 
-
     @Override
     public void run() {
         // This runs if no subcommand is provided
@@ -44,5 +40,4 @@ public static void main(String[] args) {
             throw new RuntimeException(e);
         }
     }
-
 }

hedera-state-validator/src/main/java/com/hedera/statevalidation/ValidateCommand.java

@@ -1,26 +1,12 @@
-/*
- * Copyright (C) 2022-2023 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.
- */
-
+// SPDX-License-Identifier: Apache-2.0
 package com.hedera.statevalidation;
 
+import static org.junit.platform.engine.discovery.DiscoverySelectors.selectPackage;
+
 import com.hedera.statevalidation.listener.LoggingTestExecutionListener;
 import com.hedera.statevalidation.listener.ReportingListener;
 import com.hedera.statevalidation.listener.SummaryGeneratingListener;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import java.util.concurrent.Callable;
 import org.junit.platform.launcher.Launcher;
 import org.junit.platform.launcher.LauncherDiscoveryRequest;
 import org.junit.platform.launcher.LauncherSession;
@@ -32,27 +18,29 @@
 import picocli.CommandLine.Command;
 import picocli.CommandLine.ParentCommand;
 
-import java.io.File;
-import java.util.concurrent.Callable;
-
-import static org.junit.platform.engine.discovery.DiscoverySelectors.selectPackage;
-
 /**
  * This class is an entry point for the validators.
  * It is responsible for discovering all tests in the package and running them. Uses provided tags to filter tests.<br>
  * All validators are expecting 2 parameters:<br>
  * 1. State directory - the directory where the state is stored<br>
  * 2. Tag to run - the tag of the test to run (optional) If no tags are provided, all tests are run.<br>
  */
-@Command(name = "validate", mixinStandardHelpOptions = true,
+@Command(
+        name = "validate",
+        mixinStandardHelpOptions = true,
         description = "Validates the state of a Mainnet Hedera node")
 public class ValidateCommand implements Callable<Integer> {
 
     @ParentCommand
     private StateOperatorCommand parent;
 
-    @CommandLine.Parameters(arity = "1..*", description = "Tag to run: [stateAnalyzer, internal, leaf, hdhm, account, tokenRelations, rehash, files, compaction]")
-    private String[] tags = {"stateAnalyzer", "internal", "leaf", "hdhm", "account", "tokenRelations", "rehash", "files", "compaction"};
+    @CommandLine.Parameters(
+            arity = "1..*",
+            description =
+                    "Tag to run: [stateAnalyzer, internal, leaf, hdhm, account, tokenRelations, rehash, files, compaction]")
+    private String[] tags = {
+        "stateAnalyzer", "internal", "leaf", "hdhm", "account", "tokenRelations", "rehash", "files", "compaction"
+    };
 
     @Override
     public Integer call() {
@@ -67,12 +55,12 @@ public Integer call() {
         SummaryGeneratingListener summaryGeneratingListener = new SummaryGeneratingListener();
         try (LauncherSession session = LauncherFactory.openSession()) {
             Launcher launcher = session.getLauncher();
-            launcher.registerTestExecutionListeners(new ReportingListener(), summaryGeneratingListener, new LoggingTestExecutionListener());
+            launcher.registerTestExecutionListeners(
+                    new ReportingListener(), summaryGeneratingListener, new LoggingTestExecutionListener());
             testPlan = launcher.discover(request);
             launcher.execute(testPlan);
         }
 
         return summaryGeneratingListener.isFailed() ? 1 : 0;
     }
-
-}
+}

hedera-state-validator/src/main/java/com/hedera/statevalidation/introspectors/IntrospectUtils.java

@@ -1,7 +1,7 @@
+// SPDX-License-Identifier: Apache-2.0
 package com.hedera.statevalidation.introspectors;
 
 import com.hedera.pbj.runtime.JsonCodec;
-
 import java.lang.reflect.Field;
 
 public final class IntrospectUtils {

hedera-state-validator/src/main/java/com/hedera/statevalidation/introspectors/KvIntrospector.java

@@ -1,5 +1,8 @@
+// SPDX-License-Identifier: Apache-2.0
 package com.hedera.statevalidation.introspectors;
 
+import static com.hedera.statevalidation.introspectors.IntrospectUtils.getCodecFor;
+
 import com.hedera.hapi.node.base.AccountID;
 import com.hedera.hapi.node.base.ContractID;
 import com.hedera.hapi.node.base.FileID;
@@ -13,7 +16,6 @@
 import com.hedera.hapi.node.state.contract.SlotKey;
 import com.hedera.hapi.node.state.hints.HintsPartyId;
 import com.hedera.hapi.node.state.history.ConstructionNodeId;
-import com.hedera.hapi.node.state.primitives.ProtoLong;
 import com.hedera.hapi.node.state.tss.TssMessageMapKey;
 import com.hedera.hapi.node.state.tss.TssVoteMapKey;
 import com.hedera.hapi.platform.state.NodeId;
@@ -23,8 +25,6 @@
 import com.swirlds.state.State;
 import com.swirlds.state.spi.ReadableKVState;
 
-import static com.hedera.statevalidation.introspectors.IntrospectUtils.getCodecFor;
-
 public class KvIntrospector {
 
     private final State state;
@@ -43,7 +43,8 @@ public KvIntrospector(State state, String serviceName, String stateName, String
     }
 
     public void introspect() {
-        ReadableKVState<Object, Object> kvState = state.getReadableStates(serviceName).get(stateName);
+        ReadableKVState<Object, Object> kvState =
+                state.getReadableStates(serviceName).get(stateName);
         final JsonCodec jsonCodec;
         switch (keyType) {
             case "EntityNumber" -> jsonCodec = EntityNumber.JSON;

hedera-state-validator/src/main/java/com/hedera/statevalidation/introspectors/SingletonIntrospector.java

@@ -1,9 +1,10 @@
+// SPDX-License-Identifier: Apache-2.0
 package com.hedera.statevalidation.introspectors;
 
-import com.swirlds.state.State;
-
 import static com.hedera.statevalidation.introspectors.IntrospectUtils.getCodecFor;
 
+import com.swirlds.state.State;
+
 public class SingletonIntrospector {
 
     private final State state;
@@ -17,7 +18,8 @@ public SingletonIntrospector(State state, String serviceName, String stateName)
     }
 
     public void introspect() {
-        Object singleton = state.getReadableStates(serviceName).getSingleton(stateName).get();
+        Object singleton =
+                state.getReadableStates(serviceName).getSingleton(stateName).get();
         System.out.println(getCodecFor(singleton).toJSON(singleton));
     }
 }

hedera-state-validator/src/main/java/com/hedera/statevalidation/listener/ListenerUtils.java

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 package com.hedera.statevalidation.listener;
 
 import org.junit.platform.engine.support.descriptor.MethodSource;
@@ -6,7 +7,8 @@
 public class ListenerUtils {
 
     public static String extractTestFullName(TestIdentifier testIdentifier) {
-        final MethodSource methodSource = (MethodSource) testIdentifier.getSource().orElseThrow();
+        final MethodSource methodSource =
+                (MethodSource) testIdentifier.getSource().orElseThrow();
         final String methodName = methodSource.getMethodName();
         final String className = methodSource.getJavaClass().getSimpleName();
         final String displayName = testIdentifier.getDisplayName();

hedera-state-validator/src/main/java/com/hedera/statevalidation/listener/LoggingTestExecutionListener.java

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 package com.hedera.statevalidation.listener;
 
 import static com.hedera.statevalidation.listener.ListenerUtils.extractTestFullName;

hedera-state-validator/src/main/java/com/hedera/statevalidation/listener/ReportingListener.java

@@ -1,19 +1,4 @@
-/*
- * Copyright (C) 2023 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.
- */
-
+// SPDX-License-Identifier: Apache-2.0
 package com.hedera.statevalidation.listener;
 
 import com.hedera.statevalidation.Constants;
@@ -32,7 +17,9 @@ public class ReportingListener implements org.junit.platform.launcher.TestExecut
 
     @Override
     public void testPlanExecutionFinished(TestPlan testPlan) {
-        log.info("Writing JSON report to [{}]", Constants.REPORT_FILE.toAbsolutePath().toString());
+        log.info(
+                "Writing JSON report to [{}]",
+                Constants.REPORT_FILE.toAbsolutePath().toString());
 
         JsonHelper.writeReport(ReportingFactory.getInstance().report(), Constants.REPORT_FILE);
     }

hedera-state-validator/src/main/java/com/hedera/statevalidation/listener/SummaryGeneratingListener.java

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 package com.hedera.statevalidation.listener;
 
 import static com.hedera.statevalidation.listener.ListenerUtils.extractTestFullName;
@@ -60,8 +61,7 @@ public void executionFinished(TestIdentifier testIdentifier, TestExecutionResult
     private static void printMessage(TestIdentifier testIdentifier, String message, String color, long timeTaken) {
         log.info(String.format(
                 "%s - %s%s%s, time taken - %s sec",
-                extractTestFullName(testIdentifier), color, message, ANSI_RESET, timeTaken
-        ));
+                extractTestFullName(testIdentifier), color, message, ANSI_RESET, timeTaken));
     }
 
     public boolean isFailed() {