Apache Sling Feature Model Analyser

Clone this repo:
  1. a995c78 SLING-8784 : Move api regions analysers to api regions extension by Carsten Ziegeler · 6 days ago master
  2. f635bb3 SLING-8784 : Move api regions analysers to api regions extension by Carsten Ziegeler · 6 days ago
  3. d71fcbf [maven-release-plugin] prepare for next development iteration by David Bosschaert · 9 weeks ago
  4. df1242b [maven-release-plugin] prepare release org.apache.sling.feature.analyser-1.1.0 by David Bosschaert · 9 weeks ago org.apache.sling.feature.analyser-1.1.0
  5. 38f4578 Fix JavaDoc by David Bosschaert · 9 weeks ago

Build Status Maven Central JavaDocs License feature

Feature Model Analyser

The Analyser can analyse features for completeness and correctness. The analyser is pluggable and can also perform other checks.

The analyser can be run from the commandline by running the following main class:

java org.apache.sling.feature.analyser.main.Main

Feature Model Analyser as a Maven Plugin

The Analyser can also be run as part of a maven build via the slingfeature-maven-plugin: https://github.com/apache/sling-slingfeature-maven-plugin

The following analysers are defined:

  • bundle-packages: Checks bundle import/export package statements for consistency and completeness. If API Regions are used this analyser includes this information as part of the check, to ensure that bundles don't import packages of which they have no visibility because of API Regions restrictions.

  • bundle-content: Gives a warning if a bundle container initial content specified with Sling-Initial-Content.

  • bundle-resources: Gives a warning if a bundle contains resources specified with Sling-Bundle-Resources.

  • requirements-capabilities: Checks bundle requirements/capabilities for consistency and completeness.

  • exported-packages: Lists all packages in the feature and writes these to a packages.txt file. This analyser task is not enabled by default.

There are a number of analysers which relate to API Region definitions in Feature Models.

  • api-regions: This analyser ensures that packages listed as exports in API-Regions sections are actually exported by a bundle that's part of the feature.

  • api-regions-dependencies: This analyser checks that packages in API regions listed earlier in the API-Regions declaration have no dependency on API regions listed later in the list. This include Import-Package style dependencies and also uses-clause type dependencies. Later API regions also include packages from earlier declared API regions, but not the other way around.

    • Configuration parameters:
    • exporting-apis: the name of the region that provides the visible APIs.
    • hiding-apis: the name of the region that is ‘hidden’ i.e. not as visible as the exporting one. The packages in the exporting-api cannot depend on any packages from this region.
  • api-regions-duplicates: This analyser ensures that packages are only listed in one region in a given feature. If the same package is listed in multiple regions this will be an error.

  • api-regions-check-order: This analyser checks that regions are defined in the specified order and that the same region is only declared once. Later regions inherit the packages expose in earlier regions in the list, so the order is important.

    • Configuration parameters:
    • order: A comma separated list of the region names declaring the order in which they should be found. Not all regions declared must be present, but if they are present this order must be obeyed.

For further documentation see: https://github.com/apache/sling-org-apache-sling-feature/blob/master/readme.md