bug#36174: [PATCH] Add tests for mail/flow-fill.el

bug#36174: [PATCH] Add tests for mail/flow-fill.el

[Stefan Kangas]

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

I have converted the tests in mail/flow-fill.el into ert tests.
Please see the attached patch.

Thanks,
Stefan Kangas

[-- Attachment #2: 0001-Add-tests-for-mail-flow-fill.el.patch --]
[-- Type: application/octet-stream, Size: 7716 bytes --]

From 28a086ec6775edb6dc902fa789e7f0fc78128c7d Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Tue, 11 Jun 2019 23:35:15 +0200
Subject: [PATCH] Add tests for mail/flow-fill.el

* test/lisp/mail/flow-fill-tests.el: New file.
* lisp/mail/flow-fill.el (fill-flowed-encode-tests)
(fill-flowed-test): Make obsolete.
---
 lisp/mail/flow-fill.el            | 71 ++----------------------
 test/lisp/mail/flow-fill-tests.el | 92 +++++++++++++++++++++++++++++++
 2 files changed, 98 insertions(+), 65 deletions(-)
 create mode 100644 test/lisp/mail/flow-fill-tests.el

diff --git a/lisp/mail/flow-fill.el b/lisp/mail/flow-fill.el
index 06279d4041..ed6a2df87d 100644
--- a/lisp/mail/flow-fill.el
+++ b/lisp/mail/flow-fill.el
@@ -165,74 +165,15 @@ fill-flowed
 	       (forward-line 1)
 	       nil))))))))
 
