Skip to content

Latest commit

 

History

History
 
 

integration

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
templates
templates
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
idiosyncrasies.md
idiosyncrasies.md
 
 
lib.rb
lib.rb
 
 
reference.md
reference.md
 
 
runner.rb
runner.rb
 
 
test_basics.rb
test_basics.rb
 
 
test_download_command.rb
test_download_command.rb
 
 
test_fetchcontent_compatibility.rb
test_fetchcontent_compatibility.rb
 
 
test_parallelism.rb
test_parallelism.rb
 
 
test_patches_command.rb
test_patches_command.rb
 
 
test_relative_urls.rb
test_relative_urls.rb
 
 
test_remove_source_dir.rb
test_remove_source_dir.rb
 
 
test_simple.rb
test_simple.rb
 
 
test_source_cache.rb
test_source_cache.rb
 
 
test_system_warnings.rb
test_system_warnings.rb
 
 
tips.md
tips.md
 
 
tutorial.md
tutorial.md
 
 
tutorial.rb
tutorial.rb
 
 

README.md

CPM.cmake Integration Tests

The integration tests of CPM.cmake are written in Ruby. They use a custom integration test framework which extends the Test::Unit library.

They require Ruby 2.7.0 or later.

Running tests

To run all tests from the repo root execute:

$ ruby test/integration/runner.rb

The runner will run all tests and generate a report of the execution.

The current working directory doesn't matter. If you are in <repo-root>/test/integration, you can run simply $ ruby runner.rb.

You can execute with --help ($ ruby runner.rb --help) to see various configuration options of the runner like running individual tests or test cases, or ones that match a regex.

The tests themselves are situated in the Ruby scripts prefixed with test_. <repo-root>/test/integration/test_*. You can also run an individual test script. For example to only run the basics test case, you can execute $ ruby test_basics.rb

The tests generate CMake scripts and execute CMake and build toolchains. By default they do this in a directory they generate in your temp path (/tmp/cpm-test/ on Linux). You can configure the working directory of the tests with an environment variable CPM_INTEGRATION_TEST_DIR. For example $ CPM_INTEGRATION_TEST_DIR=~/mycpmtest; ruby runner.rb

Writing tests

Writing tests makes use of the custom integration test framework in lib.rb. It is a relatively small extension of Ruby's Test::Unit library.

The Gist

  • Tests cases are Ruby scripts in this directory. The file names must be prefixed with test_
  • The script should require_relative './lib' to allow for individual execution (or else if will only be executable from the runner)
  • A test case file should contain a single class which inherits from IntegrationTest. It can contain multiple classes, but that's bad practice as it makes individual execution harder and implies a dependency between the classes.
  • There should be no dependency between the test scripts. Each should be executable individually and the order in which multiple ones are executed mustn't matter.
  • The class should contain methods, also prefixed with test_ which will be executed by the framework. In most cases there would be a single test method per class.
  • In case there are multiple test methods, they will be executed in the order in which they are defined.
  • The test methods should contain assertions which check for the expected state of things at various points of the test's execution.

More