com.palantir.tracing.RenderTracingRule 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 com.palantir.tracing.api.Span;
import java.nio.file.Path;
import java.util.Collection;
import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public final class RenderTracingRule implements TestRule {
    private static final Logger log = LoggerFactory.getLogger(RenderTracingRule.class);
    private final TestTracingSubscriber subscriber = new TestTracingSubscriber();

    @Override
    public Statement apply(Statement base, Description description) {
        return new Statement() {
            @Override
            public void evaluate() throws Throwable {
                try {
                    Tracer.setSampler(AlwaysSampler.INSTANCE);
                    Tracer.subscribe("RenderTracingRule", subscriber);

                    base.evaluate();
                } finally {
                    Tracer.unsubscribe("RenderTracingRule");

                    String displayName = description.getClassName() + "#" + description.getMethodName();
                    Path path = Utils.createOutputFile(description.getTestClass(), description.getMethodName());

                    Collection allSpans = subscriber.getAllSpans();

                    if (!allSpans.isEmpty()) {
                        HtmlFormatter.render(HtmlFormatter.RenderConfig.builder()
                                .spans(allSpans)
                                .path(path)
                                .displayName(displayName)
                                .layoutStrategy(LayoutStrategy.CHRONOLOGICAL)
                                .build());

                        log.info("Tracing report file://{}", path.toAbsolutePath());
                    }
                }
            }
        };
    }
}