Remove --show-attempts-count and make it default

Author: kwk

llvm/docs/CommandGuide/lit.rst

@@ -144,34 +144,6 @@ OUTPUT OPTIONS
 
  Show expectedly failed tests.
 
-.. option:: --show-attempts-count
-
- Show the number of attempts needed for a test to pass. It also shows the
- maximum number of attempts that were allowed for this test. This option is
- useful when you want to understand how many attempts took for a flaky test
- (``FLAKYPASS``) to pass.
-
- This is how the test output looks like *without* :option:`--show-attempts-count`
-
- .. code-block:: none
-
-  PASS: your-test-suite :: your-first-test.py (1 of 3)
-  FLAKYPASS: your-test-suite :: your-second-test.py (2 of 2)
-
- This is the output *with* :option:`--show-attempts-count`
-
- .. code-block:: none
-
-  PASS: your-test-suite :: your-first-test.py (1 of 2)
-  FLAKYPASS: your-test-suite :: your-second-test.py (2 of 2) [attempts=3,max_allowed_attempts=4]
-
- In this case ``your-second-test.py`` was executed three times and it succeeded
- after the third time (``attempts=3``). Technically another run would have been
- possible (``max_allowed_attempts=4``).
-
- We will only append the extra information when a test was allowed more than one
- attempt to succeed (i.e. see :option:`--max-retries-per-test`).
-
 .. _execution-options:
 
 EXECUTION OPTIONS
@@ -716,6 +688,14 @@ newline.
 The ``<progress info>`` field can be used to report progress information such
 as (1/300) or can be empty, but even when empty the parentheses are required.
 
+Should a test be allowed retries (see ``ALLOW_RETRIES:`` annotation) and it
+needed more than one attempt to succeed, then ``<progess info>`` is extended
+by this information:
+
+.. code-block:: none
+
+  , <num_attempts_made> of <max_allowed_attempts> attempts
+
 Each test result may include additional (multiline) log information in the
 following format:
 

llvm/utils/lit/lit/cl_arguments.py

@@ -104,13 +104,6 @@ def parse_args():
         help="Do not use curses based progress bar",
         action="store_false",
     )
-    format_group.add_argument(
-        "--show-attempts-count",
-        dest="showAttemptsCount",
-        help="Show number of attempts and maximum attempts for tests"
-        " which are allowed to run more than once.",
-        action="store_true",
-    )
 
     # Note: this does not generate flags for user-defined result codes.
     success_codes = [c for c in lit.Test.ResultCode.all_codes() if not c.isFailure]

llvm/utils/lit/lit/display.py

@@ -119,23 +119,14 @@ def print_result(self, test):
         test_name = test.getFullName()
 
         extra_info = ""
