blob: c8fee6c66773132f11a24a30439d1d81a01b7acd [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="" lang="">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>RatCheckMojoTest xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../testapidocs/org/apache/rat/mp/RatCheckMojoTest.html">View Javadoc</a></div><pre>
<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 or more</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</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="L10" href="#L10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.rat.mp;
<a class="jxr_linenumber" name="L18" href="#L18">18</a>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> java.lang.String.format;
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> java.nio.charset.StandardCharsets.UTF_8;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.apache.rat.mp.RatTestHelpers.ensureRatReportIsCorrect;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.assertj.core.api.Assertions.assertThat;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.assertj.core.api.Fail.fail;
<a class="jxr_linenumber" name="L24" href="#L24">24</a>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="L26" href="#L26">26</a>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.nio.file.Files;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.nio.file.Path;
<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.Arrays;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> javax.xml.xpath.XPath;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> javax.xml.xpath.XPathFactory;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.commons.io.FileUtils;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.rat.ReportConfiguration;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.rat.ReportConfigurationTest;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.rat.ReporterTestUtils;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.rat.api.Document;
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.rat.commandline.Arg;
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.rat.license.ILicenseFamily;
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.rat.license.LicenseSetFactory;
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.rat.license.LicenseSetFactory.LicenseFilter;
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.claim.ClaimStatistic;
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.apache.rat.test.AbstractConfigurationOptionsProvider;
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> org.apache.rat.test.utils.Resources;
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> org.apache.rat.testhelpers.TextUtils;
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> org.apache.rat.testhelpers.XmlUtils;
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> org.junit.jupiter.api.AfterAll;
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> org.junit.jupiter.api.Assertions;
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> org.junit.jupiter.api.Test;
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> org.junit.jupiter.api.condition.EnabledOnOs;
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> org.junit.jupiter.api.condition.OS;
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> org.junit.jupiter.api.io.TempDir;
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NamedNodeMap;
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList;
<a class="jxr_linenumber" name="L59" href="#L59">59</a>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Test case for the {@link RatCheckMojo} and {@link RatReportMojo}.</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="RatCheckMojoTest" href="../../../../org/apache/rat/mp/RatCheckMojoTest.html#RatCheckMojoTest">RatCheckMojoTest</a> {
<a class="jxr_linenumber" name="L64" href="#L64">64</a>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> @TempDir
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">static</strong> Path tempDir;
<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">final</strong> <strong class="jxr_keyword">static</strong> XPath xPath = XPathFactory.newInstance().newXPath();
<a class="jxr_linenumber" name="L69" href="#L69">69</a>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> @AfterAll
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> preserveData() {
<a class="jxr_linenumber" name="L72" href="#L72">72</a> AbstractConfigurationOptionsProvider.preserveData(tempDir.toFile(), <span class="jxr_string">"unit"</span>);
<a class="jxr_linenumber" name="L73" href="#L73">73</a> }
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> @AfterAll
<a class="jxr_linenumber" name="L76" href="#L76">76</a> @EnabledOnOs(OS.WINDOWS)
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> cleanup() {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> System.gc(); <em class="jxr_comment">// hacky workaround for windows bug.</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
<a class="jxr_linenumber" name="L80" href="#L80">80</a>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> RatCheckMojo getMojo(File pomFile) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">final</strong> RatCheckMojo mojo = <strong class="jxr_keyword">new</strong> OptionMojoTest.SimpleMojoTestcase() {
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }.getMojo(pomFile);
<a class="jxr_linenumber" name="L85" href="#L85">85</a> Assertions.assertNotNull(mojo);
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">return</strong> mojo;
<a class="jxr_linenumber" name="L87" href="#L87">87</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">throw</strong> e;
<a class="jxr_linenumber" name="L89" href="#L89">89</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(format(<span class="jxr_string">"Unable to generate mojo for %s"</span>, pomFile), 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>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * Creates a new instance of {@link AbstractRatMojo}.</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @param testDir The directory, where to look for a pom.xml file.</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * copy location.</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @return The configured Mojo.</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * @throws Exception An error occurred while creating the Mojo.</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">private</strong> RatCheckMojo newRatMojo(String testDir) <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L103" href="#L103">103</a> Arg.reset();
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">final</strong> File sourceDir = Resources.getResourceDirectory(format(<span class="jxr_string">"unit/%s"</span>, testDir));
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">final</strong> File baseDir = tempDir.resolve(testDir).toFile();
<a class="jxr_linenumber" name="L106" href="#L106">106</a> FileUtils.copyDirectory(sourceDir, baseDir);
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">final</strong> File pomFile = <strong class="jxr_keyword">new</strong> File(baseDir, <span class="jxr_string">"pom.xml"</span>);
<a class="jxr_linenumber" name="L108" href="#L108">108</a> RatCheckMojo mojo = getMojo(pomFile);
<a class="jxr_linenumber" name="L109" href="#L109">109</a> assertThat(mojo).isNotNull();
<a class="jxr_linenumber" name="L110" href="#L110">110</a> assertThat(mojo.getProject())
<a class="jxr_linenumber" name="L111" href="#L111">111</a> .as(<span class="jxr_string">"The mojo is missing its MavenProject, which will result in an NPE during RAT runs."</span>)
<a class="jxr_linenumber" name="L112" href="#L112">112</a> .isNotNull();
<a class="jxr_linenumber" name="L113" href="#L113">113</a>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> File buildDirectory = <strong class="jxr_keyword">new</strong> File(baseDir, <span class="jxr_string">"target"</span>);
<a class="jxr_linenumber" name="L115" href="#L115">115</a> assertThat(buildDirectory.mkdirs()).isTrue();
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">final</strong> File ratTxtFile = <strong class="jxr_keyword">new</strong> File(buildDirectory, <span class="jxr_string">"rat.txt"</span>);
<a class="jxr_linenumber" name="L117" href="#L117">117</a> FileUtils.write(ratTxtFile, <span class="jxr_string">""</span>, UTF_8); <em class="jxr_comment">// Ensure the output file exists and is empty (rerunning the test will append)</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> mojo.setOutputFile(ratTxtFile.getAbsolutePath());
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">return</strong> mojo;
<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"> * Runs a check, which should expose no problems.</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"> * @throws Exception The test failed.</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> @Test
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">void</strong> it1() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">final</strong> RatCheckMojo mojo = newRatMojo(<span class="jxr_string">"it1"</span>);
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">final</strong> File ratTxtFile = mojo.getRatTxtFile();
<a class="jxr_linenumber" name="L131" href="#L131">131</a>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> ReportConfiguration config = mojo.getConfiguration();
<a class="jxr_linenumber" name="L133" href="#L133">133</a> ReportConfigurationTest.validateDefault(config);
<a class="jxr_linenumber" name="L134" href="#L134">134</a>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> mojo.execute();
<a class="jxr_linenumber" name="L136" href="#L136">136</a> Map&lt;ClaimStatistic.Counter, String&gt; data = <strong class="jxr_keyword">new</strong> HashMap&lt;&gt;();
<a class="jxr_linenumber" name="L137" href="#L137">137</a> data.put(ClaimStatistic.Counter.ARCHIVES, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L138" href="#L138">138</a> data.put(ClaimStatistic.Counter.APPROVED, <span class="jxr_string">"1"</span>);
<a class="jxr_linenumber" name="L139" href="#L139">139</a> data.put(ClaimStatistic.Counter.BINARIES, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L140" href="#L140">140</a> data.put(ClaimStatistic.Counter.DOCUMENT_TYPES, <span class="jxr_string">"2"</span>);
<a class="jxr_linenumber" name="L141" href="#L141">141</a> data.put(ClaimStatistic.Counter.IGNORED, <span class="jxr_string">"2"</span>);
<a class="jxr_linenumber" name="L142" href="#L142">142</a> data.put(ClaimStatistic.Counter.LICENSE_CATEGORIES, <span class="jxr_string">"1"</span>);
<a class="jxr_linenumber" name="L143" href="#L143">143</a> data.put(ClaimStatistic.Counter.LICENSE_NAMES, <span class="jxr_string">"1"</span>);
<a class="jxr_linenumber" name="L144" href="#L144">144</a> data.put(ClaimStatistic.Counter.NOTICES, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L145" href="#L145">145</a> data.put(ClaimStatistic.Counter.STANDARDS, <span class="jxr_string">"1"</span>);
<a class="jxr_linenumber" name="L146" href="#L146">146</a> data.put(ClaimStatistic.Counter.UNAPPROVED, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L147" href="#L147">147</a> data.put(ClaimStatistic.Counter.UNKNOWN, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L148" href="#L148">148</a>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> org.w3c.dom.Document document = XmlUtils.toDom(Files.newInputStream(ratTxtFile.toPath()));
<a class="jxr_linenumber" name="L150" href="#L150">150</a> XPath xPath = XPathFactory.newInstance().newXPath();
<a class="jxr_linenumber" name="L151" href="#L151">151</a>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">for</strong> (ClaimStatistic.Counter counter : ClaimStatistic.Counter.values()) {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> String xpath = String.format(<span class="jxr_string">"/rat-report/statistics/statistic[@name='%s']"</span>, counter.displayName());
<a class="jxr_linenumber" name="L154" href="#L154">154</a> Map&lt;String, String&gt; map = mapOf(<span class="jxr_string">"approval"</span>, <span class="jxr_string">"true"</span>, <span class="jxr_string">"count"</span>, data.get(counter),
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <span class="jxr_string">"description"</span>, counter.getDescription());
<a class="jxr_linenumber" name="L156" href="#L156">156</a> XmlUtils.assertAttributes(document, xPath, xpath, map);
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L158" href="#L158">158</a>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/.bzrignore']"</span>,
<a class="jxr_linenumber" name="L160" href="#L160">160</a> mapOf(<span class="jxr_string">"mediaType"</span>, <span class="jxr_string">"application/octet-stream"</span>, <span class="jxr_string">"type"</span>, <span class="jxr_string">"IGNORED"</span>));
<a class="jxr_linenumber" name="L161" href="#L161">161</a>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/pom.xml']"</span>,
<a class="jxr_linenumber" name="L163" href="#L163">163</a> mapOf(<span class="jxr_string">"mediaType"</span>, <span class="jxr_string">"application/xml"</span>, <span class="jxr_string">"type"</span>, <span class="jxr_string">"STANDARD"</span>, <span class="jxr_string">"encoding"</span>, <span class="jxr_string">"ISO-8859-1"</span>));
<a class="jxr_linenumber" name="L164" href="#L164">164</a> }
<a class="jxr_linenumber" name="L165" href="#L165">165</a>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> Map&lt;String, String&gt; mapOf(String... parts) {
<a class="jxr_linenumber" name="L167" href="#L167">167</a> Map&lt;String, String&gt; map = <strong class="jxr_keyword">new</strong> HashMap&lt;&gt;();
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; parts.length; i += 2) {
<a class="jxr_linenumber" name="L169" href="#L169">169</a> map.put(parts[i], parts[i + 1]);
<a class="jxr_linenumber" name="L170" href="#L170">170</a> }
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">return</strong> map;
<a class="jxr_linenumber" name="L172" href="#L172">172</a> }
<a class="jxr_linenumber" name="L173" href="#L173">173</a>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * Runs a check, which should detect a problem.</em>
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * @throws Exception The test failed.</em>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> @Test
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">void</strong> it2() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">final</strong> RatCheckMojo mojo = newRatMojo(<span class="jxr_string">"it2"</span>);
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">final</strong> File ratTxtFile = mojo.getRatTxtFile();
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">final</strong> String[] expected = {
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <span class="jxr_string">"^Files with unapproved licenses&#92;&#92;s+&#92;&#92;*+&#92;&#92;s+&#92;&#92;Q/src.txt&#92;&#92;E&#92;&#92;s+"</span>,
<a class="jxr_linenumber" name="L185" href="#L185">185</a> ReporterTestUtils.counterText(ClaimStatistic.Counter.NOTICES, 0, false),
<a class="jxr_linenumber" name="L186" href="#L186">186</a> ReporterTestUtils.counterText(ClaimStatistic.Counter.BINARIES, 0, false),
<a class="jxr_linenumber" name="L187" href="#L187">187</a> ReporterTestUtils.counterText(ClaimStatistic.Counter.ARCHIVES, 0, false),
<a class="jxr_linenumber" name="L188" href="#L188">188</a> ReporterTestUtils.counterText(ClaimStatistic.Counter.STANDARDS, 2, false),
<a class="jxr_linenumber" name="L189" href="#L189">189</a> ReporterTestUtils.counterText(ClaimStatistic.Counter.IGNORED, 1, false),
<a class="jxr_linenumber" name="L190" href="#L190">190</a> ReporterTestUtils.apacheLicenseVersion2(1),
<a class="jxr_linenumber" name="L191" href="#L191">191</a> ReporterTestUtils.unknownLicense(1),
<a class="jxr_linenumber" name="L192" href="#L192">192</a> ReporterTestUtils.documentOut(false, Document.Type.STANDARD, <span class="jxr_string">"/src.txt"</span>) +
<a class="jxr_linenumber" name="L193" href="#L193">193</a> ReporterTestUtils.UNKNOWN_LICENSE,
<a class="jxr_linenumber" name="L194" href="#L194">194</a> ReporterTestUtils.documentOut(<strong class="jxr_keyword">true</strong>, Document.Type.STANDARD, <span class="jxr_string">"/pom.xml"</span>) +
<a class="jxr_linenumber" name="L195" href="#L195">195</a> ReporterTestUtils.APACHE_LICENSE
<a class="jxr_linenumber" name="L196" href="#L196">196</a> };
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L198" href="#L198">198</a> mojo.execute();
<a class="jxr_linenumber" name="L199" href="#L199">199</a> fail(<span class="jxr_string">"Expected RatCheckException"</span>);
<a class="jxr_linenumber" name="L200" href="#L200">200</a> } <strong class="jxr_keyword">catch</strong> (RatCheckException e) {
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">final</strong> String msg = e.getMessage();
<a class="jxr_linenumber" name="L202" href="#L202">202</a> assertThat(msg.contains(ratTxtFile.getName())).as(() -&gt; format(<span class="jxr_string">"report filename was not contained in '%s'"</span>, msg))
<a class="jxr_linenumber" name="L203" href="#L203">203</a> .isTrue();
<a class="jxr_linenumber" name="L204" href="#L204">204</a> assertThat(msg.toUpperCase()).contains(<span class="jxr_string">"UNAPPROVED EXCEEDED MINIMUM"</span>);
<a class="jxr_linenumber" name="L205" href="#L205">205</a>
<a class="jxr_linenumber" name="L206" href="#L206">206</a> ensureRatReportIsCorrect(ratTxtFile, expected, TextUtils.EMPTY);
<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>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * Tests adding license headers.</em>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> @Test
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">void</strong> it3() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">final</strong> RatCheckMojo mojo = newRatMojo(<span class="jxr_string">"it3"</span>);
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">final</strong> File ratTxtFile = mojo.getRatTxtFile();
<a class="jxr_linenumber" name="L217" href="#L217">217</a>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> ReportConfiguration config = mojo.getConfiguration();
<a class="jxr_linenumber" name="L219" href="#L219">219</a> assertThat(config.isAddingLicenses()).as(<span class="jxr_string">"should be adding licenses"</span>).isTrue();
<a class="jxr_linenumber" name="L220" href="#L220">220</a> mojo.execute();
<a class="jxr_linenumber" name="L221" href="#L221">221</a> org.w3c.dom.Document document = XmlUtils.toDom(Files.newInputStream(ratTxtFile.toPath()));
<a class="jxr_linenumber" name="L222" href="#L222">222</a>
<a class="jxr_linenumber" name="L223" href="#L223">223</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/pom.xml']"</span>, <span class="jxr_string">"type"</span>,
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <span class="jxr_string">"STANDARD"</span>);
<a class="jxr_linenumber" name="L225" href="#L225">225</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/src.apt']"</span>, <span class="jxr_string">"type"</span>,
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <span class="jxr_string">"STANDARD"</span>);
<a class="jxr_linenumber" name="L227" href="#L227">227</a> XmlUtils.assertIsPresent(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/src.apt']/license[@approval='false']"</span>);
<a class="jxr_linenumber" name="L228" href="#L228">228</a>
<a class="jxr_linenumber" name="L229" href="#L229">229</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/src.apt']"</span>, <span class="jxr_string">"type"</span>,
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <span class="jxr_string">"STANDARD"</span>);
<a class="jxr_linenumber" name="L231" href="#L231">231</a>
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">for</strong> (Document.Type type : Document.Type.values()) {
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">if</strong> (type == Document.Type.STANDARD) {
<a class="jxr_linenumber" name="L234" href="#L234">234</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/statistics/documentType[@name='STANDARD']"</span>, <span class="jxr_string">"count"</span>,
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <span class="jxr_string">"2"</span>);
<a class="jxr_linenumber" name="L236" href="#L236">236</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (type == Document.Type.IGNORED) {
<a class="jxr_linenumber" name="L237" href="#L237">237</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/statistics/documentType[@name='IGNORED']"</span>, <span class="jxr_string">"count"</span>,
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <span class="jxr_string">"1"</span>);
<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> XmlUtils.assertIsNotPresent(document, xPath, format(<span class="jxr_string">"/rat-report/statistics/documentType[@name='%s']"</span>, type));
<a class="jxr_linenumber" name="L241" href="#L241">241</a> }
<a class="jxr_linenumber" name="L242" href="#L242">242</a> }
<a class="jxr_linenumber" name="L243" href="#L243">243</a> }
<a class="jxr_linenumber" name="L244" href="#L244">244</a>
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * Tests defining licenses in configuration</em>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> @Test
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">void</strong> it5() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">final</strong> RatCheckMojo mojo = newRatMojo(<span class="jxr_string">"it5"</span>);
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">final</strong> File ratTxtFile = mojo.getRatTxtFile();
<a class="jxr_linenumber" name="L252" href="#L252">252</a>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> ReportConfiguration config = mojo.getConfiguration();
<a class="jxr_linenumber" name="L254" href="#L254">254</a> assertThat(config.isAddingLicenses()).as(<span class="jxr_string">"Should not be adding licenses"</span>).isFalse();
<a class="jxr_linenumber" name="L255" href="#L255">255</a> assertThat(config.isAddingLicensesForced()).as(<span class="jxr_string">"Should not be forcing licenses"</span>).isFalse();
<a class="jxr_linenumber" name="L256" href="#L256">256</a>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> ReportConfigurationTest.validateDefaultApprovedLicenses(config, 1);
<a class="jxr_linenumber" name="L258" href="#L258">258</a> assertThat(config.getLicenseCategories(LicenseFilter.APPROVED)).doesNotContain(ILicenseFamily.makeCategory(<span class="jxr_string">"YAL"</span>))
<a class="jxr_linenumber" name="L259" href="#L259">259</a> .contains(ILicenseFamily.makeCategory(<span class="jxr_string">"CC"</span>));
<a class="jxr_linenumber" name="L260" href="#L260">260</a> ReportConfigurationTest.validateDefaultLicenseFamilies(config, <span class="jxr_string">"YAL"</span>, <span class="jxr_string">"CC"</span>);
<a class="jxr_linenumber" name="L261" href="#L261">261</a> assertThat(LicenseSetFactory.familySearch(<span class="jxr_string">"YAL"</span>, config.getLicenseFamilies(LicenseFilter.APPROVED))).isNull();
<a class="jxr_linenumber" name="L262" href="#L262">262</a> assertThat(LicenseSetFactory.familySearch(<span class="jxr_string">"YAL"</span>, config.getLicenseFamilies(LicenseFilter.ALL))).isNotNull();
<a class="jxr_linenumber" name="L263" href="#L263">263</a> assertThat(LicenseSetFactory.familySearch(<span class="jxr_string">"CC"</span>, config.getLicenseFamilies(LicenseFilter.APPROVED))).isNotNull();
<a class="jxr_linenumber" name="L264" href="#L264">264</a> assertThat(LicenseSetFactory.familySearch(<span class="jxr_string">"CC"</span>, config.getLicenseFamilies(LicenseFilter.ALL))).isNotNull();
<a class="jxr_linenumber" name="L265" href="#L265">265</a>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> ReportConfigurationTest.validateDefaultLicenses(config, <span class="jxr_string">"CC-BY-NC-ND"</span>, <span class="jxr_string">"YAL"</span>);
<a class="jxr_linenumber" name="L267" href="#L267">267</a> assertThat(LicenseSetFactory.search(<span class="jxr_string">"YAL"</span>, <span class="jxr_string">"YAL"</span>, config.getLicenses(LicenseFilter.ALL))).isPresent();
<a class="jxr_linenumber" name="L268" href="#L268">268</a>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> mojo.execute();
<a class="jxr_linenumber" name="L270" href="#L270">270</a>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> Map&lt;ClaimStatistic.Counter, String&gt; data = <strong class="jxr_keyword">new</strong> HashMap&lt;&gt;();
<a class="jxr_linenumber" name="L272" href="#L272">272</a> data.put(ClaimStatistic.Counter.APPROVED, <span class="jxr_string">"1"</span>);
<a class="jxr_linenumber" name="L273" href="#L273">273</a> data.put(ClaimStatistic.Counter.ARCHIVES, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L274" href="#L274">274</a> data.put(ClaimStatistic.Counter.BINARIES, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L275" href="#L275">275</a> data.put(ClaimStatistic.Counter.DOCUMENT_TYPES, <span class="jxr_string">"2"</span>);
<a class="jxr_linenumber" name="L276" href="#L276">276</a> data.put(ClaimStatistic.Counter.IGNORED, <span class="jxr_string">"3"</span>);
<a class="jxr_linenumber" name="L277" href="#L277">277</a> data.put(ClaimStatistic.Counter.LICENSE_CATEGORIES, <span class="jxr_string">"1"</span>);
<a class="jxr_linenumber" name="L278" href="#L278">278</a> data.put(ClaimStatistic.Counter.LICENSE_NAMES, <span class="jxr_string">"1"</span>);
<a class="jxr_linenumber" name="L279" href="#L279">279</a> data.put(ClaimStatistic.Counter.NOTICES, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L280" href="#L280">280</a> data.put(ClaimStatistic.Counter.STANDARDS, <span class="jxr_string">"1"</span>);
<a class="jxr_linenumber" name="L281" href="#L281">281</a> data.put(ClaimStatistic.Counter.UNAPPROVED, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L282" href="#L282">282</a> data.put(ClaimStatistic.Counter.UNKNOWN, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L283" href="#L283">283</a>
<a class="jxr_linenumber" name="L284" href="#L284">284</a> org.w3c.dom.Document document = XmlUtils.toDom(Files.newInputStream(ratTxtFile.toPath()));
<a class="jxr_linenumber" name="L285" href="#L285">285</a> XPath xPath = XPathFactory.newInstance().newXPath();
<a class="jxr_linenumber" name="L286" href="#L286">286</a>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">for</strong> (ClaimStatistic.Counter counter : ClaimStatistic.Counter.values()) {
<a class="jxr_linenumber" name="L288" href="#L288">288</a> String xpath = String.format(<span class="jxr_string">"/rat-report/statistics/statistic[@name='%s']"</span>, counter.displayName());
<a class="jxr_linenumber" name="L289" href="#L289">289</a> Map&lt;String, String&gt; map = mapOf(<span class="jxr_string">"approval"</span>,
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <span class="jxr_string">"true"</span>,
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <span class="jxr_string">"count"</span>, data.get(counter),
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <span class="jxr_string">"description"</span>, counter.getDescription());
<a class="jxr_linenumber" name="L293" href="#L293">293</a> XmlUtils.assertAttributes(document, xPath, xpath, map);
<a class="jxr_linenumber" name="L294" href="#L294">294</a> }
<a class="jxr_linenumber" name="L295" href="#L295">295</a>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/.rat']"</span>,
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <span class="jxr_string">"mediaType"</span>, <span class="jxr_string">"application/octet-stream"</span>, <span class="jxr_string">"type"</span>, <span class="jxr_string">"IGNORED"</span>, <span class="jxr_string">"isDirectory"</span>, <span class="jxr_string">"true"</span>);
<a class="jxr_linenumber" name="L298" href="#L298">298</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/pom.xml']"</span>,
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <span class="jxr_string">"mediaType"</span>, <span class="jxr_string">"application/xml"</span>, <span class="jxr_string">"type"</span>, <span class="jxr_string">"IGNORED"</span>, <span class="jxr_string">"isDirectory"</span>, <span class="jxr_string">"false"</span>);
<a class="jxr_linenumber" name="L300" href="#L300">300</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/src/main/java/nl/basjes/something/Something.java']"</span>,
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <span class="jxr_string">"mediaType"</span>, <span class="jxr_string">"text/x-java-source"</span>, <span class="jxr_string">"type"</span>, <span class="jxr_string">"STANDARD"</span>, <span class="jxr_string">"encoding"</span>, <span class="jxr_string">"ISO-8859-1"</span>);
<a class="jxr_linenumber" name="L302" href="#L302">302</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/src/main/java/nl/basjes/something/Something.java']/license"</span>,
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <span class="jxr_string">"approval"</span>, <span class="jxr_string">"true"</span>, <span class="jxr_string">"family"</span>, ILicenseFamily.makeCategory(<span class="jxr_string">"CC"</span>), <span class="jxr_string">"id"</span>, <span class="jxr_string">"CC-BY-NC-ND"</span>, <span class="jxr_string">"name"</span>,
<a class="jxr_linenumber" name="L304" href="#L304">304</a> <span class="jxr_string">"Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International"</span>);
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * Runs a check, which should expose no problems.</em>
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> * @throws Exception The test failed.</em>
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L312" href="#L312">312</a> @Test
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">void</strong> rat343() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">final</strong> RatCheckMojo mojo = newRatMojo(<span class="jxr_string">"RAT-343"</span>);
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">final</strong> File ratTxtFile = mojo.getRatTxtFile();
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_comment">// POM reports AL, BSD and CC BYas BSD because it contains the BSD and CC BY strings</em>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">final</strong> String[] expected = {
<a class="jxr_linenumber" name="L318" href="#L318">318</a> ReporterTestUtils.documentOut(false, Document.Type.STANDARD, <span class="jxr_string">"/pom.xml"</span>) +
<a class="jxr_linenumber" name="L319" href="#L319">319</a> ReporterTestUtils.APACHE_LICENSE +
<a class="jxr_linenumber" name="L320" href="#L320">320</a> ReporterTestUtils.licenseOut(<span class="jxr_string">"BSD"</span>, <span class="jxr_string">"BSD"</span>) +
<a class="jxr_linenumber" name="L321" href="#L321">321</a> ReporterTestUtils.licenseOut(<span class="jxr_string">"CC BY"</span>, <span class="jxr_string">"Creative Commons Attribution (Unapproved)"</span>),
<a class="jxr_linenumber" name="L322" href="#L322">322</a> ReporterTestUtils.counterText(ClaimStatistic.Counter.NOTICES, 0, false),
<a class="jxr_linenumber" name="L323" href="#L323">323</a> ReporterTestUtils.counterText(ClaimStatistic.Counter.BINARIES, 0, false),
<a class="jxr_linenumber" name="L324" href="#L324">324</a> ReporterTestUtils.counterText(ClaimStatistic.Counter.ARCHIVES, 0, false),
<a class="jxr_linenumber" name="L325" href="#L325">325</a> ReporterTestUtils.counterText(ClaimStatistic.Counter.STANDARDS, 1, false),
<a class="jxr_linenumber" name="L326" href="#L326">326</a> ReporterTestUtils.counterText(ClaimStatistic.Counter.IGNORED, 1, false),
<a class="jxr_linenumber" name="L327" href="#L327">327</a> ReporterTestUtils.apacheLicenseVersion2(1),
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <span class="jxr_string">"^BSD: 1 "</span>,
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <span class="jxr_string">"^Creative Commons Attribution: 1 "</span>,
<a class="jxr_linenumber" name="L330" href="#L330">330</a> };
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">final</strong> String[] notExpected = {
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <span class="jxr_string">"^Unknown License:"</span>
<a class="jxr_linenumber" name="L333" href="#L333">333</a> };
<a class="jxr_linenumber" name="L334" href="#L334">334</a>
<a class="jxr_linenumber" name="L335" href="#L335">335</a> ReportConfiguration config = mojo.getConfiguration();
<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_comment">// validate configuration</em>
<a class="jxr_linenumber" name="L337" href="#L337">337</a> assertThat(config.isAddingLicenses()).isFalse();
<a class="jxr_linenumber" name="L338" href="#L338">338</a> assertThat(config.isAddingLicensesForced()).isFalse();
<a class="jxr_linenumber" name="L339" href="#L339">339</a> assertThat(config.getCopyrightMessage()).isNull();
<a class="jxr_linenumber" name="L340" href="#L340">340</a> assertThat(config.getStyleSheet()).withFailMessage(<span class="jxr_string">"Stylesheet should not be null"</span>).isNotNull();
<a class="jxr_linenumber" name="L341" href="#L341">341</a>
<a class="jxr_linenumber" name="L342" href="#L342">342</a> ReportConfigurationTest.validateDefaultApprovedLicenses(config, 1);
<a class="jxr_linenumber" name="L343" href="#L343">343</a> ReportConfigurationTest.validateDefaultLicenseFamilies(config, <span class="jxr_string">"BSD"</span>, <span class="jxr_string">"CC BY"</span>);
<a class="jxr_linenumber" name="L344" href="#L344">344</a> ReportConfigurationTest.validateDefaultLicenses(config, <span class="jxr_string">"BSD"</span>, <span class="jxr_string">"CC BY"</span>);
<a class="jxr_linenumber" name="L345" href="#L345">345</a>
<a class="jxr_linenumber" name="L346" href="#L346">346</a> mojo.execute();
<a class="jxr_linenumber" name="L347" href="#L347">347</a> ensureRatReportIsCorrect(ratTxtFile, expected, notExpected);
<a class="jxr_linenumber" name="L348" href="#L348">348</a> }
<a class="jxr_linenumber" name="L349" href="#L349">349</a>
<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * Tests verifying gitignore parsing</em>
<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L353" href="#L353">353</a> @Test
<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">void</strong> rat335() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">final</strong> RatCheckMojo mojo = newRatMojo(<span class="jxr_string">"RAT-335"</span>);
<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong class="jxr_keyword">final</strong> File ratTxtFile = mojo.getRatTxtFile();
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L358" href="#L358">358</a> mojo.execute();
<a class="jxr_linenumber" name="L359" href="#L359">359</a> fail(<span class="jxr_string">"Expected RatCheckException"</span>);
<a class="jxr_linenumber" name="L360" href="#L360">360</a> } <strong class="jxr_keyword">catch</strong> (RatCheckException e) {
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">final</strong> String msg = e.getMessage();
<a class="jxr_linenumber" name="L362" href="#L362">362</a> assertThat(msg).contains(ratTxtFile.getName());
<a class="jxr_linenumber" name="L363" href="#L363">363</a> assertThat(msg).contains(<span class="jxr_string">"UNAPPROVED exceeded minimum"</span>);
<a class="jxr_linenumber" name="L364" href="#L364">364</a>
<a class="jxr_linenumber" name="L365" href="#L365">365</a> Map&lt;ClaimStatistic.Counter, String&gt; data = <strong class="jxr_keyword">new</strong> HashMap&lt;&gt;();
<a class="jxr_linenumber" name="L366" href="#L366">366</a> data.put(ClaimStatistic.Counter.APPROVED, <span class="jxr_string">"1"</span>);
<a class="jxr_linenumber" name="L367" href="#L367">367</a> data.put(ClaimStatistic.Counter.ARCHIVES, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L368" href="#L368">368</a> data.put(ClaimStatistic.Counter.BINARIES, <span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="L369" href="#L369">369</a> data.put(ClaimStatistic.Counter.DOCUMENT_TYPES, <span class="jxr_string">"3"</span>);
<a class="jxr_linenumber" name="L370" href="#L370">370</a> data.put(ClaimStatistic.Counter.IGNORED, <span class="jxr_string">"6"</span>);
<a class="jxr_linenumber" name="L371" href="#L371">371</a> data.put(ClaimStatistic.Counter.LICENSE_CATEGORIES, <span class="jxr_string">"2"</span>);
<a class="jxr_linenumber" name="L372" href="#L372">372</a> data.put(ClaimStatistic.Counter.LICENSE_NAMES, <span class="jxr_string">"2"</span>);
<a class="jxr_linenumber" name="L373" href="#L373">373</a> data.put(ClaimStatistic.Counter.NOTICES, <span class="jxr_string">"1"</span>);
<a class="jxr_linenumber" name="L374" href="#L374">374</a> data.put(ClaimStatistic.Counter.STANDARDS, <span class="jxr_string">"5"</span>);
<a class="jxr_linenumber" name="L375" href="#L375">375</a> data.put(ClaimStatistic.Counter.UNAPPROVED, <span class="jxr_string">"4"</span>);
<a class="jxr_linenumber" name="L376" href="#L376">376</a> data.put(ClaimStatistic.Counter.UNKNOWN, <span class="jxr_string">"4"</span>);
<a class="jxr_linenumber" name="L377" href="#L377">377</a>
<a class="jxr_linenumber" name="L378" href="#L378">378</a> org.w3c.dom.Document document = XmlUtils.toDom(Files.newInputStream(ratTxtFile.toPath()));
<a class="jxr_linenumber" name="L379" href="#L379">379</a>
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">for</strong> (ClaimStatistic.Counter counter : ClaimStatistic.Counter.values()) {
<a class="jxr_linenumber" name="L381" href="#L381">381</a> String xpath = String.format(<span class="jxr_string">"/rat-report/statistics/statistic[@name='%s']"</span>, counter.displayName());
<a class="jxr_linenumber" name="L382" href="#L382">382</a> Map&lt;String, String&gt; map = mapOf(<span class="jxr_string">"approval"</span>,
<a class="jxr_linenumber" name="L383" href="#L383">383</a> counter == ClaimStatistic.Counter.UNAPPROVED ? <span class="jxr_string">"false"</span> : <span class="jxr_string">"true"</span>,
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <span class="jxr_string">"count"</span>, data.get(counter),
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <span class="jxr_string">"description"</span>, counter.getDescription());
<a class="jxr_linenumber" name="L386" href="#L386">386</a> XmlUtils.assertAttributes(document, xPath, xpath, map);
<a class="jxr_linenumber" name="L387" href="#L387">387</a> }
<a class="jxr_linenumber" name="L388" href="#L388">388</a>
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_comment">// license categories</em>
<a class="jxr_linenumber" name="L390" href="#L390">390</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/statistics/licenseCategory[@name='?????']"</span>,
<a class="jxr_linenumber" name="L391" href="#L391">391</a> mapOf(<span class="jxr_string">"count"</span>, <span class="jxr_string">"4"</span>));
<a class="jxr_linenumber" name="L392" href="#L392">392</a>
<a class="jxr_linenumber" name="L393" href="#L393">393</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/statistics/licenseCategory[@name='AL ']"</span>,
<a class="jxr_linenumber" name="L394" href="#L394">394</a> mapOf(<span class="jxr_string">"count"</span>, <span class="jxr_string">"1"</span>));
<a class="jxr_linenumber" name="L395" href="#L395">395</a>
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_comment">// license names</em>
<a class="jxr_linenumber" name="L397" href="#L397">397</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/statistics/licenseName[@name='Apache License Version 2.0']"</span>,
<a class="jxr_linenumber" name="L398" href="#L398">398</a> mapOf(<span class="jxr_string">"count"</span>, <span class="jxr_string">"1"</span>));
<a class="jxr_linenumber" name="L399" href="#L399">399</a>
<a class="jxr_linenumber" name="L400" href="#L400">400</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/statistics/licenseName[@name='Unknown license']"</span>,
<a class="jxr_linenumber" name="L401" href="#L401">401</a> mapOf(<span class="jxr_string">"count"</span>, <span class="jxr_string">"4"</span>));
<a class="jxr_linenumber" name="L402" href="#L402">402</a>
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_comment">// Document types</em>
<a class="jxr_linenumber" name="L404" href="#L404">404</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/statistics/documentType[@name='IGNORED']"</span>,
<a class="jxr_linenumber" name="L405" href="#L405">405</a> mapOf(<span class="jxr_string">"count"</span>, <span class="jxr_string">"6"</span>));
<a class="jxr_linenumber" name="L406" href="#L406">406</a>
<a class="jxr_linenumber" name="L407" href="#L407">407</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/statistics/documentType[@name='NOTICE']"</span>,
<a class="jxr_linenumber" name="L408" href="#L408">408</a> mapOf(<span class="jxr_string">"count"</span>, <span class="jxr_string">"1"</span>));
<a class="jxr_linenumber" name="L409" href="#L409">409</a>
<a class="jxr_linenumber" name="L410" href="#L410">410</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/statistics/documentType[@name='STANDARD']"</span>,
<a class="jxr_linenumber" name="L411" href="#L411">411</a> mapOf(<span class="jxr_string">"count"</span>, <span class="jxr_string">"5"</span>));
<a class="jxr_linenumber" name="L412" href="#L412">412</a>
<a class="jxr_linenumber" name="L413" href="#L413">413</a> List&lt;String&gt; ignoredFiles = <strong class="jxr_keyword">new</strong> ArrayList&lt;&gt;(Arrays.asList(
<a class="jxr_linenumber" name="L414" href="#L414">414</a> <span class="jxr_string">"/dir1/dir1.txt"</span>,
<a class="jxr_linenumber" name="L415" href="#L415">415</a> <span class="jxr_string">"/dir1/.gitignore"</span>,
<a class="jxr_linenumber" name="L416" href="#L416">416</a> <span class="jxr_string">"/dir2/dir2.md"</span>,
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <span class="jxr_string">"/dir3/dir3.log"</span>,
<a class="jxr_linenumber" name="L418" href="#L418">418</a> <span class="jxr_string">"/.gitignore"</span>,
<a class="jxr_linenumber" name="L419" href="#L419">419</a> <span class="jxr_string">"/root.md"</span>));
<a class="jxr_linenumber" name="L420" href="#L420">420</a>
<a class="jxr_linenumber" name="L421" href="#L421">421</a> NodeList nodeList = XmlUtils.getNodeList(document, xPath, <span class="jxr_string">"/rat-report/resource[@type='IGNORED']"</span>);
<a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; nodeList.getLength(); i++) {
<a class="jxr_linenumber" name="L423" href="#L423">423</a> NamedNodeMap attr = nodeList.item(i).getAttributes();
<a class="jxr_linenumber" name="L424" href="#L424">424</a> String s = attr.getNamedItem(<span class="jxr_string">"name"</span>).getNodeValue();
<a class="jxr_linenumber" name="L425" href="#L425">425</a> assertThat(ignoredFiles).contains(s);
<a class="jxr_linenumber" name="L426" href="#L426">426</a> ignoredFiles.remove(s);
<a class="jxr_linenumber" name="L427" href="#L427">427</a> }
<a class="jxr_linenumber" name="L428" href="#L428">428</a> assertThat(ignoredFiles).isEmpty();
<a class="jxr_linenumber" name="L429" href="#L429">429</a> }
<a class="jxr_linenumber" name="L430" href="#L430">430</a> }
<a class="jxr_linenumber" name="L431" href="#L431">431</a>
<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_javadoccomment"> * Tests verifying gitignore parsing under a special edge case condition</em>
<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> * The problem occurs when '/foo.md' is to be ignored and a file with that name exists</em>
<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> * in a directory which is the project base directory twice concatenated.</em>
<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment"> * So for this test we must create such a file which is specific for the current</em>
<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em class="jxr_javadoccomment"> * working directory.</em>
<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L439" href="#L439">439</a> @Test
<a class="jxr_linenumber" name="L440" href="#L440">440</a> <strong class="jxr_keyword">void</strong> rat362() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L441" href="#L441">441</a> <strong class="jxr_keyword">final</strong> RatCheckMojo mojo = newRatMojo(<span class="jxr_string">"RAT-362"</span>);
<a class="jxr_linenumber" name="L442" href="#L442">442</a> <strong class="jxr_keyword">final</strong> File ratTxtFile = mojo.getRatTxtFile();
<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L444" href="#L444">444</a> mojo.execute();
<a class="jxr_linenumber" name="L445" href="#L445">445</a> fail(<span class="jxr_string">"Expected RatCheckException"</span>);
<a class="jxr_linenumber" name="L446" href="#L446">446</a> } <strong class="jxr_keyword">catch</strong> (RatCheckException e) {
<a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong class="jxr_keyword">final</strong> String msg = e.getMessage();
<a class="jxr_linenumber" name="L448" href="#L448">448</a> assertThat(msg).contains(ratTxtFile.getName());
<a class="jxr_linenumber" name="L449" href="#L449">449</a> assertThat(msg).contains(<span class="jxr_string">"UNAPPROVED exceeded minimum"</span>);
<a class="jxr_linenumber" name="L450" href="#L450">450</a>
<a class="jxr_linenumber" name="L451" href="#L451">451</a> org.w3c.dom.Document document = XmlUtils.toDom(Files.newInputStream(ratTxtFile.toPath()));
<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_comment">// Document types</em>
<a class="jxr_linenumber" name="L453" href="#L453">453</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/statistics/documentType[@name='IGNORED']"</span>,
<a class="jxr_linenumber" name="L454" href="#L454">454</a> <span class="jxr_string">"count"</span>, <span class="jxr_string">"3"</span>);
<a class="jxr_linenumber" name="L455" href="#L455">455</a>
<a class="jxr_linenumber" name="L456" href="#L456">456</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/bar.md']"</span>,
<a class="jxr_linenumber" name="L457" href="#L457">457</a> <span class="jxr_string">"type"</span>, <span class="jxr_string">"STANDARD"</span>);
<a class="jxr_linenumber" name="L458" href="#L458">458</a> XmlUtils.assertAttributes(document, xPath, <span class="jxr_string">"/rat-report/resource[@name='/foo.md']"</span>,
<a class="jxr_linenumber" name="L459" href="#L459">459</a> <span class="jxr_string">"type"</span>, <span class="jxr_string">"IGNORED"</span>);
<a class="jxr_linenumber" name="L460" href="#L460">460</a> }
<a class="jxr_linenumber" name="L461" href="#L461">461</a> }
<a class="jxr_linenumber" name="L462" href="#L462">462</a>
<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> * Tests implicit excludes apply to submodules too</em>
<a class="jxr_linenumber" name="L465" href="#L465">465</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L466" href="#L466">466</a> @Test
<a class="jxr_linenumber" name="L467" href="#L467">467</a> <strong class="jxr_keyword">void</strong> rat107() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L468" href="#L468">468</a> <strong class="jxr_keyword">final</strong> RatCheckMojo mojo = newRatMojo(<span class="jxr_string">"RAT-107"</span>);
<a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong class="jxr_keyword">final</strong> File ratTxtFile = mojo.getRatTxtFile();
<a class="jxr_linenumber" name="L470" href="#L470">470</a> <strong class="jxr_keyword">final</strong> String[] expected = {};
<a class="jxr_linenumber" name="L471" href="#L471">471</a> <strong class="jxr_keyword">final</strong> String[] notExpected = {};
<a class="jxr_linenumber" name="L472" href="#L472">472</a> <em class="jxr_comment">//setVariableValueToObject(mojo, "excludeSubProjects", Boolean.FALSE);</em>
<a class="jxr_linenumber" name="L473" href="#L473">473</a> mojo.setInputExcludeParsedScm(<span class="jxr_string">"MAVEN"</span>);
<a class="jxr_linenumber" name="L474" href="#L474">474</a> mojo.setInputExcludeParsedScm(<span class="jxr_string">"idea"</span>);
<a class="jxr_linenumber" name="L475" href="#L475">475</a> mojo.setInputExcludeParsedScm(<span class="jxr_string">"eclipse"</span>);
<a class="jxr_linenumber" name="L476" href="#L476">476</a> mojo.execute();
<a class="jxr_linenumber" name="L477" href="#L477">477</a>
<a class="jxr_linenumber" name="L478" href="#L478">478</a> ensureRatReportIsCorrect(ratTxtFile, expected, notExpected);
<a class="jxr_linenumber" name="L479" href="#L479">479</a> }
<a class="jxr_linenumber" name="L480" href="#L480">480</a> }
</pre>
<hr/>
<div id="footer">© 2007–2025 <a href="https://www.apache.org">Apache Software Foundation</a></div>
</body>
</html>