-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathtesting_and_refactoring.html
More file actions
341 lines (333 loc) · 20 KB
/
testing_and_refactoring.html
File metadata and controls
341 lines (333 loc) · 20 KB
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
<!doctype html>
<html dir="ltr" lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Testing and Refactoring — Ruby on Rails Guides</title>
<link rel="stylesheet" type="text/css" href="stylesheets/style.css" data-turbo-track="reload">
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
<link rel="stylesheet" type="text/css" href="stylesheets/highlight.css" data-turbo-track="reload">
<link rel="icon" href="images/backend-development.svg" sizes="any">
<script src="javascripts/@hotwired--turbo.js" data-turbo-track="reload"></script>
<script src="javascripts/clipboard.js" data-turbo-track="reload"></script>
<script src="javascripts/guides.js" data-turbo-track="reload"></script>
<meta property="og:title" content="Testing and Refactoring — Ruby on Rails Guides" />
<meta name="description" content="Testing and RefactoringThis guide will explain why you should write tests for your web application. It covers built-in mechanisms offered by Rails. By referring to this guide, you will be able to: Understand Rails testing terminology Write unit and integration tests for your application This chapter is still a work in progress. You can help by reviewing the documents and posting your comments and corrections." />
<meta property="og:description" content="Testing and RefactoringThis guide will explain why you should write tests for your web application. It covers built-in mechanisms offered by Rails. By referring to this guide, you will be able to: Understand Rails testing terminology Write unit and integration tests for your application This chapter is still a work in progress. You can help by reviewing the documents and posting your comments and corrections." />
<meta property="og:locale" content="en_US" />
<meta property="og:site_name" content="Textbook Backend Developemnt" />
<meta property="og:image" content="images/backend-development.svg" />
<meta property="og:type" content="website" />
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Noto+Sans+Arabic:wght@100..900&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Heebo:wght@100..900&family=Noto+Sans+Arabic:wght@100..900&display=swap" rel="stylesheet">
<meta name="theme-color" content="#2e56e9">
</head>
<body class="guide">
<header id="page_header">
<div class="wrapper clearfix">
<nav id="feature_nav">
<div class="header-logo">
<a href="/">Backend Development</a>
</div>
<ul class="nav">
<li><a class="nav-item" id="home_nav" href="/">Home</a></li>
<li class="guides-index guides-index-large">
<a href="index.html" id="guidesMenu" class="guides-index-item nav-item">Index</a>
<div id="guides" class="clearfix" style="display: none;">
<hr />
<dl class="guides-section-container">
<div class="guides-section">
<dt>Ruby on Rails</dt>
<dd><a href="ruby_commandline.html">Ruby Commandline</a></dd>
<dd><a href="rails_database_and_model.html">Models and ActiveRecord</a></dd>
<dd><a href="rails_db.html">Database and Migrations</a></dd>
<dd><a href="rails_associations_and_validations.html">Associations and Validations</a></dd>
<dd><a href="rails_view_and_controller.html">Routing, View and Controller</a></dd>
<dd><a href="rails_authentication.html">Simple Authentication</a></dd>
<dd><a href="assets_and_import_map.html">The Asset Pipeline and Importmaps</a></dd>
<dd><a href="testing.html">Getting started with Testing</a></dd>
<dd><a href="refactoring_rails.html">Refactoring Rails</a></dd>
<dd><a href="deploy-to-paas.html">Deploy to PAAS</a></dd>
<dd><a href="rails_gems.html">Ruby Gems for your Rails Project</a></dd>
<dd><a href="deploying_rails.html">Deploying Rails</a></dd>
</div>
<div class="guides-section">
<dt>Ruby on Rails - Advanced Topics</dt>
<dd><a href="deploy-to-paas.html">Deploy to PAAS</a></dd>
<dd><a href="rest-api.html">REST API</a></dd>
<dd><a href="graphql-api.html">GraphQL API</a></dd>
<dd><a href="rails_websockets.html">Websocket in Rails</a></dd>
<dd><a href="jobs_and_tasks.html">Jobs and Tasks in Rails</a></dd>
<dd><a href="rails_security.html">Rails Security</a></dd>
</div>
<div class="guides-section">
<dt>Overarching Concerns</dt>
<dd><a href="issue.html">Issue Lifecycle</a></dd>
<dd><a href="security.html">Security</a></dd>
<dd><a href="adv_authentication.html">Advanced Authentication</a></dd>
<dd><a href="caching.html">Caching</a></dd>
<dd><a href="advanced_testing.html">Advanced Testing</a></dd>
<dd><a href="internationalization.html">Internationalization (I18n)</a></dd>
<dd><a href="git_rebasing.html">Git Rebasing</a></dd>
</div>
<div class="guides-section">
<dt>Nodes.js</dt>
<dd><a href="node_vs_rails.html">Node vs. Rails</a></dd>
<dd><a href="node_basics.html">Node Basics</a></dd>
<dd><a href="node_websockets.html">Node Websockets</a></dd>
<dd><a href="node_express.html">Node Web App</a></dd>
<dd><a href="node_cluster.html">Scaling Node</a></dd>
</div>
<div class="guides-section">
<dt>Next.js</dt>
<dd><a href="nextjs.html">Next.js</a></dd>
</div>
</dl>
</div>
</li>
<li class="guides-index guides-index-small">
<select class="guides-index-item nav-item">
<option value="index.html">Index</option>
<optgroup label="Ruby on Rails">
<option value="ruby_commandline.html">Ruby Commandline</option>
<option value="rails_database_and_model.html">Models and ActiveRecord</option>
<option value="rails_db.html">Database and Migrations</option>
<option value="rails_associations_and_validations.html">Associations and Validations</option>
<option value="rails_view_and_controller.html">Routing, View and Controller</option>
<option value="rails_authentication.html">Simple Authentication</option>
<option value="assets_and_import_map.html">The Asset Pipeline and Importmaps</option>
<option value="testing.html">Getting started with Testing</option>
<option value="refactoring_rails.html">Refactoring Rails</option>
<option value="deploy-to-paas.html">Deploy to PAAS</option>
<option value="rails_gems.html">Ruby Gems for your Rails Project</option>
<option value="deploying_rails.html">Deploying Rails</option>
</optgroup>
<optgroup label="Ruby on Rails - Advanced Topics">
<option value="deploy-to-paas.html">Deploy to PAAS</option>
<option value="rest-api.html">REST API</option>
<option value="graphql-api.html">GraphQL API</option>
<option value="rails_websockets.html">Websocket in Rails</option>
<option value="jobs_and_tasks.html">Jobs and Tasks in Rails</option>
<option value="rails_security.html">Rails Security</option>
</optgroup>
<optgroup label="Overarching Concerns">
<option value="issue.html">Issue Lifecycle</option>
<option value="security.html">Security</option>
<option value="adv_authentication.html">Advanced Authentication</option>
<option value="caching.html">Caching</option>
<option value="advanced_testing.html">Advanced Testing</option>
<option value="internationalization.html">Internationalization (I18n)</option>
<option value="git_rebasing.html">Git Rebasing</option>
</optgroup>
<optgroup label="Nodes.js">
<option value="node_vs_rails.html">Node vs. Rails</option>
<option value="node_basics.html">Node Basics</option>
<option value="node_websockets.html">Node Websockets</option>
<option value="node_express.html">Node Web App</option>
<option value="node_cluster.html">Scaling Node</option>
</optgroup>
<optgroup label="Next.js">
<option value="nextjs.html">Next.js</option>
</optgroup>
</select>
</li>
</ul>
</nav>
</div>
</header>
<hr class="hide" />
<section id="feature">
<div class="wrapper">
<h1>Testing and Refactoring</h1><p>This guide will explain why you should write tests
for your web application. It covers built-in mechanisms offered by Rails.
By referring to this guide, you will be able to:</p>
<ul>
<li>Understand Rails testing terminology</li>
<li>Write unit and integration tests for your application</li>
</ul>
<dd class="work-in-progress"><p>This chapter is still a work in progress. </p>
<p>You can help by reviewing the documents and posting your comments and corrections.</p></dd>
<nav id="subCol">
<h3 class="chapter">
<picture>
<!-- Using the `source` HTML tag to set the dark theme image -->
<source
srcset="images/icon_book-close-bookmark-1-wht.svg"
media="(prefers-color-scheme: dark)"
/>
<img src="images/icon_book-close-bookmark-1.svg" alt="Chapter Icon" />
</picture>
Chapters
</h3>
<ol class="chapters">
<li><a href="#why-test-questionmark">Why Test?</a>
<ul>
<li><a href="#for-beginners-two-testing-levels">for beginners: two testing levels</a></li>
<li><a href="#rails-and-testing">rails and testing</a></li>
<li><a href="#my-first-test">my first test</a></li>
<li><a href="#my-first-integration-test">my first integration test</a></li>
<li><a href="#see-documentation">see documentation</a></li>
</ul></li>
<li><a href="#test-driven-development-tdd">Test Driven Development (TDD)</a>
<ul>
<li><a href="#what-is-test-first-questionmark">what is "test first" ?</a></li>
<li><a href="#what-is-tdd-questionmark">what is "TDD" ?</a></li>
</ul></li>
<li><a href="#code-refactoring">Code Refactoring</a>
<ul>
<li><a href="#what-is-code-refactoring-questionmark">what is "code refactoring" ?</a></li>
<li><a href="#refactoring-and-testing">refactoring and testing</a></li>
</ul></li>
</ol>
</nav>
<hr>
</div>
</section>
<main id="container">
<div class="wrapper">
<div id="mainCol">
<div class='slide'>
</div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-0' href='slides_testing_and_refactoring.html#/0'>◻</a></p>
<h2 id="why-test-questionmark"><a class="anchorlink" href="#why-test-questionmark"><span>1</span> Why Test?</a></h2>
<ul>
<li>to know if the program works (as specified)</li>
<li>to know if it still works after refactoring</li>
<li>to know if it still works after adding a new feature</li>
<li>to know if it still works ...</li>
</ul>
</div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-1' href='slides_testing_and_refactoring.html#/1'>◻</a></p>
<h3 id="for-beginners-two-testing-levels"><a class="anchorlink" href="#for-beginners-two-testing-levels"><span>1.1</span> for beginners: two testing levels</a></h3>
<ul>
<li>unit testing - models</li>
<li>integration testing - like a browser</li>
</ul>
</div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-2' href='slides_testing_and_refactoring.html#/2'>◻</a></p>
<h3 id="rails-and-testing"><a class="anchorlink" href="#rails-and-testing"><span>1.2</span> rails and testing</a></h3>
<ul>
<li>testing built in</li>
<li>scaffold creates (empty) tests</li>
<li>testing environment</li>
<li>run all tests with <code>rake:test</code></li>
<li>run all tests with <code>rake test TESTOPTS="-v"</code></li>
</ul>
</div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-3' href='slides_testing_and_refactoring.html#/3'>◻</a></p>
<h3 id="my-first-test"><a class="anchorlink" href="#my-first-test"><span>1.3</span> my first test</a></h3><div class="interstitial code">
<pre><code class="highlight ruby"><span class="c1"># in file test/unit/user_test.rb</span>
<span class="nb">test</span> <span class="s2">"no_stars is zero in new user"</span> <span class="k">do</span>
<span class="n">u</span> <span class="o">=</span> <span class="no">User</span><span class="p">.</span><span class="nf">create!</span><span class="p">(</span><span class="ss">:first_name</span><span class="o">=></span><span class="s2">"John"</span><span class="p">,</span> <span class="ss">:last_name</span><span class="o">=></span><span class="s2">"Doe"</span><span class="p">)</span>
<span class="n">assert</span> <span class="n">u</span><span class="p">.</span><span class="nf">no_stars</span> <span class="o">==</span> <span class="mi">0</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="# in file test/unit/user_test.rb
test "no_stars is zero in new user" do
u = User.create!(:first_name=>"John", :last_name=>"Doe")
assert u.no_stars == 0
end
">Copy</button>
</div>
</div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-4' href='slides_testing_and_refactoring.html#/4'>◻</a></p>
<h3 id="my-first-integration-test"><a class="anchorlink" href="#my-first-integration-test"><span>1.4</span> my first integration test</a></h3><div class="interstitial code">
<pre><code class="highlight ruby"><span class="nb">test</span> <span class="s2">"users are displayed"</span> <span class="k">do</span>
<span class="n">u</span> <span class="o">=</span> <span class="no">User</span><span class="p">.</span><span class="nf">create!</span><span class="p">(</span><span class="ss">:first_name</span><span class="o">=></span><span class="s2">"Jane"</span><span class="p">,</span> <span class="ss">:last_name</span><span class="o">=></span><span class="s2">"Doe"</span><span class="p">)</span>
<span class="n">visit</span> <span class="s2">"/users"</span>
<span class="n">assert</span> <span class="n">page</span><span class="p">.</span><span class="nf">has_content?</span><span class="p">(</span><span class="s1">'Gib ein Sternchen!'</span><span class="p">)</span>
<span class="n">assert</span> <span class="n">page</span><span class="p">.</span><span class="nf">has_content?</span><span class="p">(</span><span class="s1">'Jane Doe'</span><span class="p">)</span>
<span class="k">end</span>
</code></pre>
<button class="clipboard-button" data-clipboard-text="test "users are displayed" do
u = User.create!(:first_name=>"Jane", :last_name=>"Doe")
visit "/users"
assert page.has_content?('Gib ein Sternchen!')
assert page.has_content?('Jane Doe')
end
">Copy</button>
</div>
</div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-5' href='slides_testing_and_refactoring.html#/5'>◻</a></p>
<h3 id="see-documentation"><a class="anchorlink" href="#see-documentation"><span>1.5</span> see documentation</a></h3>
<ul>
<li><a href="https://guides.rubyonrails.org/testing.html">Guide to Testing Rails Applications</a></li>
<li><a href="https://topfunky.com/clients/rails/ruby_and_rails_assertions.pdf">Test::Unit Cheatsheet</a></li>
<li><a href="https://gist.github.com/3942267">Capybara Cheat Sheet</a></li>
</ul>
</div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-6' href='slides_testing_and_refactoring.html#/6'>◻</a></p>
<h2 id="test-driven-development-tdd"><a class="anchorlink" href="#test-driven-development-tdd"><span>2</span> Test Driven Development (TDD)</a></h2></div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-7' href='slides_testing_and_refactoring.html#/7'>◻</a></p>
<h3 id="what-is-test-first-questionmark"><a class="anchorlink" href="#what-is-test-first-questionmark"><span>2.1</span> what is "test first" ?</a></h3>
<ol>
<li>write a test (it fails)</li>
<li>write the implementation (test still fails)</li>
<li>fix the implementation </li>
<li>test passes: you're done!</li>
</ol>
</div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-8' href='slides_testing_and_refactoring.html#/8'>◻</a></p>
<h3 id="what-is-tdd-questionmark"><a class="anchorlink" href="#what-is-tdd-questionmark"><span>2.2</span> what is "TDD" ?</a></h3>
<ol>
<li>Q: what should the program do? </li>
<li>A: integration test. (write it. it fails)</li>
<li>Q: how should the program do it?</li>
<li>A: unit test. (write it. it fails)</li>
<li>implement the unit </li>
<li>does the unit test pass? if not, got back to 5</li>
<li>does the integration test pass? if not, go back to 3</li>
</ol>
</div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-9' href='slides_testing_and_refactoring.html#/9'>◻</a></p>
<h2 id="code-refactoring"><a class="anchorlink" href="#code-refactoring"><span>3</span> Code Refactoring</a></h2></div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-10' href='slides_testing_and_refactoring.html#/10'>◻</a></p>
<h3 id="what-is-code-refactoring-questionmark"><a class="anchorlink" href="#what-is-code-refactoring-questionmark"><span>3.1</span> what is "code refactoring" ?</a></h3>
<ul>
<li>"restructuring an existing body of code</li>
<li>altering its internal structure</li>
<li>without changing its external behavior"</li>
<li>or for short:</li>
<li>change your code:</li>
<li>but only how you do it,</li>
<li>not what you do.</li>
</ul>
</div>
<div class='slide'>
<p class='slide_break_block'><a class='slide_break' id='slide-11' href='slides_testing_and_refactoring.html#/11'>◻</a></p>
<h3 id="refactoring-and-testing"><a class="anchorlink" href="#refactoring-and-testing"><span>3.2</span> refactoring and testing</a></h3>
<ul>
<li>run the unit test (it should be green)</li>
<li>refactor</li>
<li>run the unit test (it should still be green)</li>
<li>done</li>
</ul>
</div>
</div>
</div>
</main>
<hr class="hide" />
<footer id="page_footer">
<div class="wrapper">
<p class="copyright">published under <a href="https://creativecommons.org/licenses/by-nc-sa/3.0/at/deed.de">creative commons by-nc-sa</a> in 2012-2025 by <a href="https://brigitte-jellinek.at">Brigitte Jellinek</a>.
</p>
<p>If you want to contribute: <a href="https://github.com/backend-development/backend-development-textbook/fork">fork the source on github</a>
</p>
<p>Favicon "backend development" by Arkinasi from <a href="https://thenounproject.com/browse/icons/term/backend-development/" target="_blank" title="backend development Icons">Noun Project</a> (CC BY 3.0)</p>
</div>
</footer>
</body>
</html>