Cover basic and colored output regressions with unit tests (#302, #299)

Additionally: - use deterministic order of possible matches in `AmbiguousMatchError` - reduce count of cursor moves in `writer::out::WriteStrExt::clear_last_lines()` - unify code style of lines accessing `writer::Basic` Co-authored-by: 50U10FCA7 <[email protected]>
cucumber-rs · Oct 16, 2023 · 169fcff · 169fcff
1 parent f4ff0db
commit 169fcff
Show file tree

Hide file tree

Showing 84 changed files with 714 additions and 244 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,11 +14,12 @@ All user visible changes to `cucumber` crate will be documented in this file. Th
 ### Fixed
 
 - Incorrect terminal width detection when its height is low. ([#298])
-- Incorrect terminal lines clearing in interactive mode. ([#300], [#299])
+- Incorrect terminal lines clearing in interactive mode. ([#300], [#302], [#299])
 
 [#298]: /../../pull/298
 [#299]: /../../issues/299
 [#300]: /../../pull/300
+[#302]: /../../pull/302
 
 
 

diff --git a/src/step.rs b/src/step.rs
@@ -24,6 +24,7 @@ use std::{
 use derive_more::{Deref, DerefMut, Display, Error};
 use futures::future::LocalBoxFuture;
 use gherkin::StepType;
+use itertools::Itertools as _;
 use regex::Regex;
 
 /// Alias for a [`gherkin::Step`] function that returns a [`LocalBoxFuture`].
@@ -199,6 +200,7 @@ impl<World> Collection<World> {
                         possible_matches: captures
                             .into_iter()
                             .map(|(re, loc, ..)| (re.clone(), *loc))
+                            .sorted()
                             .collect(),
                     })
                 }

diff --git a/src/writer/basic.rs b/src/writer/basic.rs
@@ -548,7 +548,7 @@ impl<Out: io::Write> Basic<Out> {
                 indent = " ".repeat(self.indent),
             );
             self.lines_to_clear += self.styles.lines_count(&out);
-            self.write_line(&out)?;
+            self.output.write_line(&out)?;
         }
         Ok(())
     }
@@ -734,7 +734,8 @@ impl<Out: io::Write> Basic<Out> {
                 .unwrap_or_default(),
         ));
 
-        self.write_line(&format!("{step_keyword}{step_value}{diagnostics}"))
+        self.output
+            .write_line(&format!("{step_keyword}{step_value}{diagnostics}"))
     }
 
     /// Outputs the [`Background`] [`Step`]'s
@@ -823,7 +824,7 @@ impl<Out: io::Write> Basic<Out> {
                 indent = " ".repeat(self.indent.saturating_sub(2)),
             );
             self.lines_to_clear += self.styles.lines_count(&out);
-            self.write_line(&out)?;
+            self.output.write_line(&out)?;
         }
         Ok(())
     }
@@ -1011,7 +1012,8 @@ impl<Out: io::Write> Basic<Out> {
                 .unwrap_or_default(),
         ));
 
-        self.write_line(&format!("{step_keyword}{step_value}{diagnostics}"))
+        self.output
+            .write_line(&format!("{step_keyword}{step_value}{diagnostics}"))
     }
 }
 

diff --git a/src/writer/out.rs b/src/writer/out.rs
@@ -250,16 +250,18 @@ pub trait WriteStrExt: io::Write {
 
     /// Writes a special sequence into this writer clearing the last `n` lines.
     ///
+    /// __NOTE:__ This method doesn't clear the current line, only the `n` lines
+    ///           above it.
+    ///
     /// # Errors
     ///
     /// If this writer fails to write a special sequence.
     fn clear_last_lines(&mut self, n: usize) -> io::Result<()> {
-        self.move_cursor_up(n)?;
         for _ in 0..n {
+            self.move_cursor_up(1)?;
             self.clear_line()?;
-            self.move_cursor_down(1)?;
         }
-        self.move_cursor_up(n)
+        Ok(())
     }
 
     /// Writes a special sequence into this writer clearing the last line.

diff --git a/tests/features/output/.feature.basic.out b/tests/features/output/.feature.basic.out
@@ -0,0 +1,5 @@
+Feature: output
+  Scenario: output
+   ✔  Given foo is 0
+   ✔  When foo is 1
+   ✔  Then foo is 2
diff --git a/tests/features/output/.feature.colored.out b/tests/features/output/.feature.colored.out
@@ -0,0 +1,8 @@
+[32mFeature: output[0m
+[32m  Scenario: output[0m
+      Given foo is 0
+[1A[2K[32m   [32m✔  Given [0m[32mfoo is [0m[32m[1m0[0m[0m[32m[0m[32m[0m[32m[0m[0m
+      When foo is 1
+[1A[2K[32m   [32m✔  When [0m[32mfoo is [0m[32m[1m1[0m[0m[32m[0m[32m[0m[32m[0m[0m
+      Then foo is 2
+[1A[2K[32m   [32m✔  Then [0m[32mfoo is [0m[32m[1m2[0m[0m[32m[0m[32m[0m[32m[0m[0m

diff --git a/tests/features/output/.feature.out → tests/features/output/.feature.debug.out b/tests/features/output/.feature.out → tests/features/output/.feature.debug.out
diff --git a/tests/features/output/ambiguous_step.feature.basic.out b/tests/features/output/ambiguous_step.feature.basic.out
@@ -0,0 +1,8 @@
+Feature: ambiguous
+  Scenario: ambiguous
+   ✘  Given foo is 0 ambiguous
+      Step failed:
+      Defined: tests/features/output/ambiguous_step.feature:3:5
+      Step match is ambiguous: Possible matches:
+      foo is (\d+) --> tests/output.rs:12:1
+      foo is (\d+) ambiguous --> tests/output.rs:20:1
diff --git a/tests/features/output/ambiguous_step.feature.colored.out b/tests/features/output/ambiguous_step.feature.colored.out
@@ -0,0 +1,9 @@
+[32mFeature: ambiguous[0m
+[32m  Scenario: ambiguous[0m
+      Given foo is 0 ambiguous
+[1A[2K[31m   ✘  Given [0m[31mfoo is 0 ambiguous[0m[31m
+      Step failed:
+      Defined: tests/features/output/ambiguous_step.feature:3:5
+      Step match is ambiguous: Possible matches:
+      foo is (\d+) --> tests/output.rs:12:1
+      foo is (\d+) ambiguous --> tests/output.rs:20:1[0m

diff --git a/...eatures/output/ambiguous_step.feature.out → ...s/output/ambiguous_step.feature.debug.out b/...eatures/output/ambiguous_step.feature.out → ...s/output/ambiguous_step.feature.debug.out
@@ -3,7 +3,7 @@ Started
 Feature(Feature { keyword: "Feature", name: "ambiguous", description: None, background: None, scenarios: [Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }], rules: [], tags: [], position: LineCol { line: 1 }, }, Started)
 Feature(Feature { keyword: "Feature", name: "ambiguous", description: None, background: None, scenarios: [Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }], rules: [], tags: [], position: LineCol { line: 1 }, }, Scenario(Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }, RetryableScenario { event: Started, retries: None }))
 Feature(Feature { keyword: "Feature", name: "ambiguous", description: None, background: None, scenarios: [Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }], rules: [], tags: [], position: LineCol { line: 1 }, }, Scenario(Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }, RetryableScenario { event: Step(Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }, Started), retries: None }))
-Feature(Feature { keyword: "Feature", name: "ambiguous", description: None, background: None, scenarios: [Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }], rules: [], tags: [], position: LineCol { line: 1 }, }, Scenario(Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }, RetryableScenario { event: Step(Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }, Failed(None, None, None, AmbiguousMatch(AmbiguousMatchError { possible_matches: [(HashableRegex(Regex("foo is (\\d+)")), Some(Location { line: 13, column: 1 })), (HashableRegex(Regex("foo is (\\d+) ambiguous")), Some(Location { line: 21, column: 1 }))] }))), retries: None }))
+Feature(Feature { keyword: "Feature", name: "ambiguous", description: None, background: None, scenarios: [Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }], rules: [], tags: [], position: LineCol { line: 1 }, }, Scenario(Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }, RetryableScenario { event: Step(Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }, Failed(None, None, None, AmbiguousMatch(AmbiguousMatchError { possible_matches: [(HashableRegex(Regex("foo is (\\d+)")), Some(Location { line: 12, column: 1 })), (HashableRegex(Regex("foo is (\\d+) ambiguous")), Some(Location { line: 20, column: 1 }))] }))), retries: None }))
 Feature(Feature { keyword: "Feature", name: "ambiguous", description: None, background: None, scenarios: [Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }], rules: [], tags: [], position: LineCol { line: 1 }, }, Scenario(Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }, RetryableScenario { event: Finished, retries: None }))
 Feature(Feature { keyword: "Feature", name: "ambiguous", description: None, background: None, scenarios: [Scenario { keyword: "Scenario", name: "ambiguous", description: None, steps: [Step { keyword: "Given ", ty: Given, value: "foo is 0 ambiguous", docstring: None, table: None, position: LineCol { line: 3 } }], examples: [], tags: [], position: LineCol { line: 2 } }], rules: [], tags: [], position: LineCol { line: 1 }, }, Finished)
-Finished
+Finished
diff --git a/tests/features/output/background_rule.feature.basic.out b/tests/features/output/background_rule.feature.basic.out
@@ -0,0 +1,7 @@
+Feature: output
+Rule: output
+    Scenario: output
+     ✔> Given foo is 0
+     ✔  Given foo is 1
+     ✔  When foo is 2
+     ✔  Then foo is 3
diff --git a/tests/features/output/background_rule.feature.colored.out b/tests/features/output/background_rule.feature.colored.out
@@ -0,0 +1,11 @@
+[32mFeature: output[0m
+[32mRule: output[0m
+[32m    Scenario: output[0m
+      > Given foo is 0
+[1A[2K[32m[32m     ✔> Given [0m[32mfoo is [0m[32m[1m0[0m[0m[32m[0m[32m[0m[32m[0m[0m
+        Given foo is 1
+[1A[2K[32m     [32m✔  Given [0m[32mfoo is [0m[32m[1m1[0m[0m[32m[0m[32m[0m[32m[0m[0m
+        When foo is 2
+[1A[2K[32m     [32m✔  When [0m[32mfoo is [0m[32m[1m2[0m[0m[32m[0m[32m[0m[32m[0m[0m
+        Then foo is 3
+[1A[2K[32m     [32m✔  Then [0m[32mfoo is [0m[32m[1m3[0m[0m[32m[0m[32m[0m[32m[0m[0m