tests: increase test coverage

Author: nunomaduro

.gitignore

@@ -13,3 +13,6 @@ coverage.xml
 # Playwright
 node_modules/
 /tests/Browser/screenshots
+
+# MacOS
+.DS_Store

composer.json

@@ -49,7 +49,7 @@
         "test:type-coverage": "pest --type-coverage --exactly=100",
         "test:typos": "peck",
         "test:lint": "pint --test",
-        "test:unit": "pest --parallel --coverage --exactly=76.6",
+        "test:unit": "pest --parallel --coverage --exactly=79.7",
         "test:types": "phpstan",
         "test:refactor": "rector --dry-run",
         "test": [

phpunit.xml

@@ -31,7 +31,4 @@
             <directory suffix=".php">./src</directory>
         </include>
     </source>
-    <php>
-        <env name="PEST_BROWSER_SCREENSHOT_DIR" value="./tests/Browser/screenshots"/>
-    </php>
 </phpunit>

src/Playwright/Frame.php

@@ -519,10 +519,8 @@ public function selectOption(
 
     /**
      * Evaluates a JavaScript expression in the frame context.
-     *
-     * @param  mixed  $arg
      */
-    public function evaluate(string $pageFunction, $arg = null): mixed
+    public function evaluate(string $pageFunction, mixed $arg = null): mixed
     {
         $params = ['expression' => $pageFunction];
 

src/Playwright/Locator.php

@@ -190,10 +190,10 @@ public function press(string $key, ?array $options = null): void
     /**
      * Select options by value in a select element matching the locator.
      *
-     * @param  string|array<string>  $values
+     * @param  array<int, string>|string  $values
      * @param  array<string, mixed>|null  $options
      */
-    public function selectOption($values, ?array $options = null): void
+    public function selectOption(array|string $values, ?array $options = null): void
     {
         $values = is_array($values) ? $values : [$values];
         $params = array_merge(['values' => $values], $options ?? []);

src/Plugin.php

@@ -4,6 +4,7 @@
 
 namespace Pest\Browser;
 
+use Pest\Browser\Support\Screenshot;
 use Pest\Contracts\Plugins\Bootable;
 use Pest\Contracts\Plugins\Terminable;
 use Pest\Plugins\Parallel;
@@ -20,6 +21,8 @@ public function boot(): void
     {
         if (Parallel::isWorker() === false) {
             ServerManager::instance()->playwright()->start();
+
+            Screenshot::cleanup();
         }
     }
 

src/Support/Process.php

@@ -9,6 +9,8 @@
 
 /**
  * @internal
+ *
+ * @codeCoverageIgnore This class is used at plugin level to manage processes.
  */
 final class Process
 {

src/Support/Screenshot.php

@@ -4,30 +4,35 @@
 
 namespace Pest\Browser\Support;
 
-use SplFileObject;
+use Pest\TestSuite;
 
 /**
  * @internal
  */
 final class Screenshot
 {
-    private const string DEFAULT_DIR = '/tmp/pest-browser-screenshots';
-
     /**
-     * Return the path to the screenshots directory.
+     * Return the path to the screenshots' directory.
      */
     public static function dir(): string
     {
-        // @phpstan-ignore-next-line
-        return mb_rtrim((string) $_ENV['PEST_BROWSER_SCREENSHOT_DIR'] ?? self::DEFAULT_DIR, '/');
+        return TestSuite::getInstance()->rootPath
+            .'/tests/Browser/screenshots';
     }
 
     /**
      * Return the full path for a screenshot file.
      */
     public static function path(string $filename): string
     {
-        return self::dir().'/'.mb_ltrim($filename, '/').'.png';
+        $filename = self::dir().'/'.mb_ltrim($filename, '/');
+
+        // check if there is extension, if not, add .png
+        if (pathinfo($filename, PATHINFO_EXTENSION) === '') {
+            $filename .= '.png';
+        }
+
+        return $filename;
     }
 
     /**
@@ -43,11 +48,10 @@ public static function save(string $binary, ?string $filename = null): void
         }
 
         if (is_dir(self::dir()) === false) {
-            mkdir(self::dir(), 0775, true);
+            mkdir(self::dir(), 0755, true);
         }
 
-        $file = new SplFileObject(self::path($filename), 'wb');
-        $file->fwrite($decodedBinary);
+        file_put_contents(self::path($filename), $decodedBinary);
     }
 
     /**

tests/Browser/Playwright/Page/ScreenshotTest.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+use Pest\Browser\Support\Screenshot;
+
+describe('screenshot', function (): void {
+    it('deletes the screenshots directory', function (): void {
+        $screenshotDir = Screenshot::dir();
+
+        expect(is_dir($screenshotDir))->toBeFalse();
+    });
+
+    it('may screen a page', function (): void {
+        $page = $this->page('/test/frame-tests');
+
+        $page->screenshot('screenshot.png');
+
+        expect(file_exists(
+            Screenshot::path('screenshot.png')
+        ))->toBeTrue();
+    });
+});

tests/Pest.php

@@ -5,26 +5,6 @@
 use Pest\Browser\Playwright\Element;
 use Pest\Browser\Playwright\Locator;
 use Pest\Expectation;
-use Pest\TestSuite;
-
-pest()
-    ->beforeEach(fn () => cleanupScreenshots())
-    ->afterEach(fn () => cleanupScreenshots());
-
-function cleanupScreenshots(): void
-{
-    $basePath = TestSuite::getInstance()->testPath.'/Browser/screenshots';
-
-    foreach (glob("$basePath/*") as $file) {
-        if (is_file($file)) {
-            unlink($file);
-        }
-    }
-
-    if (file_exists($basePath)) {
-        rmdir($basePath);
-    }
-}
 
 // todo: move this to Pest core
 expect()->extend('toBeChecked', function (): Expectation {