You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by js...@apache.org on 2017/03/02 16:44:18 UTC

svn commit: r1785161 - in /jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi: AbstractRepositoryFactoryTest.groovy DocumentNodeStoreConfigTest.groovy SecurityProviderRegistrationTest.groovy

Author: jsedding
Date: Thu Mar  2 16:44:18 2017
New Revision: 1785161

URL: http://svn.apache.org/viewvc?rev=1785161&view=rev
Log:
OAK-5750 - Test failure: PojoSR run.osgi.SecurityProviderRegistrationTest

- introduce awaitServiceEvent utility method and replace sleeps in SecurityProviderRegistrationTest

Modified:
    jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/AbstractRepositoryFactoryTest.groovy
    jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/DocumentNodeStoreConfigTest.groovy
    jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/SecurityProviderRegistrationTest.groovy

Modified: jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/AbstractRepositoryFactoryTest.groovy
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/AbstractRepositoryFactoryTest.groovy?rev=1785161&r1=1785160&r2=1785161&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/AbstractRepositoryFactoryTest.groovy (original)
+++ jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/AbstractRepositoryFactoryTest.groovy Thu Mar  2 16:44:18 2017
@@ -27,11 +27,14 @@ import org.junit.Before
 import org.junit.Rule
 import org.junit.rules.TemporaryFolder
 import org.osgi.framework.BundleContext
+import org.osgi.framework.ServiceEvent
+import org.osgi.framework.ServiceListener
 import org.osgi.framework.ServiceReference
 import org.osgi.service.cm.ConfigurationAdmin
 import org.osgi.util.tracker.ServiceTracker
 
 import javax.jcr.*
+import java.util.concurrent.CountDownLatch
 import java.util.concurrent.TimeUnit
 
 import static org.apache.jackrabbit.oak.run.osgi.OakOSGiRepositoryFactory.REPOSITORY_HOME
@@ -154,4 +157,70 @@ abstract class AbstractRepositoryFactory
 
         fail("RetryLoop failed, condition is false after " + timeoutSeconds + " seconds" + (message ?: (":" + message)));
     }
+
+    /**
+     * Convenience method to be used in conjunction with {@link #awaitServiceEvent}. It creates a filter that matches
+     * the given {@code className} to one of the following properties: {@code objectClass}, {@code service.pid} or
+     * {@code service.factoryPid}.
+     *
+     * @param className The class name to match.
+     * @return The filter expression.
+     */
+    protected static String classNameFilter(String className) {
+        return "(|(objectClass=${className})(service.pid=${className})(service.factoryPid=${className}))"
+    }
+
+    /**
+     * Execute a change in a closure and wait for a ServiceEvent to happen. The method only returns once
+     * an appropriate event is matched. If no event matches within the specified timeout, an AssertionError
+     * is thrown. The error message describes any non-matching events that may have happened for debugging
+     * purposes.
+     *
+     * @param closure The closure that effects a change that should cause the expected ServiceEvent.
+     * @param serviceFilter A filter expression following the syntax of {@link org.osgi.framework.Filter} (default: (objectClass=*))
+     * @param eventTypes An integer bitmap of accepted ServiceEvent types (default: any).
+     * @param timeout A timeout value; the maximum time to wait for the service event. The unit depends on the {@code timeUnit} argument.
+     * @param timeUnit The unit for the timeout value.
+     */
+    protected void awaitServiceEvent(
+            Closure closure,
+            String serviceFilter = "(objectClass=*)",
+            int eventTypes = ServiceEvent.MODIFIED | ServiceEvent.REGISTERED | ServiceEvent.UNREGISTERING | ServiceEvent.MODIFIED_ENDMATCH,
+            long timeout = 1000,
+            TimeUnit timeUnit = TimeUnit.MILLISECONDS) {
+        def filter = registry.bundleContext.createFilter(serviceFilter)
+        def latch = new CountDownLatch(1)
+        def events = []
+        def listener = new ServiceListener() {
+            @Override
+            void serviceChanged(final ServiceEvent event) {
+                events.add([eventType: event.type, serviceProperties: asMap(event.serviceReference)])
+                if ((eventTypes & event.type) > 0 && filter.match(event.serviceReference)) {
+                    latch.countDown()
+                }
+            }
+
+            private static asMap(final ServiceReference<?> serviceReference) {
+                def map = new HashMap<String, Object>()
+                serviceReference.getPropertyKeys().each { key ->
+                    map.put(key, serviceReference.getProperty(key))
+                }
+                return map
+            }
+        }
+
+        try {
+            registry.addServiceListener(listener)
+            closure.run()
+            def start = System.nanoTime()
+            if (!latch.await(timeout, timeUnit)) {
+                throw new AssertionError("Exceeded timeout waiting for service event matching " +
+                        "[eventTypes: ${eventTypes}, filter: ${serviceFilter}], " +
+                        "got ${events.size()} non matching events: [${events}]")
+            }
+            println "awaitServiceEvent completed after ${TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - start)}ms"
+        } finally {
+            registry.removeServiceListener(listener)
+        }
+    }
 }

