io.wcm.qa.glnm.galen.specs.GalenSpecRun Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of io.wcm.qa.galenium.galen Show documentation
Galen specific integration and functionality.
The newest version!
/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2019 wcm.io
 * %%
 * 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.
 * #L%
 */
package io.wcm.qa.glnm.galen.specs;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.apache.commons.collections4.CollectionUtils;

import com.galenframework.reports.model.LayoutReport;
import com.galenframework.validation.ValidationError;
import com.galenframework.validation.ValidationResult;

/**
 * Represents an execution of a Galen spec.
 *
 * @since 4.0.0
 */
public class GalenSpecRun {

  private LayoutReport report;
  private GalenSpec spec;

  /**
   * Constructor for GalenSpecRun.
   *
   * @param spec a {@link io.wcm.qa.glnm.galen.specs.GalenSpec} object.
   * @param report a {@link com.galenframework.reports.model.LayoutReport} object.
   * @since 4.0.0
   */
  public GalenSpecRun(GalenSpec spec, LayoutReport report) {
    setSpec(spec);
    setReport(report);
  }

  /**
   * Get all messages from all errors of this run.
   *
   * @return all messages of run
   * @since 4.0.0
   */
  public Collection getMessages() {
    Collection messages = new ArrayList();
    List validationErrors = getValidationErrors();
    for (ValidationResult validationResult : validationErrors) {
      messages.addAll(getMessages(validationResult));
    }
    return messages;
  }

  /**
   * When there are no errors or warnings the spec is considered clean.
   *
   * @return whether spec is clean
   * @since 4.0.0
   */
  public boolean isClean() {
    return getValidationErrors().isEmpty();
  }

  /**
   * When there are errors that are not marked as warning level only.
   *
   * @return whether spec has failed
   * @since 4.0.0
   */
  public boolean isFailed() {
    return getReport().errors() > 0;
  }

  /**
   * When there are errors that are not marked as warning level only.
   *
   * @return whether spec has failed
   * @since 4.0.0
   */
  public boolean isWarning() {
    return getReport().warnings() > 0;
  }

  private Collection getMessages(ValidationResult validationResult) {
    Collection messages = new ArrayList();
    ValidationError error = validationResult.getError();
    if (error != null) {
      List errorMessages = error.getMessages();
      CollectionUtils.addAll(messages, errorMessages);
    }
    for (ValidationResult childResult : validationResult.getChildValidationResults()) {
      messages.addAll(getMessages(childResult));
    }
    return messages;
  }

  protected LayoutReport getReport() {
    return report;
  }

  protected GalenSpec getSpec() {
    return spec;
  }

  /**
   * getValidationErrors.
   *
   * @return a {@link java.util.List} object.
   * @since 4.0.0
   */
  protected List getValidationErrors() {
    return getReport().getValidationErrorResults();
  }

  protected void setReport(LayoutReport report) {
    this.report = report;
  }

  protected void setSpec(GalenSpec spec) {
    this.spec = spec;
  }

}