Skip to content

Commit 9e2075c

Browse files
committed
Update test/debugging tutorial
- Fixed the RST syntax for source blocks - Replaced Travis with GHA
1 parent 3d69f8e commit 9e2075c

File tree

1 file changed

+12
-18
lines changed

1 file changed

+12
-18
lines changed

doc/test_debugging/test_debugging_tutorial.rst

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,27 @@ If you haven't already done so, make sure you've completed the steps in `Getting
1212
CI Failures
1313
-----------
1414

15-
Our CI runs in Travis and uses scripts found in the `moveit_ci repo <https://github.com/ros-planning/moveit_ci.git>`. These tests build and run various tests in various environments. Often something that works locally won't work in CI in a different environment. To troubleshoot a failure from CI it is useful to use docker to run in the same environment.
15+
Our CI runs on Github Actions and uses scripts found in `industrial_ci <https://github.com/ros-industrial/industrial_ci.git>`_. These tests build and run various tests in various environments. Often something that works locally won't work in CI in a different environment. To troubleshoot a failure from CI it is useful to use docker to run in the same environment.
1616

17-
For troubleshooting a specific travis test it is helpful to look at the .travis.yml config file and test output to understand what environment variables are being set in your test.
17+
For troubleshooting a specific test it is helpful to inspect the GHA logs to understand what environment variables are being set in your test.
1818

1919
Launch Docker Environment
2020
-------------------------
2121

22-
To start docker container for kinetic:
22+
To start docker container::
2323

24-
docker pull moveit/moveit:kinetic-ci
25-
docker run -it moveit/moveit:kinetic-ci /bin/bash
26-
27-
To start docker container for melodic:
28-
29-
docker pull moveit/moveit:melodic-ci
30-
docker run -it moveit/moveit:melodic-ci /bin/bash
24+
docker run -it moveit/moveit:noetic-ci /bin/bash
3125

3226
Setup Environment
3327
-----------------
3428

35-
The first thing you should do is update debians and install tools you'll need for debugging. The update is important because that is what we do in CI.
29+
The first thing you should do is update debians and install tools you'll need for debugging. The update is important because that is what we do in CI::
3630

3731
apt-get update
3832
apt-get dist-upgrade
3933
apt-get install -y python-catkin-tools ssh git gdb valgrind vim
4034

41-
Next create the folder structure for your ROS environment:
35+
Next create the folder structure for your ROS environment::
4236

4337
CATKIN_WS=/root/ros_ws
4438
mkdir -p ${CATKIN_WS}/src
@@ -47,7 +41,7 @@ Next create the folder structure for your ROS environment:
4741
Checkout Code
4842
-------------
4943

50-
In this step we use git and wstool to get the code we will be testing. You'll replace the remote and branch with yours if you are debugging a PR. Note that on the wstool update step we'll need to skip replacing moveit if we are testing a specific branch from a PR.
44+
In this step we use git and wstool to get the code we will be testing. You'll replace the remote and branch with yours if you are debugging a PR. Note that on the wstool update step we'll need to skip replacing moveit if we are testing a specific branch from a PR::
5145

5246
cd ${CATKIN_WS}/src
5347
wstool init .
@@ -58,15 +52,15 @@ In this step we use git and wstool to get the code we will be testing. You'll r
5852
Install Dependencies
5953
--------------------
6054

61-
Here we install debian dependencies with rosdep:
55+
Here we install debian dependencies with rosdep::
6256

6357
cd ${CATKIN_WS}/src
6458
rosdep install -y -q -n --from-paths . --ignore-src --rosdistro ${ROS_DISTRO}
6559

6660
Configure and Build
6761
-------------------
6862

69-
Now we configure and build our workspace. Note that we set extra CXXFLAGS to be the same as the ones used by moveit_ci.
63+
Now we configure and build our workspace. Note that we set extra CXXFLAGS to be the same as the ones used by moveit_ci::
7064

7165
cd $CATKIN_WS
7266
export CXXFLAGS="-Wall -Wextra -Wwrite-strings -Wunreachable-code -Wpointer-arith -Wredundant-decls"
@@ -76,22 +70,22 @@ Now we configure and build our workspace. Note that we set extra CXXFLAGS to be
7670
Build the Tests
7771
---------------
7872

79-
Here is the command to build the tests in the workspace:
73+
Here is the command to build the tests in the workspace::
8074

8175
cd ${CATKIN_WS}
8276
catkin build --summarize --make-args tests
8377

8478
Run the Tests
8579
-------------
8680

87-
To run all the tests we can use the run_tests cmake arg. Here we should specify a specific package we want to test as that will speed up this run.
81+
To run all the tests we can use the run_tests cmake arg. Here we should specify a specific package we want to test as that will speed up this run::
8882

8983
catkin build --summarize --catkin-make-args run_tests -- moveit_ros_planning_interface
9084

9185
Run One Test
9286
------------
9387

94-
You can also use rostest to run a specific test. The text argument sends output to the console instead of an xml output file. To do this you'll have to source the devel workspace.
88+
You can also use rostest to run a specific test. The text argument sends output to the console instead of an xml output file. To do this you'll have to source the devel workspace::
9589

9690
cd ${CATKIN_WS}
9791
source devel/setup.bash

0 commit comments

Comments
 (0)