com.shaft.properties.internal.Web Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of SHAFT_ENGINE Show documentation

SHAFT is a unified test automation engine. Powered by best-in-class frameworks, SHAFT provides a wizard-like syntax to drive your automation efficiently, maximize your ROI, and minimize your learning curve. Stop reinventing the wheel. Upgrade now!

There is a newer version: 8.2.20240402

Show newest version

package com.shaft.properties.internal;

import com.shaft.tools.io.ReportManager;
import org.aeonbits.owner.Config.Sources;
import org.aeonbits.owner.ConfigFactory;

@SuppressWarnings("unused")
@Sources({"system:properties", "file:src/main/resources/properties/WebCapabilities.properties", "file:src/main/resources/properties/default/WebCapabilities.properties", "classpath:WebCapabilities.properties"})
public interface Web extends EngineProperties {
    private static void setProperty(String key, String value) {
        var updatedProps = new java.util.Properties();
        updatedProps.setProperty(key, value);
        Properties.web = ConfigFactory.create(Web.class, updatedProps);
        // temporarily set the system property to support hybrid read/write mode
        System.setProperty(key, value);
        ReportManager.logDiscrete("Setting \"" + key + "\" property with \"" + value + "\".");
    }

    @Key("targetBrowserName")
    @DefaultValue("chrome")
    String targetBrowserName();

    @Key("headlessExecution")
    @DefaultValue("false")
    boolean headlessExecution();

    @Key("isMobileEmulation")
    @DefaultValue("false")
    boolean isMobileEmulation();

    @Key("mobileEmulation.isCustomDevice")
    @DefaultValue("false")
    boolean mobileEmulationIsCustomDevice();

    @Key("mobileEmulation.deviceName")
    @DefaultValue("")
    String mobileEmulationDeviceName();

    @Key("mobileEmulation.width")
    @DefaultValue("")
    int mobileEmulationWidth();

    @Key("mobileEmulation.height")
    @DefaultValue("")
    int mobileEmulationHeight();

    @Key("mobileEmulation.pixelRatio")
    @DefaultValue("1.0")
    double mobileEmulationPixelRatio();

    @Key("mobileEmulation.userAgent")
    @DefaultValue("")
    String mobileEmulationUserAgent();

    @Key("baseURL")
    @DefaultValue("")
    String baseURL();

    @Key("lightHouseExecution")
    @DefaultValue("false")
    boolean lightHouseExecution();

    @Key("lightHouseExecution.port")
    @DefaultValue("8888")
    int lightHouseExecutionPort();

    default SetProperty set() {
        return new SetProperty();
    }

    class SetProperty implements EngineProperties.SetProperty {
        public void baseURL(String value) {
            setProperty("baseURL", value);
        }

        /**
         * @param value io.github.shafthq.shaft.enums.Browsers
         */
        public void targetBrowserName(String value) {
            setProperty("targetBrowserName", value);
        }

        public void headlessExecution(boolean value) {
            setProperty("headlessExecution", String.valueOf(value));
        }

        public void isMobileEmulation(boolean value) {
            setProperty("isMobileEmulation", String.valueOf(value));
        }

        public void mobileEmulationIsCustomDevice(boolean value) {
            setProperty("mobileEmulation.isCustomDevice", String.valueOf(value));
        }

        public void mobileEmulationDeviceName(String value) {
            setProperty("mobileEmulation.deviceName", value);
        }

        public void mobileEmulationWidth(int value) {
            setProperty("mobileEmulation.width", String.valueOf(value));
        }

        public void mobileEmulationHeight(int value) {
            setProperty("mobileEmulation.height", String.valueOf(value));
        }

        public void mobileEmulationPixelRatio(double value) {
            setProperty("mobileEmulation.pixelRatio", String.valueOf(value));
        }

        public void mobileEmulationUserAgent(String value) {
            setProperty("mobileEmulation.userAgent", value);
        }

        public void lightHouseExecution(String value) {
            setProperty("lightHouseExecution", value);
        }

        public void lightHouseExecutionPort(String value) {
            setProperty("lightHouseExecution.port", value);
        }
    }

}