com.palantir.tracing.TestTracing Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tracing-test-utils Show documentation

Palantir open source project

The newest version!

/*
 * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
 *
 * 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 com.palantir.tracing;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.junit.jupiter.api.extension.ExtendWith;

// TODO(dfox): maybe support annotating classes too?
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@ExtendWith(TestTracingExtension.class)
public @interface TestTracing {

    /**
     * Enable snapshot testing to capture all traces to a file in src/test/resources and then verify all successive runs
     * against this golden master file.
     */
    boolean snapshot() default false;

    /** How to layout spans in the HTML report. */
    LayoutStrategy layout() default LayoutStrategy.SPLIT_BY_TRACE;
}