Add 'bundle update' command

Signed-off-by: Stephen Finucane <stephen@that.guru>

Author: stephenfin

git_pw/api.py

@@ -24,6 +24,7 @@
     from typing import List  # noqa
     from typing import Optional  # noqa
     from typing import Tuple  # noqa
+    from typing import Union  # noqa
 
     Filters = List[Tuple[str, str]]
 
@@ -309,7 +310,7 @@ def create(resource_type, data):
 
 
 def update(resource_type, resource_id, data):
-    # type: (str, int, dict) -> dict
+    # type: (str, Union[int, str], dict) -> dict
     """Update a specific API resource.
 
     PATCH /{resource}/{resourceID}/

git_pw/bundle.py

@@ -198,3 +198,45 @@ def create_cmd(name, patch_ids, public, fmt):
     bundle = api.create('bundles', data)
 
     _show_bundle(bundle, fmt)
+
+
+@click.command(name='update')
+@click.option('--name')
+@click.option('--patch', 'patch_ids', type=click.INT, multiple=True,
+              help='Add the specified patch(es) to the bundle.')
+@click.option('--public/--private', default=None,
+              help='Allow other users to view this bundle. If private, only '
+              'you will be able to see this bundle.')
+@click.argument('bundle_id')
+@api.validate_minimum_version(
+    (1, 2), 'Updating bundles is only supported from API version 1.2',
+)
+@utils.format_options
+def update_cmd(bundle_id, name, patch_ids, public, fmt):
+    """Update a bundle.
+
+    Update a bundle on the Patchwork instance. If PATCH_IDs are specified, this
+    will overwrite all patches in the bundle. Use 'bundle add' and 'bundle
+    remove' to add or remove patches.
+
+    Requires API version 1.2 or greater.
+    """
+    LOG.debug(
+        'Updating bundle: id=%s, name=%s, patches=%s, public=%s',
+        bundle_id, name, patch_ids, public,
+    )
+
+    data = []
+
+    for key, value in [('name', name), ('public', public)]:
+        if value is None:
+            continue
+
+        data.append((key, value))
+
+    if patch_ids:  # special case patches to ignore the empty set
+        data.append(('patches', patch_ids))
+
+    bundle = api.update('bundles', bundle_id, data)
+
+    _show_bundle(bundle, fmt)

git_pw/shell.py

@@ -123,4 +123,5 @@ def bundle():
 bundle.add_command(bundle_cmds.show_cmd)
 bundle.add_command(bundle_cmds.download_cmd)
 bundle.add_command(bundle_cmds.create_cmd)
+bundle.add_command(bundle_cmds.update_cmd)
 bundle.add_command(bundle_cmds.list_cmd)

releasenotes/notes/bundle-crud-47aadae6eb7a20ad.yaml

@@ -4,6 +4,7 @@ features:
     The following ``bundle`` commands have been added:
 
     - ``bundle create``
+    - ``bundle update``
 
     Together, these allow for creation, modification and deletion of bundles.
     Bundles are custom, user-defined groups of patches that can be used to keep

tests/test_bundle.py

@@ -145,7 +145,17 @@ def _get_bundle(**kwargs):
             'project': {
                 'name': 'bar',
             },
-            'patches': [],
+            'patches': [
+                {
+                    'id': 42,
+                    'date': '2017-01-01 00:00:00',
+                    'web_url': 'https://example.com/project/foo/patch/123/',
+                    'msgid': '<hello@example.com>',
+                    'list_archive_url': None,
+                    'name': 'Test',
+                    'mbox': 'https://example.com/project/foo/patch/123/mbox/',
+                },
+            ],
             'public': True,
         }
 
@@ -360,3 +370,58 @@ def test_create_api_v1_1(
 
         assert result.exit_code == 1, result
         assert mock_log.error.called
+
+
+@mock.patch('git_pw.api.version', return_value=(1, 2))
+@mock.patch('git_pw.api.update')
+@mock.patch('git_pw.api.detail')
+@mock.patch('git_pw.utils.echo_via_pager')
+class UpdateTestCase(unittest.TestCase):
+
+    @staticmethod
+    def _get_bundle(**kwargs):
+        return ShowTestCase._get_bundle(**kwargs)
+
+    def test_update(self, mock_echo, mock_detail, mock_update, mock_version):
+        """Validate standard behavior."""
+
+        mock_update.return_value = self._get_bundle()
+
+        runner = CLIRunner()
+        result = runner.invoke(
+            bundle.update_cmd,
+            ['1', '--name', 'hello', '--patch', '1', '--patch', '2'],
+        )
+
+        assert result.exit_code == 0, result
+        mock_detail.assert_not_called()
+        mock_update.assert_called_once_with(
+            'bundles', '1', [('name', 'hello'), ('patches', (1, 2))]
+        )
+
+    def test_update_with_public(
+        self, mock_echo, mock_detail, mock_update, mock_version,
+    ):
+        """Validate behavior with --public option."""
+
+        mock_update.return_value = self._get_bundle()
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.update_cmd, ['1', '--public'])
+
+        assert result.exit_code == 0, result
+        mock_detail.assert_not_called()
+        mock_update.assert_called_once_with('bundles', '1', [('public', True)])
+
+    @mock.patch('git_pw.api.LOG')
+    def test_update_api_v1_1(
+        self, mock_log, mock_echo, mock_detail, mock_update, mock_version,
+    ):
+
+        mock_version.return_value = (1, 1)
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.update_cmd, ['1', '--name', 'hello'])
+
+        assert result.exit_code == 1, result
+        assert mock_log.error.called