io.wcm.qa.glnm.galen.specs.GalenSpecUtil 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 static io.wcm.qa.glnm.selectors.base.SelectorFactory.fromLocator;
import static io.wcm.qa.glnm.util.GaleniumContext.getTestDevice;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;

import org.apache.commons.collections4.ListUtils;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.galenframework.speclang2.pagespec.SectionFilter;
import com.galenframework.specs.page.Locator;
import com.galenframework.specs.page.PageSpec;

import io.wcm.qa.glnm.device.TestDevice;
import io.wcm.qa.glnm.exceptions.GaleniumException;
import io.wcm.qa.glnm.selectors.SelectorFromLocator;
import io.wcm.qa.glnm.selectors.base.NestedSelector;

/**
 * Utility methods for handling Galen specs.
 *
 * @since 4.0.0
 */
final class GalenSpecUtil {

  static final Map EMPTY_JS_VARS = null;

  static final Properties EMPTY_PROPERTIES = new Properties();
  private static final List EMPTY_TAG_LIST = Collections.emptyList();
  private static final Logger LOG = LoggerFactory.getLogger(GalenSpecUtil.class);

  private GalenSpecUtil() {
    // do not instantiate
  }

  private static String cleanName(String name) {
    LOG.debug("mapping '" + name + "'");
    String[] nameParts = name.split("\\.");
    List namePartList = new ArrayList<>();
    for (String namePart : nameParts) {
      if (namePart.matches(".*-[0-9][0-9]*")) {
        namePartList.add(namePart.replaceFirst("-[0-9][0-9]*$", ""));
      }
      else {
        namePartList.add(namePart);
      }
    }
    String cleanName = StringUtils.join(namePartList, ".");
    LOG.debug("clean name for muliple object locator '" + cleanName + "'");
    return cleanName;
  }

  private static Collection extractCollectionFromMapping(Map objectMapping) {
    Collection objects = new ArrayList<>();
    Collection values = objectMapping.values();
    for (SelectorFromLocator selector : values) {
      LOG.debug("checking " + selector);
      if (selector.hasParent()) {
        LOG.debug("has parent " + selector);
        NestedSelector parent = selector.getParent();
        LOG.debug("parentName: '" + parent.elementName() + "'");
        String parentCss = parent.asString();
        LOG.debug("parentCss: '" + parentCss + "'");
        SelectorFromLocator trueParent = objectMapping.get(parentCss);
        if (trueParent == null) {
          throw new GaleniumException("parent for '" + selector.elementName() + "' not found in spec ('" + parentCss + "')");
        }
        selector.setParent(trueParent);
        trueParent.addChild(selector);
      }
      else {
        LOG.debug("no parent found.");
      }
      objects.add(selector);
      LOG.debug("added: " + selector);
    }
    return objects;
  }

  private static Map getObjectMapping(PageSpec spec) {
    Map objectMapping = new HashMap();
    Map objects = spec.getObjects();
    LOG.debug("mapping " + objects.size() + " selector candidates.");
    for (Entry entry : objects.entrySet()) {
      String name = cleanName(entry.getKey());
      Locator locator = entry.getValue();
      SelectorFromLocator selector = fromLocator(name, locator);
      String asString = selector.asString();
      if (objectMapping.containsKey(asString)) {
        LOG.info("duplicate object:" + selector + " == " + objectMapping.get(asString));
      }
      else {
        objectMapping.put(asString, selector);
        LOG.debug("mapped: " + selector);
      }
    }
    LOG.info("mapped " + objectMapping.size() + " selectors.");
    return objectMapping;
  }

  /**
   * Get tags device as Galen {@link com.galenframework.speclang2.pagespec.SectionFilter}.
   * @param tagsForThisRun tags to use in filter
   * @return filter ready for use with Galen
   * @since 4.0.0
   */
  static SectionFilter asSectionFilter(List tagsForThisRun) {
    List tagList = new ArrayList();
    if (ListUtils.emptyIfNull(tagList).isEmpty()) {
      return emptySectionFilter();
    }
    tagList.addAll(tagsForThisRun);
    return new SectionFilter(tagList, EMPTY_TAG_LIST);
  }

  /**
   * Get tags from device as Galen {@link com.galenframework.speclang2.pagespec.SectionFilter}.
   *
   * @param device to get tags from
   * @return filter ready for use with Galen
   * @since 4.0.0
   */
  static SectionFilter asSectionFilter(TestDevice device) {
    return new SectionFilter(device.getTags(), EMPTY_TAG_LIST);
  }

  /**
   * Get tags from current device as Galen {@link com.galenframework.speclang2.pagespec.SectionFilter}. Empty filter
   * when no device set.
   *
   * @return filter ready for use with Galen
   * @since 4.0.0
   */
  static SectionFilter getDefaultIncludeTags() {
    if (getTestDevice() != null) {
      return asSectionFilter(getTestDevice());
    }
    return emptySectionFilter();
  }

  private static SectionFilter emptySectionFilter() {
    return new SectionFilter();
  }

  /**
   * Get objects from {@link com.galenframework.specs.page.PageSpec}.
   *
   * @param spec to extract objects from
   * @return selectors for all objects found in spec
   * @since 4.0.0
   */
  static Collection getObjects(PageSpec spec) {

    Map objectMapping = getObjectMapping(spec);

    return extractCollectionFromMapping(objectMapping);
  }
}