Updated code formatting and tests.

drevops · Jan 17, 2025 · 64d929a · 64d929a
1 parent b9a77c8
commit 64d929a
Show file tree

Hide file tree

Showing 13 changed files with 409 additions and 521 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -60,7 +60,7 @@ jobs:
         continue-on-error: ${{ vars.CI_LINT_IGNORE_FAILURE == '1' }}
 
       - name: Run unit tests
-        run: composer test-unit
+        run: composer test-coverage
         continue-on-error: ${{ vars.CI_TEST_UNIT_IGNORE_FAILURE == '1' }}
 
       - name: Run BDD tests

diff --git a/README.md b/README.md
@@ -98,7 +98,7 @@ You may optionally specify size of browser window in the screenshot step:
 | Name                    | Default value                                                        | Description                                                                                                 |
 |-------------------------|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
 | `dir`                   | `%paths.base%/screenshots`                                           | Path to directory to save screenshots. Directory structure will be created if the directory does not exist. |
-| `fail`                  | `true`                                                               | Capture screenshots for failed tests.                                                                       |
+| `fail`                  | `true`                                                               | Capture screenshot on test failure.                                                                         |
 | `fail_prefix`           | `failed_`                                                            | Prefix failed screenshots with `fail_` string. Useful to distinguish failed and intended screenshots.       |
 | `purge`                 | `false`                                                              | Remove all files from the screenshots directory on each test run. Useful during debugging of tests.         |
 | `filenamePattern`       | `{datetime:u}.{feature_file}.feature_{step_line}.{ext}`              | File name pattern for successful assertions.                                                                |

diff --git a/composer.json b/composer.json
@@ -67,7 +67,8 @@
             "phpcbf"
         ],
         "reset": "rm -Rf vendor vendor-bin composer.lock",
+        "test": "phpunit --no-coverage",
         "test-bdd": "behat --colors",
-        "test-unit": "phpunit"
+        "test-coverage": "phpunit"
     }
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -21,7 +21,9 @@ parameters:
       # it is not possible to specify the type of the parameter, so we ignore
       # this error.
       message: '#.*no value type specified in iterable type array.#'
-      path: tests/phpunit/*
+      paths:
+        - tests/phpunit/*
+        - src/DrevOps/BehatScreenshotExtension/Tokenizer.php
       reportUnmatched: false
     -
       message: '#.*#'

diff --git a/src/DrevOps/BehatScreenshotExtension/Context/Initializer/ScreenshotContextInitializer.php b/src/DrevOps/BehatScreenshotExtension/Context/Initializer/ScreenshotContextInitializer.php
@@ -15,13 +15,18 @@
  */
 class ScreenshotContextInitializer implements ContextInitializer {
 
+  /**
+   * Flag to purge files in the directory.
+   */
+  protected bool $needsPurging = TRUE;
+
   /**
    * ScreenshotContextInitializer constructor.
    *
    * @param string $dir
    *   Screenshot dir.
    * @param bool $fail
-   *   Screenshot when fail.
+   *   Create screenshot on test failure.
    * @param string $failPrefix
    *   File name prefix for a failed test.
    * @param bool $purge
@@ -31,13 +36,19 @@ class ScreenshotContextInitializer implements ContextInitializer {
    * @param string $filenamePatternFailed
    *   File name pattern failed.
    * @param bool $showPath
-   *   Show current path in screenshots.
-   * @param bool $needsPurging
-   *   Check if need to actually purge.
+   *   Show current URL in screenshots.
    *
    * @codeCoverageIgnore
    */
-  public function __construct(protected string $dir, protected bool $fail, private readonly string $failPrefix, protected bool $purge, protected string $filenamePattern, protected string $filenamePatternFailed, protected bool $showPath = FALSE, protected bool $needsPurging = TRUE) {
+  public function __construct(
+    protected string $dir,
+    protected bool $fail,
+    private readonly string $failPrefix,
+    protected bool $purge,
+    protected string $filenamePattern,
+    protected string $filenamePatternFailed,
+    protected bool $showPath = FALSE,
+  ) {
   }
 
   /**
@@ -46,11 +57,20 @@ public function __construct(protected string $dir, protected bool $fail, private
   public function initializeContext(Context $context): void {
     if ($context instanceof ScreenshotAwareContextInterface) {
       $dir = $this->resolveScreenshotDir();
-      $context->setScreenshotParameters($dir, $this->fail, $this->failPrefix, $this->filenamePattern, $this->filenamePatternFailed, $this->showPath);
+
       if ($this->shouldPurge() && $this->needsPurging) {
         $this->purgeFilesInDir($dir);
         $this->needsPurging = FALSE;
       }
+
+      $context->setScreenshotParameters(
+        $dir,
+        $this->fail,
+        $this->failPrefix,
+        $this->filenamePattern,
+        $this->filenamePatternFailed,
+        $this->showPath
+      );
     }
   }