io.knotx.junit5.wiremock.ClasspathResourcesMockServer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of knotx-junit5 Show documentation

Testing Knot.x with JUnit 5

There is a newer version: 2.4.0

/*
 * Copyright (C) 2018 Knot.x Project
 *
 * 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.knotx.junit5.wiremock;

import com.github.tomakehurst.wiremock.WireMockServer;
import com.github.tomakehurst.wiremock.core.Options;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Used with {@linkplain KnotxWiremockExtension}. Allows for injecting {@linkplain WireMockServer}
 * objects as class fields or method parameters, with specified options. It exposes static files
 * available on classpath via HTTP endpoint.
 */
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface ClasspathResourcesMockServer {

  /**
   * Port on which server should start.
   * @return mock server port
   */
  int port() default Options.DYNAMIC_PORT;
}