You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by tr...@apache.org on 2017/10/23 01:42:55 UTC
svn commit: r1812958 - in
/jackrabbit/commons/filevault-package-maven-plugin/trunk/src:
main/java/org/apache/jackrabbit/filevault/maven/packaging/
test/java/org/apache/jackrabbit/filevault/maven/packaging/it/
test/resources/test-projects/manifest-gener...
Author: tripod
Date: Mon Oct 23 01:42:55 2017
New Revision: 1812958
URL: http://svn.apache.org/viewvc?rev=1812958&view=rev
Log:
JCRVLT-214 auto-import package analyzer needs option to exclude compiletime bundles
Added:
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/expected-manifest.txt
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/jcr_root/
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/jcr_root/libs/
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/jcr_root/libs/apache/
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/jcr_root/libs/apache/IncludeUseObject.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/parent/
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/parent/pom.xml
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/pom.xml
Modified:
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AnalyzeClassesMojo.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ImportPackageBuilder.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/java/org/apache/jackrabbit/filevault/maven/packaging/it/ManifestGenerationIT.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/java/org/apache/jackrabbit/filevault/maven/packaging/it/ProjectBuilder.java
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AnalyzeClassesMojo.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AnalyzeClassesMojo.java?rev=1812958&r1=1812957&r2=1812958&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AnalyzeClassesMojo.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AnalyzeClassesMojo.java Mon Oct 23 01:42:55 2017
@@ -18,14 +18,18 @@ package org.apache.jackrabbit.filevault.
import java.io.File;
import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
import org.apache.commons.io.FileUtils;
+import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.apache.maven.shared.artifact.filter.PatternExcludesArtifactFilter;
import aQute.bnd.osgi.Processor;
@@ -63,13 +67,25 @@ public class AnalyzeClassesMojo extends
@Parameter(property = "vault.importUnusedPackages")
private boolean importUnusedPackages;
+ /**
+ * Defines a list of libraries in partial maven coordinates that are not used for analysis.
+ */
+ @Parameter(property = "vault.excludedLibraries")
+ private String[] excludedLibraries;
+
public void execute() throws MojoExecutionException, MojoFailureException {
try {
getLog().info("Analyzing java package dependencies.");
+ List<String> excluded = new ArrayList<String>(excludedLibraries.length);
+ for (String lib: excludedLibraries) {
+ excluded.add(lib.trim());
+ }
+
ImportPackageBuilder builder = new ImportPackageBuilder()
+ .withFilter(new PatternExcludesArtifactFilter(excluded))
.withDependenciesFromProject(project)
.withClassFileDirectory(sourceDirectory)
- .setIncludeUnused(importUnusedPackages)
+ .withIncludeUnused(importUnusedPackages)
.analyze();
String report = builder.createExportPackageReport();
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ImportPackageBuilder.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ImportPackageBuilder.java?rev=1812958&r1=1812957&r2=1812958&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ImportPackageBuilder.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ImportPackageBuilder.java Mon Oct 23 01:42:55 2017
@@ -38,6 +38,7 @@ import javax.annotation.Nonnull;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.DependencyResolutionRequiredException;
+import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.DirectoryScanner;
import org.codehaus.plexus.util.StringUtils;
@@ -110,6 +111,16 @@ public class ImportPackageBuilder {
private boolean includeUnused;
/**
+ * filter for project artifacts
+ */
+ private ArtifactFilter filter = new ArtifactFilter() {
+ @Override
+ public boolean include(Artifact artifact) {
+ return true;
+ }
+ };
+
+ /**
* Sets the class files directory
* @param classes the directory
* @return this.
@@ -122,6 +133,7 @@ public class ImportPackageBuilder {
/**
* defines the project from which the artifacts should be loaded.
+ * The current implementation requires the filter to be set before calling this method.
* @param project the maven project
* @return this
*/
@@ -129,6 +141,9 @@ public class ImportPackageBuilder {
public ImportPackageBuilder withDependenciesFromProject(@Nonnull MavenProject project) {
artifacts = new ArrayList<Artifact>();
for (Artifact a : project.getDependencyArtifacts()) {
+ if (!filter.include(a)) {
+ continue;
+ }
if (!Artifact.SCOPE_PROVIDED.equals(a.getScope()) && !Artifact.SCOPE_RUNTIME.equals(a.getScope())) {
continue;
}
@@ -146,11 +161,22 @@ public class ImportPackageBuilder {
* @return this
*/
@Nonnull
- public ImportPackageBuilder setIncludeUnused(boolean includeUnused) {
+ public ImportPackageBuilder withIncludeUnused(boolean includeUnused) {
this.includeUnused = includeUnused;
return this;
}
+ /**
+ * defines the filter for the project artifact
+ * @param filter the filter
+ * @return this
+ */
+ @Nonnull
+ public ImportPackageBuilder withFilter(@Nonnull ArtifactFilter filter) {
+ this.filter = filter;
+ return this;
+ }
+
/**
* analyzes the imports
* @return this
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/java/org/apache/jackrabbit/filevault/maven/packaging/it/ManifestGenerationIT.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/java/org/apache/jackrabbit/filevault/maven/packaging/it/ManifestGenerationIT.java?rev=1812958&r1=1812957&r2=1812958&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/java/org/apache/jackrabbit/filevault/maven/packaging/it/ManifestGenerationIT.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/java/org/apache/jackrabbit/filevault/maven/packaging/it/ManifestGenerationIT.java Mon Oct 23 01:42:55 2017
@@ -17,14 +17,20 @@
package org.apache.jackrabbit.filevault.maven.packaging.it;
import java.io.IOException;
+import java.util.Arrays;
+import java.util.LinkedList;
+import java.util.List;
import org.apache.maven.it.VerificationException;
import org.junit.Test;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
public class ManifestGenerationIT {
- private void verify(String projectName) throws IOException, VerificationException {
- new ProjectBuilder()
+ private ProjectBuilder verify(String projectName) throws IOException, VerificationException {
+ return new ProjectBuilder()
.setTestProjectDir("manifest-generation/" + projectName)
.build()
.verifyExpectedManifest();
@@ -49,4 +55,39 @@ public class ManifestGenerationIT {
public void unused_manifest_generation() throws Exception {
verify("with-unused-dependencies");
}
+
+ /**
+ * Tests if a unused bundle dependency define it a parent pom doesn't show up in the unused bundles report.
+ * see JCRVLT-214
+ */
+ @Test
+ public void unused_parent_manifest_generation() throws Exception {
+ ProjectBuilder builder = verify("with-unused-parent-dependencies");
+
+ // also check if unused parent is not listed
+ List<String> unusedBundles = new LinkedList<String>();
+ boolean recording = false;
+ for (String line: builder.getBuildOutput()) {
+ if (line.contains("------")) {
+ continue;
+ }
+ if (line.contains(" unused bundles")) {
+ recording = true;
+ continue;
+ }
+ if (recording) {
+ final String trimmed = line.trim();
+ if (trimmed.isEmpty()) {
+ break;
+ }
+ unusedBundles.add(trimmed);
+ }
+ }
+ String[] unused = unusedBundles.toArray(new String[unusedBundles.size()]);
+ Arrays.sort(unused);
+
+ // the project should have at 1 unused bundle but not the one from the parent
+ assertTrue("unused bundles > 0", unused.length > 0);
+ assertEquals("unused bundle", "[org.jsoup:jsoup:jar:1.10.3]", Arrays.toString(unused));
+ }
}
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/java/org/apache/jackrabbit/filevault/maven/packaging/it/ProjectBuilder.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/java/org/apache/jackrabbit/filevault/maven/packaging/it/ProjectBuilder.java?rev=1812958&r1=1812957&r2=1812958&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/java/org/apache/jackrabbit/filevault/maven/packaging/it/ProjectBuilder.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/java/org/apache/jackrabbit/filevault/maven/packaging/it/ProjectBuilder.java Mon Oct 23 01:42:55 2017
@@ -93,6 +93,8 @@ public class ProjectBuilder {
private File expectedFilterFile;
+ private File logTxtFile;
+
private boolean buildExpectedToFail;
public ProjectBuilder() {
@@ -147,6 +149,7 @@ public class ProjectBuilder {
this.expectedOrderFile = new File(testProjectDir, "expected-file-order.txt");
this.expectedManifestFile = new File(testProjectDir, "expected-manifest.txt");
this.expectedFilterFile = new File(testProjectDir, "expected-filter.xml");
+ this.logTxtFile = new File(testProjectDir, "log.txt");
return this;
}
@@ -282,4 +285,7 @@ public class ProjectBuilder {
return this;
}
+ public List<String> getBuildOutput() throws IOException {
+ return Files.readAllLines(logTxtFile.toPath(), StandardCharsets.UTF_8);
+ }
}
Added: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/expected-manifest.txt
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/expected-manifest.txt?rev=1812958&view=auto
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/expected-manifest.txt (added)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/expected-manifest.txt Mon Oct 23 01:42:55 2017
@@ -0,0 +1,13 @@
+Archiver-Version:Plexus Archiver
+Content-Package-Description:This is an Example Project to verify that manifest generation is correct.
+Content-Package-Id:my/test/group:package-plugin-test-pkg:1.0.0-SNAPSHOT
+Content-Package-Roots:/libs/apache
+Content-Package-Type:application
+Created-By:Apache Maven
+Implementation-Title:Example Default Project
+Implementation-Vendor-Id:org.apache.jackrabbit.filevault
+Implementation-Version:1.0.0-SNAPSHOT
+Import-Package:javax.servlet;
+Import-Package:org.apache.jackrabbit.api.query;
+Import-Package:org.apache.sling.api.resource;version="[2.5.0,3.0.0)"
+Manifest-Version:1.0
\ No newline at end of file
Added: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/jcr_root/libs/apache/IncludeUseObject.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/jcr_root/libs/apache/IncludeUseObject.java?rev=1812958&view=auto
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/jcr_root/libs/apache/IncludeUseObject.java (added)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/jcr_root/libs/apache/IncludeUseObject.java Mon Oct 23 01:42:55 2017
@@ -0,0 +1,58 @@
+/*
+ * 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 libs.apache;
+
+import java.io.IOException;
+
+import javax.servlet.ServletException;
+
+import org.apache.jackrabbit.api.query.JackrabbitQueryResult;
+import org.apache.sling.api.resource.Resource;
+
+public class IncludeUseObject {
+
+ private static final String RESOURCE = "includeResource";
+ private static final String RESOURCE_TYPE = "includeResourceType";
+ private static final String OPTIONS = "includeOptions";
+ private static final String SCRIPT = "includeScript";
+
+
+ protected void activate() {
+ // only for testing reference to oaj.api.query package
+ String testOnly = JackrabbitQueryResult.class.getName();
+ // only for testing reference to oas.api.resource package
+ String resource = Resource.class.getName();
+ }
+
+ /**
+ * Include the provided resource, using the provided resource type and options.
+ *
+ * @return Output from including the resource
+ */
+ public String includeResource() throws ServletException, IOException {
+ return "";
+ }
+
+ /**
+ * Include the provided script, using the provided options.
+ *
+ * @return Output from including the script
+ */
+ public String includeScript() throws ServletException, IOException {
+ return "";
+ }
+}
Added: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/parent/pom.xml
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/parent/pom.xml?rev=1812958&view=auto
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/parent/pom.xml (added)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/parent/pom.xml Mon Oct 23 01:42:55 2017
@@ -0,0 +1,46 @@
+<!--
+ 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/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>org.apache.jackrabbit.filevault</groupId>
+ <artifactId>package-plugin-test-pkg-parent</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ <packaging>pom</packaging>
+ <name>Example Parent Project</name>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.api</artifactId>
+ <version>2.7.0</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>javax.servlet</groupId>
+ <artifactId>servlet-api</artifactId>
+ <version>2.5</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <!-- unused dependency from parent should not show up in report -->
+ <groupId>biz.aQute</groupId>
+ <artifactId>bndlib</artifactId>
+ <version>1.43.0</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+</project>
Added: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/pom.xml
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/pom.xml?rev=1812958&view=auto
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/pom.xml (added)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/test/resources/test-projects/manifest-generation/with-unused-parent-dependencies/pom.xml Mon Oct 23 01:42:55 2017
@@ -0,0 +1,72 @@
+<!--
+ 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/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.jackrabbit.filevault</groupId>
+ <artifactId>package-plugin-test-pkg-parent</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ <relativePath>parent</relativePath>
+ </parent>
+
+ <artifactId>package-plugin-test-pkg</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ <packaging>content-package</packaging>
+ <name>Example Default Project</name>
+ <description>This is an Example Project to verify that manifest generation is correct.</description>
+ <build>
+ <sourceDirectory>${project.basedir}/jcr_root</sourceDirectory>
+
+ <plugins>
+ <plugin>
+ <groupId>org.apache.jackrabbit</groupId>
+ <artifactId>filevault-package-maven-plugin</artifactId>
+ <version>${plugin.version}</version>
+ <extensions>true</extensions>
+ <configuration>
+ <group>my/test/group</group>
+ <failOnDependencyErrors>false</failOnDependencyErrors>
+ <excludedLibraries>
+ biz.aQute:bndlib
+ </excludedLibraries>
+ <filters>
+ <filter>
+ <root>/libs/apache</root>
+ </filter>
+ </filters>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.jackrabbit</groupId>
+ <artifactId>jackrabbit-api</artifactId>
+ <version>2.7.5</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <!-- unused dependency -->
+ <groupId>org.jsoup</groupId>
+ <artifactId>jsoup</artifactId>
+ <version>1.10.3</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+</project>