Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html (original) +++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html Sat Apr 20 14:51:39 2024 @@ -1,292 +1,296 @@ <!DOCTYPE HTML> <html lang="en"> <head> +<!-- Generated by javadoc (17) --> <title>Source code</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta name="description" content="source: package: org.apache.commons.release.plugin.mojos, class: CommonsDistributionDetachmentMojo"> +<meta name="generator" content="javadoc/SourceToHTMLConverter"> <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> </head> -<body> +<body class="source-page"> <main role="main"> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> -<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a> -<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements. See the NOTICE file distributed with</a> -<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a> -<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a> -<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a> -<span class="sourceLineNo">007</span><a id="line.7"> * the License. You may obtain a copy of the License at</a> -<span class="sourceLineNo">008</span><a id="line.8"> *</a> -<span class="sourceLineNo">009</span><a id="line.9"> * http://www.apache.org/licenses/LICENSE-2.0</a> -<span class="sourceLineNo">010</span><a id="line.10"> *</a> -<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a> -<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a> -<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a> -<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a> -<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a> -<span class="sourceLineNo">016</span><a id="line.16"> */</a> -<span class="sourceLineNo">017</span><a id="line.17">package org.apache.commons.release.plugin.mojos;</a> -<span class="sourceLineNo">018</span><a id="line.18"></a> -<span class="sourceLineNo">019</span><a id="line.19">import java.io.File;</a> -<span class="sourceLineNo">020</span><a id="line.20">import java.io.IOException;</a> -<span class="sourceLineNo">021</span><a id="line.21">import java.io.InputStream;</a> -<span class="sourceLineNo">022</span><a id="line.22">import java.io.OutputStream;</a> -<span class="sourceLineNo">023</span><a id="line.23">import java.io.PrintWriter;</a> -<span class="sourceLineNo">024</span><a id="line.24">import java.nio.file.Files;</a> -<span class="sourceLineNo">025</span><a id="line.25">import java.util.ArrayList;</a> -<span class="sourceLineNo">026</span><a id="line.26">import java.util.Collections;</a> -<span class="sourceLineNo">027</span><a id="line.27">import java.util.HashSet;</a> -<span class="sourceLineNo">028</span><a id="line.28">import java.util.List;</a> -<span class="sourceLineNo">029</span><a id="line.29">import java.util.Locale;</a> -<span class="sourceLineNo">030</span><a id="line.30">import java.util.Set;</a> -<span class="sourceLineNo">031</span><a id="line.31"></a> -<span class="sourceLineNo">032</span><a id="line.32">import org.apache.commons.codec.digest.DigestUtils;</a> -<span class="sourceLineNo">033</span><a id="line.33">import org.apache.commons.collections4.properties.SortedProperties;</a> -<span class="sourceLineNo">034</span><a id="line.34">import org.apache.commons.lang3.StringUtils;</a> -<span class="sourceLineNo">035</span><a id="line.35">import org.apache.commons.lang3.reflect.MethodUtils;</a> -<span class="sourceLineNo">036</span><a id="line.36">import org.apache.commons.release.plugin.SharedFunctions;</a> -<span class="sourceLineNo">037</span><a id="line.37">import org.apache.maven.artifact.Artifact;</a> -<span class="sourceLineNo">038</span><a id="line.38">import org.apache.maven.plugin.AbstractMojo;</a> -<span class="sourceLineNo">039</span><a id="line.39">import org.apache.maven.plugin.MojoExecutionException;</a> -<span class="sourceLineNo">040</span><a id="line.40">import org.apache.maven.plugins.annotations.LifecyclePhase;</a> -<span class="sourceLineNo">041</span><a id="line.41">import org.apache.maven.plugins.annotations.Mojo;</a> -<span class="sourceLineNo">042</span><a id="line.42">import org.apache.maven.plugins.annotations.Parameter;</a> -<span class="sourceLineNo">043</span><a id="line.43">import org.apache.maven.project.MavenProject;</a> -<span class="sourceLineNo">044</span><a id="line.44"></a> -<span class="sourceLineNo">045</span><a id="line.45">/**</a> -<span class="sourceLineNo">046</span><a id="line.46"> * The purpose of this Maven mojo is to detach the artifacts generated by the maven-assembly-plugin,</a> -<span class="sourceLineNo">047</span><a id="line.47"> * which for the Apache Commons Project do not get uploaded to Nexus, and putting those artifacts</a> -<span class="sourceLineNo">048</span><a id="line.48"> * in the dev distribution location for Apache projects.</a> -<span class="sourceLineNo">049</span><a id="line.49"> *</a> -<span class="sourceLineNo">050</span><a id="line.50"> * @since 1.0</a> -<span class="sourceLineNo">051</span><a id="line.51"> */</a> -<span class="sourceLineNo">052</span><a id="line.52">@Mojo(name = "detach-distributions",</a> -<span class="sourceLineNo">053</span><a id="line.53"> defaultPhase = LifecyclePhase.VERIFY,</a> -<span class="sourceLineNo">054</span><a id="line.54"> threadSafe = true,</a> -<span class="sourceLineNo">055</span><a id="line.55"> aggregator = true)</a> -<span class="sourceLineNo">056</span><a id="line.56">public class CommonsDistributionDetachmentMojo extends AbstractMojo {</a> -<span class="sourceLineNo">057</span><a id="line.57"></a> -<span class="sourceLineNo">058</span><a id="line.58"> /**</a> -<span class="sourceLineNo">059</span><a id="line.59"> * A list of "artifact types" in the Maven vernacular, to</a> -<span class="sourceLineNo">060</span><a id="line.60"> * be detached from the deployment. For the time being we want</a> -<span class="sourceLineNo">061</span><a id="line.61"> * all artifacts generated by the maven-assembly-plugin to be detached</a> -<span class="sourceLineNo">062</span><a id="line.62"> * from the deployment, namely *-src.zip, *-src.tar.gz, *-bin.zip,</a> -<span class="sourceLineNo">063</span><a id="line.63"> * *-bin.tar.gz, and the corresponding .asc pgp signatures.</a> -<span class="sourceLineNo">064</span><a id="line.64"> */</a> -<span class="sourceLineNo">065</span><a id="line.65"> private static final Set<String> ARTIFACT_TYPES_TO_DETACH;</a> -<span class="sourceLineNo">066</span><a id="line.66"> static {</a> -<span class="sourceLineNo">067</span><a id="line.67"> final Set<String> hashSet = new HashSet<>();</a> -<span class="sourceLineNo">068</span><a id="line.68"> hashSet.add("zip");</a> -<span class="sourceLineNo">069</span><a id="line.69"> hashSet.add("tar.gz");</a> -<span class="sourceLineNo">070</span><a id="line.70"> hashSet.add("zip.asc");</a> -<span class="sourceLineNo">071</span><a id="line.71"> hashSet.add("tar.gz.asc");</a> -<span class="sourceLineNo">072</span><a id="line.72"> ARTIFACT_TYPES_TO_DETACH = Collections.unmodifiableSet(hashSet);</a> -<span class="sourceLineNo">073</span><a id="line.73"> }</a> -<span class="sourceLineNo">074</span><a id="line.74"></a> -<span class="sourceLineNo">075</span><a id="line.75"> /**</a> -<span class="sourceLineNo">076</span><a id="line.76"> * This list is supposed to hold the Maven references to the aforementioned artifacts so that we</a> -<span class="sourceLineNo">077</span><a id="line.77"> * can upload them to svn after they've been detached from the Maven deployment.</a> -<span class="sourceLineNo">078</span><a id="line.78"> */</a> -<span class="sourceLineNo">079</span><a id="line.79"> private final List<Artifact> detachedArtifacts = new ArrayList<>();</a> -<span class="sourceLineNo">080</span><a id="line.80"></a> -<span class="sourceLineNo">081</span><a id="line.81"> /**</a> -<span class="sourceLineNo">082</span><a id="line.82"> * A {@link SortedProperties} of {@link Artifact} â {@link String} containing the sha512 signatures</a> -<span class="sourceLineNo">083</span><a id="line.83"> * for the individual artifacts, where the {@link Artifact} is represented as:</a> -<span class="sourceLineNo">084</span><a id="line.84"> * <code>groupId:artifactId:version:type=sha512</code>.</a> -<span class="sourceLineNo">085</span><a id="line.85"> */</a> -<span class="sourceLineNo">086</span><a id="line.86"> private final SortedProperties artifactSha512s = new SortedProperties();</a> -<span class="sourceLineNo">087</span><a id="line.87"></a> -<span class="sourceLineNo">088</span><a id="line.88"> /**</a> -<span class="sourceLineNo">089</span><a id="line.89"> * The maven project context injection so that we can get a hold of the variables at hand.</a> -<span class="sourceLineNo">090</span><a id="line.90"> */</a> -<span class="sourceLineNo">091</span><a id="line.91"> @Parameter(defaultValue = "${project}", required = true)</a> -<span class="sourceLineNo">092</span><a id="line.92"> private MavenProject project;</a> -<span class="sourceLineNo">093</span><a id="line.93"></a> -<span class="sourceLineNo">094</span><a id="line.94"> /**</a> -<span class="sourceLineNo">095</span><a id="line.95"> * The working directory in <code>target</code> that we use as a sandbox for the plugin.</a> -<span class="sourceLineNo">096</span><a id="line.96"> */</a> -<span class="sourceLineNo">097</span><a id="line.97"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin",</a> -<span class="sourceLineNo">098</span><a id="line.98"> property = "commons.outputDirectory")</a> -<span class="sourceLineNo">099</span><a id="line.99"> private File workingDirectory;</a> -<span class="sourceLineNo">100</span><a id="line.100"></a> -<span class="sourceLineNo">101</span><a id="line.101"> /**</a> -<span class="sourceLineNo">102</span><a id="line.102"> * The subversion staging url to which we upload all of our staged artifacts.</a> -<span class="sourceLineNo">103</span><a id="line.103"> */</a> -<span class="sourceLineNo">104</span><a id="line.104"> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")</a> -<span class="sourceLineNo">105</span><a id="line.105"> private String distSvnStagingUrl;</a> -<span class="sourceLineNo">106</span><a id="line.106"></a> -<span class="sourceLineNo">107</span><a id="line.107"> /**</a> -<span class="sourceLineNo">108</span><a id="line.108"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</a> -<span class="sourceLineNo">109</span><a id="line.109"> */</a> -<span class="sourceLineNo">110</span><a id="line.110"> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")</a> -<span class="sourceLineNo">111</span><a id="line.111"> private Boolean isDistModule;</a> -<span class="sourceLineNo">112</span><a id="line.112"></a> -<span class="sourceLineNo">113</span><a id="line.113"> @Override</a> -<span class="sourceLineNo">114</span><a id="line.114"> public void execute() throws MojoExecutionException {</a> -<span class="sourceLineNo">115</span><a id="line.115"> if (!isDistModule) {</a> -<span class="sourceLineNo">116</span><a id="line.116"> getLog().info("This module is marked as a non distribution or assembly module, and the plugin will not run.");</a> -<span class="sourceLineNo">117</span><a id="line.117"> return;</a> -<span class="sourceLineNo">118</span><a id="line.118"> }</a> -<span class="sourceLineNo">119</span><a id="line.119"> if (StringUtils.isEmpty(distSvnStagingUrl)) {</a> -<span class="sourceLineNo">120</span><a id="line.120"> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");</a> -<span class="sourceLineNo">121</span><a id="line.121"> return;</a> -<span class="sourceLineNo">122</span><a id="line.122"> }</a> -<span class="sourceLineNo">123</span><a id="line.123"> getLog().info("Detaching Assemblies");</a> -<span class="sourceLineNo">124</span><a id="line.124"> for (final Artifact attachedArtifact : project.getAttachedArtifacts()) {</a> -<span class="sourceLineNo">125</span><a id="line.125"> putAttachedArtifactInSha512Map(attachedArtifact);</a> -<span class="sourceLineNo">126</span><a id="line.126"> if (ARTIFACT_TYPES_TO_DETACH.contains(attachedArtifact.getType())) {</a> -<span class="sourceLineNo">127</span><a id="line.127"> detachedArtifacts.add(attachedArtifact);</a> -<span class="sourceLineNo">128</span><a id="line.128"> }</a> -<span class="sourceLineNo">129</span><a id="line.129"> }</a> -<span class="sourceLineNo">130</span><a id="line.130"> if (detachedArtifacts.isEmpty()) {</a> -<span class="sourceLineNo">131</span><a id="line.131"> getLog().info("Current project contains no distributions. Not executing.");</a> -<span class="sourceLineNo">132</span><a id="line.132"> return;</a> -<span class="sourceLineNo">133</span><a id="line.133"> }</a> -<span class="sourceLineNo">134</span><a id="line.134"> //</a> -<span class="sourceLineNo">135</span><a id="line.135"> // PROBLEM CODE for Maven >= 3.8.3</a> -<span class="sourceLineNo">136</span><a id="line.136"> // https://issues.apache.org/jira/browse/MNG-7316</a> -<span class="sourceLineNo">137</span><a id="line.137"> try {</a> -<span class="sourceLineNo">138</span><a id="line.138"> // (1) Try the normal way</a> -<span class="sourceLineNo">139</span><a id="line.139"> // Maven 3.8.3 throws an exception here because MavenProject.getAttachedArtifacts()</a> -<span class="sourceLineNo">140</span><a id="line.140"> // returns an IMMUTABLE collection.</a> -<span class="sourceLineNo">141</span><a id="line.141"> project.getAttachedArtifacts().removeAll(detachedArtifacts);</a> -<span class="sourceLineNo">142</span><a id="line.142"> } catch (final UnsupportedOperationException e) {</a> -<span class="sourceLineNo">143</span><a id="line.143"> // (2) HACK workaround for https://issues.apache.org/jira/browse/MNG-7316</a> -<span class="sourceLineNo">144</span><a id="line.144"> final ArrayList<Artifact> arrayList = new ArrayList<>(project.getAttachedArtifacts());</a> -<span class="sourceLineNo">145</span><a id="line.145"> arrayList.removeAll(detachedArtifacts);</a> -<span class="sourceLineNo">146</span><a id="line.146"> try {</a> -<span class="sourceLineNo">147</span><a id="line.147"> // MavenProject#setAttachedArtifacts(List) is protected</a> -<span class="sourceLineNo">148</span><a id="line.148"> MethodUtils.invokeMethod(project, true, "setAttachedArtifacts", arrayList);</a> -<span class="sourceLineNo">149</span><a id="line.149"> } catch (final ReflectiveOperationException roe) {</a> -<span class="sourceLineNo">150</span><a id="line.150"> throw new MojoExecutionException(roe);</a> -<span class="sourceLineNo">151</span><a id="line.151"> }</a> -<span class="sourceLineNo">152</span><a id="line.152"> }</a> -<span class="sourceLineNo">153</span><a id="line.153"> if (!workingDirectory.exists()) {</a> -<span class="sourceLineNo">154</span><a id="line.154"> SharedFunctions.initDirectory(getLog(), workingDirectory);</a> -<span class="sourceLineNo">155</span><a id="line.155"> }</a> -<span class="sourceLineNo">156</span><a id="line.156"> writeAllArtifactsInSha512PropertiesFile();</a> -<span class="sourceLineNo">157</span><a id="line.157"> copyRemovedArtifactsToWorkingDirectory();</a> -<span class="sourceLineNo">158</span><a id="line.158"> getLog().info("");</a> -<span class="sourceLineNo">159</span><a id="line.159"> hashArtifacts();</a> -<span class="sourceLineNo">160</span><a id="line.160"> }</a> -<span class="sourceLineNo">161</span><a id="line.161"></a> -<span class="sourceLineNo">162</span><a id="line.162"> /**</a> -<span class="sourceLineNo">163</span><a id="line.163"> * Takes an attached artifact and puts the signature in the map.</a> -<span class="sourceLineNo">164</span><a id="line.164"> * @param artifact is a Maven {@link Artifact} taken from the project at start time of mojo.</a> -<span class="sourceLineNo">165</span><a id="line.165"> * @throws MojoExecutionException if an {@link IOException} occurs when getting the sha512 of the</a> -<span class="sourceLineNo">166</span><a id="line.166"> * artifact.</a> -<span class="sourceLineNo">167</span><a id="line.167"> */</a> -<span class="sourceLineNo">168</span><a id="line.168"> private void putAttachedArtifactInSha512Map(final Artifact artifact) throws MojoExecutionException {</a> -<span class="sourceLineNo">169</span><a id="line.169"> try {</a> -<span class="sourceLineNo">170</span><a id="line.170"> final String artifactKey = getArtifactKey(artifact);</a> -<span class="sourceLineNo">171</span><a id="line.171"> if (!artifactKey.endsWith(".asc")) { // .asc files don't need hashes</a> -<span class="sourceLineNo">172</span><a id="line.172"> try (InputStream fis = Files.newInputStream(artifact.getFile().toPath())) {</a> -<span class="sourceLineNo">173</span><a id="line.173"> artifactSha512s.put(artifactKey, DigestUtils.sha512Hex(fis));</a> -<span class="sourceLineNo">174</span><a id="line.174"> }</a> -<span class="sourceLineNo">175</span><a id="line.175"> }</a> -<span class="sourceLineNo">176</span><a id="line.176"> } catch (final IOException e) {</a> -<span class="sourceLineNo">177</span><a id="line.177"> throw new MojoExecutionException(</a> -<span class="sourceLineNo">178</span><a id="line.178"> "Could not find artifact signature for: "</a> -<span class="sourceLineNo">179</span><a id="line.179"> + artifact.getArtifactId()</a> -<span class="sourceLineNo">180</span><a id="line.180"> + "-"</a> -<span class="sourceLineNo">181</span><a id="line.181"> + artifact.getClassifier()</a> -<span class="sourceLineNo">182</span><a id="line.182"> + "-"</a> -<span class="sourceLineNo">183</span><a id="line.183"> + artifact.getVersion()</a> -<span class="sourceLineNo">184</span><a id="line.184"> + " type: "</a> -<span class="sourceLineNo">185</span><a id="line.185"> + artifact.getType(),</a> -<span class="sourceLineNo">186</span><a id="line.186"> e);</a> -<span class="sourceLineNo">187</span><a id="line.187"> }</a> -<span class="sourceLineNo">188</span><a id="line.188"> }</a> -<span class="sourceLineNo">189</span><a id="line.189"></a> -<span class="sourceLineNo">190</span><a id="line.190"> /**</a> -<span class="sourceLineNo">191</span><a id="line.191"> * Writes to ./target/commons-release-plugin/sha512.properties the artifact sha512's.</a> -<span class="sourceLineNo">192</span><a id="line.192"> *</a> -<span class="sourceLineNo">193</span><a id="line.193"> * @throws MojoExecutionException if we can't write the file due to an {@link IOException}.</a> -<span class="sourceLineNo">194</span><a id="line.194"> */</a> -<span class="sourceLineNo">195</span><a id="line.195"> private void writeAllArtifactsInSha512PropertiesFile() throws MojoExecutionException {</a> -<span class="sourceLineNo">196</span><a id="line.196"> final File propertiesFile = new File(workingDirectory, "sha512.properties");</a> -<span class="sourceLineNo">197</span><a id="line.197"> getLog().info("Writing " + propertiesFile);</a> -<span class="sourceLineNo">198</span><a id="line.198"> try (OutputStream fileWriter = Files.newOutputStream(propertiesFile.toPath())) {</a> -<span class="sourceLineNo">199</span><a id="line.199"> artifactSha512s.store(fileWriter, "Release SHA-512s");</a> -<span class="sourceLineNo">200</span><a id="line.200"> } catch (final IOException e) {</a> -<span class="sourceLineNo">201</span><a id="line.201"> throw new MojoExecutionException("Failure to write SHA-512's", e);</a> -<span class="sourceLineNo">202</span><a id="line.202"> }</a> -<span class="sourceLineNo">203</span><a id="line.203"> }</a> -<span class="sourceLineNo">204</span><a id="line.204"></a> -<span class="sourceLineNo">205</span><a id="line.205"> /**</a> -<span class="sourceLineNo">206</span><a id="line.206"> * A helper method to copy the newly detached artifacts to <code>target/commons-release-plugin</code></a> -<span class="sourceLineNo">207</span><a id="line.207"> * so that the {@link CommonsDistributionStagingMojo} can find the artifacts later.</a> -<span class="sourceLineNo">208</span><a id="line.208"> *</a> -<span class="sourceLineNo">209</span><a id="line.209"> * @throws MojoExecutionException if some form of an {@link IOException} occurs, we want it</a> -<span class="sourceLineNo">210</span><a id="line.210"> * properly wrapped so that Maven can handle it.</a> -<span class="sourceLineNo">211</span><a id="line.211"> */</a> -<span class="sourceLineNo">212</span><a id="line.212"> private void copyRemovedArtifactsToWorkingDirectory() throws MojoExecutionException {</a> -<span class="sourceLineNo">213</span><a id="line.213"> final String wdAbsolutePath = workingDirectory.getAbsolutePath();</a> -<span class="sourceLineNo">214</span><a id="line.214"> getLog().info(</a> -<span class="sourceLineNo">215</span><a id="line.215"> "Copying " + detachedArtifacts.size() + " detached artifacts to working directory " + wdAbsolutePath);</a> -<span class="sourceLineNo">216</span><a id="line.216"> for (final Artifact artifact: detachedArtifacts) {</a> -<span class="sourceLineNo">217</span><a id="line.217"> final File artifactFile = artifact.getFile();</a> -<span class="sourceLineNo">218</span><a id="line.218"> final StringBuilder copiedArtifactAbsolutePath = new StringBuilder(wdAbsolutePath);</a> -<span class="sourceLineNo">219</span><a id="line.219"> copiedArtifactAbsolutePath.append("/");</a> -<span class="sourceLineNo">220</span><a id="line.220"> copiedArtifactAbsolutePath.append(artifactFile.getName());</a> -<span class="sourceLineNo">221</span><a id="line.221"> final File copiedArtifact = new File(copiedArtifactAbsolutePath.toString());</a> -<span class="sourceLineNo">222</span><a id="line.222"> getLog().info("Copying: " + artifactFile.getName());</a> -<span class="sourceLineNo">223</span><a id="line.223"> SharedFunctions.copyFile(getLog(), artifactFile, copiedArtifact);</a> -<span class="sourceLineNo">224</span><a id="line.224"> }</a> -<span class="sourceLineNo">225</span><a id="line.225"> }</a> -<span class="sourceLineNo">226</span><a id="line.226"></a> -<span class="sourceLineNo">227</span><a id="line.227"> /**</a> -<span class="sourceLineNo">228</span><a id="line.228"> * A helper method that creates sha512 signature files for our detached artifacts in the</a> -<span class="sourceLineNo">229</span><a id="line.229"> * <code>target/commons-release-plugin</code> directory for the purpose of being uploaded by</a> -<span class="sourceLineNo">230</span><a id="line.230"> * the {@link CommonsDistributionStagingMojo}.</a> -<span class="sourceLineNo">231</span><a id="line.231"> *</a> -<span class="sourceLineNo">232</span><a id="line.232"> * @throws MojoExecutionException if some form of an {@link IOException} occurs, we want it</a> -<span class="sourceLineNo">233</span><a id="line.233"> * properly wrapped so that Maven can handle it.</a> -<span class="sourceLineNo">234</span><a id="line.234"> */</a> -<span class="sourceLineNo">235</span><a id="line.235"> private void hashArtifacts() throws MojoExecutionException {</a> -<span class="sourceLineNo">236</span><a id="line.236"> for (final Artifact artifact : detachedArtifacts) {</a> -<span class="sourceLineNo">237</span><a id="line.237"> if (!artifact.getFile().getName().toLowerCase(Locale.ROOT).contains("asc")) {</a> -<span class="sourceLineNo">238</span><a id="line.238"> final String artifactKey = getArtifactKey(artifact);</a> -<span class="sourceLineNo">239</span><a id="line.239"> try {</a> -<span class="sourceLineNo">240</span><a id="line.240"> final String digest;</a> -<span class="sourceLineNo">241</span><a id="line.241"> // SHA-512</a> -<span class="sourceLineNo">242</span><a id="line.242"> digest = artifactSha512s.getProperty(artifactKey.toString());</a> -<span class="sourceLineNo">243</span><a id="line.243"> getLog().info(artifact.getFile().getName() + " sha512: " + digest);</a> -<span class="sourceLineNo">244</span><a id="line.244"> try (PrintWriter printWriter = new PrintWriter(</a> -<span class="sourceLineNo">245</span><a id="line.245"> getSha512FilePath(workingDirectory, artifact.getFile()))) {</a> -<span class="sourceLineNo">246</span><a id="line.246"> printWriter.println(digest);</a> -<span class="sourceLineNo">247</span><a id="line.247"> }</a> -<span class="sourceLineNo">248</span><a id="line.248"> } catch (final IOException e) {</a> -<span class="sourceLineNo">249</span><a id="line.249"> throw new MojoExecutionException("Could not sign file: " + artifact.getFile().getName(), e);</a> -<span class="sourceLineNo">250</span><a id="line.250"> }</a> -<span class="sourceLineNo">251</span><a id="line.251"> }</a> -<span class="sourceLineNo">252</span><a id="line.252"> }</a> -<span class="sourceLineNo">253</span><a id="line.253"> }</a> -<span class="sourceLineNo">254</span><a id="line.254"></a> -<span class="sourceLineNo">255</span><a id="line.255"> /**</a> -<span class="sourceLineNo">256</span><a id="line.256"> * A helper method to create a file path for the <code>sha512</code> signature file from a given file.</a> -<span class="sourceLineNo">257</span><a id="line.257"> *</a> -<span class="sourceLineNo">258</span><a id="line.258"> * @param directory is the {@link File} for the directory in which to make the <code>.sha512</code> file.</a> -<span class="sourceLineNo">259</span><a id="line.259"> * @param file the {@link File} whose name we should use to create the <code>.sha512</code> file.</a> -<span class="sourceLineNo">260</span><a id="line.260"> * @return a {@link String} that is the absolute path to the <code>.sha512</code> file.</a> -<span class="sourceLineNo">261</span><a id="line.261"> */</a> -<span class="sourceLineNo">262</span><a id="line.262"> private String getSha512FilePath(final File directory, final File file) {</a> -<span class="sourceLineNo">263</span><a id="line.263"> final StringBuilder buffer = new StringBuilder(directory.getAbsolutePath());</a> -<span class="sourceLineNo">264</span><a id="line.264"> buffer.append("/");</a> -<span class="sourceLineNo">265</span><a id="line.265"> buffer.append(file.getName());</a> -<span class="sourceLineNo">266</span><a id="line.266"> buffer.append(".sha512");</a> -<span class="sourceLineNo">267</span><a id="line.267"> return buffer.toString();</a> -<span class="sourceLineNo">268</span><a id="line.268"> }</a> -<span class="sourceLineNo">269</span><a id="line.269"></a> -<span class="sourceLineNo">270</span><a id="line.270"> /**</a> -<span class="sourceLineNo">271</span><a id="line.271"> * Generates the unique artifact key for storage in our sha512 map. For example,</a> -<span class="sourceLineNo">272</span><a id="line.272"> * commons-test-1.4-src.tar.gz should have its name as the key.</a> -<span class="sourceLineNo">273</span><a id="line.273"> *</a> -<span class="sourceLineNo">274</span><a id="line.274"> * @param artifact the {@link Artifact} that we wish to generate a key for.</a> -<span class="sourceLineNo">275</span><a id="line.275"> * @return the generated key</a> -<span class="sourceLineNo">276</span><a id="line.276"> */</a> -<span class="sourceLineNo">277</span><a id="line.277"> private String getArtifactKey(final Artifact artifact) {</a> -<span class="sourceLineNo">278</span><a id="line.278"> return artifact.getFile().getName();</a> -<span class="sourceLineNo">279</span><a id="line.279"> }</a> -<span class="sourceLineNo">280</span><a id="line.280">}</a> +<div class="source-container"> +<pre><span class="source-line-no">001</span><span id="line-1">/*</span> +<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one or more</span> +<span class="source-line-no">003</span><span id="line-3"> * contributor license agreements. See the NOTICE file distributed with</span> +<span class="source-line-no">004</span><span id="line-4"> * this work for additional information regarding copyright ownership.</span> +<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses this file to You under the Apache License, Version 2.0</span> +<span class="source-line-no">006</span><span id="line-6"> * (the "License"); you may not use this file except in compliance with</span> +<span class="source-line-no">007</span><span id="line-7"> * the License. You may obtain a copy of the License at</span> +<span class="source-line-no">008</span><span id="line-8"> *</span> +<span class="source-line-no">009</span><span id="line-9"> * http://www.apache.org/licenses/LICENSE-2.0</span> +<span class="source-line-no">010</span><span id="line-10"> *</span> +<span class="source-line-no">011</span><span id="line-11"> * Unless required by applicable law or agreed to in writing, software</span> +<span class="source-line-no">012</span><span id="line-12"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +<span class="source-line-no">013</span><span id="line-13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +<span class="source-line-no">014</span><span id="line-14"> * See the License for the specific language governing permissions and</span> +<span class="source-line-no">015</span><span id="line-15"> * limitations under the License.</span> +<span class="source-line-no">016</span><span id="line-16"> */</span> +<span class="source-line-no">017</span><span id="line-17">package org.apache.commons.release.plugin.mojos;</span> +<span class="source-line-no">018</span><span id="line-18"></span> +<span class="source-line-no">019</span><span id="line-19">import java.io.File;</span> +<span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> +<span class="source-line-no">021</span><span id="line-21">import java.io.InputStream;</span> +<span class="source-line-no">022</span><span id="line-22">import java.io.OutputStream;</span> +<span class="source-line-no">023</span><span id="line-23">import java.io.PrintWriter;</span> +<span class="source-line-no">024</span><span id="line-24">import java.nio.file.Files;</span> +<span class="source-line-no">025</span><span id="line-25">import java.util.ArrayList;</span> +<span class="source-line-no">026</span><span id="line-26">import java.util.Collections;</span> +<span class="source-line-no">027</span><span id="line-27">import java.util.HashSet;</span> +<span class="source-line-no">028</span><span id="line-28">import java.util.List;</span> +<span class="source-line-no">029</span><span id="line-29">import java.util.Locale;</span> +<span class="source-line-no">030</span><span id="line-30">import java.util.Set;</span> +<span class="source-line-no">031</span><span id="line-31"></span> +<span class="source-line-no">032</span><span id="line-32">import org.apache.commons.codec.digest.DigestUtils;</span> +<span class="source-line-no">033</span><span id="line-33">import org.apache.commons.collections4.properties.SortedProperties;</span> +<span class="source-line-no">034</span><span id="line-34">import org.apache.commons.lang3.StringUtils;</span> +<span class="source-line-no">035</span><span id="line-35">import org.apache.commons.lang3.reflect.MethodUtils;</span> +<span class="source-line-no">036</span><span id="line-36">import org.apache.commons.release.plugin.SharedFunctions;</span> +<span class="source-line-no">037</span><span id="line-37">import org.apache.maven.artifact.Artifact;</span> +<span class="source-line-no">038</span><span id="line-38">import org.apache.maven.plugin.AbstractMojo;</span> +<span class="source-line-no">039</span><span id="line-39">import org.apache.maven.plugin.MojoExecutionException;</span> +<span class="source-line-no">040</span><span id="line-40">import org.apache.maven.plugins.annotations.LifecyclePhase;</span> +<span class="source-line-no">041</span><span id="line-41">import org.apache.maven.plugins.annotations.Mojo;</span> +<span class="source-line-no">042</span><span id="line-42">import org.apache.maven.plugins.annotations.Parameter;</span> +<span class="source-line-no">043</span><span id="line-43">import org.apache.maven.project.MavenProject;</span> +<span class="source-line-no">044</span><span id="line-44"></span> +<span class="source-line-no">045</span><span id="line-45">/**</span> +<span class="source-line-no">046</span><span id="line-46"> * The purpose of this Maven mojo is to detach the artifacts generated by the maven-assembly-plugin,</span> +<span class="source-line-no">047</span><span id="line-47"> * which for the Apache Commons Project do not get uploaded to Nexus, and putting those artifacts</span> +<span class="source-line-no">048</span><span id="line-48"> * in the dev distribution location for Apache projects.</span> +<span class="source-line-no">049</span><span id="line-49"> *</span> +<span class="source-line-no">050</span><span id="line-50"> * @since 1.0</span> +<span class="source-line-no">051</span><span id="line-51"> */</span> +<span class="source-line-no">052</span><span id="line-52">@Mojo(name = "detach-distributions",</span> +<span class="source-line-no">053</span><span id="line-53"> defaultPhase = LifecyclePhase.VERIFY,</span> +<span class="source-line-no">054</span><span id="line-54"> threadSafe = true,</span> +<span class="source-line-no">055</span><span id="line-55"> aggregator = true)</span> +<span class="source-line-no">056</span><span id="line-56">public class CommonsDistributionDetachmentMojo extends AbstractMojo {</span> +<span class="source-line-no">057</span><span id="line-57"></span> +<span class="source-line-no">058</span><span id="line-58"> /**</span> +<span class="source-line-no">059</span><span id="line-59"> * A list of "artifact types" in the Maven vernacular, to</span> +<span class="source-line-no">060</span><span id="line-60"> * be detached from the deployment. For the time being we want</span> +<span class="source-line-no">061</span><span id="line-61"> * all artifacts generated by the maven-assembly-plugin to be detached</span> +<span class="source-line-no">062</span><span id="line-62"> * from the deployment, namely *-src.zip, *-src.tar.gz, *-bin.zip,</span> +<span class="source-line-no">063</span><span id="line-63"> * *-bin.tar.gz, and the corresponding .asc pgp signatures.</span> +<span class="source-line-no">064</span><span id="line-64"> */</span> +<span class="source-line-no">065</span><span id="line-65"> private static final Set<String> ARTIFACT_TYPES_TO_DETACH;</span> +<span class="source-line-no">066</span><span id="line-66"> static {</span> +<span class="source-line-no">067</span><span id="line-67"> final Set<String> hashSet = new HashSet<>();</span> +<span class="source-line-no">068</span><span id="line-68"> hashSet.add("zip");</span> +<span class="source-line-no">069</span><span id="line-69"> hashSet.add("tar.gz");</span> +<span class="source-line-no">070</span><span id="line-70"> hashSet.add("zip.asc");</span> +<span class="source-line-no">071</span><span id="line-71"> hashSet.add("tar.gz.asc");</span> +<span class="source-line-no">072</span><span id="line-72"> ARTIFACT_TYPES_TO_DETACH = Collections.unmodifiableSet(hashSet);</span> +<span class="source-line-no">073</span><span id="line-73"> }</span> +<span class="source-line-no">074</span><span id="line-74"></span> +<span class="source-line-no">075</span><span id="line-75"> /**</span> +<span class="source-line-no">076</span><span id="line-76"> * This list is supposed to hold the Maven references to the aforementioned artifacts so that we</span> +<span class="source-line-no">077</span><span id="line-77"> * can upload them to svn after they've been detached from the Maven deployment.</span> +<span class="source-line-no">078</span><span id="line-78"> */</span> +<span class="source-line-no">079</span><span id="line-79"> private final List<Artifact> detachedArtifacts = new ArrayList<>();</span> +<span class="source-line-no">080</span><span id="line-80"></span> +<span class="source-line-no">081</span><span id="line-81"> /**</span> +<span class="source-line-no">082</span><span id="line-82"> * A {@link SortedProperties} of {@link Artifact} â {@link String} containing the sha512 signatures</span> +<span class="source-line-no">083</span><span id="line-83"> * for the individual artifacts, where the {@link Artifact} is represented as:</span> +<span class="source-line-no">084</span><span id="line-84"> * <code>groupId:artifactId:version:type=sha512</code>.</span> +<span class="source-line-no">085</span><span id="line-85"> */</span> +<span class="source-line-no">086</span><span id="line-86"> private final SortedProperties artifactSha512s = new SortedProperties();</span> +<span class="source-line-no">087</span><span id="line-87"></span> +<span class="source-line-no">088</span><span id="line-88"> /**</span> +<span class="source-line-no">089</span><span id="line-89"> * The maven project context injection so that we can get a hold of the variables at hand.</span> +<span class="source-line-no">090</span><span id="line-90"> */</span> +<span class="source-line-no">091</span><span id="line-91"> @Parameter(defaultValue = "${project}", required = true)</span> +<span class="source-line-no">092</span><span id="line-92"> private MavenProject project;</span> +<span class="source-line-no">093</span><span id="line-93"></span> +<span class="source-line-no">094</span><span id="line-94"> /**</span> +<span class="source-line-no">095</span><span id="line-95"> * The working directory in <code>target</code> that we use as a sandbox for the plugin.</span> +<span class="source-line-no">096</span><span id="line-96"> */</span> +<span class="source-line-no">097</span><span id="line-97"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin",</span> +<span class="source-line-no">098</span><span id="line-98"> property = "commons.outputDirectory")</span> +<span class="source-line-no">099</span><span id="line-99"> private File workingDirectory;</span> +<span class="source-line-no">100</span><span id="line-100"></span> +<span class="source-line-no">101</span><span id="line-101"> /**</span> +<span class="source-line-no">102</span><span id="line-102"> * The subversion staging url to which we upload all of our staged artifacts.</span> +<span class="source-line-no">103</span><span id="line-103"> */</span> +<span class="source-line-no">104</span><span id="line-104"> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")</span> +<span class="source-line-no">105</span><span id="line-105"> private String distSvnStagingUrl;</span> +<span class="source-line-no">106</span><span id="line-106"></span> +<span class="source-line-no">107</span><span id="line-107"> /**</span> +<span class="source-line-no">108</span><span id="line-108"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</span> +<span class="source-line-no">109</span><span id="line-109"> */</span> +<span class="source-line-no">110</span><span id="line-110"> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")</span> +<span class="source-line-no">111</span><span id="line-111"> private Boolean isDistModule;</span> +<span class="source-line-no">112</span><span id="line-112"></span> +<span class="source-line-no">113</span><span id="line-113"> @Override</span> +<span class="source-line-no">114</span><span id="line-114"> public void execute() throws MojoExecutionException {</span> +<span class="source-line-no">115</span><span id="line-115"> if (!isDistModule) {</span> +<span class="source-line-no">116</span><span id="line-116"> getLog().info("This module is marked as a non distribution or assembly module, and the plugin will not run.");</span> +<span class="source-line-no">117</span><span id="line-117"> return;</span> +<span class="source-line-no">118</span><span id="line-118"> }</span> +<span class="source-line-no">119</span><span id="line-119"> if (StringUtils.isEmpty(distSvnStagingUrl)) {</span> +<span class="source-line-no">120</span><span id="line-120"> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");</span> +<span class="source-line-no">121</span><span id="line-121"> return;</span> +<span class="source-line-no">122</span><span id="line-122"> }</span> +<span class="source-line-no">123</span><span id="line-123"> getLog().info("Detaching Assemblies");</span> +<span class="source-line-no">124</span><span id="line-124"> for (final Artifact attachedArtifact : project.getAttachedArtifacts()) {</span> +<span class="source-line-no">125</span><span id="line-125"> putAttachedArtifactInSha512Map(attachedArtifact);</span> +<span class="source-line-no">126</span><span id="line-126"> if (ARTIFACT_TYPES_TO_DETACH.contains(attachedArtifact.getType())) {</span> +<span class="source-line-no">127</span><span id="line-127"> detachedArtifacts.add(attachedArtifact);</span> +<span class="source-line-no">128</span><span id="line-128"> }</span> +<span class="source-line-no">129</span><span id="line-129"> }</span> +<span class="source-line-no">130</span><span id="line-130"> if (detachedArtifacts.isEmpty()) {</span> +<span class="source-line-no">131</span><span id="line-131"> getLog().info("Current project contains no distributions. Not executing.");</span> +<span class="source-line-no">132</span><span id="line-132"> return;</span> +<span class="source-line-no">133</span><span id="line-133"> }</span> +<span class="source-line-no">134</span><span id="line-134"> //</span> +<span class="source-line-no">135</span><span id="line-135"> // PROBLEM CODE for Maven >= 3.8.3</span> +<span class="source-line-no">136</span><span id="line-136"> // https://issues.apache.org/jira/browse/MNG-7316</span> +<span class="source-line-no">137</span><span id="line-137"> try {</span> +<span class="source-line-no">138</span><span id="line-138"> // (1) Try the normal way</span> +<span class="source-line-no">139</span><span id="line-139"> // Maven 3.8.3 throws an exception here because MavenProject.getAttachedArtifacts()</span> +<span class="source-line-no">140</span><span id="line-140"> // returns an IMMUTABLE collection.</span> +<span class="source-line-no">141</span><span id="line-141"> project.getAttachedArtifacts().removeAll(detachedArtifacts);</span> +<span class="source-line-no">142</span><span id="line-142"> } catch (final UnsupportedOperationException e) {</span> +<span class="source-line-no">143</span><span id="line-143"> // (2) HACK workaround for https://issues.apache.org/jira/browse/MNG-7316</span> +<span class="source-line-no">144</span><span id="line-144"> final ArrayList<Artifact> arrayList = new ArrayList<>(project.getAttachedArtifacts());</span> +<span class="source-line-no">145</span><span id="line-145"> arrayList.removeAll(detachedArtifacts);</span> +<span class="source-line-no">146</span><span id="line-146"> try {</span> +<span class="source-line-no">147</span><span id="line-147"> // MavenProject#setAttachedArtifacts(List) is protected</span> +<span class="source-line-no">148</span><span id="line-148"> MethodUtils.invokeMethod(project, true, "setAttachedArtifacts", arrayList);</span> +<span class="source-line-no">149</span><span id="line-149"> } catch (final ReflectiveOperationException roe) {</span> +<span class="source-line-no">150</span><span id="line-150"> throw new MojoExecutionException(roe);</span> +<span class="source-line-no">151</span><span id="line-151"> }</span> +<span class="source-line-no">152</span><span id="line-152"> }</span> +<span class="source-line-no">153</span><span id="line-153"> if (!workingDirectory.exists()) {</span> +<span class="source-line-no">154</span><span id="line-154"> SharedFunctions.initDirectory(getLog(), workingDirectory);</span> +<span class="source-line-no">155</span><span id="line-155"> }</span> +<span class="source-line-no">156</span><span id="line-156"> writeAllArtifactsInSha512PropertiesFile();</span> +<span class="source-line-no">157</span><span id="line-157"> copyRemovedArtifactsToWorkingDirectory();</span> +<span class="source-line-no">158</span><span id="line-158"> getLog().info("");</span> +<span class="source-line-no">159</span><span id="line-159"> hashArtifacts();</span> +<span class="source-line-no">160</span><span id="line-160"> }</span> +<span class="source-line-no">161</span><span id="line-161"></span> +<span class="source-line-no">162</span><span id="line-162"> /**</span> +<span class="source-line-no">163</span><span id="line-163"> * Takes an attached artifact and puts the signature in the map.</span> +<span class="source-line-no">164</span><span id="line-164"> * @param artifact is a Maven {@link Artifact} taken from the project at start time of mojo.</span> +<span class="source-line-no">165</span><span id="line-165"> * @throws MojoExecutionException if an {@link IOException} occurs when getting the sha512 of the</span> +<span class="source-line-no">166</span><span id="line-166"> * artifact.</span> +<span class="source-line-no">167</span><span id="line-167"> */</span> +<span class="source-line-no">168</span><span id="line-168"> private void putAttachedArtifactInSha512Map(final Artifact artifact) throws MojoExecutionException {</span> +<span class="source-line-no">169</span><span id="line-169"> try {</span> +<span class="source-line-no">170</span><span id="line-170"> final String artifactKey = getArtifactKey(artifact);</span> +<span class="source-line-no">171</span><span id="line-171"> if (!artifactKey.endsWith(".asc")) { // .asc files don't need hashes</span> +<span class="source-line-no">172</span><span id="line-172"> try (InputStream fis = Files.newInputStream(artifact.getFile().toPath())) {</span> +<span class="source-line-no">173</span><span id="line-173"> artifactSha512s.put(artifactKey, DigestUtils.sha512Hex(fis));</span> +<span class="source-line-no">174</span><span id="line-174"> }</span> +<span class="source-line-no">175</span><span id="line-175"> }</span> +<span class="source-line-no">176</span><span id="line-176"> } catch (final IOException e) {</span> +<span class="source-line-no">177</span><span id="line-177"> throw new MojoExecutionException(</span> +<span class="source-line-no">178</span><span id="line-178"> "Could not find artifact signature for: "</span> +<span class="source-line-no">179</span><span id="line-179"> + artifact.getArtifactId()</span> +<span class="source-line-no">180</span><span id="line-180"> + "-"</span> +<span class="source-line-no">181</span><span id="line-181"> + artifact.getClassifier()</span> +<span class="source-line-no">182</span><span id="line-182"> + "-"</span> +<span class="source-line-no">183</span><span id="line-183"> + artifact.getVersion()</span> +<span class="source-line-no">184</span><span id="line-184"> + " type: "</span> +<span class="source-line-no">185</span><span id="line-185"> + artifact.getType(),</span> +<span class="source-line-no">186</span><span id="line-186"> e);</span> +<span class="source-line-no">187</span><span id="line-187"> }</span> +<span class="source-line-no">188</span><span id="line-188"> }</span> +<span class="source-line-no">189</span><span id="line-189"></span> +<span class="source-line-no">190</span><span id="line-190"> /**</span> +<span class="source-line-no">191</span><span id="line-191"> * Writes to ./target/commons-release-plugin/sha512.properties the artifact sha512's.</span> +<span class="source-line-no">192</span><span id="line-192"> *</span> +<span class="source-line-no">193</span><span id="line-193"> * @throws MojoExecutionException if we can't write the file due to an {@link IOException}.</span> +<span class="source-line-no">194</span><span id="line-194"> */</span> +<span class="source-line-no">195</span><span id="line-195"> private void writeAllArtifactsInSha512PropertiesFile() throws MojoExecutionException {</span> +<span class="source-line-no">196</span><span id="line-196"> final File propertiesFile = new File(workingDirectory, "sha512.properties");</span> +<span class="source-line-no">197</span><span id="line-197"> getLog().info("Writing " + propertiesFile);</span> +<span class="source-line-no">198</span><span id="line-198"> try (OutputStream fileWriter = Files.newOutputStream(propertiesFile.toPath())) {</span> +<span class="source-line-no">199</span><span id="line-199"> artifactSha512s.store(fileWriter, "Release SHA-512s");</span> +<span class="source-line-no">200</span><span id="line-200"> } catch (final IOException e) {</span> +<span class="source-line-no">201</span><span id="line-201"> throw new MojoExecutionException("Failure to write SHA-512's", e);</span> +<span class="source-line-no">202</span><span id="line-202"> }</span> +<span class="source-line-no">203</span><span id="line-203"> }</span> +<span class="source-line-no">204</span><span id="line-204"></span> +<span class="source-line-no">205</span><span id="line-205"> /**</span> +<span class="source-line-no">206</span><span id="line-206"> * A helper method to copy the newly detached artifacts to <code>target/commons-release-plugin</code></span> +<span class="source-line-no">207</span><span id="line-207"> * so that the {@link CommonsDistributionStagingMojo} can find the artifacts later.</span> +<span class="source-line-no">208</span><span id="line-208"> *</span> +<span class="source-line-no">209</span><span id="line-209"> * @throws MojoExecutionException if some form of an {@link IOException} occurs, we want it</span> +<span class="source-line-no">210</span><span id="line-210"> * properly wrapped so that Maven can handle it.</span> +<span class="source-line-no">211</span><span id="line-211"> */</span> +<span class="source-line-no">212</span><span id="line-212"> private void copyRemovedArtifactsToWorkingDirectory() throws MojoExecutionException {</span> +<span class="source-line-no">213</span><span id="line-213"> final String wdAbsolutePath = workingDirectory.getAbsolutePath();</span> +<span class="source-line-no">214</span><span id="line-214"> getLog().info(</span> +<span class="source-line-no">215</span><span id="line-215"> "Copying " + detachedArtifacts.size() + " detached artifacts to working directory " + wdAbsolutePath);</span> +<span class="source-line-no">216</span><span id="line-216"> for (final Artifact artifact: detachedArtifacts) {</span> +<span class="source-line-no">217</span><span id="line-217"> final File artifactFile = artifact.getFile();</span> +<span class="source-line-no">218</span><span id="line-218"> final StringBuilder copiedArtifactAbsolutePath = new StringBuilder(wdAbsolutePath);</span> +<span class="source-line-no">219</span><span id="line-219"> copiedArtifactAbsolutePath.append("/");</span> +<span class="source-line-no">220</span><span id="line-220"> copiedArtifactAbsolutePath.append(artifactFile.getName());</span> +<span class="source-line-no">221</span><span id="line-221"> final File copiedArtifact = new File(copiedArtifactAbsolutePath.toString());</span> +<span class="source-line-no">222</span><span id="line-222"> getLog().info("Copying: " + artifactFile.getName());</span> +<span class="source-line-no">223</span><span id="line-223"> SharedFunctions.copyFile(getLog(), artifactFile, copiedArtifact);</span> +<span class="source-line-no">224</span><span id="line-224"> }</span> +<span class="source-line-no">225</span><span id="line-225"> }</span> +<span class="source-line-no">226</span><span id="line-226"></span> +<span class="source-line-no">227</span><span id="line-227"> /**</span> +<span class="source-line-no">228</span><span id="line-228"> * A helper method that creates sha512 signature files for our detached artifacts in the</span> +<span class="source-line-no">229</span><span id="line-229"> * <code>target/commons-release-plugin</code> directory for the purpose of being uploaded by</span> +<span class="source-line-no">230</span><span id="line-230"> * the {@link CommonsDistributionStagingMojo}.</span> +<span class="source-line-no">231</span><span id="line-231"> *</span> +<span class="source-line-no">232</span><span id="line-232"> * @throws MojoExecutionException if some form of an {@link IOException} occurs, we want it</span> +<span class="source-line-no">233</span><span id="line-233"> * properly wrapped so that Maven can handle it.</span> +<span class="source-line-no">234</span><span id="line-234"> */</span> +<span class="source-line-no">235</span><span id="line-235"> private void hashArtifacts() throws MojoExecutionException {</span> +<span class="source-line-no">236</span><span id="line-236"> for (final Artifact artifact : detachedArtifacts) {</span> +<span class="source-line-no">237</span><span id="line-237"> if (!artifact.getFile().getName().toLowerCase(Locale.ROOT).contains("asc")) {</span> +<span class="source-line-no">238</span><span id="line-238"> final String artifactKey = getArtifactKey(artifact);</span> +<span class="source-line-no">239</span><span id="line-239"> try {</span> +<span class="source-line-no">240</span><span id="line-240"> final String digest;</span> +<span class="source-line-no">241</span><span id="line-241"> // SHA-512</span> +<span class="source-line-no">242</span><span id="line-242"> digest = artifactSha512s.getProperty(artifactKey.toString());</span> +<span class="source-line-no">243</span><span id="line-243"> getLog().info(artifact.getFile().getName() + " sha512: " + digest);</span> +<span class="source-line-no">244</span><span id="line-244"> try (PrintWriter printWriter = new PrintWriter(</span> +<span class="source-line-no">245</span><span id="line-245"> getSha512FilePath(workingDirectory, artifact.getFile()))) {</span> +<span class="source-line-no">246</span><span id="line-246"> printWriter.println(digest);</span> +<span class="source-line-no">247</span><span id="line-247"> }</span> +<span class="source-line-no">248</span><span id="line-248"> } catch (final IOException e) {</span> +<span class="source-line-no">249</span><span id="line-249"> throw new MojoExecutionException("Could not sign file: " + artifact.getFile().getName(), e);</span> +<span class="source-line-no">250</span><span id="line-250"> }</span> +<span class="source-line-no">251</span><span id="line-251"> }</span> +<span class="source-line-no">252</span><span id="line-252"> }</span> +<span class="source-line-no">253</span><span id="line-253"> }</span> +<span class="source-line-no">254</span><span id="line-254"></span> +<span class="source-line-no">255</span><span id="line-255"> /**</span> +<span class="source-line-no">256</span><span id="line-256"> * A helper method to create a file path for the <code>sha512</code> signature file from a given file.</span> +<span class="source-line-no">257</span><span id="line-257"> *</span> +<span class="source-line-no">258</span><span id="line-258"> * @param directory is the {@link File} for the directory in which to make the <code>.sha512</code> file.</span> +<span class="source-line-no">259</span><span id="line-259"> * @param file the {@link File} whose name we should use to create the <code>.sha512</code> file.</span> +<span class="source-line-no">260</span><span id="line-260"> * @return a {@link String} that is the absolute path to the <code>.sha512</code> file.</span> +<span class="source-line-no">261</span><span id="line-261"> */</span> +<span class="source-line-no">262</span><span id="line-262"> private String getSha512FilePath(final File directory, final File file) {</span> +<span class="source-line-no">263</span><span id="line-263"> final StringBuilder buffer = new StringBuilder(directory.getAbsolutePath());</span> +<span class="source-line-no">264</span><span id="line-264"> buffer.append("/");</span> +<span class="source-line-no">265</span><span id="line-265"> buffer.append(file.getName());</span> +<span class="source-line-no">266</span><span id="line-266"> buffer.append(".sha512");</span> +<span class="source-line-no">267</span><span id="line-267"> return buffer.toString();</span> +<span class="source-line-no">268</span><span id="line-268"> }</span> +<span class="source-line-no">269</span><span id="line-269"></span> +<span class="source-line-no">270</span><span id="line-270"> /**</span> +<span class="source-line-no">271</span><span id="line-271"> * Generates the unique artifact key for storage in our sha512 map. For example,</span> +<span class="source-line-no">272</span><span id="line-272"> * commons-test-1.4-src.tar.gz should have its name as the key.</span> +<span class="source-line-no">273</span><span id="line-273"> *</span> +<span class="source-line-no">274</span><span id="line-274"> * @param artifact the {@link Artifact} that we wish to generate a key for.</span> +<span class="source-line-no">275</span><span id="line-275"> * @return the generated key</span> +<span class="source-line-no">276</span><span id="line-276"> */</span> +<span class="source-line-no">277</span><span id="line-277"> private String getArtifactKey(final Artifact artifact) {</span> +<span class="source-line-no">278</span><span id="line-278"> return artifact.getFile().getName();</span> +<span class="source-line-no">279</span><span id="line-279"> }</span> +<span class="source-line-no">280</span><span id="line-280">}</span>
