io.wcm.qa.glnm.galen.validation.GalenValidation 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) 2014 - 2016 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.validation;

import org.apache.commons.lang3.StringUtils;

import com.galenframework.validation.ValidationListener;

import io.qameta.allure.Allure;
import io.qameta.allure.model.Status;
import io.wcm.qa.glnm.galen.specs.FileBasedGalenSpec;
import io.wcm.qa.glnm.galen.specs.GalenSpec;
import io.wcm.qa.glnm.galen.specs.GalenSpecRun;
import io.wcm.qa.glnm.galen.specs.imagecomparison.IcsDefinition;
import io.wcm.qa.glnm.galen.specs.imagecomparison.ImageComparisonSpec;

/**
 * Utility methods to run Galen layout checks from Selenium tests. Integration via
 * {@link io.wcm.qa.glnm.util.GaleniumContext}.
 *
 * @since 4.0.0
 */
public final class GalenValidation {

  private GalenValidation() {
    // do not instantiate
  }

  /**
   * Checks Galen spec against current state of driver.
   *
   * @param specPath path to spec file
   * @param tags a {@link java.lang.String} object.
   * @return report on spec test
   * @since 4.0.0
   */
  public static GalenSpecRun check(String specPath, String... tags) {
    GalenSpec spec = new FileBasedGalenSpec(specPath, tags);
    GalenSpecRun check = spec.check(tags);
    if (check.isFailed()) {
      Allure.step("Failed '" + specPath + "' with [" + StringUtils.join(tags, ", ") + "]", Status.FAILED);
    }
    else if (check.isClean()) {
      Allure.step("Successfully checked '" + specPath + "' with [" + StringUtils.join(tags, ", ") + "]");
    }
    return check;
  }

  /**
   * getNoOpValidationListener.
   *
   * @return a {@link com.galenframework.validation.ValidationListener} object.
   * @since 4.0.0
   */
  public static ValidationListener getNoOpValidationListener() {
    return new NoOpValidationListener();
  }

  /**
   * getTracingValidationListener.
   *
   * @return a {@link com.galenframework.validation.ValidationListener} object.
   * @since 4.0.0
   */
  public static ValidationListener getTracingValidationListener() {
    return new TracingValidationListener();
  }

  /**
   * Performs an image comparison against current state of driver.
   * Test name test name will be taken from section name of spec factory and used in reports
   *
   * @param specDefinition {@link io.wcm.qa.glnm.galen.specs.imagecomparison.IcsDefinition} to generate spec to check
   * @return report on spec test
   * @since 4.0.0
   */
  public static GalenSpecRun imageComparison(IcsDefinition specDefinition) {
    GalenSpec spec = new ImageComparisonSpec(specDefinition);
    return spec.check();
  }

}