Merge pull request #2 from clagraff/python-unittests

This fails CircleCI because of linting issues. Going to accept and merge, and address linting issues at a later time.

Author: clagraff

.circleci/config.yml

@@ -0,0 +1,53 @@
+# Python CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-python/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      # use `-browsers` prefix for selenium tests, e.g. `3.6.1-browsers`
+      - image: circleci/python:3.6.1
+      
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "requirements.txt" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            python3 -m venv venv
+            . venv/bin/activate
+            pip install -r requirements.txt
+
+      - save_cache:
+          paths:
+            - ./venv
+          key: v1-dependencies-{{ checksum "requirements.txt" }}
+        
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            . venv/bin/activate
+            python3 setup.py test
+            python3 -m pep8 beaver/
+
+      - store_artifacts:
+          path: test-reports
+          destination: test-reports
+          

beaver/__init__.py

@@ -59,12 +59,12 @@ def run(cmd, stdin):
 
 def path_context(path):
     ctx = {}
-
     name = os.path.basename(path)
+    split = name.split(".")
 
     ctx["__file__"] = name
-    ctx["__name__"] = name.split(".")[0]
-    ctx["__ext__"] = name.split(".")[-1]
+    ctx["__name__"] = ".".join(split[0:-1] ) if len(split) > 1 else name
+    ctx["__ext__"] = split[-1] if len(split) > 1 else ""
     ctx["__dir__"] = os.path.dirname(path)
     ctx["__path__"] = path
 

beaver/tests/__init__.py

@@ -0,0 +1,10 @@
+import unittest
+import unittest.mock as mock
+
+import beaver.drivers as drivers
+
+
+class TestGetExt(unittest.TestCase):
+    def test_empty_path(self):
+        with self.assertRaises(Exception):
+            drivers.get_ext("")

beaver/tests/drivers/test__init__.py

@@ -0,0 +1,137 @@
+import unittest
+import unittest.mock as mock
+
+import beaver
+
+
+class TestRun(unittest.TestCase):
+    @mock.patch("beaver.subprocess.Popen")
+    def test_retcode_exception(self, popen_mock):
+        """test_retcode_exception ensures that `beaver.run` will raise
+        an exception when it executes a subprocess which returns a non-zero
+        execution result."""
+        m = mock.MagicMock()
+        popen_mock.return_value = m
+
+        m.returncode = 1    # non-zero return value
+
+        with self.assertRaises(Exception):
+            beaver.run("echo", "some text goes here")
+
+    @mock.patch("beaver.subprocess.Popen")
+    def test_retcode_no_exception(self, popen_mock):
+        """test_retcode_exception ensures that `beaver.run` will not raise
+        an exception when it executes a subprocess which returns a zero
+        execution result."""
+        m = mock.MagicMock()
+        popen_mock.return_value = m
+
+        m.returncode = 0
+        beaver.run("echo", "some text goes here")
+
+
+class TestPathContext(unittest.TestCase):
+    def test_path_context(self):
+        # argument: expected
+        table = {
+            # empty state
+            "": {
+                "__file__": "",
+                "__name__": "",
+                "__ext__": "",
+                "__dir__": "",
+                "__path__": "",
+            },
+            "/": {
+                "__file__": "",
+                "__name__": "",
+                "__ext__": "",
+                "__dir__": "/",
+                "__path__": "/",
+            },
+            "/dir/file": {
+                "__file__": "file",
+                "__name__": "file",
+                "__ext__": "",
+                "__dir__": "/dir",
+                "__path__": "/dir/file",
+            },
+            "/dir1/dir2/": {
+                "__file__": "",
+                "__name__": "",
+                "__ext__": "",
+                "__dir__": "/dir1/dir2",
+                "__path__": "/dir1/dir2/",
+            },
+            "/dir/file.ext": {
+                "__file__": "file.ext",
+                "__name__": "file",
+                "__ext__": "ext",
+                "__dir__": "/dir",
+                "__path__": "/dir/file.ext",
+            },
+            "/dir/file.ext1.ext2": {
+                "__file__": "file.ext1.ext2",
+                "__name__": "file.ext1",
+                "__ext__": "ext2",
+                "__dir__": "/dir",
+                "__path__": "/dir/file.ext1.ext2",
+            },
+        }
+
+        for arg in table:
+            result = beaver.path_context(arg)
+            expected = table[arg]
+
+            self.assertEqual(result, expected)
+
+
+class TestDoOne(unittest.TestCase):
+    @mock.patch("beaver.os.path.isfile")
+    def test_file_exceptions(self, mock_isfile):
+        mock_isfile.return_value = True
+        def side_effect(path):
+            return bool(path)
+        mock_isfile.side_effect = side_effect
+
+        m = mock.Mock()
+        m.template = ""
+
+        with self.assertRaises(Exception):
+            beaver.do_one(m)
+
+        m.template = "/some/path"
+        m.input = ""
+
+        with self.assertRaises(Exception):
+            beaver.do_one(m)
+
+    @mock.patch("beaver.open")
+    @mock.patch("beaver.write_output")
+    @mock.patch("beaver.run")
+    @mock.patch("beaver.load_template")
+    @mock.patch("beaver.drivers.parse")
+    @mock.patch("beaver.os.path.isfile")
+    def test_ensure_posts(
+        self, mock_isfile, mock_parse, mock_load_template,
+        mock_run, mock_write_output, mock_open
+    ):
+        m = mock.Mock()
+        m.post = [
+            "first",
+            "second",
+            "third"
+        ]
+
+        mock_tpl = mock.Mock()
+        mock_tpl.return_value = None
+
+        mock_load_template.return_value = mock_tpl
+
+        beaver.do_one(m)
+
+        assert mock_run.call_count == len(m.post)
+
+
+if __name__ == '__main__':
+    unittest.main()

beaver/tests/test__init__.py

@@ -0,0 +1,9 @@
+import unittest
+import unittest.mock as mock
+
+import beaver.version as version
+
+
+class TestVersion(unittest.TestCase):
+    def test_ensure_existance(self):
+        assert version.__version__

beaver/tests/test_version.py

@@ -1,4 +1,9 @@
 Jinja2==2.9.6
 MarkupSafe==1.0
+nose==1.3.7
+pep8==1.7.0
+pudb==2017.1.4
+Pygments==2.2.0
 PyYAML==3.12
+urwid==1.3.1
 xmldict==0.4.1

requirements.txt

@@ -61,7 +61,7 @@
 exec(compile(open('beaver/version.py').read(),
              'beaver/version.py', 'exec'))
 
-DESCRIPTION = 'Tool for templated code generation'
+DESCRIPTION = 'A code generation tool made with Python'
 LONG_DESCRIPTION = 'Command-line program to generate source code from a Jinja2 template and 1 or more input structures'
 
 py2exe_console = [{
@@ -132,9 +132,8 @@ def find_repository():
     author='Curtis La Graff',
     author_email='[email protected]',
     classifiers=[
-        'Development Status :: 2 - Pre-Alpha',
         'Environment :: Console',
-        'License :: Public Domain',
+        'License :: MIT LICENSE',
         'Programming Language :: Python :: 3.2',
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',