From a156cf3cbad6512510ae9a02a13c0408f901c734 Mon Sep 17 00:00:00 2001 From: Jim Hahn Date: Mon, 5 Aug 2019 15:27:16 -0400 Subject: Fix sonar issues in drools-pdp Address sonar issue, "Move constants to a class or enum", by moving them from interfaces to classes: ActiveStandbyFeatureApi StateManagementFeatureApi PolicyResourceLockFeatureApi PolicySessionFeatureApi DroolsController DroolsControllerFeatureApi PolicyControllerFeatureApi PolicyEngineFeatureApi HealthCheck SystemPersistence EventProtocolCoder PolicyController PolicyEngine TestTransaction MdcTransaction Address sonar issue, "Move constants to a class or enum", by change the interface to a class: DroolsProperties Address sonar issue, "Override the "equals" method in this class", by adding equals & hashCode to: DroolsPdpEntity DroolsPdpImpl Use lombok for a number of getters & setters. Address sonar issue, "Define a constant instead of duplicating this literal" in: DroolsPdpsElectionHandler JpaDroolsPdpsConnector MavenDroolsController GenericEventProtocolCoder GsonProtocolCoderToolset RestManager Address sonar issue, "Remove the parentheses around the parameter" in: MavenDroolsController Address sonar issue, "Replace this lambda with a method reference" in: LifecycleFsm Address sonar issue, "Move this constructor to comply with Java Code Conventions" in: LifecycleStateRunning Address sonar issue, "Replace this 'switch' statement by 'if' statements to increase readability", as specified in: PolicyEngineManager Address sonar issue, "Rename field to prevent any misunderstanding/clash with field" in: MdcTransactionImpl Address sonar issue, "Either log or rethrow this exception", in: RestManager Address sonar issue, "Rename this constant name to" uppercase, by replacing enums with static lists in: RestManager Addressed review comments: Fixed license dates. Renamed getSiteName/setSiteName methods to getSite/setSite in the interface to match the field names in the implementation classes. Renamed *Instance classes to *Constants. Next round of review comments. Change-Id: I1c26af9f194833dd773f2b25dc5f60cde163201c Issue-ID: POLICY-1968 Signed-off-by: Jim Hahn --- .../drools/testtransaction/TestTransaction.java | 7 ---- .../testtransaction/TestTransactionConstants.java | 38 ++++++++++++++++++++++ .../testtransaction/TestTransactionFeature.java | 2 +- .../drools/testtransaction/TtControllerTask.java | 6 ++-- .../TestTransactionAdditionalTest.java | 4 +-- .../testtransaction/TestTransactionTest.java | 35 ++++++++++---------- 6 files changed, 62 insertions(+), 30 deletions(-) create mode 100644 feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransactionConstants.java (limited to 'feature-test-transaction/src') diff --git a/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransaction.java b/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransaction.java index 03a0e4b7..0a4ef931 100644 --- a/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransaction.java +++ b/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransaction.java @@ -25,13 +25,6 @@ import org.onap.policy.drools.system.PolicyController; /** TestTransaction interface. */ public interface TestTransaction { - public static final String TT_FPC = "TT.FPC"; - public static final String TT_COUNTER = "$ttc"; - public static final String TT_UUID = "43868e59-d1f3-43c2-bd6f-86f89a61eea5"; - public static long DEFAULT_TT_TASK_SLEEP = 20000; - - public static final TestTransaction manager = new TtImpl(); - /** * register a controller for monitoring test transactions. * diff --git a/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransactionConstants.java b/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransactionConstants.java new file mode 100644 index 00000000..9b5ad251 --- /dev/null +++ b/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransactionConstants.java @@ -0,0 +1,38 @@ +/*- + * ============LICENSE_START======================================================= + * feature-test-transaction + * ================================================================================ + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.drools.testtransaction; + +import lombok.Getter; + +public class TestTransactionConstants { + + public static final String TT_FPC = "TT.FPC"; + public static final String TT_COUNTER = "$ttc"; + public static final String TT_UUID = "43868e59-d1f3-43c2-bd6f-86f89a61eea5"; + public static final long DEFAULT_TT_TASK_SLEEP = 20000; + + @Getter + private static final TestTransaction manager = new TtImpl(); + + private TestTransactionConstants() { + // do nothing + } +} diff --git a/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransactionFeature.java b/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransactionFeature.java index 3b2c4598..cc8064d4 100644 --- a/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransactionFeature.java +++ b/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TestTransactionFeature.java @@ -83,6 +83,6 @@ public class TestTransactionFeature implements PolicyControllerFeatureApi { * @return the test transaction manager */ protected TestTransaction getTestTransMgr() { - return TestTransaction.manager; + return TestTransactionConstants.getManager(); } } diff --git a/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TtControllerTask.java b/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TtControllerTask.java index cd54eb07..e0296045 100644 --- a/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TtControllerTask.java +++ b/feature-test-transaction/src/main/java/org/onap/policy/drools/testtransaction/TtControllerTask.java @@ -109,7 +109,7 @@ public class TtControllerTask implements Runnable { } if (!getCurrentThread().isInterrupted()) { - doSleep(TestTransaction.DEFAULT_TT_TASK_SLEEP); + doSleep(TestTransactionConstants.DEFAULT_TT_TASK_SLEEP); } } } catch (final InterruptedException e) { @@ -141,7 +141,7 @@ public class TtControllerTask implements Runnable { final List facts = this.controller .getDrools() - .factQuery(session, TestTransaction.TT_FPC, TestTransaction.TT_COUNTER, false); + .factQuery(session, TestTransactionConstants.TT_FPC, TestTransactionConstants.TT_COUNTER, false); if (facts == null || facts.size() != 1) { /* * unexpected something wrong here, can't expect to recover note this exception is @@ -174,7 +174,7 @@ public class TtControllerTask implements Runnable { fpc); } fpcs.put(session, fpc); - drools.getContainer().insert(session, new EventObject(TestTransaction.TT_UUID)); + drools.getContainer().insert(session, new EventObject(TestTransactionConstants.TT_UUID)); } } diff --git a/feature-test-transaction/src/test/java/org/onap/policy/drools/testtransaction/TestTransactionAdditionalTest.java b/feature-test-transaction/src/test/java/org/onap/policy/drools/testtransaction/TestTransactionAdditionalTest.java index 23fdc215..352779df 100644 --- a/feature-test-transaction/src/test/java/org/onap/policy/drools/testtransaction/TestTransactionAdditionalTest.java +++ b/feature-test-transaction/src/test/java/org/onap/policy/drools/testtransaction/TestTransactionAdditionalTest.java @@ -119,7 +119,7 @@ public class TestTransactionAdditionalTest { @Test public void testTestTransactionImpl() { - assertNotNull(TtImpl.manager); + assertNotNull(TestTransactionConstants.getManager()); } @Test @@ -153,7 +153,7 @@ public class TestTransactionAdditionalTest { // unregister again - stop() should not be called again impl.unregister(controller3); verify(task3).stop(); - + // unregister original controller - no stop() should be called again impl.unregister(controller); verify(task, never()).stop(); diff --git a/feature-test-transaction/src/test/java/org/onap/policy/drools/testtransaction/TestTransactionTest.java b/feature-test-transaction/src/test/java/org/onap/policy/drools/testtransaction/TestTransactionTest.java index e0779ba0..e3c2ed91 100644 --- a/feature-test-transaction/src/test/java/org/onap/policy/drools/testtransaction/TestTransactionTest.java +++ b/feature-test-transaction/src/test/java/org/onap/policy/drools/testtransaction/TestTransactionTest.java @@ -33,10 +33,11 @@ import java.util.concurrent.CountDownLatch; import java.util.concurrent.TimeUnit; import org.junit.BeforeClass; import org.junit.Test; -import org.onap.policy.drools.persistence.SystemPersistence; -import org.onap.policy.drools.properties.DroolsProperties; +import org.onap.policy.drools.persistence.SystemPersistenceConstants; +import org.onap.policy.drools.properties.DroolsPropertyConstants; import org.onap.policy.drools.system.PolicyController; -import org.onap.policy.drools.system.PolicyEngine; +import org.onap.policy.drools.system.PolicyControllerConstants; +import org.onap.policy.drools.system.PolicyEngineConstants; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -55,7 +56,7 @@ public class TestTransactionTest { /** * Start up. - * + * * @throws IOException exception */ @BeforeClass @@ -65,20 +66,20 @@ public class TestTransactionTest { cleanUpWorkingDir(); /* ensure presence of config directory */ - SystemPersistence.manager.setConfigurationDir(null); + SystemPersistenceConstants.getManager().setConfigurationDir(null); } @Test public void registerUnregisterTest() throws InterruptedException { final Properties controllerProperties = new Properties(); - controllerProperties.put(DroolsProperties.PROPERTY_CONTROLLER_NAME, TEST_CONTROLLER_NAME); + controllerProperties.put(DroolsPropertyConstants.PROPERTY_CONTROLLER_NAME, TEST_CONTROLLER_NAME); final PolicyController controller = - PolicyEngine.manager.createPolicyController(TEST_CONTROLLER_NAME, controllerProperties); - assertNotNull(PolicyController.factory.get(TEST_CONTROLLER_NAME)); + PolicyEngineConstants.getManager().createPolicyController(TEST_CONTROLLER_NAME, controllerProperties); + assertNotNull(PolicyControllerConstants.getFactory().get(TEST_CONTROLLER_NAME)); logger.info(controller.toString()); - + CountDownLatch latch = new CountDownLatch(1); - + // use our own impl so we can decrement the latch when run() completes TtImpl impl = new TtImpl() { @Override @@ -90,11 +91,11 @@ public class TestTransactionTest { latch.countDown(); } }; - } + } }; impl.register(controller); - assertNotNull(TestTransaction.manager); + assertNotNull(TestTransactionConstants.getManager()); /* * Unregistering the controller should terminate its TestTransaction thread if it hasn't already @@ -108,7 +109,7 @@ public class TestTransactionTest { /** * Returns thread object based on String name. - * @param latch indicates when the thread has finished running + * @param latch indicates when the thread has finished running * @param threadName thread name * @return the thread * @throws InterruptedException exception @@ -129,8 +130,8 @@ public class TestTransactionTest { /** clean up working directory. */ protected static void cleanUpWorkingDir() { final Path testControllerPath = - Paths.get( - SystemPersistence.manager.getConfigurationPath().toString(), TEST_CONTROLLER_FILE); + Paths.get(SystemPersistenceConstants.getManager().getConfigurationPath().toString(), + TEST_CONTROLLER_FILE); try { Files.deleteIfExists(testControllerPath); } catch (final Exception e) { @@ -138,8 +139,8 @@ public class TestTransactionTest { } final Path testControllerBakPath = - Paths.get( - SystemPersistence.manager.getConfigurationPath().toString(), TEST_CONTROLLER_FILE_BAK); + Paths.get(SystemPersistenceConstants.getManager().getConfigurationPath().toString(), + TEST_CONTROLLER_FILE_BAK); try { Files.deleteIfExists(testControllerBakPath); } catch (final Exception e) { -- cgit 1.2.3-korg