Merge lp:~matiasb/click-toolbelt/get-channel-details into lp:click-toolbelt

[Matias Bordese]

Added initial command for channels handling.

[Ricardo Kirkner (ricardokirkner)]

LGTM

review: Approve

=== added file 'click_toolbelt/channels.py'
--- click_toolbelt/channels.py	1970-01-01 00:00:00 +0000
+++ click_toolbelt/channels.py	2015-12-04 18:34:17 +0000
@@ -0,0 +1,64 @@
+# Copyright 2015 Canonical Ltd.  This software is licensed under the
+# GNU General Public License version 3 (see the file LICENSE).
+from __future__ import absolute_import, unicode_literals
+import logging
+import os
+
+from click_toolbelt.common import (
+    AuthenticatedCommand,
+    CommandError,
+)
+from click_toolbelt.compat import urljoin
+from click_toolbelt.constants import MYAPPS_API_ROOT_URL
+
+
+class Channels(AuthenticatedCommand):
+    """Get/Update channels configuration for a package."""
+
+    log = logging.getLogger(__name__)
+
+    def get_parser(self, prog_name):
+        parser = super(Channels, self).get_parser(prog_name)
+        parser.add_argument('package_name')
+        return parser
+
+    def get_channels(self, session, package_name):
+        """Get current channels config for package through API."""
+        result = {'success': False, 'errors': [], 'data': None}
+        myapps_url = os.environ.get('MYAPPS_API_ROOT_URL', MYAPPS_API_ROOT_URL)
+        channels_endpoint = urljoin(
+            myapps_url, 'package-channels/%s/' % package_name)
+
+        response = session.get(channels_endpoint)
+        if response.ok:
+            result['success'] = True
+            result['data'] = response.json()
+        else:
+            result['errors'] = [response.text]
+        return result
+
+    def take_action(self, parsed_args):
+        package_name = parsed_args.package_name
+
+        session = self.get_oauth_session()
+        if session is None:
+            self.log.info('No valid credentials found.')
+            # raise an exception to exit with proper code
+            raise CommandError()
+
+        result = self.get_channels(session, package_name)
+
+        if not result.get('success', False):
+            self.log.info(
+                'Could not get information. An error ocurred:\n\n%s\n\n',
+                '\n'.join(result['errors']))
+            # raise an exception to exit with proper code
+            raise CommandError()
+
+        data = result['data']
+        for config in data:
+            value = config.get('current')
+            if value is not None:
+                value = 'Sequence %d (version %s)' % (
+                    value.get('sequence'), value.get('version'))
+            self.log.info('%s: %s', config.get('channel'), value)