Modified: jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/DocumentNodeStoreConfigTest.groovy
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/DocumentNodeStoreConfigTest.groovy?rev=1785161&r1=1785160&r2=1785161&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/DocumentNodeStoreConfigTest.groovy (original)
+++ jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/DocumentNodeStoreConfigTest.groovy Thu Mar  2 16:44:18 2017
@@ -40,6 +40,7 @@ import org.h2.jdbcx.JdbcDataSource
 import org.junit.After
 import org.junit.Ignore
 import org.junit.Test
+import org.osgi.framework.ServiceEvent
 import org.osgi.framework.ServiceReference
 import org.osgi.framework.ServiceRegistration
 
@@ -128,16 +129,18 @@ class DocumentNodeStoreConfigTest extend
         DocumentNodeStore ns = getServiceWithWait(NodeStore.class)
 
         //3. Shut down ds
-        srds.unregister();
-
-        // Check for service to be unregistered after at most 5s, retrying every 500ms.
+        // Wait for service to be unregistered after at most 5s.
         // Previously, we waited only 500ms; this was extended due to
         // occasional test failures on Jenkins (see OAK-5612). If 5s
         // are not sufficient, we should investigate some more.
-        retry (5, 500, "NodeStore should be unregistered") {
-            ServiceReference<NodeStore> sr = registry.getServiceReference(NodeStore.class.name)
-            return sr == null
-        }
+        awaitServiceEvent({
+                    srds.unregister();
+                },
+                classNameFilter(NodeStore.class.name),
+                ServiceEvent.UNREGISTERING,
+                5, TimeUnit.SECONDS
+        )
+        assert registry.getServiceReference(NodeStore.class.name) == null
 
         //4. Restart ds, service should still be down
         srds = registry.registerService(DataSource.class.name, ds, ['datasource.name': 'oak'] as Hashtable)

Modified: jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/SecurityProviderRegistrationTest.groovy
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/SecurityProviderRegistrationTest.groovy?rev=1785161&r1=1785160&r2=1785161&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/SecurityProviderRegistrationTest.groovy (original)
+++ jackrabbit/oak/trunk/oak-pojosr/src/test/groovy/org/apache/jackrabbit/oak/run/osgi/SecurityProviderRegistrationTest.groovy Thu Mar  2 16:44:18 2017
@@ -34,9 +34,13 @@ import org.apache.jackrabbit.oak.spi.sec
 import org.apache.jackrabbit.oak.spi.security.user.action.AuthorizableActionProvider
 import org.junit.Before
 import org.junit.Test
+import org.osgi.framework.Filter
+import org.osgi.framework.ServiceEvent
+import org.osgi.framework.ServiceListener
 import org.osgi.framework.ServiceReference
 import org.osgi.service.cm.ConfigurationAdmin
 
+import java.util.concurrent.CountDownLatch
 import java.util.concurrent.TimeUnit
 
 import static org.mockito.Mockito.mock
