Show All 14 Lines
from swh.web.api.utils import enrich_origin, enrich_origin_visit		from swh.web.api.utils import enrich_origin, enrich_origin_visit
from swh.web.api.views.utils import api_lookup		from swh.web.api.views.utils import api_lookup


DOC_RETURN_ORIGIN = '''		DOC_RETURN_ORIGIN = '''
:>json string origin_visits_url: link to in order to get information		:>json string origin_visits_url: link to in order to get information
about the visits for that origin		about the visits for that origin
:>json string url: the origin canonical url		:>json string url: the origin canonical url
:>json string type: the type of software origin (deprecated value;
types are now associated to visits instead of origins)
:>json number id: the origin unique identifier (deprecated value;
you should only refer to origins based on their URL)
'''		'''

DOC_RETURN_ORIGIN_ARRAY = \		DOC_RETURN_ORIGIN_ARRAY = \
DOC_RETURN_ORIGIN.replace(':>json', ':>jsonarr')		DOC_RETURN_ORIGIN.replace(':>json', ':>jsonarr')

DOC_RETURN_ORIGIN_VISIT = '''		DOC_RETURN_ORIGIN_VISIT = '''
:>json string date: ISO representation of the visit date (in UTC)		:>json string date: ISO representation of the visit date (in UTC)
:>json str origin: the origin canonical url		:>json str origin: the origin canonical url
▲ Show 20 Lines • Show All 65 Lines • ▼ Show 20 Lines	def api_origins(request):
response = {'results': results, 'headers': {}}		response = {'results': results, 'headers': {}}
if len(results) > origin_count:		if len(results) > origin_count:
origin_from = results.pop()['id']		origin_from = results.pop()['id']
response['headers']['link-next'] = reverse(		response['headers']['link-next'] = reverse(
'api-1-origins',		'api-1-origins',
query_params={'origin_from': origin_from,		query_params={'origin_from': origin_from,
'origin_count': origin_count},		'origin_count': origin_count},
request=request)		request=request)
		for result in results:
		del result['id']
return response		return response


@api_route(r'/origin/(?P<origin_url>.+)/get/', 'api-1-origin')		@api_route(r'/origin/(?P<origin_url>.+)/get/', 'api-1-origin')
@api_doc('/origin/')		@api_doc('/origin/')
@format_docstring(return_origin=DOC_RETURN_ORIGIN)		@format_docstring(return_origin=DOC_RETURN_ORIGIN)
def api_origin(request, origin_url):		def api_origin(request, origin_url):
"""		"""
▲ Show 20 Lines • Show All 369 Lines • Show Last 20 Lines

View Options

swh/web/browse/views/origin.py

Show First 20 Lines • Show All 113 Lines • ▼ Show 20 Lines	def origin_releases_browse(request, origin_url, timestamp=None):
return browse_snapshot_releases(request,		return browse_snapshot_releases(request,
origin_url=origin_url, timestamp=timestamp)		origin_url=origin_url, timestamp=timestamp)


@browse_route(r'origin/(?P<origin_url>.+)/visits/',		@browse_route(r'origin/(?P<origin_url>.+)/visits/',
view_name='browse-origin-visits')		view_name='browse-origin-visits')
def origin_visits_browse(request, origin_url):		def origin_visits_browse(request, origin_url):
"""Django view that produces an HTML display of visits reporting		"""Django view that produces an HTML display of visits reporting
for a swh origin identified by its id or its url.		for a given origin.

The url that points to it is		The url that points to it is
:http:get:`/browse/origin/(origin_url)/visits/`.		:http:get:`/browse/origin/(origin_url)/visits/`.
"""		"""
try:		try:
origin_info = service.lookup_origin({'url': origin_url})		origin_info = service.lookup_origin({'url': origin_url})
origin_visits = get_origin_visits(origin_info)		origin_visits = get_origin_visits(origin_info)
snapshot_context = get_snapshot_context(origin_url=origin_url)		snapshot_context = get_snapshot_context(origin_url=origin_url)
▲ Show 20 Lines • Show All 46 Lines • Show Last 20 Lines

View Options

swh/web/common/origin_visits.py

Show All 18 Lines	def get_origin_visits(origin_info):
Args:		Args:
origin_info (dict): dict describing the origin to fetch visits from		origin_info (dict): dict describing the origin to fetch visits from

