co.verisoft.fw.utils.CapabilitiesReader Maven / Gradle / Ivy

Go to download
package co.verisoft.fw.utils;

import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
import org.openqa.selenium.remote.DesiredCapabilities;

import java.io.FileReader;
import java.util.HashMap;

/**
 * Read capabilities file from Json.
 * Source can be found here:
 * https://medium.com/geekculture/how-to-set-up-appium-desired-capabilities-from-a-json-file-91b3e0bb16dc
 *
 * @author Rommel Malqued
 * @since Aug 2021
 */
@Slf4j
public class CapabilitiesReader {

    private static JSONArray parseJSON(String jsonLocation) throws Exception {
        JSONParser jsonParser = new JSONParser();
        return (JSONArray) jsonParser.parse(new FileReader(jsonLocation));
    }

    private static JSONObject getCapability(String capabilityName, String jsonLocation) throws Exception {
        JSONArray capabilitiesArray = parseJSON(jsonLocation);
        for (Object jsonObj : capabilitiesArray) {
            JSONObject capability = (JSONObject) jsonObj;
            if (capability.get("name").toString().equalsIgnoreCase(capabilityName)) {
                return (JSONObject) capability.get("caps");
            }
        }
        return null;
    }

    private static HashMap convertCapsToHashMap(String capabilityName, String jsonLocation) throws Exception {
        ObjectMapper objectMapper = new ObjectMapper();
        //noinspection unchecked,ConstantConditions
        return objectMapper.readValue(getCapability(capabilityName, jsonLocation).toString(),
                HashMap.class);
    }

    /**
     * Main method of class. This is the entry point to the class logic. Method takes a capability file and capability
     * name, builds a DesiredCapability object and returns it.
     *
     * @param capabilityName          The name of the capability to load
     * @param capsContentRootLocation path to capability
     * @return DesiredCapability file
     * @throws Exception Runtime unexpected exception
     */
    public static DesiredCapabilities getDesiredCapabilities(String capabilityName, String capsContentRootLocation) {
        try {
            HashMap caps = convertCapsToHashMap(capabilityName, capsContentRootLocation);
            log.debug("Capabilities loaded from json file.");
            return new DesiredCapabilities(caps);
        } catch (Exception e) {
            log.warn("Failed to load capabilities.");
            return null;
        }

    }
}