FAB-4454 Increase junit coverage for Config.java

. Modified fabric/sdk/helper/ConfigTest.java to improve coverage . Added fabric_ca/sdj/helper/ConfigTest.java . Enhanced TestConfigHelper.java to properly clear the current config . Added a new helper method in TestConfigHelper.java for fabric_ca Change-Id: Ia88d6471eb314f04cea2f14e77ea52d974ce6faf Signed-off-by: Chris Murphy <chrism@fast.au.fujitsu.com>
hyperledger · Jun 9, 2017 · 584f456 · 584f456
1 parent 86befc2
commit 584f456
Show file tree

Hide file tree

Showing 3 changed files with 319 additions and 22 deletions.
diff --git a/src/test/java/org/hyperledger/fabric/sdk/TestConfigHelper.java b/src/test/java/org/hyperledger/fabric/sdk/TestConfigHelper.java
@@ -4,7 +4,7 @@
  *  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
+ *    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.
@@ -13,6 +13,8 @@
  */
 package org.hyperledger.fabric.sdk;
 
+import java.util.Properties;
+
 import org.hyperledger.fabric.sdk.helper.Config;
 
 /**
@@ -27,30 +29,72 @@ public class TestConfigHelper {
      * clearConfig "resets" Config so that the Config testcases can run without interference from other test suites.
      * Depending on what order JUnit decides to run the tests, Config could have been instantiated earlier and could
      * contain values that make the tests here fail.
+     *
      * @throws SecurityException
      * @throws NoSuchFieldException
      * @throws IllegalAccessException
      * @throws IllegalArgumentException
      *
      */
