fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-06-27 21:16:14 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update pytest-bdd to v8.0 (#1955)

Browse source 
* Encapsulate all multiline strings in triple-quotes in Gherkin files

Since pytest-bdd v8.0.0 uses the official Gherkin parser, multiline
strings must now be encapsulated by triple-quotes.

See:
- https://pytest-bdd.readthedocs.io/en/stable/#id2
- https://pytest-bdd.readthedocs.io/en/stable/#docstrings

* Remove comments in Gherkin files causing test breakage

These comments break the step matching.

* Fix compatibility of step-functions matching on multiple lines

In pytest-bdd v8.0.0 it is no longer possible to match based on multiple
lines, which breaks essentially all steps that support docstrings. Solve
this by adding a wrapper-function for each of these instances, that
matches the docstring step, and calls the original function.

So, what used to be:

    @then(parse("the output should match\n{regex}"))
    @then(parse('the output should match "{regex}"'))
    def output_should_match(regex, cli_run):
        ...

Is now:

    @then(parse("the output should match"))
    def output_should_match_docstring(cli_run, docstring):
        output_should_match(docstring, cli_run)

    @then(parse('the output should match "{regex}"'))
    def output_should_match(regex, cli_run):
        ...

There is possibly a way around this that is much better than what I've
done here, but this is a start at least.

* Update version requirement of pytest-bdd to >=8.0

* Update tox config to match poetry config

---------

Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com>
This commit is contained in:
Carl Smedstad 2025-02-25 05:16:54 +01:00 • committed by GitHub
parent 505a9b6846
commit 1530ad39a1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
23 changed files with 451 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

24
tests/bdd/features/multiple_journals.feature
View file

@ -7,8 +7,10 @@ Feature: Multiple journals
Given we use the config "multiple.yaml"
When we run "jrnl -99 --short"
Then the output should be
"""
2013-06-09 15:39 My first entry.
2013-06-10 15:40 Life is good.
"""
When we run "jrnl work -99 --short"
Then the output should be empty
@ -17,10 +19,14 @@ Feature: Multiple journals
When we run "jrnl this goes to default"
When we run "jrnl -99 --short"
Then the output should contain
"""
2013-06-09 15:39 My first entry.
2013-06-10 15:40 Life is good.
"""
Then the output should contain
"""
this goes to default
"""
When we run "jrnl work -99 --short"
Then the output should be empty
@ -29,8 +35,10 @@ Feature: Multiple journals
When we run "jrnl work a long day in the office"
When we run "jrnl -99 --short"
Then the output should be
"""
2013-06-09 15:39 My first entry.
2013-06-10 15:40 Life is good.
"""
When we run "jrnl work -99 --short"
Then the output should contain "a long day in the office"
@ -44,32 +52,44 @@ Feature: Multiple journals
When we run "jrnl work 23 july 2012: a long day in the office"
When we run "jrnl -99 --short"
Then the output should be
"""
2013-06-09 15:39 My first entry.
2013-06-10 15:40 Life is good.
"""
When we run "jrnl work -99 --short"
Then the output should be
"""
2012-07-23 09:00 a long day in the office
"""
Scenario: Write to specified journal without a timestamp but with colon
Given we use the config "multiple.yaml"
When we run "jrnl work : a long day in the office"
Then the output should be
"""
2013-06-09 15:39 My first entry.
2013-06-10 15:40 Life is good.
"""
When we run "jrnl work -99 --short"
Then the output should be contain
"""
a long day in the office
"""
Scenario: Write to specified journal without a timestamp but with colon
Given we use the config "multiple.yaml"
When we run "jrnl work: a long day in the office"
When we run "jrnl -99 --short"
Then the output should be
"""
2013-06-09 15:39 My first entry.
2013-06-10 15:40 Life is good.
"""
When we run "jrnl work -99 --short"
Then the output should contain
"""
a long day in the office
"""
Scenario: Create new journals as required
Given we use the config "multiple.yaml"
@ -77,7 +97,9 @@ Feature: Multiple journals
When we run "jrnl ideas 23 july 2012: sell my junk on ebay and make lots of money"
When we run "jrnl ideas -99 --short"
Then the output should be
"""
2012-07-23 09:00 sell my junk on ebay and make lots of money
"""
Scenario: Don't crash if no default journal is specified
Given we use the config "no_default_journal.yaml"
@ -87,9 +109,11 @@ Feature: Multiple journals
Scenario: Don't crash if no file exists for a configured encrypted journal
Given we use the config "multiple.yaml"
When we run "jrnl new_encrypted Adding first entry" and enter
"""
these three eyes
these three eyes
n
"""
Then the output should contain "Journal 'new_encrypted' created at"
Scenario: Read and write to journal with emoji name