Support for regular expression matching with the matches: operator.

.github/workflows/release.yaml

@@ -102,6 +102,12 @@ jobs:
         run: "choco install --yes --no-progress haskell-stack"
       - name: Install Haskell
         run: "stack --no-terminal setup"
+      - name: Update MSYS2
+        run: "stack --no-terminal exec -- pacman --noconfirm -Syuu"
+      - name: Install pkgconfig
+        run: "stack --no-terminal exec -- pacman --noconfirm -S mingw-w64-x86_64-pkg-config"
+      - name: Install ICU
+        run: "stack --no-terminal exec -- pacman --noconfirm -S mingw-w64-x86_64-icu"
       - name: Build for release
         run: 'stack --no-terminal install --local-bin-path=.\out\build\release'
       - id: asset

.github/workflows/verify.yaml

@@ -113,12 +113,18 @@ jobs:
         run: "choco install --yes --no-progress haskell-stack"
       - name: Install Haskell
         run: "stack --no-terminal setup"
+      - name: Update MSYS2
+        run: "stack --no-terminal exec -- pacman --noconfirm -Syuu"
+      - name: Install pkgconfig
+        run: "stack --no-terminal exec -- pacman --noconfirm -S mingw-w64-x86_64-pkg-config"
+      - name: Install ICU
+        run: "stack --no-terminal exec -- pacman --noconfirm -S mingw-w64-x86_64-icu"
       - name: Build
         run: 'stack --no-terminal install --fast --test --no-run-tests --local-bin-path=.\out\build\debug'
       - name: Test
         run: "stack --no-terminal test"
       - name: Spec
-        run: '.\out\build\debug\smoke.exe --command=.\out\build\debug\smoke.exe spec'
+        run: 'stack --no-terminal exec -- .\out\build\debug\smoke.exe --command=.\out\build\debug\smoke.exe spec'
 
   lint:
     name: Lint

README.md

@@ -120,6 +120,8 @@ tests:
         -2
 ```
 
+### Matchers
+
 We don't always want to check the full output; sometimes checking that it contains a given substring is more useful. We can use the `contains:` operator to specify this:
 
 ```yaml
@@ -134,6 +136,34 @@ tests:
 
 Note that we don't use `|` here, as we don't want to capture the trailing newline, which would make this test fail. Instead we use quotes around the value to ensure that the YAML parser treats it as a string, not a number.
 
