venetian 0.1.3-aarch64-linux → 0.2.0-aarch64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15bd1816bf46b2c665c31ce88244a59cc01330fed45524d604dd8b1a34e44918
-  data.tar.gz: f41d2df119460fdbab3c4d73c3322d8b0c5aed5917b5b58fa42584060bab42bd
+  metadata.gz: 50cfc5a705f2b283a106e74ca82adbd9507939b1f9ceca3e0450b89d976a4e1d
+  data.tar.gz: 0cf918439787fca987ce9238ac7718763ffc46675d40a38de0af7640961fd8a3
 SHA512:
-  metadata.gz: 596a38de0f4fd67ff85ed6d77127ab2f263610ba1405868017fd79a9fd901ac619e055b2be906faf6aef0046b4c94860e554ef7867cbaab0ba64eddbb42e7258
-  data.tar.gz: 5c4aefed11e760b563b4e00986b7043a836741f43fb95e3d392c218a2c35a19cae5de86e414908464e9fd1ff1b32a460026009d8bafe3abf0ce51b73bdbcb437
+  metadata.gz: e89bbab38e2669672584672de881207e9467c81ae41badaf2b7aa310d1da6413c48dc89efae46afcd28889ea7c4ffd4773985e3863343e0c3213eff985fc39ee
+  data.tar.gz: b41d91487578d454c0fb9ca211dc74aaa8b603f44e4c8f6099e04da19215d84fa1772ff59c6a2446d4db671adaefacee5cc10804f2c5883213ca574c101720d4

data/README.md

@@ -14,9 +14,11 @@ bundle add venetian --group test
 
 ## Usage
 
+### Rails system tests
+
 In your system test case, choose the Playwright driver. Venetian will provide the base command to run Playwright,
 which you can still override by passing `:playwright_cli_executable_path`, and this plus any other options will be passed through 
-to `capybara-playwright-driver`. If you specify a browser, this will be automatically downloaded if necessary.
+to `capybara-playwright-driver`.
 
 ```ruby
 require "test_helper"
@@ -26,6 +28,73 @@ class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
 end
 ```
 
+### Using Capybara directly
+
+Likewise, register the Playwright driver before using it later:
+
+```ruby
+Capybara.register_driver :playwright do |app|
+  Capybara::Playwright::Driver.new(app)
+end
+```
+
+### Automatic browser and dependency installation
+
+The gem will automatically install a browser and dependencies for you before attempting to use it.
+Browsers are installed to `$XDG_CACHE_HOME/ms-playwright` on Linux, `~/Library/Caches/ms-playwright` on macOS, 
+and `%LOCALAPPDATA%\ms-playwright` on Windows. In CI, you will want to 
+[cache this directory](https://docs.github.com/en/actions/reference/workflows-and-actions/dependency-caching) 
+to avoid downloads on every run.
+
+On Linux,
+[Playwright currently only officially supports Debian and Ubuntu](https://playwright.dev/docs/intro#system-requirements) 
+due to e.g. differences between package managers and package names across distros, 
+so dependency installation happens only if a compatible package manager is found.
+Depending on what you're doing, you may not need to install dependencies, 
+but if you do and your distro is unsupported, you will need to work out what you need and deal with that first.
+
+When parallelizing tests, there's also the issue of multiple processes all trying to acquire the package manager lock:
+if you use Rails system tests with `ActionDispatch::SystemTestCase`,
+this is handled automatically by installing all required browsers before disabling auto-installation and then forking.
+
+### Installing browsers manually
+
+If you can't rely on automatic installation, you can use the included Rake task to install browsers.
+With Rails this is included automatically when the gem is required.
+
+```bash
+$ RAILS_ENV=test rails venetian:install
+
+# Or a specific browser
+$ RAILS_ENV=test rails venetian:install[firefox]
+```
+
+Otherwise in your Rakefile add:
+
+```ruby
+load "tasks/venetian.rake"
+```
+
+And then run:
+
+```bash
+$ rake venetian:install
+```
+
+### Running Playwright yourself
+
+The gem provides a `playwright` executable which you can use to run Playwright yourself.
+
+```bash
+$ playwright --version 
+Version 1.61.1
+```
+
+### Getting more output
+
+Noisy output during a test run is often frustrating, so the gem is quiet by default. 
+You can get more output with `VENETIAN_DEBUG=1`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.