Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/exec/PmdExecutor.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/exec/PmdExecutor.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/exec/PmdExecutor.html Fri May 12 20:25:56 2023 @@ -6,536 +6,434 @@ </head> <body> <div id="overview"><a href="../../../../../../../apidocs/org/apache/maven/plugins/pmd/exec/PmdExecutor.html">View Javadoc</a></div><pre> -<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.pmd.exec; -<a class="jxr_linenumber" name="L2" href="#L2">2</a> -<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em> -<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> -<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em> -<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em> -<a class="jxr_linenumber" name="L21" href="#L21">21</a> -<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.Closeable; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.File; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream; -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.ObjectInputStream; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.io.ObjectOutputStream; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.io.OutputStreamWriter; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.io.Writer; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.Objects; -<a class="jxr_linenumber" name="L34" href="#L34">34</a> -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.ExcludeViolationsFromFile; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils; -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; -<a class="jxr_linenumber" name="L41" href="#L41">41</a> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.PmdAnalysis; -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.PMDConfiguration; -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.Report; -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RulePriority; -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RuleSetLoadException; -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RuleSetLoader; -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RuleViolation; -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.benchmark.TextTimingReportRenderer; -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.benchmark.TimeTracker; -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.benchmark.TimingReport; -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.benchmark.TimingReportRenderer; -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.lang.Language; -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.lang.LanguageRegistry; -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.lang.LanguageVersion; -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.CSVRenderer; -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.HTMLRenderer; -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.Renderer; -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.TextRenderer; -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.XMLRenderer; -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.util.Predicate; -<a class="jxr_linenumber" name="L62" href="#L62">62</a> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * Executes PMD with the configuration provided via {@link PmdRequest}.</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a> <strong class="jxr_keyword">extends</strong> <a name="Executor" href="../../../../../../org/apache/maven/plugins/pmd/exec/Executor.html#Executor">Executor</a> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> { -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger( PmdExecutor.<strong class="jxr_keyword">class</strong> ); -<a class="jxr_linenumber" name="L69" href="#L69">69</a> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="PmdResult" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdResult.html#PmdResult">PmdResult</a> execute( <a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a> request ) <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L71" href="#L71">71</a> { -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">if</strong> ( request.getJavaExecutable() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L73" href="#L73">73</a> { -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">return</strong> fork( request ); -<a class="jxr_linenumber" name="L75" href="#L75">75</a> } -<a class="jxr_linenumber" name="L76" href="#L76">76</a> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_comment">// make sure the class loaders are correct and call this in the same JVM</em> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> { -<a class="jxr_linenumber" name="L81" href="#L81">81</a> Thread.currentThread().setContextClassLoader( PmdExecutor.<strong class="jxr_keyword">class</strong>.getClassLoader() ); -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a> executor = <strong class="jxr_keyword">new</strong> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a>( request ); -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">return</strong> executor.run(); -<a class="jxr_linenumber" name="L84" href="#L84">84</a> } -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">finally</strong> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> { -<a class="jxr_linenumber" name="L87" href="#L87">87</a> Thread.currentThread().setContextClassLoader( origLoader ); -<a class="jxr_linenumber" name="L88" href="#L88">88</a> } -<a class="jxr_linenumber" name="L89" href="#L89">89</a> } -<a class="jxr_linenumber" name="L90" href="#L90">90</a> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a name="PmdResult" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdResult.html#PmdResult">PmdResult</a> fork( <a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a> request ) -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L93" href="#L93">93</a> { -<a class="jxr_linenumber" name="L94" href="#L94">94</a> File basePmdDir = <strong class="jxr_keyword">new</strong> File ( request.getTargetDirectory(), <span class="jxr_string">"pmd"</span> ); -<a class="jxr_linenumber" name="L95" href="#L95">95</a> basePmdDir.mkdirs(); -<a class="jxr_linenumber" name="L96" href="#L96">96</a> File pmdRequestFile = <strong class="jxr_keyword">new</strong> File( basePmdDir, <span class="jxr_string">"pmdrequest.bin"</span> ); -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">try</strong> ( ObjectOutputStream out = <strong class="jxr_keyword">new</strong> ObjectOutputStream( <strong class="jxr_keyword">new</strong> FileOutputStream( pmdRequestFile ) ) ) -<a class="jxr_linenumber" name="L98" href="#L98">98</a> { -<a class="jxr_linenumber" name="L99" href="#L99">99</a> out.writeObject( request ); -<a class="jxr_linenumber" name="L100" href="#L100">100</a> } -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a class="jxr_linenumber" name="L102" href="#L102">102</a> { -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); -<a class="jxr_linenumber" name="L104" href="#L104">104</a> } -<a class="jxr_linenumber" name="L105" href="#L105">105</a> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> String classpath = buildClasspath(); -<a class="jxr_linenumber" name="L107" href="#L107">107</a> ProcessBuilder pb = <strong class="jxr_keyword">new</strong> ProcessBuilder(); -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_comment">// note: using env variable instead of -cp cli arg to avoid length limitations under Windows</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> pb.environment().put( <span class="jxr_string">"CLASSPATH"</span>, classpath ); -<a class="jxr_linenumber" name="L110" href="#L110">110</a> pb.command().add( request.getJavaExecutable() ); -<a class="jxr_linenumber" name="L111" href="#L111">111</a> pb.command().add( PmdExecutor.<strong class="jxr_keyword">class</strong>.getName() ); -<a class="jxr_linenumber" name="L112" href="#L112">112</a> pb.command().add( pmdRequestFile.getAbsolutePath() ); -<a class="jxr_linenumber" name="L113" href="#L113">113</a> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> LOG.debug( <span class="jxr_string">"Executing: CLASSPATH={}, command={}"</span>, classpath, pb.command() ); -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> { -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">final</strong> Process p = pb.start(); -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_comment">// Note: can't use pb.inheritIO(), since System.out/System.err has been modified after process start</em> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_comment">// and inheritIO would only inherit file handles, not the changed streams.</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> ProcessStreamHandler.start( p.getInputStream(), System.out ); -<a class="jxr_linenumber" name="L121" href="#L121">121</a> ProcessStreamHandler.start( p.getErrorStream(), System.err ); -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">int</strong> exit = p.waitFor(); -<a class="jxr_linenumber" name="L123" href="#L123">123</a> LOG.debug( <span class="jxr_string">"PmdExecutor exit code: {}"</span>, exit ); -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">if</strong> ( exit != 0 ) -<a class="jxr_linenumber" name="L125" href="#L125">125</a> { -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"PmdExecutor exited with exit code "</span> + exit ); -<a class="jxr_linenumber" name="L127" href="#L127">127</a> } -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="PmdResult" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdResult.html#PmdResult">PmdResult</a>( <strong class="jxr_keyword">new</strong> File( request.getTargetDirectory(), <span class="jxr_string">"pmd.xml"</span> ), request.getOutputEncoding() ); -<a class="jxr_linenumber" name="L129" href="#L129">129</a> } -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a class="jxr_linenumber" name="L131" href="#L131">131</a> { -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); -<a class="jxr_linenumber" name="L133" href="#L133">133</a> } -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">catch</strong> ( InterruptedException e ) -<a class="jxr_linenumber" name="L135" href="#L135">135</a> { -<a class="jxr_linenumber" name="L136" href="#L136">136</a> Thread.currentThread().interrupt(); -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); -<a class="jxr_linenumber" name="L138" href="#L138">138</a> } -<a class="jxr_linenumber" name="L139" href="#L139">139</a> } -<a class="jxr_linenumber" name="L140" href="#L140">140</a> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * Execute PMD analysis from CLI.</em> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * Single arg with the filename to the serialized {@link PmdRequest}.</em> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * Exit-code: 0 = success, 1 = failure in executing</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * @param args</em> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> main( String[] args ) -<a class="jxr_linenumber" name="L153" href="#L153">153</a> { -<a class="jxr_linenumber" name="L154" href="#L154">154</a> File requestFile = <strong class="jxr_keyword">new</strong> File( args[0] ); -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">try</strong> ( ObjectInputStream in = <strong class="jxr_keyword">new</strong> ObjectInputStream( <strong class="jxr_keyword">new</strong> FileInputStream( requestFile ) ) ) -<a class="jxr_linenumber" name="L156" href="#L156">156</a> { -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a> request = (<a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a>) in.readObject(); -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a> pmdExecutor = <strong class="jxr_keyword">new</strong> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a>( request ); -<a class="jxr_linenumber" name="L159" href="#L159">159</a> pmdExecutor.setupLogLevel( request.getLogLevel() ); -<a class="jxr_linenumber" name="L160" href="#L160">160</a> pmdExecutor.run(); -<a class="jxr_linenumber" name="L161" href="#L161">161</a> System.exit( 0 ); +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.pmd.exec; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.Closeable; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.io.ObjectInputStream; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.ObjectOutputStream; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.io.OutputStreamWriter; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.io.Writer; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.Objects; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.PMDConfiguration; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.PmdAnalysis; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.Report; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RulePriority; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RuleSetLoadException; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RuleSetLoader; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RuleViolation; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.benchmark.TextTimingReportRenderer; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.benchmark.TimeTracker; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.benchmark.TimingReport; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.benchmark.TimingReportRenderer; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.lang.Language; +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.lang.LanguageRegistry; +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.lang.LanguageVersion; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.CSVRenderer; +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.HTMLRenderer; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.Renderer; +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.TextRenderer; +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.XMLRenderer; +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.util.Predicate; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.ExcludeViolationsFromFile; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException; +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils; +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a class="jxr_linenumber" name="L60" href="#L60">60</a> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Executes PMD with the configuration provided via {@link PmdRequest}.</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a> <strong class="jxr_keyword">extends</strong> <a name="Executor" href="../../../../../../org/apache/maven/plugins/pmd/exec/Executor.html#Executor">Executor</a> { +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(PmdExecutor.<strong class="jxr_keyword">class</strong>); +<a class="jxr_linenumber" name="L66" href="#L66">66</a> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="PmdResult" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdResult.html#PmdResult">PmdResult</a> execute(<a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a> request) <strong class="jxr_keyword">throws</strong> MavenReportException { +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">if</strong> (request.getJavaExecutable() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">return</strong> fork(request); +<a class="jxr_linenumber" name="L70" href="#L70">70</a> } +<a class="jxr_linenumber" name="L71" href="#L71">71</a> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_comment">// make sure the class loaders are correct and call this in the same JVM</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L75" href="#L75">75</a> Thread.currentThread().setContextClassLoader(PmdExecutor.<strong class="jxr_keyword">class</strong>.getClassLoader()); +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a> executor = <strong class="jxr_keyword">new</strong> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a>(request); +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">return</strong> executor.run(); +<a class="jxr_linenumber" name="L78" href="#L78">78</a> } <strong class="jxr_keyword">finally</strong> { +<a class="jxr_linenumber" name="L79" href="#L79">79</a> Thread.currentThread().setContextClassLoader(origLoader); +<a class="jxr_linenumber" name="L80" href="#L80">80</a> } +<a class="jxr_linenumber" name="L81" href="#L81">81</a> } +<a class="jxr_linenumber" name="L82" href="#L82">82</a> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a name="PmdResult" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdResult.html#PmdResult">PmdResult</a> fork(<a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a> request) <strong class="jxr_keyword">throws</strong> MavenReportException { +<a class="jxr_linenumber" name="L84" href="#L84">84</a> File basePmdDir = <strong class="jxr_keyword">new</strong> File(request.getTargetDirectory(), <span class="jxr_string">"pmd"</span>); +<a class="jxr_linenumber" name="L85" href="#L85">85</a> basePmdDir.mkdirs(); +<a class="jxr_linenumber" name="L86" href="#L86">86</a> File pmdRequestFile = <strong class="jxr_keyword">new</strong> File(basePmdDir, <span class="jxr_string">"pmdrequest.bin"</span>); +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">try</strong> (ObjectOutputStream out = <strong class="jxr_keyword">new</strong> ObjectOutputStream(<strong class="jxr_keyword">new</strong> FileOutputStream(pmdRequestFile))) { +<a class="jxr_linenumber" name="L88" href="#L88">88</a> out.writeObject(request); +<a class="jxr_linenumber" name="L89" href="#L89">89</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e); +<a class="jxr_linenumber" name="L91" href="#L91">91</a> } +<a class="jxr_linenumber" name="L92" href="#L92">92</a> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> String classpath = buildClasspath(); +<a class="jxr_linenumber" name="L94" href="#L94">94</a> ProcessBuilder pb = <strong class="jxr_keyword">new</strong> ProcessBuilder(); +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_comment">// note: using env variable instead of -cp cli arg to avoid length limitations under Windows</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> pb.environment().put(<span class="jxr_string">"CLASSPATH"</span>, classpath); +<a class="jxr_linenumber" name="L97" href="#L97">97</a> pb.command().add(request.getJavaExecutable()); +<a class="jxr_linenumber" name="L98" href="#L98">98</a> pb.command().add(PmdExecutor.<strong class="jxr_keyword">class</strong>.getName()); +<a class="jxr_linenumber" name="L99" href="#L99">99</a> pb.command().add(pmdRequestFile.getAbsolutePath()); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> LOG.debug(<span class="jxr_string">"Executing: CLASSPATH={}, command={}"</span>, classpath, pb.command()); +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">final</strong> Process p = pb.start(); +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_comment">// Note: can't use pb.inheritIO(), since System.out/System.err has been modified after process start</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_comment">// and inheritIO would only inherit file handles, not the changed streams.</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> ProcessStreamHandler.start(p.getInputStream(), System.out); +<a class="jxr_linenumber" name="L107" href="#L107">107</a> ProcessStreamHandler.start(p.getErrorStream(), System.err); +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">int</strong> exit = p.waitFor(); +<a class="jxr_linenumber" name="L109" href="#L109">109</a> LOG.debug(<span class="jxr_string">"PmdExecutor exit code: {}"</span>, exit); +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">if</strong> (exit != 0) { +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(<span class="jxr_string">"PmdExecutor exited with exit code "</span> + exit); +<a class="jxr_linenumber" name="L112" href="#L112">112</a> } +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="PmdResult" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdResult.html#PmdResult">PmdResult</a>(<strong class="jxr_keyword">new</strong> File(request.getTargetDirectory(), <span class="jxr_string">"pmd.xml"</span>), request.getOutputEncoding()); +<a class="jxr_linenumber" name="L114" href="#L114">114</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e); +<a class="jxr_linenumber" name="L116" href="#L116">116</a> } <strong class="jxr_keyword">catch</strong> (InterruptedException e) { +<a class="jxr_linenumber" name="L117" href="#L117">117</a> Thread.currentThread().interrupt(); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e); +<a class="jxr_linenumber" name="L119" href="#L119">119</a> } +<a class="jxr_linenumber" name="L120" href="#L120">120</a> } +<a class="jxr_linenumber" name="L121" href="#L121">121</a> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * Execute PMD analysis from CLI.</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * Single arg with the filename to the serialized {@link PmdRequest}.</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * Exit-code: 0 = success, 1 = failure in executing</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @param args</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> main(String[] args) { +<a class="jxr_linenumber" name="L134" href="#L134">134</a> File requestFile = <strong class="jxr_keyword">new</strong> File(args[0]); +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">try</strong> (ObjectInputStream in = <strong class="jxr_keyword">new</strong> ObjectInputStream(<strong class="jxr_keyword">new</strong> FileInputStream(requestFile))) { +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a> request = (<a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a>) in.readObject(); +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a> pmdExecutor = <strong class="jxr_keyword">new</strong> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a>(request); +<a class="jxr_linenumber" name="L138" href="#L138">138</a> pmdExecutor.setupLogLevel(request.getLogLevel()); +<a class="jxr_linenumber" name="L139" href="#L139">139</a> pmdExecutor.run(); +<a class="jxr_linenumber" name="L140" href="#L140">140</a> System.exit(0); +<a class="jxr_linenumber" name="L141" href="#L141">141</a> } <strong class="jxr_keyword">catch</strong> (IOException | ClassNotFoundException | MavenReportException e) { +<a class="jxr_linenumber" name="L142" href="#L142">142</a> LOG.error(e.getMessage(), e); +<a class="jxr_linenumber" name="L143" href="#L143">143</a> } +<a class="jxr_linenumber" name="L144" href="#L144">144</a> System.exit(1); +<a class="jxr_linenumber" name="L145" href="#L145">145</a> } +<a class="jxr_linenumber" name="L146" href="#L146">146</a> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a> request; +<a class="jxr_linenumber" name="L148" href="#L148">148</a> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">public</strong> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a>(<a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a> request) { +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">this</strong>.request = Objects.requireNonNull(request); +<a class="jxr_linenumber" name="L151" href="#L151">151</a> } +<a class="jxr_linenumber" name="L152" href="#L152">152</a> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">private</strong> <a name="PmdResult" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdResult.html#PmdResult">PmdResult</a> run() <strong class="jxr_keyword">throws</strong> MavenReportException { +<a class="jxr_linenumber" name="L154" href="#L154">154</a> setupPmdLogging(request.isShowPmdLog(), request.getLogLevel()); +<a class="jxr_linenumber" name="L155" href="#L155">155</a> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> PMDConfiguration configuration = <strong class="jxr_keyword">new</strong> PMDConfiguration(); +<a class="jxr_linenumber" name="L157" href="#L157">157</a> LanguageVersion languageVersion = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L158" href="#L158">158</a> Language language = LanguageRegistry.findLanguageByTerseName( +<a class="jxr_linenumber" name="L159" href="#L159">159</a> request.getLanguage() != <strong class="jxr_keyword">null</strong> ? request.getLanguage() : <span class="jxr_string">"java"</span>); +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">if</strong> (language == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(<span class="jxr_string">"Unsupported language: "</span> + request.getLanguage()); <a class="jxr_linenumber" name="L162" href="#L162">162</a> } -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">catch</strong> ( IOException | ClassNotFoundException | MavenReportException e ) -<a class="jxr_linenumber" name="L164" href="#L164">164</a> { -<a class="jxr_linenumber" name="L165" href="#L165">165</a> LOG.error( e.getMessage(), e ); -<a class="jxr_linenumber" name="L166" href="#L166">166</a> } -<a class="jxr_linenumber" name="L167" href="#L167">167</a> System.exit( 1 ); -<a class="jxr_linenumber" name="L168" href="#L168">168</a> } -<a class="jxr_linenumber" name="L169" href="#L169">169</a> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a> request; -<a class="jxr_linenumber" name="L171" href="#L171">171</a> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">public</strong> <a name="PmdExecutor" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdExecutor.html#PmdExecutor">PmdExecutor</a>( <a name="PmdRequest" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdRequest.html#PmdRequest">PmdRequest</a> request ) -<a class="jxr_linenumber" name="L173" href="#L173">173</a> { -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">this</strong>.request = Objects.requireNonNull( request ); -<a class="jxr_linenumber" name="L175" href="#L175">175</a> } -<a class="jxr_linenumber" name="L176" href="#L176">176</a> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">private</strong> <a name="PmdResult" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdResult.html#PmdResult">PmdResult</a> run() <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L178" href="#L178">178</a> { -<a class="jxr_linenumber" name="L179" href="#L179">179</a> setupPmdLogging( request.isShowPmdLog(), request.getLogLevel() ); -<a class="jxr_linenumber" name="L180" href="#L180">180</a> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> PMDConfiguration configuration = <strong class="jxr_keyword">new</strong> PMDConfiguration(); -<a class="jxr_linenumber" name="L182" href="#L182">182</a> LanguageVersion languageVersion = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L183" href="#L183">183</a> Language language = LanguageRegistry -<a class="jxr_linenumber" name="L184" href="#L184">184</a> .findLanguageByTerseName( request.getLanguage() != <strong class="jxr_keyword">null</strong> ? request.getLanguage() : <span class="jxr_string">"java"</span> ); -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">if</strong> ( language == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L186" href="#L186">186</a> { -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unsupported language: "</span> + request.getLanguage() ); +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">if</strong> (request.getLanguageVersion() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L164" href="#L164">164</a> languageVersion = language.getVersion(request.getLanguageVersion()); +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">if</strong> (languageVersion == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(<span class="jxr_string">"Unsupported targetJdk value '"</span> + request.getLanguageVersion() + <span class="jxr_string">"'."</span>); +<a class="jxr_linenumber" name="L167" href="#L167">167</a> } +<a class="jxr_linenumber" name="L168" href="#L168">168</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L169" href="#L169">169</a> languageVersion = language.getDefaultVersion(); +<a class="jxr_linenumber" name="L170" href="#L170">170</a> } +<a class="jxr_linenumber" name="L171" href="#L171">171</a> LOG.debug(<span class="jxr_string">"Using language "</span> + languageVersion); +<a class="jxr_linenumber" name="L172" href="#L172">172</a> configuration.setDefaultLanguageVersion(languageVersion); +<a class="jxr_linenumber" name="L173" href="#L173">173</a> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">if</strong> (request.getSourceEncoding() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L175" href="#L175">175</a> configuration.setSourceEncoding(request.getSourceEncoding()); +<a class="jxr_linenumber" name="L176" href="#L176">176</a> } +<a class="jxr_linenumber" name="L177" href="#L177">177</a> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> configuration.prependAuxClasspath(request.getAuxClasspath()); +<a class="jxr_linenumber" name="L179" href="#L179">179</a> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">if</strong> (request.getSuppressMarker() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L181" href="#L181">181</a> configuration.setSuppressMarker(request.getSuppressMarker()); +<a class="jxr_linenumber" name="L182" href="#L182">182</a> } +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">if</strong> (request.getAnalysisCacheLocation() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L184" href="#L184">184</a> configuration.setAnalysisCacheLocation(request.getAnalysisCacheLocation()); +<a class="jxr_linenumber" name="L185" href="#L185">185</a> LOG.debug(<span class="jxr_string">"Using analysis cache location: "</span> + request.getAnalysisCacheLocation()); +<a class="jxr_linenumber" name="L186" href="#L186">186</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L187" href="#L187">187</a> configuration.setIgnoreIncrementalAnalysis(<strong class="jxr_keyword">true</strong>); <a class="jxr_linenumber" name="L188" href="#L188">188</a> } -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">if</strong> ( request.getLanguageVersion() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L190" href="#L190">190</a> { -<a class="jxr_linenumber" name="L191" href="#L191">191</a> languageVersion = language.getVersion( request.getLanguageVersion() ); -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> ( languageVersion == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L193" href="#L193">193</a> { -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unsupported targetJdk value '"</span> + request.getLanguageVersion() + <span class="jxr_string">"'."</span> ); -<a class="jxr_linenumber" name="L195" href="#L195">195</a> } -<a class="jxr_linenumber" name="L196" href="#L196">196</a> } -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> { -<a class="jxr_linenumber" name="L199" href="#L199">199</a> languageVersion = language.getDefaultVersion(); -<a class="jxr_linenumber" name="L200" href="#L200">200</a> } -<a class="jxr_linenumber" name="L201" href="#L201">201</a> LOG.debug( <span class="jxr_string">"Using language "</span> + languageVersion ); -<a class="jxr_linenumber" name="L202" href="#L202">202</a> configuration.setDefaultLanguageVersion( languageVersion ); -<a class="jxr_linenumber" name="L203" href="#L203">203</a> -<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">if</strong> ( request.getSourceEncoding() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L205" href="#L205">205</a> { -<a class="jxr_linenumber" name="L206" href="#L206">206</a> configuration.setSourceEncoding( request.getSourceEncoding() ); -<a class="jxr_linenumber" name="L207" href="#L207">207</a> } -<a class="jxr_linenumber" name="L208" href="#L208">208</a> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> configuration.prependAuxClasspath( request.getAuxClasspath() ); -<a class="jxr_linenumber" name="L210" href="#L210">210</a> -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">if</strong> ( request.getSuppressMarker() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L212" href="#L212">212</a> { -<a class="jxr_linenumber" name="L213" href="#L213">213</a> configuration.setSuppressMarker( request.getSuppressMarker() ); -<a class="jxr_linenumber" name="L214" href="#L214">214</a> } -<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">if</strong> ( request.getAnalysisCacheLocation() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L216" href="#L216">216</a> { -<a class="jxr_linenumber" name="L217" href="#L217">217</a> configuration.setAnalysisCacheLocation( request.getAnalysisCacheLocation() ); -<a class="jxr_linenumber" name="L218" href="#L218">218</a> LOG.debug( <span class="jxr_string">"Using analysis cache location: "</span> + request.getAnalysisCacheLocation() ); -<a class="jxr_linenumber" name="L219" href="#L219">219</a> } -<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> { -<a class="jxr_linenumber" name="L222" href="#L222">222</a> configuration.setIgnoreIncrementalAnalysis( <strong class="jxr_keyword">true</strong> ); -<a class="jxr_linenumber" name="L223" href="#L223">223</a> } -<a class="jxr_linenumber" name="L224" href="#L224">224</a> -<a class="jxr_linenumber" name="L225" href="#L225">225</a> configuration.setRuleSets( request.getRulesets() ); -<a class="jxr_linenumber" name="L226" href="#L226">226</a> configuration.setMinimumPriority( RulePriority.valueOf( request.getMinimumPriority() ) ); -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">if</strong> ( request.getBenchmarkOutputLocation() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L228" href="#L228">228</a> { -<a class="jxr_linenumber" name="L229" href="#L229">229</a> configuration.setBenchmark( <strong class="jxr_keyword">true</strong> ); -<a class="jxr_linenumber" name="L230" href="#L230">230</a> } -<a class="jxr_linenumber" name="L231" href="#L231">231</a> List<File> files = request.getFiles(); -<a class="jxr_linenumber" name="L232" href="#L232">232</a> -<a class="jxr_linenumber" name="L233" href="#L233">233</a> Report report = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L234" href="#L234">234</a> -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">if</strong> ( request.getRulesets().isEmpty() ) -<a class="jxr_linenumber" name="L236" href="#L236">236</a> { -<a class="jxr_linenumber" name="L237" href="#L237">237</a> LOG.debug( <span class="jxr_string">"Skipping PMD execution as no rulesets are defined."</span> ); -<a class="jxr_linenumber" name="L238" href="#L238">238</a> } -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L240" href="#L240">240</a> { -<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">if</strong> ( request.getBenchmarkOutputLocation() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L242" href="#L242">242</a> { -<a class="jxr_linenumber" name="L243" href="#L243">243</a> TimeTracker.startGlobalTracking(); -<a class="jxr_linenumber" name="L244" href="#L244">244</a> } -<a class="jxr_linenumber" name="L245" href="#L245">245</a> -<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L247" href="#L247">247</a> { -<a class="jxr_linenumber" name="L248" href="#L248">248</a> report = processFilesWithPMD( configuration, files ); -<a class="jxr_linenumber" name="L249" href="#L249">249</a> } -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">finally</strong> -<a class="jxr_linenumber" name="L251" href="#L251">251</a> { -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">if</strong> ( request.getAuxClasspath() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L253" href="#L253">253</a> { -<a class="jxr_linenumber" name="L254" href="#L254">254</a> ClassLoader classLoader = configuration.getClassLoader(); -<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">if</strong> ( classLoader instanceof Closeable ) -<a class="jxr_linenumber" name="L256" href="#L256">256</a> { -<a class="jxr_linenumber" name="L257" href="#L257">257</a> Closeable closeable = (Closeable) classLoader; -<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L259" href="#L259">259</a> { -<a class="jxr_linenumber" name="L260" href="#L260">260</a> closeable.close(); -<a class="jxr_linenumber" name="L261" href="#L261">261</a> } -<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">catch</strong> ( IOException ex ) -<a class="jxr_linenumber" name="L263" href="#L263">263</a> { -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_comment">// ignore</em> -<a class="jxr_linenumber" name="L265" href="#L265">265</a> } -<a class="jxr_linenumber" name="L266" href="#L266">266</a> } -<a class="jxr_linenumber" name="L267" href="#L267">267</a> } -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">if</strong> ( request.getBenchmarkOutputLocation() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L269" href="#L269">269</a> { -<a class="jxr_linenumber" name="L270" href="#L270">270</a> TimingReport timingReport = TimeTracker.stopGlobalTracking(); -<a class="jxr_linenumber" name="L271" href="#L271">271</a> writeBenchmarkReport( timingReport, request.getBenchmarkOutputLocation(), -<a class="jxr_linenumber" name="L272" href="#L272">272</a> request.getOutputEncoding() ); -<a class="jxr_linenumber" name="L273" href="#L273">273</a> } -<a class="jxr_linenumber" name="L274" href="#L274">274</a> } -<a class="jxr_linenumber" name="L275" href="#L275">275</a> } -<a class="jxr_linenumber" name="L276" href="#L276">276</a> -<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">if</strong> ( report != <strong class="jxr_keyword">null</strong> && !report.getProcessingErrors().isEmpty() ) -<a class="jxr_linenumber" name="L278" href="#L278">278</a> { -<a class="jxr_linenumber" name="L279" href="#L279">279</a> List<Report.ProcessingError> errors = report.getProcessingErrors(); -<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">if</strong> ( !request.isSkipPmdError() ) -<a class="jxr_linenumber" name="L281" href="#L281">281</a> { -<a class="jxr_linenumber" name="L282" href="#L282">282</a> LOG.error( <span class="jxr_string">"PMD processing errors:"</span> ); -<a class="jxr_linenumber" name="L283" href="#L283">283</a> LOG.error( getErrorsAsString( errors, request.isDebugEnabled() ) ); -<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Found "</span> + errors.size() -<a class="jxr_linenumber" name="L285" href="#L285">285</a> + <span class="jxr_string">" PMD processing errors"</span> ); -<a class="jxr_linenumber" name="L286" href="#L286">286</a> } -<a class="jxr_linenumber" name="L287" href="#L287">287</a> LOG.warn( <span class="jxr_string">"There are {} PMD processing errors:"</span>, errors.size() ); -<a class="jxr_linenumber" name="L288" href="#L288">288</a> LOG.warn( getErrorsAsString( errors, request.isDebugEnabled() ) ); -<a class="jxr_linenumber" name="L289" href="#L289">289</a> } -<a class="jxr_linenumber" name="L290" href="#L290">290</a> -<a class="jxr_linenumber" name="L291" href="#L291">291</a> report = removeExcludedViolations( report ); -<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_comment">// always write XML report, as this might be needed by the check mojo</em> -<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_comment">// we need to output it even if the file list is empty or we have no violations</em> -<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_comment">// so the "check" goals can check for violations</em> -<a class="jxr_linenumber" name="L295" href="#L295">295</a> writeXmlReport( report ); -<a class="jxr_linenumber" name="L296" href="#L296">296</a> -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_comment">// write any other format except for xml and html. xml has just been produced.</em> -<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_comment">// html format is produced by the maven site formatter. Excluding html here</em> -<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_comment">// avoids using PMD's own html formatter, which doesn't fit into the maven site</em> -<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_comment">// considering the html/css styling</em> -<a class="jxr_linenumber" name="L301" href="#L301">301</a> String format = request.getFormat(); -<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">if</strong> ( !<span class="jxr_string">"html"</span>.equals( format ) && !<span class="jxr_string">"xml"</span>.equals( format ) ) -<a class="jxr_linenumber" name="L303" href="#L303">303</a> { -<a class="jxr_linenumber" name="L304" href="#L304">304</a> writeFormattedReport( report ); -<a class="jxr_linenumber" name="L305" href="#L305">305</a> } -<a class="jxr_linenumber" name="L306" href="#L306">306</a> -<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="PmdResult" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdResult.html#PmdResult">PmdResult</a>( <strong class="jxr_keyword">new</strong> File( request.getTargetDirectory(), <span class="jxr_string">"pmd.xml"</span> ), request.getOutputEncoding() ); -<a class="jxr_linenumber" name="L308" href="#L308">308</a> } -<a class="jxr_linenumber" name="L309" href="#L309">309</a> -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * Gets the errors as a single string. Each error is in its own line.</em> -<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * @param withDetails if <code>true</code> then add the error details additionally (contains e.g. the stacktrace)</em> -<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * @return the errors as string</em> -<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">private</strong> String getErrorsAsString( List<Report.ProcessingError> errors, <strong class="jxr_keyword">boolean</strong> withDetails ) -<a class="jxr_linenumber" name="L316" href="#L316">316</a> { -<a class="jxr_linenumber" name="L317" href="#L317">317</a> List<String> errorsAsString = <strong class="jxr_keyword">new</strong> ArrayList<>( errors.size() ); -<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">for</strong> ( Report.ProcessingError error : errors ) -<a class="jxr_linenumber" name="L319" href="#L319">319</a> { -<a class="jxr_linenumber" name="L320" href="#L320">320</a> errorsAsString.add( error.getFile() + <span class="jxr_string">": "</span> + error.getMsg() ); -<a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong class="jxr_keyword">if</strong> ( withDetails ) -<a class="jxr_linenumber" name="L322" href="#L322">322</a> { -<a class="jxr_linenumber" name="L323" href="#L323">323</a> errorsAsString.add( error.getDetail() ); -<a class="jxr_linenumber" name="L324" href="#L324">324</a> } -<a class="jxr_linenumber" name="L325" href="#L325">325</a> } -<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">return</strong> String.join( System.lineSeparator(), errorsAsString ); -<a class="jxr_linenumber" name="L327" href="#L327">327</a> } -<a class="jxr_linenumber" name="L328" href="#L328">328</a> -<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeBenchmarkReport( TimingReport timingReport, String benchmarkOutputLocation, String encoding ) -<a class="jxr_linenumber" name="L330" href="#L330">330</a> { -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">try</strong> ( Writer writer = <strong class="jxr_keyword">new</strong> OutputStreamWriter( <strong class="jxr_keyword">new</strong> FileOutputStream( benchmarkOutputLocation ), encoding ) ) -<a class="jxr_linenumber" name="L332" href="#L332">332</a> { -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">final</strong> TimingReportRenderer renderer = <strong class="jxr_keyword">new</strong> TextTimingReportRenderer(); -<a class="jxr_linenumber" name="L334" href="#L334">334</a> renderer.render( timingReport, writer ); +<a class="jxr_linenumber" name="L189" href="#L189">189</a> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> configuration.setRuleSets(request.getRulesets()); +<a class="jxr_linenumber" name="L191" href="#L191">191</a> configuration.setMinimumPriority(RulePriority.valueOf(request.getMinimumPriority())); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (request.getBenchmarkOutputLocation() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L193" href="#L193">193</a> configuration.setBenchmark(<strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L194" href="#L194">194</a> } +<a class="jxr_linenumber" name="L195" href="#L195">195</a> List<File> files = request.getFiles(); +<a class="jxr_linenumber" name="L196" href="#L196">196</a> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> Report report = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L198" href="#L198">198</a> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">if</strong> (request.getRulesets().isEmpty()) { +<a class="jxr_linenumber" name="L200" href="#L200">200</a> LOG.debug(<span class="jxr_string">"Skipping PMD execution as no rulesets are defined."</span>); +<a class="jxr_linenumber" name="L201" href="#L201">201</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">if</strong> (request.getBenchmarkOutputLocation() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L203" href="#L203">203</a> TimeTracker.startGlobalTracking(); +<a class="jxr_linenumber" name="L204" href="#L204">204</a> } +<a class="jxr_linenumber" name="L205" href="#L205">205</a> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L207" href="#L207">207</a> report = processFilesWithPMD(configuration, files); +<a class="jxr_linenumber" name="L208" href="#L208">208</a> } <strong class="jxr_keyword">finally</strong> { +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">if</strong> (request.getAuxClasspath() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L210" href="#L210">210</a> ClassLoader classLoader = configuration.getClassLoader(); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">if</strong> (classLoader instanceof Closeable) { +<a class="jxr_linenumber" name="L212" href="#L212">212</a> Closeable closeable = (Closeable) classLoader; +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L214" href="#L214">214</a> closeable.close(); +<a class="jxr_linenumber" name="L215" href="#L215">215</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) { +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_comment">// ignore</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> } +<a class="jxr_linenumber" name="L218" href="#L218">218</a> } +<a class="jxr_linenumber" name="L219" href="#L219">219</a> } +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">if</strong> (request.getBenchmarkOutputLocation() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L221" href="#L221">221</a> TimingReport timingReport = TimeTracker.stopGlobalTracking(); +<a class="jxr_linenumber" name="L222" href="#L222">222</a> writeBenchmarkReport( +<a class="jxr_linenumber" name="L223" href="#L223">223</a> timingReport, request.getBenchmarkOutputLocation(), request.getOutputEncoding()); +<a class="jxr_linenumber" name="L224" href="#L224">224</a> } +<a class="jxr_linenumber" name="L225" href="#L225">225</a> } +<a class="jxr_linenumber" name="L226" href="#L226">226</a> } +<a class="jxr_linenumber" name="L227" href="#L227">227</a> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">if</strong> (report != <strong class="jxr_keyword">null</strong> && !report.getProcessingErrors().isEmpty()) { +<a class="jxr_linenumber" name="L229" href="#L229">229</a> List<Report.ProcessingError> errors = report.getProcessingErrors(); +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">if</strong> (!request.isSkipPmdError()) { +<a class="jxr_linenumber" name="L231" href="#L231">231</a> LOG.error(<span class="jxr_string">"PMD processing errors:"</span>); +<a class="jxr_linenumber" name="L232" href="#L232">232</a> LOG.error(getErrorsAsString(errors, request.isDebugEnabled())); +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(<span class="jxr_string">"Found "</span> + errors.size() + <span class="jxr_string">" PMD processing errors"</span>); +<a class="jxr_linenumber" name="L234" href="#L234">234</a> } +<a class="jxr_linenumber" name="L235" href="#L235">235</a> LOG.warn(<span class="jxr_string">"There are {} PMD processing errors:"</span>, errors.size()); +<a class="jxr_linenumber" name="L236" href="#L236">236</a> LOG.warn(getErrorsAsString(errors, request.isDebugEnabled())); +<a class="jxr_linenumber" name="L237" href="#L237">237</a> } +<a class="jxr_linenumber" name="L238" href="#L238">238</a> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> report = removeExcludedViolations(report); +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_comment">// always write XML report, as this might be needed by the check mojo</em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_comment">// we need to output it even if the file list is empty or we have no violations</em> +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_comment">// so the "check" goals can check for violations</em> +<a class="jxr_linenumber" name="L243" href="#L243">243</a> writeXmlReport(report); +<a class="jxr_linenumber" name="L244" href="#L244">244</a> +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_comment">// write any other format except for xml and html. xml has just been produced.</em> +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_comment">// html format is produced by the maven site formatter. Excluding html here</em> +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_comment">// avoids using PMD's own html formatter, which doesn't fit into the maven site</em> +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_comment">// considering the html/css styling</em> +<a class="jxr_linenumber" name="L249" href="#L249">249</a> String format = request.getFormat(); +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">if</strong> (!<span class="jxr_string">"html"</span>.equals(format) && !<span class="jxr_string">"xml"</span>.equals(format)) { +<a class="jxr_linenumber" name="L251" href="#L251">251</a> writeFormattedReport(report); +<a class="jxr_linenumber" name="L252" href="#L252">252</a> } +<a class="jxr_linenumber" name="L253" href="#L253">253</a> +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="PmdResult" href="../../../../../../org/apache/maven/plugins/pmd/exec/PmdResult.html#PmdResult">PmdResult</a>(<strong class="jxr_keyword">new</strong> File(request.getTargetDirectory(), <span class="jxr_string">"pmd.xml"</span>), request.getOutputEncoding()); +<a class="jxr_linenumber" name="L255" href="#L255">255</a> } +<a class="jxr_linenumber" name="L256" href="#L256">256</a> +<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * Gets the errors as a single string. Each error is in its own line.</em> +<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * @param withDetails if <code>true</code> then add the error details additionally (contains e.g. the stacktrace)</em> +<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * @return the errors as string</em> +<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">private</strong> String getErrorsAsString(List<Report.ProcessingError> errors, <strong class="jxr_keyword">boolean</strong> withDetails) { +<a class="jxr_linenumber" name="L263" href="#L263">263</a> List<String> errorsAsString = <strong class="jxr_keyword">new</strong> ArrayList<>(errors.size()); +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">for</strong> (Report.ProcessingError error : errors) { +<a class="jxr_linenumber" name="L265" href="#L265">265</a> errorsAsString.add(error.getFile() + <span class="jxr_string">": "</span> + error.getMsg()); +<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">if</strong> (withDetails) { +<a class="jxr_linenumber" name="L267" href="#L267">267</a> errorsAsString.add(error.getDetail()); +<a class="jxr_linenumber" name="L268" href="#L268">268</a> } +<a class="jxr_linenumber" name="L269" href="#L269">269</a> } +<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">return</strong> String.join(System.lineSeparator(), errorsAsString); +<a class="jxr_linenumber" name="L271" href="#L271">271</a> } +<a class="jxr_linenumber" name="L272" href="#L272">272</a> +<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeBenchmarkReport(TimingReport timingReport, String benchmarkOutputLocation, String encoding) { +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">try</strong> (Writer writer = <strong class="jxr_keyword">new</strong> OutputStreamWriter(<strong class="jxr_keyword">new</strong> FileOutputStream(benchmarkOutputLocation), encoding)) { +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">final</strong> TimingReportRenderer renderer = <strong class="jxr_keyword">new</strong> TextTimingReportRenderer(); +<a class="jxr_linenumber" name="L276" href="#L276">276</a> renderer.render(timingReport, writer); +<a class="jxr_linenumber" name="L277" href="#L277">277</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L278" href="#L278">278</a> LOG.error(<span class="jxr_string">"Unable to generate benchmark file: {}"</span>, benchmarkOutputLocation, e); +<a class="jxr_linenumber" name="L279" href="#L279">279</a> } +<a class="jxr_linenumber" name="L280" href="#L280">280</a> } +<a class="jxr_linenumber" name="L281" href="#L281">281</a> +<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">private</strong> Report processFilesWithPMD(PMDConfiguration pmdConfiguration, List<File> files) +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">throws</strong> MavenReportException { +<a class="jxr_linenumber" name="L284" href="#L284">284</a> Report report = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L285" href="#L285">285</a> RuleSetLoader rulesetLoader = +<a class="jxr_linenumber" name="L286" href="#L286">286</a> RuleSetLoader.fromPmdConfig(pmdConfiguration).warnDeprecated(<strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_comment">// load the ruleset once to log out any deprecated rules as warnings</em> +<a class="jxr_linenumber" name="L289" href="#L289">289</a> rulesetLoader.loadFromResources(pmdConfiguration.getRuleSetPaths()); +<a class="jxr_linenumber" name="L290" href="#L290">290</a> } <strong class="jxr_keyword">catch</strong> (RuleSetLoadException e1) { +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(<span class="jxr_string">"The ruleset could not be loaded"</span>, e1); +<a class="jxr_linenumber" name="L292" href="#L292">292</a> } +<a class="jxr_linenumber" name="L293" href="#L293">293</a> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">try</strong> (PmdAnalysis pmdAnalysis = PmdAnalysis.create(pmdConfiguration)) { +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">for</strong> (File file : files) { +<a class="jxr_linenumber" name="L296" href="#L296">296</a> pmdAnalysis.files().addFile(file.toPath()); +<a class="jxr_linenumber" name="L297" href="#L297">297</a> } +<a class="jxr_linenumber" name="L298" href="#L298">298</a> LOG.debug(<span class="jxr_string">"Executing PMD..."</span>); +<a class="jxr_linenumber" name="L299" href="#L299">299</a> report = pmdAnalysis.performAnalysisAndCollectReport(); +<a class="jxr_linenumber" name="L300" href="#L300">300</a> LOG.debug( +<a class="jxr_linenumber" name="L301" href="#L301">301</a> <span class="jxr_string">"PMD finished. Found {} violations."</span>, report.getViolations().size()); +<a class="jxr_linenumber" name="L302" href="#L302">302</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { +<a class="jxr_linenumber" name="L303" href="#L303">303</a> String message = <span class="jxr_string">"Failure executing PMD: "</span> + e.getLocalizedMessage(); +<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">if</strong> (!request.isSkipPmdError()) { +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(message, e); +<a class="jxr_linenumber" name="L306" href="#L306">306</a> } +<a class="jxr_linenumber" name="L307" href="#L307">307</a> LOG.warn(message, e); +<a class="jxr_linenumber" name="L308" href="#L308">308</a> } +<a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">return</strong> report; +<a class="jxr_linenumber" name="L310" href="#L310">310</a> } +<a class="jxr_linenumber" name="L311" href="#L311">311</a> +<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * Use the PMD XML renderer to create the XML report format used by the</em> +<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * check mojo later on.</em> +<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * @param report</em> +<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * @throws MavenReportException</em> +<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeXmlReport(Report report) <strong class="jxr_keyword">throws</strong> MavenReportException { +<a class="jxr_linenumber" name="L320" href="#L320">320</a> File targetFile = writeReport(report, <strong class="jxr_keyword">new</strong> XMLRenderer(request.getOutputEncoding())); +<a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong class="jxr_keyword">if</strong> (request.isIncludeXmlInSite()) { +<a class="jxr_linenumber" name="L322" href="#L322">322</a> File siteDir = <strong class="jxr_keyword">new</strong> File(request.getReportOutputDirectory()); +<a class="jxr_linenumber" name="L323" href="#L323">323</a> siteDir.mkdirs(); +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L325" href="#L325">325</a> FileUtils.copyFile(targetFile, <strong class="jxr_keyword">new</strong> File(siteDir, <span class="jxr_string">"pmd.xml"</span>)); +<a class="jxr_linenumber" name="L326" href="#L326">326</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e); +<a class="jxr_linenumber" name="L328" href="#L328">328</a> } +<a class="jxr_linenumber" name="L329" href="#L329">329</a> }
[... 294 lines stripped ...]
