Add 'bundle create' command

This requires API v1.2. Note that we don't update man pages in this
change. That will be done separately.

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

Author: stephenfin

git_pw/api.py

@@ -17,6 +17,8 @@
 from git_pw import config
 
 if 0:  # noqa
+    from typing import Any  # noqa
+    from typing import Callable  # noqa
     from typing import Dict  # noqa
     from typing import IO  # noqa
     from typing import List  # noqa
@@ -144,6 +146,23 @@ def _get(url, params=None, stream=False):
     return rsp
 
 
+def _post(url, data):
+    # type: (str, dict) -> requests.Response
+    """Make POST request and handle errors."""
+    LOG.debug('POST %s, data=%r', url, data)
+
+    try:
+        rsp = requests.post(url, auth=_get_auth(), headers=_get_headers(),
+                            data=data)
+        rsp.raise_for_status()
+    except requests.exceptions.RequestException as exc:
+        _handle_error('create', exc)
+
+    LOG.debug('Got response')
+
+    return rsp
+
+
 def _patch(url, data):
     # type: (str, dict) -> requests.Response
     """Make PATCH request and handle errors."""
@@ -270,6 +289,25 @@ def detail(resource_type, resource_id, params=None):
     return _get(url, params, stream=False).json()
 
 
+def create(resource_type, data):
+    # type: (str, dict) -> dict
+    """Create a new API resource.
+
+    POST /{resource}/
+
+    Arguments:
+        resource_type: The resource endpoint name.
+        params: Fields to update.
+
+    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, ''])
+
+    return _post(url, data).json()
+
+
 def update(resource_type, resource_id, data):
     # type: (str, int, dict) -> dict
     """Update a specific API resource.
@@ -290,6 +328,23 @@ def update(resource_type, resource_id, data):
     return _patch(url, data).json()
 
 
+def validate_minimum_version(min_version, msg):
+    # type: (Tuple[int, int], str) -> Callable[[Any], Any]
+
+    def inner(f):
+        @click.pass_context
+        def new_func(ctx, *args, **kwargs):
+            if version() < min_version:
+                LOG.error(msg)
+                sys.exit(1)
+
+            return ctx.invoke(f, *args, **kwargs)
+
+        return update_wrapper(new_func, f)
+
+    return inner
+
+
 def validate_multiple_filter_support(f):
 
     @click.pass_context

git_pw/bundle.py

@@ -77,17 +77,7 @@ def download_cmd(bundle_id, output):
         LOG.info('Downloaded bundle to %s', path)
 
 
-@click.command(name='show')
-@utils.format_options
-@click.argument('bundle_id')
-def show_cmd(fmt, bundle_id):
-    """Show information about bundle.
-
-    Retrieve Patchwork metadata for a bundle.
-    """
-    LOG.debug('Showing bundle: id=%s', bundle_id)
-
-    bundle = _get_bundle(bundle_id)
+def _show_bundle(bundle, fmt):
 
     def _format_patch(patch):
         return '%-4d %s' % (patch.get('id'), patch.get('name'))
@@ -108,6 +98,21 @@ def _format_patch(patch):
     utils.echo(output, ['Property', 'Value'], fmt=fmt)
 
 
+@click.command(name='show')
+@utils.format_options
+@click.argument('bundle_id')
+def show_cmd(fmt, bundle_id):
+    """Show information about bundle.
+
+    Retrieve Patchwork metadata for a bundle.
+    """
+    LOG.debug('Showing bundle: id=%s', bundle_id)
+
+    bundle = _get_bundle(bundle_id)
+
+    _show_bundle(bundle, fmt)
+
+
 @click.command(name='list')
 @click.option('--owner', metavar='OWNER', multiple=True,
               help='Show only bundles with these owners. Should be an email, '
@@ -162,3 +167,34 @@ def list_cmd(owner, limit, page, sort, fmt, headers, name):
             output[-1].append(item[idx])
 
     utils.echo_via_pager(output, headers, fmt=fmt)
+
+
+@click.command(name='create')
+@click.option('--public/--private', default=False,
+              help='Allow other users to view this bundle. If private, only '
+              'you will be able to see this bundle.')
+@click.argument('name')
+@click.argument('patch_ids', type=click.INT, nargs=-1, required=True)
+@api.validate_minimum_version(
+    (1, 2), 'Creating bundles is only supported from API version 1.2',
+)
+@utils.format_options
+def create_cmd(name, patch_ids, public, fmt):
+    """Create a bundle.
+
+    Create a bundle with the given NAME and patches from PATCH_ID.
+
+    Requires API version 1.2 or greater.
+    """
+    LOG.debug('Create bundle: name=%s, patches=%s, public=%s',
+              name, patch_ids, public)
+
+    data = [
+        ('name', name),
+        ('patches', patch_ids),
+        ('public', public),
+    ]
+
+    bundle = api.create('bundles', data)
+
+    _show_bundle(bundle, fmt)

git_pw/shell.py

@@ -122,4 +122,5 @@ 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.create_cmd)
 bundle.add_command(bundle_cmds.list_cmd)

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

@@ -0,0 +1,12 @@
+---
+features:
+  - |
+    The following ``bundle`` commands have been added:
+
+    - ``bundle create``
+
+    Together, these allow for creation, modification and deletion of bundles.
+    Bundles are custom, user-defined groups of patches that can be used to keep
+    patch lists, preserving order, for future inclusion in a tree.
+
+    These commands require API v1.2.

tests/test_bundle.py

@@ -308,3 +308,55 @@ def test_list_api_v1_1(self, mock_log, mock_echo, mock_index,
 
         # We shouldn't see a warning about multiple versions either
         assert not mock_log.warning.called
+
+
+@mock.patch('git_pw.api.version', return_value=(1, 2))
+@mock.patch('git_pw.api.create')
+@mock.patch('git_pw.utils.echo_via_pager')
+class CreateTestCase(unittest.TestCase):
+
+    @staticmethod
+    def _get_bundle(**kwargs):
+        return ShowTestCase._get_bundle(**kwargs)
+
+    def test_create(self, mock_echo, mock_create, mock_version):
+        """Validate standard behavior."""
+
+        mock_create.return_value = self._get_bundle()
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.create_cmd, ['hello', '1', '2'])
+
+        assert result.exit_code == 0, result
+        mock_create.assert_called_once_with(
+            'bundles',
+            [('name', 'hello'), ('patches', (1, 2)), ('public', False)]
+        )
+
+    def test_create_with_public(self, mock_echo, mock_create, mock_version):
+        """Validate behavior with --public option."""
+
+        mock_create.return_value = self._get_bundle()
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.create_cmd, [
+            'hello', '1', '2', '--public'])
+
+        assert result.exit_code == 0, result
+        mock_create.assert_called_once_with(
+            'bundles',
+            [('name', 'hello'), ('patches', (1, 2)), ('public', True)]
+        )
+
+    @mock.patch('git_pw.api.LOG')
+    def test_create_api_v1_1(
+        self, mock_log, mock_echo, mock_create, mock_version
+    ):
+
+        mock_version.return_value = (1, 1)
+
+        runner = CLIRunner()
+        result = runner.invoke(bundle.create_cmd, ['hello', '1', '2'])
+
+        assert result.exit_code == 1, result
+        assert mock_log.error.called