Configure screenshot name pattern in behat.yml about behat-screenshot HOT 6 CLOSED

And don't miss the existing WIP in #53 :)

You're welcome to squash commits on that branch to base your work on. When doing so please retain commit credit for existing progress 😄

It's fine to start over too! Thanks for picking this up 😁

from behat-screenshot.

@xurizaemon
I liked your suggestion and was thinking about supporting this. But I do not have the bandwidth to support this. A PR is always welcomed!

Please note that there is a purge option available to purge all screenshots after every run.

The timestamp prefix was added to order screenshots by creation time.

from behat-screenshot.

@xurizaemon I work with @tannguyen04 on this and the priority for this issue has changed a bit. We will be addressing this in a week or two.

from behat-screenshot.

Here is a suggested spec for providing configurable file names for screenshots.

Token format

{name[_qualifier[:format]}, where

• { and } denote the start and end of a token
• name is the name of the token
• qualifier is an optional qualifier for the token. Must be separated from the name by an underscore.
• format is an optional format for the token. Must be separated from the qualifier by a colon.

The reasoning behind using {} as delimiters instead of @ is to make it easier to identify the token end delimiter in
the string.

Supported tokens

Using http://example.com/mypath/subpath?myquery=1+2+3&another[]=4#somefragment in URL examples.

Based on the above, the current format can be expressed as:

{datetime:u}.{fail_prefix}{feature_file}.feature_{step_line}.{ext}

resulting in filenames like:

1697490961192498.login.feature_14.png - success

1697490961192498.failed_login.feature_14.png - failed

Config changes

extensions:
    DrevOps\BehatScreenshotExtension:
      dir: %paths.base%/screenshots
      fail: true
      purge: false
      # New config option.
      filenamePattern: {datetime:u}.{fail_prefix}{feature_file}.feature_{step_line}.{ext}

Success vs failed patterns

Although adding an ability to provide different file name patterns for successful and failed screenshots is not a part of this issue, it is worth specifying how it would look like in config:

extensions:
    DrevOps\BehatScreenshotExtension:
      dir: %paths.base%/screenshots
      fail: true
      purge: false
      # New config option.
      filenamePattern: {datetime:u}.{feature_file}.feature_{step_line}.{ext}
      filenamePatternFailed: {datetime:u}.{fail_prefix}{feature_file}.feature_{step_line}.{ext}      

from behat-screenshot.

@tannguyen04
When working on this, please note that this implementation should work well with #28.

from behat-screenshot.

@tannguyen04 came across the config for this in a repo today and wondered how it had progressed. Did you get anywhere? Can I help in any way?

from behat-screenshot.