From 3fbd18245306b3abd415d234ba33145de2ac8cef Mon Sep 17 00:00:00 2001
From: Mike Terzo <mike@terzo.org>
Date: Sun, 11 Sep 2016 21:01:13 -0400
Subject: [PATCH] Adding unittests (#300)

* Create a custom class to handle aborting 204 properly.  If this isn't
covered the server will send a 500 due to a python exception

* Moved py.test configuration under tool:pytest, this was causing a
warning.  This is new to 3.0.1 which is now the pinned version

* Unittest for puppetboard.utils
---
 puppetboard/app.py    |  18 +++++
 requirements-test.txt |   2 +
 setup.cfg             |   2 +-
 test/test_utils.py    | 158 ++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 179 insertions(+), 1 deletion(-)
 create mode 100644 test/test_utils.py

diff --git a/puppetboard/app.py b/puppetboard/app.py
index b789959..8fddc6c 100644
--- a/puppetboard/app.py
+++ b/puppetboard/app.py
@@ -25,6 +25,8 @@ from puppetboard.utils import (
     jsonprint, prettyprint, Pagination
 )
 
+import werkzeug.exceptions as ex
+
 DEFAULT_ORDER_BY = '[{"field": "start_time", "order": "desc"}]'
 
 app = Flask(__name__)
@@ -93,6 +95,22 @@ def utility_processor():
     return dict(now=now)
 
 
+#
+# 204 doesn't have a mapping in werkzeug, we need to define a custom
+# class and then set it to the mappings.
+#
+class NoContent(ex.HTTPException):
+    code = 204
+    description = '<p>No content</p'
+
+abort.mapping[204] = NoContent
+
+
+@app.errorhandler(204)
+def no_content(e):
+    return '', 204
+
+
 @app.errorhandler(400)
 def bad_request(e):
     envs = environments()
diff --git a/requirements-test.txt b/requirements-test.txt
index e4c1a9b..d78d396 100644
--- a/requirements-test.txt
+++ b/requirements-test.txt
@@ -1,6 +1,8 @@
 pep8==1.6.2
 coverage==4.0
 mock==1.3.0
+pytest==3.0.1
 pytest-pep8==1.0.5
 pytest-cov==2.2.1
 cov-core==1.15.0
+unittest2==1.1.0; python_version < '2.7'
diff --git a/setup.cfg b/setup.cfg
index 820c370..7ca6f80 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -19,7 +19,7 @@ cover-package = puppetboard
 [flake8]
 exclude=venv
 
-[pytest]
+[tool:pytest]
 addopts = --cov=puppetboard --cov-report=term-missing
 norecursedirs = docs .tox venv
 pep8ignore = E402
diff --git a/test/test_utils.py b/test/test_utils.py
new file mode 100644
index 0000000..7a82f48
--- /dev/null
+++ b/test/test_utils.py
@@ -0,0 +1,158 @@
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+
+import sys
+import json
+import mock
+
+from types import GeneratorType
+
+from requests.exceptions import HTTPError, ConnectionError
+from pypuppetdb.errors import EmptyResponseError
+from requests import Response
+from werkzeug.exceptions import NotFound, InternalServerError
+
+from puppetboard import utils
+from puppetboard import app
+from puppetboard.app import NoContent
+
+
+import logging
+
+
+class UtilsTestCase(unittest.TestCase):
+    def setUp(self):
+        pass
+
+    def teadDown(self):
+        pass
+
+    def test_json_format(self):
+        demo = [{'foo': 'bar'}, {'bar': 'foo'}]
+        sample = json.dumps(demo, indent=2, separators=(',', ': '))
+
+        self.assertEqual(sample, utils.jsonprint(demo),
+                         "Json formatting has changed")
+
+    def test_format_val_str(self):
+        x = "some string"
+        self.assertEqual(x, utils.formatvalue(x),
+                         "Should return same value")
+
+    def test_format_val_array(self):
+        x = ['a', 'b', 'c']
+        self.assertEqual("a, b, c", utils.formatvalue(x),
+                         "Should return comma seperated string")
+
+    def test_format_val_dict_one_layer(self):
+        x = {'a': 'b'}
+        self.assertEqual("a => b,<br/>", utils.formatvalue(x),
+                         "Should return stringified value")
+
+    def test_format_val_tuple(self):
+        x = ('a', 'b')
+        self.assertEqual(str(x), utils.formatvalue(x))
+
+
+@mock.patch('logging.log')
+class GetOrAbortTesting(unittest.TestCase):
+
+    def test_get(self, mock_log):
+        x = "hello world"
+
+        def test_get_or_abort():
+            return x
+
+        self.assertEqual(x, utils.get_or_abort(test_get_or_abort))
+
+    def test_http_error(self, mock_log):
+        err = "NotFound"
+
+        def raise_http_error():
+            x = Response()
+            x.status_code = 404
+            x.reason = err
+            raise HTTPError(err, response=x)
+
+        with self.assertRaises(NotFound) as error:
+            utils.get_or_abort(raise_http_error)
+            mock_log.error.assert_called_with(err)
+
+    def test_http_connection_error(self, mock_log):
+        err = "ConnectionError"
+
+        def connection_error():
+            x = Response()
+            x.status_code = 500
+            x.reason = err
+            raise ConnectionError(err, response=x)
+
+        with self.assertRaises(InternalServerError) as error:
+            utils.get_or_abort(connection_error)
+            mock_log.error.assert_called_with(err)
+
+    @mock.patch('flask.abort')
+    def test_http_empty(self, mock_log, flask_abort):
+        err = "Empty Response"
+
+        def connection_error():
+            raise EmptyResponseError(err)
+
+        with self.assertRaises(NoContent) as error:
+            utils.get_or_abort(connection_error)
+            mock_log.error.assert_called_with(err)
+            flask_abort.assert_called_with('204')
+
+
+class yieldOrStop(unittest.TestCase):
+
+    def test_iter(self):
+        test_list = (0, 1, 2, 3)
+
+        def my_generator():
+            for i in test_list:
+                yield i
+
+        gen = utils.yield_or_stop(my_generator())
+        self.assertIsInstance(gen, GeneratorType)
+
+        i = 0
+        for val in gen:
+            self.assertEqual(i, val)
+            i = i + 1
+
+    def test_stop_empty(self):
+        def my_generator():
+            yield 1
+            raise EmptyResponseError
+            yield 2
+
+        gen = utils.yield_or_stop(my_generator())
+        for val in gen:
+            self.assertEqual(1, val)
+
+    def test_stop_conn_error(self):
+        def my_generator():
+            yield 1
+            raise ConnectionError
+            yield 2
+
+        gen = utils.yield_or_stop(my_generator())
+        for val in gen:
+            self.assertEqual(1, val)
+
+    def test_stop_http_error(self):
+        def my_generator():
+            yield 1
+            raise HTTPError
+            yield 2
+
+        gen = utils.yield_or_stop(my_generator())
+        for val in gen:
+            self.assertEqual(1, val)
+
+
+if __name__ == '__main__':
+    unittest.main()