io.github.martinschneider.justtestlah.configuration.SpringContext Maven / Gradle / Ivy

Go to download
package io.github.martinschneider.justtestlah.configuration;

import com.applitools.eyes.selenium.Eyes;
import com.galenframework.reports.GalenTestInfo;
import io.github.martinschneider.justtestlah.locator.LocatorParser;
import io.github.martinschneider.justtestlah.user.UserService;
import io.github.martinschneider.justtestlah.visual.TemplateMatcher;
import java.lang.reflect.InvocationTargetException;
import java.util.LinkedList;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.yaml.snakeyaml.Yaml;

/** JustTestLah! Spring context. */
@Configuration
@PropertySource(value = {"justtestlah.properties", "file:${justtestlah.properties}"},
    ignoreResourceNotFound = true)
@ComponentScan(basePackages = {"${pages.package}", "${steps.package}"})
public class SpringContext {

  private static final String PCLOUDY_WEB_DRIVER_BUILDER_CLASS = "io.github.martinschneider.justtestlah.configuration.PCloudyConfiguration";
  private static final String BROWSER_STACK_WEB_DRIVER_BUILDER_CLASS = "io.github.martinschneider.justtestlah.configuration.BrowserStackWebDriverBuilder";

  private Logger LOG = LoggerFactory.getLogger(SpringContext.class);

  @Value("${eyes.apiKey}")
  private String eyesApiKey;

  @Value("${cloudprovider:local}")
  private String cloudProvider;

  private List galenTests = new LinkedList<>();

  @Bean
  public JustTestLahConfiguration config() {
    return new JustTestLahConfiguration(webDriverBuilder(), userService());
  }

  @Bean
  public Yaml yamlParser() {
    return new Yaml();
  }

  @Bean
  public LocatorParser locatorParser() {
    return new LocatorParser();
  }

  /**
   * Construct the matching {@link WebDriverBuilder}.
   *
   * @return {@link WebDriverBuilder} matching the configured cloud provider
   */
  @Bean
  public WebDriverBuilder webDriverBuilder() {
    if (cloudProvider.equals("local")) {
      return new LocalWebDriverBuilder();
    }
    // TODO: use Spring to contribute WebDriverBuilders from other modules instead of hard-coding
    // the class names
    else if (cloudProvider.equals("browserstack")) {
      try {
        return getWebDriverBuilder(
            BROWSER_STACK_WEB_DRIVER_BUILDER_CLASS);
      } catch (Exception e) {
        LOG.error(
            "Couldn't instantiate BrowserStackWebDriverBuilder. Ensure that you included `justestlah-browserstack` in your pom.xml!");
      }
    } else if (cloudProvider.equals("pcloudy")) {
      try {
        return getWebDriverBuilder(
            PCLOUDY_WEB_DRIVER_BUILDER_CLASS);
      } catch (Exception e) {
        LOG.error(
            "Couldn't instantiate PCloudyWebDriverBuilder. Ensure that you included `justestlah-pcloudy` in your pom.xml!");
      }
    }
    return null;
  }

  private WebDriverBuilder getWebDriverBuilder(String className)
      throws InstantiationException, IllegalAccessException, InvocationTargetException,
      NoSuchMethodException, ClassNotFoundException {
    return (WebDriverBuilder) Class.forName(className).getConstructor().newInstance();
  }

  @Bean
  public TemplateMatcher templateMatcher() {
    return new TemplateMatcher();
  }

  @Bean
  public UserService userService() {
    return new UserService();
  }

  /**
   * Applitools.
   *
   * @return Applitools {@link Eyes}
   */
  @Bean(destroyMethod = "")
  /**
   * Spring would call close() otherwise which will throw an Exception because we already close it
   * ourselves.
   */
  public Eyes eyes() {
    Eyes eyes = new Eyes();
    eyes.setApiKey(eyesApiKey);
    return eyes;
  }

  @Bean
  public List galenTests() {
    return galenTests;
  }
}