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

refactor(ekf_localizer)!: prefix package and namespace with autoware #8888

Conversation

a-maumau
Copy link
Contributor

@a-maumau a-maumau commented Sep 17, 2024

Description

This PR will add an autoware_ prefix to ekf_localizer package.

Related links

autoware_tools: autowarefoundation/autoware_tools#119

Parent Issue:

How was this PR tested?

Checked with running the autoware sample-map.

Notes for reviewers

None.

Interface changes

None.

Effects on system behavior

None.

@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:localization Vehicle's position determination in its environment. (auto-assigned) type:ci Continuous Integration (CI) processes and testing. (auto-assigned) component:launch Launch files, scripts and initialization tools. (auto-assigned) labels Sep 17, 2024
Copy link

github-actions bot commented Sep 17, 2024

Thank you for contributing to the Autoware project!

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

Please ensure:

@SakodaShintaro
Copy link
Contributor

@a-maumau
We have some code that includes the header files of ekf_localizer, so could you avoid moving them from include/* to src/*?

TIER IV INTERNAL REPOSITORY

@SakodaShintaro SakodaShintaro added the tag:run-build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Sep 17, 2024
@a-maumau
Copy link
Contributor Author

a-maumau commented Sep 17, 2024

@SakodaShintaro I am sorry for that. It seems I overlooked some of the repository.
I moved the header files back in the exporting folder (i.e. include/autoware/ekf_localizer/) at 444cd9f
0750dcf .

@a-maumau
Copy link
Contributor Author

a-maumau commented Sep 17, 2024

@SakodaShintaro I accidentally move all the header files to the exporting folder, but it seems it only requires some of headers. Should we keep the exporting header to a minimum (only ekf_localizer.hpp is used?)?

I put the ekf_localizer.hpp in include/autoware/ekf_localizer and the others in src at [del].

Copy link

codecov bot commented Sep 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.31%. Comparing base (6effe2c) to head (0750dcf).
Report is 18 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8888      +/-   ##
==========================================
+ Coverage   27.92%   28.31%   +0.38%     
==========================================
  Files        1324     1338      +14     
  Lines       98877    99587     +710     
  Branches    39821    40210     +389     
==========================================
+ Hits        27615    28201     +586     
- Misses      71210    71333     +123     
- Partials       52       53       +1     
Flag Coverage Δ *Carryforward flag
differential 27.76% <ø> (?)
total 27.92% <ø> (ø) Carriedforward from 6effe2c

*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.

@a-maumau a-maumau force-pushed the mau/ref/localization/ekf_localizer branch from 3070c5c to 0750dcf Compare September 17, 2024 09:39
@a-maumau
Copy link
Contributor Author

a-maumau commented Sep 17, 2024

Sorry for making PR comments little bit messy.
I moved all the header in include/autoware/ekf_localizer (0750dcf) since it requires other headers to be exported too.

ekf_localizer.hpp are including the other headers in src, and this make other package or library unable to find the headers included from ekf_localizer.hpp when they include the ekf_localizer.hpp.

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.

I have confirmed that logging_simulator, planning_simulator and e2e_simulator with AWSIM works well.

I checked

  • 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)

    • Add autoware:: to namespace.
    • Add autoware folder as necessary and update include statements accordingly.
  • 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>.
  • 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

LGTM

@SakodaShintaro SakodaShintaro merged commit 18fb465 into autowarefoundation:main Sep 18, 2024
34 checks passed
@a-maumau a-maumau deleted the mau/ref/localization/ekf_localizer branch September 19, 2024 08:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:launch Launch files, scripts and initialization tools. (auto-assigned) component:localization Vehicle's position determination in its environment. (auto-assigned) tag: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
None yet
Development

Successfully merging this pull request may close these issues.

2 participants