span_test.cc

// Copyright 2017, OpenCensus Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include "opencensus/trace/span.h"

#include <cstdint>

#include "absl/strings/str_cat.h"
#include "gtest/gtest.h"
#include "opencensus/trace/attribute_value_ref.h"
#include "opencensus/trace/exporter/attribute_value.h"
#include "opencensus/trace/exporter/span_data.h"
#include "opencensus/trace/internal/span_impl.h"
#include "opencensus/trace/span_id.h"
#include "opencensus/trace/trace_id.h"
#include "opencensus/trace/trace_options.h"

namespace opencensus {
namespace trace {

class SpanTestPeer {
 public:
  static SpanId GetParentSpanId(Span* span) {
    return span->span_impl_for_test()->parent_span_id();
  }

  static exporter::SpanData ToSpanData(Span* span) {
    return span->span_impl_for_test()->ToSpanData();
  }
};

namespace {

TEST(SpanTest, SampledSpan) {
  AlwaysSampler sampler;
  auto span = Span::StartSpan("MySpan", /*parent=*/nullptr, {&sampler});
  EXPECT_TRUE(span.IsSampled());
  EXPECT_TRUE(span.IsRecording()) << "Sampled spans must be recording.";
}

TEST(SpanTest, NotSampledSpan) {
  NeverSampler sampler;
  auto span = Span::StartSpan("MySpan", /*parent=*/nullptr, {&sampler});
  EXPECT_FALSE(span.IsSampled());
  EXPECT_FALSE(span.IsRecording());
}

TEST(SpanTest, ChildInheritsSamplingFromParent) {
  AlwaysSampler sampler;
  auto root_span =
      Span::StartSpan("MyRootSpan", /*parent=*/nullptr, {&sampler});
  auto child_span = Span::StartSpan("MyChildSpan",
                                    /*parent=*/&root_span);
  EXPECT_TRUE(root_span.IsSampled());
  EXPECT_TRUE(child_span.IsSampled());
  EXPECT_EQ(root_span.context().trace_id(), child_span.context().trace_id());
  EXPECT_EQ(root_span.context().span_id(),
            SpanTestPeer::GetParentSpanId(&child_span));
}

TEST(SpanTest, AddAttributesLastValueWins) {
  AlwaysSampler sampler;
  auto span = Span::StartSpan("SpanName", /*parent=*/nullptr, {&sampler});
  span.AddAttributes({{"key", "value1"},
                      {"key", 123},
                      {"another_key", "another_value"},
                      {"key", "value2"},
                      {"bool_key", true}});
  auto data = SpanTestPeer::ToSpanData(&span);
  span.End();
  EXPECT_EQ("value2", data.attributes().at("key").string_value())
      << "Last value wins.";
  EXPECT_EQ("another_value",
            data.attributes().at("another_key").string_value());
}

TEST(SpanTest, AddAttributesWithArrayAndVector) {
  AlwaysSampler sampler;
  auto span = Span::StartSpan("SpanName", /*parent=*/nullptr, {&sampler});
  std::array<std::pair<absl::string_view, AttributeValueRef>, 3>
      attributes_array = {
          {{"str_key", "value1"}, {"int_key", 123}, {"bool_key", true}}};
  std::vector<std::pair<absl::string_view, AttributeValueRef>>
      attributes_vector = {{"another_key", "another_value"}};
  span.AddAttributes(attributes_array);
  span.AddAttributes(attributes_vector);
  auto data = SpanTestPeer::ToSpanData(&span);
  span.End();
  EXPECT_EQ("value1", data.attributes().at("str_key").string_value());
  EXPECT_EQ(123, data.attributes().at("int_key").int_value());
  EXPECT_EQ(true, data.attributes().at("bool_key").bool_value());
  EXPECT_EQ("another_value",
            data.attributes().at("another_key").string_value());
}

TEST(SpanTest, AddAnnotationLastAttributeWins) {
  AlwaysSampler sampler;
  auto span = Span::StartSpan("SpanName", /*parent=*/nullptr, {&sampler});
  span.AddAnnotation("Annotation text.", {{"key", "value1"},
                                          {"key", 123},
                                          {"another_key", "another_value"},
                                          {"key", "value2"},
                                          {"bool_key", true}});
  auto data = SpanTestPeer::ToSpanData(&span);
  span.End();
  EXPECT_EQ("value2", data.annotations()
                          .events()[0]
                          .event()
                          .attributes()
                          .at("key")
                          .string_value())
      << "Last value wins.";
  EXPECT_EQ("another_value", data.annotations()
                                 .events()[0]
                                 .event()
                                 .attributes()
                                 .at("another_key")
                                 .string_value());
}

TEST(SpanTest, ParentLinksFromOptions) {
  AlwaysSampler sampler;
  auto parent0 = Span::StartSpan("Parent0", /*parent=*/nullptr, {&sampler});
  auto parent1 = Span::StartSpan("Parent1", /*parent=*/nullptr, {&sampler});
  auto span =
      Span::StartSpan("MyRootSpan",
                      /*parent=*/nullptr, {&sampler, {&parent0, &parent1}});
  // Check that StartSpan added parent links to span.
  {
    auto data = SpanTestPeer::ToSpanData(&span);
    EXPECT_FALSE(data.parent_span_id().IsValid())
        << "Span has no parent in its own trace.";
    auto expect_link = [](const Span& parent, const exporter::Link& link) {
      EXPECT_EQ(exporter::Link::Type::kParentLinkedSpan, link.type());
      EXPECT_EQ(parent.context().trace_id(), link.trace_id());
      EXPECT_EQ(parent.context().span_id(), link.span_id());
      EXPECT_EQ(0, link.attributes().size());
    };
    ASSERT_EQ(2, data.links().size());
    expect_link(parent0, data.links()[0]);
    expect_link(parent1, data.links()[1]);
  }
  // Check that StartSpan added child links to the parents.
  for (Span* parent : {&parent0, &parent1}) {
    auto data = SpanTestPeer::ToSpanData(parent);
    ASSERT_EQ(1, data.links().size());
    auto& link = data.links()[0];
    EXPECT_EQ(exporter::Link::Type::kChildLinkedSpan, link.type());
    EXPECT_EQ(span.context().trace_id(), link.trace_id());
    EXPECT_EQ(span.context().span_id(), link.span_id());
    EXPECT_EQ(0, link.attributes().size());
  }
}

TEST(SpanTest, FullSpanTest) {
  AlwaysSampler sampler;
  auto linked_span1 = Span::StartSpan("link1");
  auto linked_span2 = Span::StartSpan("link2");
  auto parent = Span::StartSpan("parent");
  auto related_span =
      Span::StartSpan("RelatedSpan", /*parent=*/nullptr, {&sampler});
  StartSpanOptions opts = {&sampler, {&related_span}};
  auto span = ::opencensus::trace::Span::StartSpan("MyRootSpan", &parent, opts);
  auto child = Span::StartSpan("child", &span);

  AttributeValueRef av("value1");
  span.AddAttribute("key1", av);
  span.AddAttribute("key2", "value2");
  span.AddAttributes({{"key3", "value3"}, {"key4", 123}, {"key5", false}});

  // String (as opposed to literal).
  std::string val = "value";
  val += "6";
  span.AddAttribute("key6", val);

  // Test that StrCat's output outlives the AddAttribute call.
  span.AddAttribute(absl::StrCat("ke", "y7"), absl::StrCat("val", "ue7"));
  span.AddAttributes(
      {{absl::StrCat("key", "10"), "value10"},
       {"key11", absl::StrCat("value", "11")},
       {absl::StrCat("key", "12"), absl::StrCat("value", "12")}});

  span.AddAnnotation("anno1");
  span.AddAnnotation(
      "anno2", {{"str_attr", "hello"}, {"int_attr", 123}, {"bool_attr", true}});

  span.AddSentMessageEvent(2, 3, 4);
  span.AddReceivedMessageEvent(3, 4, 5);

  span.AddParentLink(linked_span1.context(), {{"attrib1", "value1"}});
  span.AddChildLink(linked_span2.context(), {{"attrib2", 123}});

  span.SetStatus(StatusCode::DEADLINE_EXCEEDED, "desc");

  EXPECT_TRUE(span.context().IsValid());
  span.End();
  // Add a few extra things and make sure they are NOT included since the span
  // has ended.
  span.AddAttribute("key_invalid", "value_invalid");
  span.AddSentMessageEvent(7, 8, 9);
  span.AddReceivedMessageEvent(10, 11, 12);

  const exporter::SpanData data = SpanTestPeer::ToSpanData(&span);

  EXPECT_EQ("MyRootSpan", data.name());
  EXPECT_EQ(parent.context().span_id(), data.parent_span_id());
  EXPECT_EQ(0, data.annotations().dropped_events_count());
  EXPECT_EQ(0, data.message_events().dropped_events_count());
  EXPECT_EQ(0, data.num_links_dropped());
  EXPECT_EQ(0, data.num_attributes_dropped());
  EXPECT_EQ(true, data.has_ended());
  EXPECT_FALSE(data.status().ok());
  EXPECT_EQ(false, data.has_remote_parent());

  const auto& attributes = data.attributes();
  EXPECT_EQ("value1", attributes.at("key1").string_value());
  EXPECT_EQ("value2", attributes.at("key2").string_value());
  EXPECT_EQ("value3", attributes.at("key3").string_value());
  EXPECT_EQ(123, attributes.at("key4").int_value());
  EXPECT_EQ(false, attributes.at("key5").bool_value());
  EXPECT_EQ("value6", attributes.at("key6").string_value());
  EXPECT_EQ("value7", attributes.at("key7").string_value());
  EXPECT_EQ("value10", attributes.at("key10").string_value());
  EXPECT_EQ("value11", attributes.at("key11").string_value());
  EXPECT_EQ("value12", attributes.at("key12").string_value());
  EXPECT_EQ(attributes.end(), attributes.find("key_invalid"));

  EXPECT_EQ(2, data.annotations().events().size());
  EXPECT_EQ("hello", data.annotations()
                         .events()[1]
                         .event()
                         .attributes()
                         .at("str_attr")
                         .string_value());
  EXPECT_EQ(123, data.annotations()
                     .events()[1]
                     .event()
                     .attributes()
                     .at("int_attr")
                     .int_value());
  EXPECT_EQ(true, data.annotations()
                      .events()[1]
                      .event()
                      .attributes()
                      .at("bool_attr")
                      .bool_value());

  EXPECT_EQ(3, data.links().size());
  auto expect_link = [](const Span& span, const exporter::Link& link,
                        exporter::Link::Type type) {
    EXPECT_EQ(type, link.type());
    EXPECT_EQ(span.context().trace_id(), link.trace_id());
    EXPECT_EQ(span.context().span_id(), link.span_id());
  };
  expect_link(related_span, data.links()[0],
              exporter::Link::Type::kParentLinkedSpan);
  expect_link(linked_span1, data.links()[1],
              exporter::Link::Type::kParentLinkedSpan);
  expect_link(linked_span2, data.links()[2],
              exporter::Link::Type::kChildLinkedSpan);

  EXPECT_EQ(2, data.message_events().events().size());
  auto expect_message_event = [](uint32_t id, uint32_t compressed_size,
                                 uint32_t uncompressed_size,
                                 const exporter::MessageEvent& event) {
    EXPECT_EQ(id, event.id());
    EXPECT_EQ(compressed_size, event.compressed_size());
    EXPECT_EQ(uncompressed_size, event.uncompressed_size());
  };
  expect_message_event(2, 3, 4, data.message_events().events()[0].event());
  expect_message_event(3, 4, 5, data.message_events().events()[1].event());
}

TEST(SpanTest, StrictSpanTest) {
  AlwaysSampler sampler;
  TraceOptions t = TraceOptions().WithStrictSpans(true);
  StartSpanOptions opts = {&sampler, {}, t};
  auto span = ::opencensus::trace::Span::StartSpan("MyRootSpan", nullptr, opts);
  auto child = Span::StartSpan("child", &span);
  EXPECT_TRUE(span.context().IsValid());

  // Calling end on the parent span with an open child should fail/not cause it
  // to end
  span.End();
  const exporter::SpanData data = SpanTestPeer::ToSpanData(&span);
  EXPECT_EQ("MyRootSpan", data.name());
  EXPECT_EQ(false, data.has_ended());

  // Now end the child and see that the parent span is ended as well
  child.End();
  const exporter::SpanData data2 = SpanTestPeer::ToSpanData(&span);
  EXPECT_EQ("MyRootSpan", data2.name());
  EXPECT_EQ(true, data2.has_ended());

  // Now, try ending child first and verify that that doesn't end the parent
  // span
  auto span2 = ::opencensus::trace::Span::StartSpan("root2", nullptr, opts);
  auto child2 = Span::StartSpan("child2", &span2);
  EXPECT_TRUE(span2.context().IsValid());

  // Now end the child and see that the parent span is ended as well
  child2.End();
  const exporter::SpanData root2_pre = SpanTestPeer::ToSpanData(&span2);
  EXPECT_EQ("root2", root2_pre.name());
  EXPECT_EQ(false, root2_pre.has_ended());

  // Calling end on the parent span with an open child should fail/not cause it
  // to end
  span2.End();
  const exporter::SpanData root2_post = SpanTestPeer::ToSpanData(&span2);
  EXPECT_EQ("root2", root2_post.name());
  EXPECT_EQ(true, root2_post.has_ended());

  // Now try with 3 tiers
  auto grandparent =
      ::opencensus::trace::Span::StartSpan("grandpa", nullptr, opts);
  auto parent =
      ::opencensus::trace::Span::StartSpan("parent", &grandparent, opts);
  auto kid = Span::StartSpan("kid", &parent);

  // End both grandparent and parent, neither should have ended
  grandparent.End();
  parent.End();
  const exporter::SpanData grandparent_open_data =
      SpanTestPeer::ToSpanData(&grandparent);
  EXPECT_EQ(false, grandparent_open_data.has_ended());
  const exporter::SpanData parent_open_data = SpanTestPeer::ToSpanData(&parent);
  EXPECT_EQ(false, parent_open_data.has_ended());

  kid.End();
  const exporter::SpanData grandparent_closed_data =
      SpanTestPeer::ToSpanData(&grandparent);
  EXPECT_EQ(true, grandparent_closed_data.has_ended());
  const exporter::SpanData parent_closed_data =
      SpanTestPeer::ToSpanData(&parent);
  EXPECT_EQ(true, parent_closed_data.has_ended());
}

TEST(SpanTest, ChildInheritsTraceOption) {
  constexpr uint8_t trace_id[] = {1, 2,  3,  4,  5,  6,  7,  8,
                                  9, 10, 11, 12, 13, 14, 15, 16};
  constexpr uint8_t span_id[] = {1, 0, 0, 0, 0, 0, 0, 11};
  // Create a parent context with TraceOptions set to sampled.
  TraceOptions trace_options = TraceOptions().WithSampling(true);
  SpanContext parent_ctx1{TraceId(trace_id), SpanId(span_id), trace_options};

  // Create a child Span with default sampling.
  auto span1 = Span::StartSpanWithRemoteParent("Span1", parent_ctx1);
  EXPECT_TRUE(span1.IsSampled());
}

TEST(SpanTest, ForceSamplingOnViaTraceConfig) {
  // No sampling requested, but trace_params forces it.
  TraceConfig::SetCurrentTraceParams(
      TraceParams{32, 32, 128, 128, ProbabilitySampler(1.0)});
  for (int i = 0; i < 1000; ++i) {
    auto span = Span::StartSpan("SpanName");
    EXPECT_TRUE(span.IsSampled());
    span.End();
  }
}

TEST(SpanTest, ForceSamplingOffViaTraceConfig) {
  // No sampling requested, but trace_params forces it.
  TraceConfig::SetCurrentTraceParams(
      TraceParams{32, 32, 128, 128, ProbabilitySampler(0.0)});
  for (int i = 0; i < 1000; ++i) {
    auto span = Span::StartSpan("SpanName");
    EXPECT_FALSE(span.IsSampled());
    span.End();
  }
}

TEST(SpanTest, CheckSpanData) {
  AlwaysSampler sampler;
  auto current_span = Span::StartSpan("test_span", nullptr, {&sampler});

  current_span.AddAttribute("test1", "attribute1");
  current_span.AddAttribute("test2", true);
  current_span.AddAttribute("test3", 333);

  const exporter::SpanData data = SpanTestPeer::ToSpanData(&current_span);

  EXPECT_EQ("test_span", data.name());
  EXPECT_EQ(SpanId(), data.parent_span_id()) << "No parent.";
  EXPECT_EQ(0, data.annotations().dropped_events_count());
  EXPECT_EQ(0, data.message_events().dropped_events_count());
  EXPECT_EQ(0, data.num_links_dropped());
  EXPECT_EQ(0, data.num_attributes_dropped());
  EXPECT_EQ(false, data.has_ended());
  EXPECT_TRUE(data.status().ok());
  EXPECT_EQ(false, data.has_remote_parent());

  std::unordered_map<std::string, exporter::AttributeValue> attributes =
      data.attributes();
  EXPECT_EQ("attribute1", attributes.at("test1").string_value());
  EXPECT_EQ(true, attributes.at("test2").bool_value());
  EXPECT_EQ(333, attributes.at("test3").int_value());
}

TEST(SpanTest, BlankSpan) {
  auto parent = Span::StartSpan("parent");
  auto span = Span::BlankSpan();

  EXPECT_EQ(SpanContext(), span.context());
  EXPECT_FALSE(span.context().IsValid());

  // Check that it does not crash with operations on a blank span.
  span.AddSentMessageEvent(2, 3, 4);
  span.AddReceivedMessageEvent(3, 4, 5);
  span.AddParentLink(parent.context(), {{"test", "attribute"}});
  span.AddAnnotation("This is an annotation.",
                     {{"hello", "world"}, {"latency", 1234}});
  span.AddAttribute("bool attribute", true);
  span.SetStatus(StatusCode::CANCELLED, "error text");
  span.End();
}

}  // namespace
}  // namespace trace
}  // namespace opencensus