com.intuit.karate.driver.playwright.PlaywrightDriver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of karate-playwright Show documentation
There is a newer version: 1.5.0
/*
 * The MIT License
 *
 * Copyright 2023 Karate Labs Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.intuit.karate.driver.playwright;

import com.intuit.karate.core.ScenarioRuntime;
import com.intuit.karate.playwright.driver.PlaywrightDriverOptions;
import com.microsoft.playwright.Browser;
import com.microsoft.playwright.Playwright;

import java.util.Map;

/**
 * A drop-in replacement for the "legacy" implementation. May help as long as
 * both the old and the new drivers are in the code-base, should be removed
 * if/when one gets dropped.
 *
 * To enable the new implementation, one just needs to add the karate-playwright
 * dependency in their pom.xml before karate-core.
 *
 * To conditionally enable the new implementation is bit more challenging. Maven
 * profiles are typically used for this, but unfortunately, dependencies from
 * profiles are added AFTER regular dependencies, so that won't work.
 *
 * One solution would be to declare karate-playwright as a regular dependency,
 * with its scope controlled by a property. By default, the property is
 * "import", so it won't be picked up by Maven and the legacy driver will be
 * used. But in the profile, the property is set to "compile" so that it gets
 * picked up. A bit of a hack, but it should work.
 *
 */
public class PlaywrightDriver extends com.intuit.karate.playwright.driver.PlaywrightDriver {

    public static PlaywrightDriver start(Map map, ScenarioRuntime sr) {
        return com.intuit.karate.playwright.driver.PlaywrightDriver.start(map, sr, PlaywrightDriver::new);
    }

    public PlaywrightDriver(PlaywrightDriverOptions options, Browser browser, Playwright playwright) {
        super(options, browser, playwright);
        options.driverLogger.info("Using native PlaywrightDriver");
    }
    
}