add more tests for template render and assets

increases coverage to 94%

Author: goodwillcoding

configme/assets.py

@@ -4,6 +4,7 @@
 Asset management.
 """
 
+from io import open as io_open
 
 from os import makedirs
 from os.path import basename
@@ -59,7 +60,7 @@ def location(self, location, location_subject,
         return location
 
     # ....................................................................... #
-    def join_path(self, path_parts, _os_path_join=join):
+    def path_join(self, path_parts, _os_path_join=join):
         """
         Join and return the folder path from segments.
         """
@@ -157,3 +158,13 @@ def create_folder(self, folder_path, _os_makedirs=makedirs):
             raise LocationCreationError(msg)
 
         return folder_path
+
+    # ....................................................................... #
+    def write_to_file(self, file_path, content, _io_open=io_open):
+
+        # TODO: add error handling
+        file_handler = _io_open(file_path, 'w')
+        file_handler.write(content)
+        file_handler.close()
+
+        return file_path

configme/cli/cli_runner.py

@@ -136,7 +136,8 @@ def run(self):
 
             # and write config files out
             output_list = role.write_configs()
-
+        #try:
+        #    pass
         except ConfigMeException as err:
             # handle any recognizable erros in a CLI friendly fashion
             self.logger.error("Error: %s" % err.message)

configme/role.py

@@ -33,8 +33,8 @@ class Role(object):
         must be at least marginally human readable.
 
         As such due to difficulty maintaining OS specific forbidden characters
-        set, complying with ini file specifications, and keeping readability
-        a set of forbidden characters have choosen.
+        set, complying with INI file specifications, and keeping readability
+        a set of forbidden characters have chosen.
 
         The naming rules are:
 
@@ -138,8 +138,8 @@ def output_folder_path(self):
 
         :rtype: str/unicode
         """
-        join_path = self.config._asset_manager.join_path
-        return join_path((self.config.output_path, self.suffixed_name))
+        path_join = self.config._asset_manager.path_join
+        return path_join((self.config.output_path, self.suffixed_name))
 
     # ....................................................................... #
     @property
@@ -153,9 +153,9 @@ def settings_file_path(self):
 
         :rtype: str/unicode
         """
-        join_path = self.config._asset_manager.join_path
+        path_join = self.config._asset_manager.path_join
         file_name = "%s.%s" % (self.name, self.config.settings_file_extension)
-        return join_path((self.config.settings_path, file_name))
+        return path_join((self.config.settings_path, file_name))
 
     # ....................................................................... #
     def __init__(self, config, name, suffix='', variables=None):

configme/template_renderer.py

@@ -1,13 +1,11 @@
 
 """
-File Generator module.
+Template Renderers
 """
 
 from abc import ABCMeta
 from abc import abstractmethod
 
-from io import open as io_open
-
 from .exceptions import InvalidName
 
 
@@ -34,13 +32,14 @@ class BaseTemplateRenderer(object):
         must be at least marginally human readable.
 
         As such due to difficulty maintaining OS specific forbidden characters
-        set, complying with ini file specifications, and keeping readability
-        a set of forbidden characters have choosen.
+        set, complying with INI file specifications, and keeping readability
+        a set of forbidden characters have chosen.
 
         The naming rules are:
 
          - name cannot start with a: `space` `/` `../` `./`
-         - name cannot contain: `/../` `/./` `<` `>` `:` `"` `|` `?` `*`
+         - name cannot contain:
+           `/../` `/./` `<` `>` `:` `'` `"` `|` `?` `*` `\``
 
     :type path: str
 
@@ -58,7 +57,8 @@ class BaseTemplateRenderer(object):
     """
 
     _FORBIDDEN_START_CHARS = (" ", "/", "../", "./")
-    _FORBIDDEN_CHARS = ("/../", "/./", "<", ">", ":", '"', "|", "?", "*")
+    _FORBIDDEN_CHARS = \
+        ("/../", "/./", "<", ">", ":", "'", '"', "|", "?", "*", "`")
 
     __metaclass__ = ABCMeta
 
@@ -102,11 +102,11 @@ def output_file_path(self):
         :rtype: str
         """
         asset_manager = self.config._asset_manager
-        return asset_manager.join_path(
+        return asset_manager.path_join(
             (self.role_output_folder_path, self.path))
 
     # ....................................................................... #
-    def create_output_folder(self):
+    def write(self):
         """
         Create the output folder specified in `output_folder_path`.
         If the parents for the folder do not exist they will be created as
@@ -126,10 +126,6 @@ def create_output_folder(self):
 
         asset_manager = self.config._asset_manager
 
-        # if there is no folder for this config file just return the role path
-        if asset_manager.path_dirname(self.path) == '':
-            return self.role_output_folder_path
-
         # otherwise get the folder path for the output file
         output_file_folder = asset_manager.path_dirname(self.output_file_path)
 
@@ -140,7 +136,11 @@ def create_output_folder(self):
         # create folder
         asset_manager.create_folder(output_file_folder)
 
-        return output_file_folder
+        # get the rendered config
+        content = self.get_rendered_config()
+
+        # write to file
+        return asset_manager.write_to_file(self.output_file_path, content)
 
     # ....................................................................... #
     @abstractmethod
@@ -155,26 +155,7 @@ def get_rendered_config(self):
         :return: rendered template
         :rtype: str/unicode
         """
-
-        pass
-
-    # ....................................................................... #
-    def write(self, _io_open=io_open):
-        """
-        Render and output config to file at `output_file_path`.
-
-        :return: path to the the generated config file.
-        :rype: str
-        """
-
-        self.create_output_folder()
-
-        # TODO: exception handling
-        file_handler = _io_open(self.output_file_path, 'w')
-        file_handler.write(self.get_rendered_config())
-        file_handler.close()
-
-        return self.output_file_path
+        pass  # pragma: no cover
 
     # ....................................................................... #
     @classmethod

configme/tests/test_assets.py

@@ -72,7 +72,7 @@ def dummy_os_path_isdir(path):
             _os_path_isdir=dummy_os_path_isdir)
 
     # ....................................................................... #
-    def test_join_path(self):
+    def test_path_join(self):
 
         test_path_parts = ('test', 'path', 'parts')
 
@@ -84,7 +84,7 @@ def dummy_os_path_join(*path_parts):
         asset_manager = self._makeOne()
 
         self.assertEqual(
-            asset_manager.join_path(test_path_parts,
+            asset_manager.path_join(test_path_parts,
                                     _os_path_join=dummy_os_path_join),
             desired_result)
 

configme/tests/test_role.py

@@ -104,7 +104,7 @@ def dummy_asset_manager_maker():
     class DummyAssetManager(object):
 
         # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ #
-        def join_path(self, path_parts):
+        def path_join(self, path_parts):
             return '/'.join(path_parts)
 
         # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ #