Add 'bundle delete' command

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

Author: stephenfin

git_pw/api.py

@@ -181,6 +181,22 @@ def _patch(url, data):
     return rsp
 
 
+def _delete(url):
+    # type: (str) -> requests.Response
+    """Make DELETE request and handle errors."""
+    LOG.debug('DELETE %s', url)
+
+    try:
+        rsp = requests.delete(url, auth=_get_auth(), headers=_get_headers())
+        rsp.raise_for_status()
+    except requests.exceptions.RequestException as exc:
+        _handle_error('delete', exc)
+
+    LOG.debug('Got response')
+
+    return rsp
+
+
 def version():
     # type: () -> Optional[Tuple[int, int]]
     """Get the version of the server from the URL, if present."""
@@ -309,6 +325,25 @@ def create(resource_type, data):
     return _post(url, data).json()
 
 
+def delete(resource_type, resource_id):
+    # type: (str, Union[str, int]) -> None
+    """Delete a specific API resource.
+
+    DELETE /{resource}/{resourceID}/
+
+    Arguments:
+        resource_type: The resource endpoint name.
+        resource_id: The ID for the specific resource.
+
+    Returns:
+        A dictionary representing the detailed view of a given resource.
+    """
+    # NOTE(stephenfin): All resources must have a trailing '/'
+    url = '/'.join([_get_server(), resource_type, str(resource_id), ''])
+
+    _delete(url)
+
+
 def update(resource_type, resource_id, data):
     # type: (str, Union[int, str], dict) -> dict
     """Update a specific API resource.

git_pw/bundle.py

@@ -240,3 +240,21 @@ def update_cmd(bundle_id, name, patch_ids, public, fmt):
     bundle = api.update('bundles', bundle_id, data)
 
     _show_bundle(bundle, fmt)
+
+
+@click.command(name='delete')
+@click.argument('bundle_id')
+@api.validate_minimum_version(
+    (1, 2), 'Deleting bundles is only supported from API version 1.2',
+)
+@utils.format_options
+def delete_cmd(bundle_id, fmt):
+    """Delete a bundle.
+
+    Delete bundle BUNDLE_ID.
+
+    Requires API version 1.2 or greater.
+    """
+    LOG.debug('Delete bundle: id=%s', bundle_id)
+
+    api.delete('bundles', bundle_id)

git_pw/shell.py

@@ -122,6 +122,7 @@ def bundle():
 bundle.add_command(bundle_cmds.apply_cmd)
 bundle.add_command(bundle_cmds.show_cmd)
 bundle.add_command(bundle_cmds.download_cmd)
+bundle.add_command(bundle_cmds.list_cmd)
 bundle.add_command(bundle_cmds.create_cmd)
 bundle.add_command(bundle_cmds.update_cmd)
-bundle.add_command(bundle_cmds.list_cmd)
+bundle.add_command(bundle_cmds.delete_cmd)

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

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

@@ -425,3 +425,34 @@ def test_update_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.delete')
+@mock.patch('git_pw.utils.echo_via_pager')
+class DeleteTestCase(unittest.TestCase):
+
+    def test_delete(self, mock_echo, mock_delete, mock_version):
+        """Validate standard behavior."""
+
+        mock_delete.return_value = None
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.delete_cmd, ['hello'])
+
+        assert result.exit_code == 0, result
+        mock_delete.assert_called_once_with('bundles', 'hello')
+
+    @mock.patch('git_pw.api.LOG')
+    def test_delete_api_v1_1(
+        self, mock_log, mock_echo, mock_delete, mock_version,
+    ):
+        """Validate standard behavior."""
+
+        mock_version.return_value = (1, 1)
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.delete_cmd, ['hello'])
+
+        assert result.exit_code == 1, result
+        assert mock_log.error.called