com.cognifide.qa.bb.config.YamlConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bb-core Show documentation
The newest version!
/*-
 * #%L
 * Bobcat
 * %%
 * Copyright (C) 2016 Cognifide Ltd.
 * %%
 * 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 com.cognifide.qa.bb.config;

import java.io.IOException;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.stream.Collectors;
import java.util.stream.Stream;

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

import com.cognifide.qa.bb.config.yaml.Config;
import com.cognifide.qa.bb.utils.YamlReader;
import com.fasterxml.jackson.core.type.TypeReference;

/**
 * Provides configuration strategy that loads Bobcat properties from a YAML file.
 * 

 * At the moment, to enable this config, Bobcat users needs to run tests with
 * {@value com.cognifide.qa.bb.constants.ConfigKeys#CONFIG_STRATEGY} system property set to {@code yaml}.
 * 

 * 

 * YAML configuration files should follow this format:
 *  * {@code
 *
 * default:
 *   properties:
 *    # default properties
 *   contexts: [context1, context2} # list of context to be loaded by default
 * contexts:
 *   context1:
 *     prop1: value1
 *     prop2: value2
 *     # ...
 *   context2:
 *     propr1: value3
 *     # ...
 *   # ...
 * }
 *
 * @since 1.4.0
 */
public class YamlConfig implements ConfigStrategy {
  public static final String DEFAULT_CONFIG_NAME = "/default";
  public static final String USER_CONFIG_NAME = "/config";

  public static final String SYS_PROP_CONFIG_CONTEXTS = "bobcat.config.contexts";
  public static final String ADDITIONAL_CONTEXTS_FOLDER_NAME = "contexts";
  public static final String ADDITIONAL_CONTEXTS_FOLDER = "/" + ADDITIONAL_CONTEXTS_FOLDER_NAME;

  private static final Logger LOG = LoggerFactory.getLogger(YamlConfig.class);

  /**
   * Loads the default Bobcat configuration from {@code default.yaml} file.
   *
   * @return {@inheritDoc}
   */
  @Override
  public Properties loadDefaultConfig() {
    Properties defaultConfig = new Properties();
    defaultConfig.putAll(readDefaultYaml().getDefaultConfig().getProperties());
    return defaultConfig;
  }

  //not private for unit-testing purposes
  Config readDefaultYaml() {
    return YamlReader.read(DEFAULT_CONFIG_NAME, Config.class);
  }

  /**
   * Loads Bobcat user configuration from {@code config.yaml} file.
   *
   * @return {@inheritDoc}
   */
  @Override
  public Properties loadConfig() {
    Properties config = new Properties();
    Config rawConfig = readUserYaml();
    config.putAll(rawConfig.getDefaultConfig().getProperties());
    config.putAll(getSelectedContexts(rawConfig));
    return config;
  }

  //not private for unit-testing purposes
  Config readUserYaml() {
    return YamlReader.read(USER_CONFIG_NAME, Config.class);
  }

  private Map> readAdditionalContexts() {
    Map> additionalContexts = new HashMap<>();

    URL contextsResource = getClass().getResource(ADDITIONAL_CONTEXTS_FOLDER);
    if (contextsResource != null) {
      try (Stream files = Files.walk(Paths.get(contextsResource.toURI()))) {
        additionalContexts.putAll(files
            .filter(Files::isRegularFile)
            .filter(path -> path.toString().endsWith(YamlReader.YAML))
            .map(this::getContextsFromYaml)
            .map(Map::entrySet)
            .flatMap(Collection::stream)
            .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)));
      } catch (IOException e) {
        LOG.error("Could not read the additional contexts", e);
      } catch (URISyntaxException e) {
        LOG.error("Could not parse the additional contexts folder path", e);
      }
    }
    return additionalContexts;
  }

  private Map> getContextsFromYaml(Path path) {
    TypeReference>> typeRef =
        new TypeReference>>() {
        };
    return YamlReader
        .read(ADDITIONAL_CONTEXTS_FOLDER + StringUtils
                .substringAfter(path.toString(), ADDITIONAL_CONTEXTS_FOLDER_NAME),
            typeRef);
  }

  private Map getSelectedContexts(Config rawConfig) {
    Map contexts = new HashMap<>();
    String contextsProperty = System.getProperty(SYS_PROP_CONFIG_CONTEXTS);
    List selectedContexts = StringUtils.isNotBlank(contextsProperty) ?
        Arrays.asList(contextsProperty.split(",")) : rawConfig.getDefaultConfig().getContexts();

    Map> allContexts = new HashMap<>();

    allContexts.putAll(rawConfig.getContexts());
    allContexts.putAll(readAdditionalContexts());

    selectedContexts.stream().forEach(context -> contexts
        .putAll(allContexts.getOrDefault(context, Collections.emptyMap())));
    return contexts;
  }
}