diff --git a/feature-analyser-extension/CODE_OF_CONDUCT.md b/feature-analyser-extension/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..0fa18e593 --- /dev/null +++ b/feature-analyser-extension/CODE_OF_CONDUCT.md @@ -0,0 +1,22 @@ + +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/feature-analyser-extension/CONTRIBUTING.md b/feature-analyser-extension/CONTRIBUTING.md new file mode 100644 index 000000000..ac82a1abe --- /dev/null +++ b/feature-analyser-extension/CONTRIBUTING.md @@ -0,0 +1,24 @@ + +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/feature-analyser-extension/LICENSE b/feature-analyser-extension/LICENSE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/feature-analyser-extension/LICENSE @@ -0,0 +1,201 @@ + 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/feature-analyser-extension/README.md b/feature-analyser-extension/README.md new file mode 100644 index 000000000..5b47f676a --- /dev/null +++ b/feature-analyser-extension/README.md @@ -0,0 +1,10 @@ +[](http://sling.apache.org) + +# Apache Sling Feature Model Analyser Extension + +This extension of the Sling Featuremodel Launcher adds the capability to run analysis of the provided feature model and identify incoherent feature combinations to block startup. + +## Usage +Configuration of the Analyser Launcher is similar to the launcher - in addition the apiregion extension has to be added to the classpath and regionsorder has to be configured via system property for all analysers to be executed. +Dynamic configuration of AnalyserTasks is out of scope of first iteration. +`java -Dregionsorder="global,deprecated,internal" -cp org.apache.sling.feature.extension.apiregions-1.0.4.jar:org.apache.sling.feature.extension.analyser-0.0.1-SNAPSHOT.jar:org.apache.sling.feature.launcher-1.0.4.jar org.apache.sling.feature.launcher.impl.Main -u file://$HOME/.m2/repository -f mvn:org.myown/myfeature/1.0.0-SNAPSHOT/slingosgifeature/myclassifier` \ No newline at end of file diff --git a/feature-analyser-extension/pom.xml b/feature-analyser-extension/pom.xml new file mode 100644 index 000000000..2c41875be --- /dev/null +++ b/feature-analyser-extension/pom.xml @@ -0,0 +1,132 @@ + + + 4.0.0 + + org.apache.sling + sling + 34 + + + + org.apache.sling.feature.extension.analyser + 0.0.1-SNAPSHOT + Sling Featuremodel - Feature Analyser Exension for Launcher + + + + + The Apache Software License, Version 2.0 + http://www.apache.org/licenses/LICENSE-2.0.txt + + + + + 8 + UTF-8 + + + + + + + org.apache.maven.plugins + maven-shade-plugin + + + package + + shade + + + + + org.apache.sling:org.apache.sling.feature.analyser + org.apache.commons:commons-text + org.apache.commons:commons-lang3 + + + + + + + + org.apache.rat + apache-rat-plugin + + + src/main/resources/META-INF/services/** + + + + + + + + org.osgi + osgi.core + provided + + + org.apache.sling + org.apache.sling.feature + 1.0.4 + provided + + + org.apache.sling + org.apache.sling.feature.io + 1.0.4 + provided + + + org.apache.sling + org.apache.sling.feature.launcher + 1.0.4 + provided + + + org.apache.sling + org.apache.sling.feature.analyser + 1.0.4 + + + org.apache.commons + commons-text + 1.6 + + + org.apache.commons + commons-lang3 + 3.9 + + + + junit + junit + test + + + com.github.stefanbirkner + system-rules + 1.19.0 + test + + + + org.mockito + mockito-core + 2.23.0 + test + + + \ No newline at end of file diff --git a/feature-analyser-extension/src/main/java/org/apache/sling/feature/extension/analyser/AnalyserLauncher.java b/feature-analyser-extension/src/main/java/org/apache/sling/feature/extension/analyser/AnalyserLauncher.java new file mode 100644 index 000000000..1f699460e --- /dev/null +++ b/feature-analyser-extension/src/main/java/org/apache/sling/feature/extension/analyser/AnalyserLauncher.java @@ -0,0 +1,159 @@ +/* + * 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.feature.extension.analyser; + + +import java.io.File; +import java.io.IOException; +import java.net.URL; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.StandardCopyOption; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.apache.commons.lang3.StringUtils; +import org.apache.sling.feature.ArtifactId; +import org.apache.sling.feature.Feature; +import org.apache.sling.feature.analyser.Analyser; +import org.apache.sling.feature.analyser.AnalyserResult; +import org.apache.sling.feature.analyser.task.AnalyserTask; +import org.apache.sling.feature.analyser.task.impl.CheckApiRegions; +import org.apache.sling.feature.analyser.task.impl.CheckApiRegionsDependencies; +import org.apache.sling.feature.analyser.task.impl.CheckApiRegionsDuplicates; +import org.apache.sling.feature.analyser.task.impl.CheckApiRegionsOrder; +import org.apache.sling.feature.analyser.task.impl.CheckBundleExportsImports; +import org.apache.sling.feature.analyser.task.impl.CheckBundlesForResources; +import org.apache.sling.feature.analyser.task.impl.CheckRequirementsCapabilities; +import org.apache.sling.feature.builder.ArtifactProvider; +import org.apache.sling.feature.io.artifacts.ArtifactManager; +import org.apache.sling.feature.io.artifacts.ArtifactManagerConfig; +import org.apache.sling.feature.launcher.spi.Launcher; +import org.apache.sling.feature.launcher.spi.LauncherPrepareContext; +import org.apache.sling.feature.launcher.spi.LauncherRunContext; +import org.apache.sling.feature.scanner.Scanner; +import org.osgi.framework.FrameworkEvent; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +public class AnalyserLauncher implements Launcher { + + + private Runnable analyserRunner; + + private final Logger logger = LoggerFactory.getLogger(this.getClass()); + + @Override + public void prepare(final LauncherPrepareContext context, + final ArtifactId frameworkId, + final Feature app) throws Exception { + + final ArtifactManager am = ArtifactManager.getArtifactManager(new ArtifactManagerConfig()); + final Scanner scanner = new Scanner(new ArtifactProvider(){ + + @Override + public URL provide(ArtifactId id) { + try { + return am.getArtifactHandler(id.toMvnUrl()).getLocalURL(); + } catch (final IOException e) { + return null; + } + } + }); + + this.analyserRunner = new Runnable() { + + @SuppressWarnings("serial") + @Override + public void run() { + try { + Map> analyserTaskConfigs = new HashMap<>(); + List analyserTasks = new ArrayList(); + + analyserTasks.add(new CheckApiRegions()); + String regionsorder = System.getProperty("regionsorder"); + if (StringUtils.isNotEmpty(regionsorder)) { + CheckApiRegionsOrder caro = new CheckApiRegionsOrder(); + analyserTaskConfigs.put(caro.getId(), new HashMap(){{ + put("order", System.getProperty("regionsorder")); + }}); + analyserTasks.add(caro); + } + CheckApiRegionsDependencies cardep = new CheckApiRegionsDependencies(); + String location = System.getProperty("sling.feature.apiregions.resource.bundles.properties"); + if(StringUtils.isNotEmpty(location)) { + File bundleprosrc = new File(location); + Path original = bundleprosrc.toPath(); + Path target = Paths.get("fmtemp/group_assembled_1.0.0/regionOrigins.properties"); + Files.createDirectories(target.getParent()); + Files.copy(original, target, StandardCopyOption.REPLACE_EXISTING); + + analyserTaskConfigs.put("all", new HashMap(){{ + put("fileStorage", target.getParent().getParent().toAbsolutePath().toString()); + }}); + analyserTasks.add(cardep); + } + analyserTasks.add(new CheckApiRegionsDuplicates()); + analyserTasks.add(new CheckBundleExportsImports()); + analyserTasks.add(new CheckRequirementsCapabilities()); + analyserTasks.add(new CheckBundlesForResources()); + + + Analyser analyser = new Analyser(scanner, analyserTaskConfigs, analyserTasks.toArray(new AnalyserTask[analyserTasks.size()])); + + + final AnalyserResult result = analyser.analyse(app, frameworkId); + for (final String msg : result.getWarnings()) { + context.getLogger().warn(msg); + } + for (final String msg : result.getErrors()) { + context.getLogger().error(msg); + } + + if (!result.getErrors().isEmpty()) { + context.getLogger().error("Analyser detected errors. See log output for error messages."); + System.exit(1); + } + + } catch (Exception e) { + context.getLogger().error(e.getMessage()); + System.exit(1); + } + } + }; + } + + + /** + * Run the launcher + * @throws Exception If anything goes wrong + */ + @Override + public int run(final LauncherRunContext context, final ClassLoader cl) throws Exception { + try { + analyserRunner.run(); + } catch ( final Exception e) { + System.exit(1); + } + return FrameworkEvent.STOPPED; + } + +} \ No newline at end of file diff --git a/feature-analyser-extension/src/main/resources/META-INF/services/org.apache.sling.feature.launcher.spi.Launcher b/feature-analyser-extension/src/main/resources/META-INF/services/org.apache.sling.feature.launcher.spi.Launcher new file mode 100644 index 000000000..31a14002d --- /dev/null +++ b/feature-analyser-extension/src/main/resources/META-INF/services/org.apache.sling.feature.launcher.spi.Launcher @@ -0,0 +1 @@ +org.apache.sling.feature.extension.analyser.AnalyserLauncher \ No newline at end of file diff --git a/feature-analyser-extension/src/test/java/org/apache/sling/feature/extension/analyser/AnalyserLauncherTest.java b/feature-analyser-extension/src/test/java/org/apache/sling/feature/extension/analyser/AnalyserLauncherTest.java new file mode 100644 index 000000000..47ca3bb27 --- /dev/null +++ b/feature-analyser-extension/src/test/java/org/apache/sling/feature/extension/analyser/AnalyserLauncherTest.java @@ -0,0 +1,121 @@ +/* + * 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.feature.extension.analyser; + +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.util.HashMap; +import java.util.Map; + +import org.apache.sling.feature.ArtifactId; +import org.apache.sling.feature.Feature; +import org.apache.sling.feature.MatchingRequirement; +import org.apache.sling.feature.launcher.spi.LauncherPrepareContext; +import org.junit.Rule; +import org.junit.Test; +import org.junit.contrib.java.lang.system.ExpectedSystemExit; +import org.mockito.Mockito; +import org.osgi.framework.Constants; +import org.osgi.resource.Capability; +import org.osgi.resource.Resource; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class AnalyserLauncherTest { + + @Rule + public final ExpectedSystemExit exit = ExpectedSystemExit.none(); + + @Test + public void testSuccessOnWarn() throws Exception { + + + AnalyserLauncher al = new AnalyserLauncher(); + LauncherPrepareContext context = Mockito.mock(LauncherPrepareContext.class); + Logger logger = spy(LoggerFactory.getLogger(AnalyserLauncher.class)); + when(context.getLogger()).thenReturn(logger); + Feature app = new Feature(ArtifactId.fromMvnId("a:b:1")); + + @SuppressWarnings("serial") + Map directives = new HashMap() {{ + put(Constants.RESOLUTION_DIRECTIVE, Constants.RESOLUTION_OPTIONAL); + }}; + addUnsatisfiedRequirement(directives, app); + + al.prepare(context, null, app); + al.run(null, null); + verify(logger).warn(any()); + } + + @Test + public void testSystemExitOnError() throws Exception { + + exit.expectSystemExitWithStatus(1); + AnalyserLauncher al = new AnalyserLauncher(); + LauncherPrepareContext context = Mockito.mock(LauncherPrepareContext.class); + Logger logger = spy(LoggerFactory.getLogger(AnalyserLauncher.class)); + when(context.getLogger()).thenReturn(logger); + Feature app = new Feature(ArtifactId.fromMvnId("a:b:1")); + + @SuppressWarnings("serial") + Map directives = new HashMap() {{ + put(Constants.RESOLUTION_DIRECTIVE, Constants.RESOLUTION_MANDATORY); + }}; + addUnsatisfiedRequirement(directives, app); + + al.prepare(context, null, app); + al.run(null, null); + verify(logger).error(any()); + } + + + private void addUnsatisfiedRequirement(Map directives, Feature app) { + MatchingRequirement req = new MatchingRequirement () { + + @Override + public Resource getResource() { + return null; + } + + @Override + public String getNamespace() { + return null; + } + + @Override + public Map getDirectives() { + return directives; + } + + @Override + public Map getAttributes() { + return null; + } + + @Override + public boolean matches(Capability cap) { + return false; + } + }; + + app.getRequirements().add(req); + } + +}