-;; Test vectors.
-
-(defvar show-trailing-whitespace)
-
-(defvar fill-flowed-encode-tests
-  `(
-    ;; The syntax of each list element is:
-    ;; (INPUT . EXPECTED-OUTPUT)
-    (,(concat
-       "> Thou villainous ill-breeding spongy dizzy-eyed \n"
-       "> reeky elf-skinned pigeon-egg! \n"
-       ">> Thou artless swag-bellied milk-livered \n"
-       ">> dismal-dreaming idle-headed scut!\n"
-       ">>> Thou errant folly-fallen spleeny reeling-ripe \n"
-       ">>> unmuzzled ratsbane!\n"
-       ">>>> Henceforth, the coding style is to be strictly \n"
-       ">>>> enforced, including the use of only upper case.\n"
-       ">>>>> I've noticed a lack of adherence to the coding \n"
-       ">>>>> styles, of late.\n"
-       ">>>>>> Any complaints?")
-     .
-     ,(concat
-       "> Thou villainous ill-breeding spongy dizzy-eyed reeky elf-skinned\n"
-       "> pigeon-egg! \n"
-       ">> Thou artless swag-bellied milk-livered dismal-dreaming idle-headed\n"
-       ">> scut!\n"
-       ">>> Thou errant folly-fallen spleeny reeling-ripe unmuzzled ratsbane!\n"
-       ">>>> Henceforth, the coding style is to be strictly enforced,\n"
-       ">>>> including the use of only upper case.\n"
-       ">>>>> I've noticed a lack of adherence to the coding styles, of late.\n"
-       ">>>>>> Any complaints?\n"
-       ))
-    ;; (,(concat
-    ;;    "\n"
-    ;;    "> foo\n"
-    ;;    "> \n"
-    ;;    "> \n"
-    ;;    "> bar\n")
-    ;;  .
-    ;;  ,(concat
-    ;;    "\n"
-    ;;    "> foo bar\n"))
-    ))
+(make-obsolete-variable 'fill-flowed-encode-tests nil "27.1")
+(defvar fill-flowed-encode-tests)
 
 (defun fill-flowed-test ()
   (interactive "")
-  (switch-to-buffer (get-buffer-create "*Format=Flowed test output*"))
-  (erase-buffer)
-  (setq show-trailing-whitespace t)
-  (dolist (test fill-flowed-encode-tests)
-    (let (start output)
-      (insert "***** BEGIN TEST INPUT *****\n")
-      (insert (car test))
-      (insert "***** END TEST INPUT *****\n\n")
-      (insert "***** BEGIN TEST OUTPUT *****\n")
-      (setq start (point))
-      (insert (car test))
-      (save-restriction
-	(narrow-to-region start (point))
-	(fill-flowed))
-      (setq output (buffer-substring start (point-max)))
-      (insert "***** END TEST OUTPUT *****\n")
-      (unless (string= output (cdr test))
-	(insert "\n***** BEGIN TEST EXPECTED OUTPUT *****\n")
-	(insert (cdr test))
-	(insert "***** END TEST EXPECTED OUTPUT *****\n"))
-      (insert "\n\n")))
-  (goto-char (point-max)))
+  (declare (obsolete nil "27.1"))
+  (user-error (concat "This function is obsolete.  Please see "
+                      "test/lisp/mail/flow-fill-tests.el "
+                      "in the Emacs source tree")))
 
 (provide 'flow-fill)
 
diff --git a/test/lisp/mail/flow-fill-tests.el b/test/lisp/mail/flow-fill-tests.el
new file mode 100644
index 0000000000..a05950bb70
--- /dev/null
+++ b/test/lisp/mail/flow-fill-tests.el
@@ -0,0 +1,92 @@
+;;; flow-fill-tests.el --- Tests for flow-fill.el  -*- lexical-binding: t -*-
+
+;; Copyright (C) 2019 Free Software Foundation, Inc.
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;;; Code:
+
+(require 'ert)
+(require 'flow-fill)
+
+(ert-deftest fill-flow-tests-fill-flowed-encode ()
+  (let ((input
+         (concat
+          "> Thou villainous ill-breeding spongy dizzy-eyed \n"
+          "> reeky elf-skinned pigeon-egg! \n"
+          ">> Thou artless swag-bellied milk-livered \n"
+          ">> dismal-dreaming idle-headed scut!\n"
+          ">>> Thou errant folly-fallen spleeny reeling-ripe \n"
+          ">>> unmuzzled ratsbane!\n"
+          ">>>> Henceforth, the coding style is to be strictly \n"
+          ">>>> enforced, including the use of only upper case.\n"
+          ">>>>> I've noticed a lack of adherence to the coding \n"
+          ">>>>> styles, of late.\n"
+          ">>>>>> Any complaints?\n"))
+        (output
+         (concat
+          "> Thou villainous ill-breeding spongy dizzy-eyed reeky elf-skinned\n"
+          "> pigeon-egg! \n"
+          ">> Thou artless swag-bellied milk-livered dismal-dreaming idle-headed\n"
+          ">> scut!\n"
+          ">>> Thou errant folly-fallen spleeny reeling-ripe unmuzzled ratsbane!\n"
+          ">>>> Henceforth, the coding style is to be strictly enforced,\n"
+          ">>>> including the use of only upper case.\n"
+          ">>>>> I've noticed a lack of adherence to the coding styles, of late.\n"
+          ">>>>>> Any complaints?\n"))
+        (fill-flowed-display-column 69))
+    (with-temp-buffer
+      (insert input)
+      (fill-flowed)
+      (should (equal (buffer-string) output)))))
+
+(ert-deftest fill-flow-tests-fill-flowed-encode ()
+  (let ((input
+         (concat
+          "> Thou villainous ill-breeding spongy dizzy-eyed \n"
+          "> reeky elf-skinned pigeon-egg! \n"
+          ">> Thou artless swag-bellied milk-livered \n"
+          ">> dismal-dreaming idle-headed scut!\n"
+          ">>> Thou errant folly-fallen spleeny reeling-ripe \n"
+          ">>> unmuzzled ratsbane!\n"
+          ">>>> Henceforth, the coding style is to be strictly \n"
+          ">>>> enforced, including the use of only upper case.\n"
+          ">>>>> I've noticed a lack of adherence to the coding \n"
+          ">>>>> styles, of late.\n"
+          ">>>>>> Any complaints?\n"))
+        (output
+         (concat
+          "> Thou villainous ill-breeding spongy dizzy-eyed \n"
+          "> reeky elf-skinned pigeon-egg! \n"
+          ">> Thou artless swag-bellied milk-livered \n"
+          ">> dismal-dreaming idle-headed scut!\n"
+          ">>> Thou errant folly-fallen spleeny reeling-ripe \n"
+          ">>> unmuzzled ratsbane!\n"
+          ">>>> Henceforth, the coding style is to be strictly \n"
+          ">>>> enforced, including the use of only upper case.\n"
+          ">>>>> I've noticed a lack of adherence to the coding \n"
+          ">>>>> styles, of late.\n"
+          ">>>>>> Any complaints?\n"))
+        (fill-flowed-display-column 69))
+    (with-temp-buffer
+      (insert input)
+      (fill-flowed-encode)
+      (should (equal (buffer-string) output)))))
+
+(provide 'flow-fill-tests)
+;;; flow-fill-tests.el ends here
-- 
2.21.0

bug#36174: [PATCH] Add tests for mail/flow-fill.el

[Eli Zaretskii]

> From: Stefan Kangas <stefan@marxist.se>
> Date: Tue, 11 Jun 2019 23:44:10 +0200
> 
> I have converted the tests in mail/flow-fill.el into ert tests.
> Please see the attached patch.

Thanks, pushed.