ROS workspace and package structure - Practice Problems & Coding Challenges

Challenge - 5 Problems

🧠 Conceptual

intermediate

Understanding the ROS workspace layout

Which directory inside a ROS workspace typically contains the source code of ROS packages?

A install

B src

C build

D devel

💡 Hint

Think about where you put your package folders before building.

The src directory holds the source code of ROS packages inside a workspace. The build and install directories are generated during the build process.

❓ component_behavior

intermediate

Package manifest file role

What is the main purpose of the package.xml file inside a ROS package?

A To declare package dependencies and metadata

B To store launch configurations

C To compile source code

D To list executable nodes

💡 Hint

It tells ROS about your package and what it needs.

The package.xml file declares the package's name, version, maintainer, license, and dependencies. It helps ROS tools understand how to build and use the package.

📝 Syntax

advanced

Correct CMakeLists.txt command for adding executable

Which line correctly adds an executable named talker from source file talker.cpp in a ROS package's CMakeLists.txt?

A add_executable(talker)

B add_executable(talker.cpp talker)

C add_executable(talker.cpp)

D add_executable(talker talker.cpp)

💡 Hint

The first argument is the executable name, the second is the source file.

The add_executable command takes the executable name first, then the source files. Option D follows this syntax correctly.

❓ state_output

advanced

Result of building a ROS workspace

After running colcon build in a ROS workspace, which directory contains the setup files to source for environment setup?

A build

B src

C install

D devel

💡 Hint

This directory holds the final installed files and setup scripts.

The install directory contains the setup files like setup.bash that you source to configure your environment after building.

🔧 Debug

expert

Identifying error in package structure

You created a ROS package but when building, you get an error saying package.xml not found. Which of the following is the most likely cause?

A The package folder is not inside the workspace's src directory

B The workspace was not initialized with colcon

C The package.xml file has incorrect XML syntax

D The package folder is missing the CMakeLists.txt file

💡 Hint

ROS expects packages in a specific place inside the workspace.

If the package folder is not inside the src directory of the workspace, ROS build tools cannot find the package.xml file, causing this error.

Practice

1. What is the main purpose of a ROS workspace?

easy

A. To organize multiple ROS packages and build them together

B. To store robot hardware components physically

C. To run ROS nodes directly without packages

D. To replace the operating system for robots

Solution

1. Step 1: Understand what a ROS workspace is

   A ROS workspace is a directory where you keep your ROS packages organized and ready to build.

2. Step 2: Identify the workspace role

   The workspace allows you to build all packages together and manage dependencies easily.

3. Final Answer:

   To organize multiple ROS packages and build them together -> Option A

4. Quick Check:

   Workspace = Organize and build packages [OK]

Hint: Workspace groups packages for building and management [OK]

Common Mistakes:

• Confusing workspace with physical robot parts
• Thinking workspace runs nodes directly
• Assuming workspace replaces OS

2. Which file must every ROS package contain to define its metadata?

easy

A. package.xml

B. CMakeLists.txt

C. README.md

D. setup.py

Solution

1. Step 1: Identify metadata files in ROS packages

   Every ROS package must have a package.xml file that describes the package name, version, dependencies, and other metadata.

2. Step 2: Differentiate from build files

   CMakeLists.txt is for build instructions, not metadata. README.md is documentation, and setup.py is for Python packages but not mandatory in ROS.

3. Final Answer:

   package.xml -> Option A

4. Quick Check:

   Metadata file = package.xml [OK]

Hint: Metadata always in package.xml file [OK]

Common Mistakes:

• Confusing CMakeLists.txt with metadata
• Thinking README.md defines package info
• Assuming setup.py is mandatory for all packages

3. Given a ROS workspace with packages pkg1 and pkg2, what happens after running colcon build and then source install/setup.bash?

medium

A. The packages are deleted from the workspace

B. Only pkg1 is built and pkg2 is ignored

C. The workspace is built and environment is set to use the packages

D. The ROS master node starts automatically

Solution

1. Step 1: Understand colcon build role

   This command builds all packages in the workspace, compiling code and preparing install files.

2. Step 2: Understand source install/setup.bash role

   This command sets environment variables so ROS can find and use the newly built packages.

3. Final Answer:

   The workspace is built and environment is set to use the packages -> Option C

4. Quick Check:

   Build + source = ready to use packages [OK]

Hint: Build then source to use packages in ROS [OK]

Common Mistakes:

• Thinking only one package builds
• Assuming packages get deleted after build
• Believing ROS master starts automatically

4. You created a new package inside your ROS workspace but forgot to run colcon build. What problem will you face?

medium

A. The package will run but with errors

B. The package will build automatically when you run any node

C. The package will be deleted from the workspace

D. ROS will not recognize the new package when you try to use it

Solution

1. Step 1: Understand build necessity

   ROS requires running colcon build to compile and register new packages in the workspace environment.

2. Step 2: Consequence of skipping build

   If you skip building, ROS environment does not know about the new package, so it cannot find or use it.

3. Final Answer:

   ROS will not recognize the new package when you try to use it -> Option D

4. Quick Check:

   Build missing = package not recognized [OK]

Hint: Always build after adding new packages [OK]

Common Mistakes:

• Assuming packages build automatically
• Thinking package deletion happens without build
• Believing package runs with errors without build

5. You want to add a new ROS package that depends on an existing package std_msgs. Which steps correctly update your workspace to include this dependency?

hard

A. Run rosdep install std_msgs without modifying any files

B. Add std_msgs to package.xml dependencies, update CMakeLists.txt, then run colcon build

C. Delete package.xml and create a new one with std_msgs listed

D. Only add std_msgs to README.md and run colcon build

Solution

1. Step 1: Add dependency in package.xml

   You must declare std_msgs as a dependency in package.xml so ROS knows your package needs it.

2. Step 2: Update CMakeLists.txt for build

   Modify CMakeLists.txt to find and link std_msgs during build.

3. Step 3: Build workspace

   Run colcon build to compile your package with the new dependency.

4. Final Answer:

   Add std_msgs to package.xml dependencies, update CMakeLists.txt, then run colcon build -> Option B

5. Quick Check:

   Declare dependency + update build + build workspace [OK]

Hint: Declare dependencies in package.xml and CMakeLists.txt before build [OK]

Common Mistakes:

• Only updating README.md without build changes
• Deleting package.xml unnecessarily
• Relying on rosdep without declaring dependencies