This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-providertype-bnd-plugin.git
commit bce3164489b99c09e9edbef2f7ea9d6c105cb7fc
Author: Konrad Windszus <k...@apache.org>
AuthorDate: Tue Dec 5 17:11:45 2023 +0100
SLING-12026: Initial implementation of a bnd plugin enforcing that no
class extends a provider type
---
.gitignore | 18 ++
CODE_OF_CONDUCT.md | 22 +++
CONTRIBUTING.md | 24 +++
LICENSE | 202 +++++++++++++++++++++
pom.xml | 93 ++++++++++
readme.md | 56 ++++++
.../bndplugin/ProviderTypeScanner.java | 130 +++++++++++++
.../bndplugin/BndBuilderExtension.java | 66 +++++++
.../bndplugin/ProviderTypeScannerTest.java | 97 ++++++++++
.../apache/sling/providertype/bndplugin/TypeA.java | 23 +++
.../sling/providertype/bndplugin/TypeAImpl.java | 23 +++
.../apache/sling/providertype/bndplugin/TypeB.java | 23 +++
.../providertype/bndplugin/TypeBExtension.java | 23 +++
src/test/resources/META-INF/api-info.json | 3 +
src/test/resources2/META-INF/api-info.json | 3 +
src/test/resources3/META-INF/api-info.json | 4 +
16 files changed, 810 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..c7f991e
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,18 @@
+/target
+.idea
+.classpath
+.metadata
+.project
+.settings
+.externalToolBuilders
+maven-eclipse.xml
+*.swp
+*.iml
+*.ipr
+*.iws
+*.bak
+.vlt
+.vscode
+.DS_Store
+jcr.log
+atlassian-ide-plugin.xml
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..0fa18e5
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,22 @@
+<!--/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ 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.
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/-->
+Apache Software Foundation Code of Conduct
+====
+
+Being an Apache project, Apache Sling adheres to the Apache Software
Foundation's [Code of
Conduct](https://www.apache.org/foundation/policies/conduct.html).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..ac82a1a
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,24 @@
+<!--/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ 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.
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/-->
+Contributing
+====
+
+Thanks for choosing to contribute!
+
+You will find all the necessary details about how you can do this at
https://sling.apache.org/contributing.html.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
diff --git a/pom.xml b/pom.xml
new file mode 100644
index 0000000..8062adb
--- /dev/null
+++ b/pom.xml
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
https://maven.apache.org/xsd/maven-4.0.0.xsd";>
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>sling</artifactId>
+ <version>52</version>
+ <relativePath />
+ </parent>
+ <artifactId>org.apache.sling.providertype.bnd-plugin</artifactId>
+ <version>0.0.1-SNAPSHOT</version>
+
+ <name>Apache Sling Provider Type Checker Bnd Plugin</name>
+ <description>Bnd plugin enforcing that no class extends/implements a
provider type</description>
+
+ <properties>
+ <sling.java.version>11</sling.java.version>
+
<minimalJavaBuildVersion>${sling.java.version}</minimalJavaBuildVersion>
+
<project.build.outputTimestamp>1675867676</project.build.outputTimestamp>
+ <bnd.version>6.0.0</bnd.version>
+ </properties>
+
+ <scm>
+
<connection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-providertype-bnd-plugin.git</connection>
+
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-providertype-bnd-plugin.git</developerConnection>
+
<url>https://github.com/apache/sling-org-apache-sling-providertype-bnd-plugin/tree/${project.scm.tag}</url>
+ <tag>HEAD</tag>
+ </scm>
+
+ <dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.junit</groupId>
+ <artifactId>junit-bom</artifactId>
+ <version>5.10.0</version>
+ <type>pom</type>
+ <scope>import</scope>
+ </dependency>
+ </dependencies>
+ </dependencyManagement>
+
+ <dependencies>
+ <dependency>
+ <groupId>biz.aQute.bnd</groupId>
+ <artifactId>biz.aQute.bndlib</artifactId>
+ <version>${bnd.version}</version>
+ <scope>provided</scope>
+ </dependency>
+ <!-- testing dependencies -->
+ <dependency>
+ <groupId>org.junit.jupiter</groupId>
+ <artifactId>junit-jupiter</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.hamcrest</groupId>
+ <artifactId>hamcrest-library</artifactId>
+ <version>2.2</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.mockito</groupId>
+ <artifactId>mockito-core</artifactId>
+ <version>5.6.0</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-simple</artifactId>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+</project>
\ No newline at end of file
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..0ee5dca
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,56 @@
+[](https://sling.apache.org)
+
+# Apache Sling Provider Type Checker Bnd Plugin
+
+This module contains a [Bnd plugin][bnd-plugins] enforcing that no class of
the current bundle extends or implements a [provider type][provider-type]. Note
that *using* a provider type (i.e. calling its methods without implementing or
extending it) is still allowed (even for consumers).
+
+That ensures that the `import-package` version ranges are not narrow but
[broad][semantic-versioning] and the risk that the bundle is incompatible with
newer versions of its dependent bundles is less likely.
+
+# Usage
+
+For usage with Maven the Bnd plugin has to be added to the plugin dependencies
of `bnd-maven-plugin` (or `maven-bundle-plugin`) like this:
+
+```
+<plugin>
+ <groupId>biz.aQute.bnd</groupId>
+ <artifactId>bnd-maven-plugin</artifactId>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.providertype.bnd-plugin</artifactId>
+ <version>1.0.0</version>
+ </dependency>
+ </dependencies>
+</plugin>
+```
+
+In addition the `bnd.bnd` file needs to register the Bnd plugin with the
[plugin instruction](https://bnd.bndtools.org/instructions/plugin.html)
+
+```
+-plugin.providertype:org.apache.sling.providertype.bndplugin.ProviderTypeScanner
+```
+
+## Configuration
+
+To explicitly ignore certain provider types (i.e. don't fail when these are
extended/implemented) one can use the attribute `ignored` with one or multiple
comma-separated fully qualified provider type names. For example
+
+```
+-plugin.providertype:org.apache.sling.providertype.bndplugin.ProviderTypeScanner;ignored=org.apache.jackrabbit.api.security.user.User
+```
+
+## Prerequisites
+
+* Bnd 6.0 or newer (integrated in `bnd-maven-plugin` version 6.0.0+ or
`maven-bundle-plugin` version 5.1.5+)
+* Java 11 or newer
+
+# Provider Type Information
+
+The information whether a type (i.e. a class or interface) is designed to be
extended/implemented only by providers or also by consumers is determined
originally from the the annotations
[`@org.osgi.annotation.versioning.ProviderType`][provider-type] or
[`@org.osgi.annotation.versioning.ConsumerType`][consumer-type].
+In order to speed up the check [the annotation is evaluated and extracted into
a dedicated JSON file named `META-INF/api-info.json` when generating the apis
jar](https://issues.apache.org/jira/browse/SLING-12135) and being looked up
from there within this plugin.
+
+
+[bnd-plugins]: https://bnd.bndtools.org/chapters/870-plugins.html
+[provider-type]:
https://docs.osgi.org/javadoc/osgi.annotation/8.0.0/org/osgi/annotation/versioning/ProviderType.html
+[consumer-type]:
https://docs.osgi.org/javadoc/osgi.annotation/8.0.0/org/osgi/annotation/versioning/ConsumerType.html
+[semantic-versioning]:
https://docs.osgi.org/whitepaper/semantic-versioning/060-importer-policy.html
diff --git
a/src/main/java/org/apache/sling/providertype/bndplugin/ProviderTypeScanner.java
b/src/main/java/org/apache/sling/providertype/bndplugin/ProviderTypeScanner.java
new file mode 100644
index 0000000..d4c3b0a
--- /dev/null
+++
b/src/main/java/org/apache/sling/providertype/bndplugin/ProviderTypeScanner.java
@@ -0,0 +1,130 @@
+/*
+ * 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.providertype.bndplugin;
+
+import java.io.InputStream;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import aQute.bnd.osgi.Analyzer;
+import aQute.bnd.osgi.Clazz;
+import aQute.bnd.osgi.Descriptors.TypeRef;
+import aQute.bnd.osgi.Resource;
+import aQute.bnd.service.AnalyzerPlugin;
+import aQute.bnd.service.Plugin;
+import aQute.lib.json.Decoder;
+import aQute.lib.json.JSONCodec;
+import aQute.service.reporter.Reporter;
+
+/**
+ * Enforces that no classes implement or extend a type marked as provider.
+ * Provider types are retrieved from the resource "META-INF/api-info.json"
which is expected to be provided
+ * in the class path.
+ */
+public class ProviderTypeScanner implements AnalyzerPlugin, Plugin {
+
+ private static final String API_INFO_JSON_RESOURCE_PATH =
"META-INF/api-info.json";
+ private static final String FIELD_PROVIDER_TYPES = "providerTypes";
+ private static final String MESSAGE = "Type \"%s\" %s provider type
\"%s\". This is not allowed!";
+ private static final String ATTRIBUTE_IGNORED_PROVIDER_TYPES = "ignored";
+
+ private Map<String,String> parameters = new HashMap<>();
+
+ @Override
+ public void setProperties(Map<String, String> map) throws Exception {
+ //
https://docs.osgi.org/specification/osgi.core/8.0.0/framework.module.html#framework.common.header.syntax
+ parameters.clear();
+ parameters.putAll(map);
+ }
+
+ @Override
+ public void setReporter(Reporter processor) {
+ // no need to store it as passed in analyzeJar(...) as well
+ }
+
+ @Override
+ public boolean analyzeJar(Analyzer analyzer) throws Exception {
+ List<Resource> apiInfoJsonResources = analyzer.findResources(s ->
s.equals(API_INFO_JSON_RESOURCE_PATH)).collect(Collectors.toList());
+ if(apiInfoJsonResources.isEmpty()) {
+ analyzer.warning("Could not find resource \"%s\" in the
classpath", API_INFO_JSON_RESOURCE_PATH);
+ } else {
+ Set<String> providerTypes = new HashSet<>();
+ for (Resource apiInfoJsonResource : apiInfoJsonResources) {
+ try {
+ Set<String> resourceProviderTypes =
collectProviderTypes(analyzer, apiInfoJsonResource);
+ analyzer.trace("Added provider types from resource \"%s\":
%s", apiInfoJsonResource, String.join(",", resourceProviderTypes));
+ providerTypes.addAll(resourceProviderTypes);
+ } catch (Exception e) {
+ throw new IllegalStateException("Could not parse JSON from
resource " + apiInfoJsonResource, e);
+ }
+ }
+ // remove ignored provider types
+
Arrays.stream(parameters.getOrDefault(ATTRIBUTE_IGNORED_PROVIDER_TYPES,
"").split(",")).filter(s -> !s.isBlank()).forEach(ignored -> {
+ if (providerTypes.remove(ignored)) {
+ analyzer.trace("Ignore extensions of provider type \"%s\"
due to plugin configuration", ignored);
+ } else {
+ analyzer.warning("Ignored class \"%s\" is not defined as
provider type at all, you can safely remove the according plugin parameter",
ignored);
+ }
+ });
+ checkIfExtendingType(analyzer, analyzer.getClassspace().values(),
providerTypes);
+ }
+ return false;
+ }
+
+ private void checkIfExtendingType(Reporter reporter, Collection<Clazz>
clazzes, Set<String> providerTypes) {
+ for (Clazz clazz : clazzes) {
+ if (clazz.getSuper() != null &&
(providerTypes.contains(clazz.getSuper().getFQN()))) {
+ reporter.error(MESSAGE, clazz.getFQN(), "extends",
clazz.getSuper().getFQN()).file(clazz.getSourceFile());
+ }
+ for (TypeRef interfaceType : clazz.interfaces()) {
+ if (providerTypes.contains(interfaceType.getFQN())) {
+ reporter.error(MESSAGE, clazz.getFQN(), "implements",
interfaceType.getFQN()).file(clazz.getSourceFile());
+ }
+ }
+ }
+ }
+
+ @SuppressWarnings("unchecked")
+ private Set<String> collectProviderTypes(Reporter reporter, Resource
apiInfoResource) throws Exception {
+ JSONCodec codec = new JSONCodec();
+ // read JSON file
+ try (InputStream input = apiInfoResource.openInputStream();
+ Decoder decoder = codec.dec().from(input)) {
+ Map<?, ?> jsonMap = decoder.get(Map.class);
+ Object providerTypes = jsonMap.get(FIELD_PROVIDER_TYPES);
+ if (providerTypes == null) {
+ reporter.error("Resource \"%s\" does not contain a field named
\"%s\"", API_INFO_JSON_RESOURCE_PATH, FIELD_PROVIDER_TYPES);
+ } else if (!(providerTypes instanceof Collection)) {
+ reporter.error("Field \"%s\" in JSON resource \"%s\" is not
containing a string array but a type converted to %s", FIELD_PROVIDER_TYPES,
API_INFO_JSON_RESOURCE_PATH, providerTypes.getClass().getName());
+ } else {
+ return new HashSet<>((Collection<String>)providerTypes);
+ }
+ }
+ return Collections.emptySet();
+ }
+
+
+}
\ No newline at end of file
diff --git
a/src/test/java/org/apache/sling/providertype/bndplugin/BndBuilderExtension.java
b/src/test/java/org/apache/sling/providertype/bndplugin/BndBuilderExtension.java
new file mode 100644
index 0000000..d14add8
--- /dev/null
+++
b/src/test/java/org/apache/sling/providertype/bndplugin/BndBuilderExtension.java
@@ -0,0 +1,66 @@
+/*
+ * 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.providertype.bndplugin;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.jar.Manifest;
+
+import org.junit.jupiter.api.extension.AfterEachCallback;
+import org.junit.jupiter.api.extension.BeforeEachCallback;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+import aQute.bnd.osgi.Builder;
+import aQute.bnd.osgi.Jar;
+import aQute.bnd.service.Plugin;
+
+public class BndBuilderExtension implements BeforeEachCallback,
AfterEachCallback {
+
+ protected Builder builder;
+ private final Collection<Object> plugins;
+
+ public BndBuilderExtension(Object... plugins) {
+ this.plugins = Arrays.asList(plugins);
+ }
+
+ @Override
+ public void beforeEach(ExtensionContext context) throws Exception {
+ builder = new Builder();
+ Jar classesDirJar = new Jar("test.jar", new
File("target/test-classes"));
+ classesDirJar.setManifest(new Manifest());
+ builder.setJar(classesDirJar); // jar closed with builder
+ builder.setSourcepath(new File[] { new File("src/test/java") } );
+ for (Object plugin : plugins) {
+ if (plugin instanceof Plugin) {
+ Plugin pluginPlugin = (Plugin)plugin;
+ pluginPlugin.setReporter(builder);
+ pluginPlugin.setProperties(new HashMap<>()); // not used
+ }
+ builder.addBasicPlugin(plugin);
+ }
+ }
+
+ @Override
+ public void afterEach(ExtensionContext context) throws IOException {
+ builder.close();
+ }
+}
diff --git
a/src/test/java/org/apache/sling/providertype/bndplugin/ProviderTypeScannerTest.java
b/src/test/java/org/apache/sling/providertype/bndplugin/ProviderTypeScannerTest.java
new file mode 100644
index 0000000..bf26f0f
--- /dev/null
+++
b/src/test/java/org/apache/sling/providertype/bndplugin/ProviderTypeScannerTest.java
@@ -0,0 +1,97 @@
+/*
+ * 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.providertype.bndplugin;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.fail;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import aQute.bnd.osgi.Builder;
+import aQute.bnd.osgi.Jar;
+
+class ProviderTypeScannerTest {
+
+ @RegisterExtension
+ static BndBuilderExtension bndBuilderExtension = new
BndBuilderExtension(new ProviderTypeScanner());
+
+ @Test
+ void testBuildWithViolations() throws Exception {
+ Builder builder = bndBuilderExtension.builder;
+ // add classpath entry with api-info.json
+ builder.setClasspath(new File[] { new File("src/test/resources") });
+ try (Jar jar = builder.build()) {
+ List<String> expectedErrors = Arrays.asList(
+ "Type
\"org.apache.sling.providertype.bndplugin.TypeAImpl\" implements provider type
\"org.apache.sling.providertype.bndplugin.TypeA\". This is not allowed!",
+ "Type
\"org.apache.sling.providertype.bndplugin.TypeBExtension\" extends provider
type \"org.apache.sling.providertype.bndplugin.TypeB\". This is not allowed!");
+ assertEquals(expectedErrors, builder.getErrors());
+ if (!builder.getWarnings().isEmpty()) {
+ fail(String.join("\n", builder.getWarnings()));
+ }
+ }
+ }
+
+ @Test
+ void testBuildWithoutProviderTypeMetadata() throws Exception {
+ Builder builder = bndBuilderExtension.builder;
+ try (Jar jar = builder.build()) {
+ if (!builder.getErrors().isEmpty()) {
+ fail(String.join("\n", builder.getErrors()));
+ }
+ List<String> expectedWarnings = Arrays.asList(
+ "Could not find resource \"META-INF/api-info.json\" in the
classpath");
+ assertEquals(expectedWarnings, builder.getWarnings());
+ }
+ }
+
+ @Test
+ void testBuildWithInvalidProviderTypeMetadata() throws Exception {
+ Builder builder = bndBuilderExtension.builder;
+ // add classpath entry with api-info.json
+ builder.setClasspath(new File[] { new File("src/test/resources2") });
+ try (Jar jar = builder.build()) {
+ List<String> expectedErrors = Arrays.asList(
+ "Resource \"META-INF/api-info.json\" does not contain a
field named \"providerTypes\"");
+ assertEquals(expectedErrors, builder.getErrors());
+ if (!builder.getWarnings().isEmpty()) {
+ fail(String.join("\n", builder.getWarnings()));
+ }
+ }
+ }
+
+ @Test
+ void testBuildWithInvalidProviderTypeMetadata2() throws Exception {
+ Builder builder = bndBuilderExtension.builder;
+ // add classpath entry with api-info.json
+ builder.setClasspath(new File[] { new File("src/test/resources3") });
+ try (Jar jar = builder.build()) {
+ assertEquals(2, builder.getErrors().size());
+ assertTrue(builder.getErrors().get(0).startsWith("Exception:
java.lang.IllegalStateException: Could not parse JSON from resource"));
+ if (!builder.getWarnings().isEmpty()) {
+ fail(String.join("\n", builder.getWarnings()));
+ }
+ }
+ }
+}
diff --git a/src/test/java/org/apache/sling/providertype/bndplugin/TypeA.java
b/src/test/java/org/apache/sling/providertype/bndplugin/TypeA.java
new file mode 100644
index 0000000..521d1db
--- /dev/null
+++ b/src/test/java/org/apache/sling/providertype/bndplugin/TypeA.java
@@ -0,0 +1,23 @@
+/*
+ * 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.providertype.bndplugin;
+
+public interface TypeA {
+
+}
diff --git
a/src/test/java/org/apache/sling/providertype/bndplugin/TypeAImpl.java
b/src/test/java/org/apache/sling/providertype/bndplugin/TypeAImpl.java
new file mode 100644
index 0000000..2061e7a
--- /dev/null
+++ b/src/test/java/org/apache/sling/providertype/bndplugin/TypeAImpl.java
@@ -0,0 +1,23 @@
+/*
+ * 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.providertype.bndplugin;
+
+public class TypeAImpl implements TypeA {
+
+}
diff --git a/src/test/java/org/apache/sling/providertype/bndplugin/TypeB.java
b/src/test/java/org/apache/sling/providertype/bndplugin/TypeB.java
new file mode 100644
index 0000000..141fb5a
--- /dev/null
+++ b/src/test/java/org/apache/sling/providertype/bndplugin/TypeB.java
@@ -0,0 +1,23 @@
+/*
+ * 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.providertype.bndplugin;
+
+public class TypeB {
+
+}
diff --git
a/src/test/java/org/apache/sling/providertype/bndplugin/TypeBExtension.java
b/src/test/java/org/apache/sling/providertype/bndplugin/TypeBExtension.java
new file mode 100644
index 0000000..c227cc2
--- /dev/null
+++ b/src/test/java/org/apache/sling/providertype/bndplugin/TypeBExtension.java
@@ -0,0 +1,23 @@
+/*
+ * 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.providertype.bndplugin;
+
+public class TypeBExtension extends TypeB {
+
+}
diff --git a/src/test/resources/META-INF/api-info.json
b/src/test/resources/META-INF/api-info.json
new file mode 100644
index 0000000..ce4dcf7
--- /dev/null
+++ b/src/test/resources/META-INF/api-info.json
@@ -0,0 +1,3 @@
+{
+
"providerTypes":["org.apache.sling.providertype.bndplugin.TypeA","org.apache.sling.providertype.bndplugin.TypeB"]
+}
\ No newline at end of file
diff --git a/src/test/resources2/META-INF/api-info.json
b/src/test/resources2/META-INF/api-info.json
new file mode 100644
index 0000000..94a2d1d
--- /dev/null
+++ b/src/test/resources2/META-INF/api-info.json
@@ -0,0 +1,3 @@
+{
+ "foo":"bar"
+}
\ No newline at end of file
diff --git a/src/test/resources3/META-INF/api-info.json
b/src/test/resources3/META-INF/api-info.json
new file mode 100644
index 0000000..573e373
--- /dev/null
+++ b/src/test/resources3/META-INF/api-info.json
@@ -0,0 +1,4 @@
+{
+ "foo"
+
+}
\ No newline at end of file
