Add 'bundle add', 'bundle remove' commands

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

Author: stephenfin

git_pw/bundle.py

@@ -215,9 +215,9 @@ def create_cmd(name, patch_ids, public, fmt):
 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.
+    Update bundle BUNDLE_ID. 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.
     """
@@ -258,3 +258,62 @@ def delete_cmd(bundle_id, fmt):
     LOG.debug('Delete bundle: id=%s', bundle_id)
 
     api.delete('bundles', bundle_id)
+
+
+@click.command(name='add')
+@click.argument('bundle_id')
+@click.argument('patch_ids', type=click.INT, nargs=-1, required=True)
+@api.validate_minimum_version(
+    (1, 2), 'Modifying bundles is only supported from API version 1.2',
+)
+@utils.format_options
+def add_cmd(bundle_id, patch_ids, fmt):
+    """Add one or more patches to a bundle.
+
+    Append the provided PATCH_IDS to bundle BUNDLE_ID.
+
+    Requires API version 1.2 or greater.
+    """
+    LOG.debug('Add to bundle: id=%s, patches=%s', bundle_id, patch_ids)
+
+    bundle = _get_bundle(bundle_id)
+
+    data = [
+        ('patches', patch_ids + tuple([p['id'] for p in bundle['patches']])),
+    ]
+
+    bundle = api.update('bundles', bundle_id, data)
+
+    _show_bundle(bundle, fmt)
+
+
+@click.command(name='remove')
+@click.argument('bundle_id')
+@click.argument('patch_ids', type=click.INT, nargs=-1, required=True)
+@api.validate_minimum_version(
+    (1, 2), 'Modifying bundles is only supported from API version 1.2',
+)
+@utils.format_options
+def remove_cmd(bundle_id, patch_ids, fmt):
+    """Remove one or more patches from a bundle.
+
+    Remove the provided PATCH_IDS to bundle BUNDLE_ID.
+
+    Requires API version 1.2 or greater.
+    """
+    LOG.debug('Remove from bundle: id=%s, patches=%s', bundle_id, patch_ids)
+
+    bundle = _get_bundle(bundle_id)
+
+    patches = [p['id'] for p in bundle['patches'] if p['id'] not in patch_ids]
+    if not patches:
+        LOG.error(
+            'Bundles cannot be empty. Consider deleting the bundle instead'
+        )
+        sys.exit(1)
+
+    data = [('patches', tuple(patches))]
+
+    bundle = api.update('bundles', bundle_id, data)
+
+    _show_bundle(bundle, fmt)

git_pw/shell.py

@@ -126,3 +126,5 @@ def bundle():
 bundle.add_command(bundle_cmds.create_cmd)
 bundle.add_command(bundle_cmds.update_cmd)
 bundle.add_command(bundle_cmds.delete_cmd)
+bundle.add_command(bundle_cmds.add_cmd)
+bundle.add_command(bundle_cmds.remove_cmd)

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

@@ -6,6 +6,8 @@ features:
     - ``bundle create``
     - ``bundle update``
     - ``bundle delete``
+    - ``bundle add``
+    - ``bundle remove``
 
     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

@@ -456,3 +456,108 @@ def test_delete_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 AddTestCase(unittest.TestCase):
+
+    @staticmethod
+    def _get_bundle(**kwargs):
+        return ShowTestCase._get_bundle(**kwargs)
+
+    def test_add(
+        self, mock_echo, mock_detail, mock_update, mock_version,
+    ):
+        """Validate standard behavior."""
+
+        mock_detail.return_value = self._get_bundle()
+        mock_update.return_value = self._get_bundle()
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.add_cmd, ['1', '1', '2'])
+
+        assert result.exit_code == 0, result
+        mock_detail.assert_called_once_with('bundles', '1')
+        mock_update.assert_called_once_with(
+            'bundles', '1', [('patches', (1, 2, 42))],
+        )
+
+    @mock.patch('git_pw.api.LOG')
+    def test_add_api_v1_1(
+        self, mock_log, mock_echo, mock_detail, mock_update, mock_version,
+    ):
+        """Validate behavior with API v1.1."""
+
+        mock_version.return_value = (1, 1)
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.add_cmd, ['1', '1', '2'])
+
+        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 RemoveTestCase(unittest.TestCase):
+
+    @staticmethod
+    def _get_bundle(**kwargs):
+        return ShowTestCase._get_bundle(**kwargs)
+
+    def test_remove(
+        self, mock_echo, mock_detail, mock_update, mock_version,
+    ):
+        """Validate standard behavior."""
+
+        mock_detail.return_value = self._get_bundle(
+            patches=[{'id': 1}, {'id': 2}, {'id': 3}],
+        )
+        mock_update.return_value = self._get_bundle()
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.remove_cmd, ['1', '1', '2'])
+
+        assert result.exit_code == 0, result
+        mock_detail.assert_called_once_with('bundles', '1')
+        mock_update.assert_called_once_with(
+            'bundles', '1', [('patches', (3,))],
+        )
+
+    @mock.patch('git_pw.bundle.LOG')
+    def test_remove_empty(
+        self, mock_log, mock_echo, mock_detail, mock_update, mock_version,
+    ):
+        """Validate behavior when deleting would remove all patches."""
+
+        mock_detail.return_value = self._get_bundle(
+            patches=[{'id': 1}, {'id': 2}, {'id': 3}],
+        )
+        mock_update.return_value = self._get_bundle()
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.remove_cmd, ['1', '1', '2', '3'])
+
+        assert result.exit_code == 1, result.output
+        assert mock_log.error.called
+        mock_detail.assert_called_once_with('bundles', '1')
+        mock_update.assert_not_called()
+
+    @mock.patch('git_pw.api.LOG')
+    def test_remove_api_v1_1(
+        self, mock_log, mock_echo, mock_detail, mock_update, mock_version,
+    ):
+        """Validate behavior with API v1.1."""
+
+        mock_version.return_value = (1, 1)
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.remove_cmd, ['1', '1', '2'])
+
+        assert result.exit_code == 1, result
+        assert mock_log.error.called