Merge pull request #6 from nir0s/code-optimization

refactoring

Author: nir0s

CHANGELOG.md

@@ -1,9 +1,9 @@
 python-packer
 =============
 
-* Master Branch [![Build Status](https://travis-ci.org/nir0s/python-packer.svg?branch=master)](https://travis-ci.org/nir0s/python-packer)
-* PyPI [![PyPI](http://img.shields.io/pypi/dm/python-packer.svg)](http://img.shields.io/pypi/dm/python-packer.svg)
-* Version [![PypI](http://img.shields.io/pypi/v/python-packer.svg)](http://img.shields.io/pypi/v/python-packer.svg)
+[![Build Status](https://travis-ci.org/nir0s/python-packer.svg?branch=master)](https://travis-ci.org/nir0s/python-packer)
+[![PyPI](http://img.shields.io/pypi/dm/python-packer.svg)](http://img.shields.io/pypi/dm/python-packer.svg)
+[![PypI](http://img.shields.io/pypi/v/python-packer.svg)](http://img.shields.io/pypi/v/python-packer.svg)
 
 
 A Python interface for [packer.io](http://www.packer.io)
@@ -15,10 +15,11 @@ The interface has been developed vs. Packer v0.7.5.
 
 ## Installation
 
-You must have Packer installed prior to using this client (DUH!)
+You must have Packer installed prior to using this client though as installer class is provided to install packer for you.
 
 ```shell
  pip install python-packer
+
  # or, for dev:
  pip install https://github.com/nir0s/python-packer/archive/master.tar.gz
 ```
@@ -172,3 +173,19 @@ As such, return values from all functional methods (`validate`, `build`, etc..)
 will return an `sh` execution object. This is meant for you to be able to read stdout, stderr, exit codes and more after executing the commands. With the progression of `python-packer` less abstract objects will return and more concise return values will be provided.
 
 Additionally, to verify that all errors return with as much info as possible, error handling is done gently. Most errors will raise an `sh` exception so that you're able to interact with them. Again, as this module progresses, these exceptions will be handled properly.
+
+
+## Testing
+
+Please contribute. Currently tests are not really developed.
+
+```shell
+git clone git@github.com:nir0s/python-packer.git
+cd python-packer
+pip install tox
+tox
+```
+
+## Contributions..
+
+..are always welcome.

README.md

@@ -3,21 +3,22 @@
 import json
 import zipfile
 
-__version__ = '0.0.3'
+__version__ = '0.1.0'
 
 DEFAULT_PACKER_PATH = 'packer'
 
 
-class Packer():
-    """Packer interface using the `sh` module (http://amoffat.github.io/sh/)
+class Packer(object):
+    """A packer client.
     """
+
     def __init__(self, packerfile, exc=None, only=None, vars=None,
                  var_file=None, exec_path=DEFAULT_PACKER_PATH):
         """
         :param string packerfile: Path to Packer template file
         :param list exc: List of builders to exclude
         :param list only: List of builders to include
-        :param dict vars: Key Value pairs of template variables
+        :param dict vars: key=value pairs of template variables
         :param string var_file: Path to variables file
         :param string exec_path: Path to Packer executable
         """
@@ -26,34 +27,39 @@ def __init__(self, packerfile, exc=None, only=None, vars=None,
         if not os.path.isfile(self.packerfile):
             raise OSError('packerfile not found at path: {0}'.format(
                 self.packerfile))
-        self.exc = self._validate_argtype(exc if exc else [], list)
-        self.only = self._validate_argtype(only if only else [], list)
-        self.vars = self._validate_argtype(vars if vars else {}, dict)
+        self.exc = self._validate_argtype(exc or [], list)
+        self.only = self._validate_argtype(only or [], list)
+        self.vars = self._validate_argtype(vars or {}, dict)
+
         self.packer = sh.Command(exec_path)
 
     def build(self, parallel=True, debug=False, force=False):
-        """Executes a Packer build (`packer build`)
+        """Executes a `packer build`
 
         :param bool parallel: Run builders in parallel
         :param bool debug: Run in debug mode
         :param bool force: Force artifact output even if exists
         """
-        self.ccmd = self.packer.build
+        self.packer_cmd = self.packer.build
+
         self._add_opt('-parallel=true' if parallel else None)
         self._add_opt('-debug' if debug else None)
         self._add_opt('-force' if force else None)
         self._append_base_arguments()
         self._add_opt(self.packerfile)
-        return self.ccmd()
+
+        return self.packer_cmd()
 
     def fix(self, to_file=None):
         """Implements the `packer fix` function
 
         :param string to_file: File to output fixed template to
         """
-        self.ccmd = self.packer.fix
+        self.packer_cmd = self.packer.fix
+
         self._add_opt(self.packerfile)
-        result = self.ccmd()
+
+        result = self.packer_cmd()
         if to_file:
             with open(to_file, 'w') as f:
                 f.write(result.stdout)
@@ -87,27 +93,33 @@ def inspect(self, mrf=True):
               "name": "amazon"
             }
           ]
+
         :param bool mrf: output in machine-readable form.
         """
-        self.ccmd = self.packer.inspect
+        self.packer_cmd = self.packer.inspect
+
         self._add_opt('-machine-readable' if mrf else None)
         self._add_opt(self.packerfile)
-        result = self.ccmd()
+
+        result = self.packer_cmd()
         if mrf:
-            result.parsed_output = self._parse_inspection_output(
-                result.stdout)
+            result.parsed_output = self._parse_inspection_output(result.stdout)
+        else:
+            result.parsed_output = None
         return result
 
     def push(self, create=True, token=False):
         """Implmenets the `packer push` function
 
         UNTESTED! Must be used alongside an Atlas account
         """
-        self.ccmd = self.packer.push
+        self.packer_cmd = self.packer.push
+
         self._add_opt('-create=true' if create else None)
         self._add_opt('-tokn={0}'.format(token) if token else None)
         self._add_opt(self.packerfile)
-        return self.ccmd()
+
+        return self.packer_cmd()
 
     def validate(self, syntax_only=False):
         """Validates a Packer Template file (`packer validate`)
@@ -116,16 +128,18 @@ def validate(self, syntax_only=False):
         :param bool syntax_only: Whether to validate the syntax only
         without validating the configuration itself.
         """
-        self.ccmd = self.packer.validate
+        self.packer_cmd = self.packer.validate
+
         self._add_opt('-syntax-only' if syntax_only else None)
         self._append_base_arguments()
         self._add_opt(self.packerfile)
+
         # as sh raises an exception rather than return a value when execution
         # fails we create an object to return the exception and the validation
         # state
         try:
-            validation = self.ccmd()
-            validation.succeeded = True if validation.exit_code == 0 else False
+            validation = self.packer_cmd()
+            validation.succeeded = validation.exit_code == 0
             validation.error = None
         except Exception as ex:
             validation = ValidationObject()
@@ -146,7 +160,7 @@ def version(self):
 
     def _add_opt(self, option):
         if option:
-            self.ccmd = self.ccmd.bake(option)
+            self.packer_cmd = self.packer_cmd.bake(option)
 
     def _validate_argtype(self, arg, argtype):
         if not isinstance(arg, argtype):
@@ -164,47 +178,43 @@ def _append_base_arguments(self):
         if self.exc and self.only:
             raise PackerException('Cannot provide both "except" and "only"')
         elif self.exc:
-            self._add_opt('-except={0}'.format(self._joinc(self.exc)))
+            self._add_opt('-except={0}'.format(self._join_comma(self.exc)))
         elif self.only:
-            self._add_opt('-only={0}'.format(self._joinc(self.only)))
+            self._add_opt('-only={0}'.format(self._join_comma(self.only)))
         for var, value in self.vars.items():
             self._add_opt("-var '{0}={1}'".format(var, value))
         if self.var_file:
             self._add_opt('-var-file={0}'.format(self.var_file))
 
-    def _joinc(self, lst):
+    def _join_comma(self, lst):
         """Returns a comma delimited string from a list"""
         return str(','.join(lst))
 
-    def _joins(self, lst):
-        """Returns a space delimited string from a list"""
-        return str(' '.join(lst))
-
     def _parse_inspection_output(self, output):
         """Parses the machine-readable output `packer inspect` provides.
 
         See the inspect method for more info.
         This has been tested vs. Packer v0.7.5
         """
         parts = {'variables': [], 'builders': [], 'provisioners': []}
-        for l in output.splitlines():
-            l = l.split(',')
-            if l[2].startswith('template'):
-                del l[0:2]
-                component = l[0]
+        for line in output.splitlines():
+            line = line.split(',')
+            if line[2].startswith('template'):
+                del line[0:2]
+                component = line[0]
                 if component == 'template-variable':
-                    variable = {"name": l[1], "value": l[2]}
+                    variable = {"name": line[1], "value": line[2]}
                     parts['variables'].append(variable)
                 elif component == 'template-builder':
-                    builder = {"name": l[1], "type": l[2]}
+                    builder = {"name": line[1], "type": line[2]}
                     parts['builders'].append(builder)
                 elif component == 'template-provisioner':
-                    provisioner = {"type": l[1]}
+                    provisioner = {"type": line[1]}
                     parts['provisioners'].append(provisioner)
         return parts
 
 
-class Installer():
+class Installer(object):
     def __init__(self, packer_path, installer_path):
         self.packer_path = packer_path
         self.installer_path = installer_path
@@ -215,15 +225,15 @@ def install(self):
             for path in zip.namelist():
                 zip.extract(path, self.packer_path)
         exec_path = os.path.join(self.packer_path, 'packer')
-        if not self._verify(exec_path):
+        if not self._verify_packer_installed(exec_path):
             raise PackerException('packer installation failed. '
                                   'Executable could not be found under: '
                                   '{0}'.format(exec_path))
         else:
             return exec_path
 
-    def _verify(self, packer):
-        return True if os.path.isfile(packer) else False
+    def _verify_packer_installed(self, packer_path):
+        return os.path.isfile(packer_path)
 
 
 class ValidationObject():

TODO.md

@@ -1,10 +1,6 @@
-from setuptools import setup
-# from setuptools import find_packages
-from setuptools.command.test import test as testcommand
-import sys
-import re
 import os
 import codecs
+from setuptools import setup
 
 here = os.path.abspath(os.path.dirname(__file__))
 
@@ -13,45 +9,18 @@ def read(*parts):
     # intentionally *not* adding an encoding option to open
     return codecs.open(os.path.join(here, *parts), 'r').read()
 
-
-def find_version(*file_paths):
-    version_file = read(*file_paths)
-    version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
-                              version_file, re.M)
-    if version_match:
-        print('VERSION: ', version_match.group(1))
-        return version_match.group(1)
-    raise RuntimeError("Unable to find version string.")
-
-
-class Tox(testcommand):
-    def finalize_options(self):
-        testcommand.finalize_options(self)
-        self.test_args = []
-        self.test_suite = True
-
-    def run_tests(self):
-        # import here, cause outside the eggs aren't loaded
-        import tox
-        errcode = tox.cmdline(self.test_args)
-        sys.exit(errcode)
-
 setup(
     name='python-packer',
-    version=find_version('packer', '__init__.py'),
+    version='0.1.0',
     url='https://github.com/nir0s/python-packer',
     author='nir0s',
     author_email='nir36g@gmail.com',
     license='LICENSE',
     platforms='All',
     description='A Python interface for Hashicorp\'s Packer',
     long_description=read('README.rst'),
-    packages=['packer'],
-    install_requires=[
-        "sh==1.11",
-    ],
-    tests_require=['nose', 'tox'],
-    cmdclass={'test': Tox},
+    py_modules=['packer'],
+    install_requires=["sh==1.11"],
     classifiers=[
         'Programming Language :: Python',
         'Natural Language :: English',

packer/__init__.py renamed to packer.py

@@ -4,7 +4,7 @@
 import os
 
 PACKER_PATH = '/usr/bin/packer'
-TEST_RESOURCES_DIR = 'packer/tests/resources/'
+TEST_RESOURCES_DIR = 'tests/resources'
 TEST_PACKERFILE = os.path.join(TEST_RESOURCES_DIR, 'packerfile.json')
 TEST_BAD_PACKERFILE = os.path.join(TEST_RESOURCES_DIR, 'badpackerfile.json')
 
@@ -23,10 +23,6 @@ def test_inspect(self):
         p = packer.Packer(TEST_PACKERFILE)
         p.inspect()
 
-    def test_push(self):
-        p = packer.Packer(TEST_PACKERFILE)
-        p.push()
-
     def test_validate(self):
         p = packer.Packer(TEST_PACKERFILE)
         p.validate()

setup.py

@@ -5,15 +5,15 @@ envlist=flake8,py27,py26
 [testenv:py26]
 deps =
     -rdev-requirements.txt
-commands=nosetests --with-cov --cov-report term-missing --cov packer packer/tests -v
+commands=nosetests --with-cov --cov-report term-missing --cov packer tests -v
 
 [testenv:py27]
 deps =
     -rdev-requirements.txt
-commands=nosetests --with-cov --cov-report term-missing --cov packer packer/tests -v
+commands=nosetests --with-cov --cov-report term-missing --cov packer tests -v
 
 [testenv:flake8]
 deps =
     flake8
     -rdev-requirements.txt
-commands=flake8 packer
+commands=flake8 packer.py