[Code Health] include-what-you-use cleanup, part 3 (open-telemetry#3004)

lalitb · Aug 26, 2024 · a920898 · a920898
1 parent a71642f
commit a920898
Show file tree

Hide file tree

Showing 61 changed files with 415 additions and 162 deletions.
diff --git a/.iwyu.imp b/.iwyu.imp
@@ -9,5 +9,8 @@
 
   # Local opentelemetry-cpp
 
+  { "include": ["<gtest/gtest-message.h>", "private", "<gtest/gtest.h>", "public"] },
+  { "include": ["<gtest/gtest-test-part.h>", "private", "<gtest/gtest.h>", "public"] },
+  { "include": ["<gtest/gtest_pred_impl.h>", "private", "<gtest/gtest.h>", "public"] },
 ]
 
diff --git a/api/include/opentelemetry/baggage/propagation/baggage_propagator.h b/api/include/opentelemetry/baggage/propagation/baggage_propagator.h
@@ -3,9 +3,15 @@
 
 #pragma once
 
+#include <memory>
+#include <string>
+
 #include "opentelemetry/baggage/baggage.h"
 #include "opentelemetry/baggage/baggage_context.h"
+#include "opentelemetry/context/context.h"
 #include "opentelemetry/context/propagation/text_map_propagator.h"
+#include "opentelemetry/nostd/function_ref.h"
+#include "opentelemetry/nostd/string_view.h"
 #include "opentelemetry/version.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE

diff --git a/api/include/opentelemetry/common/key_value_iterable_view.h b/api/include/opentelemetry/common/key_value_iterable_view.h
@@ -3,9 +3,14 @@
 
 #pragma once
 
+#include <stddef.h>
+#include <initializer_list>
 #include <iterator>
+#include <type_traits>
 #include <utility>
+#include <vector>
 
+#include "opentelemetry/common/attribute_value.h"
 #include "opentelemetry/common/key_value_iterable.h"
 #include "opentelemetry/nostd/function_ref.h"
 #include "opentelemetry/nostd/span.h"

diff --git a/api/include/opentelemetry/context/context.h b/api/include/opentelemetry/context/context.h
@@ -4,9 +4,12 @@
 #pragma once
 
 #include <cstring>
+#include <utility>
+
 #include "opentelemetry/context/context_value.h"
 #include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/nostd/string_view.h"
+#include "opentelemetry/nostd/variant.h"
 #include "opentelemetry/version.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE

diff --git a/api/include/opentelemetry/context/runtime_context.h b/api/include/opentelemetry/context/runtime_context.h
@@ -3,8 +3,12 @@
 
 #pragma once
 
+#include <stddef.h>
+#include <algorithm>
+
 #include "opentelemetry/common/macros.h"
 #include "opentelemetry/context/context.h"
+#include "opentelemetry/context/context_value.h"
 #include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/nostd/string_view.h"
 #include "opentelemetry/nostd/unique_ptr.h"

diff --git a/api/include/opentelemetry/nostd/function_ref.h b/api/include/opentelemetry/nostd/function_ref.h
@@ -3,16 +3,18 @@
 
 #pragma once
 
-#include <memory>
+#include <iosfwd>
+#include <memory>  // IWYU pragma: keep
 #include <type_traits>
