From 6e190c19072a82d609c27e187e2aba16fc1ee939 Mon Sep 17 00:00:00 2001
From: neil_a_wilson <neil_a_wilson@localhost>
Date: Mon, 25 Sep 2006 20:21:40 +0000
Subject: [PATCH] Add some very simple tests that can be used to get coverage for objects that implement the ConfigurableComponent and ConfigChangeListener interfaces.

---
 opends/tests/unit-tests-testng/src/server/org/opends/server/api/ConfigurableComponentTestCase.java |  144 ++++++++++++++++++++++++
 opends/tests/unit-tests-testng/src/server/org/opends/server/api/APITestCase.java                   |   46 +++++++
 opends/ext/testng/testng.xml                                                                       |    1 
 opends/tests/unit-tests-testng/src/server/org/opends/server/api/ConfigChangeListenerTestCase.java  |  150 +++++++++++++++++++++++++
 4 files changed, 341 insertions(+), 0 deletions(-)

diff --git a/opends/ext/testng/testng.xml b/opends/ext/testng/testng.xml
index 94f8ac4..75d5c91 100644
--- a/opends/ext/testng/testng.xml
+++ b/opends/ext/testng/testng.xml
@@ -18,6 +18,7 @@
             <package name="org.opends.server.plugins"/>
             <package name="org.opends.server.types"/>
             <package name="org.opends.server.changelog"/>
+            <package name="org.opends.server.api"/>
         </packages>
     </test>
 
