add setup.py #1

Author: bekozi

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ben Koziol ([email protected])
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

requirements.txt

@@ -0,0 +1,2 @@
+boto
+setuptools

setup.py

@@ -0,0 +1,14 @@
+from setuptools import setup, find_packages
+
+
+setup(
+    name='aws',
+    version='0.01a',
+    packages=find_packages(where='./src'),
+    package_dir={'': 'src'},
+    url='https://github.com/bekozi/simple-aws',
+    license='MIT',
+    author='bekozi',
+    author_email='[email protected]',
+    description='A simple management interface to Amazon Web Services using boto.'
+)

src/simple-aws.conf.TEMPLATE renamed to simple-aws.conf.TEMPLATE

@@ -5,6 +5,7 @@
 import boto.ec2
 import time
 from boto.ec2.address import Address
+from exc import InstanceNameNotAvailable
 
 
 class AwsManager(object):
@@ -16,6 +17,10 @@ class AwsManager(object):
     """
 
     def __init__(self, conf_path=None, filtered=True, only_running=True, section_title='simple-aws'):
+        if conf_path is None:
+            msg = 'Path to configuration file required.'
+            raise ValueError(msg)
+
         self.conf_path = conf_path or os.path.expanduser(os.getenv('SIMPLEAWS_CONF_PATH'))
         self.filtered = filtered
         self.only_running = only_running
@@ -30,14 +35,27 @@ def conn(self):
             self._conn = self._get_aws_connection_()
         return self._conn
 
-    def get_instances(self):
+    def get_instances(self, key='id'):
+
+        def _get_key_(instance):
+            if key == 'id':
+                ret = instance.id
+            elif key == 'name':
+                try:
+                    ret = instance.tags['Name']
+                except KeyError:
+                    ret = instance.id
+            else:
+                raise NotImplementedError(key)
+            return ret
+
         reservations = self.conn.get_all_reservations()
         instances = [i for r in reservations for i in r.instances]
         instances = {i.id: i for i in instances}
         if self.only_running:
-            instances = {i.id: i for i in instances.values() if i.update() == 'running'}
+            instances = {_get_key_(i): i for i in instances.values() if i.update() == 'running'}
         if self.filtered:
-            instances = {i.id: i for i in instances.values() if self._filter_(i)}
+            instances = {_get_key_(i): i for i in instances.values() if self._filter_(i)}
         return instances
 
     def get_instance_by_name(self, name):
@@ -46,7 +64,7 @@ def get_instance_by_name(self, name):
             if instance.tags['Name'] == name:
                 ret = instance
         if ret is None:
-            raise ValueError('Name not found.')
+            raise InstanceNameNotAvailable('Name not found.')
         else:
             return ret
 
@@ -104,10 +122,12 @@ def start_instance_by_name(self, name, wait=True):
             self.only_running = prev_only_running
 
     @staticmethod
-    def wait_for_status(target, status_target, sleep=1):
+    def wait_for_status(target, status_target, sleep=1, pad=None):
         time.sleep(sleep)
         while target.update() != status_target:
             time.sleep(sleep)
+        if pad is not None:
+            time.sleep(pad)
 
     def _filter_(self, instance):
         if instance.key_name == self._cfg['key_name']:

src/aws.py

@@ -0,0 +1,6 @@
+class SimpleAwsException(Exception):
+    pass
+
+
+class InstanceNameNotAvailable(SimpleAwsException):
+    pass

src/exc.py

@@ -0,0 +1 @@
+__author__ = 'ben.koziol'

src/test/__init__.py

@@ -8,76 +8,83 @@
 
 
 class TestAwsManager(unittest.TestCase):
+    PREFIX = '_test_simple_aws_'
 
     @classmethod
     def tearDownClass(cls):
         m = AwsManager(CONF_PATH)
-        assert(m.get_instances() == {})
+        instances = m.get_instances(key='name')
+        for key in instances.iterkeys():
+            assert not key.startswith(cls.PREFIX)
 
-    def test_constructor(self):
+    @property
+    def iname(self):
+        return self.get_instance_name('foo')
+
+    def get_instance_name(self, suffix):
+        return '{0}{1}'.format(self.PREFIX, suffix)
+
+    def test_init(self):
         filtered = [True, False]
         only_running = [True, False]
         conf_path = [None, CONF_PATH]
         for f, a, c in itertools.product(filtered, only_running, conf_path):
             try:
                 m = AwsManager(c, filtered=f, only_running=a)
                 self.assertIsInstance(m._cfg, dict)
-            except TypeError:
+            except ValueError:
                 if c is None:
                     pass
                 else:
                     raise
 
     def test_get_instance_by_name(self):
         m = AwsManager(CONF_PATH)
-        i1 = m.launch_new_instance('_foo_name_test', wait=True)
+        i1 = m.launch_new_instance(self.iname, wait=True)
         try:
-            instance = m.get_instance_by_name('_foo_name_test')
-            self.assertEqual(instance.tags['Name'], '_foo_name_test')
+            instance = m.get_instance_by_name(self.iname)
+            self.assertEqual(instance.tags['Name'], self.iname)
         finally:
             i1.terminate()
 
     def test_start_instance_by_name(self):
         m = AwsManager(CONF_PATH)
-        i1 = m.launch_new_instance('_foo_name_test', wait=True)
+        i1 = m.launch_new_instance(self.iname, wait=True)
         try:
             i1.stop()
-            AwsManager.wait_for_status(i1, 'stopped')
-            instance = m.start_instance_by_name('_foo_name_test')
+            AwsManager.wait_for_status(i1, 'stopped', pad=20)
+            instance = m.start_instance_by_name(self.iname)
             self.assertEqual(instance.update(), 'running')
         finally:
             i1.terminate()
 
     def test_launch_instance_with_wait(self):
         m = AwsManager(CONF_PATH)
         # print('launching 1')
-        i1 = m.launch_new_instance('_foo_test_1')
-        self.assertEqual(i1.tags['Name'], '_foo_test_1')
+        name1 = self.get_instance_name('foo_test_1')
+        i1 = m.launch_new_instance(name1)
         # print('launching 2')
-        i2 = m.launch_new_instance('_foo_test_2')
+        i2 = m.launch_new_instance(self.get_instance_name('foo_test_2'))
         # print('instances launched')
         try:
-            instances = m.get_instances()
-            self.assertEqual(len(instances), 2)
-            self.assertEqual(set([i.update() for i in instances.values()]), set(['running']))
+            self.assertEqual(i1.update(), 'running')
+            self.assertEqual(i2.update(), 'running')
         finally:
             i1.terminate()
             i2.terminate()
-        self.assertEqual(m.get_instances(), {})
 
     def test_launch_instance_without_wait(self):
         m = AwsManager(CONF_PATH)
-        i1 = m.launch_new_instance('_foo_test_1', wait=False)
+        i1 = m.launch_new_instance(self.iname, wait=False)
         try:
             self.assertNotEqual(i1.update(), 'running')
         finally:
             i1.terminate()
-        self.assertEqual(m.get_instances(), {})
 
     def test_launch_new_instance_elastic_ip(self):
         elastic_ip = '54.68.61.218'
         m = AwsManager(CONF_PATH)
-        name = '_foo_test_elastic_ip'
+        name = self.get_instance_name('foo_test_elastic_ip')
         i1 = m.launch_new_instance(name, elastic_ip=elastic_ip)
         try:
             self.assertEqual(i1.ip_address, elastic_ip)
@@ -86,11 +93,11 @@ def test_launch_new_instance_elastic_ip(self):
 
     def test_name_must_be_unique(self):
         m = AwsManager(CONF_PATH)
-        self.assertEqual(m.get_instances(), {})
+        name = self.get_instance_name('foo_unique')
         try:
-            i1 = m.launch_new_instance('_foo_test_4', wait=True)
+            i1 = m.launch_new_instance(name, wait=True)
             with self.assertRaises(ValueError):
-                i2 = m.launch_new_instance('_foo_test_4', wait=True)
+                i2 = m.launch_new_instance(name, wait=True)
         finally:
             try:
                 i1.terminate()