Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ros2 lights integration tests #408

Merged
merged 9 commits into from
Sep 13, 2024
Merged

Conversation

pawelirh
Copy link
Contributor

@pawelirh pawelirh commented Sep 11, 2024

Description

  • Fixed mistake copyright
  • Segregated test files between unit and integration
  • Implemented integration tests for the panther_lights package

Requirements

  • Code style guidelines followed
  • Documentation updated

Tests 🧪

  • Robot
  • Container
  • Simulation

Summary by CodeRabbit

  • New Features

    • Updated copyright notice to reflect new ownership.
    • Introduced a new option to enable or disable integration tests.
    • Added a new integration test suite for the panther_lights package, ensuring robust testing of LED control functionalities.
    • Introduced a utility for retrieving information about ROS 2 nodes.
  • Bug Fixes

    • None
  • Documentation

    • None
  • Refactor

    • Restructured test file paths for better organization.
  • Chores

    • Updated copyright year in the relevant files.

Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Walkthrough

The pull request introduces changes across multiple files, focusing on updating copyright notices, restructuring test file paths, and enhancing the testing framework for the panther_lights package. Key modifications include the addition of integration tests, updates to the CMakeLists.txt file for improved organization, and the introduction of utility functions for interacting with ROS nodes.

Changes

File Path Change Summary
panther_diagnostics/test/integration/system_monitor_node.test.py Updated copyright notice from "Copyright 2022 TIER IV, Inc." to "Copyright 2024 Husarion sp. z o.o."
panther_lights/CMakeLists.txt Restructured test file paths, added an option for integration tests, and specified a new integration test script location.
panther_lights/test/integration/panther_lights.test.py Introduced a new file containing integration tests using unittest, focusing on the setup and validation of ROS nodes for LED control functionalities.
panther_utils/panther_utils/integration_test_utils.py Added a new utility file for interacting with ROS nodes, including functionality to retrieve node information via command execution.

Possibly related PRs

  • Ros2 lights tests #407: The changes in CMakeLists.txt in both the main PR and this PR involve modifications to the testing framework, specifically related to the organization and dependencies for testing, indicating a direct connection in the context of enhancing the testing setup.

Tip

OpenAI O1 model for chat
  • We have deployed OpenAI's latest O1 model for chat.
  • OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
  • Please share any feedback with us in the discussions post.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ffc4fe6 and 962719b.

Files selected for processing (1)
  • panther_utils/panther_utils/integration_test_utils.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • panther_utils/panther_utils/integration_test_utils.py

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@pawelirh pawelirh marked this pull request as ready for review September 12, 2024 06:37
@KmakD KmakD self-requested a review September 12, 2024 12:53
panther_lights/CMakeLists.txt Show resolved Hide resolved
panther_lights/test/integration/panther_lights.test.py Outdated Show resolved Hide resolved
panther_lights/test/integration/panther_lights.test.py Outdated Show resolved Hide resolved
self.set_led_animation_client.wait_for_service(timeout_sec=1.0)
self.set_led_animation_client.call_async(request)

def test_msg_publishers(self):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a simple way to check msg subscribers? Like check if lights_driver_node is subscribed to frame topics?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added new functionality 👍🏼

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3f9d608 and 9eb271c.

Files selected for processing (2)
  • panther_lights/test/integration/panther_lights.test.py (1 hunks)
  • panther_utils/panther_utils/integration_test_utils.py (1 hunks)
Files skipped from review due to trivial changes (1)
  • panther_lights/test/integration/panther_lights.test.py
Additional comments not posted (2)
panther_utils/panther_utils/integration_test_utils.py (2)

21-33: LGTM!

The ROSNodeInfo class is a simple and effective data class to represent the ROS node info. The attributes cover all the necessary information about a node's communication interfaces.


35-79: Well-structured function implementation.

The get_node_info function follows a clear logic to execute the ros2 node info command and parse its output to populate a ROSNodeInfo object. The use of section_map is a good approach to map the output sections to the corresponding ROSNodeInfo attributes.

Comment on lines 75 to 78
except subprocess.CalledProcessError as e:
print(f"Error executing command: {e}")
print(f"stderr: {e.stderr}")

Copy link
Contributor

@coderabbitai coderabbitai bot Sep 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider raising an exception instead of just printing the error details.

In the except block, instead of just printing the error details, consider raising an exception to allow the caller to handle the error appropriately. This will make the function more robust and easier to use in different contexts.

Apply this diff to raise an exception:

-    except subprocess.CalledProcessError as e:
-        print(f"Error executing command: {e}")
-        print(f"stderr: {e.stderr}")
+    except subprocess.CalledProcessError as e:
+        raise RuntimeError(f"Error executing command: {e}. stderr: {e.stderr}") from e
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
except subprocess.CalledProcessError as e:
print(f"Error executing command: {e}")
print(f"stderr: {e.stderr}")
except subprocess.CalledProcessError as e:
raise RuntimeError(f"Error executing command: {e}. stderr: {e.stderr}") from e

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed error handling

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pawelirh, thank you for updating the error handling!

(/◕ヮ◕)/


If you found this review helpful, would you consider giving us a shout-out on X?
Thank you for using CodeRabbit!

@pawelirh pawelirh requested a review from KmakD September 13, 2024 08:13
@KmakD KmakD merged commit fb78242 into ros2-devel Sep 13, 2024
1 check passed
@KmakD KmakD deleted the ros2-lights-integration-tests branch September 13, 2024 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants