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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtestlib.qdoc -->
<title>Qt 4.8: Chapter 1: Writing a Unit Test</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="all-examples.html">Examples</a></li>
<li>Chapter 1: Writing a Unit Test</li>
</ul>
</div>
</div>
<div class="content mainContent">
<link rel="next" href="qtestlib-tutorial2.html" />
<p class="naviNextPrevious headerNavi">
<a class="nextPage" href="qtestlib-tutorial2.html">Chapter 2</a>
</p><p/>
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#writing-a-test">Writing a Test</a></li>
<li class="level1"><a href="#executing-a-test">Executing a Test</a></li>
</ul>
</div>
<h1 class="title">Chapter 1: Writing a Unit Test</h1>
<span class="subtitle"></span>
<!-- $$$qtestlib/tutorial1-description -->
<div class="descr"> <a name="details"></a>
<p>Files:</p>
<ul>
<li><a href="qtestlib-tutorial1-testqstring-cpp.html">qtestlib/tutorial1/testqstring.cpp</a></li>
<li><a href="qtestlib-tutorial1-tutorial1-pro.html">qtestlib/tutorial1/tutorial1.pro</a></li>
</ul>
<p>In this first chapter we will see how to write a simple unit test for a class, and how to execute it.</p>
<a name="writing-a-test"></a>
<h2>Writing a Test</h2>
<p>Let's assume you want to test the behavior of our <a href="qstring.html">QString</a> class. First, you need a class that contains your test functions. This class has to inherit from <a href="qobject.html">QObject</a>:</p>
<pre class="cpp"> <span class="preprocessor">#include <QtTest/QtTest></span>
<span class="keyword">class</span> TestQString: <span class="keyword">public</span> <span class="type"><a href="qobject.html">QObject</a></span>
{
Q_OBJECT
<span class="keyword">private</span> <span class="keyword">slots</span>:
<span class="type">void</span> toUpper();
};</pre>
<p>Note that you need to include the <a href="qtest.html">QTest</a> header, and that the test functions have to be declared as private slots so the test framework finds and executes it.</p>
<p>Then you need to implement the test function itself. The implementation could look like this:</p>
<pre class="cpp"> <span class="type">void</span> TestQString<span class="operator">::</span>toUpper()
{
<span class="type"><a href="qstring.html">QString</a></span> str <span class="operator">=</span> <span class="string">"Hello"</span>;
QVERIFY(str<span class="operator">.</span>toUpper() <span class="operator">=</span><span class="operator">=</span> <span class="string">"HELLO"</span>);
}</pre>
<p>The <a href="qtest.html#QVERIFY">QVERIFY</a>() macro evaluates the expression passed as its argument. If the expression evaluates to true, the execution of the test function continues. Otherwise, a message describing the failure is appended to the test log, and the test function stops executing.</p>
<p>But if you want a more verbose output to the test log, you should use the <a href="qtest.html#QCOMPARE">QCOMPARE</a>() macro instead:</p>
<pre class="cpp"> <span class="type">void</span> TestQString<span class="operator">::</span>toUpper()
{
<span class="type"><a href="qstring.html">QString</a></span> str <span class="operator">=</span> <span class="string">"Hello"</span>;
QCOMPARE(str<span class="operator">.</span>toUpper()<span class="operator">,</span> <span class="type"><a href="qstring.html">QString</a></span>(<span class="string">"HELLO"</span>));
}</pre>
<p>If the strings are not equal, the contents of both strings is appended to the test log, making it immediately visible why the comparison failed.</p>
<p>Finally, to make our test case a stand-alone executable, the following two lines are needed:</p>
<pre class="cpp"> <a href="qtest.html#QTEST_MAIN">QTEST_MAIN</a>(TestQString)
<span class="preprocessor">#include "testqstring.moc"</span></pre>
<p>The <a href="qtest.html#QTEST_MAIN">QTEST_MAIN</a>() macro expands to a simple <tt>main()</tt> method that runs all the test functions. Note that if both the declaration and the implementation of our test class are in a <tt>.cpp</tt> file, we also need to include the generated moc file to make Qt's introspection work.</p>
<a name="executing-a-test"></a>
<h2>Executing a Test</h2>
<p>Now that we finished writing our test, we want to execute it. Assuming that our test was saved as <tt>testqstring.cpp</tt> in an empty directory: we build the test using qmake to create a project and generate a makefile.</p>
<pre class="cpp"> /myTestDirectory$ qmake -project "CONFIG += qtestlib"
/myTestDirectory$ qmake
/myTestDirectory$ make</pre>
<p><b>Note:</b>If you're using windows, replace <tt>make</tt> with <tt>nmake</tt> or whatever build tool you use.</p>
<p>Running the resulting executable should give you the following output:</p>
<pre class="cpp"> ********* Start testing of TestQString *********
Config: Using QTest library 4.8.2, Qt 4.8.2
PASS : TestQString::initTestCase()
PASS : TestQString::toUpper()
PASS : TestQString::cleanupTestCase()
Totals: 3 passed, 0 failed, 0 skipped
********* Finished testing of TestQString *********</pre>
<p>Congratulations! You just wrote and executed your first unit test using the <a href="qtestlib-manual.html#qtestlib">QTestLib</a> framework.</p>
</div>
<!-- @@@qtestlib/tutorial1 -->
<p class="naviNextPrevious footerNavi">
<a class="nextPage" href="qtestlib-tutorial2.html">Chapter 2</a>
</p>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
