io.wcm.qa.glnm.galen.util.GalenHelperUtil 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) 2017 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.util;

import static io.wcm.qa.glnm.webdriver.WebDriverManagement.getDriver;

import org.openqa.selenium.Dimension;

import com.galenframework.browser.Browser;
import com.galenframework.browser.SeleniumBrowser;
import com.galenframework.config.GalenConfig;
import com.galenframework.config.GalenProperty;
import com.galenframework.utils.GalenUtils;

import io.wcm.qa.glnm.device.TestDevice;
import io.wcm.qa.glnm.util.GaleniumContext;

/**
 * Helper methods for dealing with Galen.
 *
 * @since 1.0.0
 */
public final class GalenHelperUtil {

  private GalenHelperUtil() {
    // do not instantiate
  }

  /**
   * getBrowser.
   *
   * @return a {@link com.galenframework.browser.Browser} object.
   * @since 4.0.0
   */
  public static Browser getBrowser() {
    return new SeleniumBrowser(GaleniumContext.getDriver());
  }

  /**
   * Turns test device into {@link com.galenframework.browser.SeleniumBrowser} as expected by Galen.
   *
   * @param device to turn into browser
   * @return browser object for use with Galen
   * @since 4.0.0
   */
  public static Browser getBrowser(TestDevice device) {
    return new SeleniumBrowser(getDriver(device));
  }

  /**
   * adjustViewport.
   *
   * @param adjustBrowserViewportSize a boolean.
   * @since 4.0.0
   */
  public static void adjustViewport(boolean adjustBrowserViewportSize) {
    GalenConfig.getConfig().setProperty(
        GalenProperty.GALEN_BROWSER_VIEWPORT_ADJUSTSIZE,
        new Boolean(adjustBrowserViewportSize).toString());
  }

  /**
   * Turn Galen syntax size string into Selenium {@link org.openqa.selenium.Dimension}.
   *
   * @param size to parse
   * @return Selenium representation of size
   * @since 4.0.0
   */
  public static Dimension getDimension(String size) {
    java.awt.Dimension parsedSize = GalenUtils.readSize(size);
    return new Dimension(parsedSize.width, parsedSize.height);
  }

}