You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2017/05/30 13:42:21 UTC

svn commit: r1796865 - in /sling/whiteboard/cziegeler/feature/src: main/java/org/apache/sling/feature/json/ main/java/org/apache/sling/feature/process/ test/java/org/apache/sling/feature/json/

Author: cziegeler
Date: Tue May 30 13:42:21 2017
New Revision: 1796865

URL: http://svn.apache.org/viewvc?rev=1796865&view=rev
Log:
Start implementing extensions

Added:
    sling/whiteboard/cziegeler/feature/src/test/java/org/apache/sling/feature/json/FeatureJSONWriterTest.java   (with props)
Modified:
    sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/FeatureJSONWriter.java
    sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/process/FeatureBuilder.java

Modified: sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/FeatureJSONWriter.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/FeatureJSONWriter.java?rev=1796865&r1=1796864&r2=1796865&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/FeatureJSONWriter.java (original)
+++ sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/FeatureJSONWriter.java Tue May 30 13:42:21 2017
@@ -60,8 +60,7 @@ public class FeatureJSONWriter {
 
         // includes
         if ( !feature.getIncludes().isEmpty() ) {
-            w.write(JSONConstants.FEATURE_INCLUDES);
-            w.writeStartArray();
+            w.writeStartArray(JSONConstants.FEATURE_INCLUDES);
 
             for(final Include inc : feature.getIncludes()) {
                 if ( inc.getArtifactExtensionRemovals().isEmpty()
@@ -72,18 +71,15 @@ public class FeatureJSONWriter {
                 } else {
                     w.writeStartObject();
                     w.write(JSONConstants.ARTIFACT_ID, inc.getId().toMvnId());
-                    w.write(JSONConstants.INCLUDE_REMOVALS);
-                    w.writeStartObject();
+                    w.writeStartObject(JSONConstants.INCLUDE_REMOVALS);
                     if ( !inc.getArtifactExtensionRemovals().isEmpty()
                          || inc.getExtensionRemovals().isEmpty() ) {
-                        w.write(JSONConstants.INCLUDE_EXTENSION_REMOVALS);
-                        w.writeStartArray();
+                        w.writeStartArray(JSONConstants.INCLUDE_EXTENSION_REMOVALS);
                         for(final String id : inc.getExtensionRemovals()) {
                             w.write(id);
                         }
                         for(final Map.Entry<String, List<ArtifactId>> entry : inc.getArtifactExtensionRemovals().entrySet()) {
-                            w.write(entry.getKey());
-                            w.writeStartObject();
+                            w.writeStartObject(entry.getKey());
                             w.writeStartArray();
                             for(final ArtifactId id : entry.getValue()) {
                                 w.write(id.toMvnId());
@@ -94,24 +90,21 @@ public class FeatureJSONWriter {
                         w.writeEnd();
                     }
                     if ( !inc.getConfigurationRemovals().isEmpty() ) {
-                        w.write(JSONConstants.FEATURE_CONFIGURATIONS);
-                        w.writeStartArray();
+                        w.writeStartArray(JSONConstants.FEATURE_CONFIGURATIONS);
                         for(final String val : inc.getConfigurationRemovals()) {
                             w.write(val);
                         }
                         w.writeEnd();
                     }
                     if ( !inc.getBundleRemovals().isEmpty() ) {
-                        w.write(JSONConstants.FEATURE_BUNDLES);
-                        w.writeStartArray();
+                        w.writeStartArray(JSONConstants.FEATURE_BUNDLES);
                         for(final ArtifactId val : inc.getBundleRemovals()) {
                             w.write(val.toMvnId());
                         }
                         w.writeEnd();
                     }
                     if ( !inc.getFrameworkPropertiesRemovals().isEmpty() ) {
-                        w.write(JSONConstants.FEATURE_FRAMEWORK_PROPERTIES);
-                        w.writeStartArray();
+                        w.writeStartArray(JSONConstants.FEATURE_FRAMEWORK_PROPERTIES);
                         for(final String val : inc.getFrameworkPropertiesRemovals()) {
                             w.write(val);
                         }
@@ -126,23 +119,20 @@ public class FeatureJSONWriter {
 
         // requirements
         if ( !feature.getRequirements().isEmpty() ) {
-            w.write(JSONConstants.FEATURE_REQUIREMENTS);
-            w.writeStartArray();
+            w.writeStartArray(JSONConstants.FEATURE_REQUIREMENTS);
 
             for(final Requirement req : feature.getRequirements()) {
                 w.writeStartObject();
                 w.write(JSONConstants.REQCAP_NAMESPACE, req.getNamespace());
                 if ( !req.getAttributes().isEmpty() ) {
-                    w.write(JSONConstants.REQCAP_ATTRIBUTES);
-                    w.writeStartObject();
+                    w.writeStartObject(JSONConstants.REQCAP_ATTRIBUTES);
                     for(final Map.Entry<String, String> entry : req.getAttributes()) {
                         w.write(entry.getKey(), entry.getValue());
                     }
                     w.writeEnd();
                 }
                 if ( !req.getDirectives().isEmpty() ) {
-                    w.write(JSONConstants.REQCAP_DIRECTIVES);
-                    w.writeStartObject();
+                    w.writeStartObject(JSONConstants.REQCAP_DIRECTIVES);
                     for(final Map.Entry<String, String> entry : req.getDirectives()) {
                         w.write(entry.getKey(), entry.getValue());
                     }
@@ -155,23 +145,20 @@ public class FeatureJSONWriter {
 
         // capabilities
         if ( !feature.getCapabilities().isEmpty() ) {
-            w.write(JSONConstants.FEATURE_CAPABILITIES);
-            w.writeStartArray();
+            w.writeStartArray(JSONConstants.FEATURE_CAPABILITIES);
 
             for(final Capability cap : feature.getCapabilities()) {
                 w.writeStartObject();
                 w.write(JSONConstants.REQCAP_NAMESPACE, cap.getNamespace());
                 if ( !cap.getAttributes().isEmpty() ) {
-                    w.write(JSONConstants.REQCAP_ATTRIBUTES);
-                    w.writeStartObject();
+                    w.writeStartObject(JSONConstants.REQCAP_ATTRIBUTES);
                     for(final Map.Entry<String, String> entry : cap.getAttributes()) {
                         w.write(entry.getKey(), entry.getValue());
                     }
                     w.writeEnd();
                 }
                 if ( !cap.getDirectives().isEmpty() ) {
-                    w.write(JSONConstants.REQCAP_DIRECTIVES);
-                    w.writeStartObject();
+                    w.writeStartObject(JSONConstants.REQCAP_DIRECTIVES);
                     for(final Map.Entry<String, String> entry : cap.getDirectives()) {
                         w.write(entry.getKey(), entry.getValue());
                     }
@@ -184,11 +171,9 @@ public class FeatureJSONWriter {
 
         // bundles
         if ( !feature.getBundles().getBundlesByStartLevel().isEmpty() ) {
-            w.write(JSONConstants.FEATURE_BUNDLES);
-            w.writeStartObject();
+            w.writeStartObject(JSONConstants.FEATURE_BUNDLES);
             for(final Map.Entry<Integer, List<Artifact>> entry : feature.getBundles().getBundlesByStartLevel().entrySet()) {
-                w.write(String.valueOf(entry.getKey()));
-                w.writeStartArray();
+                w.writeStartArray(String.valueOf(entry.getKey()));
 
                 for(final Artifact artifact : entry.getValue()) {
                     final List<Configuration> cfgs = new ArrayList<>();
@@ -230,8 +215,7 @@ public class FeatureJSONWriter {
 
         // framework properties
         if ( !feature.getFrameworkProperties().isEmpty() ) {
-            w.write(JSONConstants.FEATURE_FRAMEWORK_PROPERTIES);
-            w.writeStartObject();
+            w.writeStartObject(JSONConstants.FEATURE_FRAMEWORK_PROPERTIES);
 
             for(final Map.Entry<String, String> entry : feature.getFrameworkProperties()) {
                 w.write(entry.getKey(), entry.getValue());
@@ -251,8 +235,7 @@ public class FeatureJSONWriter {
             } else if ( ext.getType() == ExtensionType.TEXT ) {
                 w.write(key, ext.getText());
             } else {
-                w.write(key);
-                w.writeStartArray();
+                w.writeStartArray(key);
                 for(final Artifact artifact : ext.getArtifacts()) {
                     final List<Configuration> artifactCfgs = new ArrayList<>();
                     for(final Configuration cfg : feature.getConfigurations()) {
@@ -290,8 +273,7 @@ public class FeatureJSONWriter {
      */
     private static void writeConfigurations(final JsonGenerator w, final List<Configuration> cfgs) {
         if ( !cfgs.isEmpty() ) {
-            w.write(JSONConstants.FEATURE_CONFIGURATIONS);
-            w.writeStartObject();
+            w.writeStartObject(JSONConstants.FEATURE_CONFIGURATIONS);
             for(final Configuration cfg : cfgs) {
                 final String key;
                 if ( cfg.isFactoryConfiguration() ) {
@@ -299,8 +281,7 @@ public class FeatureJSONWriter {
                 } else {
                     key = cfg.getPid();
                 }
-                w.write(key);
-                w.writeStartObject();
+                w.writeStartObject(key);
 
                 final Enumeration<String> e = cfg.getProperties().keys();
                 while ( e.hasMoreElements() ) {

Modified: sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/process/FeatureBuilder.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/process/FeatureBuilder.java?rev=1796865&r1=1796864&r2=1796865&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/process/FeatureBuilder.java (original)
+++ sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/process/FeatureBuilder.java Tue May 30 13:42:21 2017
@@ -17,6 +17,7 @@
 package org.apache.sling.feature.process;
 
 import java.io.StringReader;
+import java.util.ArrayList;
 import java.util.Enumeration;
 import java.util.Iterator;
 import java.util.List;
@@ -49,9 +50,19 @@ public class FeatureBuilder {
      * @throws IllegalStateException If an included feature can't be provided
      */
     public static Feature assemble(final Feature feature, final FeatureProvider provider) {
+        return internalAssemble(new ArrayList<>(), feature, provider);
+    }
+
+    private static Feature internalAssemble(final List<String> processedFeatures,
+            final Feature feature,
+            final FeatureProvider provider) {
         if ( feature == null || provider == null ) {
             throw new IllegalArgumentException("Feature and/or provider must not be null");
         }
+        if ( processedFeatures.contains(feature.getId().toMvnId()) ) {
+            throw new IllegalStateException("Recursive inclusion of " + feature.getId().toMvnId() + " via " + processedFeatures);
+        }
+        processedFeatures.add(feature.getId().toMvnId());
         Feature result = feature;
 
         if ( !feature.getIncludes().isEmpty() ) {
@@ -63,8 +74,7 @@ public class FeatureBuilder {
                 if ( f == null ) {
                     throw new IllegalStateException("Unable to find included feature " + i.getId());
                 }
-                // TODO add recursion detection
-                final Feature af = assemble(feature, provider);
+                final Feature af = internalAssemble(processedFeatures, feature, provider);
 
                 // process removals
                 // bundles
@@ -152,6 +162,8 @@ public class FeatureBuilder {
             }
             merge(result, feature);
         }
+        processedFeatures.remove(feature.getId().toMvnId());
+
         return result;
     }
 

Added: sling/whiteboard/cziegeler/feature/src/test/java/org/apache/sling/feature/json/FeatureJSONWriterTest.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature/src/test/java/org/apache/sling/feature/json/FeatureJSONWriterTest.java?rev=1796865&view=auto
==============================================================================
--- sling/whiteboard/cziegeler/feature/src/test/java/org/apache/sling/feature/json/FeatureJSONWriterTest.java (added)
+++ sling/whiteboard/cziegeler/feature/src/test/java/org/apache/sling/feature/json/FeatureJSONWriterTest.java Tue May 30 13:42:21 2017
@@ -0,0 +1,41 @@
+/*
+ * 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.json;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.StringReader;
+import java.io.StringWriter;
+
+import org.apache.sling.feature.Feature;
+import org.junit.Test;
+
+public class FeatureJSONWriterTest {
+
+    @Test public void testRead() throws Exception {
+        final Feature feature = U.readFeature("test");
+        final Feature readFeature;
+        try ( final StringWriter writer = new StringWriter() ) {
+            FeatureJSONWriter.write(writer, feature);
+            try ( final StringReader reader = new StringReader(writer.toString()) ) {
+                readFeature = FeatureJSONReader.read(reader, null);
+            }
+        }
+        assertEquals(feature.getId(), readFeature.getId());
+    }
+
+}

Propchange: sling/whiteboard/cziegeler/feature/src/test/java/org/apache/sling/feature/json/FeatureJSONWriterTest.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: sling/whiteboard/cziegeler/feature/src/test/java/org/apache/sling/feature/json/FeatureJSONWriterTest.java
------------------------------------------------------------------------------
    svn:keywords = author date id revision rev url