/usr/share/doc/junit4/api/src-html/org/junit/Assume.html is in junit4-doc 4.12-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>package org.junit;<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>import static java.util.Arrays.asList;<a name="line.3"></a>
<span class="sourceLineNo">004</span>import static org.hamcrest.CoreMatchers.everyItem;<a name="line.4"></a>
<span class="sourceLineNo">005</span>import static org.hamcrest.CoreMatchers.is;<a name="line.5"></a>
<span class="sourceLineNo">006</span>import static org.hamcrest.CoreMatchers.notNullValue;<a name="line.6"></a>
<span class="sourceLineNo">007</span>import static org.hamcrest.CoreMatchers.nullValue;<a name="line.7"></a>
<span class="sourceLineNo">008</span><a name="line.8"></a>
<span class="sourceLineNo">009</span>import org.hamcrest.Matcher;<a name="line.9"></a>
<span class="sourceLineNo">010</span><a name="line.10"></a>
<span class="sourceLineNo">011</span>/**<a name="line.11"></a>
<span class="sourceLineNo">012</span> * A set of methods useful for stating assumptions about the conditions in which a test is meaningful.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * A failed assumption does not mean the code is broken, but that the test provides no useful information. Assume<a name="line.13"></a>
<span class="sourceLineNo">014</span> * basically means "don't run this test if these conditions don't apply". The default JUnit runner skips tests with<a name="line.14"></a>
<span class="sourceLineNo">015</span> * failing assumptions. Custom runners may behave differently.<a name="line.15"></a>
<span class="sourceLineNo">016</span> * <p><a name="line.16"></a>
<span class="sourceLineNo">017</span> * A good example of using assumptions is in <a href="https://github.com/junit-team/junit/wiki/Theories">Theories</a> where they are needed to exclude certain datapoints that aren't suitable or allowed for a certain test case.<a name="line.17"></a>
<span class="sourceLineNo">018</span> * </p><a name="line.18"></a>
<span class="sourceLineNo">019</span> * Failed assumptions are usually not logged, because there may be many tests that don't apply to certain<a name="line.19"></a>
<span class="sourceLineNo">020</span> * configurations.<a name="line.20"></a>
<span class="sourceLineNo">021</span> *<a name="line.21"></a>
<span class="sourceLineNo">022</span> * <p><a name="line.22"></a>
<span class="sourceLineNo">023</span> * These methods can be used directly: <code>Assume.assumeTrue(...)</code>, however, they<a name="line.23"></a>
<span class="sourceLineNo">024</span> * read better if they are referenced through static import:<br/><a name="line.24"></a>
<span class="sourceLineNo">025</span> * <pre><a name="line.25"></a>
<span class="sourceLineNo">026</span> * import static org.junit.Assume.*;<a name="line.26"></a>
<span class="sourceLineNo">027</span> * ...<a name="line.27"></a>
<span class="sourceLineNo">028</span> * assumeTrue(...);<a name="line.28"></a>
<span class="sourceLineNo">029</span> * </pre><a name="line.29"></a>
<span class="sourceLineNo">030</span> * </p><a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * @see <a href="https://github.com/junit-team/junit/wiki/Theories">Theories</a><a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * @since 4.4<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span>public class Assume {<a name="line.36"></a>
<span class="sourceLineNo">037</span> /**<a name="line.37"></a>
<span class="sourceLineNo">038</span> * If called with an expression evaluating to {@code false}, the test will halt and be ignored.<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span> public static void assumeTrue(boolean b) {<a name="line.40"></a>
<span class="sourceLineNo">041</span> assumeThat(b, is(true));<a name="line.41"></a>
<span class="sourceLineNo">042</span> }<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * The inverse of {@link #assumeTrue(boolean)}.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> public static void assumeFalse(boolean b) {<a name="line.47"></a>
<span class="sourceLineNo">048</span> assumeTrue(!b);<a name="line.48"></a>
<span class="sourceLineNo">049</span> }<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * If called with an expression evaluating to {@code false}, the test will halt and be ignored.<a name="line.52"></a>
<span class="sourceLineNo">053</span> *<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @param b If <code>false</code>, the method will attempt to stop the test and ignore it by<a name="line.54"></a>
<span class="sourceLineNo">055</span> * throwing {@link AssumptionViolatedException}.<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @param message A message to pass to {@link AssumptionViolatedException}.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> public static void assumeTrue(String message, boolean b) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> if (!b) throw new AssumptionViolatedException(message);<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /**<a name="line.62"></a>
<span class="sourceLineNo">063</span> * The inverse of {@link #assumeTrue(String, boolean)}.<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> public static void assumeFalse(String message, boolean b) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> assumeTrue(message, !b);<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
<span class="sourceLineNo">070</span> * If called with one or more null elements in <code>objects</code>, the test will halt and be ignored.<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span> public static void assumeNotNull(Object... objects) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> assumeThat(asList(objects), everyItem(notNullValue()));<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Call to assume that <code>actual</code> satisfies the condition specified by <code>matcher</code>.<a name="line.77"></a>
<span class="sourceLineNo">078</span> * If not, the test halts and is ignored.<a name="line.78"></a>
<span class="sourceLineNo">079</span> * Example:<a name="line.79"></a>
<span class="sourceLineNo">080</span> * <pre>:<a name="line.80"></a>
<span class="sourceLineNo">081</span> * assumeThat(1, is(1)); // passes<a name="line.81"></a>
<span class="sourceLineNo">082</span> * foo(); // will execute<a name="line.82"></a>
<span class="sourceLineNo">083</span> * assumeThat(0, is(1)); // assumption failure! test halts<a name="line.83"></a>
<span class="sourceLineNo">084</span> * int x = 1 / 0; // will never execute<a name="line.84"></a>
<span class="sourceLineNo">085</span> * </pre><a name="line.85"></a>
<span class="sourceLineNo">086</span> *<a name="line.86"></a>
<span class="sourceLineNo">087</span> * @param <T> the static type accepted by the matcher (this can flag obvious compile-time problems such as {@code assumeThat(1, is("a"))}<a name="line.87"></a>
<span class="sourceLineNo">088</span> * @param actual the computed value being compared<a name="line.88"></a>
<span class="sourceLineNo">089</span> * @param matcher an expression, built of {@link Matcher}s, specifying allowed values<a name="line.89"></a>
<span class="sourceLineNo">090</span> * @see org.hamcrest.CoreMatchers<a name="line.90"></a>
<span class="sourceLineNo">091</span> * @see org.junit.matchers.JUnitMatchers<a name="line.91"></a>
<span class="sourceLineNo">092</span> */<a name="line.92"></a>
<span class="sourceLineNo">093</span> public static <T> void assumeThat(T actual, Matcher<T> matcher) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (!matcher.matches(actual)) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> throw new AssumptionViolatedException(actual, matcher);<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> /**<a name="line.99"></a>
<span class="sourceLineNo">100</span> * Call to assume that <code>actual</code> satisfies the condition specified by <code>matcher</code>.<a name="line.100"></a>
<span class="sourceLineNo">101</span> * If not, the test halts and is ignored.<a name="line.101"></a>
<span class="sourceLineNo">102</span> * Example:<a name="line.102"></a>
<span class="sourceLineNo">103</span> * <pre>:<a name="line.103"></a>
<span class="sourceLineNo">104</span> * assumeThat("alwaysPasses", 1, is(1)); // passes<a name="line.104"></a>
<span class="sourceLineNo">105</span> * foo(); // will execute<a name="line.105"></a>
<span class="sourceLineNo">106</span> * assumeThat("alwaysFails", 0, is(1)); // assumption failure! test halts<a name="line.106"></a>
<span class="sourceLineNo">107</span> * int x = 1 / 0; // will never execute<a name="line.107"></a>
<span class="sourceLineNo">108</span> * </pre><a name="line.108"></a>
<span class="sourceLineNo">109</span> *<a name="line.109"></a>
<span class="sourceLineNo">110</span> * @param <T> the static type accepted by the matcher (this can flag obvious compile-time problems such as {@code assumeThat(1, is("a"))}<a name="line.110"></a>
<span class="sourceLineNo">111</span> * @param actual the computed value being compared<a name="line.111"></a>
<span class="sourceLineNo">112</span> * @param matcher an expression, built of {@link Matcher}s, specifying allowed values<a name="line.112"></a>
<span class="sourceLineNo">113</span> * @see org.hamcrest.CoreMatchers<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @see org.junit.matchers.JUnitMatchers<a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> public static <T> void assumeThat(String message, T actual, Matcher<T> matcher) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> if (!matcher.matches(actual)) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> throw new AssumptionViolatedException(message, actual, matcher);<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> /**<a name="line.122"></a>
<span class="sourceLineNo">123</span> * Use to assume that an operation completes normally. If {@code e} is non-null, the test will halt and be ignored.<a name="line.123"></a>
<span class="sourceLineNo">124</span> *<a name="line.124"></a>
<span class="sourceLineNo">125</span> * For example:<a name="line.125"></a>
<span class="sourceLineNo">126</span> * <pre><a name="line.126"></a>
<span class="sourceLineNo">127</span> * \@Test public void parseDataFile() {<a name="line.127"></a>
<span class="sourceLineNo">128</span> * DataFile file;<a name="line.128"></a>
<span class="sourceLineNo">129</span> * try {<a name="line.129"></a>
<span class="sourceLineNo">130</span> * file = DataFile.open("sampledata.txt");<a name="line.130"></a>
<span class="sourceLineNo">131</span> * } catch (IOException e) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> * // stop test and ignore if data can't be opened<a name="line.132"></a>
<span class="sourceLineNo">133</span> * assumeNoException(e);<a name="line.133"></a>
<span class="sourceLineNo">134</span> * }<a name="line.134"></a>
<span class="sourceLineNo">135</span> * // ...<a name="line.135"></a>
<span class="sourceLineNo">136</span> * }<a name="line.136"></a>
<span class="sourceLineNo">137</span> * </pre><a name="line.137"></a>
<span class="sourceLineNo">138</span> *<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @param e if non-null, the offending exception<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span> public static void assumeNoException(Throwable e) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> assumeThat(e, nullValue());<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> /**<a name="line.145"></a>
<span class="sourceLineNo">146</span> * Attempts to halt the test and ignore it if Throwable <code>e</code> is<a name="line.146"></a>
<span class="sourceLineNo">147</span> * not <code>null</code>. Similar to {@link #assumeNoException(Throwable)},<a name="line.147"></a>
<span class="sourceLineNo">148</span> * but provides an additional message that can explain the details<a name="line.148"></a>
<span class="sourceLineNo">149</span> * concerning the assumption.<a name="line.149"></a>
<span class="sourceLineNo">150</span> *<a name="line.150"></a>
<span class="sourceLineNo">151</span> * @param e if non-null, the offending exception<a name="line.151"></a>
<span class="sourceLineNo">152</span> * @param message Additional message to pass to {@link AssumptionViolatedException}.<a name="line.152"></a>
<span class="sourceLineNo">153</span> * @see #assumeNoException(Throwable)<a name="line.153"></a>
<span class="sourceLineNo">154</span> */<a name="line.154"></a>
<span class="sourceLineNo">155</span> public static void assumeNoException(String message, Throwable e) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> assumeThat(message, e, nullValue());<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span>}<a name="line.158"></a>
</pre>
</div>
</body>
</html>
|