com.phoenixnap.oss.ramlapisync.generation.RamlVerifier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of springmvc-raml-parser Show documentation
Components including the parsing of RAML documents and Spring MVC Annotations to create RAML models
There is a newer version: 0.9.1
Show newest version
/*
 * Copyright 2002-2017 the original author or authors.
 * 
 * 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 com.phoenixnap.oss.ramlapisync.generation;

import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.StringUtils;

import com.phoenixnap.oss.ramlapisync.naming.Pair;
import com.phoenixnap.oss.ramlapisync.naming.RamlHelper;
import com.phoenixnap.oss.ramlapisync.raml.RamlRoot;
import com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckVisitorCoordinator;
import com.phoenixnap.oss.ramlapisync.style.RamlStyleChecker;
import com.phoenixnap.oss.ramlapisync.verification.Issue;
import com.phoenixnap.oss.ramlapisync.verification.RamlActionVisitorCheck;
import com.phoenixnap.oss.ramlapisync.verification.RamlChecker;
import com.phoenixnap.oss.ramlapisync.verification.RamlResourceVisitorCheck;
import com.phoenixnap.oss.ramlapisync.verification.checkers.RamlCheckerResourceVisitorCoordinator;
import com.phoenixnap.oss.ramlapisync.verification.checkers.ResourceExistenceChecker;

/**
 * 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
 * 
 * @author Kurt Paris
 * @since 0.0.2
 *
 */
public class RamlVerifier {
	
	/**
	 * Class Logger
	 */
	protected static final Logger logger = LoggerFactory.getLogger(RamlVerifier.class);

	private RamlRoot published;
	private RamlRoot implemented;
	
	private Set errors = new LinkedHashSet<>();
	private Set warnings = new LinkedHashSet<>();
	
	private List checkers;
	
	/**
	 * 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
	 * 
	 * @param published The RAML model from the published RAML file
	 * @param implemented The RAML model built from the Spring MVC
	 * @param checkers Checkers that will be applied to the models
	 * @param actionCheckers Checker Visitors that will trigger to compare individual actions
	 * @param resourceCheckers Checker Visitors that will trigger to compare individual resources
	 * @param styleChecks Style Checks that will be applied to the models
	 * 
	 */
	public RamlVerifier(RamlRoot published, RamlRoot implemented, List checkers, List actionCheckers, List resourceCheckers, List styleChecks) {
		this(published, implemented, checkers, actionCheckers, resourceCheckers, styleChecks, null);
	}
	
	/**
	 * 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
	 * 
	 * @param published The RAML model from the published RAML file
	 * @param implemented The RAML model built from the Spring MVC
	 * @param checkers Checkers that will be applied to the models
	 * @param actionCheckers Checker Visitors that will trigger to compare individual actions
	 * @param resourceCheckers Checker Visitors that will trigger to compare individual resources
	 * @param styleChecks Style Checks that will be applied to the models
	 * @param implementedUrlPrefixToIgnore The Portion of the url to ignore from the implementation. use this to align urls as an alternative to baseUri
	 * 
	 */
	public RamlVerifier(RamlRoot published, RamlRoot implemented, List checkers, List actionCheckers, List resourceCheckers, List styleChecks, String implementedUrlPrefixToIgnore) {
		this.published = published;
		this.implemented = implemented;
		this.checkers = new ArrayList<>();
		
		if (implemented != null && StringUtils.hasText(implementedUrlPrefixToIgnore)) {
			RamlHelper.removeResourceTree(implemented, implementedUrlPrefixToIgnore);
		}
		
		this.checkers.add(new RamlCheckerResourceVisitorCoordinator(actionCheckers == null ? Collections.emptyList() : actionCheckers, resourceCheckers == null ? Collections.emptyList() : resourceCheckers));
		if (checkers == null) {			
			this.checkers.add(new ResourceExistenceChecker());
		} else {
			this.checkers.addAll(checkers);
		}
		if (styleChecks != null) {
			this.checkers.add(new RamlStyleCheckVisitorCoordinator(styleChecks));			
		}
		validate();
	}
	
	/**
	 * 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
	 * 
	 * @param published The RAML model from the published RAML file
	 * @param implemented The RAML model built from the Spring MVC
	 * @param checkers Checkers that will be applied to the models
	 * @param actionCheckers Checker Visitors that will trigger to compare individual actions
	 * @param resourceCheckers Checker Visitors that will trigger to compare individual resources
	 */
	public RamlVerifier(RamlRoot published, RamlRoot implemented, List checkers, List actionCheckers, List resourceCheckers) {
		this (published, implemented, checkers, actionCheckers, resourceCheckers, null);
	}
	
	/**
	 * Checks if there are any errors generated during the comparison
	 * 
	 * @return If true the verification process has found errors
	 */
	public boolean hasErrors() {
		if (errors.size() > 0) {
			return true;
		} else {
			return false;
		}
	}
	
	/**
	 * Checks if there are any warnings generated during the comparison
	 * 
	 * @return If true the verification process has found warnings
	 */
	public boolean hasWarnings() {
		if (warnings.size() > 0) {
			return true;
		} else {
			return false;
		}
	}
	
	/**
	 * Main orchestration method that will compare two Raml models together and identify discrepancies between the implementation and contract
	 */
	private void validate() {
		if (checkers != null) {
			for (RamlChecker checker : checkers) {
				Pair,Set> check = checker.check(published, implemented);
				warnings.addAll(check.getFirst());
				errors.addAll(check.getSecond());
			}
		}
	}
	
	/**
	 * Retrieve the Errors identified
	 * 
	 * @return A set of unique Error-Level Issues
	 */
	public Set getErrors() {
		return errors;
	}

	/**
	 * Retrieve the Warnings identified
	 * 
	 * @return A set of unique Warning-Level Issues
	 */
	public Set getWarnings() {
		return warnings;
	}

	
	
}