Require project configuration

99% of users are going to want to filter on a specific project. Make
life easier for these folks by altering them to potential
misconfigurations.

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

Author: stephenfin

git_pw/api.py

@@ -60,6 +60,19 @@ def _get_server():  # type: () -> str
         sys.exit(1)
 
 
+def _get_project():  # type: () -> str
+    if CONF.project and CONF.project.strip() == '*':
+        return ''  # just don't bother filtering on project
+    elif CONF.project:
+        return CONF.project.strip()
+    else:
+        LOG.error('Project information missing')
+        LOG.error('You must provide project information via git-config or '
+                  'via --project')
+        LOG.error('To list all projects, set project to "*"')
+        sys.exit(1)
+
+
 def get(url, params=None):  # type: (str, dict) -> requests.Response
     """Make GET request and handle errors."""
     LOG.debug('GET %s', url)
@@ -131,6 +144,11 @@ def index(resource_type, params=None):  # type: (str, dict) -> dict
     # NOTE(stephenfin): All resources must have a trailing '/'
     url = '/'.join([_get_server(), 'api', resource_type, ''])
 
+    # NOTE(stephenfin): Not all endpoints in the Patchwork API allow filtering
+    # by project, but all the ones we care about here do.
+    params = params or []
+    params.append(('project', _get_project()))
+
     return get(url, params).json()
 
 

git_pw/bundle.py

@@ -10,10 +10,8 @@
 from tabulate import tabulate
 
 from git_pw import api
-from git_pw import config
 from git_pw import utils
 
-CONF = config.CONF
 LOG = logging.getLogger(__name__)
 
 
@@ -122,7 +120,6 @@ def list_cmd(owner, limit, page, sort, name):
 
     params.extend([
         ('q', name),
-        ('project', CONF.project),
         ('page', page),
         ('per_page', limit),
         ('order', sort),

git_pw/patch.py

@@ -11,10 +11,8 @@
 from tabulate import tabulate
 
 from git_pw import api
-from git_pw import config
 from git_pw import utils
 
-CONF = config.CONF
 LOG = logging.getLogger(__name__)
 
 
@@ -224,7 +222,6 @@ def list_cmd(state, submitter, delegate, archived, limit, page, sort, name):
 
     params.extend([
         ('q', name),
-        ('project', CONF.project),
         # TODO(stephenfin): Perhaps we could use string values. Refer to
         # https://github.com/carltongibson/django-filter/pull/378
         ('archived', 3 if archived else 1),

git_pw/series.py

@@ -11,10 +11,8 @@
 from tabulate import tabulate
 
 from git_pw import api
-from git_pw import config
 from git_pw import utils
 
-CONF = config.CONF
 LOG = logging.getLogger(__name__)
 
 
@@ -131,7 +129,6 @@ def list_cmd(submitter, limit, page, sort, name):
 
     params.extend([
         ('q', name),
-        ('project', CONF.project),
         ('page', page),
         ('per_page', limit),
         ('order', sort),

releasenotes/notes/enforce-filtering-by-project-59ed29c4b7edc0a5.yaml

@@ -0,0 +1,9 @@
+---
+upgrade:
+  - |
+    Project configuration, e.g. via ``git config pw.project``, is now required.
+    Previously, not configuring a project would result in items for for all
+    projects being listed. This did not scale for larger instances such as
+    `patchwork.ozlabs.org` and proved confusing for some users. If this
+    functionality is required, you must explicitly request it using the ``*``
+    character, e.g. ``git pw patch list --project='*'``.