+ + * This annotation is used in Quarkus applications to automatically inject + * Playwright resources into fields where it is applied. It is intended + * for use with fields of classes that depend on Playwright for browser automation + * and testing. + *
+ *+ * Usage example: + * + *
+ * {@code
+ * @InjectPlaywright
+ * private Playwright playwright;
+ * }
+ *
+ *
+ *
+ * + * The annotation should be retained at runtime, as it is processed by the + * Quarkus framework to inject the necessary Playwright instances. + *
+ * + * @since 1.0 + */ +@Retention(RetentionPolicy.RUNTIME) // The annotation is available at runtime for Quarkus to process. +@Target(ElementType.FIELD) // This annotation can only be applied to fields. +public @interface InjectPlaywright { +} \ No newline at end of file diff --git a/runtime/src/main/java/io/quarkiverse/playwright/PlaywrightRecorder.java b/runtime/src/main/java/io/quarkiverse/playwright/PlaywrightRecorder.java new file mode 100644 index 0000000..59560f3 --- /dev/null +++ b/runtime/src/main/java/io/quarkiverse/playwright/PlaywrightRecorder.java @@ -0,0 +1,62 @@ +package io.quarkiverse.playwright; + +import java.io.IOException; +import java.net.URI; +import java.net.URISyntaxException; +import java.nio.file.FileSystem; +import java.nio.file.FileSystems; +import java.util.Collections; + +import org.jboss.logging.Logger; + +import com.microsoft.playwright.impl.driver.jar.DriverJar; + +import io.quarkus.runtime.annotations.Recorder; + +/** + * A recorder for managing Playwright driver initialization. + * This class handles the setup of the Playwright driver by + * loading the driver resources and creating a file system + * for those resources. + */ +@Recorder +public class PlaywrightRecorder { + + private static final Logger log = Logger.getLogger(PlaywrightRecorder.class); + + /** + * Initializes the Playwright driver by obtaining its resource URI, + * setting up a file system, and logging relevant information. + * + *+ * This method attempts to retrieve the URI of the driver resources + * and creates a new file system for accessing those resources. If the + * file system cannot be created, an error is logged. + *
+ * + * In Native mode this is `resource:/` and must be registered before anything else. + * + * @throws RuntimeException if there is an error in URI syntax or + * during file system creation. + */ + public void initialize() { + try { + // Retrieve the URI of the Playwright driver resources + URI uri = DriverJar.getDriverResourceURI(); + log.infof("Playwright Driver: %s", uri); + + // Create a new file system for the driver resources typically resource:/ + FileSystem fs = FileSystems.newFileSystem(uri, Collections.emptyMap()); + if (fs == null) { + log.errorf("FileSystem Error NULL: %s", uri); + } + + // Log the directory where the driver is located + DriverJar jar = new DriverJar(); + log.debugf("Playwright Driver Directory: %s", jar.driverDir()); + } catch (URISyntaxException | IOException e) { + // Wrap and throw any exceptions that occur during initialization + throw new RuntimeException(e); + } + } +} \ No newline at end of file diff --git a/runtime/src/main/java/io/quarkiverse/playwright/QuarkusPlaywrightManager.java b/runtime/src/main/java/io/quarkiverse/playwright/QuarkusPlaywrightManager.java new file mode 100644 index 0000000..f86d957 --- /dev/null +++ b/runtime/src/main/java/io/quarkiverse/playwright/QuarkusPlaywrightManager.java @@ -0,0 +1,172 @@ +package io.quarkiverse.playwright; + +import java.nio.file.Paths; +import java.util.Arrays; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; + +import org.apache.commons.lang3.StringUtils; + +import com.microsoft.playwright.Browser; +import com.microsoft.playwright.BrowserContext; +import com.microsoft.playwright.BrowserType; +import com.microsoft.playwright.BrowserType.LaunchOptions; +import com.microsoft.playwright.Playwright; + +import io.quarkus.test.common.QuarkusTestResourceConfigurableLifecycleManager; + +/** + * Manages the lifecycle of a Playwright instance in Quarkus tests. + *+ * This class implements {@link QuarkusTestResourceConfigurableLifecycleManager} and is responsible + * for initializing and configuring Playwright resources, such as the {@link Browser}, + * {@link BrowserContext}, and {@link Playwright} instance, according to the settings specified + * in the {@link WithPlaywright} annotation. + *
+ * + *+ * This manager supports injecting Playwright resources into test classes marked with the + * {@code @InjectPlaywright} annotation, allowing easy access to {@link BrowserContext}, + * {@link Browser}, or {@link Playwright} instances. + *
+ * + * @see WithPlaywright + * @see InjectPlaywright + * @see QuarkusTestResourceConfigurableLifecycleManager + * @since 1.0 + */ +public class QuarkusPlaywrightManager implements QuarkusTestResourceConfigurableLifecycleManager+ * This method supports injection of {@link BrowserContext}, {@link Browser}, and {@link Playwright} + * into appropriately annotated fields. + *
+ * + * @param testInjector the test injector responsible for dependency injection + */ + @Override + public void inject(TestInjector testInjector) { + // Injects BrowserContext if @InjectPlaywright is present on a matching field + testInjector.injectIntoFields(playwrightContext, + new TestInjector.AnnotatedAndMatchesType(InjectPlaywright.class, BrowserContext.class)); + + // Injects Playwright if @InjectPlaywright is present on a matching field + testInjector.injectIntoFields(playwright, + new TestInjector.AnnotatedAndMatchesType(InjectPlaywright.class, Playwright.class)); + + // Injects Browser if @InjectPlaywright is present on a matching field + testInjector.injectIntoFields(playwrightBrowser, + new TestInjector.AnnotatedAndMatchesType(InjectPlaywright.class, Browser.class)); + } +} \ No newline at end of file diff --git a/runtime/src/main/java/io/quarkiverse/playwright/WithPlaywright.java b/runtime/src/main/java/io/quarkiverse/playwright/WithPlaywright.java new file mode 100644 index 0000000..c9fbd24 --- /dev/null +++ b/runtime/src/main/java/io/quarkiverse/playwright/WithPlaywright.java @@ -0,0 +1,129 @@ +package io.quarkiverse.playwright; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import io.quarkus.test.common.QuarkusTestResource; + +/** + * Annotation to configure and enable Playwright for Quarkus tests. + *+ * This annotation sets up a Playwright testing environment with options for + * browser selection, debugging, and configuration of other Playwright features. + * It is applied at the class level and managed by {@link QuarkusPlaywrightManager}. + *
+ * + *+ * Usage example: + * + *
+ * {@code
+ * @WithPlaywright(browser = Browser.FIREFOX, headless = false, verbose = true)
+ * public class PlaywrightTest {
+ * // Test code here
+ * }
+ * }
+ *
+ *
+ *
+ * @see io.quarkus.test.common.QuarkusTestResource
+ * @see QuarkusPlaywrightManager
+ * @since 1.0
+ */
+@QuarkusTestResource(QuarkusPlaywrightManager.class)
+@Retention(RetentionPolicy.RUNTIME) // Annotation is retained at runtime for test setup.
+@Target(ElementType.TYPE) // Applied only at the class level.
+public @interface WithPlaywright {
+
+ /**
+ * Specifies the browser to use for Playwright tests.
+ * + * Defaults to {@link Browser#CHROMIUM}. + *
+ */ + Browser browser() default Browser.CHROMIUM; + + /** + * Enables Playwright verbose logging. + *+ * Set to {@code true} to enable detailed logging, useful for debugging. + *
+ */ + boolean verbose() default false; + + /** + * Enables the Playwright Debug Inspector for debugging tests. + *+ * Use {@code true} to launch the inspector, which pauses tests for interactive debugging. + *
+ */ + boolean debug() default false; + + /** + * Specifies the distribution channel of the browser to use, such as "chrome" or "msedge". + *+ * Supported values include "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", + * "msedge-beta", "msedge-dev", and "msedge-canary". + *
+ *+ * Refer to the + * Playwright documentation for additional details on using these channels. + *
+ */ + String channel() default ""; + + /** + * Enables sandboxing for Chromium-based browsers. + *+ * Defaults to {@code false} for compatibility. Set to {@code true} to enable sandboxing if supported. + *
+ */ + boolean chromiumSandbox() default false; + + /** + * Runs the browser in headless mode, which is suitable for CI environments. + *+ * Defaults to {@code true} unless the {@code devtools} option is enabled. + *
+ *+ * See more about headless mode in + * Chromium and Firefox. + *
+ */ + boolean headless() default true; + + /** + * Slows down Playwright operations by the specified number of milliseconds. + *+ * This is useful for observing browser interactions more clearly during tests. + *
+ */ + double slowMo() default 0; + + /** + * Specifies the directory to store video recordings of all pages. + *+ * If not set, video recording is disabled. + *
+ */ + String recordVideoDir() default ""; + + /** + * Specifies command-line arguments to use when launching the browser. + *+ * Defaults to disabling GPU with {@code "--disable-gpu"}. + *
+ */ + String[] args() default { "--disable-gpu" }; + + /** + * Enum representing the supported browsers for Playwright testing. + */ + enum Browser { + CHROMIUM, // Google Chrome and other Chromium-based browsers. + FIREFOX, // Mozilla Firefox browser. + WEBKIT // WebKit browser, primarily for Safari compatibility. + } +} \ No newline at end of file diff --git a/runtime/src/main/java/io/quarkiverse/playwright/graal/DriverLoggingSubstitution.java b/runtime/src/main/java/io/quarkiverse/playwright/graal/DriverLoggingSubstitution.java new file mode 100644 index 0000000..4d0ca19 --- /dev/null +++ b/runtime/src/main/java/io/quarkiverse/playwright/graal/DriverLoggingSubstitution.java @@ -0,0 +1,32 @@ +package io.quarkiverse.playwright.graal; + +import java.time.ZonedDateTime; +import java.time.format.DateTimeFormatter; + +import com.oracle.svm.core.annotate.Alias; +import com.oracle.svm.core.annotate.Substitute; +import com.oracle.svm.core.annotate.TargetClass; + +import io.quarkus.logging.Log; + +/** + * Replace System.err.println with Jboss Logging. + */ +@TargetClass(className = "com.microsoft.playwright.impl.driver.DriverLogging") +final class DriverLoggingSubstitution { + + @Alias + private static boolean isEnabled; + + @Alias + private static DateTimeFormatter timestampFormat; + + @Substitute + static void logWithTimestamp(String message) { + if (!isEnabled) { + return; + } + String timestamp = ZonedDateTime.now().format(timestampFormat); + Log.infof("%s %s", timestamp, message); + } +} diff --git a/runtime/src/main/java/io/quarkiverse/playwright/graal/LoggingSupportSubstitution.java b/runtime/src/main/java/io/quarkiverse/playwright/graal/LoggingSupportSubstitution.java new file mode 100644 index 0000000..253215f --- /dev/null +++ b/runtime/src/main/java/io/quarkiverse/playwright/graal/LoggingSupportSubstitution.java @@ -0,0 +1,41 @@ +package io.quarkiverse.playwright.graal; + +import java.time.ZonedDateTime; +import java.time.format.DateTimeFormatter; + +import com.oracle.svm.core.annotate.Alias; +import com.oracle.svm.core.annotate.Substitute; +import com.oracle.svm.core.annotate.TargetClass; + +import io.quarkus.logging.Log; + +/** + * Replace System.out.println with Jboss Logging. + */ +@TargetClass(className = "com.microsoft.playwright.impl.LoggingSupport") +final class LoggingSupportSubstitution { + + @Alias + private static boolean isEnabled; + + @Alias + private static DateTimeFormatter timestampFormat; + + @Substitute + static void logWithTimestamp(String message) { + String timestamp = ZonedDateTime.now().format(timestampFormat); + Log.infof("%s %s", timestamp, message); + } + + @Substitute + static void logApiIfEnabled(String message) { + if (isEnabled) { + logApi(message); + } + } + + @Substitute + static void logApi(String message) { + logWithTimestamp("pw:api " + message); + } +} diff --git a/testing/src/main/resources/META-INF/quarkus-extension.yaml b/runtime/src/main/resources/META-INF/quarkus-extension.yaml similarity index 51% rename from testing/src/main/resources/META-INF/quarkus-extension.yaml rename to runtime/src/main/resources/META-INF/quarkus-extension.yaml index ec0bb49..bbf526b 100644 --- a/testing/src/main/resources/META-INF/quarkus-extension.yaml +++ b/runtime/src/main/resources/META-INF/quarkus-extension.yaml @@ -1,5 +1,5 @@ name: Playwright -description: Playwright enables reliable end-to-end testing for modern web apps. +description: Playwright is an open-source automation library for end-to-end browser testing and web scraping. metadata: type: test keywords: @@ -7,8 +7,12 @@ metadata: - e2e - end-to-end - playwright - guide: https://quarkiverse.github.io/quarkiverse-docs/playwright/dev/ # To create and publish this guide, see https://github.com/quarkiverse/quarkiverse/wiki#documenting-your-extension - icon-url: "https://playwright.dev/java/img/playwright-logo.svg" + - browser + - screen-scraper categories: - - "testing" - status: "stable" + - "web" + config: + - "quarkus.playwright." + guide: https://quarkiverse.github.io/quarkiverse-docs/playwright/dev/ + icon-url: "https://playwright.dev/java/img/playwright-logo.svg" + status: "stable" \ No newline at end of file diff --git a/testing/pom.xml b/testing/pom.xml deleted file mode 100644 index 919da3a..0000000 --- a/testing/pom.xml +++ /dev/null @@ -1,33 +0,0 @@ - -