-    public void clearConfig() throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException {
+    public void clearConfig()
+            throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException {
+
         Config config = Config.getConfig();
+
+        // Set the private static variable Config.config = null
         java.lang.reflect.Field configInstance = config.getClass().getDeclaredField("config");
         configInstance.setAccessible(true);
         configInstance.set(null, null);
+
+        // Clear the sdkProperties map - Config.sdkProperties.clear()
+        java.lang.reflect.Field sdkPropInstance = config.getClass().getDeclaredField("sdkProperties");
+        sdkPropInstance.setAccessible(true);
+        Properties sdkProperties = (Properties) sdkPropInstance.get(config);
+        sdkProperties.clear();
+
+    }
+
+    /**
+     * clearCaConfig "resets" Config used by fabric_ca so that the Config testcases can run without interference from
+     * other test suites.
+     *
+     * @throws SecurityException
+     * @throws NoSuchFieldException
+     * @throws IllegalAccessException
+     * @throws IllegalArgumentException
+     *
+     * @see #clearConfig()
+     */
+    public void clearCaConfig()
+            throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException {
+
+        org.hyperledger.fabric_ca.sdk.helper.Config config = org.hyperledger.fabric_ca.sdk.helper.Config.getConfig();
+
+        // Set the private static variable Config.config = null
+        java.lang.reflect.Field configInstance = config.getClass().getDeclaredField("config");
+        configInstance.setAccessible(true);
+        configInstance.set(null, null);
+
+        // Clear the sdkProperties map - Config.sdkProperties.clear()
+        java.lang.reflect.Field sdkPropInstance = config.getClass().getDeclaredField("sdkProperties");
+        sdkPropInstance.setAccessible(true);
+        Properties sdkProperties = (Properties) sdkPropInstance.get(config);
+        sdkProperties.clear();
+
     }
 
     /**
-     * customizeConfig() sets up the properties listed by env var CONFIG_OVERRIDES
-     * The value of the env var is <i>property1=value1,property2=value2</i> and so on where each <i>property</i> is a property
-     * from the SDK's config file.
+     * customizeConfig() sets up the properties listed by env var CONFIG_OVERRIDES The value of the env var is
+     * <i>property1=value1,property2=value2</i> and so on where each <i>property</i> is a property from the SDK's config
+     * file.
      *
      * @throws NoSuchFieldException
      * @throws SecurityException
      * @throws IllegalArgumentException
      * @throws IllegalAccessException
      */
-    public void customizeConfig() throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException {
+    public void customizeConfig()
+            throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException {
         String fabricSdkConfig = System.getenv(CONFIG_OVERRIDES);
         if (fabricSdkConfig != null && fabricSdkConfig.length() > 0) {
             String[] configs = fabricSdkConfig.split(",");

diff --git a/src/test/java/org/hyperledger/fabric/sdk/helper/ConfigTest.java b/src/test/java/org/hyperledger/fabric/sdk/helper/ConfigTest.java
@@ -14,44 +14,149 @@
 
 package org.hyperledger.fabric.sdk.helper;
 
+import org.apache.log4j.Level;
+
 import org.hyperledger.fabric.sdk.TestConfigHelper;
 import org.junit.After;
+import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 
-import static org.junit.Assert.assertEquals;
-
 public class ConfigTest {
 
     private TestConfigHelper configHelper = new TestConfigHelper();
-    private String originalValue;
+    // private String originalHashAlgorithm;
 
     @Before
     public void setUp() throws Exception {
-        originalValue = Config.getConfig().getHashAlgorithm();
         // reset Config before each test
         configHelper.clearConfig();
     }
 
     @After
     public void tearDown() throws Exception {
-        // reset Config after each test. We do not want to interfere with the next test or the next test suite
+        // reset Config after each test. We do not want to interfere with the
+        // next test or the next test suite
         configHelper.clearConfig();
     }
 
+    // Tests that Config.getConfig properly loads a value from a system property
+    @Test
+    public void testGetConfigSystemProperty() throws Exception {
+
+        final String propName = Config.HASH_ALGORITHM;
+
+        // Get the original value of the property so that we can restore it later
+        final String originalValue = System.getProperty(propName);
+
+        try {
+
+            // Configure the system property with the value to be tested
+            final String newVal = "XXX";
+            System.setProperty(propName, newVal);
+
+            // getConfig should load the property from System
+            Config config = Config.getConfig();
+            Assert.assertEquals(config.getHashAlgorithm(), newVal);
+        } finally {
+            // Restore the system property
+            setSystemProperty(propName, originalValue);
+        }
+
+    }
+
+    // Note: This unit test is of questionable value
+    // It may be better to actually set the individual values (via a system property)
+    // and make sure they come back again!
+    @Test
+    public void testGetters() {
+        Config config = Config.getConfig();
+
+        // Numeric params
+        Assert.assertTrue(config.getSecurityLevel() > 0);
+        Assert.assertTrue(config.getProposalWaitTime() > 0);
+        Assert.assertTrue(config.getGenesisBlockWaitTime() > 0);
+        Assert.assertTrue(config.getSymmetricKeyByteCount() > 0);
+        Assert.assertTrue(config.getMACKeyByteCount() > 0);
+
+        Assert.assertTrue(config.maxLogStringLength() > 0);
+
+        // Boolean params
+        // Not sure how best to deal with these, as they will always return either true or false
+        // So, for coverage, let's simply call the method to ensure they don't throw exceptions...
+        config.getProposalConsistencyValidation();
+
+        // String params
+        Assert.assertNotNull(config.getHashAlgorithm());
+        Assert.assertNotNull(config.getAsymmetricKeyType());
+        Assert.assertNotNull(config.getSymmetricKeyType());
+        Assert.assertNotNull(config.getKeyAgreementAlgorithm());
+        Assert.assertNotNull(config.getSymmetricAlgorithm());
+        Assert.assertNotNull(config.getSignatureAlgorithm());
+        Assert.assertNotNull(config.getCertificateFormat());
+
+        // Arrays
+        Assert.assertNotNull(config.getPeerCACerts());
+    }
+
     @Test
-    public void testGetConfig() {
-        System.setProperty(Config.HASH_ALGORITHM, "XXX");
+    public void testExtraLogLevel() {
         Config config = Config.getConfig();
-        assertEquals(config.getSecurityLevel(), 256);
-        assertEquals(config.getHashAlgorithm(), "XXX");
-        String[] cacerts = config.getPeerCACerts();
-        assertEquals(cacerts[0], "/genesisblock/peercacert.pem");
-
-        // Clean up so that other tests can get valid values from the Config singleton.
-        // configHelper.clearConfig() is not enough. System.clearProperty() is not enough.
-        // Have to set the system property back to the original value as well.
-        System.setProperty(Config.HASH_ALGORITHM, originalValue);
+        Assert.assertTrue(config.extraLogLevel(-99));
+        Assert.assertFalse(config.extraLogLevel(99));
+    }
+
+    @Test
+    public void testLogLevelTrace() {
+        testLogLevelAny("TRACE", org.apache.log4j.Level.TRACE);
+    }
+
+    @Test
+    public void testLogLevelDebug() {
+        testLogLevelAny("DEBUG", org.apache.log4j.Level.DEBUG);
+    }
+
+    @Test
+    public void testLogLevelInfo() {
+        testLogLevelAny("INFO", org.apache.log4j.Level.INFO);
+    }
+
+    @Test
+    public void testLogLevelWarn() {
+        testLogLevelAny("WARN", org.apache.log4j.Level.WARN);
+    }
+
+    @Test
+    public void testLogLevelError() {
+        testLogLevelAny("ERROR", org.apache.log4j.Level.ERROR);
+    }
+
+    // ==========================================================================================
+    // Helper methods
+    // ==========================================================================================
+
+    // Helper method to set the value of a system property
+    private Object setSystemProperty(String propName, String propValue) {
+        if (propValue == null) {
+            System.clearProperty(propName);
+        } else {
+            System.setProperty(propName, propValue);
+        }
+        return propValue;
+    }
+
+    // Helper function to test one of the possible log levels
+    private void testLogLevelAny(String levelString, Level level) {
+        String originalValue = System.setProperty(Config.LOGGERLEVEL, levelString);
+        try {
+            // Dummy call to ensure that a config instance is created and the
+            // underlying logging level is set...
+            Config.getConfig();
+            Assert.assertEquals(level, org.apache.log4j.Logger.getLogger("org.hyperledger.fabric").getLevel());
+        } finally {
+            // Restore the original value so that other tests run consistently
+            setSystemProperty(Config.LOGGERLEVEL, originalValue);
+        }
     }
 
 }