-
Notifications
You must be signed in to change notification settings - Fork 30
/
assertj-core-quick-start.html
189 lines (166 loc) · 10 KB
/
assertj-core-quick-start.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="AssertJ site">
<meta name="author" content="Joel Costigliola">
<title>AssertJ / Fluent assertions for java</title>
<!-- CSS -->
<link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Inconsolata|Source+Code+Pro|Open+Sans|Ubuntu|Varela+Round|Karla">
<link href="css/bootstrap.min.css" rel="stylesheet">
<link href="font-awesome/css/font-awesome.min.css" rel="stylesheet">
<script src="highlight/highlight.pack.js"></script>
<link rel="stylesheet" href="highlight/styles/railscasts.css">
<script>hljs.initHighlightingOnLoad();</script>
<link href="css/assertj.min.css" rel="stylesheet">
<link rel="shortcut icon" href="favicon.png" />
</head>
<body>
<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- You'll want to use a responsive image option so this logo looks good on devices - I recommend using something like retina.js (do a quick Google search for it and you'll find it) -->
<a class="navbar-brand" href="index.html">AssertJ</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse navbar-ex1-collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="assertj-core-quick-start.html">Quick start</a></li>
<li><a href="assertj-news.html">News</a></li>
<li><a href="assertj-core.html">Core</a></li>
<li><a href="assertj-assertions-generator.html">Assertions generator</a></li>
<li><a href="assertj-guava.html">Guava</a></li>
<li><a href="assertj-joda-time.html">Joda-Time</a></li>
<li><a href="assertj-db.html">DB</a></li>
<li><a href="assertj-neo4j.html">Neo4j</a></li>
<li><a href="assertj-swing.html">Swing</a></li>
<li><a href="assertj-help.html">Help</a></li>
</ul>
</div>
</div>
</nav>
<div class="container">
<div class="row" >
<div class="col-md-2 assertj-sidebar-menu">
<div class="bs-sidebar hidden-print affix-top" role="complementary">
<ul class="bs-sidenav nav ">
<li class="sidenav-header">Main</li>
<li><a href="assertj-core.html">Overview</a></li>
<li><a href="assertj-core-quick-start.html">Quick start</a></li>
<li><a href="assertj-core-news.html">News & releases</a></li>
<li><a href="assertj-core-features-highlight.html">Features highlight</a></li>
<li><a href="assertj-core-conditions.html">Using conditions</a></li>
<li><a href="assertj-core-custom-assertions.html">Custom assertions</a></li>
<li><a href="http://joel-costigliola.github.io/assertj/core/api/index.html" target="_blank">Javadoc (2.x)</a></li>
<li><a href="http://joel-costigliola.github.io/assertj/core-8/api/index.html" target="_blank">Javadoc (3.x)</a></li>
<li><a href="assertj-core.html#help">Help & F.A.Q</a></li>
<li><a href="assertj-core.html#code">Code & issues <i class="fa fa-github"></i></a></li>
<li><a href="assertj-core.html#team">Team</a></li>
<li><a href="assertj-core.html#contributing">Contributing</a></li>
<li class="sidenav-header">Migrating</li>
<li><a href="assertj-core-converting-junit-assertions-to-assertj.html">JUnit 4 Assertions</a></li>
<li><a href="assertj-core-converting-junit5-assertions-to-assertj.html">JUnit 5 Assertions</a></li>
<li><a href="assertj-core-converting-testng-assertions-to-assertj.html">TestNG Assertions</a></li>
<li><a href="assertj-core-migrating-from-fest.html">Fest Assert</a></li>
</ul>
</div>
</div>
<div class="col-lg-10 col-md-10 col-sm-10 text-left" >
<h1 class="page-header">AssertJ Core new website!</h1>
<h2 style="color:darkblue;font-style: italic;">AssertJ Core site has moved to <a href="https://assertj.github.io/doc/">https://assertj.github.io/doc/</a></h2>
<h1 class="page-header">One minute starting guide</h1>
<p>This guide is for the AssertJ core module. Quick start guides for other modules are here:
<ul>
<li><a href="assertj-guava.html#quickstart">Guava assertions quick start</a></li>
<li><a href="assertj-joda-time.html#quickstart">Joda Time assertions quick start</a></li>
<li><a href="assertj-db.html#quickstart">Database assertions quick start</a></li>
<li><a href="assertj-neo4j.html#quickstart">Neo4J assertions quick start</a></li>
<li><a href="assertj-swing-quick-start.html">Swing assertions quick start</a></li>
</ul>
</p>
<h3 class="page-header">1 - Get AssertJ Core assertions</h3>
<div class="row">
<div class="col-md-6 portfolio-item">
<h3 class="quickstart">Maven</h3>
<p>AssertJ artifacts are in the Maven central repository.</p>
<pre><code class="xml"><dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<!-- use 2.9.1 for Java 7 projects -->
<version>3.11.1</version>
<scope>test</scope>
</dependency></code></pre>
</div>
<div class="col-md-6 portfolio-item">
<h3 class="quickstart">Gradle</h3>
<p>For Gradle users (using the Maven Central Repository)</p>
<pre><code class="java">testCompile("org.assertj:assertj-core:3.11.1")</code></pre>
<p>Or version 2.9.1 for Java 7 projects</p>
<pre><code class="java">testCompile("org.assertj:assertj-core:2.9.1")</code></pre>
</div>
<div class="col-md-12">
<p>If you use another dependency management tool, please check this page to find the relevant <a href="https://search.maven.org/artifact/org.assertj/assertj-core/3.11.1/bundle">assertj dependency declaration</a>.</p>
</div>
</div>
<h3 class="page-header">2 - Add AssertJ methods static import</h3>
<p>One static import to rule them all ...</p>
<pre><code class="language-java">import static org.assertj.core.api.Assertions.*;</code></pre>
<p>... or many if you prefer</p>
<pre><code class="language-java">import static org.assertj.core.api.Assertions.assertThat; // main one
import static org.assertj.core.api.Assertions.atIndex; // for List assertions
import static org.assertj.core.api.Assertions.entry; // for Map assertions
import static org.assertj.core.api.Assertions.tuple; // when extracting several properties at once
import static org.assertj.core.api.Assertions.fail; // use when writing exception tests
import static org.assertj.core.api.Assertions.failBecauseExceptionWasNotThrown; // idem
import static org.assertj.core.api.Assertions.filter; // for Iterable/Array assertions
import static org.assertj.core.api.Assertions.offset; // for floating number assertions
import static org.assertj.core.api.Assertions.anyOf; // use with Condition
import static org.assertj.core.api.Assertions.contentOf; // use with File assertions</code></pre>
<p>On Android (API Level < 26) use this static import :</p>
<pre><code class="language-java">import static org.assertj.core.api.Java6Assertions.*;</code></pre>
<p>You can even configure your IDE, so that when you type <span class="small-code">as</span> and trigger code completion, it will suggest <span class="small-code">assertThat</span>, see <a href="assertj-core-features-highlight.html#ide-automatic-static-import">this tip</a>.</p>
<h3 class="page-header">3 - Use code completion</h3>
<p>
Type <span class="small-code">assertThat</span> followed by the object under test and a dot ... and any Java IDE code completion will show you all available assertions.
<pre><code class="language-java">assertThat(objectUnderTest). // code completion -> assertions specific to objectUnderTest</code></pre>
<p>Code completion example for <span class="small-code">String</span> assertions :</p>
<img src="images/ide-completion.png" alt="Screenshot of IDE completion">
<br/>
<h3 class="page-header">4 - Want to see more ?</h3>
<p>
See some of <a href="assertj-core-features-highlight.html">AssertJ noteworthy features</a> to get the maximum out of it !
</p>
<p>
You can learn more by looking at the <a href="http://joel-costigliola.github.io/assertj/core/api/index.html">AssertJ core javadoc</a>.
</p>
<p>
Another way to extend your knowledge is the <a href="https://github.com/joel-costigliola/assertj-examples/tree/master/assertions-examples/src/test/java/org/assertj/examples">assertj-examples tests</a> project. It covers what is possible with AssertJ Assertions with running code. You can clone the repository and run its tests ! (You need to run `mvn install` first, as the project also shows how to generate custom assertions.)
</p>
</div>
</div>
</div>
<br>
<!--
<div class="container">
<footer>
<div class="row">
<div class="col-lg-12">
<p>AssertJ - Licensed under the Apache License, Version 2.0.</p>
</div>
</div>
</footer>
</div>
-->
<script src="js/jquery-1.10.2.js"></script>
<script src="js/bootstrap.js"></script>
<script src="js/modern-business.js"></script>
<script src="js/assertj.js"></script>
</body>
</html>