Package io.wcm.siteapi.integrationtestsupport

Class IntegrationTestContext

  • public final class IntegrationTestContext
extends java.lang.Object
    Context for Site API integration tests. To build an instance use IntegrationTestContextBuilder. An instances is always associated with a publish URL to test against, and a specific Site API OAS3 spec version to validate the JSON content against.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String buildSiteApiUrl​(@NotNull java.lang.String path, @NotNull java.lang.String suffix)
      Build full Site API URL.
      @NotNull java.util.Collection<java.lang.String> getAllApiVersions()  
      @NotNull java.lang.String getApiVersion()  
      @NotNull java.lang.String getExtension()  
      @NotNull HttpClient getHttpClient()  
      @NotNull java.lang.String getPublishUrl()  
      @NotNull java.lang.String getSelector()  
      @NotNull io.wcm.siteapi.openapi.validator.OpenApiSchemaValidator getValidator​(@NotNull java.lang.String suffix)
      Get OAS3 schema validator for given processor/suffix.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • buildSiteApiUrl

        public java.lang.String buildSiteApiUrl​(@NotNull
                                        @NotNull java.lang.String path,
                                        @NotNull
                                        @NotNull java.lang.String suffix)
        Build full Site API URL.
        Parameters:
        path - Content path
        suffix - Suffix
        Returns:
        Site API URL

      • getHttpClient

        @NotNull
public @NotNull HttpClient getHttpClient()
        Returns:
        Simple HTTP client for integration tests.

      • getAllApiVersions

        @NotNull
public @NotNull java.util.Collection<java.lang.String> getAllApiVersions()
        Returns:
        Get all available API versions.

      • getValidator

        @NotNull
public @NotNull io.wcm.siteapi.openapi.validator.OpenApiSchemaValidator getValidator​(@NotNull
                                                                                     @NotNull java.lang.String suffix)
        Get OAS3 schema validator for given processor/suffix.
        Parameters:
        suffix - Suffix e.g. "content", "navigation"
        Returns:
        Validator

      • getPublishUrl

        @NotNull
public @NotNull java.lang.String getPublishUrl()
        Returns:
        Publish URL (without trailing /)

      • getSelector

        @NotNull
public @NotNull java.lang.String getSelector()
        Returns:
        Site API Selector

      • getApiVersion

        @NotNull
public @NotNull java.lang.String getApiVersion()
        Returns:
        Site API version or empty string

      • getExtension

        @NotNull
public @NotNull java.lang.String getExtension()
        Returns:
        Site API Extension