ci(codecov): add codecov config to fix file access problem

[KeisukeShima]

Signed-off-by: Keisuke Shima 19993104+KeisukeShima@users.noreply.github.com

Related Issue(required)

#368

Description(required)

This PR will fix path mismatch problem.

Review Procedure(required)

Access below CodeCov page and navigate to file tree view.
https://app.codecov.io/gh/autowarefoundation/autoware.universe/

Related PR(optional)

Pre-Review Checklist for the PR Author

PR Author should check the checkboxes below when creating the PR.

• Read commit-guidelines
• Assign PR to reviewer

If you are adding new package following items are required:

• Documentation with description of the package is available
• A sample launch file and parameter file are available if the package contains executable nodes

Checklist for the PR Reviewer

Reviewers should check the checkboxes below before approval.

• Commits are properly organized and messages are according to the guideline
• PR title describes the changes

Post-Review Checklist for the PR Author

PR Author should check the checkboxes below before merging.

• All open points are addressed and tracked via issues or tickets

CI Checks

• Build and test for PR / build-and-test-pr: Required to pass before the merge.
• Build and test for PR / clang-tidy-pr: NOT required to pass before the merge. It is up to the reviewer(s). Found false positives? See the [guidelines][clang-tidy-guidelines].
• Check spelling: NOT required to pass before the merge. It is up to the reviewer(s). See here if you want to add some words to the spell check dictionary.

[KeisukeShima]

I tested the file using the codecov yaml validator.

❯ curl --data-binary @codecov.yaml https://codecov.io/validate
Valid!

