mirror of
https://github.com/cpm-cmake/CPM.cmake.git
synced 2025-11-17 14:47:30 -05:00
c58e98a0a0
* Initial commit for integration tests. Experimental. Playing with potential syntax
* Some experimental code to setup tests
* Piecewise building of CMakeLists
* First check
* Alternative approach. Using ruby's test/unit
* Parse CMakeCache. Separate lib
* First integration test
* Latest Format.cmake. Passing style
* Allow user-provided integration test dir. Allow reuse
* Separate class with utils for cache (no longer pure Hash)
* Allow running of tests from any dir
* Add integration tests to CI
* Use an in-source integration test directory
* Allow relative integration test dir from env
* Custom assertion for a success of CommandResult
* Windows-latest-latest
* Enrich CMakeCache class with more CPM data
* Added test for CPM-specific CMakeCache values
* Style
* Style
* test_update_single_package
* WiP for source cache test
* Small source_cache test
* Style
* Moved env clean to cleanup to make setup methods simpler (not require super)
* WiP for integration test documentation
* WiP for integration test documentation
* Project file creation tweaks
* Split docs into multiple files. Complete tutorial. Reference.
* Tips
* Typo
* Setup Ruby inistead of requiring windows-2022
* Revert "Setup Ruby inistead of requiring windows-2022"
This reverts commit 8aa2732145.
99 lines
2.5 KiB
Markdown
99 lines
2.5 KiB
Markdown
# Notable Idiosyncrasies When Writing Integration Tests
|
|
|
|
As an integration test framework based on a unit test framework the one created for CPM.cmake suffers from several idiosyncrasies. Make sure you familiarize yourself with them before writing integration tests.
|
|
|
|
## No shared instance variables between methods
|
|
|
|
The runner will create an instance of the test class for each test method. This means that instance variables defined in a test method, *will not* be visible in another. For example:
|
|
|
|
```ruby
|
|
class MyTest < IntegrationTest
|
|
def test_something
|
|
@x = 123
|
|
assert_equal 123, @x # Pass. @x is 123
|
|
end
|
|
def test_something_else
|
|
assert_equal 123, @x # Fail! @x would be nil here
|
|
end
|
|
end
|
|
```
|
|
|
|
There are hacks around sharing Ruby state between methods, but we choose not to use them. If you want to initialize something for all test methods, use `setup`.
|
|
|
|
```ruby
|
|
class MyTest < IntegrationTest
|
|
def setup
|
|
@x = 123
|
|
end
|
|
def test_something
|
|
assert_equal 123, @x # Pass. @x is 123 thanks to setup
|
|
end
|
|
def test_something_else
|
|
assert_equal 123, @x # Pass. @x is 123 thanks to setup
|
|
end
|
|
end
|
|
```
|
|
|
|
## `IntegrationTest` makes use of `Test::Unit::TestCase#cleanup`
|
|
|
|
After each test method the `cleanup` method is called thanks to Test::Unit. If you require the use of `cleanup` in your own tests, make sure you call `super` to also run `IntegrationTest#cleanup`.
|
|
|
|
```ruby
|
|
class MyTest < IntegrationTest
|
|
def cleanup
|
|
super
|
|
my_cleanup
|
|
end
|
|
# ...
|
|
end
|
|
```
|
|
|
|
## It's better to have assertions in test methods as opposed to helper methods
|
|
|
|
Test::Unit will display a helpful message if an assertion has failed. It will also include the line of code in the test method which caused the failure. However if an assertion is not in the test method, it will display the line which calls the method in which it is. So, please try, to have most assertions in test methods (though we acknowledge that in certain cases this is not practical). For example, if you only require scopes, try using lambdas.
|
|
|
|
Instead of this:
|
|
|
|
```ruby
|
|
class MyTest < IntegrationTest
|
|
def test_something
|
|
do_a
|
|
do_b
|
|
do_c
|
|
end
|
|
def do_a
|
|
# ...
|
|
end
|
|
def do_b
|
|
# ...
|
|
assert false # will display failed line as "do_b"
|
|
end
|
|
def do_c
|
|
# ...
|
|
end
|
|
end
|
|
```
|
|
|
|
...write this:
|
|
|
|
```ruby
|
|
class MyTest < IntegrationTest
|
|
def test_something
|
|
do_a = -> {
|
|
# ...
|
|
}
|
|
do_b = -> {
|
|
# ...
|
|
assert false # will display failed line as "assert false"
|
|
}
|
|
do_c = -> {
|
|
# ...
|
|
}
|
|
|
|
do_a.()
|
|
do_b.()
|
|
do_c.()
|
|
end
|
|
end
|
|
```
|