+Or we can use a regular expression with the `matches:` operator:
+
+```yaml
+tests:
+  - name: lorem ipsum
+    stdout:
+      matches: |-
+        ^Lorem ipsum .* dolore magna aliqua\.$
+```
+
+Here we're using `|-` to similar effect; the `-` means "don't add a trailing newline". Unlike quotes, it doesn't interpret escape sequences (such as `\n`), so we can use `\` without trouble.
+
+You may want to provide options to the regular expression. The currently-supported options are `case-insensitive` (`i`), `comments` (`x`), and `dot-all` (`s`). You can add them as follows:
+
+```yaml
+tests:
+  - name: lorem ipsum
+    stdout:
+      matches:
+        regex: |-
+          Lorem ipsum .* fugiat nulla pariatur\.
+        options:
+          - case-insensitive
+          - dot-all
+```
+
+The variant of regular expressions supported is from the ICU library; see [the ICU documentation on Regular Expressions](https://unicode-org.github.io/icu/userguide/strings/regexp.html) for syntax and functionality, including how the options work.
+
 You can also use `equals:` to explicitly specify that we're checking equality, though this is the default.
 
 We can use files to specify the STDIN, STDOUT or STDERR values:

fixtures/bottles/smoke.yaml

@@ -75,3 +75,21 @@ tests:
       contents:
         contains: |
           9 bottles of beer on the wall, 9 bottles of beer.
+
+  - name: "10-matches"
+    args:
+      - "10"
+    stdout:
+      matches: 5 bottles .* 5 bottles
+
+  - name: "10000-matches"
+    args:
+      - "10000"
+    stdout:
+      matches: 6543 bottles .* 6543 bottles
+
+  - name: "10-does-not-match-multiple-lines"
+    args:
+      - "10"
+    stdout:
+      matches: 4 bottles .* 2 bottles

fixtures/encrypter/io/lorem-ipsum.in

@@ -0,0 +1,4 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

fixtures/encrypter/regex.yaml

@@ -0,0 +1,66 @@
+command:
+  - ruby
+  - fixtures/encrypter.rb
+
+tests:
+  - name: simple
+    stdin:
+      file: io/lorem-ipsum.in
+    stdout:
+      matches: |-
+        dhvf abfgehq rkrepvgngvba hyynzpb ynobevf
+
+  - name: case-sensitive
+    stdin:
+      file: io/lorem-ipsum.in
+    stdout:
+      matches: |-
+        yberz vcfhz
+
+  - name: case-insensitive
+    stdin:
+      file: io/lorem-ipsum.in
+    stdout:
+      matches:
+        regex: |-
+          yberz vcfhz
+        options:
+          - case-insensitive
+
+  - name: erroneous-comments
+    stdin:
+      file: io/lorem-ipsum.in
+    stdout:
+      matches:
+        regex: |
+          Yberz  # Lorem
+          \ vcfhz  # ipsum
+        options: []
+
+  - name: comments
+    stdin:
+      file: io/lorem-ipsum.in
+    stdout:
+      matches:
+        regex: |-
+          Yberz  # Lorem
+          \ vcfhz  # ipsum
+        options:
+          - comments
+
+  - name: dot-without-dot-all
+    stdin:
+      file: io/lorem-ipsum.in
+    stdout:
+      matches: |-
+        Yberz vcfhz qbybe fvg nzrg, .* fhag va phycn dhv bssvpvn qrfrehag zbyyvg navz vq rfg ynobehz\.
+
+  - name: dot-with-dot-all
+    stdin:
+      file: io/lorem-ipsum.in
+    stdout:
+      matches:
+        regex: |-
+          Yberz vcfhz qbybe fvg nzrg, .* fhag va phycn dhv bssvpvn qrfrehag zbyyvg navz vq rfg ynobehz\.
+        options:
+          - dot-all

nix/libs.nix

@@ -8,6 +8,7 @@ let
 in
 [
   gmp6
+  pkgs.icu
   libiconv
   openssl
   zlib

package.yaml

@@ -31,6 +31,7 @@ dependencies:
   - tar
   - temporary
   - text
+  - text-icu
   - transformers
   - vector
   - yaml

spec/bless.yaml

@@ -1,11 +1,21 @@
 tests:
-  - name: encrypter
+  - name: encrypter-simple
     args:
       - --bless
-      - fixtures/encrypter
+      - fixtures/encrypter/simple.yaml
     exit-status: 0
     stdout:
-      file: io/encrypter-bless-success.out
+      file: io/encrypter-simple-bless-success.out
+    revert:
+      - ../fixtures/encrypter
+
+  - name: encrypter-regex
+    args:
+      - --bless
+      - fixtures/encrypter/regex.yaml
+    exit-status: 1
+    stdout:
+      file: io/encrypter-regex-bless-failure.out
     revert:
       - ../fixtures/encrypter
 

spec/io/bottles-bless-failure.out

@@ -35,5 +35,34 @@ broken
     Go to the store and buy some more, 10 bottles of beer on the wall.
 10-contents-contains
   succeeded
+10-matches
+  succeeded
+10000-matches
+  succeeded
+10-does-not-match-multiple-lines
+  The fixture "stdout" is matching a pattern, so the result cannot be blessed.
+  Actual value:
+    10 bottles of beer on the wall, 10 bottles of beer.
+    Take one down and pass it around, 9 bottles of beer on the wall.
+    9 bottles of beer on the wall, 9 bottles of beer.
+    Take one down and pass it around, 8 bottles of beer on the wall.
+    8 bottles of beer on the wall, 8 bottles of beer.
+    Take one down and pass it around, 7 bottles of beer on the wall.
+    7 bottles of beer on the wall, 7 bottles of beer.
+    Take one down and pass it around, 6 bottles of beer on the wall.
+    6 bottles of beer on the wall, 6 bottles of beer.
+    Take one down and pass it around, 5 bottles of beer on the wall.
+    5 bottles of beer on the wall, 5 bottles of beer.
+    Take one down and pass it around, 4 bottles of beer on the wall.
+    4 bottles of beer on the wall, 4 bottles of beer.
+    Take one down and pass it around, 3 bottles of beer on the wall.
+    3 bottles of beer on the wall, 3 bottles of beer.
+    Take one down and pass it around, 2 bottles of beer on the wall.
+    2 bottles of beer on the wall, 2 bottles of beer.
+    Take one down and pass it around, 1 bottle of beer on the wall.
+    1 bottle of beer on the wall, 1 bottle of beer.
+    Take one down and pass it around, no more bottles of beer on the wall.
+    No more bottles of beer on the wall, no more bottles of beer.
+    Go to the store and buy some more, 10 bottles of beer on the wall.
 
-7 tests, 1 failure
+10 tests, 2 failures

spec/io/encrypter-regex-bless-failure.out

@@ -0,0 +1,31 @@
+simple
+  succeeded
+case-sensitive
+  The fixture "stdout" is matching a pattern, so the result cannot be blessed.
+  Actual value:
+    Yberz vcfhz qbybe fvg nzrg, pbafrpgrghe nqvcvfpvat ryvg, frq qb rvhfzbq grzcbe vapvqvqhag hg ynober rg qbyber zntan nyvdhn.
+    Hg ravz nq zvavz iravnz, dhvf abfgehq rkrepvgngvba hyynzpb ynobevf avfv hg nyvdhvc rk rn pbzzbqb pbafrdhng.
+    Qhvf nhgr veher qbybe va erceruraqrevg va ibyhcgngr iryvg rffr pvyyhz qbyber rh shtvng ahyyn cnevnghe.
+    Rkprcgrhe fvag bppnrpng phcvqngng aba cebvqrag, fhag va phycn dhv bssvpvn qrfrehag zbyyvg navz vq rfg ynobehz.
+case-insensitive
+  succeeded
+erroneous-comments
+  The fixture "stdout" is matching a pattern, so the result cannot be blessed.
+  Actual value:
+    Yberz vcfhz qbybe fvg nzrg, pbafrpgrghe nqvcvfpvat ryvg, frq qb rvhfzbq grzcbe vapvqvqhag hg ynober rg qbyber zntan nyvdhn.
+    Hg ravz nq zvavz iravnz, dhvf abfgehq rkrepvgngvba hyynzpb ynobevf avfv hg nyvdhvc rk rn pbzzbqb pbafrdhng.
+    Qhvf nhgr veher qbybe va erceruraqrevg va ibyhcgngr iryvg rffr pvyyhz qbyber rh shtvng ahyyn cnevnghe.
+    Rkprcgrhe fvag bppnrpng phcvqngng aba cebvqrag, fhag va phycn dhv bssvpvn qrfrehag zbyyvg navz vq rfg ynobehz.
+comments
+  succeeded
+dot-without-dot-all
+  The fixture "stdout" is matching a pattern, so the result cannot be blessed.
+  Actual value:
+    Yberz vcfhz qbybe fvg nzrg, pbafrpgrghe nqvcvfpvat ryvg, frq qb rvhfzbq grzcbe vapvqvqhag hg ynober rg qbyber zntan nyvdhn.
+    Hg ravz nq zvavz iravnz, dhvf abfgehq rkrepvgngvba hyynzpb ynobevf avfv hg nyvdhvc rk rn pbzzbqb pbafrdhng.
+    Qhvf nhgr veher qbybe va erceruraqrevg va ibyhcgngr iryvg rffr pvyyhz qbyber rh shtvng ahyyn cnevnghe.
+    Rkprcgrhe fvag bppnrpng phcvqngng aba cebvqrag, fhag va phycn dhv bssvpvn qrfrehag zbyyvg navz vq rfg ynobehz.
+dot-with-dot-all
+  succeeded
+
+7 tests, 3 failures

spec/io/encrypter.out

@@ -1,9 +1,54 @@
-word
+regex/simple
+  succeeded
+regex/case-sensitive
+  stdin:  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+          Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+          Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+          Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+  stdout:
+    expected to match:
+            yberz vcfhz
+    actual: Yberz vcfhz qbybe fvg nzrg, pbafrpgrghe nqvcvfpvat ryvg, frq qb rvhfzbq grzcbe vapvqvqhag hg ynober rg qbyber zntan nyvdhn.
+            Hg ravz nq zvavz iravnz, dhvf abfgehq rkrepvgngvba hyynzpb ynobevf avfv hg nyvdhvc rk rn pbzzbqb pbafrdhng.
+            Qhvf nhgr veher qbybe va erceruraqrevg va ibyhcgngr iryvg rffr pvyyhz qbyber rh shtvng ahyyn cnevnghe.
+            Rkprcgrhe fvag bppnrpng phcvqngng aba cebvqrag, fhag va phycn dhv bssvpvn qrfrehag zbyyvg navz vq rfg ynobehz.
+regex/case-insensitive
+  succeeded
+regex/erroneous-comments
+  stdin:  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+          Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+          Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+          Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+  stdout:
+    expected to match:
+            Yberz  # Lorem
+            \ vcfhz  # ipsum
+    actual: Yberz vcfhz qbybe fvg nzrg, pbafrpgrghe nqvcvfpvat ryvg, frq qb rvhfzbq grzcbe vapvqvqhag hg ynober rg qbyber zntan nyvdhn.
+            Hg ravz nq zvavz iravnz, dhvf abfgehq rkrepvgngvba hyynzpb ynobevf avfv hg nyvdhvc rk rn pbzzbqb pbafrdhng.
+            Qhvf nhgr veher qbybe va erceruraqrevg va ibyhcgngr iryvg rffr pvyyhz qbyber rh shtvng ahyyn cnevnghe.
+            Rkprcgrhe fvag bppnrpng phcvqngng aba cebvqrag, fhag va phycn dhv bssvpvn qrfrehag zbyyvg navz vq rfg ynobehz.
+regex/comments
+  succeeded
+regex/dot-without-dot-all
+  stdin:  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+          Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+          Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+          Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+  stdout:
+    expected to match:
+            Yberz vcfhz qbybe fvg nzrg, .* fhag va phycn dhv bssvpvn qrfrehag zbyyvg navz vq rfg ynobehz\.
+    actual: Yberz vcfhz qbybe fvg nzrg, pbafrpgrghe nqvcvfpvat ryvg, frq qb rvhfzbq grzcbe vapvqvqhag hg ynober rg qbyber zntan nyvdhn.
+            Hg ravz nq zvavz iravnz, dhvf abfgehq rkrepvgngvba hyynzpb ynobevf avfv hg nyvdhvc rk rn pbzzbqb pbafrdhng.
+            Qhvf nhgr veher qbybe va erceruraqrevg va ibyhcgngr iryvg rffr pvyyhz qbyber rh shtvng ahyyn cnevnghe.
+            Rkprcgrhe fvag bppnrpng phcvqngng aba cebvqrag, fhag va phycn dhv bssvpvn qrfrehag zbyyvg navz vq rfg ynobehz.
+regex/dot-with-dot-all
+  succeeded
+simple/word
   stdin:  word
   stdout: @@ -1 +1 @@
           -xpse
           +jbeq
-lines
+simple/lines
   stdin:  one
           two
           three
@@ -17,10 +62,10 @@ lines
           +gjb
           +guerr
           +sbhe
-color
+simple/color
   stdin:  this is a green word
   stdout: @@ -1 +1 @@
           -uijt jt b hsffo xpse
           +guvf vf n terra jbeq
 
-3 tests, 3 failures
+10 tests, 6 failures

spec/io/long-output.out

@@ -136,5 +136,36 @@ broken
             Go to the store and buy some more, 10 bottles of beer on the wall.
 10-contents-contains
   succeeded
+10-matches
+  succeeded
+10000-matches
+  succeeded
+10-does-not-match-multiple-lines
+  args:   10
+  stdout:
+    expected to match:
+            4 bottles .* 2 bottles
+    actual: 10 bottles of beer on the wall, 10 bottles of beer.
+            Take one down and pass it around, 9 bottles of beer on the wall.
+            9 bottles of beer on the wall, 9 bottles of beer.
+            Take one down and pass it around, 8 bottles of beer on the wall.
+            8 bottles of beer on the wall, 8 bottles of beer.
+            Take one down and pass it around, 7 bottles of beer on the wall.
+            7 bottles of beer on the wall, 7 bottles of beer.
+            Take one down and pass it around, 6 bottles of beer on the wall.
+            6 bottles of beer on the wall, 6 bottles of beer.
+            Take one down and pass it around, 5 bottles of beer on the wall.
+            5 bottles of beer on the wall, 5 bottles of beer.
+            Take one down and pass it around, 4 bottles of beer on the wall.
+            4 bottles of beer on the wall, 4 bottles of beer.
+            Take one down and pass it around, 3 bottles of beer on the wall.
+            3 bottles of beer on the wall, 3 bottles of beer.
+            Take one down and pass it around, 2 bottles of beer on the wall.
+            2 bottles of beer on the wall, 2 bottles of beer.
+            Take one down and pass it around, 1 bottle of beer on the wall.
+            1 bottle of beer on the wall, 1 bottle of beer.
+            Take one down and pass it around, no more bottles of beer on the wall.
+            No more bottles of beer on the wall, no more bottles of beer.
+            Go to the store and buy some more, 10 bottles of beer on the wall.
 
-7 tests, 2 failures
+10 tests, 3 failures