{
  "codecov": {
    "require_ci_to_pass": true
  },
  "coverage": {
    "precision": 2,
    "round": "down",
    "range": [
      70.0,
      100.0
    ]
  },
  "parsers": {
    "gcov": {
      "branch_detection": {
        "conditional": true,
        "loop": true,
        "method": false,
        "macro": false
      }
    }
  },
  "comment": {
    "layout": "reach,diff,flags,files,footer",
    "behavior": "default",
    "require_changes": false
  },
  "flag_management": {
    "default_rules": {
      "carryforward": true
    }
  },
  "ignore": [
    "(?s:.*/test.*)\\Z"
  ],
  "fixes": [
    "autoware.universe/*/accel_brake_map_calibrator/::",
    "autoware.universe/*/ad_service_state_monitor/::",
    "autoware.universe/*/autoware_auto_cmake/::",
    "autoware.universe/*/autoware_auto_common/::",
    "autoware.universe/*/autoware_auto_control_msgs/::",
    "autoware.universe/*/autoware_auto_geometry/::",
    "autoware.universe/*/autoware_auto_geometry_msgs/::",
    "autoware.universe/*/autoware_auto_mapping_msgs/::",
    "autoware.universe/*/autoware_auto_msgs/::",
    "autoware.universe/*/autoware_auto_perception_msgs/::",
    "autoware.universe/*/autoware_auto_perception_rviz_plugin/::",
    "autoware.universe/*/autoware_auto_planning_msgs/::",
    "autoware.universe/*/autoware_auto_system_msgs/::",
    "autoware.universe/*/autoware_auto_tf2/::",
    "autoware.universe/*/autoware_auto_vehicle_msgs/::",
    "autoware.universe/*/autoware_lint_common/::",
    "autoware.universe/*/autoware_point_types/::",
    "autoware.universe/*/autoware_testing/::",
    "autoware.universe/*/behavior_path_planner/::",
    "autoware.universe/*/behavior_velocity_planner/::",
    "autoware.universe/*/compare_map_segmentation/::",
    "autoware.universe/*/control_performance_analysis/::",
    "autoware.universe/*/costmap_generator/::",
    "autoware.universe/*/detected_object_feature_remover/::",
    "autoware.universe/*/detection_by_tracker/::",
    "autoware.universe/*/dummy_diag_publisher/::",
    "autoware.universe/*/dummy_infrastructure/::",
    "autoware.universe/*/dummy_perception_publisher/::",
    "autoware.universe/*/ekf_localizer/::",
    "autoware.universe/*/elevation_map_loader/::",
    "autoware.universe/*/emergency_handler/::",
    "autoware.universe/*/euclidean_cluster/::",
    "autoware.universe/*/external_cmd_converter/::",
    "autoware.universe/*/external_cmd_selector/::",
    "autoware.universe/*/external_velocity_limit_selector/::",
    "autoware.universe/*/fake_test_node/::",
    "autoware.universe/*/fault_injection/::",
    "autoware.universe/*/freespace_planner/::",
    "autoware.universe/*/freespace_planning_algorithms/::",
    "autoware.universe/*/geo_pos_conv/::",
    "autoware.universe/*/global_parameter_loader/::",
    "autoware.universe/*/gnss_poser/::",
    "autoware.universe/*/goal_distance_calculator/::",
    "autoware.universe/*/grid_map/::",
    "autoware.universe/*/grid_map_cmake_helpers/::",
    "autoware.universe/*/grid_map_core/::",
    "autoware.universe/*/grid_map_costmap_2d/::",
    "autoware.universe/*/grid_map_cv/::",
    "autoware.universe/*/grid_map_demos/::",
    "autoware.universe/*/grid_map_filters/::",
    "autoware.universe/*/grid_map_loader/::",
    "autoware.universe/*/grid_map_msgs/::",
    "autoware.universe/*/grid_map_octomap/::",
    "autoware.universe/*/grid_map_pcl/::",
    "autoware.universe/*/grid_map_ros/::",
    "autoware.universe/*/grid_map_rviz_plugin/::",
    "autoware.universe/*/grid_map_sdf/::",
    "autoware.universe/*/grid_map_visualization/::",
    "autoware.universe/*/ground_segmentation/::",
    "autoware.universe/*/gyro_odometer/::",
    "autoware.universe/*/had_map_utils/::",
    "autoware.universe/*/image_transport_decompressor/::",
    "autoware.universe/*/imu_corrector/::",
    "autoware.universe/*/initial_pose_button_panel/::",
    "autoware.universe/*/interpolation/::",
    "autoware.universe/*/joy_controller/::",
    "autoware.universe/*/kalman_filter/::",
    "autoware.universe/*/lane_departure_checker/::",
    "autoware.universe/*/lanelet2_extension/::",
    "autoware.universe/*/laserscan_to_occupancy_grid_map/::",
    "autoware.universe/*/lidar_apollo_instance_segmentation/::",
    "autoware.universe/*/lidar_centerpoint/::",
    "autoware.universe/*/livox_tag_filter/::",
    "autoware.universe/*/localization_error_monitor/::",
    "autoware.universe/*/map_based_prediction/::",
    "autoware.universe/*/map_loader/::",
    "autoware.universe/*/map_tf_generator/::",
    "autoware.universe/*/mission_planner/::",
    "autoware.universe/*/motion_common/::",
    "autoware.universe/*/motion_testing/::",
    "autoware.universe/*/motion_velocity_smoother/::",
    "autoware.universe/*/multi_object_tracker/::",
    "autoware.universe/*/mussp/::",
    "autoware.universe/*/ndt/::",
    "autoware.universe/*/ndt_omp/::",
    "autoware.universe/*/ndt_pcl_modified/::",
    "autoware.universe/*/ndt_scan_matcher/::",
    "autoware.universe/*/object_merger/::",
    "autoware.universe/*/object_range_splitter/::",
    "autoware.universe/*/obstacle_avoidance_planner/::",
    "autoware.universe/*/obstacle_collision_checker/::",
    "autoware.universe/*/obstacle_stop_planner/::",
    "autoware.universe/*/occupancy_grid_map_outlier_filter/::",
    "autoware.universe/*/osqp_interface/::",
    "autoware.universe/*/pacmod_interface/::",
    "autoware.universe/*/path_distance_calculator/::",
    "autoware.universe/*/planning_error_monitor/::",
    "autoware.universe/*/pointcloud_preprocessor/::",
    "autoware.universe/*/polar_grid/::",
    "autoware.universe/*/pose2twist/::",
    "autoware.universe/*/pose_initializer/::",
    "autoware.universe/*/pure_pursuit/::",
    "autoware.universe/*/raw_vehicle_cmd_converter/::",
    "autoware.universe/*/roi_cluster_fusion/::",
    "autoware.universe/*/route_handler/::",
    "autoware.universe/*/scenario_selector/::",
    "autoware.universe/*/shape_estimation/::",
    "autoware.universe/*/shift_decider/::",
    "autoware.universe/*/signal_processing/::",
    "autoware.universe/*/simple_planning_simulator/::",
    "autoware.universe/*/stop_filter/::",
    "autoware.universe/*/surround_obstacle_checker/::",
    "autoware.universe/*/system_error_monitor/::",
    "autoware.universe/*/system_monitor/::",
    "autoware.universe/*/tensorrt_yolo/::",
    "autoware.universe/*/tier4_api_msgs/::",
    "autoware.universe/*/tier4_api_utils/::",
    "autoware.universe/*/tier4_auto_msgs_converter/::",
    "autoware.universe/*/tier4_autoware_launch/::",
    "autoware.universe/*/tier4_autoware_utils/::",
    "autoware.universe/*/tier4_calibration_rviz_plugin/::",
    "autoware.universe/*/tier4_control_launch/::",
    "autoware.universe/*/tier4_control_msgs/::",
    "autoware.universe/*/tier4_datetime_rviz_plugin/::",
    "autoware.universe/*/tier4_debug_msgs/::",
    "autoware.universe/*/tier4_debug_tools/::",
    "autoware.universe/*/tier4_external_api_msgs/::",
    "autoware.universe/*/tier4_hmi_msgs/::",
    "autoware.universe/*/tier4_integration_launch/::",
    "autoware.universe/*/tier4_localization_launch/::",
    "autoware.universe/*/tier4_localization_msgs/::",
    "autoware.universe/*/tier4_localization_rviz_plugin/::",
    "autoware.universe/*/tier4_map_launch/::",
    "autoware.universe/*/tier4_pcl_extensions/::",
    "autoware.universe/*/tier4_perception_launch/::",
    "autoware.universe/*/tier4_perception_msgs/::",
    "autoware.universe/*/tier4_perception_rviz_plugin/::",
    "autoware.universe/*/tier4_planning_launch/::",
    "autoware.universe/*/tier4_planning_msgs/::",
    "autoware.universe/*/tier4_planning_rviz_plugin/::",
    "autoware.universe/*/tier4_sensing_launch/::",
    "autoware.universe/*/tier4_simulation_msgs/::",
    "autoware.universe/*/tier4_simulator_launch/::",
    "autoware.universe/*/tier4_state_rviz_plugin/::",
    "autoware.universe/*/tier4_system_launch/::",
    "autoware.universe/*/tier4_system_msgs/::",
    "autoware.universe/*/tier4_v2x_msgs/::",
    "autoware.universe/*/tier4_vehicle_launch/::",
    "autoware.universe/*/tier4_vehicle_msgs/::",
    "autoware.universe/*/tier4_vehicle_rviz_plugin/::",
    "autoware.universe/*/time_utils/::",
    "autoware.universe/*/topic_state_monitor/::",
    "autoware.universe/*/traffic_light_classifier/::",
    "autoware.universe/*/traffic_light_map_based_detector/::",
    "autoware.universe/*/traffic_light_ssd_fine_detector/::",
    "autoware.universe/*/traffic_light_visualization/::",
    "autoware.universe/*/trajectory_follower/::",
    "autoware.universe/*/trajectory_follower_nodes/::",
    "autoware.universe/*/vehicle_cmd_gate/::",
    "autoware.universe/*/vehicle_constants_manager/::",
    "autoware.universe/*/vehicle_info_util/::",
    "autoware.universe/*/vehicle_velocity_converter/::",
    "autoware.universe/*/velodyne_monitor/::",
    "autoware.universe/*/web_controller/::"
  ]
}

[kenji-miyake]

Could you explain the cause a little more concretely, please?
Since we don't want to maintain such a file, I'd like to find if there is another way.

[KeisukeShima]

https://github.com/ros-tooling/action-ros-ci#integrate-action-ros-ci-with-codecov

I referred to the above link.
According to this, it seems that I have to modify the path for each package.
I tried the non-enumerated package approach, but it didn't work.

[kenji-miyake]

If we do so, definitely we have to automate this.

[KeisukeShima]

OK. I'll create a new workflow in autoware-github-actions. For now, I have set this PR to draft.

[kenji-miyake]

Why do you have to include autoware.universe here?
I mean, usually this kind of settings are written as the paths from the repository root and don't have their repository name.

[kenji-miyake]

Generally if your uploaded reports fail to process, path fixing may help. You should download the coverage report generated within your CI for a particular commit, examine the file paths located within it, and see if they map directly to your git/hg file structure. If not, you can attempt to apply a path fix and see if this helps on subsequent commits.

Do you know where I can download the coverage report?
https://docs.codecov.com/docs/fixing-paths#how-do-i-know-if-i-should-use-path-fixing

[KeisukeShima]

here https://app.codecov.io/gh/autowarefoundation/autoware.universe/commit/5af18dcbe100f7cd305c0be1e445d9e46bb8e1c7

Strangely, we can access the source files from commit, branch and pull request views.
Overview is still not working.

[kenji-miyake]

Thank you.
Then, we need more investigation.

[KeisukeShima]

Yes, perhaps additional settings are needed.

[kenji-miyake]

• ::<corresponding paths in git/hg project>

Could you write here some concrete examples of what are the <files in coverage report> and what are the <corresponding paths in git/hg project>?

[KeisukeShima]

In my point of view, <files in coverage report> is

SF:/__w/autoware.universe/autoware.universe/planning/behavior_velocity_planner/include/scene_module/blind_spot/manager.hpp

(SF stands for source file. https://ja.osdn.net/projects/lcov-jp/wiki/geninfo.1 )

from
https://api.codecov.io/upload/gh/autowarefoundation/autoware.universe/download?path=v4/raw/2022-02-10/EA9EE84B5FC56CCEF5197BE5F31E99EC/eb599aec607084113cf0994888031ebe6065468a/ca733788-b72e-4a3d-b24a-9fd37af6e8cd.txt

<corresponding paths in git/hg project> is

from https://app.codecov.io/gh/autowarefoundation/autoware.universe

[KeisukeShima]

Note that rclc uses CodeCov.
https://app.codecov.io/gh/ros2/rclc/

rclc uploads coverage result generated by action-ros-ci.
https://github.com/ros2/rclc/blob/master/.github/workflows/ci.yml#L49-L51

And they need to fix paths in codecov.yml.
(/ros_ws/src/28ud84ktfbl/rclc is the root of the source code inside action-ros-ci)
ros2/rclc#155

[KeisukeShima]

As a experiment, I tried to apply the same workflow as this repository to another repository. KeisukeShima/demos@11a243d
The following results show that it appears to work without any configuration. Umm...

https://app.codecov.io/gh/KeisukeShima/demos

[codecov]

Codecov Report

Merging #369 (eb599ae) into main (a3f0736) will decrease coverage by 1.66%.
The diff coverage is n/a.

❗ Current head eb599ae differs from pull request most recent head f1ae733. Consider uploading reports for the commit f1ae733 to get more accurate results

@@            Coverage Diff            @@
##             main    #369      +/-   ##
=========================================
- Coverage   10.99%   9.32%   -1.67%     
=========================================
  Files         704     701       -3     
  Lines       49510   48973     -537     
  Branches     6647    5818     -829     
=========================================
- Hits         5442    4566     -876     
- Misses      39708   40594     +886     
+ Partials     4360    3813     -547     

Impacted Files	Coverage Δ
...r/include/raw_vehicle_cmd_converter/csv_loader.hpp	0.00% <0.00%> (-100.00%)	⬇️
...ulator/vehicle_model/sim_model_delay_steer_acc.hpp	0.00% <0.00%> (-100.00%)	⬇️
...ulator/vehicle_model/sim_model_delay_steer_vel.hpp	0.00% <0.00%> (-100.00%)	⬇️
...ulator/vehicle_model/sim_model_ideal_steer_acc.hpp	0.00% <0.00%> (-100.00%)	⬇️
...ulator/vehicle_model/sim_model_ideal_steer_vel.hpp	0.00% <0.00%> (-100.00%)	⬇️
...vehicle_model/sim_model_delay_steer_acc_geared.hpp	0.00% <0.00%> (-100.00%)	⬇️
...vehicle_model/sim_model_ideal_steer_acc_geared.hpp	0.00% <0.00%> (-100.00%)	⬇️
...ulator/vehicle_model/sim_model_ideal_steer_acc.cpp	0.00% <0.00%> (-92.00%)	⬇️
...ulator/vehicle_model/sim_model_ideal_steer_vel.cpp	0.00% <0.00%> (-92.00%)	⬇️
...ulator/vehicle_model/sim_model_delay_steer_vel.cpp	0.00% <0.00%> (-80.00%)	⬇️
... and 113 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8142ef1...f1ae733. Read the comment docs.

[KeisukeShima]

Closes #368