=== added file 'click_toolbelt/tests/test_channels.py'
--- click_toolbelt/tests/test_channels.py	1970-01-01 00:00:00 +0000
+++ click_toolbelt/tests/test_channels.py	2015-12-04 18:34:17 +0000
@@ -0,0 +1,128 @@
+# -*- coding: utf-8 -*-
+# Copyright 2015 Canonical Ltd.  This software is licensed under the
+# GNU General Public License version 3 (see the file LICENSE).
+from __future__ import absolute_import, unicode_literals
+from collections import namedtuple
+from unittest import TestCase
+
+from mock import call, patch
+
+from click_toolbelt.common import CommandError
+from click_toolbelt.channels import (
+    Channels,
+)
+
+
+class ChannelsCommandTestCase(TestCase):
+
+    def setUp(self):
+        super(ChannelsCommandTestCase, self).setUp()
+        app = None
+        args = None
+        self.command = Channels(app, args)
+
+        patcher = patch('click_toolbelt.channels.Channels.log')
+        self.mock_log = patcher.start()
+        self.addCleanup(patcher.stop)
+
+        oauth_session = 'click_toolbelt.channels.Channels.get_oauth_session'
+        patcher = patch(oauth_session)
+        self.mock_get_oauth_session = patcher.start()
+        self.mock_session = self.mock_get_oauth_session.return_value
+        self.mock_get = self.mock_session.get
+        self.mock_response = self.mock_get.return_value
+        self.addCleanup(patcher.stop)
+
+        self.parsed_args = namedtuple('parsed_args', 'package_name')
+        self.args = self.parsed_args('package.name')
+
+        self.channels_data = [
+            {'channel': 'stable', 'current': {'sequence': 2, 'version': '1'}},
+            {'channel': 'beta', 'current': {'sequence': 4, 'version': '1.5'}},
+            {'channel': 'edge', 'current': None},
+        ]
+
+    def set_channels_success_response(self):
+        self.mock_response.ok = True
+        self.mock_response.json.return_value = self.channels_data
+
+    def set_channels_error_response(self, error_msg):
+        self.mock_response.ok = False
+        self.mock_response.text = error_msg
+
+    def test_parser(self):
+        parser = self.command.get_parser('prog_name')
+        # only one argument -- the first item is the default help option
+        self.assertEqual(len(parser._actions), 2)
+        self.assertEqual(parser._actions[0].dest, 'help')
+        # package_name is optional
+        self.assertEqual(parser._actions[1].dest, 'package_name')
+        self.assertTrue(parser._actions[1].required)
+
+    def test_get_channels(self):
+        self.set_channels_success_response()
+
+        data = self.command.get_channels(self.mock_session, 'package.name')
+
+        expected = {
+            'success': True,
+            'errors': [],
+            'data': self.channels_data,
+        }
+        self.assertEqual(data, expected)
+
+    def test_get_channels_with_error_response(self):
+        error_msg = 'some error'
+        self.set_channels_error_response(error_msg)
+
+        data = self.command.get_channels(self.mock_session, 'package.name')
+
+        expected = {
+            'success': False,
+            'errors': [error_msg],
+            'data': None,
+        }
+        self.assertEqual(data, expected)
+
+    def test_get_channels_uses_environment_variables(self):
+        with patch('click_toolbelt.channels.os.environ',
+                   {'MYAPPS_API_ROOT_URL': 'http://example.com'}):
+            self.command.get_channels(self.mock_session, 'package.name')
+        self.mock_get.assert_called_once_with(
+            'http://example.com/package-channels/package.name/')
+
+    def test_take_action_invalid_credentials(self):
+        self.mock_get_oauth_session.return_value = None
+
+        with self.assertRaises(CommandError):
+            self.command.take_action(self.args)
+
+        self.mock_log.info.assert_called_once_with(
+            'No valid credentials found.')
+
+    def test_take_action(self):
+        self.set_channels_success_response()
+
+        self.command.take_action(self.args)
+
+        expected_calls = []
+        for config in self.channels_data:
+            expected = None
+            upload = config['current']
+            if upload is not None:
+                expected = 'Sequence %d (version %s)' % (
+                    upload['sequence'], upload['version'])
+            channel_call = call('%s: %s', config['channel'], expected)
+            expected_calls.append(channel_call)
+        self.assertEqual(self.mock_log.info.call_args_list, expected_calls)
+
+    def test_take_action_with_error(self):
+        error_msg = 'some error'
+        self.set_channels_error_response(error_msg)
+
+        with self.assertRaises(CommandError):
+            self.command.take_action(self.args)
+
+        self.mock_log.info.assert_called_once_with(
+            'Could not get information. An error ocurred:\n\n%s\n\n',
+            'some error')

=== modified file 'click_toolbelt/tests/test_upload.py'
--- click_toolbelt/tests/test_upload.py	2015-12-03 14:45:57 +0000
+++ click_toolbelt/tests/test_upload.py	2015-12-04 18:34:17 +0000
@@ -5,7 +5,6 @@
 import os
 import tempfile
 from collections import namedtuple
-from unittest import TestCase, skip
 
 from mock import ANY, DEFAULT, patch
 from requests import Response

=== modified file 'setup.py'
--- setup.py	2015-09-23 12:40:58 +0000
+++ setup.py	2015-12-04 18:34:17 +0000
@@ -61,6 +61,7 @@
             'login = click_toolbelt.login:Login',
             'upload = click_toolbelt.upload:Upload',
             'info = click_toolbelt.info:Info',
+            'channels = click_toolbelt.channels:Channels',
         ],
     },