com.galenframework.validation.SpecValidationCount Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of galen-core Show documentation
A library for layout testing of websites
There is a newer version: 2.4.4
/*******************************************************************************
* Copyright 2017 Ivan Shubin http://galenframework.com
* 
* 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.galenframework.validation;

import com.galenframework.page.PageElement;
import com.galenframework.specs.SpecCount;

import java.util.*;

import static java.lang.String.format;

public class SpecValidationCount extends SpecValidation {

    @Override
    public ValidationResult check(PageValidation pageValidation, String objectName, SpecCount spec) throws ValidationErrorException {
        List matchingNames = pageValidation.getPageSpec().findOnlyExistingMatchingObjectNames(spec.getPattern());
        Map reportElements;
        Map filteredElements;

        String filterName;

        if (spec.getFetchType() == SpecCount.FetchType.ANY) {
            filteredElements = findAllObjects(pageValidation, matchingNames);
            reportElements = filteredElements;
            filterName = "";
        } else if (spec.getFetchType() == SpecCount.FetchType.VISIBLE) {
            filteredElements = findVisibleObjects(pageValidation, matchingNames);
            reportElements = filteredElements;
            filterName = " visible";
        } else if (spec.getFetchType() == SpecCount.FetchType.ABSENT) {
            filteredElements = findAbsentObjects(pageValidation, matchingNames);
            reportElements = Collections.emptyMap();
            filterName = " absent";
        } else {
            throw new ValidationErrorException("Unknown filter: " + spec.getFetchType().toString().toLowerCase());
        }


        if (spec.getAmount().holds(filteredElements.size())) {
            return new ValidationResult(spec, convertToValidationObjects(reportElements));
        } else {
            throw new ValidationErrorException()
                    .withValidationObjects(convertToValidationObjects(reportElements))
                    .withMessage(format("There are %d%s objects matching \"%s\" %s",
                            filteredElements.size(),
                            filterName,
                            spec.getPattern(),
                            spec.getAmount().getErrorMessageSuffix("")));
        }
    }

    private List convertToValidationObjects(Map reportElements) {
        List validationObjects = new LinkedList<>();
        for (Map.Entry element : reportElements.entrySet()) {
            validationObjects.add(new ValidationObject(element.getValue().getArea(), element.getKey()));
        }
        return validationObjects;
    }


    private Map findAllObjects(PageValidation pageValidation, List matchingNames) {
        Map objects = new HashMap<>();
        for (String name : matchingNames) {
            objects.put(name, pageValidation.findPageElement(name));
        }
        return objects;
    }

    private Map findVisibleObjects(PageValidation pageValidation, List matchingNames) {
        Map objects = new HashMap<>();
        for (String name : matchingNames) {
            PageElement pageElement = pageValidation.findPageElement(name);
            if (pageElement.isVisible() && pageElement.isPresent()) {
                objects.put(name, pageElement);
            }
        }
        return objects;
    }

    private Map findAbsentObjects(PageValidation pageValidation, List matchingNames) {
        Map objects = new HashMap<>();
        for (String name : matchingNames) {
            PageElement pageElement = pageValidation.findPageElement(name);
            if (!pageElement.isVisible() || !pageElement.isPresent()) {
                objects.put(name, pageElement);
            }
        }
        return objects;
    }
}