aboutsummaryrefslogtreecommitdiff
path: root/testing/src/main/java/io/opencensus/testing/export/TestHandler.java
blob: 6d73aff122e343559573ab4dbcb0c71d72ce0367 (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
/*
 * 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.testing.export;

import io.opencensus.trace.export.SpanData;
import io.opencensus.trace.export.SpanExporter;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import javax.annotation.Nullable;
import javax.annotation.concurrent.GuardedBy;

/**
 * A {@link SpanExporter.Handler} for testing only.
 *
 * @since 0.9
 */
public final class TestHandler extends SpanExporter.Handler {

  private final Object monitor = new Object();

  // TODO: Decide whether to use a different class instead of LinkedList.
  @GuardedBy("monitor")
  @SuppressWarnings("JdkObsolete")
  private final List<SpanData> spanDataList = new LinkedList<SpanData>();

  @Override
  public void export(Collection<SpanData> spanDataList) {
    synchronized (monitor) {
      this.spanDataList.addAll(spanDataList);
      monitor.notifyAll();
    }
  }

  /**
   * Waits until we received numberOfSpans spans to export. Returns the list of exported {@link
   * SpanData} objects, otherwise {@code null} if the current thread is interrupted.
   *
   * @param numberOfSpans the number of minimum spans to be collected.
   * @return the list of exported {@link SpanData} objects, otherwise {@code null} if the current
   *     thread is interrupted.
   * @since 0.9
   */
  @Nullable
  public List<SpanData> waitForExport(int numberOfSpans) {
    List<SpanData> ret;
    synchronized (monitor) {
      while (spanDataList.size() < numberOfSpans) {
        try {
          monitor.wait();
        } catch (InterruptedException e) {
          // Preserve the interruption status as per guidance.
          Thread.currentThread().interrupt();
          return null;
        }
      }
      ret = new ArrayList<SpanData>(spanDataList);
      spanDataList.clear();
    }
    return ret;
  }
}