From 01c1a400b8396acb56c24e6e9bd5ecf5d40b4411 Mon Sep 17 00:00:00 2001
From: Adam Williamson <awilliam@redhat.com>
Date: Nov 16 2016 22:02:03 +0000
Subject: Handle namespaced projects in SSE server
The SSE server's code for parsing the URL to get to the project
does not handle namespacing. With this, it does. I tried to
figure out the 'rules' for the path as best I could from other
code in the project.
Also refactor a bit to split out a path parsing function and
separate object finding functions, and be more explicit about
the specific object types we support.
Also add a test suite for the streaming server, and update all
docs, Ansible play, spec file etc. for the rename from
'pagure-stream-server' to 'pagure_stream_server'.
Fixes https://pagure.io/pagure/issue/1532
Signed-off-by: Adam Williamson <awilliam@redhat.com>
---
diff --git a/ansible/roles/pagure-dev/files/pagure_ev.service b/ansible/roles/pagure-dev/files/pagure_ev.service
index 3ee6697..573f99d 100644
--- a/ansible/roles/pagure-dev/files/pagure_ev.service
+++ b/ansible/roles/pagure-dev/files/pagure_ev.service
@@ -6,7 +6,7 @@ Documentation=https://pagure.io/pagure
[Service]
Environment="PAGURE_CONFIG=/home/vagrant/pagure.cfg"
ExecStart=/home/vagrant/.virtualenvs/python2-pagure/bin/python \
- /home/vagrant/devel/ev-server/pagure-stream-server.py
+ /home/vagrant/devel/ev-server/pagure_stream_server.py
Type=simple
[Install]
diff --git a/doc/install_evs.rst b/doc/install_evs.rst
index 0ccbcc9..0ba7edc 100644
--- a/doc/install_evs.rst
+++ b/doc/install_evs.rst
@@ -28,7 +28,7 @@ The eventsource server is easy to set-up.
+----------------------------------------+-----------------------------------------------------+
| Source | Destination |
+========================================+=====================================================+
-| ``ev-server/pagure-stream-server.py`` | ``/usr/libexec/pagure-ev/pagure-stream-server.py`` |
+| ``ev-server/pagure_stream_server.py`` | ``/usr/libexec/pagure-ev/pagure_stream_server.py`` |
+----------------------------------------+-----------------------------------------------------+
| ``ev-server/pagure_ev.service`` | ``/etc/systemd/system/pagure_ev.service`` |
+----------------------------------------+-----------------------------------------------------+
diff --git a/ev-server/pagure-stream-server.py b/ev-server/pagure-stream-server.py
deleted file mode 100644
index 746de60..0000000
--- a/ev-server/pagure-stream-server.py
+++ /dev/null
@@ -1,248 +0,0 @@
-#!/usr/bin/env python
-
-"""
- (c) 2015 - Copyright Red Hat Inc
-
- Authors:
- Pierre-Yves Chibon <pingou@pingoured.fr>
-
-
-Streaming server for pagure's eventsource feature
-This server takes messages sent to redis and publish them at the specified
-endpoint
-
-To test, run this script and in another terminal
-nc localhost 8080
- HELLO
-
- GET /test/issue/26?foo=bar HTTP/1.1
-
-"""
-
-import datetime
-import logging
-import os
-import urlparse
-
-import trollius
-import trollius_redis
-
-log = logging.getLogger(__name__)
-
-
-if 'PAGURE_CONFIG' not in os.environ \
- and os.path.exists('/etc/pagure/pagure.cfg'):
- print 'Using configuration file `/etc/pagure/pagure.cfg`'
- os.environ['PAGURE_CONFIG'] = '/etc/pagure/pagure.cfg'
-
-
-import pagure
-import pagure.lib
-from pagure.exceptions import PagureEvException
-
-SERVER = None
-
-def get_obj_from_path(path):
- """ Return the Ticket or Request object based on the path provided.
- """
- username = None
- try:
- if path.startswith('/fork'):
- username, repo, obj, objid = path.split('/')[2:6]
- else:
- repo, obj, objid = path.split('/')[1:4]
- except:
- raise PagureEvException("Invalid URL: %s" % path)
-
- repo = pagure.lib.get_project(pagure.SESSION, repo, user=username)
-
- if repo is None:
- raise PagureEvException("Project '%s' not found" % repo)
-
- output = None
- if obj == 'issue':
- if not repo.settings.get('issue_tracker', True):
- raise PagureEvException("No issue tracker found for this project")
-
- output = pagure.lib.search_issues(
- pagure.SESSION, repo, issueid=objid)
-
- if output is None or output.project != repo:
- raise PagureEvException("Issue '%s' not found" % objid)
-
- if output.private:
- # TODO: find a way to do auth
- raise PagureEvException(
- "This issue is private and you are not allowed to view it")
- elif obj == 'pull-request':
- if not repo.settings.get('pull_requests', True):
- raise PagureEvException(
- "No pull-request tracker found for this project")
-
- output = pagure.lib.search_pull_requests(
- pagure.SESSION, project_id=repo.id, requestid=objid)
-
- if output is None or output.project != repo:
- raise PagureEvException("Pull-Request '%s' not found" % objid)
-
- else:
- raise PagureEvException("Invalid object provided: '%s'" % obj)
-
- return output
-
-
-@trollius.coroutine
-def handle_client(client_reader, client_writer):
- data = None
- while True:
- # give client a chance to respond, timeout after 10 seconds
- line = yield trollius.From(trollius.wait_for(
- client_reader.readline(),
- timeout=10.0))
- if not line.decode().strip():
- break
- line = line.decode().rstrip()
- if data is None:
- data = line
-
- if data is None:
- log.warning("Expected ticket uid, received None")
- return
-
- data = data.decode().rstrip().split()
- log.info("Received %s", data)
- if not data:
- log.warning("No URL provided: %s" % data)
- return
-
- if not '/' in data[1]:
- log.warning("Invalid URL provided: %s" % data[1])
- return
-
- url = urlparse.urlsplit(data[1])
-
- try:
- obj = get_obj_from_path(url.path)
- except PagureEvException as err:
- log.warning(err.message)
- return
-
- origin = pagure.APP.config.get('APP_URL')
- if origin.endswith('/'):
- origin = origin[:-1]
-
- client_writer.write((
- "HTTP/1.0 200 OK\n"
- "Content-Type: text/event-stream\n"
- "Cache: nocache\n"
- "Connection: keep-alive\n"
- "Access-Control-Allow-Origin: %s\n\n" % origin
- ).encode())
-
- connection = yield trollius.From(trollius_redis.Connection.create(
- host=pagure.APP.config['REDIS_HOST'],
- port=pagure.APP.config['REDIS_PORT'],
- db=pagure.APP.config['REDIS_DB']))
-
- try:
-
- # Create subscriber.
- subscriber = yield trollius.From(connection.start_subscribe())
-
- # Subscribe to channel.
- yield trollius.From(subscriber.subscribe(['pagure.%s' % obj.uid]))
-
- # Inside a while loop, wait for incoming events.
- while True:
- reply = yield trollius.From(subscriber.next_published())
- #print(u'Received: ', repr(reply.value), u'on channel', reply.channel)
- log.info(reply)
- log.info("Sending %s", reply.value)
- client_writer.write(('data: %s\n\n' % reply.value).encode())
- yield trollius.From(client_writer.drain())
-
- except trollius.ConnectionResetError as err:
- log.exception("ERROR: ConnectionResetError in handle_client")
- except Exception as err:
- log.exception("ERROR: Exception in handle_client")
- finally:
- # Wathever happens, close the connection.
- connection.close()
- client_writer.close()
-
-
-@trollius.coroutine
-def stats(client_reader, client_writer):
-
- try:
- log.info('Clients: %s', SERVER.active_count)
- client_writer.write((
- "HTTP/1.0 200 OK\n"
- "Cache: nocache\n\n"
- ).encode())
- client_writer.write(('data: %s\n\n' % SERVER.active_count).encode())
- yield trollius.From(client_writer.drain())
-
- except trollius.ConnectionResetError as err:
- log.info(err)
- pass
- finally:
- client_writer.close()
- return
-
-
-def main():
- global SERVER
-
- try:
- loop = trollius.get_event_loop()
- coro = trollius.start_server(
- handle_client,
- host=None,
- port=pagure.APP.config['EVENTSOURCE_PORT'],
- loop=loop)
- SERVER = loop.run_until_complete(coro)
- log.info('Serving server at {}'.format(SERVER.sockets[0].getsockname()))
- if pagure.APP.config.get('EV_STATS_PORT'):
- stats_coro = trollius.start_server(
- stats,
- host=None,
- port=pagure.APP.config.get('EV_STATS_PORT'),
- loop=loop)
- stats_server = loop.run_until_complete(stats_coro)
- log.info('Serving stats at {}'.format(
- stats_server.sockets[0].getsockname()))
- loop.run_forever()
- except KeyboardInterrupt:
- pass
- except trollius.ConnectionResetError as err:
- log.exception("ERROR: ConnectionResetError in main")
- except Exception as err:
- log.exception("ERROR: Exception in main")
- finally:
- # Close the server
- SERVER.close()
- if pagure.APP.config.get('EV_STATS_PORT'):
- stats_server.close()
- log.info("End Connection")
- loop.run_until_complete(SERVER.wait_closed())
- loop.close()
- log.info("End")
-
-
-if __name__ == '__main__':
- log = logging.getLogger("")
- formatter = logging.Formatter(
- "%(asctime)s %(levelname)s [%(module)s:%(lineno)d] %(message)s")
-
- # setup console logging
- log.setLevel(logging.DEBUG)
- ch = logging.StreamHandler()
- ch.setLevel(logging.DEBUG)
-
- aslog = logging.getLogger("asyncio")
- aslog.setLevel(logging.DEBUG)
-
- ch.setFormatter(formatter)
- log.addHandler(ch)
- main()
diff --git a/ev-server/pagure_ev.service b/ev-server/pagure_ev.service
index d980441..27e864b 100644
--- a/ev-server/pagure_ev.service
+++ b/ev-server/pagure_ev.service
@@ -4,7 +4,7 @@ After=redis.target
Documentation=https://pagure.io/pagure
[Service]
-ExecStart=/usr/libexec/pagure-ev/pagure-stream-server.py
+ExecStart=/usr/libexec/pagure-ev/pagure_stream_server.py
Type=simple
User=git
Group=git
diff --git a/ev-server/pagure_stream_server.py b/ev-server/pagure_stream_server.py
new file mode 100644
index 0000000..64360e9
--- /dev/null
+++ b/ev-server/pagure_stream_server.py
@@ -0,0 +1,311 @@
+#!/usr/bin/env python
+
+"""
+ (c) 2015 - Copyright Red Hat Inc
+
+ Authors:
+ Pierre-Yves Chibon <pingou@pingoured.fr>
+
+
+Streaming server for pagure's eventsource feature
+This server takes messages sent to redis and publish them at the specified
+endpoint
+
+To test, run this script and in another terminal
+nc localhost 8080
+ HELLO
+
+ GET /test/issue/26?foo=bar HTTP/1.1
+
+"""
+
+import datetime
+import logging
+import os
+import urlparse
+
+import trollius
+import trollius_redis
+
+log = logging.getLogger(__name__)
+
+
+if 'PAGURE_CONFIG' not in os.environ \
+ and os.path.exists('/etc/pagure/pagure.cfg'):
+ print 'Using configuration file `/etc/pagure/pagure.cfg`'
+ os.environ['PAGURE_CONFIG'] = '/etc/pagure/pagure.cfg'
+
+
+import pagure
+import pagure.lib
+from pagure.exceptions import PagureEvException
+
+SERVER = None
+
+
+def _get_issue(repo, objid):
+ """Get a Ticket (issue) instance for a given repo (Project) and
+ objid (issue number).
+ """
+ issue = None
+ if not repo.settings.get('issue_tracker', True):
+ raise PagureEvException("No issue tracker found for this project")
+
+ issue = pagure.lib.search_issues(
+ pagure.SESSION, repo, issueid=objid)
+
+ if issue is None or issue.project != repo:
+ raise PagureEvException("Issue '%s' not found" % objid)
+
+ if issue.private:
+ # TODO: find a way to do auth
+ raise PagureEvException(
+ "This issue is private and you are not allowed to view it")
+
+ return issue
+
+
+def _get_pull_request(repo, objid):
+ """Get a PullRequest instance for a given repo (Project) and objid
+ (request number).
+ """
+ if not repo.settings.get('pull_requests', True):
+ raise PagureEvException(
+ "No pull-request tracker found for this project")
+
+ request = pagure.lib.search_pull_requests(
+ pagure.SESSION, project_id=repo.id, requestid=objid)
+
+ if request is None or request.project != repo:
+ raise PagureEvException("Pull-Request '%s' not found" % objid)
+
+ return request
+
+
+# Dict representing known object types that we handle requests for,
+# and the bound functions for getting an object instance from the
+# parsed path data. Has to come after the functions it binds
+OBJECTS = {
+ 'issue': _get_issue,
+ 'pull-request': _get_pull_request
+}
+
+
+def _parse_path(path):
+ """Get the repo name, object type, object ID, and (if present)
+ username and/or namespace from a URL path component. Will only
+ handle the known object types from the OBJECTS dict. Assumes:
+ * Project name comes immediately before object type
+ * Object ID comes immediately after object type
+ * If a fork, path starts with /fork/(username)
+ * Namespace, if present, comes after fork username (if present) or at start
+ * No other components come before the project name
+ * None of the parsed items can contain a /
+ """
+ username = None
+ namespace = None
+ # path always starts with / so split and throw away first item
+ items = path.split('/')[1:]
+ # find the *last* match for any object type
+ try:
+ objtype = [item for item in items if item in OBJECTS][-1]
+ except IndexError:
+ raise PagureEvException("No known object type found in path: %s" % path)
+ try:
+ # objid is the item after objtype, we need all items up to it
+ items = items[:items.index(objtype) + 2]
+ # now strip the repo, objtype and objid off the end
+ (repo, objtype, objid) = items[-3:]
+ items = items[:-3]
+ except (IndexError, ValueError):
+ raise PagureEvException("No project or object ID found in path: %s" % path)
+ # now check for a fork
+ if items and items[0] == 'fork':
+ try:
+ # get the username and strip it and 'fork'
+ username = items[1]
+ items = items[2:]
+ except IndexError:
+ raise PagureEvException("Path starts with /fork but no user found! Path: %s" % path)
+ # if we still have an item left, it must be the namespace
+ if items:
+ namespace = items.pop(0)
+ # if we have any items left at this point, we've no idea
+ if items:
+ raise PagureEvException("More path components than expected! Path: %s" % path)
+
+ return (username, namespace, repo, objtype, objid)
+
+
+def get_obj_from_path(path):
+ """ Return the Ticket or Request object based on the path provided.
+ """
+ (username, namespace, reponame, objtype, objid) = _parse_path(path)
+ repo = pagure.lib.get_project(pagure.SESSION, reponame, user=username, namespace=namespace)
+ if repo is None:
+ raise PagureEvException("Project '%s' not found" % reponame)
+
+ # find the appropriate object getter function from OBJECTS
+ try:
+ getfunc = OBJECTS[objtype]
+ except KeyError:
+ raise PagureEvException("Invalid object provided: '%s'" % objtype)
+
+ return getfunc(repo, objid)
+
+
+@trollius.coroutine
+def handle_client(client_reader, client_writer):
+ data = None
+ while True:
+ # give client a chance to respond, timeout after 10 seconds
+ line = yield trollius.From(trollius.wait_for(
+ client_reader.readline(),
+ timeout=10.0))
+ if not line.decode().strip():
+ break
+ line = line.decode().rstrip()
+ if data is None:
+ data = line
+
+ if data is None:
+ log.warning("Expected ticket uid, received None")
+ return
+
+ data = data.decode().rstrip().split()
+ log.info("Received %s", data)
+ if not data:
+ log.warning("No URL provided: %s" % data)
+ return
+
+ if not '/' in data[1]:
+ log.warning("Invalid URL provided: %s" % data[1])
+ return
+
+ url = urlparse.urlsplit(data[1])
+
+ try:
+ obj = get_obj_from_path(url.path)
+ except PagureEvException as err:
+ log.warning(err.message)
+ return
+
+ origin = pagure.APP.config.get('APP_URL')
+ if origin.endswith('/'):
+ origin = origin[:-1]
+
+ client_writer.write((
+ "HTTP/1.0 200 OK\n"
+ "Content-Type: text/event-stream\n"
+ "Cache: nocache\n"
+ "Connection: keep-alive\n"
+ "Access-Control-Allow-Origin: %s\n\n" % origin
+ ).encode())
+
+ connection = yield trollius.From(trollius_redis.Connection.create(
+ host=pagure.APP.config['REDIS_HOST'],
+ port=pagure.APP.config['REDIS_PORT'],
+ db=pagure.APP.config['REDIS_DB']))
+
+ try:
+
+ # Create subscriber.
+ subscriber = yield trollius.From(connection.start_subscribe())
+
+ # Subscribe to channel.
+ yield trollius.From(subscriber.subscribe(['pagure.%s' % obj.uid]))
+
+ # Inside a while loop, wait for incoming events.
+ while True:
+ reply = yield trollius.From(subscriber.next_published())
+ #print(u'Received: ', repr(reply.value), u'on channel', reply.channel)
+ log.info(reply)
+ log.info("Sending %s", reply.value)
+ client_writer.write(('data: %s\n\n' % reply.value).encode())
+ yield trollius.From(client_writer.drain())
+
+ except trollius.ConnectionResetError as err:
+ log.exception("ERROR: ConnectionResetError in handle_client")
+ except Exception as err:
+ log.exception("ERROR: Exception in handle_client")
+ finally:
+ # Wathever happens, close the connection.
+ connection.close()
+ client_writer.close()
+
+
+@trollius.coroutine
+def stats(client_reader, client_writer):
+
+ try:
+ log.info('Clients: %s', SERVER.active_count)
+ client_writer.write((
+ "HTTP/1.0 200 OK\n"
+ "Cache: nocache\n\n"
+ ).encode())
+ client_writer.write(('data: %s\n\n' % SERVER.active_count).encode())
+ yield trollius.From(client_writer.drain())
+
+ except trollius.ConnectionResetError as err:
+ log.info(err)
+ pass
+ finally:
+ client_writer.close()
+ return
+
+
+def main():
+ global SERVER
+
+ try:
+ loop = trollius.get_event_loop()
+ coro = trollius.start_server(
+ handle_client,
+ host=None,
+ port=pagure.APP.config['EVENTSOURCE_PORT'],
+ loop=loop)
+ SERVER = loop.run_until_complete(coro)
+ log.info('Serving server at {}'.format(SERVER.sockets[0].getsockname()))
+ if pagure.APP.config.get('EV_STATS_PORT'):
+ stats_coro = trollius.start_server(
+ stats,
+ host=None,
+ port=pagure.APP.config.get('EV_STATS_PORT'),
+ loop=loop)
+ stats_server = loop.run_until_complete(stats_coro)
+ log.info('Serving stats at {}'.format(
+ stats_server.sockets[0].getsockname()))
+ loop.run_forever()
+ except KeyboardInterrupt:
+ pass
+ except trollius.ConnectionResetError as err:
+ log.exception("ERROR: ConnectionResetError in main")
+ except Exception as err:
+ log.exception("ERROR: Exception in main")
+ finally:
+ # Close the server
+ SERVER.close()
+ if pagure.APP.config.get('EV_STATS_PORT'):
+ stats_server.close()
+ log.info("End Connection")
+ loop.run_until_complete(SERVER.wait_closed())
+ loop.close()
+ log.info("End")
+
+
+if __name__ == '__main__':
+ log = logging.getLogger("")
+ formatter = logging.Formatter(
+ "%(asctime)s %(levelname)s [%(module)s:%(lineno)d] %(message)s")
+
+ # setup console logging
+ log.setLevel(logging.DEBUG)
+ ch = logging.StreamHandler()
+ ch.setLevel(logging.DEBUG)
+
+ aslog = logging.getLogger("asyncio")
+ aslog.setLevel(logging.DEBUG)
+
+ ch.setFormatter(formatter)
+ log.addHandler(ch)
+ main()
diff --git a/files/pagure.spec b/files/pagure.spec
index fb3a27f..7858241 100644
--- a/files/pagure.spec
+++ b/files/pagure.spec
@@ -207,8 +207,8 @@ install -m 644 milters/comment_email_milter.py \
# Install the eventsource
mkdir -p $RPM_BUILD_ROOT/%{_libexecdir}/pagure-ev
-install -m 755 ev-server/pagure-stream-server.py \
- $RPM_BUILD_ROOT/%{_libexecdir}/pagure-ev/pagure-stream-server.py
+install -m 755 ev-server/pagure_stream_server.py \
+ $RPM_BUILD_ROOT/%{_libexecdir}/pagure-ev/pagure_stream_server.py
install -m 644 ev-server/pagure_ev.service \
$RPM_BUILD_ROOT/%{_unitdir}/pagure_ev.service
diff --git a/pagure/exceptions.py b/pagure/exceptions.py
index fed319d..8eeefc3 100644
--- a/pagure/exceptions.py
+++ b/pagure/exceptions.py
@@ -47,7 +47,7 @@ class BranchNotFoundException(PagureException):
class PagureEvException(PagureException):
- ''' Exceptions used in the pagure-stream-server.
+ ''' Exceptions used in the pagure_stream_server.
'''
pass
diff --git a/tests/test_stream_server.py b/tests/test_stream_server.py
new file mode 100644
index 0000000..411df62
--- /dev/null
+++ b/tests/test_stream_server.py
@@ -0,0 +1,237 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+ (c) 2016 - Copyright Red Hat Inc
+
+ Authors:
+ Adam Williamson <awilliam@redhat.com>
+
+Tests for the Pagure streaming server.
+
+"""
+
+# obviously this is fine for testing.
+# pylint: disable=locally-disabled, protected-access
+
+import logging
+import os
+import sys
+import unittest
+
+import mock
+
+sys.path.insert(0, os.path.join(os.path.dirname(
+ os.path.abspath(__file__)), '..'))
+sys.path.insert(0, os.path.join(os.path.dirname(
+ os.path.abspath(__file__)), '../ev-server'))
+
+import pagure # pylint: disable=wrong-import-position
+from pagure.exceptions import PagureEvException # pylint: disable=wrong-import-position
+import tests # pylint: disable=wrong-import-position
+# comes from ev-server/
+import pagure_stream_server as pss # pylint: disable=wrong-import-position, import-error
+
+logging.basicConfig(stream=sys.stderr)
+
+
+class StreamingServerTests(tests.Modeltests):
+ """Tests for the streaming server."""
+
+ def setUp(self):
+ """Set up the environnment, run before every test."""
+ super(StreamingServerTests, self).setUp()
+ pagure.SESSION = self.session
+
+ # Mock send_email, we never want to send or see emails here.
+ self.mailpatcher = mock.patch('pagure.lib.notify.send_email')
+ self.mailpatcher.start()
+
+ # Setup projects
+ tests.create_projects(self.session)
+ self.repo = pagure.lib.get_project(self.session, 'test')
+ self.repo2 = pagure.lib.get_project(self.session, 'test2')
+
+ # Disable repo 2's issue tracker and PR tracker
+ pagure.lib.update_project_settings(
+ session=self.session,
+ repo=self.repo2,
+ user='pingou',
+ settings={
+ 'issue_tracker': False,
+ 'pull_requests': False,
+ }
+ )
+
+ # Create a public issue
+ pagure.lib.new_issue(
+ session=self.session,
+ repo=self.repo,
+ title='Test issue',
+ content='We should work on this',
+ user='pingou',
+ ticketfolder=None
+ )
+
+ # Create a private issue
+ pagure.lib.new_issue(
+ session=self.session,
+ repo=self.repo,
+ title='Private issue #2',
+ content='The world can see my porn folder',
+ user='pingou',
+ private=True,
+ ticketfolder=None
+ )
+
+ # Create a PR
+ pagure.lib.new_pull_request(
+ session=self.session,
+ repo_from=self.repo,
+ repo_to=self.repo,
+ branch_from='feature',
+ branch_to='master',
+ title='Test PR',
+ user='pingou',
+ requestfolder=None
+ )
+
+ def tearDown(self):
+ "Stop the patchers, as well as calling super."""
+ super(StreamingServerTests, self).tearDown()
+ self.mailpatcher.stop()
+
+ def test_parse_path(self):
+ """Tests for _parse_path."""
+ # Result format is: (username, namespace, repo, objtype, objid)
+ # Simple case: issue for non-namespaced, non-forked repo.
+ result = pss._parse_path('/pagure/issue/1')
+ self.assertEqual(result, (None, None, 'pagure', 'issue', '1'))
+
+ # Pull request for namespaced repo.
+ result = pss._parse_path('/fedora-qa/fedfind/pull-request/2')
+ self.assertEqual(result, (None, 'fedora-qa', 'fedfind', 'pull-request', '2'))
+
+ # Issue for forked repo.
+ result = pss._parse_path('/fork/adamwill/pagure/issue/3')
+ self.assertEqual(result, ('adamwill', None, 'pagure', 'issue', '3'))
+
+ # Issue for forked, namespaced repo.
+ result = pss._parse_path('/fork/pingou/fedora-qa/fedfind/issue/4')
+ self.assertEqual(result, ('pingou', 'fedora-qa', 'fedfind', 'issue', '4'))
+
+ # Issue for repo named 'pull-request' (yeah, now we're getting tricksy).
+ result = pss._parse_path('/pull-request/issue/5')
+ self.assertEqual(result, (None, None, 'pull-request', 'issue', '5'))
+
+ # Unknown object type.
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"No known object",
+ pss._parse_path, '/pagure/unexpected/1'
+ )
+
+ # No object ID.
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"No project or object ID",
+ pss._parse_path, '/pagure/issue'
+ )
+
+ # No repo name. Note: we cannot catch 'namespace but no repo name',
+ # but that should fail later in pagure.lib.get_project
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"No project or object ID",
+ pss._parse_path, '/issue/1'
+ )
+
+ # /fork but no user name.
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"no user found!",
+ pss._parse_path, '/fork/pagure/issue/1'
+ )
+
+ # Too many path components before object type.
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"More path components",
+ pss._parse_path, '/fork/adamwill/fedora-qa/fedfind/unexpected/issue/1'
+ )
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"More path components",
+ pss._parse_path, '/fedora-qa/fedfind/unexpected/issue/1'
+ )
+
+ def test_get_issue(self):
+ """Tests for _get_issue."""
+ # Simple case: get the existing issue from the existing repo.
+ result = pss._get_issue(self.repo, '1')
+ self.assertEqual(result.id, 1)
+
+ # Issue that doesn't exist.
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"Issue '3' not found",
+ pss._get_issue, self.repo, '3'
+ )
+
+ # Private issue (for now we don't handle auth).
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"issue is private",
+ pss._get_issue, self.repo, '2'
+ )
+
+ # Issue from a project with no issue tracker.
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"No issue tracker found",
+ pss._get_issue, self.repo2, '1'
+ )
+
+ def test_get_pull_request(self):
+ """Tests for _get_pull_request."""
+ # Simple case: get the existing PR from the existing repo.
+ result = pss._get_pull_request(self.repo, '3')
+ self.assertEqual(result.id, 3)
+
+ # PR that doesn't exist.
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"Pull-Request '2' not found",
+ pss._get_pull_request, self.repo, '2'
+ )
+
+ # PR from a project with no PR tracker.
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"No pull-request tracker found",
+ pss._get_pull_request, self.repo2, '1'
+ )
+
+ def test_get_obj_from_path(self):
+ """Tests for get_obj_from_path."""
+ # Simple issue case.
+ result = pss.get_obj_from_path('/test/issue/1')
+ self.assertEqual(result.id, 1)
+
+ # Simple PR case.
+ result = pss.get_obj_from_path('/test/pull-request/3')
+ self.assertEqual(result.id, 3)
+
+ # Non-existent repo.
+ self.assertRaisesRegexp(
+ PagureEvException,
+ r"Project 'foo' not found",
+ pss.get_obj_from_path, '/foo/issue/1'
+ )
+
+ # NOTE: we cannot test the 'Invalid object provided' exception
+ # as it's a backup (current code will never hit it)
+
+if __name__ == '__main__':
+ SUITE = unittest.TestLoader().loadTestsFromTestCase(StreamingServerTests)
+ unittest.TextTestRunner(verbosity=2).run(SUITE)