You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by si...@apache.org on 2019/06/27 21:50:07 UTC
[sling-org-apache-sling-feature-r2f] branch master created (now
c5f12fa)
This is an automated email from the ASF dual-hosted git repository.
simonetripodi pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature-r2f.git.
at c5f12fa initial import, moved from sling-whiteboard
This branch includes the following new commits:
new c5f12fa initial import, moved from sling-whiteboard
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[sling-org-apache-sling-feature-r2f] 01/01: initial import,
moved from sling-whiteboard
Posted by si...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
simonetripodi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature-r2f.git
commit c5f12fab3bb946a332f259ea7a80ccdbf25b4cc1
Author: Simo Tripodi <st...@adobe.com>
AuthorDate: Thu Jun 27 23:49:57 2019 +0200
initial import, moved from sling-whiteboard
---
.gitignore | 17 ++
CODE_OF_CONDUCT.md | 22 +++
CONTRIBUTING.md | 24 +++
Jenkinsfile | 20 ++
LICENSE | 201 +++++++++++++++++++++
README.md | 66 +++++++
pom.xml | 106 +++++++++++
.../r2f/RuntimeEnvironment2FeatureModel.java | 31 ++++
.../r2f/impl/AbstractFeatureElementConsumer.java | 35 ++++
.../feature/r2f/impl/Bundle2ArtifactMapper.java | 127 +++++++++++++
...GiConfiguration2FeatureConfigurationMapper.java | 55 ++++++
.../RuntimeEnvironment2FeatureModelService.java | 181 +++++++++++++++++++
.../org/apache/sling/feature/r2f/package-info.java | 19 ++
13 files changed, 904 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..5b783ed
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,17 @@
+/target
+.idea
+.classpath
+.metadata
+.project
+.settings
+.externalToolBuilders
+maven-eclipse.xml
+*.swp
+*.iml
+*.ipr
+*.iws
+*.bak
+.vlt
+.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/Jenkinsfile b/Jenkinsfile
new file mode 100644
index 0000000..f582519
--- /dev/null
+++ b/Jenkinsfile
@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+
+slingOsgiBundleBuild()
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..261eeb9
--- /dev/null
+++ b/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/README.md b/README.md
new file mode 100644
index 0000000..9568bef
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+[<img src="http://sling.apache.org/res/logos/sling.png"/>](http://sling.apache.org)
+
+# Apache Sling OSGi runtime environment to Feature Model generator
+
+## Running Feature
+
+This is a simple OSGi service which is able to convert, given a `BundleContext` instance, a currently running OSGi container to an Apache Sling Feature Model definition.
+
+APIs are really simple: it is necessary first to obtain the `RuntimeEnvironment2FeatureModel` instance from the OSGi Service Registry, then
+
+```java
+import org.apache.sling.feature.r2f.*;
+
+@Reference
+RuntimeEnvironment2FeatureModel generator;
+
+...
+Feature runtimeFeature = generator.getRunningFeature();
+```
+
+## Please Note
+
+Currently version will include in the generated Feature Model `bundles` and `configurations` only, which are the only informations that can be extracted from a `BundleContext` instance.
+
+## Launch Feature
+
+The `RuntimeEnvironment2FeatureModel` OSGi service is also able to retrieve the (assembled) Feature used to launch the platform:
+
+```java
+import org.apache.sling.feature.r2f.*;
+
+@Reference
+RuntimeEnvironment2FeatureModel generator;
+
+...
+Feature launchFeature = generator.getLaunchFeature();
+```
+
+## Upgrade Feature
+
+The `RuntimeEnvironment2FeatureModel` OSGi service is also able to compute the upgrade Feature which prototypes from the Feature used to launch the platform and that targets the runtime Feature:
+
+```java
+import org.apache.sling.feature.r2f.*;
+
+@Reference
+RuntimeEnvironment2FeatureModel generator;
+
+...
+Feature launchFeature = generator.getLaunch2RuntimeUpgradingFeature();
+```
+
+## The effective Runtime Feature
+
+Finally, the `RuntimeEnvironment2FeatureModel` OSGi service is also able to compute the real runtime Feature which is assembled from the Feature used to launch the platform and that targets the runtime Feature:
+
+```java
+import org.apache.sling.feature.r2f.*;
+
+@Reference
+RuntimeEnvironment2FeatureModel generator;
+
+...
+Feature launchFeature = generator.getLaunch2RuntimeUpgradingFeature();
+```
+
diff --git a/pom.xml b/pom.xml
new file mode 100644
index 0000000..e363ba8
--- /dev/null
+++ b/pom.xml
@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ 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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>sling-bundle-parent</artifactId>
+ <version>35</version>
+ <relativePath />
+ </parent>
+
+ <artifactId>org.apache.sling.feature.r2f</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+
+ <name>Apache Sling Feature Model runtime creator</name>
+ <description>Feature Model runtime creator tool for Apache Sling</description>
+
+ <properties>
+ <sling.java.version>8</sling.java.version>
+ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+ <bnd.baseline.skip>true</bnd.baseline.skip>
+ </properties>
+
+ <scm>
+ <connection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature-r2f.git</connection>
+ <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature-r2f.git</developerConnection>
+ <url>https://gitbox.apache.org/repos/asf?p=sling-org-apache-sling-feature-r2f.git</url>
+ <tag>HEAD</tag>
+ </scm>
+
+ <dependencies>
+ <!--
+ | core OSGi APIs
+ -->
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>osgi.core</artifactId>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.compendium</artifactId>
+ <version>5.0.0</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.annotation.versioning</artifactId>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.service.component.annotations</artifactId>
+ <scope>provided</scope>
+ </dependency>
+
+ <!--
+ | Apache Sling Feature APIs
+ -->
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.feature</artifactId>
+ <version>1.0.4</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.feature.io</artifactId>
+ <version>1.0.4</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.feature.diff</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ </dependency>
+
+ <!--
+ | Test only dependencies
+ -->
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+
+</project>
diff --git a/src/main/java/org/apache/sling/feature/r2f/RuntimeEnvironment2FeatureModel.java b/src/main/java/org/apache/sling/feature/r2f/RuntimeEnvironment2FeatureModel.java
new file mode 100644
index 0000000..9c52006
--- /dev/null
+++ b/src/main/java/org/apache/sling/feature/r2f/RuntimeEnvironment2FeatureModel.java
@@ -0,0 +1,31 @@
+/*
+ * 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.r2f;
+
+import org.apache.sling.feature.Feature;
+
+public interface RuntimeEnvironment2FeatureModel {
+
+ Feature getLaunchFeature();
+
+ Feature getRunningFeature();
+
+ Feature getLaunch2RunningUpgradingFeature();
+
+ Feature getRuntimeFeature();
+
+}
diff --git a/src/main/java/org/apache/sling/feature/r2f/impl/AbstractFeatureElementConsumer.java b/src/main/java/org/apache/sling/feature/r2f/impl/AbstractFeatureElementConsumer.java
new file mode 100644
index 0000000..f557a8b
--- /dev/null
+++ b/src/main/java/org/apache/sling/feature/r2f/impl/AbstractFeatureElementConsumer.java
@@ -0,0 +1,35 @@
+/*
+ * 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.r2f.impl;
+
+import java.util.function.Consumer;
+
+import org.apache.sling.feature.Feature;
+
+abstract class AbstractFeatureElementConsumer<T> implements Consumer<T> {
+
+ private final Feature targetFeature;
+
+ public AbstractFeatureElementConsumer(Feature targetFeature) {
+ this.targetFeature = targetFeature;
+ }
+
+ protected final Feature getTargetFeature() {
+ return targetFeature;
+ }
+
+}
diff --git a/src/main/java/org/apache/sling/feature/r2f/impl/Bundle2ArtifactMapper.java b/src/main/java/org/apache/sling/feature/r2f/impl/Bundle2ArtifactMapper.java
new file mode 100644
index 0000000..26f31ed
--- /dev/null
+++ b/src/main/java/org/apache/sling/feature/r2f/impl/Bundle2ArtifactMapper.java
@@ -0,0 +1,127 @@
+/*
+ * 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.r2f.impl;
+
+import static org.osgi.framework.wiring.BundleWiring.LISTRESOURCES_RECURSE;
+
+import java.io.InputStream;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.net.URLConnection;
+import java.util.Collection;
+import java.util.Properties;
+import java.util.function.Function;
+
+import org.apache.sling.feature.Artifact;
+import org.apache.sling.feature.ArtifactId;
+import org.apache.sling.feature.Feature;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.startlevel.BundleStartLevel;
+import org.osgi.framework.wiring.BundleWiring;
+
+final class Bundle2ArtifactMapper extends AbstractFeatureElementConsumer<Artifact> implements Function<Bundle, Artifact> {
+
+ private static final String MAVEN_METADATA_PATH = "/META-INF/maven";
+
+ private static final String POM_PROPERTIES_RESOURCE_NAME = "pom.properties";
+
+ private static final String GROUP_ID = "groupId";
+
+ private static final String ARTIFACT_ID = "artifactId";
+
+ private static final String VERSION = "version";
+
+ private static final String CLASSIFIER = "classifier";
+
+ public Bundle2ArtifactMapper(Feature targetFeature) {
+ super(targetFeature);
+ }
+
+ @Override
+ public Artifact apply(Bundle bundle) {
+ Properties pomProperties = new Properties();
+
+ BundleWiring bundleWiring = bundle.adapt(BundleWiring.class);
+ Collection<String> pomPropertiesResources = bundleWiring.listResources(MAVEN_METADATA_PATH, POM_PROPERTIES_RESOURCE_NAME, LISTRESOURCES_RECURSE);
+
+ if (pomPropertiesResources == null || pomPropertiesResources.isEmpty()) {
+ return null;
+ }
+
+ URL pomPropertiesURL = getPomPropertiesURL(pomPropertiesResources, bundle);
+ if (pomPropertiesURL == null) {
+ return null;
+ }
+
+ try {
+ URLConnection connection = pomPropertiesURL.openConnection();
+ connection.connect();
+
+ try (InputStream inStream = connection.getInputStream()) {
+ pomProperties.load(inStream);
+ }
+
+ if (connection instanceof HttpURLConnection) {
+ ((HttpURLConnection) connection).disconnect();
+ }
+ } catch (Throwable t) {
+ throw new RuntimeException("An error occurred while reading "
+ + pomPropertiesURL
+ + " properties file from Bundle "
+ + bundle.getSymbolicName(), t);
+ }
+
+ if (pomProperties.isEmpty()) {
+ throw new RuntimeException("Bundle "
+ + bundle.getSymbolicName()
+ + " does not export valid Maven metadata");
+ }
+
+ String groupId = pomProperties.getProperty(GROUP_ID);
+ String artifactId = pomProperties.getProperty(ARTIFACT_ID);
+ String version = pomProperties.getProperty(VERSION);
+ String classifier = pomProperties.getProperty(CLASSIFIER);
+
+ Artifact artifact = new Artifact(new ArtifactId(groupId, artifactId, version, classifier, null));
+
+ BundleStartLevel bundleStartLevel = bundle.adapt(BundleStartLevel.class);
+ int startOrder = bundleStartLevel.getStartLevel();
+ artifact.setStartOrder(startOrder);
+
+ return artifact;
+ }
+
+ private static URL getPomPropertiesURL(Collection<String> pomPropertiesResources, Bundle bundle) {
+ for (String pomPropertiesResource : pomPropertiesResources) {
+ URL pomPropertiesURL = bundle.getEntry(pomPropertiesResource);
+
+ if (pomPropertiesURL != null) {
+ return pomPropertiesURL;
+ }
+ }
+
+ return null;
+ }
+
+ @Override
+ public void accept(Artifact artifact) {
+ if (artifact != null) {
+ getTargetFeature().getBundles().add(artifact);
+ }
+ }
+
+}
diff --git a/src/main/java/org/apache/sling/feature/r2f/impl/OSGiConfiguration2FeatureConfigurationMapper.java b/src/main/java/org/apache/sling/feature/r2f/impl/OSGiConfiguration2FeatureConfigurationMapper.java
new file mode 100644
index 0000000..afe8695
--- /dev/null
+++ b/src/main/java/org/apache/sling/feature/r2f/impl/OSGiConfiguration2FeatureConfigurationMapper.java
@@ -0,0 +1,55 @@
+/*
+ * 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.r2f.impl;
+
+import java.util.Dictionary;
+import java.util.Enumeration;
+import java.util.function.Function;
+
+import org.apache.sling.feature.Configuration;
+import org.apache.sling.feature.Feature;
+
+final class OSGiConfiguration2FeatureConfigurationMapper
+ extends AbstractFeatureElementConsumer<Configuration>
+ implements Function<org.osgi.service.cm.Configuration, Configuration> {
+
+ public OSGiConfiguration2FeatureConfigurationMapper(Feature targetFeature) {
+ super(targetFeature);
+ }
+
+ @Override
+ public Configuration apply(org.osgi.service.cm.Configuration sourceConfiguration) {
+ Configuration targetConfiguration = new Configuration(sourceConfiguration.getPid());
+
+ Dictionary<String, Object> configurationProperties = sourceConfiguration.getProperties();
+ Enumeration<String> keys = configurationProperties.keys();
+ while (keys.hasMoreElements()) {
+ String key = keys.nextElement();
+ Object value = configurationProperties.get(key);
+
+ targetConfiguration.getProperties().put(key, value);
+ }
+
+ return targetConfiguration;
+ }
+
+ @Override
+ public void accept(Configuration configuration) {
+ getTargetFeature().getConfigurations().add(configuration);
+ }
+
+}
diff --git a/src/main/java/org/apache/sling/feature/r2f/impl/RuntimeEnvironment2FeatureModelService.java b/src/main/java/org/apache/sling/feature/r2f/impl/RuntimeEnvironment2FeatureModelService.java
new file mode 100644
index 0000000..484aec1
--- /dev/null
+++ b/src/main/java/org/apache/sling/feature/r2f/impl/RuntimeEnvironment2FeatureModelService.java
@@ -0,0 +1,181 @@
+/*
+ * 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.r2f.impl;
+
+import static java.nio.file.Files.newBufferedReader;
+import static org.apache.sling.feature.builder.FeatureBuilder.assemble;
+import static org.apache.sling.feature.diff.FeatureDiff.compareFeatures;
+import static org.apache.sling.feature.io.json.FeatureJSONReader.read;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.net.URI;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.stream.Stream;
+
+import org.apache.sling.feature.ArtifactId;
+import org.apache.sling.feature.Feature;
+import org.apache.sling.feature.Prototype;
+import org.apache.sling.feature.builder.BuilderContext;
+import org.apache.sling.feature.builder.FeatureProvider;
+import org.apache.sling.feature.diff.DiffRequest;
+import org.apache.sling.feature.r2f.RuntimeEnvironment2FeatureModel;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.ServiceReference;
+import org.osgi.service.cm.Configuration;
+import org.osgi.service.cm.ConfigurationAdmin;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+
+@Component(service = RuntimeEnvironment2FeatureModel.class)
+public class RuntimeEnvironment2FeatureModelService implements RuntimeEnvironment2FeatureModel, FeatureProvider {
+
+ private static final String SLING_FEATURE_PROPERTY_NAME = "sling.feature";
+
+ private static final String RUNNING_CLASSIFIER = "running";
+
+ private static final String RUNTIME_CLASSIFIER = "runtime";
+
+ private static final String PACKAGING_FEATURE = "slingosgifeature";
+
+ protected BundleContext bundleContext;
+
+ private Feature launchFeature;
+
+ @Activate
+ public void start(BundleContext bundleContext) {
+ this.bundleContext = bundleContext;
+
+ String launchFeatureLocation = bundleContext.getProperty(SLING_FEATURE_PROPERTY_NAME);
+
+ if (launchFeatureLocation == null) {
+ throw new IllegalStateException("Framework property 'sling.feature' is not set, impossible to assemble the launch Feature");
+ }
+
+ URI launchFeatureURI = URI.create(launchFeatureLocation);
+ Path launchFeaturePath = Paths.get(launchFeatureURI);
+
+ try (BufferedReader reader = newBufferedReader(launchFeaturePath)) {
+ launchFeature = read(reader, launchFeatureLocation);
+ } catch (IOException cause) {
+ throw new UncheckedIOException(cause);
+ }
+ }
+
+ @Deactivate
+ public void stop() {
+ bundleContext = null;
+ launchFeature = null;
+ }
+
+ @Override
+ public Feature getLaunchFeature() {
+ return launchFeature;
+ }
+
+ @Override
+ public Feature getRunningFeature() {
+ Feature targetFeature = new Feature(newId(RUNNING_CLASSIFIER));
+
+ // collect all bundles
+
+ Bundle[] bundles = bundleContext.getBundles();
+ if (bundles != null) {
+ Bundle2ArtifactMapper mapper = new Bundle2ArtifactMapper(targetFeature);
+
+ Stream.of(bundles).map(mapper).forEach(mapper);
+ }
+
+ // collect all configurations
+
+ ServiceReference<ConfigurationAdmin> configurationAdminReference = bundleContext.getServiceReference(ConfigurationAdmin.class);
+ if (configurationAdminReference != null) {
+ ConfigurationAdmin configurationAdmin = bundleContext.getService(configurationAdminReference);
+
+ if (configurationAdmin != null) {
+ try {
+ Configuration[] configurations = configurationAdmin.listConfigurations(null);
+ if (configurations != null) {
+ OSGiConfiguration2FeatureConfigurationMapper mapper = new OSGiConfiguration2FeatureConfigurationMapper(targetFeature);
+
+ Stream.of(configurations).map(mapper).forEach(mapper);
+ }
+ } catch (Exception e) {
+ // that should not happen
+ throw new RuntimeException("Something went wrong while iterating over all available Configurations", e);
+ }
+ }
+ }
+
+ return targetFeature;
+ }
+
+ @Override
+ public Feature getLaunch2RunningUpgradingFeature() {
+ Feature runningFeature = getRunningFeature();
+
+ // framework-properties can not be scanned in the BundleContext ATM
+ // extensions can not be computed at runtime
+ return compareFeatures(new DiffRequest()
+ .setPrevious(launchFeature)
+ .setCurrent(runningFeature)
+ .addIncludeComparator("bundles")
+ .addIncludeComparator("configurations"));
+ }
+
+ @Override
+ public Feature getRuntimeFeature() {
+ Feature launch2RunningUpgradingFeature = getLaunch2RunningUpgradingFeature();
+ Prototype prototype = launch2RunningUpgradingFeature.getPrototype();
+
+ // if there are no differences, no need to assemble the new Feature, it is a vanilla Feature
+
+ if (launch2RunningUpgradingFeature.getBundles().isEmpty()
+ && launch2RunningUpgradingFeature.getConfigurations().isEmpty()
+ && prototype.getBundleRemovals().isEmpty()
+ && prototype.getConfigurationRemovals().isEmpty()) {
+ return launchFeature;
+ }
+
+ ArtifactId runtimeId = newId(RUNTIME_CLASSIFIER);
+
+ BuilderContext context = new BuilderContext(this);
+
+ return assemble(runtimeId, context, launch2RunningUpgradingFeature);
+ }
+
+ @Override
+ public Feature provide(ArtifactId id) {
+ if (launchFeature.getId().equals(id)) {
+ return launchFeature;
+ }
+ return null;
+ }
+
+ private ArtifactId newId(String classifier) {
+ String groupId = launchFeature.getId().getGroupId();
+ String artifactId = launchFeature.getId().getArtifactId();
+ String version = launchFeature.getId().getVersion();
+
+ return new ArtifactId(groupId, artifactId, version, classifier, PACKAGING_FEATURE);
+ }
+
+}
diff --git a/src/main/java/org/apache/sling/feature/r2f/package-info.java b/src/main/java/org/apache/sling/feature/r2f/package-info.java
new file mode 100644
index 0000000..151085c
--- /dev/null
+++ b/src/main/java/org/apache/sling/feature/r2f/package-info.java
@@ -0,0 +1,19 @@
+/*
+ * 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.
+ */
+
+@org.osgi.annotation.versioning.Version("1.0.0")
+package org.apache.sling.feature.r2f;