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 2019/08/20 18:33:28 UTC

[sling-org-apache-sling-feature-analyser] branch master updated: SLING-8645 : Deprecate bundle start level

This is an automated email from the ASF dual-hosted git repository.

cziegeler pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature-analyser.git


The following commit(s) were added to refs/heads/master by this push:
     new 7c6e91e  SLING-8645 : Deprecate bundle start level
7c6e91e is described below

commit 7c6e91ecb5d68c9a48ed997f2071fd0fc964c16e
Author: Carsten Ziegeler <cz...@apache.org>
AuthorDate: Tue Aug 20 11:33:19 2019 -0700

    SLING-8645 : Deprecate bundle start level
---
 .../task/impl/CheckBundleExportsImports.java       | 26 +++++++------
 .../task/impl/CheckRequirementsCapabilities.java   | 16 ++++----
 .../sling/feature/scanner/BundleDescriptor.java    |  3 ++
 .../impl/AbstractApiRegionsAnalyserTaskTest.java   | 29 +++++++-------
 .../scanner/impl/ContentPackageScannerTest.java    | 45 ++++++++--------------
 5 files changed, 55 insertions(+), 64 deletions(-)

diff --git a/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckBundleExportsImports.java b/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckBundleExportsImports.java
index f4de6e4..4bb72bd 100644
--- a/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckBundleExportsImports.java
+++ b/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckBundleExportsImports.java
@@ -18,14 +18,6 @@
  */
 package org.apache.sling.feature.analyser.task.impl;
 
-import org.apache.sling.feature.Extension;
-import org.apache.sling.feature.Feature;
-import org.apache.sling.feature.analyser.task.AnalyserTask;
-import org.apache.sling.feature.analyser.task.AnalyserTaskContext;
-import org.apache.sling.feature.scanner.BundleDescriptor;
-import org.apache.sling.feature.scanner.PackageInfo;
-import org.osgi.framework.Version;
-
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
@@ -45,6 +37,14 @@ import java.util.SortedMap;
 import java.util.TreeMap;
 import java.util.stream.Collectors;
 
