Add call to fetch units

Author: sukrit007

fleet/client/fleet_fabric.py

@@ -1,6 +1,8 @@
 from io import BytesIO
+
 from fleet.client import fleet_base
 
+
 __author__ = 'sukrit'
 
 from fabric.api import run, settings, put, hide
@@ -147,6 +149,50 @@ def destroy_units_matching(self, service_prefix):
                                 % service_prefix,
                         command_output=stream.getvalue())
 
+    def fetch_units_matching(self, service_prefix):
+        """
+        Fetch units matching prefix.
+
+        :param service_prefix:
+        :type service_prefix: str
+        :return: list of units where each unit is represented as dict
+            comprising of
+                - unit : Name of fleet unit,
+                - machine : Machine for the unit
+                - active : Activation status ('activating', 'active')
+                - sub : Current state of the unit
+        """
+        with self._fabric_wrapper() as stream:
+            with self._settings():
+                try:
+                    units_raw = run('fleetctl list-units -no-legend '
+                                    '-fields unit,machine,active,sub -full | '
+                                    'grep %s | awk \'{{print $1}}\'' %
+                                    service_prefix,
+                                    stdout=stream, stderr=stream,
+                                    warn_only=True)
+
+                    units = []
+
+                    for line in units_raw.splitlines():
+                        cols = line.split()
+                        if not cols:
+                            continue
+                        units.append({
+                            'unit': cols[0],
+                            'machine': cols[1],
+                            'active': cols[2],
+                            'sub': cols[3]
+                        })
+
+                    return units
+
+                except SystemExit:
+                    raise FleetExecutionException(
+                        message='Failed to Fetch units with prefix: %s'
+                                % service_prefix,
+                        command_output=stream.getvalue())
+
     def destroy(self, service):
         with self._fabric_wrapper() as stream:
             with self._settings():
