aboutsummaryrefslogtreecommitdiff
path: root/api/src/test/java/io/opencensus/trace/SpanTest.java
blob: 5d36bb147ff42343cf3c1ebfe76084469a4fff98 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
 * 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.
 */

package io.opencensus.trace;

import static com.google.common.truth.Truth.assertThat;
import static org.mockito.Matchers.eq;
import static org.mockito.Matchers.same;
import static org.mockito.Mockito.verify;

import java.util.Collections;
import java.util.EnumSet;
import java.util.Map;
import java.util.Random;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.Mockito;

/** Unit tests for {@link Span}. */
@RunWith(JUnit4.class)
public class SpanTest {
  private Random random;
  private SpanContext spanContext;
  private SpanContext notSampledSpanContext;
  private EnumSet<Span.Options> spanOptions;

  @Before
  public void setUp() {
    random = new Random(1234);
    spanContext =
        SpanContext.create(
            TraceId.generateRandomId(random),
            SpanId.generateRandomId(random),
            TraceOptions.builder().setIsSampled().build());
    notSampledSpanContext =
        SpanContext.create(
            TraceId.generateRandomId(random),
            SpanId.generateRandomId(random),
            TraceOptions.DEFAULT);
    spanOptions = EnumSet.of(Span.Options.RECORD_EVENTS);
  }

  @Test(expected = NullPointerException.class)
  public void newSpan_WithNullContext() {
    new NoopSpan(null, null);
  }

  @Test(expected = IllegalArgumentException.class)
  public void newSpan_SampledContextAndNullOptions() {
    new NoopSpan(spanContext, null);
  }

  @Test(expected = IllegalArgumentException.class)
  public void newSpan_SampledContextAndEmptyOptions() {
    new NoopSpan(spanContext, EnumSet.noneOf(Span.Options.class));
  }

  @Test
  public void getOptions_WhenNullOptions() {
    Span span = new NoopSpan(notSampledSpanContext, null);
    assertThat(span.getOptions()).isEmpty();
  }

  @Test
  public void getContextAndOptions() {
    Span span = new NoopSpan(spanContext, spanOptions);
    assertThat(span.getContext()).isEqualTo(spanContext);
    assertThat(span.getOptions()).isEqualTo(spanOptions);
  }

  @Test
  public void addAttributeCallsAddAttributesByDefault() {
    Span span = Mockito.spy(new NoopSpan(spanContext, spanOptions));
    span.putAttribute("MyKey", AttributeValue.booleanAttributeValue(true));
    span.end();
    verify(span)
        .addAttributes(
            eq(Collections.singletonMap("MyKey", AttributeValue.booleanAttributeValue(true))));
  }

  @Test
  public void endCallsEndWithDefaultOptions() {
    Span span = Mockito.spy(new NoopSpan(spanContext, spanOptions));
    span.end();
    verify(span).end(same(EndSpanOptions.DEFAULT));
  }

  // No-op implementation of the Span for testing only.
  private static class NoopSpan extends Span {
    private NoopSpan(SpanContext context, EnumSet<Span.Options> options) {
      super(context, options);
    }

    @Override
    public void addAttributes(Map<String, AttributeValue> attributes) {}

    @Override
    public void addAnnotation(String description, Map<String, AttributeValue> attributes) {}

    @Override
    public void addAnnotation(Annotation annotation) {}

    @Override
    public void addNetworkEvent(NetworkEvent networkEvent) {}

    @Override
    public void addLink(Link link) {}

    @Override
    public void end(EndSpanOptions options) {}
  }
}