io.tapack.satisfy.fixtures.ProxyFixture Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of satisfy-web-steps Show documentation
There is a newer version: 0.6.6
/*
 * Copyright © 2015 Tapack, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Tapack Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Tapack Software is supplied to you by Tapack in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Tapack Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Tapack Software.
 *
 * Neither the name, trademarks, service marks or logos of Tapack may be used
 * to endorse or promote products derived from the Tapack Software without
 * specific prior written permission from Tapack.
 *
 * The Tapack Software is provided by Tapack on an "AS IS" basis. TAPACK
 * MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE TAPACK SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL TAPACK BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE TAPACK SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF TAPACK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.tapack.io/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Tapack and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Tapack and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Tapack or visit www.tapack.io if you need additional
 * information or have any questions.
 */

package io.tapack.satisfy.fixtures;

import net.thucydides.core.fixtureservices.FixtureException;
import net.thucydides.core.fixtureservices.FixtureService;
import org.openqa.selenium.Proxy;
import org.openqa.selenium.Proxy.ProxyType;
import org.openqa.selenium.remote.CapabilityType;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.InputStream;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Properties;

public class ProxyFixture implements FixtureService {

    private final static String PROPERTIES_FILENAME = "zap.proxy.properties";
    private static final Logger LOGGER = LoggerFactory.getLogger(ProxyFixture
            .class);

    @Override
    public void setup() throws FixtureException {
    }

    @Override
    public void shutdown() throws FixtureException {
    }

    @Override
    public void addCapabilitiesTo(DesiredCapabilities capabilities) {
        Map proxyProperties = getProxyProperties();

        if (proxyProperties.size() == 0) {
            return;
        } else if (proxyProperties.containsValue("")) {
            try {
                throw new Exception(
                        "Proxy cannot be set. Please provide all settings " +
                                "needed to setup proxy connection.");
            } catch (Exception e) {
                e.printStackTrace();
                return;
            }
        } else {
            LOGGER.error("Setting proxy ...");
            setProxyTo(capabilities, proxyProperties);
        }
    }

    private void setProxyTo(DesiredCapabilities capabilities, Map proxyProperties) {
        Proxy proxy = new Proxy();
        boolean isEnable = false;
        try {
            String enableParam = System.getProperty("zap.enable");
            isEnable = Boolean.parseBoolean(enableParam);
        } catch (Exception ex) {
            LOGGER.error("\"NullPointerException = \" + ex.getMessage()");
        }


        String host = proxyProperties.get(ProxyProperty.ZAP_PROXY_HOST
                .toString());
        String port = proxyProperties.get(ProxyProperty.ZAP_PROXY_PORT
                .toString());

        if (!isEnable) {
            LOGGER.error("Proxy will not be set: " + " = " + isEnable);
            return;
        }
        proxy.setHttpProxy(host + ":" + port);
        proxy.setSocksProxy(host + ":" + port);
        proxy.setFtpProxy(host + ":" + port);
        proxy.setSslProxy(host + ":" + port);
        proxy.setProxyType(ProxyType.MANUAL);

        capabilities.setCapability(CapabilityType.PROXY, proxy);
    }


    private Map getProxyProperties() {
        Map result = new LinkedHashMap<>();
        Properties propertyFile = new Properties();

        try {
            InputStream inputStream = getClass().getClassLoader()
                    .getResourceAsStream(PROPERTIES_FILENAME);
            propertyFile.load(inputStream);
        } catch (Exception e) {
            return new LinkedHashMap<>();
        }

        LOGGER.error("Loading proxy properties...");
        ProxyProperty[] availableProperties = ProxyProperty.values();
        for (int i = 0; i < availableProperties.length; i++) {
            ProxyProperty prop = availableProperties[i];
            String propName = prop.getPropertyName();
            String propValue = prop.from(propertyFile);

            result.put(propName, propValue);
            LOGGER.error(propName + "=" + propValue);
        }
        return result;
    }
}