+#include <utility>
 
 #include "opentelemetry/version.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE
 namespace nostd
 {
 template <class Sig>
-class function_ref;
+class function_ref;  // IWYU pragma: keep
 
 /**
  * Non-owning function reference that can be used as a more performant

diff --git a/api/include/opentelemetry/nostd/string_view.h b/api/include/opentelemetry/nostd/string_view.h
@@ -12,13 +12,14 @@
 
 #if !defined(OPENTELEMETRY_HAVE_STD_STRING_VIEW)
 #  include <algorithm>
-#  include <cstddef>
 #  include <cstring>
+#  include <functional>
 #  include <ostream>
 #  include <stdexcept>
 #  include <string>
+#  include <type_traits>
+#  include <utility>
 
-#  include "opentelemetry/common/macros.h"
 #  include "opentelemetry/version.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE

diff --git a/api/include/opentelemetry/nostd/variant.h b/api/include/opentelemetry/nostd/variant.h
@@ -54,7 +54,7 @@ OPENTELEMETRY_END_NAMESPACE
 #  ifdef HAVE_ABSEIL
 #    include "absl/types/variant.h"
 #  else
-#    include "./internal/absl/types/variant.h"
+#    include "opentelemetry/nostd/internal/absl/types/variant.h"
 #  endif
 
 #  ifdef _MSC_VER

diff --git a/api/include/opentelemetry/plugin/dynamic_load.h b/api/include/opentelemetry/plugin/dynamic_load.h
@@ -6,19 +6,19 @@
 #include <memory>
 #include <string>
 
+#include "opentelemetry/plugin/factory.h"
+#include "opentelemetry/version.h"
+
 #ifdef _WIN32
 #  include "opentelemetry/plugin/detail/dynamic_load_windows.h"  // IWYU pragma: export
 #else
 #  include "opentelemetry/plugin/detail/dynamic_load_unix.h"  // IWYU pragma: export
 #endif
-#include "opentelemetry/version.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE
 namespace plugin
 {
 
-class Factory;
-
 /**
  * Load an OpenTelemetry implementation as a plugin.
  * @param plugin the path to the plugin to load

diff --git a/api/include/opentelemetry/trace/noop.h b/api/include/opentelemetry/trace/noop.h
@@ -7,15 +7,21 @@
 // This file is part of the internal implementation of OpenTelemetry. Nothing in this file should be
 // used directly. Please refer to span.h and tracer.h for documentation on these interfaces.
 
-#include <memory>
+#include <stdint.h>
+#include <utility>
 
-#include "opentelemetry/context/runtime_context.h"
+#include "opentelemetry/common/attribute_value.h"
+#include "opentelemetry/common/key_value_iterable.h"
+#include "opentelemetry/common/timestamp.h"
+#include "opentelemetry/context/context_value.h"
 #include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/nostd/string_view.h"
 #include "opentelemetry/nostd/unique_ptr.h"
 #include "opentelemetry/trace/span.h"
 #include "opentelemetry/trace/span_context.h"
 #include "opentelemetry/trace/span_context_kv_iterable.h"
+#include "opentelemetry/trace/span_metadata.h"
+#include "opentelemetry/trace/span_startoptions.h"
 #include "opentelemetry/trace/tracer.h"
 #include "opentelemetry/trace/tracer_provider.h"
 #include "opentelemetry/version.h"

diff --git a/api/include/opentelemetry/trace/provider.h b/api/include/opentelemetry/trace/provider.h
@@ -5,18 +5,16 @@
 
 #include <mutex>
 
-#include "opentelemetry/common/macros.h"
 #include "opentelemetry/common/spin_lock_mutex.h"
 #include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/trace/noop.h"
+#include "opentelemetry/trace/tracer_provider.h"
 #include "opentelemetry/version.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE
 namespace trace
 {
 
-class TracerProvider;
-
 /**
  * Stores the singleton global TracerProvider.
  */

diff --git a/api/include/opentelemetry/trace/scope.h b/api/include/opentelemetry/trace/scope.h
@@ -3,18 +3,18 @@
 
 #pragma once
 
+#include "opentelemetry/context/context.h"
 #include "opentelemetry/context/runtime_context.h"
 #include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/nostd/unique_ptr.h"
+#include "opentelemetry/trace/span.h"
 #include "opentelemetry/trace/span_metadata.h"
 #include "opentelemetry/version.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE
 namespace trace
 {
 
-class Span;
-
 /**
  * Controls how long a span is active.
  *

diff --git a/api/include/opentelemetry/trace/span_context.h b/api/include/opentelemetry/trace/span_context.h
@@ -3,6 +3,8 @@
 
 #pragma once
 
+#include <stdint.h>
+
 #include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/trace/span_id.h"
 #include "opentelemetry/trace/trace_flags.h"

diff --git a/api/include/opentelemetry/trace/trace_state.h b/api/include/opentelemetry/trace/trace_state.h
@@ -3,13 +3,14 @@
 
 #pragma once
 
-#include <cstdint>
+#include <ctype.h>
+#include <cstddef>
 #include <string>
+#include <vector>
 
 #include "opentelemetry/common/kv_properties.h"
 #include "opentelemetry/nostd/function_ref.h"
 #include "opentelemetry/nostd/shared_ptr.h"
-#include "opentelemetry/nostd/span.h"
 #include "opentelemetry/nostd/string_view.h"
 #include "opentelemetry/nostd/unique_ptr.h"
 #include "opentelemetry/version.h"

diff --git a/api/test/baggage/baggage_benchmark.cc b/api/test/baggage/baggage_benchmark.cc
@@ -1,11 +1,14 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#include <benchmark/benchmark.h>
+#include <stddef.h>
+#include <memory>
+#include <string>
+
 #include "opentelemetry/baggage/baggage.h"
 #include "opentelemetry/nostd/string_view.h"
-
-#include <benchmark/benchmark.h>
-#include <cstdint>
+#include "opentelemetry/nostd/utility.h"
 
 using namespace opentelemetry::baggage;
 namespace nostd = opentelemetry::nostd;

diff --git a/api/test/baggage/baggage_test.cc b/api/test/baggage/baggage_test.cc
@@ -1,15 +1,17 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-#include "opentelemetry/nostd/string_view.h"
-
+#include <assert.h>
 #include <gtest/gtest.h>
+#include <stddef.h>
 #include <string>
 #include <vector>
 
 #include "opentelemetry/baggage/baggage.h"
+#include "opentelemetry/common/kv_properties.h"
+#include "opentelemetry/nostd/shared_ptr.h"
+#include "opentelemetry/nostd/string_view.h"
 
-using namespace opentelemetry;
 using namespace opentelemetry::baggage;
 
 std::string header_with_custom_entries(size_t num_entries)
@@ -82,7 +84,8 @@ TEST(BaggageTest, ValidateExtractHeader)
   {
     auto baggage = Baggage::FromHeader(testcase.input);
     size_t index = 0;
-    baggage->GetAllEntries([&testcase, &index](nostd::string_view key, nostd::string_view value) {
+    baggage->GetAllEntries([&testcase, &index](opentelemetry::nostd::string_view key,
+                                               opentelemetry::nostd::string_view value) {
       EXPECT_EQ(key, testcase.keys[index]);
       EXPECT_EQ(value, testcase.values[index]);
       index++;
@@ -97,7 +100,7 @@ TEST(BaggageTest, ValidateExtractHeader)
   // Entries beyond threshold are dropped
   auto baggage = Baggage::FromHeader(header_with_custom_entries(Baggage::kMaxKeyValuePairs + 1));
   auto header  = baggage->ToHeader();
-  common::KeyValueStringTokenizer kv_str_tokenizer(header);
+  opentelemetry::common::KeyValueStringTokenizer kv_str_tokenizer(header);
   int expected_tokens = Baggage::kMaxKeyValuePairs;
   EXPECT_EQ(kv_str_tokenizer.NumTokens(), expected_tokens);
 
@@ -126,7 +129,7 @@ TEST(BaggageTest, ValidateInjectHeader)
 
   for (auto &testcase : testcases)
   {
-    nostd::shared_ptr<Baggage> baggage(new Baggage{});
+    opentelemetry::nostd::shared_ptr<Baggage> baggage(new Baggage{});
     for (size_t i = 0; i < testcase.keys.size(); i++)
     {
       baggage = baggage->Set(testcase.keys[i], testcase.values[i]);
@@ -202,17 +205,17 @@ TEST(BaggageTest, BaggageRemove)
 
 TEST(BaggageTest, BaggageGetAll)
 {
-  std::string baggage_header           = "k1=v1,k2=v2,k3=v3";
-  auto baggage                         = Baggage::FromHeader(baggage_header);
-  const int kNumPairs                  = 3;
-  nostd::string_view keys[kNumPairs]   = {"k1", "k2", "k3"};
-  nostd::string_view values[kNumPairs] = {"v1", "v2", "v3"};
-  size_t index                         = 0;
-  baggage->GetAllEntries(
-      [&keys, &values, &index](nostd::string_view key, nostd::string_view value) {
-        EXPECT_EQ(key, keys[index]);
-        EXPECT_EQ(value, values[index]);
-        index++;
-        return true;
-      });
+  std::string baggage_header                          = "k1=v1,k2=v2,k3=v3";
+  auto baggage                                        = Baggage::FromHeader(baggage_header);
+  const int kNumPairs                                 = 3;
+  opentelemetry::nostd::string_view keys[kNumPairs]   = {"k1", "k2", "k3"};
+  opentelemetry::nostd::string_view values[kNumPairs] = {"v1", "v2", "v3"};
+  size_t index                                        = 0;
+  baggage->GetAllEntries([&keys, &values, &index](opentelemetry::nostd::string_view key,
+                                                  opentelemetry::nostd::string_view value) {
+    EXPECT_EQ(key, keys[index]);
+    EXPECT_EQ(value, values[index]);
+    index++;
+    return true;
+  });
 }
diff --git a/api/test/baggage/propagation/baggage_propagator_test.cc b/api/test/baggage/propagation/baggage_propagator_test.cc
@@ -2,11 +2,20 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-#include "opentelemetry/baggage/propagation/baggage_propagator.h"
 #include <gtest/gtest.h>
 #include <map>
+#include <memory>
 #include <string>
+#include <utility>
+#include <vector>
+
+#include "opentelemetry/baggage/baggage.h"
 #include "opentelemetry/baggage/baggage_context.h"
+#include "opentelemetry/baggage/propagation/baggage_propagator.h"
+#include "opentelemetry/context/context.h"
+#include "opentelemetry/context/propagation/text_map_propagator.h"
+#include "opentelemetry/nostd/string_view.h"
+#include "opentelemetry/nostd/utility.h"
 
 using namespace opentelemetry;
 using namespace opentelemetry::baggage::propagation;

diff --git a/api/test/common/kv_properties_test.cc b/api/test/common/kv_properties_test.cc
@@ -3,12 +3,15 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include <gtest/gtest.h>
-#include <opentelemetry/common/kv_properties.h>
-
+#include <stddef.h>
 #include <string>
 #include <utility>
 #include <vector>
 
+#include <opentelemetry/common/kv_properties.h>
+#include "opentelemetry/nostd/string_view.h"
+#include "opentelemetry/nostd/utility.h"
+
 // ------------------------- Entry class tests ---------------------------------
 
 using namespace opentelemetry;

diff --git a/api/test/common/spinlock_benchmark.cc b/api/test/common/spinlock_benchmark.cc
@@ -1,10 +1,21 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-#include "opentelemetry/common/spin_lock_mutex.h"
-
 #include <benchmark/benchmark.h>
-#include <mutex>
+#include <stdint.h>
+#include <algorithm>
+#include <atomic>
+#include <thread>
+#include <vector>
+
+#if defined(__i386__) || defined(__x86_64__)
+#  if defined(__clang__) || defined(__INTEL_COMPILER)
+#    include <emmintrin.h>  // for _mm_pause
+#  endif
+#endif
+
+#include "opentelemetry/common/macros.h"
+#include "opentelemetry/common/spin_lock_mutex.h"
 
 namespace
 {