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 scenario_simulator_v2_adapter #9957

Conversation

sasakisasaki
Copy link
Contributor

@sasakisasaki sasakisasaki commented Jan 18, 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_scenario_simulator_v2_adapter
$ colcon test --packages-select autoware_scenario_simulator_v2_adapter
$ 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 scenario_simulator_v2_adapter needs to modify their code. This is maybe kind of non quick-win task.

…x (see below):

  * In this commit, I did not organize a folder structure.
    The folder structure will be organized in the next some commits.
  * The changes will follow the Autoware's guideline as below:
      - https://autowarefoundation.github.io/autoware-documentation/main/contributing/coding-guidelines/ros-nodes/directory-structure/#package-folder

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

  * 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>
  * To follow the previous commit

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

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 18, 2025
Copy link

github-actions bot commented Jan 18, 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 added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jan 18, 2025
Copy link

codecov bot commented Jan 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 29.49%. Comparing base (82c9470) to head (d142926).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9957      +/-   ##
==========================================
- Coverage   29.76%   29.49%   -0.27%     
==========================================
  Files        1434     1425       -9     
  Lines      108244   107739     -505     
  Branches    42930    42787     -143     
==========================================
- Hits        32222    31781     -441     
- Misses      72893    72895       +2     
+ Partials     3129     3063      -66     
Flag Coverage Δ *Carryforward flag
differential 93.54% <100.00%> (?)
total 29.47% <ø> (-0.29%) ⬇️ Carriedforward from b76f5a4

*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 sasakisasaki marked this pull request as ready for review January 20, 2025 02:30
@xtk8532704
Copy link
Contributor

xtk8532704 commented Jan 20, 2025

Please test it with this catalog to check if you branch pass all scenarios(1-2 failures is ok.), which contains many scenarios using scenario_simulator_v2_adapter.

…nario-simulator-v2-adapter

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

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

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

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
…nario-simulator-v2-adapter

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

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

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@github-actions github-actions bot added the component:launch Launch files, scripts and initialization tools. (auto-assigned) label Jan 23, 2025
@sasakisasaki
Copy link
Contributor Author

@xtk8532704 @maxime-clem Thank you for all your support and review! Now tested as this result. Without the testing on evaluator, I could not detect lots of issues. I appreciate all your reviews!

@SakodaShintaro SakodaShintaro merged commit f0c8170 into autowarefoundation:main Jan 23, 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) component:launch Launch files, scripts and initialization tools. (auto-assigned) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) type:documentation Creating or refining documentation. (auto-assigned)
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants