org.springframework.cloud.contract.verifier.builder

Interface SingleTestGenerator

All Known Implementing Classes:

JavaTestGenerator

public interface SingleTestGenerator

Builds a single test.

Since:

1.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SingleTestGenerator.GeneratedClassData

Method Summary

Modifier and Type	Method and Description
default String	buildClass(ContractVerifierConfigProperties properties, Collection<ContractMetadata> listOfFiles, String includedDirectoryRelativePath, SingleTestGenerator.GeneratedClassData generatedClassData) Creates contents of a single test class in which all test scenarios from the contract metadata should be placed.
String	buildClass(ContractVerifierConfigProperties properties, Collection<ContractMetadata> listOfFiles, String className, String classPackage, String includedDirectoryRelativePath) Deprecated. usebuildClass(ContractVerifierConfigProperties, Collection, String, GeneratedClassData)
String	fileExtension(ContractVerifierConfigProperties properties) Deprecated.

Method Detail

buildClass

@Deprecated
String buildClass(ContractVerifierConfigProperties properties,
                              Collection<ContractMetadata> listOfFiles,
                              String className,
                              String classPackage,
                              String includedDirectoryRelativePath)

Deprecated. usebuildClass(ContractVerifierConfigProperties, Collection, String, GeneratedClassData)

Creates contents of a single test class in which all test scenarios from the contract metadata should be placed.

Parameters:

properties - - properties passed to the plugin

listOfFiles - - list of parsed contracts with additional metadata

className - - the name of the generated test class

classPackage - - the name of the package in which the test class should be stored

includedDirectoryRelativePath - - relative path to the included directory

Returns:

contents of a single test class

buildClass

default String buildClass(ContractVerifierConfigProperties properties,
                          Collection<ContractMetadata> listOfFiles,
                          String includedDirectoryRelativePath,
                          SingleTestGenerator.GeneratedClassData generatedClassData)

Creates contents of a single test class in which all test scenarios from the contract metadata should be placed.

Parameters:

properties - - properties passed to the plugin

listOfFiles - - list of parsed contracts with additional metadata

generatedClassData - - information about the generated class

includedDirectoryRelativePath - - relative path to the included directory

Returns:

contents of a single test class

fileExtension

@Deprecated
String fileExtension(ContractVerifierConfigProperties properties)

Deprecated.

Extension that should be appended to the generated test class. E.g. .java or .php

Parameters:

properties - - properties passed to the plugin