Returns:		Returns:
list: A list of dict describing the origin visits with the		list: A list of dict describing the origin visits with the
following keys:		following keys:

* date: UTC visit date in ISO format,		* date: UTC visit date in ISO format,
* origin: the origin id		* origin: the origin url
* status: the visit status, either full, partial		* status: the visit status, either full, partial
or ongoing		or ongoing
* visit: the visit id		* visit: the visit id
		* type: the visit type

Raises:		Raises:
NotFoundExc: if the origin is not found		NotFoundExc: if the origin is not found
"""		"""

from swh.web.common import service		from swh.web.common import service

if 'url' in origin_info:		if 'url' in origin_info:
▲ Show 20 Lines • Show All 50 Lines • ▼ Show 20 Lines	def get_origin_visit(origin_info, visit_ts=None, visit_id=None,
snapshot_id=None):		snapshot_id=None):
"""Function that returns information about a visit for		"""Function that returns information about a visit for
a given origin.		a given origin.
The visit is retrieved from a provided timestamp.		The visit is retrieved from a provided timestamp.
The closest visit from that timestamp is selected.		The closest visit from that timestamp is selected.

Args:		Args:
origin_info (dict): a dict filled with origin information		origin_info (dict): a dict filled with origin information
(id, url, type)
visit_ts (int or str): an ISO date string or Unix timestamp to parse		visit_ts (int or str): an ISO date string or Unix timestamp to parse

Returns:		Returns:
A dict containing the visit info as described below::		A dict containing the visit info as described below::

{'origin': 2,		{'origin': 'https://forge.softwareheritage.org/source/swh-web/',
'date': '2017-10-08T11:54:25.582463+00:00',		'date': '2017-10-08T11:54:25.582463+00:00',
'metadata': {},		'metadata': {},
'visit': 25,		'visit': 25,
'status': 'full'}		'status': 'full'}

"""		"""
visits = get_origin_visits(origin_info)		visits = get_origin_visits(origin_info)

if not visits:		if not visits:
if 'url' in origin_info:		raise NotFoundExc(('No visit associated to origin with'
message = ('No visit associated to origin with'		' url %s!' % origin_info['url']))
' url %s!' % origin_info['url'])
else:
message = ('No visit associated to origin with'
' id %s!' % origin_info['id'])
raise NotFoundExc(message)

if snapshot_id:		if snapshot_id:
visit = [v for v in visits if v['snapshot'] == snapshot_id]		visit = [v for v in visits if v['snapshot'] == snapshot_id]
if len(visit) == 0:		if len(visit) == 0:
if 'type' in origin_info and 'url' in origin_info:		raise NotFoundExc(('Visit for snapshot with id %s for origin with'
message = ('Visit for snapshot with id %s for origin with type'
' url %s not found!' %		' url %s not found!' %
(snapshot_id, origin_info['url']))		(snapshot_id, origin_info['url'])))
else:
message = ('Visit for snapshot with id %s for origin with'
' id %s not found!' %
(snapshot_id, origin_info['id']))
raise NotFoundExc(message)
return visit[0]		return visit[0]

if visit_id:		if visit_id:
visit = [v for v in visits if v['visit'] == int(visit_id)]		visit = [v for v in visits if v['visit'] == int(visit_id)]
if len(visit) == 0:		if len(visit) == 0:
if 'type' in origin_info and 'url' in origin_info:		raise NotFoundExc(('Visit with id %s for origin with'
message = ('Visit with id %s for origin with'		' url %s not found!' %
' and url %s not found!' %		(visit_id, origin_info['url'])))
(visit_id, origin_info['url']))
else:
message = ('Visit with id %s for origin with id %s'
' not found!' % (visit_id, origin_info['id']))
raise NotFoundExc(message)
return visit[0]		return visit[0]

