Skip to content

Commit 456b1f6

Browse files
authored
Clarify test tutorial (#662)
1 parent fb8847d commit 456b1f6

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

doc/tests/tests_tutorial.rst

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,33 @@ Getting Started
99
---------------
1010
If you haven't already done so, make sure you've completed the steps in `Getting Started <../getting_started/getting_started.html>`_.
1111

12-
Integration Test
13-
----------------
12+
Integration Tests
13+
-----------------
1414

15-
A Python-based integration test is available for testing higher-level move_group functionality in MoveIt - to run: ::
15+
Python-based integration tests are available for testing higher-level move_group functionality in MoveIt. To run: ::
1616

1717
rostest moveit_ros_planning_interface python_move_group.test
1818

19+
20+
Running Unit Tests
21+
------------------
22+
23+
To run unit tests locally on the entire MoveIt catkin workspace using catkin-tools: ::
24+
25+
catkin run_tests -iv
26+
27+
To run a test for just 1 package, `cd` to the package's directory and run::
28+
29+
catkin run_tests --no-deps --this -iv
30+
31+
To ignore most of the log/print output of the tests::
32+
33+
catkin run_tests --no-status --summarize --no-deps --this
34+
35+
To run a single test, you can execute the compiled file, e.g. from your catkin workspace::
36+
37+
./devel/lib/moveit_core/test_planning_scene
38+
1939
Test Robots
2040
-----------
2141

@@ -31,13 +51,11 @@ From the package `moveit_resources <https://github.com/ros-planning/moveit_resou
3151

3252
roslaunch moveit_resources demo.launch
3353

34-
Unit Tests
35-
----------
3654

3755
Writing Unit Tests
38-
~~~~~~~~~~~~~~~~~~
56+
------------------
3957

40-
The entire test file, with includes, can be seen :codedir:`here <tests>` in the moveit_tutorials GitHub project.
58+
The file below explains how a test is structured, so you can write your own. The entire test file, with includes, can be seen :codedir:`here <tests>` in the moveit_tutorials GitHub project.
4159

4260
MoveIt uses Google Test as a testing framework.
4361

@@ -48,22 +66,6 @@ MoveIt uses Google Test as a testing framework.
4866
.. tutorial-formatter:: ./test/tests.cpp
4967

5068

51-
Running Unit Tests
52-
~~~~~~~~~~~~~~~~~~
53-
54-
To run unit tests locally on the entire MoveIt catkin workspace using catkin-tools: ::
55-
56-
catkin run_tests -iv
57-
58-
To run a test for just 1 package::
59-
60-
catkin run_tests --no-deps --this -iv
61-
62-
To ignore most of the log/print output of the tests::
63-
64-
catkin run_tests --no-status --summarize --no-deps --this
65-
66-
6769
Code Coverage
6870
-------------
6971

0 commit comments

Comments
 (0)