com.consol.citrus.actions.LoadPropertiesAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of citrus-base Show documentation
Citrus base and default implementation
There is a newer version: 3.4.1
/*
 * Copyright 2006-2010 the original author or authors.
 *
 * 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.
 */

package com.consol.citrus.actions;

import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;

import com.consol.citrus.AbstractTestActionBuilder;
import com.consol.citrus.context.TestContext;
import com.consol.citrus.exceptions.CitrusRuntimeException;
import com.consol.citrus.util.FileUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.io.Resource;

/**
 * Action reads property files and creates test variables for every property entry. File
 * resource path can define a {@link org.springframework.core.io.ClassPathResource} or
 * a {@link org.springframework.core.io.FileSystemResource}.
 *
 * @author Christoph Deppisch
 */
public class LoadPropertiesAction extends AbstractTestAction {

    /** File resource path */
    private final String filePath;

    /** Logger */
    private static final Logger LOG = LoggerFactory.getLogger(LoadPropertiesAction.class);

    /**
     * Default constructor.
     */
    public LoadPropertiesAction(Builder builder) {
        super("load", builder);

        this.filePath = builder.filePath;
    }

    @Override
    public void doExecute(TestContext context) {
        Resource resource = FileUtils.getFileResource(filePath, context);

        if (LOG.isDebugEnabled()) {
            LOG.debug("Reading property file " + resource.getFilename());
        }

        Properties props = FileUtils.loadAsProperties(resource);

        Map unresolved = new LinkedHashMap<>();
        for (Entry entry : props.entrySet()) {
            String key = entry.getKey().toString();

            if (LOG.isDebugEnabled()) {
                LOG.debug("Loading property: " + key + "=" + props.getProperty(key) + " into variables");
            }

            if (LOG.isDebugEnabled() && context.getVariables().containsKey(key)) {
                LOG.debug("Overwriting property " + key + " old value:" + context.getVariable(key)
                        + " new value:" + props.getProperty(key));
            }

            try {
                context.setVariable(key, context.replaceDynamicContentInString(props.getProperty(key)));
            } catch (CitrusRuntimeException e) {
                unresolved.put(key, props.getProperty(key));
            }
        }

        context.resolveDynamicValuesInMap(unresolved).forEach(context::setVariable);

        LOG.info("Loaded property file " + resource.getFilename());
    }

    /**
     * Gets the file.
     * @return the file
     */
    public String getFilePath() {
        return filePath;
    }

    /**
     * Action builder.
     */
    public static final class Builder extends AbstractTestActionBuilder {

        private String filePath;

        /**
         * Fluent API action building entry method used in Java DSL.
         * @param filePath
         * @return
         */
        public static Builder load(String filePath) {
            Builder builder = new Builder();
            builder.filePath(filePath);
            return builder;
        }

        public Builder filePath(String filePath) {
            this.filePath = filePath;
            return this;
        }

        @Override
        public LoadPropertiesAction build() {
            return new LoadPropertiesAction(this);
        }
    }
}