if not visit_ts:		if not visit_ts:
# returns the latest full visit when no timestamp is provided		# returns the latest full visit when no timestamp is provided
for v in reversed(visits):		for v in reversed(visits):
if v['status'] == 'full':		if v['status'] == 'full':
return v		return v
return visits[-1]		return visits[-1]
Show All 11 Lines	if visit_idx is not None:
# If multiple visits have the same date, select the one with		# If multiple visits have the same date, select the one with
# the largest id.		# the largest id.
while visit_idx < len(visits) - 1 and \		while visit_idx < len(visits) - 1 and \
visit['date'] == visits[visit_idx+1]['date']:		visit['date'] == visits[visit_idx+1]['date']:
visit_idx = visit_idx + 1		visit_idx = visit_idx + 1
visit = visits[visit_idx]		visit = visits[visit_idx]
return visit		return visit
else:		else:
if 'type' in origin_info and 'url' in origin_info:		raise NotFoundExc(('Visit with timestamp %s for origin with '
message = ('Visit with timestamp %s for origin with '		'url %s not found!' %
'and url %s not found!' %		(visit_ts, origin_info['url'])))
(visit_ts, origin_info['url']))
else:
message = ('Visit with timestamp %s for origin with id %s '
'not found!' % (visit_ts, origin_info['id']))
raise NotFoundExc(message)

View Options

swh/web/tests/common/test_origin_visits.py

Show All 36 Lines	def _lookup_origin_visits(args, *kwargs):
'metadata': {}		'metadata': {}
}		}
]		]

mock_service.lookup_origin_visits.side_effect = _lookup_origin_visits		mock_service.lookup_origin_visits.side_effect = _lookup_origin_visits

origin_info = {		origin_info = {
'id': 1,		'id': 1,
'type': 'git',
'url': 'https://github.com/foo/bar',		'url': 'https://github.com/foo/bar',
}		}

origin_visits = get_origin_visits(origin_info)		origin_visits = get_origin_visits(origin_info)

assert len(origin_visits) == 3		assert len(origin_visits) == 3


def test_get_origin_visit(mocker):		def test_get_origin_visit(mocker):
mock_origin_visits = mocker.patch(		mock_origin_visits = mocker.patch(
'swh.web.common.origin_visits.get_origin_visits')		'swh.web.common.origin_visits.get_origin_visits')
origin_info = {		origin_info = {
'id': 2,
'type': 'git',
'url': 'https://github.com/foo/bar',		'url': 'https://github.com/foo/bar',
}		}
visits = [		visits = [
{		{
'status': 'full',		'status': 'full',
'date': '2015-07-09T21:09:24+00:00',		'date': '2015-07-09T21:09:24+00:00',
'visit': 1,		'visit': 1,
'origin': origin_info['id']		'origin': 'https://github.com/foo/bar',
		'type': 'git',
},		},
{		{
'status': 'full',		'status': 'full',
'date': '2016-02-23T18:05:23.312045+00:00',		'date': '2016-02-23T18:05:23.312045+00:00',
'visit': 2,		'visit': 2,
'origin': origin_info['id']		'origin': 'https://github.com/foo/bar',
		'type': 'git',
},		},
{		{
'status': 'full',		'status': 'full',
'date': '2016-03-28T01:35:06.554111+00:00',		'date': '2016-03-28T01:35:06.554111+00:00',
'visit': 3,		'visit': 3,
'origin': origin_info['id']		'origin': 'https://github.com/foo/bar',
		'type': 'git',
},		},
{		{
'status': 'full',		'status': 'full',
'date': '2016-06-18T01:22:24.808485+00:00',		'date': '2016-06-18T01:22:24.808485+00:00',
'visit': 4,		'visit': 4,
'origin': origin_info['id']		'origin': 'https://github.com/foo/bar',
		'type': 'git',
},		},
{		{
'status': 'full',		'status': 'full',
'date': '2016-08-14T12:10:00.536702+00:00',		'date': '2016-08-14T12:10:00.536702+00:00',
'visit': 5,		'visit': 5,
'origin': origin_info['id']		'origin': 'https://github.com/foo/bar',
		'type': 'git',
}		}
]		]
mock_origin_visits.return_value = visits		mock_origin_visits.return_value = visits

visit_id = 12		visit_id = 12
with pytest.raises(NotFoundExc) as e:		with pytest.raises(NotFoundExc) as e:
visit = get_origin_visit(origin_info,		visit = get_origin_visit(origin_info,
visit_id=visit_id)		visit_id=visit_id)
Show All 34 Lines

Remove last references to non-intrinsic origin identifiersClosedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 9296

swh/web/api/views/origin.py

swh/web/browse/views/origin.py

swh/web/common/origin_visits.py

swh/web/tests/common/test_origin_visits.py

Remove last references to non-intrinsic origin identifiers
ClosedPublic
Actions

Revision Contents
Changeset List