com.phoenixnap.oss.ramlapisync.generation

Class RamlVerifier

java.lang.Object

com.phoenixnap.oss.ramlapisync.generation.RamlVerifier

public class RamlVerifier
extends Object

Engine that aims to compare RAML as loaded from a raml file that is published as our API contract with RAML generated from the Spring MVC implementation

Since:

0.0.2

Author:

Kurt Paris

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger Class Logger

Constructor Summary

Constructors

Constructor and Description
RamlVerifier(RamlRoot published, RamlRoot implemented, List<RamlChecker> checkers, List<RamlActionVisitorCheck> actionCheckers, List<RamlResourceVisitorCheck> resourceCheckers) Constructor which will accept target/implementation RAML models as well as the the checkers to be applied.
RamlVerifier(RamlRoot published, RamlRoot implemented, List<RamlChecker> checkers, List<RamlActionVisitorCheck> actionCheckers, List<RamlResourceVisitorCheck> resourceCheckers, List<RamlStyleChecker> styleChecks) Constructor which will accept target/implementation RAML models as well as the the checkers and style checkers to verify.
RamlVerifier(RamlRoot published, RamlRoot implemented, List<RamlChecker> checkers, List<RamlActionVisitorCheck> actionCheckers, List<RamlResourceVisitorCheck> resourceCheckers, List<RamlStyleChecker> styleChecks, String implementedUrlPrefixToIgnore) Constructor which will accept target/implementation RAML models as well as the the checkers and style checkers to verify.

Method Summary

Modifier and Type	Method and Description
Set<Issue>	getErrors() Retrieve the Errors identified
Set<Issue>	getWarnings() Retrieve the Warnings identified
boolean	hasErrors() Checks if there are any errors generated during the comparison
boolean	hasWarnings() Checks if there are any warnings generated during the comparison
static RamlRoot	loadRamlFromFile(String ramlFileUrl) Loads a RAML document from a file.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Class Logger

Constructor Detail

RamlVerifier

public RamlVerifier(RamlRoot published,
                    RamlRoot implemented,
                    List<RamlChecker> checkers,
                    List<RamlActionVisitorCheck> actionCheckers,
                    List<RamlResourceVisitorCheck> resourceCheckers,
                    List<RamlStyleChecker> styleChecks)

Constructor which will accept target/implementation RAML models as well as the the checkers and style checkers to verify. Once the data is set validation is triggered

Parameters:

published - The RAML model from the published RAML file

implemented - The RAML model built from the Spring MVC

checkers - Checkers that will be applied to the models

actionCheckers - Checker Visitors that will trigger to compare individual actions

resourceCheckers - Checker Visitors that will trigger to compare individual resources

styleChecks - Style Checks that will be applied to the models

RamlVerifier

public RamlVerifier(RamlRoot published,
                    RamlRoot implemented,
                    List<RamlChecker> checkers,
                    List<RamlActionVisitorCheck> actionCheckers,
                    List<RamlResourceVisitorCheck> resourceCheckers,
                    List<RamlStyleChecker> styleChecks,
                    String implementedUrlPrefixToIgnore)

Constructor which will accept target/implementation RAML models as well as the the checkers and style checkers to verify. Once the data is set validation is triggered

Parameters:

published - The RAML model from the published RAML file

implemented - The RAML model built from the Spring MVC

checkers - Checkers that will be applied to the models

actionCheckers - Checker Visitors that will trigger to compare individual actions

resourceCheckers - Checker Visitors that will trigger to compare individual resources

styleChecks - Style Checks that will be applied to the models

implementedUrlPrefixToIgnore - The Portion of the url to ignore from the implementation. use this to align urls as an alternative to baseUri

RamlVerifier

public RamlVerifier(RamlRoot published,
                    RamlRoot implemented,
                    List<RamlChecker> checkers,
                    List<RamlActionVisitorCheck> actionCheckers,
                    List<RamlResourceVisitorCheck> resourceCheckers)

Constructor which will accept target/implementation RAML models as well as the the checkers to be applied. Style checking will not be applied Once the data is set validation is triggered

Parameters:

published - The RAML model from the published RAML file

implemented - The RAML model built from the Spring MVC

checkers - Checkers that will be applied to the models

actionCheckers - Checker Visitors that will trigger to compare individual actions

resourceCheckers - Checker Visitors that will trigger to compare individual resources

Method Detail

hasErrors

public boolean hasErrors()

Checks if there are any errors generated during the comparison

Returns:

If true the verification process has found errors

hasWarnings

public boolean hasWarnings()

Checks if there are any warnings generated during the comparison

Returns:

If true the verification process has found warnings

loadRamlFromFile

public static RamlRoot loadRamlFromFile(String ramlFileUrl)

Loads a RAML document from a file.

Parameters:

ramlFileUrl - The path to the file, this can either be a resource on the class path (in which case the classpath: prefix should be omitted) or a file on disk (in which case the file: prefix should be included)

Returns:

Built Raml model

getErrors

public Set<Issue> getErrors()

Retrieve the Errors identified

Returns:

A set of unique Error-Level Issues

getWarnings

public Set<Issue> getWarnings()

Retrieve the Warnings identified

Returns:

A set of unique Warning-Level Issues