-        extra_attrs = []
-
-        if self.opts.showAttemptsCount:
-            if (
-                test.result.max_allowed_attempts is not None
-                and test.result.max_allowed_attempts > 1
-            ):
-                extra_attrs.append(f"attempts={test.result.attempts}")
-                extra_attrs.append(
-                    f"max_allowed_attempts={test.result.max_allowed_attempts}"
-                )
-
-        if len(extra_attrs) > 0:
-            extra_info = " [" + ",".join(extra_attrs) + "]"
+        if (
+            test.result.max_allowed_attempts is not None
+            and test.result.max_allowed_attempts > 1
+        ) and test.result.attempts > 0:
+            extra_info = f", {test.result.attempts} of {test.result.max_allowed_attempts} attempts"
 
         print(
-            "%s: %s (%d of %d)%s"
+            "%s: %s (%d of %d%s)"
             % (
                 test.result.code.name,
                 test_name,

llvm/utils/lit/tests/allow-retries.py

@@ -22,7 +22,7 @@
 # RUN: not %{lit} %{inputs}/allow-retries/does-not-succeed-within-limit.py -v |\
 # RUN:   FileCheck --check-prefix=CHECK-TEST3 -match-full-lines %s
 #
-#       CHECK-TEST3: FAIL: allow-retries :: does-not-succeed-within-limit.py (1 of 1)
+#       CHECK-TEST3: FAIL: allow-retries :: does-not-succeed-within-limit.py (1 of 1, 4 of 4 attempts)
 #  CHECK-TEST3-NEXT: {{\**}} TEST 'allow-retries :: does-not-succeed-within-limit.py' FAILED {{\**}}
 #  CHECK-TEST3-NEXT: Exit Code: 1
 # CHECK-TEST3-EMPTY:
@@ -78,11 +78,10 @@
 # RUN: rm -f %t.counter
 # RUN: %{lit} %{inputs}/max-retries-per-test/no-allow-retries-no-test_retry_attempts/test.py \
 # RUN:   --max-retries-per-test=7 \
-# RUN:   --show-attempts-count \
 # RUN:   -Dcounter=%t.counter \
 # RUN:   -Dpython=%{python} \
 # RUN: | FileCheck --check-prefix=CHECK-TEST8 %s
-# CHECK-TEST8: FLAKYPASS: no-allow-retries-no-test_retry_attempts :: test.py (1 of 1) [attempts=4,max_allowed_attempts=8]
+# CHECK-TEST8: FLAKYPASS: no-allow-retries-no-test_retry_attempts :: test.py (1 of 1, 4 of 8 attempts)
 # CHECK-TEST8: Passed With Retry: 1
 
 # This test only passes on the 4th try. Here we check that a test can be re-run when:
@@ -92,11 +91,10 @@
 # RUN: rm -f %t.counter
 # RUN: %{lit} %{inputs}/max-retries-per-test/allow-retries-no-test_retry_attempts/test.py \
 # RUN:   --max-retries-per-test=2 \
-# RUN:   --show-attempts-count \
 # RUN:   -Dcounter=%t.counter \
 # RUN:   -Dpython=%{python} \
 # RUN: | FileCheck --check-prefix=CHECK-TEST9 %s
-# CHECK-TEST9: FLAKYPASS: allow-retries-no-test_retry_attempts :: test.py (1 of 1) [attempts=4,max_allowed_attempts=9]
+# CHECK-TEST9: FLAKYPASS: allow-retries-no-test_retry_attempts :: test.py (1 of 1, 4 of 9 attempts)
 # CHECK-TEST9: Passed With Retry: 1
 
 # This test only passes on the 4th try. Here we check that a test can be re-run when:
@@ -106,11 +104,10 @@
 # RUN: rm -f %t.counter
 # RUN: %{lit} %{inputs}/max-retries-per-test/no-allow-retries-test_retry_attempts/test.py \
 # RUN:   --max-retries-per-test=2 \
-# RUN:   --show-attempts-count \
 # RUN:   -Dcounter=%t.counter \
 # RUN:   -Dpython=%{python} \
 # RUN: | FileCheck --check-prefix=CHECK-TEST10 %s
-# CHECK-TEST10: FLAKYPASS: no-allow-retries-test_retry_attempts :: test.py (1 of 1) [attempts=4,max_allowed_attempts=10]
+# CHECK-TEST10: FLAKYPASS: no-allow-retries-test_retry_attempts :: test.py (1 of 1, 4 of 10 attempts)
 # CHECK-TEST10: Passed With Retry: 1
 
 # This test only passes on the 4th try. Here we check that a test can be re-run when:
@@ -120,9 +117,8 @@
 # RUN: rm -f %t.counter
 # RUN: %{lit} %{inputs}/max-retries-per-test/allow-retries-test_retry_attempts/test.py \
 # RUN:   --max-retries-per-test=1 \
-# RUN:   --show-attempts-count \
 # RUN:   -Dcounter=%t.counter \
 # RUN:   -Dpython=%{python} \
 # RUN: | FileCheck --check-prefix=CHECK-TEST11 %s
-# CHECK-TEST11: FLAKYPASS: allow-retries-test_retry_attempts :: test.py (1 of 1) [attempts=4,max_allowed_attempts=11]
+# CHECK-TEST11: FLAKYPASS: allow-retries-test_retry_attempts :: test.py (1 of 1, 4 of 11 attempts)
 # CHECK-TEST11: Passed With Retry: 1