You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2017/11/07 09:19:02 UTC
[sling-org-apache-sling-caconfig-bnd-plugin] 03/07: 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
This is an automated email from the ASF dual-hosted git repository.
rombert pushed a commit to annotated tag org.apache.sling.caconfig.bnd-plugin-1.0.2
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-caconfig-bnd-plugin.git
commit fc320eab4f0142ae4775662fb7e01ac4d193eed4
Author: Stefan Seifert <ss...@apache.org>
AuthorDate: Fri Nov 11 22:07:05 2016 +0000
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
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/contextaware-config/tooling/bnd-plugin@1769352 13f79535-47bb-0310-9956-ffa450edef68
---
pom.xml | 22 ++++++
.../bndplugin/ConfigurationClassScannerPlugin.java | 14 ++--
src/test/java/dummy/example/pkg1/Config1.java | 26 +++++++
src/test/java/dummy/example/pkg1/Config2.java | 26 +++++++
src/test/java/dummy/example/pkg1/sub1/Config3.java | 26 +++++++
.../AbstractConfigurationClassScannerPlugin.java | 79 ++++++++++++++++++++++
.../caconfig/bndplugin/GenerateHeaderTest.java | 39 +++++++++++
7 files changed, 226 insertions(+), 6 deletions(-)
diff --git a/pom.xml b/pom.xml
index cea3692..788d622 100644
--- a/pom.xml
+++ b/pom.xml
@@ -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>
diff --git a/src/main/java/org/apache/sling/caconfig/bndplugin/ConfigurationClassScannerPlugin.java b/src/main/java/org/apache/sling/caconfig/bndplugin/ConfigurationClassScannerPlugin.java
index 1b9b779..9584741 100644
--- a/src/main/java/org/apache/sling/caconfig/bndplugin/ConfigurationClassScannerPlugin.java
+++ b/src/main/java/org/apache/sling/caconfig/bndplugin/ConfigurationClassScannerPlugin.java
@@ -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 ConfigurationClassScannerPlugin implements AnalyzerPlugin, Plugin {
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 ConfigurationClassScannerPlugin implements AnalyzerPlugin, Plugin {
* @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 {
diff --git a/src/test/java/dummy/example/pkg1/Config1.java b/src/test/java/dummy/example/pkg1/Config1.java
new file mode 100644
index 0000000..9dd90b7
--- /dev/null
+++ b/src/test/java/dummy/example/pkg1/Config1.java
@@ -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 {
+
+}
diff --git a/src/test/java/dummy/example/pkg1/Config2.java b/src/test/java/dummy/example/pkg1/Config2.java
new file mode 100644
index 0000000..322a1df
--- /dev/null
+++ b/src/test/java/dummy/example/pkg1/Config2.java
@@ -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 {
+
+}
diff --git a/src/test/java/dummy/example/pkg1/sub1/Config3.java b/src/test/java/dummy/example/pkg1/sub1/Config3.java
new file mode 100644
index 0000000..456413c
--- /dev/null
+++ b/src/test/java/dummy/example/pkg1/sub1/Config3.java
@@ -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 {
+
+}
diff --git a/src/test/java/org/apache/sling/caconfig/bndplugin/AbstractConfigurationClassScannerPlugin.java b/src/test/java/org/apache/sling/caconfig/bndplugin/AbstractConfigurationClassScannerPlugin.java
new file mode 100644
index 0000000..e0e9e31
--- /dev/null
+++ b/src/test/java/org/apache/sling/caconfig/bndplugin/AbstractConfigurationClassScannerPlugin.java
@@ -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);
+ }
+
+}
diff --git a/src/test/java/org/apache/sling/caconfig/bndplugin/GenerateHeaderTest.java b/src/test/java/org/apache/sling/caconfig/bndplugin/GenerateHeaderTest.java
new file mode 100644
index 0000000..aed0980
--- /dev/null
+++ b/src/test/java/org/apache/sling/caconfig/bndplugin/GenerateHeaderTest.java
@@ -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");
+ }
+
+}
--
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.