Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.7.1 / xref-test / org / apache / shiro / web / filter / PathMatchingFilterParameterizedTest.html
blob: 0264cb3f07225b00972aafc4d3473c8403f9e07e [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="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>PathMatchingFilterParameterizedTest xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../testapidocs/org/apache/shiro/web/filter/PathMatchingFilterParameterizedTest.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</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"> * 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.shiro.web.filter;
<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> org.junit.Before;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.junit.Test;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.junit.runner.RunWith;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.junit.runners.Parameterized;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L27" href="#L27">27</a>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a class="jxr_linenumber" name="L31" href="#L31">31</a>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.stream.Stream;
<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> <strong class="jxr_keyword">static</strong> org.easymock.EasyMock.createNiceMock;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.easymock.EasyMock.expect;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.easymock.EasyMock.replay;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.easymock.EasyMock.verify;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.junit.Assert.assertEquals;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.junit.Assert.assertFalse;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.junit.Assert.assertTrue;
<a class="jxr_linenumber" name="L41" href="#L41">41</a>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * Unit tests for the {@link PathMatchingFilter} implementation.</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> @RunWith(Parameterized.<strong class="jxr_keyword">class</strong>)
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="PathMatchingFilterParameterizedTest" href="../../../../../org/apache/shiro/web/filter/PathMatchingFilterParameterizedTest.html#PathMatchingFilterParameterizedTest">PathMatchingFilterParameterizedTest</a> {
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(PathMatchingFilterParameterizedTest.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L49" href="#L49">49</a>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CONTEXT_PATH = <span class="jxr_string">"/"</span>;
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DISABLED_PATH = CONTEXT_PATH + <span class="jxr_string">"disabled"</span>;
<a class="jxr_linenumber" name="L52" href="#L52">52</a>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> PathMatchingFilter filter;
<a class="jxr_linenumber" name="L54" href="#L54">54</a>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> @Parameterized.Parameter(0)
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">public</strong> String pattern;
<a class="jxr_linenumber" name="L57" href="#L57">57</a>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> @Parameterized.Parameter(1)
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> HttpServletRequest request;
<a class="jxr_linenumber" name="L60" href="#L60">60</a>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> @Parameterized.Parameter(2)
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> shouldMatch;
<a class="jxr_linenumber" name="L63" href="#L63">63</a>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * Tests the following assumptions:</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * URL Must match pattern Must not match pattern</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * /foo/ /foo/* /foo* || /foo</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * /foo/bar /foo/* /foo* || /foo</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * /foo /foo /foo/*</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> @Parameterized.Parameters
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Object[][] generateParameters() {
<a class="jxr_linenumber" name="L76" href="#L76">76</a>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">return</strong> Stream.of(
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo/*"</span>, createRequest(<span class="jxr_string">"/foo/"</span>), <strong class="jxr_keyword">true</strong> },
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo*"</span>, createRequest(<span class="jxr_string">"/foo/"</span>), <strong class="jxr_keyword">true</strong> },
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo"</span>, createRequest(<span class="jxr_string">"/foo/"</span>), <strong class="jxr_keyword">true</strong> },
<a class="jxr_linenumber" name="L81" href="#L81">81</a>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo/*"</span>, createRequest(<span class="jxr_string">"/foo/bar"</span>), <strong class="jxr_keyword">true</strong> },
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo*"</span>, createRequest(<span class="jxr_string">"/foo/bar"</span>), false },
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo"</span>, createRequest(<span class="jxr_string">"/foo/bar"</span>), false },
<a class="jxr_linenumber" name="L85" href="#L85">85</a>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo"</span>, createRequest(<span class="jxr_string">"/foo"</span>), <strong class="jxr_keyword">true</strong> },
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo/*"</span>, createRequest(<span class="jxr_string">"/foo"</span>), false },
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo/*"</span>, createRequest(<span class="jxr_string">"/foo "</span>), false },
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo/*"</span>, createRequest(<span class="jxr_string">"/foo /"</span>), false },
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo/*"</span>, createRequest(<span class="jxr_string">"/foo%20"</span>), false }, <em class="jxr_comment">// already URL decoded, encoded would have been %2520</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo/*"</span>, createRequest(<span class="jxr_string">"/foo%20/"</span>), false },
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo/*"</span>, createRequest(<span class="jxr_string">"/foo/%20/"</span>), <strong class="jxr_keyword">true</strong> },
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">new</strong> Object[]{ <span class="jxr_string">"/foo/*"</span>, createRequest(<span class="jxr_string">"/foo/ /"</span>), <strong class="jxr_keyword">true</strong> }
<a class="jxr_linenumber" name="L94" href="#L94">94</a> )
<a class="jxr_linenumber" name="L95" href="#L95">95</a> .toArray(Object[][]::<strong class="jxr_keyword">new</strong>);
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
<a class="jxr_linenumber" name="L97" href="#L97">97</a>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HttpServletRequest createRequest(String requestUri) {
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">return</strong> createRequest(requestUri, <span class="jxr_string">""</span>, requestUri);
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HttpServletRequest createRequest(String requestUri, String servletPath, String pathInfo) {
<a class="jxr_linenumber" name="L103" href="#L103">103</a> HttpServletRequest request = createNiceMock(HttpServletRequest.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L104" href="#L104">104</a> expect(request.getContextPath()).andReturn(CONTEXT_PATH).anyTimes();
<a class="jxr_linenumber" name="L105" href="#L105">105</a> expect(request.getRequestURI()).andReturn(requestUri).anyTimes();
<a class="jxr_linenumber" name="L106" href="#L106">106</a> expect(request.getServletPath()).andReturn(servletPath).anyTimes();
<a class="jxr_linenumber" name="L107" href="#L107">107</a> expect(request.getPathInfo()).andReturn(pathInfo).anyTimes();
<a class="jxr_linenumber" name="L108" href="#L108">108</a> replay(request);
<a class="jxr_linenumber" name="L109" href="#L109">109</a>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">return</strong> request;
<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
<a class="jxr_linenumber" name="L112" href="#L112">112</a>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> @Before
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUp() {
<a class="jxr_linenumber" name="L115" href="#L115">115</a> filter = createTestInstance();
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<a class="jxr_linenumber" name="L117" href="#L117">117</a>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">private</strong> PathMatchingFilter createTestInstance() {
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">final</strong> String NAME = <span class="jxr_string">"pathMatchingFilter"</span>;
<a class="jxr_linenumber" name="L120" href="#L120">120</a>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> PathMatchingFilter filter = <strong class="jxr_keyword">new</strong> PathMatchingFilter() {
<a class="jxr_linenumber" name="L122" href="#L122">122</a> @Override
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isEnabled(ServletRequest request, ServletResponse response, String path, Object mappedValue) <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">return</strong> !path.equals(DISABLED_PATH);
<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
<a class="jxr_linenumber" name="L126" href="#L126">126</a>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> @Override
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> onPreHandle(ServletRequest request, ServletResponse response, Object mappedValue) <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_comment">//simulate a subclass that handles the response itself (A 'false' return value indicates that the</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_comment">//FilterChain should not continue to be executed)</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_comment">//This method should only be called if the filter is enabled, so we know if the return value is</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_comment">//false, then the filter was enabled. A true return value from 'onPreHandle' indicates this test</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_comment">//filter was disabled or a path wasn't matched.</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L136" href="#L136">136</a> }
<a class="jxr_linenumber" name="L137" href="#L137">137</a> };
<a class="jxr_linenumber" name="L138" href="#L138">138</a> filter.setName(NAME);
<a class="jxr_linenumber" name="L139" href="#L139">139</a>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">return</strong> filter;
<a class="jxr_linenumber" name="L141" href="#L141">141</a> }
<a class="jxr_linenumber" name="L142" href="#L142">142</a>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> @Test
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testBasicAssumptions() {
<a class="jxr_linenumber" name="L145" href="#L145">145</a> LOG.debug(<span class="jxr_string">"Input pattern: [{}], input path: [{}]."</span>, <strong class="jxr_keyword">this</strong>.pattern, <strong class="jxr_keyword">this</strong>.request.getPathInfo());
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">boolean</strong> matchEnabled = filter.pathsMatch(<strong class="jxr_keyword">this</strong>.pattern, <strong class="jxr_keyword">this</strong>.request);
<a class="jxr_linenumber" name="L147" href="#L147">147</a> assertEquals(<span class="jxr_string">"PathMatch can match URL end with multi Separator, ["</span>+ <strong class="jxr_keyword">this</strong>.pattern + <span class="jxr_string">"] - ["</span> + <strong class="jxr_keyword">this</strong>.request.getPathInfo() + <span class="jxr_string">"]"</span>, <strong class="jxr_keyword">this</strong>.shouldMatch, matchEnabled);
<a class="jxr_linenumber" name="L148" href="#L148">148</a> verify(request);
<a class="jxr_linenumber" name="L149" href="#L149">149</a> }
<a class="jxr_linenumber" name="L150" href="#L150">150</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>