@@ -165,7 +211,7 @@ def status(self, service_name):
                 try:
                     return run('fleetctl list-units | grep {} | '
                                'awk \'{{{{print $4}}}}\''.format(service_name),
-                                   stdout=stream, stderr=stream)
+                               stdout=stream, stderr=stream)
                 except SystemExit:
                     raise FleetExecutionException(
                         message='Failed to get status for unit: %s'

fleet/deploy/deployer.py

@@ -86,9 +86,32 @@ def deploy(self):
         self._deploy(service_name_prefix)
 
 
+def _get_service_prefix(name, version, service_type):
+    """
+    Gets the service prefix
+
+    :param name: Name of the application
+    :type name: str
+    :param version: Version of the application. If none, all versions are
+        undeployed.
+    :type version: str
+    :param service_type: Service type (e.g. 'app', 'logger' etc)
+    :type service_type: str
+    :return: Service Prefix
+    :rtype: str
+    """
+    if not version and not service_type:
+        return '%s-' % name
+    elif not service_type:
+        return '%s-%s-' % (name, version)
+    else:
+        return '%s-%s-%s@' % (name, version, service_type)
+
+
 def undeploy(fleet_provider, name, version=None, service_type=None):
     """
     Un-deploys the application from the fleet cluster.
+
     :param fleet_provider: Fleet provider for connecting to fleet cluster.
     :type fleet_provider: fleet.client.fleet_base.Provider
     :param name: Name of the application
@@ -98,23 +121,23 @@ def undeploy(fleet_provider, name, version=None, service_type=None):
     :type version: str
     :param service_type: Service type (e.g. 'app', 'logger' etc)
     :type service_type: str
-    :return: None
+    :return: List of fleet units (dict)
+    :rtype: list
     """
-    def get_service_prefix():
-        if not version and not service_type:
-            return '%s-' % name
-        elif not service_type:
-            return '%s-%s-' % (name, version)
-        else:
-            return '%s-%s-%s@' % (name, version, service_type)
 
-    service_prefix = get_service_prefix()
+    service_prefix = _get_service_prefix(name, version, service_type)
     fleet_provider.destroy_units_matching(service_prefix)
 
 
+def filter_units(fleet_provider, name, version=None, service_type=None):
+    service_prefix = _get_service_prefix(name, version, service_type)
+    return fleet_provider.fetch_units_matching(service_prefix)
+
+
 def status(fleet_provider, name, version, node_num, service_type='app'):
     """
     Gets the status for a node in cluster.
+
     :param fleet_provider:
     :param name:
     :param version:

tests/helper.py

@@ -0,0 +1,63 @@
+from nose.tools import ok_, eq_
+
+__author__ = 'sukrit'
+
+
+def dict_compare(actual, expected, key_path='',):
+    """
+    :param actual:
+    :param expected:
+    :param nested_path:
+    :return: None
+
+    >>> dict_compare('A', 'B')
+    Traceback (most recent call last):
+    ...
+    AssertionError: Actual 'A' != Expected 'B'  at path: ''
+
+    >>> dict_compare({}, 'B')
+    Traceback (most recent call last):
+    ...
+    AssertionError: Actual {} != Expected 'B'  at path: ''
+
+    >>> dict_compare({}, {})
+    True
+
+    >>> dict_compare({'key1':'value1'}, {'key2':'value2'})
+    Traceback (most recent call last):
+    ...
+    AssertionError: Key 'key1' was not expected at path: ''
+
+    >>> dict_compare({'key1':'value1', 'key2': 'value2'},
+    ... {'key2':'value2', 'key1': 'value1'})
+    True
+
+    >>> dict_compare({'key1':{'key1.1': 'value1.1', 'key1.2': 'value1.2'}},
+    ... {'key1':{'key1.2': 'value1.2', 'key1.1': 'value1.1'}})
+    True
+
+    >>> dict_compare({'key1':'value1'}, {'key2':'value2', 'key1':'value1'})
+    Traceback (most recent call last):
+    ...
+    AssertionError: Key 'key2' was not found in actual at path: ''
+
+    >>> dict_compare({'key1':'value1'}, {'key1':'value2'})
+    Traceback (most recent call last):
+    ...
+    AssertionError: Actual 'value1' != Expected 'value2'  at path: '.key1'
+
+    """
+
+    if isinstance(actual, dict) and isinstance(expected, dict):
+        for key in actual:
+            ok_(key in expected, 'Key \'%s\' was not expected at '
+                                 'path: \'%s\'' % (key, key_path))
+            dict_compare(actual[key], expected[key], '%s.%s' % (key_path, key))
+
+        for key in expected:
+            ok_(key in actual, 'Key \'%s\' was not found in actual at '
+                               'path: \'%s\'' % (key, key_path))
+    else:
+        eq_(actual, expected, 'Actual %r != Expected %r  at path: \'%s\''
+            % (actual, expected, key_path))
+    return True

tests/unit/client/__init__.py

@@ -0,0 +1 @@
+__author__ = 'sukrit'

tests/unit/client/test_fleet_fabric.py

@@ -0,0 +1,64 @@
+from mock import patch
+
+from fleet.client.fleet_fabric import Provider
+from tests.helper import dict_compare
+
+
+__author__ = 'sukrit'
+
+from nose.tools import eq_
+
+
+def _get_fleet_provider():
+    return Provider()
+
+
+@patch('fleet.client.fleet_fabric.run')
+def test_fetch_units_matching_with_no_match(mock_run):
+    """
+    Should return empty list when there are no matching units found
+    """
+    # Given: Fleet provider
+    provider = _get_fleet_provider()
+
+    # And no existing units for given service prefix
+    mock_run.return_value = ''
+
+    # When: I try to fetch units with no matching unit
+    units = provider.fetch_units_matching('non-existing-unit-')
+
+    # Then: Empty list is returned
+    eq_(units, [])
+
+
+@patch('fleet.client.fleet_fabric.run')
+def test_fetch_units_matching_with_multiple_match(mock_run):
+    """
+    Should return empty list when there are no matching units found
+    """
+    # Given: Fleet provider
+    provider = _get_fleet_provider()
+
+    # And no existing units for given service prefix
+    mock_run.return_value = '''[email protected]		442337f12da14ad7830cda843079730b/10.249.0.235	active	running
+[email protected]		0a5239ec591e4981905c792e99341f03/10.229.23.106	activating	start-pre
+    '''  # noqa
+
+    # When: I try to fetch units with no matching unit
+    units = provider.fetch_units_matching('cluster-deployer-develop-')
+
+    # Then: Empty list is returned
+    eq_(len(units), 2, 'Expecting 2 units to be returned. Found: %d' %
+        len(units))
+    dict_compare(units[0], {
+        'unit': '[email protected]',
+        'machine': '442337f12da14ad7830cda843079730b/10.249.0.235',
+        'active': 'active',
+        'sub': 'running'
+    })
+    dict_compare(units[1], {
+        'unit': '[email protected]',
+        'machine': '0a5239ec591e4981905c792e99341f03/10.229.23.106',
+        'active': 'activating',
+        'sub': 'start-pre'
+    })

tests/unit/deploy/test_deployer.py

@@ -1,9 +1,38 @@
+from nose.tools import eq_
+from fleet.deploy.deployer import _get_service_prefix
 
 
-def test_undeploy_with_defaults():
+def test_get_service_name_prefix_for_all_versions():
     """
-    Should undeploy application with all versions and service types.
+    Should get service name prefix for all versions
     """
 
-    # Given: Instance of fleet provider
-    pass
+    # When: I get service name prefix for all version
+    service_prefix = _get_service_prefix('test', None, None)
+
+    # Then: Expected value for service prefix is returned
+    eq_(service_prefix, 'test')
+
+
+def test_get_service_name_prefix_for_given_version():
+    """
+    Should get service name prefix for given version
+    """
+
+    # When: I get service name prefix for all version
+    service_prefix = _get_service_prefix('test', 'v1', None)
+
+    # Then: Expected value for service prefix is returned
+    eq_(service_prefix, 'test-v1')
+
+
+def test_get_service_name_prefix_for_given_type():
+    """
+    Should get service name prefix for given version
+    """
+
+    # When: I get service name prefix for all version
+    service_prefix = _get_service_prefix('test', 'v1', 'app')
+
+    # Then: Expected value for service prefix is returned
+    eq_(service_prefix, 'test-v1-app@')