+import org.apache.sling.feature.Extension;
+import org.apache.sling.feature.Feature;
+import org.apache.sling.feature.analyser.task.AnalyserTask;
+import org.apache.sling.feature.analyser.task.AnalyserTaskContext;
+import org.apache.sling.feature.scanner.BundleDescriptor;
+import org.apache.sling.feature.scanner.PackageInfo;
+import org.osgi.framework.Version;
+
 public class CheckBundleExportsImports implements AnalyserTask {
     private static final String FILE_STORAGE_CONFIG_KEY = "fileStorage";
     private static final String IGNORE_API_REGIONS_CONFIG_KEY = "ignoreAPIRegions";
@@ -129,10 +129,10 @@ public class CheckBundleExportsImports implements AnalyserTask {
 
         final SortedMap<Integer, List<BundleDescriptor>> bundlesMap = new TreeMap<>();
         for(final BundleDescriptor bi : ctx.getFeatureDescriptor().getBundleDescriptors()) {
-            List<BundleDescriptor> list = bundlesMap.get(bi.getBundleStartLevel());
+            List<BundleDescriptor> list = bundlesMap.get(bi.getArtifact().getStartOrder());
             if ( list == null ) {
                 list = new ArrayList<>();
-                bundlesMap.put(bi.getBundleStartLevel(), list);
+                bundlesMap.put(bi.getArtifact().getStartOrder(), list);
             }
             list.add(bi);
         }
@@ -248,12 +248,14 @@ public class CheckBundleExportsImports implements AnalyserTask {
 
             if ( !entry.getValue().missingExports.isEmpty() ) {
                 ctx.reportError(key + " is importing package(s) " + getPackageInfo(entry.getValue().missingExports, false) + " in start level " +
-                        String.valueOf(entry.getKey().getBundleStartLevel()) + " but no bundle is exporting these for that start level.");
+                        String.valueOf(entry.getKey().getArtifact().getStartOrder())
+                        + " but no bundle is exporting these for that start level.");
                 errorReported = true;
             }
             if ( !entry.getValue().missingExportsWithVersion.isEmpty() ) {
                 StringBuilder message = new StringBuilder(key + " is importing package(s) " + getPackageInfo(entry.getValue().missingExportsWithVersion, true) + " in start level " +
-                        String.valueOf(entry.getKey().getBundleStartLevel()) + " but no visible bundle is exporting these for that start level in the required version range.");
+                        String.valueOf(entry.getKey().getArtifact().getStartOrder())
+                        + " but no visible bundle is exporting these for that start level in the required version range.");
 
                 for (Map.Entry<PackageInfo, Map.Entry<Set<String>, Set<String>>> regionInfoEntry : entry.getValue().regionInfo.entrySet()) {
                     PackageInfo pkg = regionInfoEntry.getKey();
diff --git a/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckRequirementsCapabilities.java b/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckRequirementsCapabilities.java
index 369c624..a6821b1 100644
--- a/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckRequirementsCapabilities.java
+++ b/src/main/java/org/apache/sling/feature/analyser/task/impl/CheckRequirementsCapabilities.java
@@ -16,6 +16,13 @@
  */
 package org.apache.sling.feature.analyser.task.impl;
 
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.SortedMap;
+import java.util.TreeMap;
+import java.util.stream.Collectors;
+
 import org.apache.felix.utils.resource.CapabilitySet;
 import org.apache.felix.utils.resource.RequirementImpl;
 import org.apache.sling.feature.analyser.task.AnalyserTask;
@@ -26,13 +33,6 @@ import org.osgi.framework.wiring.BundleRevision;
 import org.osgi.namespace.service.ServiceNamespace;
 import org.osgi.resource.Requirement;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
-import java.util.SortedMap;
-import java.util.TreeMap;
-import java.util.stream.Collectors;
-
 public class CheckRequirementsCapabilities implements AnalyserTask {
     private final String format = "Artifact %s requires %s in start level %d but %s";
 
@@ -50,7 +50,7 @@ public class CheckRequirementsCapabilities implements AnalyserTask {
     public void execute(AnalyserTaskContext ctx) throws Exception {
         final SortedMap<Integer, List<Descriptor>> artifactsMap = new TreeMap<>();
         for(final BundleDescriptor bi : ctx.getFeatureDescriptor().getBundleDescriptors()) {
-            List<Descriptor> list = getDescriptorList(bi.getBundleStartLevel(), artifactsMap);
+            List<Descriptor> list = getDescriptorList(bi.getArtifact().getStartOrder(), artifactsMap);
             list.add(bi);
         }
 
diff --git a/src/main/java/org/apache/sling/feature/scanner/BundleDescriptor.java b/src/main/java/org/apache/sling/feature/scanner/BundleDescriptor.java
index 8e98bbb..2c20a94 100644
--- a/src/main/java/org/apache/sling/feature/scanner/BundleDescriptor.java
+++ b/src/main/java/org/apache/sling/feature/scanner/BundleDescriptor.java
@@ -48,8 +48,11 @@ public abstract class BundleDescriptor extends ArtifactDescriptor implements Com
 
     /**
      * Get the start level
+     * 
      * @return The start level.
+     * @deprecated Use start order of the bundle
      */
+    @Deprecated
     public abstract int getBundleStartLevel();
 
     /**
diff --git a/src/test/java/org/apache/sling/feature/analyser/task/impl/AbstractApiRegionsAnalyserTaskTest.java b/src/test/java/org/apache/sling/feature/analyser/task/impl/AbstractApiRegionsAnalyserTaskTest.java
index cad154f..b67fcb8 100644
--- a/src/test/java/org/apache/sling/feature/analyser/task/impl/AbstractApiRegionsAnalyserTaskTest.java
+++ b/src/test/java/org/apache/sling/feature/analyser/task/impl/AbstractApiRegionsAnalyserTaskTest.java
@@ -16,6 +16,20 @@
  */
 package org.apache.sling.feature.analyser.task.impl;
 
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.net.URL;
+import java.util.Collections;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+import java.util.jar.Manifest;
+
 import org.apache.sling.feature.Artifact;
 import org.apache.sling.feature.ArtifactId;
 import org.apache.sling.feature.Extension;
@@ -34,21 +48,6 @@ import org.mockito.Mockito;
 import org.mockito.invocation.InvocationOnMock;
 import org.mockito.stubbing.Answer;
 
-import java.io.File;
-import java.net.URL;
-import java.util.Collections;
-import java.util.LinkedList;
-import java.util.List;
-import java.util.Map;
-import java.util.jar.Manifest;
-
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertTrue;
-import static org.mockito.ArgumentMatchers.anyString;
-import static org.mockito.Mockito.doAnswer;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
-
 public abstract class AbstractApiRegionsAnalyserTaskTest<T extends AbstractApiRegionsAnalyserTask> {
 
     protected abstract T newTask();
diff --git a/src/test/java/org/apache/sling/feature/scanner/impl/ContentPackageScannerTest.java b/src/test/java/org/apache/sling/feature/scanner/impl/ContentPackageScannerTest.java
index fdf23ca..0ef2ae0 100644
--- a/src/test/java/org/apache/sling/feature/scanner/impl/ContentPackageScannerTest.java
+++ b/src/test/java/org/apache/sling/feature/scanner/impl/ContentPackageScannerTest.java
@@ -17,17 +17,14 @@
 package org.apache.sling.feature.scanner.impl;
 
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
 
 import java.io.File;
 import java.io.IOException;
 import java.net.URISyntaxException;
 import java.util.Dictionary;
-import java.util.Enumeration;
 import java.util.Set;
-import java.util.zip.ZipEntry;
-import java.util.zip.ZipFile;
 
 import org.apache.sling.feature.Artifact;
 import org.apache.sling.feature.ArtifactId;
@@ -37,36 +34,36 @@ import org.junit.Before;
 import org.junit.Test;
 
 public class ContentPackageScannerTest {
-    
+
     private static final String COORDINATES_TEST_PACKAGE_A_10 = "my_packages:test_a:1.0";
     private static ArtifactId TEST_PACKAGE_AID_A_10 = ArtifactId.fromMvnId(COORDINATES_TEST_PACKAGE_A_10);
 
     private File file;
-    
+
     private Artifact artifact;
-    
+
     ContentPackageDescriptor test_descriptor;
-    
+
     @Before
     public void setUp() throws Exception {
         file = getTestFile("/test-content.zip");
-        
+
         artifact = new Artifact(TEST_PACKAGE_AID_A_10);
-        
+
         test_descriptor = new ContentPackageDescriptor(file.getName());
         test_descriptor.setName("test-content");
         test_descriptor.setArtifact(artifact);
         test_descriptor.setArtifactFile(file.toURI().toURL());
     }
-    
+
     @Test
     public void testScan() throws URISyntaxException, IOException {
         ContentPackageScanner scanner = new ContentPackageScanner();
-        Set<ContentPackageDescriptor> descriptors = scanner.scan(artifact, file.toURI().toURL()); 
+        Set<ContentPackageDescriptor> descriptors = scanner.scan(artifact, file.toURI().toURL());
         for(ContentPackageDescriptor desc : descriptors) {
             String name = desc.getName();
             assertNotNull(name);
-            
+
             if(name.equals(test_descriptor.getName())) {
                 assetDescriptor(desc, desc.getName());
             } else {
@@ -74,39 +71,29 @@ public class ContentPackageScannerTest {
             }
         }
     }
-    
+
     private File getTestFile(String path) throws URISyntaxException {
         return new File(getClass().getResource(path).toURI());
     }
-    
+
     private void assetDescriptor(ContentPackageDescriptor desc, String descName) {
         assertEquals(descName, test_descriptor.getName());
         assertEquals(desc.getArtifact().getId().getArtifactId(), test_descriptor.getArtifact().getId().getArtifactId());
         assertEquals(desc.getArtifactFile().toString(), test_descriptor.getArtifactFile().toString());
-        
+
         assertTrue(desc.bundles != null && !desc.bundles.isEmpty());
         BundleDescriptor bundles[] = desc.bundles.toArray(new BundleDescriptor[desc.bundles.size()]);
-        
+
         assertEquals(bundles[0].getArtifact().getId().toString(), "org.apache.felix:org.apache.felix.framework:jar:bundle:6.0.1");
-        
+
         assertTrue(desc.configs != null && !desc.configs.isEmpty());
         Configuration configs[] = desc.configs.toArray(new Configuration[desc.configs.size()]);
         assertConfiguration(configs[0]);
     }
-    
+
     private void assertConfiguration(Configuration c) {
         Dictionary<String, Object> props = c.getProperties();
         String contentPath = (String) props.get(":configurator:feature:content-path");
         assertEquals(contentPath, "/libs/config/com.example.some.Component.xml");
     }
-    
-    private void printPackageEntries(File archive) throws IOException {
-        ZipFile zip = new ZipFile(archive);
-        Enumeration<? extends ZipEntry> entries = zip.entries();
-        System.out.println("ZIP Archive: " + zip.getName());
-        while(entries.hasMoreElements()) 
-            System.out.println("    " + entries.nextElement().getName());
-        System.out.println();
-    }
-    
 }