@@ -147,13 +151,16 @@ class SecurityProviderRegistrationTest e
     public void testMultipleRequiredServices() {
 
         // Set up the SecurityProvider to require 4 services
-
-        setRequiredServicePids(
-                "test.RequiredAuthorizationConfiguration",
-                "test.RequiredPrincipalConfiguration",
-                "test.RequiredTokenConfiguration",
-                "test.RestrictionProvider")
-        TimeUnit.MILLISECONDS.sleep(500)
+        awaitServiceEvent({
+                    setRequiredServicePids(
+                            "test.RequiredAuthorizationConfiguration",
+                            "test.RequiredPrincipalConfiguration",
+                            "test.RequiredTokenConfiguration",
+                            "test.RestrictionProvider")
+                },
+                "(objectClass=org.apache.jackrabbit.oak.spi.security.SecurityProvider)",
+                ServiceEvent.UNREGISTERING
+        )
         assert securityProviderServiceReferences == null
 
         // Start the services and verify that only at the end the
@@ -201,23 +208,34 @@ class SecurityProviderRegistrationTest e
         assert c
 
         // 1. Disable AuthenticationConfiguration such that SecurityProvider is unregistered
-        c[0].disable()
-
-        TimeUnit.SECONDS.sleep(1)
+        awaitServiceEvent({
+                    c[0].disable()
+                },
+                '(objectClass=org.apache.jackrabbit.oak.spi.security.SecurityProvider)',
+                ServiceEvent.UNREGISTERING
+        )
 
         assert securityProviderServiceReferences == null
 
         // 2. Modify the config for AuthorizableActionProvider. It's expected that this config change is picked up
-        setConfiguration([
-                "org.apache.jackrabbit.oak.spi.security.user.action.DefaultAuthorizableActionProvider": [
-                        "groupPrivilegeNames":"jcr:read"
-                ]
-        ])
-
-        TimeUnit.SECONDS.sleep(1)
+        awaitServiceEvent({
+                    setConfiguration([
+                            "org.apache.jackrabbit.oak.spi.security.user.action.DefaultAuthorizableActionProvider": [
+                                    "groupPrivilegeNames":"jcr:read"
+                            ]
+                    ])
+                },
+                classNameFilter('org.apache.jackrabbit.oak.spi.security.user.action.DefaultAuthorizableActionProvider'),
+                ServiceEvent.MODIFIED | ServiceEvent.REGISTERED
+        )
 
         // 3. Enable component again such that SecurityProvider gets reactivated
-        c[0].enable()
+        awaitServiceEvent({
+                    c[0].enable()
+                },
+                '(objectClass=org.apache.jackrabbit.oak.spi.security.SecurityProvider)',
+                ServiceEvent.REGISTERED
+        )
 
         securityProvider = getServiceWithWait(SecurityProvider.class)
         assertAuthorizationConfig(securityProvider)
@@ -237,13 +255,17 @@ class SecurityProviderRegistrationTest e
         UserConfiguration userConfiguration = getServiceWithWait(UserConfiguration.class)
 
         //1. Modify the config for AuthorizableActionProvider. It's expected that this config change is picked up
-        setConfiguration([
-                "org.apache.jackrabbit.oak.spi.security.user.action.DefaultAuthorizableActionProvider": [
-                        "groupPrivilegeNames":"jcr:read"
+        def servicePid = "org.apache.jackrabbit.oak.spi.security.user.action.DefaultAuthorizableActionProvider"
+        awaitServiceEvent({
+            setConfiguration([
+                        (servicePid): [
+                                "groupPrivilegeNames":"jcr:read"
+                        ]
                 ]
-        ])
-
-        TimeUnit.SECONDS.sleep(1)
+            )},
+            "(service.pid=${servicePid})",
+            ServiceEvent.MODIFIED | ServiceEvent.REGISTERED
+        )
 
         securityProvider = getServiceWithWait(SecurityProvider.class)
         assertAuthorizationConfig(securityProvider)
@@ -254,14 +276,22 @@ class SecurityProviderRegistrationTest e
         assert c
 
         // 2. Disable AuthenticationConfiguration such that SecurityProvider is unregistered
-        c[0].disable()
-
-        TimeUnit.SECONDS.sleep(1)
+        awaitServiceEvent({
+                    c[0].disable()
+                },
+                "(objectClass=org.apache.jackrabbit.oak.spi.security.SecurityProvider)",
+                ServiceEvent.UNREGISTERING
+        )
 
         assert securityProviderServiceReferences == null
 
         // 3. Enable component again such that SecurityProvider gets reactivated
-        c[0].enable()
+        awaitServiceEvent({
+                    c[0].enable()
+                },
+                "(objectClass=org.apache.jackrabbit.oak.spi.security.SecurityProvider)",
+                ServiceEvent.REGISTERED
+        )
 
         securityProvider = getServiceWithWait(SecurityProvider.class)
         assertAuthorizationConfig(securityProvider)
@@ -273,8 +303,12 @@ class SecurityProviderRegistrationTest e
         // Adding a new precondition on a missing service PID forces the
         // SecurityProvider to unregister.
 
-        setRequiredServicePids("test.Required" + serviceClass.simpleName)
-        TimeUnit.MILLISECONDS.sleep(500)
+        awaitServiceEvent({
+                    setRequiredServicePids("test.Required" + serviceClass.simpleName)
+                },
+                "(objectClass=org.apache.jackrabbit.oak.spi.security.SecurityProvider)",
+                ServiceEvent.UNREGISTERING
+        )
         assert securityProviderServiceReferences == null
 
         // If a service is registered, and if the PID of the service matches the
@@ -290,9 +324,12 @@ class SecurityProviderRegistrationTest e
         assert securityProviderServiceReferences == null
 
         // Removing the precondition allows the SecurityProvider to register.
-
-        setRequiredServicePids()
-        TimeUnit.MILLISECONDS.sleep(500)
+        awaitServiceEvent({
+                    setRequiredServicePids()
+                },
+                "(objectClass=org.apache.jackrabbit.oak.spi.security.SecurityProvider)",
+                ServiceEvent.REGISTERED
+        )
         assert securityProviderServiceReferences != null
     }