[PATCH] Unit tests for sgml-delete-tag

[PATCH] Unit tests for sgml-delete-tag

[Przemysław Wojnowski]

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

Hello everybody,

Unit tests for sgml-delete-tag.
I did run them from command line too. ;-)

Cheers,
Przemysław

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-test-automated-sgml-mode-tests.el-Tests-for-sgml-del.patch --]
[-- Type: text/x-patch; name="0001-test-automated-sgml-mode-tests.el-Tests-for-sgml-del.patch", Size: 5276 bytes --]

From 5996f483ad5ee1a14436c4239dc2f83e9d097e9f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Przemys=C5=82aw=20Wojnowski?= <esperanto@cumego.com>
Date: Sun, 17 May 2015 21:49:05 +0200
Subject: [PATCH] * test/automated/sgml-mode-tests.el: Tests for
 sgml-delete-tag

A test case for (Bug#8203).
---
 test/automated/sgml-mode-tests.el | 135 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 135 insertions(+)
 create mode 100644 test/automated/sgml-mode-tests.el

diff --git a/test/automated/sgml-mode-tests.el b/test/automated/sgml-mode-tests.el
new file mode 100644
index 0000000..0e9272d
--- /dev/null
+++ b/test/automated/sgml-mode-tests.el
@@ -0,0 +1,135 @@
+;;; sgml-mode-tests.el --- Tests for sgml-mode
+
+;; Copyright (C) 2015 Free Software Foundation, Inc.
+
+;; Author: Przemysław Wojnowski <esperanto@cumego.com>
+;; Keywords: tests
+
+;; 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 <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;;; Code:
+
+(require 'sgml-mode)
+(require 'ert)
+
+(defmacro with-content (content &rest body)
+  "Insert CONTENT into a temporary `sgml-mode' buffer and execute BODY on it.
+The point is set to the beginning of the buffer."
+  `(with-temp-buffer
+     (sgml-mode)
+     (insert ,content)
+     (goto-char (point-min))
+     ,@body))
+
+
+;;; sgml-delete-tag tests:
+(ert-deftest should-not-delete-tags-when-wrong-args ()
+  "Don't delete tag, when number of tags to delete is not positive number."
+  (let ((content "<p>Valar Morghulis</p>"))
+    (with-content
+     content
+     (sgml-delete-tag -1)
+     (should (string= content (buffer-string)))
+     (sgml-delete-tag 0)
+     (should (string= content (buffer-string))))))
+
+(ert-deftest should-delete-tags-n-times ()
+  ;; Delete only 1, when 1 available:
+  (with-content
+   "<br />"
+   (sgml-delete-tag 1)
+   (should (string= "" (buffer-string))))
+  ;; Delete from position on whitespaces before tag:
+  (with-content
+   " \t\n<br />"
+   (sgml-delete-tag 1)
+   (should (string= "" (buffer-string))))
+  ;; Delete from position on tag:
+  (with-content
+   "<br />"
+   (goto-char 3)
+   (sgml-delete-tag 1)
+   (should (string= "" (buffer-string))))
+  ;; Delete one by one:
+  (with-content
+   "<h1><p>You know nothing, Jon Snow.</p></h1>"
+   (sgml-delete-tag 1)
+   (should (string= "<p>You know nothing, Jon Snow.</p>" (buffer-string)))
+   (sgml-delete-tag 1)
+   (should (string= "You know nothing, Jon Snow." (buffer-string))))
+  ;; Delete 2 at a time, when 2 available:
+  (with-content
+   "<h1><p>You know nothing, Jon Snow.</p></h1>"
+   (sgml-delete-tag 2)
+   (should (string= "You know nothing, Jon Snow." (buffer-string)))))
+
+(ert-deftest should-delete-unclosed-tag ()
+  (with-content
+   "<ul><li>Keep your stones connected.</ul>"
+   (goto-char 5)                   ; position on "li" tag
+   (sgml-delete-tag 1)
+   (should (string= "<ul>Keep your stones connected.</ul>" (buffer-string)))))
+
+(ert-deftest should-signal-error-for-malformed-tags ()
+  (let ((content "<h1><h2>Drakaris!</h1></h2>"))
+    ;; Delete outside tag:
+    (with-content
+     content
+     (sgml-delete-tag 1)
+     (should (string= "<h2>Drakaris!</h2>" (buffer-string))))
+    ;; Delete inner tag:
+    (with-content
+     content
+     (goto-char 5)                   ; position the inner tag
+     (sgml-delete-tag 1)
+     (should (string= "<h1>Drakaris!</h1>" (buffer-string))))))
+
+(ert-deftest should-signal-error-when-deleting-too-much ()
+  (let ((content "<emph>Drakaris!</emph>"))
+    ;; No tags to delete:
+    (with-content
+     "Drakaris!"
+     (should-error (sgml-delete-tag 1) :type 'error)
+     (should (string= "Drakaris!" (buffer-string))))
+    ;; Trying to delete 2 tags, when only 1 available:
+    (with-content
+     content
+     (should-error (sgml-delete-tag 2) :type 'error)
+     (should (string= "Drakaris!" (buffer-string))))
+    ;; Trying to delete a tag, but not on/before a tag:
+    (with-content
+     content
+     (goto-char 7)                     ; D in Drakaris
+     (should-error (sgml-delete-tag 1) :type 'error)
+     (should (string= content (buffer-string))))
+    ;; Trying to delete a tag from position outside tag:
+    (with-content
+     content
+     (goto-char (point-max))
+     (should-error (sgml-delete-tag 1) :type 'error)
+     (should (string= content (buffer-string))))))
+
+(ert-deftest bug-8203-sgml-delete-tag-should-not-delete-apostrophe ()
+  :expected-result :failed
+  (with-content
+   "<title>Winter is comin'</title>"
+   (sgml-delete-tag 1)
+   (should (string= "Winter is comin'" (buffer-string)))))
+
+(provide 'sgml-mode-tests)
+;;; sgml-mode-tests.el ends here
-- 
2.1.0

Re: [PATCH] Unit tests for sgml-delete-tag

[Dmitry Gutov]

Hi again!

On 05/18/2015 10:15 AM, Przemysław Wojnowski wrote:
> Unit tests for sgml-delete-tag.
> I did run them from command line too. ;-)

Please prefix the names of the tests and the setup macro.

Otherwise, they look fine, thanks.

Will the next step be the patch for 8203? There's no real need to send 
them separately.

Re: [PATCH] Unit tests for sgml-delete-tag

[Przemysław Wojnowski]

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

W dniu 18.05.2015 o 17:52, Dmitry Gutov pisze:
> Please prefix the names of the tests and the setup macro.
Done.

> Will the next step be the patch for 8203? There's no real need to send them
> separately.
Probably, but don't know when, so I'm sending a patch to things I already have. 
It's just Continuous Integration, but through email. ;-)

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-test-automated-sgml-mode-tests.el-Tests-for-sgml-del.patch --]
[-- Type: text/x-patch; name="0001-test-automated-sgml-mode-tests.el-Tests-for-sgml-del.patch", Size: 5429 bytes --]

From 03137d5591a415ec90de1fab1bfbccdeed5726be Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Przemys=C5=82aw=20Wojnowski?= <esperanto@cumego.com>
Date: Sun, 17 May 2015 21:49:05 +0200
Subject: [PATCH] * test/automated/sgml-mode-tests.el: Tests for
 sgml-delete-tag

A test case for (Bug#8203).
---
 test/automated/sgml-mode-tests.el | 134 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 134 insertions(+)
 create mode 100644 test/automated/sgml-mode-tests.el

diff --git a/test/automated/sgml-mode-tests.el b/test/automated/sgml-mode-tests.el
new file mode 100644
index 0000000..dcc34d9
--- /dev/null
+++ b/test/automated/sgml-mode-tests.el
@@ -0,0 +1,134 @@
+;;; sgml-mode-tests.el --- Tests for sgml-mode
+
+;; Copyright (C) 2015 Free Software Foundation, Inc.
+
+;; Author: Przemysław Wojnowski <esperanto@cumego.com>
+;; Keywords: tests
+
+;; 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 <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;;; Code:
+
+(require 'sgml-mode)
+(require 'ert)
+
+(defmacro sgml-with-content (content &rest body)
+  "Insert CONTENT into a temporary `sgml-mode' buffer and execute BODY on it.
+The point is set to the beginning of the buffer."
+  `(with-temp-buffer
+     (sgml-mode)
+     (insert ,content)
+     (goto-char (point-min))
+     ,@body))
+
+;;; sgml-delete-tag tests:
+(ert-deftest sgml-delete-tag-should-not-delete-tags-when-wrong-args ()
+  "Don't delete tag, when number of tags to delete is not positive number."
+  (let ((content "<p>Valar Morghulis</p>"))
+    (sgml-with-content
+     content
+     (sgml-delete-tag -1)
+     (should (string= content (buffer-string)))
+     (sgml-delete-tag 0)
+     (should (string= content (buffer-string))))))
+
+(ert-deftest sgml-delete-tag-should-delete-tags-n-times ()
+  ;; Delete only 1, when 1 available:
+  (sgml-with-content
+   "<br />"
+   (sgml-delete-tag 1)
+   (should (string= "" (buffer-string))))
+  ;; Delete from position on whitespaces before tag:
+  (sgml-with-content
+   " \t\n<br />"
+   (sgml-delete-tag 1)
+   (should (string= "" (buffer-string))))
+  ;; Delete from position on tag:
+  (sgml-with-content
+   "<br />"
+   (goto-char 3)
+   (sgml-delete-tag 1)
+   (should (string= "" (buffer-string))))
+  ;; Delete one by one:
+  (sgml-with-content
+   "<h1><p>You know nothing, Jon Snow.</p></h1>"
+   (sgml-delete-tag 1)
+   (should (string= "<p>You know nothing, Jon Snow.</p>" (buffer-string)))
+   (sgml-delete-tag 1)
+   (should (string= "You know nothing, Jon Snow." (buffer-string))))
+  ;; Delete 2 at a time, when 2 available:
+  (sgml-with-content
+   "<h1><p>You know nothing, Jon Snow.</p></h1>"
+   (sgml-delete-tag 2)
+   (should (string= "You know nothing, Jon Snow." (buffer-string)))))
+
+(ert-deftest sgml-delete-tag-should-delete-unclosed-tag ()
+  (sgml-with-content
+   "<ul><li>Keep your stones connected.</ul>"
+   (goto-char 5)                   ; position on "li" tag
+   (sgml-delete-tag 1)
+   (should (string= "<ul>Keep your stones connected.</ul>" (buffer-string)))))
+
+(ert-deftest sgml-delete-tag-should-signal-error-for-malformed-tags ()
+  (let ((content "<h1><h2>Drakaris!</h1></h2>"))
+    ;; Delete outside tag:
+    (sgml-with-content
+     content
+     (sgml-delete-tag 1)
+     (should (string= "<h2>Drakaris!</h2>" (buffer-string))))
+    ;; Delete inner tag:
+    (sgml-with-content
+     content
+     (goto-char 5)                   ; position the inner tag
+     (sgml-delete-tag 1)
+     (should (string= "<h1>Drakaris!</h1>" (buffer-string))))))
+
+(ert-deftest sgml-delete-tag-should-signal-error-when-deleting-too-much ()
+  (let ((content "<emph>Drakaris!</emph>"))
+    ;; No tags to delete:
+    (sgml-with-content
+     "Drakaris!"
+     (should-error (sgml-delete-tag 1) :type 'error)
+     (should (string= "Drakaris!" (buffer-string))))
+    ;; Trying to delete 2 tags, when only 1 available:
+    (sgml-with-content
+     content
+     (should-error (sgml-delete-tag 2) :type 'error)
+     (should (string= "Drakaris!" (buffer-string))))
+    ;; Trying to delete a tag, but not on/before a tag:
+    (sgml-with-content
+     content
+     (goto-char 7)                     ; D in Drakaris
+     (should-error (sgml-delete-tag 1) :type 'error)
+     (should (string= content (buffer-string))))
+    ;; Trying to delete a tag from position outside tag:
+    (sgml-with-content
+     content
+     (goto-char (point-max))
+     (should-error (sgml-delete-tag 1) :type 'error)
+     (should (string= content (buffer-string))))))
+
+(ert-deftest sgml-delete-tag-bug-8203-should-not-delete-apostrophe ()
+  :expected-result :failed
+  (sgml-with-content
+   "<title>Winter is comin'</title>"
+   (sgml-delete-tag 1)
+   (should (string= "Winter is comin'" (buffer-string)))))
+
+(provide 'sgml-mode-tests)
+;;; sgml-mode-tests.el ends here
-- 
2.1.0

Re: [PATCH] Unit tests for sgml-delete-tag

[Dmitry Gutov]

On 05/18/2015 07:29 PM, Przemysław Wojnowski wrote:

> Done.

Thanks. I've changed the "sgml-delete-tag tests:" a bit (plus extra 
line, minus extraneous work), and pushed it.

> Probably, but don't know when, so I'm sending a patch to things I
> already have. It's just Continuous Integration, but through email. ;-)

Why don't you ask for commit access? It would be smoother if you could 
commit your own patches after review.