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

feat: apply autoware_ prefix for evaluator/kinematic_evaluator #9936

Conversation

sasakisasaki
Copy link
Contributor

@sasakisasaki sasakisasaki commented Jan 16, 2025

Description

This pull request addresses the issue of inconsistent naming by adding the autoware_ prefix to relevant components. This change ensures uniformity across the codebase and aligns with the project's naming conventions.

Related Links

How was this PR tested?

Currently, we only verified that the build succeeds. Further checks will be performed by using the updated module. This PR will be ready for review after finishing all the necessary checks/tests.

Executed Commands (which succeeded)

$ # Around 19:00 JST 21st Jan. 2025
$ vcs import src < autoware-nighty.repos    # Commented out autoware.universe repo
$ rosdep install -y --from-paths src --ignore-src --rosdistro humble
$ colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=ON --packages-up-to autoware_kinematic_evaluator
$ colcon test --packages-select autoware_kinematic_evaluator
$ colcon test-result --verbose
  • Directory Name

    • Add autoware_ as a prefix to the directory name.
  • packages.xml

    • Add autoware_ to the name element.
  • CMakeLists.txt

    • Change the project name to autoware_***.
    • Add autoware:: to PLUGIN.
  • Header Files (.hpp)

    • Start #ifndef guards with AUTOWARE__.
    • Add autoware:: to namespace.
  • Source Files (.cpp)

    • Add autoware:: inside RCLCPP_COMPONENTS_REGISTER_NODE.
  • Launch Files

    • Add autoware_ before find-pkg-share.
    • Change node pkg="<pkgname>" to autoware_<pkgname>.
  • Include

    • Add autoware folder as necessary and update include statements accordingly.
    • Check for impacts on other packages.
  • Verification Points

    • Search find-pkg-share in autoware
    • Check README file (especially json schema)
    • Pay attention to complex cases like sensor_launch as seen in gnss_poser

Notes for Reviewers

None.

Interface Changes

None.

Effects on System Behavior

All the developers who were using kinematic_evaluator needs to modify their code. This is maybe kind of non quick-win task.

  * In this commit, I did not organize a folder structure.
    The folder structure will be organized in the next some commits.

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
…include/autoware`:

  * Fixes due to this changes for .hpp/.cpp files will be applied in the next commit

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
…mmit

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:evaluator Evaluation tools for planning, localization etc. (auto-assigned) labels Jan 16, 2025
Copy link

github-actions bot commented Jan 16, 2025

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

@sasakisasaki sasakisasaki changed the title Feat apply autoware prefix for evaluator kinematic evaluator feat: apply autoware_ prefix for evaluator kinematic evaluator Jan 16, 2025
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki sasakisasaki changed the title feat: apply autoware_ prefix for evaluator kinematic evaluator feat: apply autoware_ prefix for evaluator/kinematic_evaluator Jan 16, 2025
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki sasakisasaki added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jan 17, 2025
@sasakisasaki sasakisasaki marked this pull request as ready for review January 20, 2025 02:29
Copy link

codecov bot commented Jan 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 29.53%. Comparing base (972f445) to head (5a8f131).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9936      +/-   ##
==========================================
- Coverage   29.78%   29.53%   -0.25%     
==========================================
  Files        1435     1430       -5     
  Lines      108277   107813     -464     
  Branches    42946    42824     -122     
==========================================
- Hits        32249    31847     -402     
+ Misses      72898    72897       -1     
+ Partials     3130     3069      -61     
Flag Coverage Δ *Carryforward flag
differential 5.15% <100.00%> (?)
total 29.49% <ø> (-0.29%) ⬇️ Carriedforward from f4b3eca

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

sasakisasaki and others added 4 commits January 21, 2025 19:36
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
…ematic-evaluator

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
…uator' of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-evaluator-kinematic-evaluator

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@github-actions github-actions bot added the type:ci Continuous Integration (CI) processes and testing. (auto-assigned) label Jan 21, 2025
Copy link
Contributor

@SakodaShintaro SakodaShintaro left a comment

Choose a reason for hiding this comment

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

LGTM

@sasakisasaki sasakisasaki marked this pull request as draft January 24, 2025 01:52
@sasakisasaki sasakisasaki marked this pull request as ready for review January 24, 2025 01:52
Signed-off-by: Ryohsuke Mitsudome <ryohsuke.mitsudome@tier4.jp>
@mitsudome-r
Copy link
Member

The evaluator result (TIER IV Internal link):
https://evaluation.ci.tier4.jp/evaluation/reports/53e058e2-47af-559a-974f-6c3520d709b5?project_id=prd_jt

@mitsudome-r mitsudome-r merged commit 5872113 into autowarefoundation:main Jan 24, 2025
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:evaluator Evaluation tools for planning, localization etc. (auto-assigned) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) type:ci Continuous Integration (CI) processes and testing. (auto-assigned) type:documentation Creating or refining documentation. (auto-assigned)
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants