Fix linting issues #54

mm318 · 2019-12-21T07:09:26Z

Fix linting issues found by clang-tidy 6.0.

codecov · 2019-12-21T07:36:06Z

Codecov Report

Merging #54 into master will increase coverage by 0.81%.
The diff coverage is 33.33%.

@@            Coverage Diff             @@
##           master      #54      +/-   ##
==========================================
+ Coverage   40.95%   41.77%   +0.81%     
==========================================
  Files          28       28              
  Lines         967      881      -86     
  Branches      566      505      -61     
==========================================
- Hits          396      368      -28     
+ Misses         54       53       -1     
+ Partials      517      460      -57

Flag	Coverage Δ
#unittests	`41.77% <33.33%> (+0.81%)`	⬆️

Impacted Files	Coverage Δ
...ollector/linux_process_memory_measurement_node.cpp	`31.81% <0%> (-1.52%)`	⬇️
...llector/src/system_metrics_collector/utilities.cpp	`35.21% <100%> (-5.01%)`	⬇️
...r/test/system_metrics_collector/test_utilities.cpp	`14.89% <0%> (-5.76%)`	⬇️
...m_metrics_collector/linux_cpu_measurement_node.cpp	`34.61% <0%> (ø)`	⬆️
...src/system_metrics_collector/proc_pid_cpu_data.cpp
...r/test/system_metrics_collector/test_utilities.hpp	`25% <0%> (ø)`
...m_metrics_collector/test_linux_cpu_measurement.cpp	`28.8% <0%> (+3.08%)`	⬆️

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 9a51d68...d4fac45. Read the comment docs.

thomas-moulard · 2019-12-22T17:56:39Z

system_metrics_collector/src/system_metrics_collector/periodic_measurement_node.cpp

@@ -29,7 +29,7 @@ namespace system_metrics_collector
 PeriodicMeasurementNode::PeriodicMeasurementNode(
  const std::string & name,
  const std::chrono::milliseconds measurement_period,
-  const std::string & publishing_topic,
+  const std::string & publishing_topic,   // NOLINT


Can't we fix this? Generally, each NOLINT must contain a justification of why the linting rules has been disabled.

The issue the linter caught here was https://clang.llvm.org/extra/clang-tidy/checks/modernize-pass-by-value.html

I am not sure it warrants an API change. Any thoughts, @zmichaels11, @dabonnie, @emersonknapp?

I tried providing a justification with // NOLINT(modernize-pass-by-value), which clang-tidy is happy about but cpplint is not (it complained about unrecognized NOLINT criteria).

Can you add another comment explaining the // NOLINT

modernize-pass-by-value is also something we should probably look more into as a team.

I am thinking we disregard modernize-pass-by-value (turn off modernize-pass-by-value checks) until we look more into it as a team, so NOLINT will not be applicable here for now.

thomas-moulard · 2019-12-22T18:02:11Z

Note: this should be merged to master directly.

thomas-moulard

I'll be OOO until 08/01. I think Emerson, Davin and Aaron can give you good advice regarding clang-tidy.

system_metrics_collector/src/system_metrics_collector/linux_process_memory_measurement_node.cpp

thomas-moulard · 2019-12-22T18:03:27Z

system_metrics_collector/src/system_metrics_collector/utilities.cpp

@@ -35,7 +35,7 @@ constexpr const char kMemAvailable[] = "MemAvailable:";
 constexpr const char kEmptyFile[] = "";
 constexpr const int kInvalidMemorySample = -1;

-double ComputeCpuTotalTime(const ProcCpuData measurement1, const ProcCpuData measurement2)
+double ComputeCpuTotalTime(const ProcCpuData & measurement1, const ProcCpuData & measurement2)


@dabonnie I think this is done on purpose because those are lightweight objects, no?

I believe I made a comment on this last time suggesting pass by val because ProcCpuData has a size of 2 words. I'll re-check

Edit:
ProcCpuData now holds an std::string, so it should be passed by const ref.

I think there was some confusing about ProcCpuData and ProcPidCpuData.

thomas-moulard

This LGTM, let's make sure with @dabonnie that we can safely modify computeCpuTotalTime

dabonnie

Only nit to update the linux_process_memory_measurement_node.cpp with a comment of why struct is needed (so it doesn't keep coming up in review).

mm318 · 2020-01-09T23:27:54Z

Rebased and added some changes to unit test source codes that were somehow missed earlier.

piraka9011

Don't see any issues with proposed changes so LGTM

mm318 · 2020-01-11T19:33:09Z

system_metrics_collector/test/system_metrics_collector/test_linux_cpu_measurement.cpp

@@ -57,7 +57,7 @@ class TestLinuxCpuMeasurementNode : public system_metrics_collector::LinuxCpuMea
    const std::chrono::milliseconds publish_period)
  : LinuxCpuMeasurementNode(name, measurement_period, publishing_topic, publish_period) {}

-  virtual ~TestLinuxCpuMeasurementNode() = default;
+  ~TestLinuxCpuMeasurementNode() override = default;


This stylistic choice of clang-tidy's (declaring destructors as override) is a controversial one: isocpp/CppCoreGuidelines#721.

Though I think the majority in the discussion sided with using override as being practically good, even if the behavior/semantics of a virtual destructor isn't quite the same as that of a virtual function.

prajakta-gokhale · 2020-01-13T19:12:19Z

CodeCov Action is failing for unrelated reason - fix is tracked in https://github.com/ros-security/aws-oncall/issues/48.

thomas-moulard reviewed Dec 22, 2019

View reviewed changes

thomas-moulard reviewed Dec 23, 2019

View reviewed changes

mm318 force-pushed the miaofei/style-guide branch from af6da6e to 4f6c229 Compare December 23, 2019 19:29

mm318 force-pushed the miaofei/clang-tidy-linting branch 2 times, most recently from a9c6e83 to 321b1f9 Compare December 23, 2019 19:58

mm318 changed the base branch from miaofei/style-guide to master December 23, 2019 19:59

thomas-moulard approved these changes Jan 9, 2020

View reviewed changes

dabonnie approved these changes Jan 9, 2020

View reviewed changes

mm318 added 3 commits January 9, 2020 15:24

fix linting issues found by clang-tidy

53672b6

address PR comment

fc8f768

fix linting issues found in tests

d4fac45

mm318 force-pushed the miaofei/clang-tidy-linting branch from 321b1f9 to d4fac45 Compare January 9, 2020 23:25

piraka9011 approved these changes Jan 9, 2020

View reviewed changes

mm318 commented Jan 11, 2020

View reviewed changes

zmichaels11 approved these changes Jan 12, 2020

View reviewed changes

prajakta-gokhale merged commit c581bfe into master Jan 13, 2020

prajakta-gokhale deleted the miaofei/clang-tidy-linting branch January 13, 2020 19:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix linting issues #54

Fix linting issues #54

mm318 commented Dec 21, 2019

codecov bot commented Dec 21, 2019 •

edited

Loading

thomas-moulard Dec 22, 2019

mm318 Dec 23, 2019

zmichaels11 Dec 23, 2019

mm318 Dec 23, 2019

thomas-moulard commented Dec 22, 2019

thomas-moulard left a comment

thomas-moulard Dec 22, 2019

zmichaels11 Dec 23, 2019 •

edited

Loading

mm318 Dec 23, 2019

thomas-moulard left a comment

dabonnie left a comment

mm318 commented Jan 9, 2020

piraka9011 left a comment

mm318 Jan 11, 2020

mm318 Jan 11, 2020 •

edited

Loading

prajakta-gokhale commented Jan 13, 2020

Fix linting issues #54

Fix linting issues #54

Conversation

mm318 commented Dec 21, 2019

codecov bot commented Dec 21, 2019 • edited Loading

Codecov Report

thomas-moulard Dec 22, 2019

Choose a reason for hiding this comment

mm318 Dec 23, 2019

Choose a reason for hiding this comment

zmichaels11 Dec 23, 2019

Choose a reason for hiding this comment

mm318 Dec 23, 2019

Choose a reason for hiding this comment

thomas-moulard commented Dec 22, 2019

thomas-moulard left a comment

Choose a reason for hiding this comment

thomas-moulard Dec 22, 2019

Choose a reason for hiding this comment

zmichaels11 Dec 23, 2019 • edited Loading

Choose a reason for hiding this comment

mm318 Dec 23, 2019

Choose a reason for hiding this comment

thomas-moulard left a comment

Choose a reason for hiding this comment

dabonnie left a comment

Choose a reason for hiding this comment

mm318 commented Jan 9, 2020

piraka9011 left a comment

Choose a reason for hiding this comment

mm318 Jan 11, 2020

Choose a reason for hiding this comment

mm318 Jan 11, 2020 • edited Loading

Choose a reason for hiding this comment

prajakta-gokhale commented Jan 13, 2020

codecov bot commented Dec 21, 2019 •

edited

Loading

zmichaels11 Dec 23, 2019 •

edited

Loading

mm318 Jan 11, 2020 •

edited

Loading