diff --git a/opends/tests/unit-tests-testng/src/server/org/opends/server/api/APITestCase.java b/opends/tests/unit-tests-testng/src/server/org/opends/server/api/APITestCase.java
new file mode 100644
index 0000000..33ed8da
--- /dev/null
+++ b/opends/tests/unit-tests-testng/src/server/org/opends/server/api/APITestCase.java
@@ -0,0 +1,46 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License, Version 1.0 only
+ * (the "License").  You may not use this file except in compliance
+ * with the License.
+ *
+ * You can obtain a copy of the license at
+ * trunk/opends/resource/legal-notices/OpenDS.LICENSE
+ * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
+ * See the License for the specific language governing permissions
+ * and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at
+ * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
+ * add the following below this CDDL HEADER, with the fields enclosed
+ * by brackets "[]" replaced with your own identifying * information:
+ *      Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ *
+ *
+ *      Portions Copyright 2006 Sun Microsystems, Inc.
+ */
+package org.opends.server.api;
+
+
+
+import org.testng.annotations.Test;
+
+import org.opends.server.DirectoryServerTestCase;
+
+
+
+/**
+ * An abstract base class for all extensions test cases.
+ */
+@Test(groups = { "precommit", "api" })
+public abstract class APITestCase
+       extends DirectoryServerTestCase
+{
+  // No implementation required.
+}
+
diff --git a/opends/tests/unit-tests-testng/src/server/org/opends/server/api/ConfigChangeListenerTestCase.java b/opends/tests/unit-tests-testng/src/server/org/opends/server/api/ConfigChangeListenerTestCase.java
new file mode 100644
index 0000000..5dd0289
--- /dev/null
+++ b/opends/tests/unit-tests-testng/src/server/org/opends/server/api/ConfigChangeListenerTestCase.java
@@ -0,0 +1,150 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License, Version 1.0 only
+ * (the "License").  You may not use this file except in compliance
+ * with the License.
+ *
+ * You can obtain a copy of the license at
+ * trunk/opends/resource/legal-notices/OpenDS.LICENSE
+ * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
+ * See the License for the specific language governing permissions
+ * and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at
+ * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
+ * add the following below this CDDL HEADER, with the fields enclosed
+ * by brackets "[]" replaced with your own identifying * information:
+ *      Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ *
+ *
+ *      Portions Copyright 2006 Sun Microsystems, Inc.
+ */
+package org.opends.server.api;
+
+
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+import org.opends.server.TestCaseUtils;
+import org.opends.server.config.ConfigAttribute;
+import org.opends.server.config.ConfigEntry;
+import org.opends.server.config.JMXMBean;
+import org.opends.server.core.DirectoryServer;
+import org.opends.server.types.DN;
+import org.opends.server.types.Entry;
+
+import static org.testng.Assert.*;
+
+
+
+/**
+ * A set of generic test cases for config change listeners.
+ */
+public class ConfigChangeListenerTestCase
+       extends APITestCase
+{
+  /**
+   * Ensures that the Directory Server is running.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @BeforeClass()
+  public void startServer()
+         throws Exception
+  {
+    TestCaseUtils.startServer();
+  }
+
+
+
+  /**
+   * Retrieves the set of config change listeners registered with the server.
+   *
+   * @return  The set of config change listeners registered with the server.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @DataProvider(name = "configChangeListeners")
+  public Object[][] getConfigChangeListeners()
+         throws Exception
+  {
+    ArrayList<DN> dns = new ArrayList<DN>();
+    ArrayList<ConfigChangeListener> listeners =
+         new ArrayList<ConfigChangeListener>();
+    getChangeListeners(DirectoryServer.getConfigHandler().getConfigRootEntry(),
+                       dns, listeners);
+
+
+    Object[][] componentArray = new Object[listeners.size()][1];
+    for (int i=0; i < componentArray.length; i++)
+    {
+      componentArray[i] = new Object[] { dns.get(i), listeners.get(i) };
+    }
+
+    return componentArray;
+  }
+
+
+
+  /**
+   * Retrieves the config change listeners from the provided configuration
+   * entry, as well as recursively from all of the its subordinate entries.
+   *
+   * @param  configEntry  The configuration entry from which to retrieve the
+   *                      change listeners.
+   * @param  dns          The list into which to add the DNs of the
+   *                      configuration entries with the change listeners.
+   * @param  listeners    The list into which to add all identified change
+   *                      listeners.
+   */
+  private void getChangeListeners(ConfigEntry configEntry,
+                                  ArrayList<DN> dns,
+                                  ArrayList<ConfigChangeListener> listeners)
+  {
+    for (ConfigChangeListener l : configEntry.getChangeListeners())
+    {
+      dns.add(configEntry.getDN());
+      listeners.add(l);
+    }
+
+    if (configEntry.hasChildren())
+    {
+      for (ConfigEntry e : configEntry.getChildren().values())
+      {
+        getChangeListeners(e, dns, listeners);
+      }
+    }
+  }
+
+
+
+  /**
+   * Tests the <CODE>configChangeIsAccpetable</CODE> method with the current
+   * configuration.
+   *
+   * @param  dn  The DN of the configuration entry for the provided listener.
+   * @param  l   The listener to be tested.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test(dataProvider = "configChangeListeners")
+  public void testConfigChangeIsAcceptable(DN dn, ConfigChangeListener l)
+         throws Exception
+  {
+    ConfigEntry e = DirectoryServer.getConfigEntry(dn);
+    assertNotNull(e);
+
+    assertTrue(l.configChangeIsAcceptable(e, new StringBuilder()));
+  }
+}
+
diff --git a/opends/tests/unit-tests-testng/src/server/org/opends/server/api/ConfigurableComponentTestCase.java b/opends/tests/unit-tests-testng/src/server/org/opends/server/api/ConfigurableComponentTestCase.java
new file mode 100644
index 0000000..efbbead
--- /dev/null
+++ b/opends/tests/unit-tests-testng/src/server/org/opends/server/api/ConfigurableComponentTestCase.java
@@ -0,0 +1,144 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License, Version 1.0 only
+ * (the "License").  You may not use this file except in compliance
+ * with the License.
+ *
+ * You can obtain a copy of the license at
+ * trunk/opends/resource/legal-notices/OpenDS.LICENSE
+ * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
+ * See the License for the specific language governing permissions
+ * and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at
+ * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
+ * add the following below this CDDL HEADER, with the fields enclosed
+ * by brackets "[]" replaced with your own identifying * information:
+ *      Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ *
+ *
+ *      Portions Copyright 2006 Sun Microsystems, Inc.
+ */
+package org.opends.server.api;
+
+
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+import org.opends.server.TestCaseUtils;
+import org.opends.server.config.ConfigAttribute;
+import org.opends.server.config.ConfigEntry;
+import org.opends.server.config.JMXMBean;
+import org.opends.server.core.DirectoryServer;
+import org.opends.server.types.DN;
+
+import static org.testng.Assert.*;
+
+
+
+/**
+ * A set of generic test cases for configurable components.
+ */
+public class ConfigurableComponentTestCase
+       extends APITestCase
+{
+  /**
+   * Ensures that the Directory Server is running.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @BeforeClass()
+  public void startServer()
+         throws Exception
+  {
+    TestCaseUtils.startServer();
+  }
+
+
+
+  /**
+   * Retrieves the set of configurable components registered with the server.
+   *
+   * @return  The set of configurable components registered with the server.
+   */
+  @DataProvider(name = "configurableComponents")
+  public Object[][] getConfigurableComponents()
+  {
+    ArrayList<ConfigurableComponent> components =
+         new ArrayList<ConfigurableComponent>();
+    for (JMXMBean b : DirectoryServer.getJMXMBeans().values())
+    {
+      for (ConfigurableComponent c : b.getConfigurableComponents())
+      {
+        components.add(c);
+      }
+    }
+
+    Object[][] componentArray = new Object[components.size()][1];
+    for (int i=0; i < componentArray.length; i++)
+    {
+      componentArray[i] = new Object[] { components.get(i) };
+    }
+
+    return componentArray;
+  }
+
+
+
+  /**
+   * Tests the <CODE>getConfigurableComponentEntryDN</CODE> method.
+   *
+   * @param  c  The configurable component to use in the test.
+   */
+  @Test(dataProvider = "configurableComponents")
+  public void testGetConfigurableComponentEntryDN(ConfigurableComponent c)
+  {
+    assertNotNull(c.getConfigurableComponentEntryDN());
+  }
+
+
+
+  /**
+   * Tests the <CODE>getConfigurationAttributes</CODE> method.
+   *
+   * @param  c  The configurable component to use in the test.
+   */
+  @Test(dataProvider = "configurableComponents")
+  public void testGetConfigurationAttributes(ConfigurableComponent c)
+  {
+    List<ConfigAttribute> attrs = c.getConfigurationAttributes();
+    assertNotNull(attrs);
+  }
+
+
+
+  /**
+   * Tests the <CODE>hasAcceptableConfiguration</CODE> method with the
+   * associated configuration entry.
+   *
+   * @param  c  The configurable component to use in the test.
+   *
+   * @throws  Exception  If an unexpected problem occurs.
+   */
+  @Test(dataProvider = "configurableComponents")
+  public void testHasAcceptableConfiguration(ConfigurableComponent c)
+         throws Exception
+  {
+    DN          configEntryDN = c.getConfigurableComponentEntryDN();
+    ConfigEntry configEntry   = DirectoryServer.getConfigEntry(configEntryDN);
+
+    ArrayList<String> unacceptableReasons = new ArrayList<String>();
+    assertTrue(c.hasAcceptableConfiguration(configEntry, unacceptableReasons));
+  }
+}
+

--
Gitblit v1.10.0