Re: Documenting NEWS features for 25.1

[Shakthi Kannan <shakthimaan@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 783 bytes --]

Hi,

NEWS entry:

  ** New ERT function `ert-summarize-tests-batch-and-exit'.

I have verified the function by creating a sample test.el file whose
contents are as follows:

  (ert-deftest example-test ()
    (should (= (+ 9 2) 11)))

I was able to run the test, and capture the output using:

  $ emacs -batch -l ert -l test.el -f ert-run-tests-batch > test.log

I compiled emacs-25, and ran the following to produce the expected
summary result as shown below:

  $ ./src/emacs -batch -l ert -f ert-summarize-tests-batch-and-exit test.log

SUMMARY OF TEST RESULTS
-----------------------
Files examined: 1
Ran 1 tests, 1 results as expected

Is the attached documentation change fine? I can then send you an actual patch.

Regards,

SK

--
Shakthi Kannan
http://www.shakthimaan.com

[-- Attachment #2: ert-summarize.patch --]
[-- Type: text/x-patch, Size: 1270 bytes --]

diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi
index 35d315c..d29c1d8 100644
--- a/doc/misc/ert.texi
+++ b/doc/misc/ert.texi
@@ -283,6 +283,15 @@ Running Tests in Batch Mode
 failed or if anything else went wrong.  It will also print progress
 messages and error diagnostics to standard output.
 
+You can also redirect the above output to a log file, say
+@code{output.log}, and use the
+@code{ert-summarize-tests-batch-and-exit} function to produce a neat
+summary as shown below:
+
+@example
+emacs -batch -l ert -f ert-summarize-tests-batch-and-exit output.log
+@end example
+
 If ERT is not part of your Emacs distribution, you may need to use
 @code{-L /path/to/ert/} so that Emacs can find it.  You may need
 additional @code{-L} flags to ensure that @code{my-tests.el} and all the
diff --git a/etc/NEWS b/etc/NEWS
index 19c9858..f1ba79f 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -696,7 +696,11 @@ The remainder were:
 
 **** The nil and list forms of `diary-display-function'.
 
++++
 ** New ERT function `ert-summarize-tests-batch-and-exit'.
+If the output of ERT tests in batch mode execution can be saved to a
+log file, then it can be passed as an argument to the above function
+to produce a neat summary.
 
 ** New js.el option `js-indent-first-init'.