eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverCapabilityLogHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of driver-ui Show documentation

Testerra test automation framework - driver-ui module

There is a newer version: 2.10

/*
 * Testerra
 *
 * (C) 2021, Eric Kubenka, T-Systems Multimedia Solutions GmbH, Deutsche Telekom AG
 *
 * Deutsche Telekom AG and all other contributors /
 * copyright owners license this file to you 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 eu.tsystems.mms.tic.testframework.webdrivermanager;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.chrome.ChromeOptions;

/**
 * This is a simple helper to modify log messages of {@link Capabilities} to short long values or do other opertations
 * 
 * Date: 13.01.2021
 * Time: 07:14
 *
 * @author Eric Kubenka
 */
class WebDriverCapabilityLogHelper {

    /**
     * Clean the given {@link Capabilities} and return a {@link Map}
     *
     * @param capabilities {@link Capabilities}
     * @return Map
     */
    public Map clean(Capabilities capabilities) {
        return clean(capabilities.asMap());
    }

    public Map clean(Map capabilityMap) {

        // 1. make map modifiable.
        Map mutableCapabilityMap = new TreeMap<>(capabilityMap);

        // 2. do all the operations
        mutableCapabilityMap = shortChromeExtensionStrings(mutableCapabilityMap);

        // 3. make the map unmodifiable again.
        return Collections.unmodifiableMap(mutableCapabilityMap);
    }

    /**
     * Extensions strings are very long, so therefore we will cut them off
     *
     * @param capabilityMap {@link Map}
     * @return Map
     */
    private Map shortChromeExtensionStrings(Map capabilityMap) {

        final Object chromeOptionsObject = capabilityMap.get(ChromeOptions.CAPABILITY);
        final Object extensionsObject = capabilityMap.get("extensions");

        if (chromeOptionsObject != null) {
            final Map chromeOptions = (Map) chromeOptionsObject;
            if (chromeOptions.containsKey("extensions")) {
                chromeOptions.put("extensions", shortAllStringsInLists(chromeOptions.get("extensions")));
            }
        }

        if (extensionsObject != null) {
            capabilityMap.put("extensions", shortAllStringsInLists(extensionsObject));
        }

        return capabilityMap;
    }

    private List shortAllStringsInLists(final Object stringListObject) {
        final List extList = new ArrayList<>();
        ((List) stringListObject).forEach(e -> extList.add(e.substring(0, 10) + "..."));
        return extList;
    }
}