This is an automated email from the ASF dual-hosted git repository.
jbonofre pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/felix-dev.git
The following commit(s) were added to refs/heads/master by this push:
new b988ddc FELIX-6325 - OSGi log package is mandatory but imported as
optional
new 946535c Merge pull request #46 from tjwatson/FELIX-6325
b988ddc is described below
commit b988ddc926cfb9e416f07c23e2d2d576b9f0e0dc
Author: Thomas Watson <[email protected]>
AuthorDate: Fri Sep 4 10:49:50 2020 -0500
FELIX-6325 - OSGi log package is mandatory but imported as optional
Make the log package optional again.
The implementation still will only use
an OSGi R7 log service implementation
if one is available.
---
.../apache/felix/scr/impl/logger/LogManager.java | 28 ++--
.../felix/scr/impl/logger/ScrLogManager.java | 10 +-
.../apache/felix/scr/impl/logger/LoggerTest.java | 10 +-
.../felix/scr/integration/ComponentTestBase.java | 4 +
.../scr/integration/Felix6325OptionalLogTest.java | 177 +++++++++++++++++++++
5 files changed, 207 insertions(+), 22 deletions(-)
diff --git a/scr/src/main/java/org/apache/felix/scr/impl/logger/LogManager.java
b/scr/src/main/java/org/apache/felix/scr/impl/logger/LogManager.java
index 47c8d03..d5cd008 100644
--- a/scr/src/main/java/org/apache/felix/scr/impl/logger/LogManager.java
+++ b/scr/src/main/java/org/apache/felix/scr/impl/logger/LogManager.java
@@ -45,7 +45,9 @@ import org.osgi.util.tracker.ServiceTracker;
* The LogDomain represents every bundle. Per LogDomain, we keep the facades.
If the factory goes,
* we reset the facades.
*/
-class LogManager extends ServiceTracker<LoggerFactory, LoggerFactory>
implements BundleListener {
+class LogManager extends ServiceTracker<Object, Object> implements
BundleListener {
+
+ private static final String LOGGER_FACTORY_CLASS_NAME =
"org.osgi.service.log.LoggerFactory";
final BundleContext scrContext;
final AtomicBoolean closed = new AtomicBoolean(false);
@@ -56,7 +58,7 @@ class LogManager extends ServiceTracker<LoggerFactory,
LoggerFactory> implements
class Lock {
final Map<Bundle, LogDomain> domains = new HashMap<>();
int
trackingCount;
- LoggerFactory factory;
+ Object factory;
int
ranking=0;
synchronized LogDomain getLogDomain(Bundle bundle) {
@@ -68,14 +70,14 @@ class LogManager extends ServiceTracker<LoggerFactory,
LoggerFactory> implements
return domain;
}
- synchronized void removedFactory(LoggerFactory service) {
+ synchronized void removedFactory(Object service) {
if (this.factory == service) {
this.factory = null;
reset();
}
}
- synchronized void setFactory(int ranking, LoggerFactory
service) {
+ synchronized void setFactory(int ranking, Object service) {
if (this.factory == null) {
this.factory = service;
this.ranking = ranking;
@@ -92,11 +94,11 @@ class LogManager extends ServiceTracker<LoggerFactory,
LoggerFactory> implements
}
}
- synchronized Logger getLogger(LoggerFacade facade, Bundle
bundle, String name) {
+ synchronized Object getLogger(LoggerFacade facade, Bundle
bundle, String name) {
if (factory == null)
return facade.logger = null;
else
- return facade.logger =
factory.getLogger(bundle, name, Logger.class);
+ return facade.logger = ((LoggerFactory)
factory).getLogger(bundle, name, Logger.class);
}
synchronized LogDomain remove(Bundle bundle) {
@@ -113,14 +115,14 @@ class LogManager extends ServiceTracker<LoggerFactory,
LoggerFactory> implements
final Lock lock = new Lock();
LogManager(BundleContext context) {
- super(context, LoggerFactory.class, null);
+ super(context, LOGGER_FACTORY_CLASS_NAME, null);
this.scrContext = context;
scrContext.addBundleListener(this);
}
@Override
- public LoggerFactory addingService(ServiceReference<LoggerFactory>
reference) {
- LoggerFactory service = super.addingService(reference);
+ public Object addingService(ServiceReference<Object> reference) {
+ Object service = super.addingService(reference);
Integer ranking = (Integer)
reference.getProperty(Constants.SERVICE_RANKING);
if (ranking == null)
ranking = 0;
@@ -129,7 +131,7 @@ class LogManager extends ServiceTracker<LoggerFactory,
LoggerFactory> implements
}
@Override
- public void removedService(ServiceReference<LoggerFactory> reference,
LoggerFactory service) {
+ public void removedService(ServiceReference<Object> reference, Object
service) {
super.removedService(reference, service);
lock.removedFactory(service);
}
@@ -188,7 +190,7 @@ class LogManager extends ServiceTracker<LoggerFactory,
LoggerFactory> implements
class LoggerFacade {
private final String name;
private final LogDomain domain;
- volatile Logger logger;
+ volatile Object logger;
volatile String prefix;
LoggerFacade(LogDomain logDomain, String name) {
@@ -200,8 +202,8 @@ class LogManager extends ServiceTracker<LoggerFactory,
LoggerFactory> implements
logger = null;
}
- Logger getLogger() {
- Logger l = this.logger;
+ Object getLogger() {
+ Object l = this.logger;
if (l == null) {
l = lock.getLogger(this, domain.bundle, name);
}
diff --git
a/scr/src/main/java/org/apache/felix/scr/impl/logger/ScrLogManager.java
b/scr/src/main/java/org/apache/felix/scr/impl/logger/ScrLogManager.java
index d25dd92..1aa1f70 100644
--- a/scr/src/main/java/org/apache/felix/scr/impl/logger/ScrLogManager.java
+++ b/scr/src/main/java/org/apache/felix/scr/impl/logger/ScrLogManager.java
@@ -128,8 +128,9 @@ public class ScrLogManager extends LogManager {
// assert !closed.get();
- Logger logger = getLogger();
- if (logger != null) {
+ Object checkLogger = getLogger();
+ if (checkLogger != null) {
+ Logger logger = (Logger) checkLogger;
switch (level) {
case AUDIT:
return true;
@@ -166,8 +167,9 @@ public class ScrLogManager extends LogManager {
if (prefix != null && prefix.length() > 0) {
message = prefix.concat(" ").concat(message);
}
- Logger logger = getLogger();
- if (logger != null) {
+ Object checkLogger = getLogger();
+ if (checkLogger != null) {
+ Logger logger = (Logger) checkLogger;
if (ex == null) {
switch (level) {
case AUDIT:
diff --git a/scr/src/test/java/org/apache/felix/scr/impl/logger/LoggerTest.java
b/scr/src/test/java/org/apache/felix/scr/impl/logger/LoggerTest.java
index cfafd1b..e0714da 100644
--- a/scr/src/test/java/org/apache/felix/scr/impl/logger/LoggerTest.java
+++ b/scr/src/test/java/org/apache/felix/scr/impl/logger/LoggerTest.java
@@ -375,7 +375,7 @@ public class LoggerTest {
l.register();
assertThat(l.loggers.get(scr)).isNull();
- Logger logger = facade.getLogger();
+ Logger logger = (Logger) facade.getLogger();
assertThat(logger).isNotNull();
assertThat(facade.logger).isEqualTo(logger);
@@ -383,7 +383,7 @@ public class LoggerTest {
assertThat(logger.getName()).isEqualTo("lifecycle");
- Logger logger2 = facade.getLogger();
+ Logger logger2 = (Logger) facade.getLogger();
assertThat(logger2).isEqualTo(logger);
assertThat(l.loggers.get(scr)).hasSize(1);
@@ -391,7 +391,7 @@ public class LoggerTest {
l.register();
assertThat(facade.logger).isNull();
- logger = facade.getLogger();
+ logger = (Logger) facade.getLogger();
assertThat(l.loggers.get(scr)).hasSize(2);
assertThat(facade.logger).isNotNull();
@@ -409,7 +409,7 @@ public class LoggerTest {
LogService la = new LogService(log.getBundleContext());
la.register();
- Logger loggera = facade.getLogger();
+ Logger loggera = (Logger) facade.getLogger();
assertThat(loggera).isNotNull();
assertThat(facade.logger).isEqualTo(loggera);
assertThat(la.loggers.get(scr)).hasSize(1);
@@ -418,7 +418,7 @@ public class LoggerTest {
assertThat(facade.logger).isNull();
- Logger loggerb = facade.getLogger();
+ Logger loggerb = (Logger) facade.getLogger();
assertThat(loggerb).isNotNull();
assertThat(higherRanking.loggers.get(scr)).hasSize(1);
diff --git
a/scr/src/test/java/org/apache/felix/scr/integration/ComponentTestBase.java
b/scr/src/test/java/org/apache/felix/scr/integration/ComponentTestBase.java
index ce27281..0966c5b 100644
--- a/scr/src/test/java/org/apache/felix/scr/integration/ComponentTestBase.java
+++ b/scr/src/test/java/org/apache/felix/scr/integration/ComponentTestBase.java
@@ -242,6 +242,10 @@ public abstract class ComponentTestBase
scrTracker.close();
scrTracker = null;
}
+ catch (IllegalStateException e)
+ {
+ // not sure why this is thrown
+ }
finally
{
log.stop();
diff --git
a/scr/src/test/java/org/apache/felix/scr/integration/Felix6325OptionalLogTest.java
b/scr/src/test/java/org/apache/felix/scr/integration/Felix6325OptionalLogTest.java
new file mode 100644
index 0000000..b4d0137
--- /dev/null
+++
b/scr/src/test/java/org/apache/felix/scr/integration/Felix6325OptionalLogTest.java
@@ -0,0 +1,177 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+package org.apache.felix.scr.integration;
+
+import static org.junit.Assert.assertNotNull;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.ops4j.pax.exam.junit.PaxExam;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.BundleException;
+import org.osgi.framework.Constants;
+import org.osgi.framework.FrameworkEvent;
+import org.osgi.framework.FrameworkListener;
+import org.osgi.framework.ServiceRegistration;
+import org.osgi.framework.hooks.resolver.ResolverHook;
+import org.osgi.framework.hooks.resolver.ResolverHookFactory;
+import org.osgi.framework.namespace.PackageNamespace;
+import org.osgi.framework.wiring.BundleCapability;
+import org.osgi.framework.wiring.BundleRequirement;
+import org.osgi.framework.wiring.BundleRevision;
+import org.osgi.framework.wiring.FrameworkWiring;
+
+@RunWith(PaxExam.class)
+public class Felix6325OptionalLogTest extends ComponentTestBase
+{
+ static
+ {
+ // This test creates its own component bundles
+ descriptorFile = null;
+ DS_LOGLEVEL = "debug";
+ //paxRunnerVmOption = DEBUG_VM_OPTION;
+ }
+
+ final ResolverHookFactory resolverHookFactory = new
ResolverHookFactoryImpl();
+
+ class ResolverHookFactoryImpl implements ResolverHookFactory
+ {
+ final ResolverHook resolverHook = new ResolverHookImpl();
+
+ @Override
+ public ResolverHook begin(Collection<BundleRevision> triggers)
+ {
+ return resolverHook;
+ }
+ }
+
+ class ResolverHookImpl implements ResolverHook
+ {
+ @Override
+ public void filterSingletonCollisions(BundleCapability singleton,
+ Collection<BundleCapability> collisionCandidates)
+ {
+ // nothing to do
+ }
+
+ @Override
+ public void filterResolvable(Collection<BundleRevision> candidates)
+ {
+ // nothing to do
+ }
+
+ @Override
+ public void filterMatches(BundleRequirement requirement,
+ Collection<BundleCapability> candidates)
+ {
+ if (!candidates.isEmpty()
+ &&
PackageNamespace.PACKAGE_NAMESPACE.equals(requirement.getNamespace()))
+ {
+ String packageName = (String)
candidates.iterator().next().getAttributes().get(
+ PackageNamespace.PACKAGE_NAMESPACE);
+ if (packageName != null &&
packageName.startsWith("org.osgi.service.log"))
+ {
+ candidates.clear();
+ }
+ }
+ return;
+ }
+
+ @Override
+ public void end()
+ {
+ // nothing to do
+ }
+ }
+
+ private ServiceRegistration<ResolverHookFactory> hookReg;
+ private Bundle scrBundle;
+ private FrameworkWiring fwkWiring;
+
+ @Before
+ public void registerResolverHook() throws BundleException
+ {
+ scrBundle = null;
+ for (Bundle b : bundleContext.getBundles())
+ {
+ if ("org.apache.felix.scr".equals(b.getSymbolicName()))
+ {
+ scrBundle = b;
+ break;
+ }
+ }
+ assertNotNull("No SCR bundle found!", scrBundle);
+
+ Bundle systemBundle =
bundleContext.getBundle(Constants.SYSTEM_BUNDLE_LOCATION);
+ BundleContext systemContext = systemBundle.getBundleContext();
+ fwkWiring = systemContext.getBundle().adapt(FrameworkWiring.class);
+
+ // Use a resolver hook to make sure scr does not import the log
packages
+ hookReg = systemContext.registerService(ResolverHookFactory.class,
+ resolverHookFactory, null);
+ }
+
+ @After
+ public void unregisterResolverHook() throws InterruptedException
+ {
+ if (hookReg != null)
+ {
+ try
+ {
+ hookReg.unregister();
+ }
+ catch (IllegalStateException e)
+ {
+ // ignore
+ }
+ hookReg = null;
+ }
+ refresh(scrBundle);
+ }
+
+ private void refresh(Bundle b) throws InterruptedException
+ {
+ final CountDownLatch refreshWait = new CountDownLatch(1);
+ fwkWiring.refreshBundles(Collections.singleton(b), new
FrameworkListener()
+ {
+ @Override
+ public void frameworkEvent(FrameworkEvent event)
+ {
+ refreshWait.countDown();
+ }
+ });
+ refreshWait.await(10, TimeUnit.SECONDS);
+ }
+
+ @Test
+ public void testNoLogPackage() throws Exception
+ {
+ scrBundle.stop();
+ refresh(scrBundle);
+ scrBundle.start();
+ }
+}
