io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opentelemetry-testing-common Show documentation
OpenTelemetry Javaagent testing commons
There is a newer version: 2.10.0-alpha
Show newest version
/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.instrumentation.testing.junit.http;

import io.opentelemetry.api.trace.Span;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.HashMap;
import java.util.Map;

public class ServerEndpoint {
  private static final Map PATH_MAP = new HashMap<>();
  public static final ServerEndpoint SUCCESS =
      new ServerEndpoint("SUCCESS", "success", 200, "success");
  public static final ServerEndpoint REDIRECT =
      new ServerEndpoint("REDIRECT", "redirect", 302, "/redirected");
  public static final ServerEndpoint ERROR =
      new ServerEndpoint(
          "ERROR",
          "error-status",
          500,
          "controller error"); // "error" is a special path for some frameworks
  public static final ServerEndpoint EXCEPTION =
      new ServerEndpoint("EXCEPTION", "exception", 500, "controller exception");
  public static final ServerEndpoint NOT_FOUND =
      new ServerEndpoint("NOT_FOUND", "notFound", 404, "not found");
  public static final ServerEndpoint CAPTURE_HEADERS =
      new ServerEndpoint("CAPTURE_HEADERS", "captureHeaders", 200, "headers captured");
  public static final ServerEndpoint CAPTURE_PARAMETERS =
      new ServerEndpoint("CAPTURE_PARAMETERS", "captureParameters", 200, "parameters captured");

  // TODO: add tests for the following cases:
  public static final ServerEndpoint QUERY_PARAM =
      new ServerEndpoint("QUERY_PARAM", "query?some=query", 200, "some=query");
  // OkHttp never sends the fragment in the request, so these cases don't work.
  // FRAGMENT_PARAM("fragment#some-fragment", 200, "some-fragment"),
  // QUERY_FRAGMENT_PARAM("query/fragment?some=query#some-fragment", 200,
  // "some=query#some-fragment"),
  public static final ServerEndpoint PATH_PARAM =
      new ServerEndpoint("PATH_PARAM", "path/123/param", 200, "123");
  public static final ServerEndpoint AUTH_REQUIRED =
      new ServerEndpoint("AUTH_REQUIRED", "authRequired", 200, null);
  public static final ServerEndpoint LOGIN = new ServerEndpoint("LOGIN", "login", 302, null);
  public static final ServerEndpoint AUTH_ERROR =
      new ServerEndpoint("AUTH_ERROR", "basicsecured/endpoint", 401, null);
  public static final ServerEndpoint INDEXED_CHILD =
      new ServerEndpoint("INDEXED_CHILD", "child", 200, "");

  public static final String ID_ATTRIBUTE_NAME = "test.request.id";
  public static final String ID_PARAMETER_NAME = "id";

  private final String name;
  private final URI uriObj;
  private final String path;
  final String query;
  final String fragment;
  final int status;
  final String body;

  public String getQuery() {
    return query;
  }

  public String getFragment() {
    return fragment;
  }

  public int getStatus() {
    return status;
  }

  public String getBody() {
    return body;
  }

  public String name() {
    return name;
  }

  public ServerEndpoint(String name, String uri, int status, String body) {
    this(name, uri, status, body, true);
  }

  public ServerEndpoint(String name, String uri, int status, String body, boolean registerPath) {
    this.name = name;
    this.uriObj = URI.create(uri);
    this.path = uriObj.getPath();
    this.query = uriObj.getQuery();
    this.fragment = uriObj.getFragment();
    this.status = status;
    this.body = body;
    if (registerPath) {
      PATH_MAP.put(this.getPath(), this);
    }
  }

  public String getPath() {
    return "/" + path;
  }

  public String rawPath() {
    return path;
  }

  URI resolvePath(URI address) {
    return address.resolve(path);
  }

  URI resolve(URI address) {
    return address.resolve(uriObj);
  }

  URI resolveWithoutFragment(URI address) throws URISyntaxException {
    URI uri = resolve(address);
    return new URI(
        uri.getScheme(), null, uri.getHost(), uri.getPort(), uri.getPath(), uri.getQuery(), null);
  }

  /**
   * Populates custom test attributes for the {@link
   * io.opentelemetry.instrumentation.test.base.HttpServerTest#controller} span (which must be the
   * current span when this is called) based on URL parameters. Required for {@link #INDEXED_CHILD}.
   */
  public void collectSpanAttributes(ServerEndpoint.UrlParameterProvider parameterProvider) {
    if (this == INDEXED_CHILD) {
      String value = parameterProvider.getParameter(ID_PARAMETER_NAME);

      if (value != null) {
        Span.current().setAttribute(ID_ATTRIBUTE_NAME, Long.parseLong(value));
      }
    }
  }

  public static ServerEndpoint forPath(String path) {
    return PATH_MAP.get(path);
  }

  public interface UrlParameterProvider {
    String getParameter(String name);
  }
}