-
Notifications
You must be signed in to change notification settings - Fork 27
extract FilesCollector #45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
178 changes: 178 additions & 0 deletions
178
src/main/java/org/apache/maven/plugins/gpg/FilesCollector.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| /* | ||
| * 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.maven.plugins.gpg; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.nio.file.Path; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import org.apache.maven.artifact.Artifact; | ||
| import org.apache.maven.plugin.MojoExecutionException; | ||
| import org.apache.maven.plugin.MojoFailureException; | ||
| import org.apache.maven.plugin.logging.Log; | ||
| import org.apache.maven.project.MavenProject; | ||
| import org.codehaus.plexus.util.FileUtils; | ||
| import org.codehaus.plexus.util.SelectorUtils; | ||
|
|
||
| /** | ||
| * Collects project artifact, the POM, and attached artifacts to be signed. | ||
| * | ||
| * @since 3.1.0 | ||
| */ | ||
| public class FilesCollector { | ||
| private final MavenProject project; | ||
|
|
||
| private static final String DEFAULT_EXCLUDES[] = | ||
| new String[] {"**/*.md5", "**/*.sha1", "**/*.sha256", "**/*.sha512", "**/*.asc"}; | ||
|
|
||
| private final String[] excludes; | ||
|
|
||
| private final Log log; | ||
|
|
||
| public FilesCollector(MavenProject project, String[] excludes, Log log) { | ||
| this.project = project; | ||
| this.log = log; | ||
| if (excludes == null || excludes.length == 0) { | ||
| this.excludes = DEFAULT_EXCLUDES; | ||
| return; | ||
| } | ||
| String newExcludes[] = new String[excludes.length]; | ||
| for (int i = 0; i < excludes.length; i++) { | ||
| String pattern; | ||
| pattern = excludes[i].trim().replace('/', File.separatorChar).replace('\\', File.separatorChar); | ||
| if (pattern.endsWith(File.separator)) { | ||
| pattern += "**"; | ||
| } | ||
| newExcludes[i] = pattern; | ||
| } | ||
| this.excludes = newExcludes; | ||
| } | ||
|
|
||
| public List<Item> collect() throws MojoExecutionException, MojoFailureException { | ||
| List<Item> items = new ArrayList<>(); | ||
|
|
||
| if (!"pom".equals(project.getPackaging())) { | ||
| // ---------------------------------------------------------------------------- | ||
| // Project artifact | ||
| // ---------------------------------------------------------------------------- | ||
|
|
||
| Artifact artifact = project.getArtifact(); | ||
|
|
||
| File file = artifact.getFile(); | ||
|
|
||
| if (file != null && file.isFile()) { | ||
| items.add(new Item(file, artifact.getArtifactHandler().getExtension())); | ||
| } else if (project.getAttachedArtifacts().isEmpty()) { | ||
| throw new MojoFailureException("The project artifact has not been assembled yet. " | ||
michael-o marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| + "Please do not invoke this goal before the lifecycle phase \"package\"."); | ||
| } else { | ||
| log.debug("Main artifact not assembled, skipping signature generation"); | ||
| } | ||
| } | ||
|
|
||
| // ---------------------------------------------------------------------------- | ||
| // POM | ||
| // ---------------------------------------------------------------------------- | ||
|
|
||
| File pomToSign = | ||
| new File(project.getBuild().getDirectory(), project.getBuild().getFinalName() + ".pom"); | ||
|
|
||
| try { | ||
| FileUtils.copyFile(project.getFile(), pomToSign); | ||
michael-o marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } catch (IOException e) { | ||
| throw new MojoExecutionException("Error copying POM for signing.", e); | ||
| } | ||
|
|
||
| items.add(new Item(pomToSign, "pom")); | ||
|
|
||
| // ---------------------------------------------------------------------------- | ||
| // Attached artifacts | ||
| // ---------------------------------------------------------------------------- | ||
|
|
||
| for (Artifact artifact : project.getAttachedArtifacts()) { | ||
| File file = artifact.getFile(); | ||
|
|
||
| if (isExcluded(artifact)) { | ||
| log.debug("Skipping generation of signature for excluded " + file); | ||
| continue; | ||
| } | ||
|
|
||
| items.add(new Item( | ||
| file, | ||
| artifact.getClassifier(), | ||
| artifact.getArtifactHandler().getExtension())); | ||
| } | ||
|
|
||
| return items; | ||
| } | ||
|
|
||
| /** | ||
| * Tests whether or not a name matches against at least one exclude pattern. | ||
| * | ||
| * @param artifact The artifact to match. Must not be <code>null</code>. | ||
| * @return <code>true</code> when the name matches against at least one exclude pattern, or <code>false</code> | ||
| * otherwise. | ||
| */ | ||
| protected boolean isExcluded(Artifact artifact) { | ||
| final Path projectBasePath = project.getBasedir().toPath(); | ||
| final Path artifactPath = artifact.getFile().toPath(); | ||
| final String relativeArtifactPath = | ||
| projectBasePath.relativize(artifactPath).toString(); | ||
|
|
||
| for (String exclude : excludes) { | ||
| if (SelectorUtils.matchPath(exclude, relativeArtifactPath)) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| public static class Item { | ||
| private final File file; | ||
|
|
||
| private final String classifier; | ||
|
|
||
| private final String extension; | ||
|
|
||
| public Item(File file, String classifier, String extension) { | ||
| this.file = file; | ||
| this.classifier = classifier; | ||
| this.extension = extension; | ||
| } | ||
|
|
||
| public Item(File file, String extension) { | ||
| this(file, null, extension); | ||
| } | ||
|
|
||
| public File getFile() { | ||
| return file; | ||
| } | ||
|
|
||
| public String getClassifier() { | ||
| return classifier; | ||
| } | ||
|
|
||
| public String getExtension() { | ||
| return extension; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.