You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ss...@apache.org on 2016/11/11 22:07:05 UTC
svn commit: r1769352 - in
/sling/trunk/contrib/extensions/contextaware-config: ./
tooling/bnd-plugin-integration-tests/ tooling/bnd-plugin/
tooling/bnd-plugin/src/main/java/org/apache/sling/caconfig/bndplugin/
tooling/bnd-plugin/src/test/ tooling/bnd-p...
Author: sseifert
Date: Fri Nov 11 22:07:05 2016
New Revision: 1769352
URL: http://svn.apache.org/viewvc?rev=1769352&view=rev
Log:
SLING-6277 CAConfig BND Plugin: Do not generate bundle header when no class names found
use unit test calling BND directly instead of integration test
Added:
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config1.java (with props)
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config2.java (with props)
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/sub1/
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/sub1/Config3.java (with props)
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/AbstractConfigurationClassScannerPlugin.java (with props)
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/GenerateHeaderTest.java (with props)
Removed:
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin-integration-tests/
Modified:
sling/trunk/contrib/extensions/contextaware-config/pom.xml
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/pom.xml
sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/main/java/org/apache/sling/caconfig/bndplugin/ConfigurationClassScannerPlugin.java
Modified: sling/trunk/contrib/extensions/contextaware-config/pom.xml
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/pom.xml?rev=1769352&r1=1769351&r2=1769352&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/pom.xml (original)
+++ sling/trunk/contrib/extensions/contextaware-config/pom.xml Fri Nov 11 22:07:05 2016
@@ -44,11 +44,7 @@
<module>spi</module>
<module>impl</module>
<module>integration-tests</module>
- <!-- BND plugin has to be available before starting maven build -> get from maven repository -->
- <!--
<module>tooling/bnd-plugin</module>
- <module>tooling/bnd-plugin-integration-tests</module>
- -->
</modules>
<build>
Modified: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/pom.xml
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/pom.xml?rev=1769352&r1=1769351&r2=1769352&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/pom.xml (original)
+++ sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/pom.xml Fri Nov 11 22:07:05 2016
@@ -51,6 +51,28 @@
<version>3.3.2</version>
<scope>compile</scope>
</dependency>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-api</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.mockito</groupId>
+ <artifactId>mockito-core</artifactId>
+ <version>2.2.15</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.caconfig.api</artifactId>
+ <version>1.0.0</version>
+ <scope>test</scope>
+ </dependency>
</dependencies>
</project>
Modified: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/main/java/org/apache/sling/caconfig/bndplugin/ConfigurationClassScannerPlugin.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/main/java/org/apache/sling/caconfig/bndplugin/ConfigurationClassScannerPlugin.java?rev=1769352&r1=1769351&r2=1769352&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/main/java/org/apache/sling/caconfig/bndplugin/ConfigurationClassScannerPlugin.java (original)
+++ sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/main/java/org/apache/sling/caconfig/bndplugin/ConfigurationClassScannerPlugin.java Fri Nov 11 22:07:05 2016
@@ -18,10 +18,10 @@
*/
package org.apache.sling.caconfig.bndplugin;
-import java.util.ArrayList;
import java.util.Collection;
-import java.util.List;
import java.util.Map;
+import java.util.SortedSet;
+import java.util.TreeSet;
import org.apache.commons.lang3.StringUtils;
@@ -40,9 +40,9 @@ import aQute.service.reporter.Reporter;
*/
public class ConfigurationClassScannerPlugin implements AnalyzerPlugin, Plugin {
- private static final String CONFIGURATION_ANNOTATION_CLASS = "org.apache.sling.caconfig.annotation.Configuration";
+ static final String CONFIGURATION_ANNOTATION_CLASS = "org.apache.sling.caconfig.annotation.Configuration";
- private static final String CONFIGURATION_CLASSES_HEADER = "Sling-ContextAware-Configuration-Classes";
+ static final String CONFIGURATION_CLASSES_HEADER = "Sling-ContextAware-Configuration-Classes";
private Reporter reporter;
@@ -63,7 +63,9 @@ public class ConfigurationClassScannerPl
Collection<String> classNames = getClassesWithAnnotation(CONFIGURATION_ANNOTATION_CLASS, analyzer);
// set bundle header containing all class names found
- analyzer.set(CONFIGURATION_CLASSES_HEADER, StringUtils.join(classNames, ","));
+ if (!classNames.isEmpty()) {
+ analyzer.set(CONFIGURATION_CLASSES_HEADER, StringUtils.join(classNames, ","));
+ }
// we did not change any classes - no need to re-analyze
return false;
@@ -76,7 +78,7 @@ public class ConfigurationClassScannerPl
* @return Class names
*/
private Collection<String> getClassesWithAnnotation(String annotationClassName, Analyzer analyzer) {
- List<String> classNames = new ArrayList<>();
+ SortedSet<String> classNames = new TreeSet<>();
Collection<Clazz> clazzes = analyzer.getClassspace().values();
Instruction instruction = new Instruction(annotationClassName);
try {
Added: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config1.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config1.java?rev=1769352&view=auto
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config1.java (added)
+++ sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config1.java Fri Nov 11 22:07:05 2016
@@ -0,0 +1,26 @@
+/*
+ * 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 dummy.example.pkg1;
+
+import org.apache.sling.caconfig.annotation.Configuration;
+
+@Configuration
+public @interface Config1 {
+
+}
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config1.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config1.java
------------------------------------------------------------------------------
--- svn:keywords (added)
+++ svn:keywords Fri Nov 11 22:07:05 2016
@@ -0,0 +1 @@
+LastChangedDate LastChangedRevision LastChangedBy HeadURL Id Author
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config1.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config2.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config2.java?rev=1769352&view=auto
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config2.java (added)
+++ sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config2.java Fri Nov 11 22:07:05 2016
@@ -0,0 +1,26 @@
+/*
+ * 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 dummy.example.pkg1;
+
+import org.apache.sling.caconfig.annotation.Configuration;
+
+@Configuration
+public @interface Config2 {
+
+}
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config2.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config2.java
------------------------------------------------------------------------------
--- svn:keywords (added)
+++ svn:keywords Fri Nov 11 22:07:05 2016
@@ -0,0 +1 @@
+LastChangedDate LastChangedRevision LastChangedBy HeadURL Id Author
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/Config2.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/sub1/Config3.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/sub1/Config3.java?rev=1769352&view=auto
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/sub1/Config3.java (added)
+++ sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/sub1/Config3.java Fri Nov 11 22:07:05 2016
@@ -0,0 +1,26 @@
+/*
+ * 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 dummy.example.pkg1.sub1;
+
+import org.apache.sling.caconfig.annotation.Configuration;
+
+@Configuration
+public @interface Config3 {
+
+}
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/sub1/Config3.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/sub1/Config3.java
------------------------------------------------------------------------------
--- svn:keywords (added)
+++ svn:keywords Fri Nov 11 22:07:05 2016
@@ -0,0 +1 @@
+LastChangedDate LastChangedRevision LastChangedBy HeadURL Id Author
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/dummy/example/pkg1/sub1/Config3.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/AbstractConfigurationClassScannerPlugin.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/AbstractConfigurationClassScannerPlugin.java?rev=1769352&view=auto
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/AbstractConfigurationClassScannerPlugin.java (added)
+++ sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/AbstractConfigurationClassScannerPlugin.java Fri Nov 11 22:07:05 2016
@@ -0,0 +1,79 @@
+/*
+ * 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.sling.caconfig.bndplugin;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.fail;
+import static org.mockito.Mockito.mock;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.jar.Manifest;
+
+import org.apache.commons.lang3.StringUtils;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.runner.RunWith;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import aQute.bnd.osgi.Builder;
+import aQute.bnd.osgi.Jar;
+import aQute.bnd.service.Plugin;
+import aQute.service.reporter.Reporter;
+
+@RunWith(MockitoJUnitRunner.class)
+public abstract class AbstractConfigurationClassScannerPlugin {
+
+ protected Builder builder;
+
+ @Before
+ public final void setUp() throws Exception {
+ builder = new Builder();
+
+ Jar classesDirJar = new Jar("test.jar", new File("target/test-classes"));
+ classesDirJar.setManifest(new Manifest());
+ builder.setJar(classesDirJar);
+
+ builder.setSourcepath(new File[] { new File("src/test/java") } );
+
+ Plugin plugin = new ConfigurationClassScannerPlugin();
+ plugin.setReporter(mock(Reporter.class));
+ plugin.setProperties(new HashMap<String,String>());
+ builder.addBasicPlugin(plugin);
+ }
+
+ @After
+ public final void tearDown() throws Exception {
+ if (!builder.getErrors().isEmpty()) {
+ fail(StringUtils.join(builder.getErrors(), "\n"));
+ }
+ builder.close();
+ }
+
+ protected final void assertHeader(Jar jar, String headerName, String... headerValues) throws Exception {
+ Set<String> expectedValues = new HashSet<>(Arrays.asList(headerValues));
+ String[] actual = StringUtils.split(jar.getManifest().getMainAttributes().getValue(headerName), ",");
+ Set<String> actualValues = new HashSet<>(Arrays.asList(actual));
+ assertEquals(expectedValues, actualValues);
+ }
+
+}
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/AbstractConfigurationClassScannerPlugin.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/AbstractConfigurationClassScannerPlugin.java
------------------------------------------------------------------------------
--- svn:keywords (added)
+++ svn:keywords Fri Nov 11 22:07:05 2016
@@ -0,0 +1 @@
+LastChangedDate LastChangedRevision LastChangedBy HeadURL Id Author
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/AbstractConfigurationClassScannerPlugin.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/GenerateHeaderTest.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/GenerateHeaderTest.java?rev=1769352&view=auto
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/GenerateHeaderTest.java (added)
+++ sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/GenerateHeaderTest.java Fri Nov 11 22:07:05 2016
@@ -0,0 +1,39 @@
+/*
+ * 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.sling.caconfig.bndplugin;
+
+import static org.apache.sling.caconfig.bndplugin.ConfigurationClassScannerPlugin.*;
+
+import org.junit.Test;
+
+import aQute.bnd.osgi.Jar;
+
+public class GenerateHeaderTest extends AbstractConfigurationClassScannerPlugin {
+
+ @Test
+ public void testBuild() throws Exception {
+ Jar jar = builder.build();
+
+ assertHeader(jar, CONFIGURATION_CLASSES_HEADER,
+ "dummy.example.pkg1.Config1",
+ "dummy.example.pkg1.Config2",
+ "dummy.example.pkg1.sub1.Config3");
+ }
+
+}
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/GenerateHeaderTest.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/GenerateHeaderTest.java
------------------------------------------------------------------------------
--- svn:keywords (added)
+++ svn:keywords Fri Nov 11 22:07:05 2016
@@ -0,0 +1 @@
+LastChangedDate LastChangedRevision LastChangedBy HeadURL Id Author
Propchange: sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin/src/test/java/org/apache/sling/caconfig/bndplugin/GenerateHeaderTest.java
------------------------------------------------------------------------------
svn:mime-type = text/plain