Crystal For Rubyists
Search…
book
Chapter 5: Testing
Rubyists love testing, so before we go any farther, let’s talk about testing. In Crystal, there is a testing framework built in, and it’s named
spec. It’s pretty similar to RSpec.Let’s continue with the project we created in Chapter 04.
As you remember
crystal created this project structure for us.1
$ cd sample && tree
2
-- LICENSE
3
-- README.md
4
-- shard.yml
5
-- spec
6
-- sample_spec.cr
7
-- spec_helper.cr
8
-- src
9
-- sample
10
-- version.cr
11
-- sample.cr
Copied!
Did you see that
spec folder? Yes, as you guess Crystal created this folder and the first spec for us. In Crystal a file is tested with corresponding _spec file. Since we named our project as sampleit created a file named sample.cr and the corresponding spec with spec/sample_spec.cr.By the way, in this context
spec and unit test means the same so we can use them interchangeably.Without further ado lets open up
spec/sample_spec.cr1
require "./spec_helper"
2
3
describe Sample do
4
# TODO: Write tests
5
6
it "works" do
7
false.should eq(true)
8
end
9
end
Copied!
Now this file is pretty interesting. There a three important keywords,
describe, it and should.Those keywords are only used in
specs with the following purposes.describelets you group related specs.itis used for defining a spec with the given title in between “”.shouldis used for making assumptions about the spec.
As you can see this file has a group
described as Sample and it has one spec with the title of works which makes the assumption that false should equal true.You might be asking ‘How do we run these tests?’. Well
crystal command to the rescue.1
$ crystal spec
2
F
3
4
Failures:
5
6
1) Sample works
7
Failure/Error: false.should eq(true)
8
9
expected: true
10
got: false
11
12
# ./spec/sample_spec.cr:7
13
14
Finished in 0.69 milliseconds
15
1 examples, 1 failures, 0 errors, 0 pending
16
17
Failed examples:
18
19
crystal spec ./spec/sample_spec.cr:6 # Sample works
Copied!
Yay! We got a failing(red) test. Reading the output we can easily find which spec failed. Here it’s the spec within the group of
Sample titled works a.k.a Sample works. Let’s make it pass(green).1
require "./spec_helper"
2
3
describe Sample do
4
# TODO: Write tests
5
6
it "works" do
7
true.should eq(true)
8
end
9
end
Copied!
Rerun the specs.
1
$ crystal spec
2
3
.
4
5
Finished in 0.63 milliseconds
6
1 examples, 0 failures, 0 errors, 0 pending
Copied!
Green! That’s all you need to know to get started. Next up: FizzBuzz.
Last modified 2yr ago
Copy link