diff --git a/docs/uri-scheme-browse-origin.rst b/docs/uri-scheme-browse-origin.rst index 2c071e01..8ba31c4f 100644 --- a/docs/uri-scheme-browse-origin.rst +++ b/docs/uri-scheme-browse-origin.rst @@ -1,363 +1,491 @@ Origin ^^^^^^ +This describes the URI scheme when one wants to browse the Software Heritage +archive in the context of an origin (for instance, a repository crawled from +GitHub or a Debian source package). All the views pointed by that scheme +offer quick links to browse objects as found during the associated crawls +performed by Software Heritage: + + * the root directory of the origin + * the list of branches of the origin + * the list of releases of the origin + Origin metadata """"""""""""""" .. http:get:: /browse/origin/(origin_type)/url/(origin_url)/ HTML view that displays a SWH origin identified by its type and url. The view displays the origin metadata and contains links for browsing its directories and contents for each SWH visit. :param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...) :param string origin_url: the url of the origin (e.g. https://github.com/user/repo) :statuscode 200: no error :statuscode 404: requested origin can not be found in the SWH archive **Examples:** .. parsed-literal:: :swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/` :swh_web_browse:`origin/git/url/https://github.com/python/cpython/` :swh_web_browse:`origin/deb/url/deb://Debian-Security/packages/mediawiki/` :swh_web_browse:`origin/git/url/https://gitorious.org/qt/qtbase.git` Origin directory """""""""""""""" .. http:get:: /browse/origin/(origin_type)/url/(origin_url)/directory/[(path)/] HTML view for browsing the content of a directory reachable from the root directory (including itself) associated to the latest visit of a SWH origin. The content of the directory is first sorted in lexicographical order and the sub-directories are displayed before the regular files. The view enables to navigate from the requested directory to directories reachable from it in a recursive way but also up to the origin root directory. A breadcrumb located in the top part of the view allows to keep track of the paths navigated so far. The view also enables to easily switch between the origin branches - through a dropdown menu. + and releases through a dropdown menu. The origin branch (default to master) from which to retrieve the directory content can also be specified by using the branch query parameter. :param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...) :param string origin_url: the url of the origin (e.g. https://github.com/user/repo) :param string path: optional parameter used to specify the path of a directory reachable from the origin root one :query string branch: specify the origin branch name from which to retrieve the directory :query string release: specify the origin release name from which to retrieve the directory :query string revision: specify the origin revision, identified by the hexadecimal representation of its *sha1_git* value, from which to retrieve the directory :query int visit_id: specify a SWH visit id to retrieve the directory from instead of using the latest visit by default :statuscode 200: no error :statuscode 404: requested origin can not be found in the SWH archive or the provided path does not exist from the origin root directory **Examples:** .. parsed-literal:: :swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/directory/` :swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/directory/net/ethernet/` :swh_web_browse:`origin/git/url/https://github.com/python/cpython/directory/` :swh_web_browse:`origin/git/url/https://github.com/python/cpython/directory/Python/` :swh_web_browse:`origin/git/url/https://github.com/python/cpython/directory/?branch=refs/heads/2.7` .. http:get:: /browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/directory/[(path)/] HTML view for browsing the content of a directory reachable from the root directory (including itself) associated to a visitof a SWH origin closest to a provided timestamp. The content of the directory is first sorted in lexicographical order and the sub-directories are displayed before the regular files. The view enables to navigate from the requested directory to directories reachable from it in a recursive way but also up to the origin root directory. A breadcrumb located in the top part of the view allows to keep track of the paths navigated so far. The view also enables to easily switch between the origin branches - through a dropdown menu. + and releases through a dropdown menu. The origin branch (default to master) from which to retrieve the directory content can also be specified by using the branch query parameter. :param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...) :param string origin_url: the url of the origin (e.g. https://github.com/user/repo) :param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) or Unix timestamp to parse in order to find the closest SWH visit. :param path: optional parameter used to specify the path of a directory reachable from the origin root one :type path: string :query string branch: specify the origin branch name from which to retrieve the directory :query string revision: specify the origin release name from which to retrieve the directory :query string revision: specify the origin revision, identified by the hexadecimal representation of its *sha1_git* value, from which to retrieve the directory :query int visit_id: specify a SWH visit id to retrieve the directory from instead of using the provided timestamp :statuscode 200: no error :statuscode 404: requested origin can not be found in the SWH archive, requested visit timestamp does not exist or the provided path does not exist from the origin root directory **Examples:** .. parsed-literal:: :swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/visit/1493926809/directory/` :swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/visit/2016-09-14T10:36:21/directory/net/ethernet/` :swh_web_browse:`origin/git/url/https://github.com/python/cpython/visit/1474620651/directory/` :swh_web_browse:`origin/git/url/https://github.com/python/cpython/visit/2017-05-05/directory/Python/` :swh_web_browse:`origin/git/url/https://github.com/python/cpython/visit/2015-08/directory/?branch=refs/heads/2.7` Origin content """""""""""""" .. http:get:: /browse/origin/(origin_type)/url/(origin_url)/content/(path)/ HTML view that produces a display of a SWH content associated to the latest visit of a SWH origin. If the content to display is textual, it will be highlighted client-side if possible using highlightjs_. The procedure to perform that task is described in :http:get:`/browse/content/[(algo_hash):](hash)/`. It is also possible to highlight specific lines of a textual content (not in terms of syntax highlighting but to emphasize some relevant content part) by either: * clicking on line numbers (holding shift to highlight a lines range) * using an url fragment in the form '#Ln' or '#Lm-Ln' The view displays a breadcrumb on top of the rendered content in order to easily navigate up to the origin root directory. The view also enables to easily switch between the origin branches - through a dropdown menu. + and releases through a dropdown menu. The origin branch (default to master) from which to retrieve the content can also be specified by using the branch query parameter. :param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...) :param string origin_url: the url of the origin (e.g. https://github.com/user/repo) :param string path: path of a content reachable from the origin root directory :query string branch: specify the origin branch name from which to retrieve the content :query string release: specify the origin release name from which to retrieve the content :query string revision: specify the origin revision, identified by the hexadecimal representation of its *sha1_git* value, from which to retrieve the content :query int visit_id: specify a SWH visit id to retrieve the content from instead of using the latest visit by default :statuscode 200: no error :statuscode 404: requested origin can not be found in the SWH archive, or the provided content path does not exist from the origin root directory **Examples:** .. parsed-literal:: :swh_web_browse:`origin/git/url/https://github.com/git/git/content/git.c/` :swh_web_browse:`origin/git/url/https://github.com/git/git/content/git.c/` :swh_web_browse:`origin/git/url/https://github.com/mozilla/gecko-dev/content/js/src/json.cpp/` :swh_web_browse:`origin/git/url/https://github.com/git/git/content/git.c/?branch=refs/heads/next` .. http:get:: /browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/content/(path)/ HTML view that produces a display of a SWH content associated to a visit of a SWH origin closest to a provided timestamp. If the content to display is textual, it will be highlighted client-side if possible using highlightjs_. The procedure to perform that task is described in :http:get:`/browse/content/[(algo_hash):](hash)/`. It is also possible to highlight specific lines of a textual content (not in terms of syntax highlighting but to emphasize some relevant content part) by either: * clicking on line numbers (holding shift to highlight a lines range) * using an url fragment in the form '#Ln' or '#Lm-Ln' The view displays a breadcrumb on top of the rendered content in order to easily navigate up to the origin root directory. The view also enables to easily switch between the origin branches - through a dropdown menu. + and releases through a dropdown menu. The origin branch (default to master) from which to retrieve the content can also be specified by using the branch query parameter. :param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...) :param string origin_url: the url of the origin (e.g. https://github.com/user/repo) :param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) or Unix timestamp to parse in order to find the closest SWH visit. :param string path: path of a content reachable from the origin root directory :query string branch: specify the origin branch name from which to retrieve the content :query string release: specify the origin release name from which to retrieve the content :query string revision: specify the origin revision, identified by the hexadecimal representation of its *sha1_git* value, from which to retrieve the content :query int visit_id: specify a SWH visit id to retrieve the content from instead of using the provided timestamp :statuscode 200: no error :statuscode 404: requested origin can not be found in the SWH archive, requested visit timestamp does not exist or the provided content path does not exist from the origin root directory **Examples:** .. parsed-literal:: :swh_web_browse:`origin/git/url/https://github.com/git/git/visit/1473933564/content/git.c/` :swh_web_browse:`origin/git/url/https://github.com/git/git/visit/2016-05-05T00:0:00+00:00/content/git.c/` :swh_web_browse:`origin/git/url/https://github.com/mozilla/gecko-dev/visit/1490126182/content/js/src/json.cpp/` :swh_web_browse:`origin/git/url/https://github.com/mozilla/gecko-dev/visit/2017-03-21/content/js/src/json.cpp/#L904-L931` :swh_web_browse:`origin/git/url/https://github.com/git/git/visit/2017-09-15/content/git.c/?branch=refs/heads/next` Origin history """""""""""""" .. http:get:: /browse/origin/(origin_type)/url/(origin_url)/log/ HTML view that produces a display of revisions history heading to the last revision found during the latest visit of a SWH origin. In other words, it shows the commit log associated to the latest visit of a SWH origin. The following data are displayed for each log entry: * author of the revision * link to the revision metadata * message associated the revision * date of the revision * link to browse the associated source tree in the origin context N log entries are displayed per page (default is 20). In order to navigate in a large history, two buttons are present at the bottom of the view: * *Newer*: fetch and display if available the N more recent log entries than the ones currently displayed * *Older*: fetch and display if available the N older log entries than the ones currently displayed The view also enables to easily switch between the origin branches - through a dropdown menu. + and releases through a dropdown menu. The origin branch (default to master) from which to retrieve the content can also be specified by using the branch query parameter. :param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...) :param string origin_url: the url of the origin (e.g. https://github.com/user/repo) :query string revs_breadcrumb: used internally to store the navigation breadcrumbs (i.e. the list of descendant revisions visited so far). It must be a string in the form "(rev_1)[/(rev_2)/.../(rev_n)]" where rev_i corresponds to a revision sha1_git. :query int per_page: the number of log entries to display per page (default is 20, max is 50) :query string branch: specify the origin branch name from which to retrieve the commit log :query string release: specify the origin release name from which to retrieve the commit log :query string revision: specify the origin revision, identified by the hexadecimal representation of its *sha1_git* value, from which to retrieve the commit log :query int visit_id: specify a SWH visit id to retrieve the history log from instead of using the latest visit by default :statuscode 200: no error :statuscode 404: requested origin can not be found in the SWH archive **Examples:** .. parsed-literal:: :swh_web_browse:`origin/git/url/https://github.com/videolan/vlc/log/` :swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/log/` :swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/log/?branch=refs/heads/release` .. http:get:: /browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/log/ HTML view that produces a display of revisions history heading to the last revision found during a visit of a SWH origin closest to the provided timestamp. In other words, it shows the commit log associated to a visit of a SWH origin closest to a provided timestamp. The following data are displayed for each log entry: * author of the revision * link to the revision metadata * message associated the revision * date of the revision * link to browse the associated source tree in the origin context N log entries are displayed per page (default is 20). In order to navigate in a large history, two buttons are present at the bottom of the view: * *Newer*: fetch and display if available the N more recent log entries than the ones currently displayed * *Older*: fetch and display if available the N older log entries than the ones currently displayed The view also enables to easily switch between the origin branches - through a dropdown menu. + and releases through a dropdown menu. The origin branch (default to master) from which to retrieve the content can also be specified by using the branch query parameter. :param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...) :param string origin_url: the url of the origin (e.g. https://github.com/user/repo) :param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) or Unix timestamp to parse in order to find the closest SWH visit. :query string revs_breadcrumb: used internally to store the navigation breadcrumbs (i.e. the list of descendant revisions visited so far). It must be a string in the form "(rev_1)[/(rev_2)/.../(rev_n)]" where rev_i corresponds to a revision sha1_git. :query int per_page: the number of log entries to display per page (default is 20, max is 50) :query string branch: specify the origin branch name from which to retrieve the commit log :query string release: specify the origin release name from which to retrieve the commit log :query string revision: specify the origin revision, identified by the hexadecimal representation of its *sha1_git* value, from which to retrieve the commit log :query int visit_id: specify a SWH visit id to retrieve the history log from instead of using the provided timestamp :statuscode 200: no error :statuscode 404: requested origin can not be found in the SWH archive **Examples:** .. parsed-literal:: :swh_web_browse:`origin/git/url/https://github.com/videolan/vlc/visit/1459651262/log/` :swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/visit/2016-04-01/log/` :swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/visit/1438116814/log/?branch=refs/heads/release` :swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/visit/2017-05-05T03:14:23/log/?branch=refs/heads/release` +Origin branches +""""""""""""""" + +.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/branches/ + + HTML view that produces a display of the list of branches + found during the latest visit of a SWH origin. + + The following data are displayed for each branch: + + * its name + * a link to browse the associated directory + * a link to browse the associated revision + * last commit message + * last commit date + + That list of branches is paginated, each page displaying a maximum of 20 branches. + + :param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...) + :param string origin_url: the url of the origin (e.g. https://github.com/user/repo) + :statuscode 200: no error + :statuscode 404: requested origin can not be found in the SWH archive + + **Examples:** + + .. parsed-literal:: + + :swh_web_browse:`origin/deb/url/deb://Debian/packages/linux/branches/` + :swh_web_browse:`origin/git/url/https://github.com/webpack/webpack/branches/` + +.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/branches/ + + HTML view that produces a display of the list of branches + found during a visit of a SWH origin closest to the provided timestamp. + + The following data are displayed for each branch: + + * its name + * a link to browse the associated directory + * a link to browse the associated revision + * last commit message + * last commit date + + That list of branches is paginated, each page displaying a maximum of 20 branches. + + :param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...) + :param string origin_url: the url of the origin (e.g. https://github.com/user/repo) + :param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) + or Unix timestamp to parse in order to find the closest SWH visit. + :statuscode 200: no error + :statuscode 404: requested origin can not be found in the SWH archive + + **Examples:** + + .. parsed-literal:: + + :swh_web_browse:`origin/git/url/https://github.com/kripken/emscripten/visit/2017-05-05T12:02:03/branches/` + :swh_web_browse:`origin/deb/url/deb://Debian/packages/apache2-mod-xforward/visit/2017-11-15T05:15:09/branches/` + +Origin releases +""""""""""""""" + +.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/releases/ + + HTML view that produces a display of the list of releases + found during the latest visit of a SWH origin. + + The following data are displayed for each release: + + * its name + * a link to browse the release details + * its target type (revision, directory, content or release) + * its associated message + * its date + + That list of releases is paginated, each page displaying a maximum of 20 releases. + + :param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...) + :param string origin_url: the url of the origin (e.g. https://github.com/user/repo) + :statuscode 200: no error + :statuscode 404: requested origin can not be found in the SWH archive + + **Examples:** + + .. parsed-literal:: + + :swh_web_browse:`origin/git/url/https://github.com/git/git/releases/` + :swh_web_browse:`origin/git/url/https://github.com/webpack/webpack/releases/` + +.. http:get:: /browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/releases/ + + HTML view that produces a display of the list of releases + found during the latest visit of a SWH origin. + + The following data are displayed for each release: + + * its name + * a link to browse the release details + * its target type (revision, directory, content or release) + * its associated message + * its date + + That list of releases is paginated, each page displaying a maximum of 20 releases. + + :param string origin_type: the type of the SWH origin (*git*, *svn*, *deb* ...) + :param string origin_url: the url of the origin (e.g. https://github.com/user/repo) + :param string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) + or Unix timestamp to parse in order to find the closest SWH visit. + :statuscode 200: no error + :statuscode 404: requested origin can not be found in the SWH archive + + **Examples:** + + .. parsed-literal:: + + :swh_web_browse:`origin/git/url/https://github.com/torvalds/linux/visit/2017-11-21T19:37:42/releases/` + :swh_web_browse:`origin/git/url/https://github.com/Kitware/CMake/visit/2016-09-23T14:06:35/releases/` + .. _highlightjs: https://highlightjs.org/ .. _dateutil.parser.parse: http://dateutil.readthedocs.io/en/stable/parser.html diff --git a/docs/uri-scheme-browse-release.rst b/docs/uri-scheme-browse-release.rst new file mode 100644 index 00000000..1938b52a --- /dev/null +++ b/docs/uri-scheme-browse-release.rst @@ -0,0 +1,23 @@ +Release +^^^^^^^ + +.. http:get:: /browse/release/(sha1_git)/ + + HTML view that displays metadata associated to a SWH release: + + * the author + * the release date + * the release name + * the associated message + * the type of target the release points to (revision, directory, content or relase) + * the link to browse the release target + + :param string sha1_git: hexadecimal representation for the *sha1_git* + identifier of a SWH release + :statuscode 200: no error + :statuscode 404: requested release can not be found in the SWH archive + + .. parsed-literal:: + + :swh_web_browse:`release/208f61cc7a5dbc9879ae6e5c2f95891e270f09ef/` + :swh_web_browse:`release/f883596e997fe5bcbc5e89bee01b869721326109/` diff --git a/docs/uri-scheme-browse.rst b/docs/uri-scheme-browse.rst index 359f9897..cb245f8c 100644 --- a/docs/uri-scheme-browse.rst +++ b/docs/uri-scheme-browse.rst @@ -1,92 +1,94 @@ URI scheme for SWH Web Browse application ========================================= This web application aims to provide HTML views to easily navigate in the SWH archive, thus it needs to be reached from a web browser. If you intend to query the SWH archive programmatically through any HTTP client, please refer to the :ref:`swh-web-api-urls` section instead. Context-independent browsing ---------------------------- Context-independent URLs provide information about SWH objects (e.g., revisions, directories, contents, person, ...), independently of the contexts where they have been found (e.g., specific repositories, branches, commits, ...). The following endpoints are the same of the API case (see below), and just render the corresponding information for user consumption. Where hyperlinks are created, they always point to other context-independent user URLs: * :http:get:`/browse/content/[(algo_hash):](hash)/`: Display a SWH content * :http:get:`/browse/content/[(algo_hash):](hash)/raw/`: Get / Download SWH content raw data * :http:get:`/browse/directory/(sha1_git)/[(path)/]`: Browse the content of a SWH directory * :http:get:`/browse/person/(person_id)/`: Information on a SWH person * :http:get:`/browse/revision/(sha1_git)/`: Browse a SWH revision * :http:get:`/browse/revision/(sha1_git)/log/`: Browse history log heading to a SWH revision Context-dependent browsing -------------------------- Context-dependent URLs provide information about SWH objects, limited to specific contexts where the objects have been found. For instance, instead of having to specify a (root) revision by *sha1_git*, users might want to specify a place and a time. In SWH a "place" is an origin, with an optional branch name; a "time" is a timestamp at which some place has been observed by SWH crawlers. Wherever a revision context is expected in a path (i.e., a **/browse/revision/(sha1_git)/** path fragment) we can put in its stead a path fragment of the form **/origin/(origin_type)/url/(origin_url)/[/visit/(timestamp)/][?branch=(branch)]**. Such a fragment is resolved, internally by the SWH archive, to a *sha1_git* as follows: - if *timestamp* is absent: look for the most recent crawl of origin *origin_id* - if *timestamp* is given: look for the closest crawl of origin *origin_id* from timestamp *timestamp* - if *branch* is given as a query parameter: look for the branch *branch* - if *branch* is absent: look for branch "HEAD" or "master" - return the *sha1_git* pointed by the chosen branch The already mentioned URLs for revision contexts can therefore be alternatively specified by users as: * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/directory/[(path)/]` * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/directory/[(path)/]` * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/content/(path)/` * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/content/(path)/` * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/log/` * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/log/` Typing: - *origin_id* is given as an integer identifier, pointing into the origin table. There will be separate mechanisms for finding origins by other means (e.g., URLs, metadata, etc). - *branch* name is given as per the corresponding VCS (e.g., Git) as a query parameter to the requestes URL. - *timestamp* is given in a format as liberal as possible, to uphold the principle of least surprise. At the very minimum it is possible to enter timestamps as: - Unix epoch timestamp (see for instance the output of `date +%s`) - ISO 8601 timestamps (see for instance the output of `date -I`, `date -Is`) - YYYY[MM[DD[HH[MM[SS]]]]] ad-hoc format - YYYY[-MM[-DD[ HH:[MM:[SS:]]]]] ad-hoc format SWH Browse Urls --------------- .. include:: uri-scheme-browse-content.rst .. include:: uri-scheme-browse-directory.rst .. include:: uri-scheme-browse-origin.rst .. include:: uri-scheme-browse-person.rst .. include:: uri-scheme-browse-revision.rst + +.. include:: uri-scheme-browse-release.rst \ No newline at end of file diff --git a/swh/web/browse/urls.py b/swh/web/browse/urls.py index c65ffbb5..a7333c9a 100644 --- a/swh/web/browse/urls.py +++ b/swh/web/browse/urls.py @@ -1,36 +1,37 @@ # Copyright (C) 2017-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information from django.conf.urls import url from django.shortcuts import render import swh.web.browse.views.directory # noqa import swh.web.browse.views.content # noqa import swh.web.browse.views.origin # noqa import swh.web.browse.views.person # noqa +import swh.web.browse.views.release # noqa import swh.web.browse.views.revision # noqa from swh.web.browse.browseurls import BrowseUrls def default_browse_view(request): """Default django view used as an entry point for the swh browse ui web application. The url that point to it is /browse/. Args: request: input django http request """ return render(request, 'person.html', {'heading': 'Browse the Software Heritage archive', 'empty_browse': True}) urlpatterns = [ url(r'^$', default_browse_view, name='browse-homepage') ] urlpatterns += BrowseUrls.get_url_patterns() diff --git a/swh/web/browse/utils.py b/swh/web/browse/utils.py index 41df77c5..21e93bf4 100644 --- a/swh/web/browse/utils.py +++ b/swh/web/browse/utils.py @@ -1,555 +1,733 @@ # Copyright (C) 2017-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information import base64 import dateutil import magic import math import stat import textwrap from django.core.cache import cache from django.utils.safestring import mark_safe from swh.web.common import highlightjs, service from swh.web.common.exc import NotFoundExc from swh.web.common.utils import ( reverse, format_utc_iso_date, parse_timestamp ) def get_directory_entries(sha1_git): """Function that retrieves the content of a SWH directory from the SWH archive. The directories entries are first sorted in lexicographical order. Sub-directories and regular files are then extracted. Args: sha1_git: sha1_git identifier of the directory Returns: A tuple whose first member corresponds to the sub-directories list and second member the regular files list Raises: NotFoundExc if the directory is not found """ cache_entry_id = 'directory_entries_%s' % sha1_git cache_entry = cache.get(cache_entry_id) if cache_entry: return cache_entry entries = list(service.lookup_directory(sha1_git)) entries = sorted(entries, key=lambda e: e['name']) for entry in entries: entry['perms'] = stat.filemode(entry['perms']) dirs = [e for e in entries if e['type'] == 'dir'] files = [e for e in entries if e['type'] == 'file'] cache.set(cache_entry_id, (dirs, files)) return dirs, files def get_mimetype_and_encoding_for_content(content): """Function that returns the mime type and the encoding associated to a content buffer using the magic module under the hood. Args: content (bytes): a content buffer Returns: A tuple (mimetype, encoding), for instance ('text/plain', 'us-ascii'), associated to the provided content. """ magic_result = magic.detect_from_content(content) return magic_result.mime_type, magic_result.encoding def request_content(query_string): """Function that retrieves a SWH content from the SWH archive. Raw bytes content is first retrieved, then the content mime type. If the mime type is not stored in the archive, it will be computed using Python magic module. Args: query_string: a string of the form "[ALGO_HASH:]HASH" where optional ALGO_HASH can be either *sha1*, *sha1_git*, *sha256*, or *blake2s256* (default to *sha1*) and HASH the hexadecimal representation of the hash value Returns: A tuple whose first member corresponds to the content raw bytes and second member the content mime type Raises: NotFoundExc if the content is not found """ content_data = service.lookup_content(query_string) content_raw = service.lookup_content_raw(query_string) content_data['raw_data'] = content_raw['data'] filetype = service.lookup_content_filetype(query_string) language = service.lookup_content_language(query_string) license = service.lookup_content_license(query_string) if filetype: mimetype = filetype['mimetype'] encoding = filetype['encoding'] else: mimetype, encoding = \ get_mimetype_and_encoding_for_content(content_data['raw_data']) content_data['mimetype'] = mimetype content_data['encoding'] = encoding # encode textual content to utf-8 if needed if mimetype.startswith('text/') and 'ascii' not in encoding \ and 'utf-8' not in encoding: content_data['raw_data'] = \ content_data['raw_data'].decode(encoding).encode('utf-8') if language: content_data['language'] = language['lang'] else: content_data['language'] = 'not detected' if license: content_data['licenses'] = ', '.join(license['licenses']) else: content_data['licenses'] = 'not detected' return content_data _browsers_supported_image_mimes = set(['image/gif', 'image/png', 'image/jpeg', 'image/bmp', 'image/webp']) def prepare_content_for_display(content_data, mime_type, path): """Function that prepares a content for HTML display. The function tries to associate a programming language to a content in order to perform syntax highlighting client-side using highlightjs. The language is determined using either the content filename or its mime type. If the mime type corresponds to an image format supported by web browsers, the content will be encoded in base64 for displaying the image. Args: content_data (bytes): raw bytes of the content mime_type (string): mime type of the content path (string): path of the content including filename Returns: A dict containing the content bytes (possibly different from the one provided as parameter if it is an image) under the key 'content_data and the corresponding highlightjs language class under the key 'language'. """ language = highlightjs.get_hljs_language_from_filename(path) if not language: language = highlightjs.get_hljs_language_from_mime_type(mime_type) if not language: language = 'nohighlight-swh' elif mime_type.startswith('application/'): mime_type = mime_type.replace('application/', 'text/') if mime_type.startswith('image/'): if mime_type in _browsers_supported_image_mimes: content_data = base64.b64encode(content_data) else: content_data = None return {'content_data': content_data, 'language': language} def get_origin_visits(origin_info): """Function that returns the list of visits for a swh origin. That list is put in cache in order to speedup the navigation in the swh web browse ui. Args: origin_id (int): the id of the swh origin to fetch visits from Returns: A list of dict describing the origin visits:: [{'date': , 'origin': , 'status': <'full' | 'partial'>, 'visit': }, ... ] Raises: NotFoundExc if the origin is not found """ cache_entry_id = 'origin_%s_visits' % origin_info['id'] cache_entry = cache.get(cache_entry_id) if cache_entry: return cache_entry origin_visits = [] per_page = service.MAX_LIMIT last_visit = None while 1: visits = list(service.lookup_origin_visits(origin_info['id'], last_visit=last_visit, per_page=per_page)) origin_visits += visits if len(visits) < per_page: break else: if not last_visit: last_visit = per_page else: last_visit += per_page def _visit_sort_key(visit): ts = dateutil.parser.parse(visit['date']).timestamp() return ts + (float(visit['visit']) / 10e3) for v in origin_visits: - del v['metadata'] + if 'metadata' in v: + del v['metadata'] origin_visits = [dict(t) for t in set([tuple(d.items()) for d in origin_visits])] origin_visits = sorted(origin_visits, key=lambda v: _visit_sort_key(v)) cache.set(cache_entry_id, origin_visits) return origin_visits def get_origin_visit(origin_info, visit_ts=None, visit_id=None): """Function that returns information about a SWH visit for a given origin. The visit is retrieved from a provided timestamp. The closest visit from that timestamp is selected. Args: 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 Returns: A dict containing the visit info as described below:: {'origin': 2, 'date': '2017-10-08T11:54:25.582463+00:00', 'metadata': {}, 'visit': 25, 'status': 'full'} """ visits = get_origin_visits(origin_info) if not visits: raise NotFoundExc('No SWH visit associated to origin with' ' type %s and url %s!' % (origin_info['type'], origin_info['url'])) if visit_id: visit = [v for v in visits if v['visit'] == int(visit_id)] if len(visit) == 0: raise NotFoundExc( 'Visit with id %s for origin with type %s' ' and url %s not found!' % (visit_id, origin_info['type'], origin_info['url'])) return visit[0] if not visit_ts: return visits[-1] parsed_visit_ts = math.floor(parse_timestamp(visit_ts).timestamp()) visit_idx = None for i, visit in enumerate(visits): ts = math.floor(parse_timestamp(visit['date']).timestamp()) if i == 0 and parsed_visit_ts <= ts: return visit elif i == len(visits) - 1: if parsed_visit_ts >= ts: return visit else: next_ts = math.floor( parse_timestamp(visits[i+1]['date']).timestamp()) if parsed_visit_ts >= ts and parsed_visit_ts < next_ts: if (parsed_visit_ts - ts) < (next_ts - parsed_visit_ts): visit_idx = i break else: visit_idx = i+1 break if visit_idx: visit = visits[visit_idx] while visit_idx < len(visits) - 1 and \ visit['date'] == visits[visit_idx+1]['date']: visit_idx = visit_idx + 1 visit = visits[visit_idx] return visit else: raise NotFoundExc( 'Visit with timestamp %s for origin with type %s and url %s not found!' % # noqa (visit_ts, origin_info['type'], origin_info['url'])) def get_origin_visit_occurrences(origin_info, visit_ts=None, visit_id=None): """Function that returns the lists of branches and releases associated to a swh origin for a given visit. The visit is expressed by a timestamp. In the latter case, the closest visit from the provided timestamp will be used. If no visit parameter is provided, it returns the list of branches found for the latest visit. That list is put in cache in order to speedup the navigation in the swh web browse ui. Args: 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_id (int): optional visit id for desambiguation in case several visits have the same timestamp Returns: A tuple with two members. The first one is a list of dict describing the origin branches for the given visit:: [{'name': , 'revision': , 'directory': }, ... ] The second one is a list of dict describing the origin branches for the given visit. Raises: NotFoundExc if the origin or its visit are not found """ visit_info = get_origin_visit(origin_info, visit_ts, visit_id) - visit_id = visit_info['visit'] + visit = visit_info['visit'] cache_entry_id = 'origin_%s_visit_%s_occurrences' % (origin_info['id'], - visit_id) + visit) cache_entry = cache.get(cache_entry_id) if cache_entry: return cache_entry['branches'], cache_entry['releases'] origin_visit_data = service.lookup_origin_visit(origin_info['id'], - visit_id) + visit) branches = [] releases = [] revision_ids = [] releases_ids = [] occurrences = origin_visit_data['occurrences'] for key in sorted(occurrences.keys()): if occurrences[key]['target_type'] == 'revision': branches.append({'name': key, 'revision': occurrences[key]['target']}) revision_ids.append(occurrences[key]['target']) elif occurrences[key]['target_type'] == 'release': releases_ids.append(occurrences[key]['target']) releases_info = service.lookup_release_multiple(releases_ids) for release in releases_info: releases.append({'name': release['name'], - 'release': release['id'], - 'revision': release['target']}) + 'date': format_utc_iso_date(release['date']), + 'id': release['id'], + 'message': release['message'], + 'target_type': release['target_type'], + 'target': release['target']}) revision_ids.append(release['target']) revisions = service.lookup_revision_multiple(revision_ids) branches_to_remove = [] - releases_to_remove = [] for idx, revision in enumerate(revisions): if idx < len(branches): if revision: branches[idx]['directory'] = revision['directory'] + branches[idx]['date'] = format_utc_iso_date(revision['date']) + branches[idx]['message'] = revision['message'] else: branches_to_remove.append(branches[idx]) else: rel_idx = idx - len(branches) if revision: releases[rel_idx]['directory'] = revision['directory'] - else: - releases_to_remove.append(releases[rel_idx]) for b in branches_to_remove: branches.remove(b) - for b in releases_to_remove: - releases.remove(b) - cache.set(cache_entry_id, {'branches': branches, 'releases': releases}) return branches, releases def gen_link(url, link_text): """ Utility function for generating an HTML link to insert in Django templates. Args: url (str): an url link_text (str): the text for the produced link Returns: An HTML link in the form 'link_text' """ link = '%s' % (url, link_text) return mark_safe(link) def gen_person_link(person_id, person_name): """ Utility function for generating a link to a SWH person HTML view to insert in Django templates. Args: person_id (int): a SWH person id person_name (str): the associated person name Returns: An HTML link in the form 'person_name' """ person_url = reverse('browse-person', kwargs={'person_id': person_id}) return gen_link(person_url, person_name) -def gen_revision_link(revision_id, shorten_id=False, origin_info=None): +def gen_revision_link(revision_id, shorten_id=False, origin_context=None): """ Utility function for generating a link to a SWH revision HTML view to insert in Django templates. Args: revision_id (int): a SWH revision id shorten_id (boolean): wheter to shorten the revision id to 7 characters for the link text Returns: An HTML link in the form 'revision_id' """ query_params = None - if origin_info: + if origin_context: + origin_info = origin_context['origin_info'] query_params = {'origin_type': origin_info['type'], 'origin_url': origin_info['url']} + if 'timestamp' in origin_context['url_args']: + query_params['timestamp'] = \ + origin_context['url_args']['timestamp'] + if 'visit_id' in origin_context['query_params']: + query_params['visit_id'] = \ + origin_context['query_params']['visit_id'] + revision_url = reverse('browse-revision', kwargs={'sha1_git': revision_id}, query_params=query_params) if shorten_id: return gen_link(revision_url, revision_id[:7]) else: return gen_link(revision_url, revision_id) def gen_origin_link(origin_info): """ Utility function for generating a link to a SWH origin HTML view to insert in Django templates. Args: origin_info (dict): a dicted filled with origin information (id, type, url) Returns: An HTML link in the form 'Origin: origin_url' """ # noqa origin_browse_url = reverse('browse-origin', kwargs={'origin_type': origin_info['type'], 'origin_url': origin_info['url']}) return gen_link(origin_browse_url, 'Origin: ' + origin_info['url']) -def _format_log_entries(revision_log, per_page, origin_info=None): +def gen_directory_link(sha1_git, link_text=None): + """ + Utility function for generating a link to a SWH directory HTML view + to insert in Django templates. + + Args: + sha1_git (str): directory identifier + link_text (str): optional text for the generated link + (the generated url will be used by default) + + Returns: + An HTML link in the form 'link_text' + + """ + directory_url = reverse('browse-directory', + kwargs={'sha1_git': sha1_git}) + if not link_text: + link_text = directory_url + return gen_link(directory_url, link_text) + + +def gen_origin_directory_link(origin_context, revision_id=None): + """ + Utility function for generating a link to a SWH directory HTML view + in the context of an origin to insert in Django templates. + + Args: + origin_info (dict): the origin information (type and url) + revision_id (str): optional revision identifier in order + to use the associated directory + + Returns: + An HTML link in the form + 'origin_directory_view_url' + """ + origin_info = origin_context['origin_info'] + url_args = {'origin_type': origin_info['type'], + 'origin_url': origin_info['url']} + query_params = {'revision': revision_id} + if 'timestamp' in origin_context['url_args']: + url_args['timestamp'] = \ + origin_context['url_args']['timestamp'] + if 'visit_id' in origin_context['query_params']: + query_params['visit_id'] = \ + origin_context['query_params']['visit_id'] + directory_url = reverse('browse-origin-directory', + kwargs=url_args, + query_params=query_params) + return gen_link(directory_url, directory_url) + + +def gen_revision_log_link(revision_id, origin_context=None, link_text=None): + """ + Utility function for generating a link to a SWH revision log HTML view + (possibly in the context of an origin) to insert in Django templates. + + Args: + revision_id (str): revision identifier the history heads to + origin_info (dict): optional origin information + link_text (str): optional text to use for the generated link + + Returns: + An HTML link in the form + 'link_text' + """ + if origin_context: + origin_info = origin_context['origin_info'] + url_args = {'origin_type': origin_info['type'], + 'origin_url': origin_info['url']} + query_params = {'revision': revision_id} + if 'timestamp' in origin_context['url_args']: + url_args['timestamp'] = \ + origin_context['url_args']['timestamp'] + if 'visit_id' in origin_context['query_params']: + query_params['visit_id'] = \ + origin_context['query_params']['visit_id'] + revision_log_url = reverse('browse-origin-log', + kwargs=url_args, + query_params=query_params) + else: + revision_log_url = reverse('browse-revision-log', + kwargs={'sha1_git': revision_id}) + if not link_text: + link_text = revision_log_url + return gen_link(revision_log_url, link_text) + + +def _format_log_entries(revision_log, per_page, origin_context=None): revision_log_data = [] for i, log in enumerate(revision_log): if i == per_page: break revision_log_data.append( {'author': gen_person_link(log['author']['id'], log['author']['name']), - 'revision': gen_revision_link(log['id'], True, origin_info), + 'revision': gen_revision_link(log['id'], True, origin_context), 'message': log['message'], 'message_shorten': textwrap.shorten(log['message'], width=80, placeholder='...'), 'date': format_utc_iso_date(log['date']), 'directory': log['directory']}) return revision_log_data def prepare_revision_log_for_display(revision_log, per_page, revs_breadcrumb, - origin_context=False, origin_info=None): + origin_context=None): """ Utility functions that process raw revision log data for HTML display. Its purpose is to: * add links to relevant SWH browse views * format date in human readable format * truncate the message log It also computes the data needed to generate the links for navigating back and forth in the history log. Args: revision_log (list): raw revision log as returned by the SWH web api per_page (int): number of log entries per page revs_breadcrumb (str): breadcrumbs of revisions navigated so far, in the form 'rev1[/rev2/../revN]'. Each revision corresponds to the first one displayed in the HTML view for history log. origin_context (boolean): wheter or not the revision log is browsed from an origin view. """ current_rev = revision_log[0]['id'] next_rev = None prev_rev = None next_revs_breadcrumb = None prev_revs_breadcrumb = None if len(revision_log) == per_page + 1: prev_rev = revision_log[-1]['id'] prev_rev_bc = current_rev if origin_context: prev_rev_bc = prev_rev if revs_breadcrumb: revs = revs_breadcrumb.split('/') next_rev = revs[-1] if len(revs) > 1: next_revs_breadcrumb = '/'.join(revs[:-1]) if len(revision_log) == per_page + 1: prev_revs_breadcrumb = revs_breadcrumb + '/' + prev_rev_bc else: prev_revs_breadcrumb = prev_rev_bc return {'revision_log_data': _format_log_entries(revision_log, per_page, - origin_info), + origin_context), 'prev_rev': prev_rev, 'prev_revs_breadcrumb': prev_revs_breadcrumb, 'next_rev': next_rev, 'next_revs_breadcrumb': next_revs_breadcrumb} + + +def get_origin_context(origin_type, origin_url, timestamp, visit_id=None): + """ + Utility function to compute relevant information when navigating + the SWH archive in an origin context. + + Args: + origin_type (str): the origin type (git, svn, deposit, ...) + origin_url (str): the origin_url (e.g. https://github.com//) + timestamp (str): a datetime string for retrieving the closest + SWH visit of the origin + visit_id (int): optional visit id for disambiguation in case + of several visits with the same timestamp + + Returns: + A dict with the following entries: + * origin_info: dict containing origin information + * visit_info: dict containing SWH visit information + * branches: the list of branches for the origin found + during the visit + * releases: the list of releases for the origin found + during the visit + * origin_browse_url: the url to browse the origin + * origin_branches_url: the url to browse the origin branches + * origin_releases_url': the url to browse the origin releases + * origin_visit_url: the url to browse the snapshot of the origin + found during the visit + * url_args: dict containg url arguments to use when browsing in + the context of the origin and its visit + """ # noqa + origin_info = service.lookup_origin({'type': origin_type, + 'url': origin_url}) + + visit_info = get_origin_visit(origin_info, timestamp, visit_id) + visit_info['fmt_date'] = format_utc_iso_date(visit_info['date']) + + # provided timestamp is not necessarily equals to the one + # of the retrieved visit, so get the exact one in order + # use it in the urls generated below + if timestamp: + timestamp = visit_info['date'] + + branches, releases = \ + get_origin_visit_occurrences(origin_info, timestamp, visit_id) + + releases = list(reversed(releases)) + + url_args = {'origin_type': origin_info['type'], + 'origin_url': origin_info['url']} + + if timestamp: + url_args['timestamp'] = format_utc_iso_date(timestamp, + '%Y-%m-%dT%H:%M:%S') + + origin_browse_url = reverse('browse-origin', + kwargs={'origin_type': origin_info['type'], + 'origin_url': origin_info['url']}) + + origin_visit_url = reverse('browse-origin-directory', + kwargs=url_args, + query_params={'visit_id': visit_id}) + + origin_branches_url = reverse('browse-origin-branches', + kwargs=url_args, + query_params={'visit_id': visit_id}) + + origin_releases_url = reverse('browse-origin-releases', + kwargs=url_args, + query_params={'visit_id': visit_id}) + + return { + 'origin_info': origin_info, + 'visit_info': visit_info, + 'branches': branches, + 'releases': releases, + 'origin_browse_url': origin_browse_url, + 'origin_branches_url': origin_branches_url, + 'origin_releases_url': origin_releases_url, + 'origin_visit_url': origin_visit_url, + 'url_args': url_args, + 'query_params': {'visit_id': visit_id} + } diff --git a/swh/web/browse/views/content.py b/swh/web/browse/views/content.py index d1df4789..0bcde9c5 100644 --- a/swh/web/browse/views/content.py +++ b/swh/web/browse/views/content.py @@ -1,159 +1,157 @@ # Copyright (C) 2017-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information from django.http import HttpResponse from django.utils.safestring import mark_safe from django.shortcuts import render from django.template.defaultfilters import filesizeformat from swh.model.hashutil import hash_to_hex from swh.web.common import query from swh.web.common.utils import reverse, gen_path_info from swh.web.common.exc import handle_view_exception from swh.web.browse.utils import ( request_content, prepare_content_for_display ) from swh.web.browse.browseurls import browse_route @browse_route(r'content/(?P.+)/raw/', view_name='browse-content-raw') def content_raw(request, query_string): """Django view that produces a raw display of a SWH content identified by its hash value. The url that points to it is :http:get:`/browse/content/[(algo_hash):](hash)/raw/` Args: request: input django http request query_string: a string of the form "[ALGO_HASH:]HASH" where optional ALGO_HASH can be either *sha1*, *sha1_git*, *sha256*, or *blake2s256* (default to *sha1*) and HASH the hexadecimal representation of the hash value Returns: The raw bytes of the content. """ # noqa try: algo, checksum = query.parse_hash(query_string) checksum = hash_to_hex(checksum) content_data = request_content(query_string) except Exception as exc: return handle_view_exception(request, exc) filename = request.GET.get('filename', None) if not filename: filename = '%s_%s' % (algo, checksum) if content_data['mimetype'].startswith('text/'): response = HttpResponse(content_data['raw_data'], content_type="text/plain") response['Content-disposition'] = 'filename=%s' % filename else: response = HttpResponse(content_data['raw_data'], content_type='application/octet-stream') response['Content-disposition'] = 'attachment; filename=%s' % filename return response @browse_route(r'content/(?P.+)/', view_name='browse-content') def content_display(request, query_string): """Django view that produces an HTML display of a SWH content identified by its hash value. The url that points to it is :http:get:`/browse/content/[(algo_hash):](hash)/` Args: request: input django http request query_string: a string of the form "[ALGO_HASH:]HASH" where optional ALGO_HASH can be either *sha1*, *sha1_git*, *sha256*, or *blake2s256* (default to *sha1*) and HASH the hexadecimal representation of the hash value Returns: The HTML rendering of the requested content. """ # noqa try: algo, checksum = query.parse_hash(query_string) checksum = hash_to_hex(checksum) content_data = request_content(query_string) except Exception as exc: return handle_view_exception(request, exc) path = request.GET.get('path', None) content_display_data = prepare_content_for_display( content_data['raw_data'], content_data['mimetype'], path) root_dir = None filename = None path_info = None breadcrumbs = [] if path: split_path = path.split('/') root_dir = split_path[0] filename = split_path[-1] path = path.replace(root_dir + '/', '') path = path.replace(filename, '') path_info = gen_path_info(path) breadcrumbs.append({'name': root_dir[:7], 'url': reverse('browse-directory', kwargs={'sha1_git': root_dir})}) for pi in path_info: breadcrumbs.append({'name': pi['name'], 'url': reverse('browse-directory', kwargs={'sha1_git': root_dir, 'path': pi['path']})}) breadcrumbs.append({'name': filename, 'url': None}) query_params = None if filename: query_params = {'filename': filename} content_raw_url = reverse('browse-content-raw', kwargs={'query_string': query_string}, query_params=query_params) content_metadata = { 'sha1 checksum': content_data['checksums']['sha1'], 'sha1_git checksum': content_data['checksums']['sha1_git'], 'sha256 checksum': content_data['checksums']['sha256'], 'blake2s256 checksum': content_data['checksums']['blake2s256'], 'mime type': content_data['mimetype'], 'encoding': content_data['encoding'], 'size': filesizeformat(content_data['length']), 'language': content_data['language'], 'licenses': content_data['licenses'] } return render(request, 'content.html', {'empty_browse': False, 'heading': 'Content information', 'top_panel_visible': True, 'top_panel_collapsible': True, - 'top_panel_text_left': 'SWH object: Content', - 'top_panel_text_right': '%s: %s' % (algo, checksum), + 'top_panel_text': 'SWH object: Content', 'swh_object_metadata': content_metadata, 'main_panel_visible': True, 'content': content_display_data['content_data'], 'mimetype': content_data['mimetype'], 'language': content_display_data['language'], 'breadcrumbs': breadcrumbs, - 'branches': None, - 'branch': None, 'top_right_link': content_raw_url, 'top_right_link_text': mark_safe( 'Raw File') + 'Raw File'), + 'origin_context': None }) diff --git a/swh/web/browse/views/directory.py b/swh/web/browse/views/directory.py index a0c405ae..d3b9b382 100644 --- a/swh/web/browse/views/directory.py +++ b/swh/web/browse/views/directory.py @@ -1,108 +1,106 @@ # Copyright (C) 2017-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information from django.shortcuts import render from django.template.defaultfilters import filesizeformat from swh.web.common import service from swh.web.common.utils import reverse, gen_path_info from swh.web.common.exc import handle_view_exception from swh.web.browse.utils import get_directory_entries from swh.web.browse.browseurls import browse_route @browse_route(r'directory/(?P[0-9a-f]+)/', r'directory/(?P[0-9a-f]+)/(?P.+)/', view_name='browse-directory') def directory_browse(request, sha1_git, path=None): """Django view for browsing the content of a SWH directory identified by its sha1_git value. The url that points to it is :http:get:`/browse/directory/(sha1_git)/[(path)/]` Args: request: input django http request sha1_git: swh sha1_git identifer of the directory to browse path: optionnal path parameter used to navigate in directories reachable from the provided root one Returns: The HTML rendering for the content of the provided directory. """ # noqa root_sha1_git = sha1_git try: if path: dir_info = service.lookup_directory_with_path(sha1_git, path) sha1_git = dir_info['target'] dirs, files = get_directory_entries(sha1_git) except Exception as exc: return handle_view_exception(request, exc) path_info = gen_path_info(path) breadcrumbs = [] breadcrumbs.append({'name': root_sha1_git[:7], 'url': reverse('browse-directory', kwargs={'sha1_git': root_sha1_git})}) for pi in path_info: breadcrumbs.append({'name': pi['name'], 'url': reverse('browse-directory', kwargs={'sha1_git': root_sha1_git, 'path': pi['path']})}) path = '' if path is None else (path + '/') for d in dirs: d['url'] = reverse('browse-directory', kwargs={'sha1_git': root_sha1_git, 'path': path + d['name']}) sum_file_sizes = 0 readme_name = None readme_url = None for f in files: query_string = 'sha1_git:' + f['target'] f['url'] = reverse('browse-content', kwargs={'query_string': query_string}, query_params={'path': root_sha1_git + '/' + path + f['name']}) sum_file_sizes += f['length'] f['length'] = filesizeformat(f['length']) if f['name'].lower().startswith('readme'): readme_name = f['name'] readme_sha1 = f['checksums']['sha1'] readme_url = reverse('browse-content-raw', kwargs={'query_string': readme_sha1}) sum_file_sizes = filesizeformat(sum_file_sizes) dir_metadata = {'id': sha1_git, 'number of regular files': len(files), 'number of subdirectories': len(dirs), 'sum of regular file sizes': sum_file_sizes} return render(request, 'directory.html', {'empty_browse': False, 'heading': 'Directory information', 'top_panel_visible': True, 'top_panel_collapsible': True, - 'top_panel_text_left': 'SWH object: Directory', - 'top_panel_text_right': 'Sha1 git: ' + sha1_git, + 'top_panel_text': 'SWH object: Directory', 'swh_object_metadata': dir_metadata, 'main_panel_visible': True, 'dirs': dirs, 'files': files, 'breadcrumbs': breadcrumbs, - 'branches': None, - 'branch': None, 'top_right_link': None, 'top_right_link_text': None, 'readme_name': readme_name, - 'readme_url': readme_url}) + 'readme_url': readme_url, + 'origin_context': None}) diff --git a/swh/web/browse/views/origin.py b/swh/web/browse/views/origin.py index 28632a4a..f47032fc 100644 --- a/swh/web/browse/views/origin.py +++ b/swh/web/browse/views/origin.py @@ -1,736 +1,848 @@ # Copyright (C) 2017-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information import dateutil import json from distutils.util import strtobool from django.http import HttpResponse from django.shortcuts import render from django.utils.safestring import mark_safe from django.template.defaultfilters import filesizeformat from swh.web.common import service from swh.web.common.utils import ( gen_path_info, reverse, format_utc_iso_date ) from swh.web.common.exc import NotFoundExc, handle_view_exception from swh.web.browse.utils import ( - get_origin_visits, get_origin_visit, get_origin_visit_occurrences, + get_origin_visits, get_directory_entries, request_content, prepare_content_for_display, gen_link, - prepare_revision_log_for_display, gen_origin_link + prepare_revision_log_for_display, + get_origin_context ) from swh.web.browse.browseurls import browse_route -def _get_origin_url_args(origin_info, timestamp): - url_args = {'origin_type': origin_info['type'], - 'origin_url': origin_info['url']} - if timestamp: - url_args['timestamp'] = format_utc_iso_date(timestamp, - '%Y-%m-%dT%H:%M:%S') - return url_args - - def _occurrence_not_found(origin_info, timestamp, branch_type, occurrence, occurrences, visit_id=None): """ Utility function to raise an exception when a specified branch/release can not be found. """ if branch_type: occ_type = 'Branch' occ_type_plural = 'branches' else: occ_type = 'Release' occ_type_plural = 'releases' if visit_id: if len(occurrences) == 0: raise NotFoundExc('Origin with type %s and url %s' ' for visit with id %s has an empty list' ' of %s!' % (origin_info['type'], origin_info['url'], visit_id, occ_type_plural)) else: raise NotFoundExc('%s %s associated to visit with' ' id %s for origin with type %s and url %s' ' not found!' % (occ_type, occurrence, visit_id, origin_info['type'], origin_info['url'])) else: if len(occurrences) == 0: raise NotFoundExc('Origin with type %s and url %s' ' for visit with timestamp %s has an empty list' ' of %s!' % (origin_info['type'], origin_info['url'], timestamp, occ_type_plural)) else: raise NotFoundExc('%s %s associated to visit with' ' timestamp %s for origin with type %s' ' and url %s not found!' % (occ_type, occurrence, timestamp, origin_info['type'], origin_info['url'])) def _get_branch(branches, branch_name): """ Utility function to get a specific branch from an origin branches list. Its purpose is to get the default HEAD branch as some SWH origin (e.g those with svn type) does not have it. In that latter case, check if there is a master branch instead and returns it. """ filtered_branches = \ [b for b in branches if b['name'].endswith(branch_name)] if len(filtered_branches) > 0: return filtered_branches[0] elif branch_name == 'HEAD': filtered_branches = \ [b for b in branches if b['name'].endswith('master')] if len(filtered_branches) > 0: return filtered_branches[0] elif len(branches) > 0: return branches[0] return None def _get_release(releases, release_name): filtered_releases = \ [r for r in releases if r['name'] == release_name] if len(filtered_releases) > 0: return filtered_releases[0] else: return None def _process_origin_request(request, origin_type, origin_url, timestamp, path, browse_view_name): """ Utility function to perform common input request processing for origin context views. """ - request_data = {} - - origin_info = service.lookup_origin({ - 'type': origin_type, - 'url': origin_url - }) - visit_id = request.GET.get('visit_id', None) - visit_info = get_origin_visit(origin_info, timestamp, visit_id) - - if timestamp: - timestamp = visit_info['date'] - - branches, releases = \ - get_origin_visit_occurrences(origin_info, timestamp, visit_id) - - url_args = _get_origin_url_args(origin_info, timestamp) + origin_context = get_origin_context(origin_type, origin_url, + timestamp, visit_id) - for b in branches: - branch_url_args = dict(url_args) + for b in origin_context['branches']: + branch_url_args = dict(origin_context['url_args']) if path: b['path'] = path branch_url_args['path'] = path b['url'] = reverse(browse_view_name, kwargs=branch_url_args, query_params={'branch': b['name'], 'visit_id': visit_id}) - for r in releases: - release_url_args = dict(url_args) + for r in origin_context['releases']: + release_url_args = dict(origin_context['url_args']) if path: r['path'] = path release_url_args['path'] = path r['url'] = reverse(browse_view_name, kwargs=release_url_args, query_params={'release': r['name'], 'visit_id': visit_id}) root_sha1_git = None - query_params = {'visit_id': visit_id} + query_params = origin_context['query_params'] revision_id = request.GET.get('revision', None) release_name = request.GET.get('release', None) branch_name = None if revision_id: revision = service.lookup_revision(revision_id) root_sha1_git = revision['directory'] - branches.append({'name': revision_id, - 'revision': revision_id, - 'directory': root_sha1_git, - 'url': None}) + origin_context['branches'].append({'name': revision_id, + 'revision': revision_id, + 'directory': root_sha1_git, + 'url': None}) branch_name = revision_id query_params['revision'] = revision_id elif release_name: - release = _get_release(releases, release_name) + release = _get_release(origin_context['releases'], release_name) if release: root_sha1_git = release['directory'] query_params['release'] = release_name - revision_id = release['revision'] + revision_id = release['target'] else: - _occurrence_not_found(origin_info, timestamp, False, - release_name, releases, visit_id) + _occurrence_not_found(origin_context['origin_info'], timestamp, + False, release_name, + origin_context['releases'], visit_id) else: - branch_name = request.GET.get('branch', 'HEAD') - branch = _get_branch(branches, branch_name) + branch_name = request.GET.get('branch', None) + if branch_name: + query_params['branch'] = branch_name + branch = _get_branch(origin_context['branches'], branch_name or 'HEAD') if branch: branch_name = branch['name'] root_sha1_git = branch['directory'] - query_params['branch'] = branch_name revision_id = branch['revision'] + else: - _occurrence_not_found(origin_info, timestamp, True, - branch_name, branches, visit_id) + _occurrence_not_found(origin_context['origin_info'], timestamp, + True, branch_name, + origin_context['branches'], visit_id) - request_data['origin_info'] = origin_info - request_data['visit_info'] = visit_info - request_data['root_sha1_git'] = root_sha1_git - request_data['url_args'] = url_args - request_data['query_params'] = query_params - request_data['revision_id'] = revision_id - request_data['branches'] = branches - request_data['branch_name'] = branch_name - request_data['releases'] = releases - request_data['release_name'] = release_name + origin_context['root_sha1_git'] = root_sha1_git + origin_context['revision_id'] = revision_id + origin_context['branch'] = branch_name + origin_context['release'] = release_name - return request_data + return origin_context @browse_route(r'origin/(?P[a-z]+)/url/(?P.+)/visit/(?P.+)/directory/', # noqa r'origin/(?P[a-z]+)/url/(?P.+)/visit/(?P.+)/directory/(?P.+)/', # noqa r'origin/(?P[a-z]+)/url/(?P.+)/directory/', # noqa r'origin/(?P[a-z]+)/url/(?P.+)/directory/(?P.+)/', # noqa view_name='browse-origin-directory') def origin_directory_browse(request, origin_type, origin_url, timestamp=None, path=None): - """Django view for browsing the content of a swh directory associated + """Django view for browsing the content of a SWH directory associated to an origin for a given visit. The url scheme that points to it is the following: * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/directory/[(path)/]` * :http:get:`/browse/origin/(origin_type)/url/(origin_type)/visit/(timestamp)/directory/[(path)/]` Args: request: input django http request origin_type: the type of swh origin (git, svn, hg, ...) origin_url: the url of the swh origin timestamp: optional swh visit timestamp parameter (the last one will be used by default) path: optional path parameter used to navigate in directories reachable from the origin root one branch: optional query parameter that specifies the origin branch from which to retrieve the directory release: optional query parameter that specifies the origin release from which to retrieve the directory revision: optional query parameter to specify the origin revision from which to retrieve the directory Returns: The HTML rendering for the content of the directory associated to the provided origin and visit. """ # noqa try: - request_data = _process_origin_request( + origin_context = _process_origin_request( request, origin_type, origin_url, timestamp, path, 'browse-origin-directory') - root_sha1_git = request_data['root_sha1_git'] + root_sha1_git = origin_context['root_sha1_git'] sha1_git = root_sha1_git if path: dir_info = service.lookup_directory_with_path(root_sha1_git, path) sha1_git = dir_info['target'] dirs, files = get_directory_entries(sha1_git) except Exception as exc: return handle_view_exception(request, exc) - origin_info = request_data['origin_info'] - visit_info = request_data['visit_info'] - url_args = request_data['url_args'] - query_params = request_data['query_params'] - revision_id = request_data['revision_id'] + origin_info = origin_context['origin_info'] + visit_info = origin_context['visit_info'] + url_args = origin_context['url_args'] + query_params = origin_context['query_params'] + revision_id = origin_context['revision_id'] path_info = gen_path_info(path) breadcrumbs = [] breadcrumbs.append({'name': root_sha1_git[:7], 'url': reverse('browse-origin-directory', kwargs=url_args, query_params=query_params)}) for pi in path_info: bc_url_args = dict(url_args) bc_url_args['path'] = pi['path'] breadcrumbs.append({'name': pi['name'], 'url': reverse('browse-origin-directory', kwargs=bc_url_args, query_params=query_params)}) path = '' if path is None else (path + '/') for d in dirs: bc_url_args = dict(url_args) bc_url_args['path'] = path + d['name'] d['url'] = reverse('browse-origin-directory', kwargs=bc_url_args, query_params=query_params) sum_file_sizes = 0 readme_name = None readme_url = None for f in files: bc_url_args = dict(url_args) bc_url_args['path'] = path + f['name'] f['url'] = reverse('browse-origin-content', kwargs=bc_url_args, query_params=query_params) sum_file_sizes += f['length'] f['length'] = filesizeformat(f['length']) if f['name'].lower().startswith('readme'): readme_name = f['name'] readme_sha1 = f['checksums']['sha1'] readme_url = reverse('browse-content-raw', kwargs={'query_string': readme_sha1}) history_url = reverse('browse-origin-log', kwargs=url_args, query_params=query_params) sum_file_sizes = filesizeformat(sum_file_sizes) browse_dir_url = reverse('browse-directory', kwargs={'sha1_git': sha1_git}) browse_rev_url = reverse('browse-revision', kwargs={'sha1_git': revision_id}, query_params={'origin_type': origin_info['type'], 'origin_url': origin_info['url']}) dir_metadata = {'id': sha1_git, 'browse directory url': browse_dir_url, 'number of regular files': len(files), 'number of subdirectories': len(dirs), 'sum of regular file sizes': sum_file_sizes, 'origin id': origin_info['id'], 'origin type': origin_info['type'], 'origin url': origin_info['url'], 'origin visit date': format_utc_iso_date(visit_info['date']), # noqa 'origin visit id': visit_info['visit'], 'path': '/' + path, 'revision id': revision_id, 'browse revision url': browse_rev_url} return render(request, 'directory.html', {'empty_browse': False, 'heading': 'Directory information', 'top_panel_visible': True, 'top_panel_collapsible': True, - 'top_panel_text_left': 'SWH object: Directory', - 'top_panel_text_right': gen_origin_link(origin_info), + 'top_panel_text': 'SWH object: Directory', 'swh_object_metadata': dir_metadata, 'main_panel_visible': True, 'dirs': dirs, 'files': files, 'breadcrumbs': breadcrumbs, - 'branches': request_data['branches'], - 'branch': request_data['branch_name'], - 'releases': request_data['releases'], - 'release': request_data['release_name'], 'top_right_link': history_url, 'top_right_link_text': mark_safe( '' 'History' ), 'readme_name': readme_name, - 'readme_url': readme_url}) + 'readme_url': readme_url, + 'origin_context': origin_context}) @browse_route(r'origin/(?P[a-z]+)/url/(?P.+)/visit/(?P.+)/content/(?P.+)/', # noqa r'origin/(?P[a-z]+)/url/(?P.+)/content/(?P.+)/', # noqa view_name='browse-origin-content') def origin_content_display(request, origin_type, origin_url, path, timestamp=None): - """Django view that produces an HTML display of a swh content + """Django view that produces an HTML display of a SWH content associated to an origin for a given visit. The url scheme that points to it is the following: * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/content/(path)/` * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/content/(path)/` Args: request: input django http request origin_type: the type of swh origin (git, svn, hg, ...) origin_url: the url of the swh origin path: path of the content relative to the origin root directory timestamp: optional swh visit timestamp parameter (the last one will be used by default) branch: optional query parameter that specifies the origin branch from which to retrieve the content release: optional query parameter that specifies the origin release from which to retrieve the content revision: optional query parameter to specify the origin revision from which to retrieve the content Returns: The HTML rendering of the requested content associated to the provided origin and visit. """ # noqa try: - request_data = _process_origin_request( + origin_context = _process_origin_request( request, origin_type, origin_url, timestamp, path, 'browse-origin-content') - root_sha1_git = request_data['root_sha1_git'] + root_sha1_git = origin_context['root_sha1_git'] content_info = service.lookup_directory_with_path(root_sha1_git, path) sha1_git = content_info['target'] query_string = 'sha1_git:' + sha1_git content_data = request_content(query_string) except Exception as exc: return handle_view_exception(request, exc) - url_args = request_data['url_args'] - query_params = request_data['query_params'] - revision_id = request_data['revision_id'] - origin_info = request_data['origin_info'] - visit_info = request_data['visit_info'] + url_args = origin_context['url_args'] + query_params = origin_context['query_params'] + revision_id = origin_context['revision_id'] + origin_info = origin_context['origin_info'] + visit_info = origin_context['visit_info'] content_display_data = prepare_content_for_display( content_data['raw_data'], content_data['mimetype'], path) filename = None path_info = None breadcrumbs = [] split_path = path.split('/') filename = split_path[-1] path = path.replace(filename, '') path_info = gen_path_info(path) breadcrumbs.append({'name': root_sha1_git[:7], 'url': reverse('browse-origin-directory', kwargs=url_args, query_params=query_params)}) for pi in path_info: bc_url_args = dict(url_args) bc_url_args['path'] = pi['path'] breadcrumbs.append({'name': pi['name'], 'url': reverse('browse-origin-directory', kwargs=bc_url_args, query_params=query_params)}) breadcrumbs.append({'name': filename, 'url': None}) browse_content_url = reverse('browse-content', kwargs={'query_string': query_string}) content_raw_url = reverse('browse-content-raw', kwargs={'query_string': query_string}, query_params={'filename': filename}) browse_rev_url = reverse('browse-revision', kwargs={'sha1_git': revision_id}, query_params={'origin_type': origin_info['type'], 'origin_url': origin_info['url']}) content_metadata = { 'browse content url': browse_content_url, 'sha1 checksum': content_data['checksums']['sha1'], 'sha1_git checksum': content_data['checksums']['sha1_git'], 'sha256 checksum': content_data['checksums']['sha256'], 'blake2s256 checksum': content_data['checksums']['blake2s256'], 'mime type': content_data['mimetype'], 'encoding': content_data['encoding'], 'size': filesizeformat(content_data['length']), 'language': content_data['language'], 'licenses': content_data['licenses'], 'origin id': origin_info['id'], 'origin type': origin_info['type'], 'origin url': origin_info['url'], 'origin visit date': format_utc_iso_date(visit_info['date']), 'origin visit id': visit_info['visit'], 'path': '/' + path, 'filename': filename, 'revision id': revision_id, 'browse revision url': browse_rev_url } return render(request, 'content.html', {'empty_browse': False, 'heading': 'Content information', 'top_panel_visible': True, 'top_panel_collapsible': True, - 'top_panel_text_left': 'SWH object: Content', - 'top_panel_text_right': gen_origin_link(origin_info), + 'top_panel_text': 'SWH object: Content', 'swh_object_metadata': content_metadata, 'main_panel_visible': True, 'content': content_display_data['content_data'], 'mimetype': content_data['mimetype'], 'language': content_display_data['language'], 'breadcrumbs': breadcrumbs, - 'branches': request_data['branches'], - 'branch': request_data['branch_name'], - 'releases': request_data['releases'], - 'release': request_data['release_name'], 'top_right_link': content_raw_url, 'top_right_link_text': mark_safe( 'Raw File') - }) + 'Raw File'), + 'origin_context': origin_context}) def _gen_directory_link(url_args, query_params, link_text): directory_url = reverse('browse-origin-directory', kwargs=url_args, query_params=query_params) return gen_link(directory_url, link_text) -NB_LOG_ENTRIES = 20 +PER_PAGE = 20 @browse_route(r'origin/(?P[a-z]+)/url/(?P.+)/visit/(?P.+)/log/', # noqa r'origin/(?P[a-z]+)/url/(?P.+)/log/', view_name='browse-origin-log') def origin_log_browse(request, origin_type, origin_url, timestamp=None): """Django view that produces an HTML display of revisions history (aka the commit log) associated to a SWH origin. The url scheme that points to it is the following: * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/log/` * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/log/` Args: request: input django http request origin_type: the type of swh origin (git, svn, hg, ...) origin_url: the url of the swh origin timestamp: optional visit timestamp parameter (the last one will be used by default) revs_breadcrumb: query parameter used internally to store the navigation breadcrumbs (i.e. the list of descendant revisions visited so far). per_page: optional query parameter used to specify the number of log entries per page branch: optional query parameter that specifies the origin branch from which to retrieve the commit log release: optional query parameter that specifies the origin release from which to retrieve the commit log revision: optional query parameter to specify the origin revision from which to retrieve the commit log Returns: The HTML rendering of revisions history for a given SWH visit. """ # noqa try: - request_data = _process_origin_request( + origin_context = _process_origin_request( request, origin_type, origin_url, timestamp, None, 'browse-origin-log') - revision_id = request_data['revision_id'] - per_page = int(request.GET.get('per_page', NB_LOG_ENTRIES)) + revision_id = origin_context['revision_id'] + per_page = int(request.GET.get('per_page', PER_PAGE)) revision_log = service.lookup_revision_log(revision_id, limit=per_page+1) revision_log = list(revision_log) except Exception as exc: return handle_view_exception(request, exc) - origin_info = request_data['origin_info'] - visit_info = request_data['visit_info'] - url_args = request_data['url_args'] - query_params = request_data['query_params'] + origin_info = origin_context['origin_info'] + visit_info = origin_context['visit_info'] + url_args = origin_context['url_args'] + query_params = origin_context['query_params'] query_params['per_page'] = per_page revs_breadcrumb = request.GET.get('revs_breadcrumb', None) if revs_breadcrumb: revision_id = revs_breadcrumb.split('/')[-1] revision_log_display_data = prepare_revision_log_for_display( - revision_log, per_page, revs_breadcrumb, origin_context=True, - origin_info=origin_info) + revision_log, per_page, revs_breadcrumb, origin_context) prev_rev = revision_log_display_data['prev_rev'] prev_revs_breadcrumb = revision_log_display_data['prev_revs_breadcrumb'] prev_log_url = None query_params['revs_breadcrumb'] = prev_revs_breadcrumb if prev_rev: prev_log_url = \ reverse('browse-origin-log', kwargs=url_args, query_params=query_params) next_rev = revision_log_display_data['next_rev'] next_revs_breadcrumb = revision_log_display_data['next_revs_breadcrumb'] next_log_url = None query_params['revs_breadcrumb'] = next_revs_breadcrumb if next_rev: next_log_url = \ reverse('browse-origin-log', kwargs=url_args, query_params=query_params) revision_log_data = revision_log_display_data['revision_log_data'] for i, log in enumerate(revision_log_data): - query_params = { + params = { 'revision': revision_log[i]['id'], - 'visit_id': visit_info['visit'] } - log['directory'] = _gen_directory_link(url_args, query_params, 'Tree') + if 'visit_id' in query_params: + params['visit_id'] = query_params['visit_id'] + log['directory'] = _gen_directory_link(url_args, params, 'Tree') browse_log_url = reverse('browse-revision-log', kwargs={'sha1_git': revision_id}) revision_metadata = { 'browse revision history url': browse_log_url, 'origin id': origin_info['id'], 'origin type': origin_info['type'], 'origin url': origin_info['url'], 'origin visit date': format_utc_iso_date(visit_info['date']), 'origin visit id': visit_info['visit'] } return render(request, 'revision-log.html', {'empty_browse': False, 'heading': 'Revision history information', 'top_panel_visible': True, 'top_panel_collapsible': True, - 'top_panel_text_left': 'SWH object: Revision history', - 'top_panel_text_right': gen_origin_link(origin_info), + 'top_panel_text': 'SWH object: Revision history', 'swh_object_metadata': revision_metadata, 'main_panel_visible': True, 'revision_log': revision_log_data, 'next_log_url': next_log_url, 'prev_log_url': prev_log_url, 'breadcrumbs': None, - 'branches': request_data['branches'], - 'branch': request_data['branch_name'], - 'releases': request_data['releases'], - 'release': request_data['release_name'], 'top_right_link': None, 'top_right_link_text': None, 'include_top_navigation': True, - 'no_origin_context': False}) + 'origin_context': origin_context}) + + +@browse_route(r'origin/(?P[a-z]+)/url/(?P.+)/visit/(?P.+)/branches/', # noqa + r'origin/(?P[a-z]+)/url/(?P.+)/branches/', # noqa + view_name='browse-origin-branches') +def origin_branches_browse(request, origin_type, origin_url, timestamp=None): + """Django view that produces an HTML display of the list of branches + associated to an origin for a given visit. + + The url scheme that points to it is the following: + + * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/branches/` + * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/branches/` + + """ # noqa + try: + origin_context = _process_origin_request( + request, origin_type, origin_url, timestamp, None, + 'browse-origin-directory') + + except Exception as exc: + return handle_view_exception(request, exc) + + branches_offset = int(request.GET.get('branches_offset', 0)) + + origin_info = origin_context['origin_info'] + url_args = origin_context['url_args'] + query_params = origin_context['query_params'] + + branches = origin_context['branches'] + + displayed_branches = \ + branches[branches_offset:branches_offset+PER_PAGE] + + for branch in displayed_branches: + revision_url = reverse( + 'browse-revision', kwargs={'sha1_git': branch['revision']}, + query_params={'origin_type': origin_info['type'], + 'origin_url': origin_info['url']}) + query_params['branch'] = branch['name'] + directory_url = reverse('browse-origin-directory', + kwargs=url_args, + query_params=query_params) + del query_params['branch'] + branch['revision_url'] = revision_url + branch['directory_url'] = directory_url + + prev_branches_url = None + next_branches_url = None + + next_offset = branches_offset + PER_PAGE + prev_offset = branches_offset - PER_PAGE + if next_offset < len(branches): + query_params['branches_offset'] = next_offset + next_branches_url = reverse('browse-origin-branches', + kwargs=url_args, query_params=query_params) + query_params['branches_offset'] = None + if prev_offset >= 0: + if prev_offset != 0: + query_params['branches_offset'] = prev_offset + prev_branches_url = reverse('browse-origin-branches', + kwargs=url_args, query_params=query_params) + + return render(request, 'branches.html', + {'empty_browse': False, + 'heading': 'Origin branches list', + 'top_panel_visible': False, + 'top_panel_collapsible': False, + 'top_panel_text': 'SWH object: Origin branches list', + 'swh_object_metadata': {}, + 'main_panel_visible': True, + 'top_right_link': None, + 'top_right_link_text': None, + 'include_top_navigation': True, + 'displayed_branches': displayed_branches, + 'prev_branches_url': prev_branches_url, + 'next_branches_url': next_branches_url, + 'origin_context': origin_context}) + + +@browse_route(r'origin/(?P[a-z]+)/url/(?P.+)/visit/(?P.+)/releases/', # noqa + r'origin/(?P[a-z]+)/url/(?P.+)/releases/', # noqa + view_name='browse-origin-releases') +def origin_releases_browse(request, origin_type, origin_url, timestamp=None): + """Django view that produces an HTML display of the list of releases + associated to an origin for a given visit. + + The url scheme that points to it is the following: + + * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/releases/` + * :http:get:`/browse/origin/(origin_type)/url/(origin_url)/visit/(timestamp)/releases/` + + """ # noqa + try: + origin_context = _process_origin_request( + request, origin_type, origin_url, timestamp, None, + 'browse-origin-directory') + + except Exception as exc: + return handle_view_exception(request, exc) + + releases_offset = int(request.GET.get('releases_offset', 0)) + + origin_info = origin_context['origin_info'] + url_args = origin_context['url_args'] + query_params = origin_context['query_params'] + + releases = origin_context['releases'] + + displayed_releases = \ + releases[releases_offset:releases_offset+PER_PAGE] + + for release in displayed_releases: + release_url = reverse('browse-release', + kwargs={'sha1_git': release['id']}, + query_params={'origin_type': origin_info['type'], + 'origin_url': origin_info['url']}) + query_params['release'] = release['name'] + del query_params['release'] + release['release_url'] = release_url + + prev_releases_url = None + next_releases_url = None + + next_offset = releases_offset + PER_PAGE + prev_offset = releases_offset - PER_PAGE + if next_offset < len(releases): + query_params['releases_offset'] = next_offset + next_releases_url = reverse('browse-origin-releases', + kwargs=url_args, query_params=query_params) + query_params['releases_offset'] = None + if prev_offset >= 0: + if prev_offset != 0: + query_params['releases_offset'] = prev_offset + prev_releases_url = reverse('browse-origin-releases', + kwargs=url_args, query_params=query_params) + + return render(request, 'releases.html', + {'empty_browse': False, + 'heading': 'Origin releases list', + 'top_panel_visible': False, + 'top_panel_collapsible': False, + 'top_panel_text': 'SWH object: Origin releases list', + 'swh_object_metadata': {}, + 'main_panel_visible': True, + 'top_right_link': None, + 'top_right_link_text': None, + 'include_top_navigation': True, + 'displayed_releases': displayed_releases, + 'prev_releases_url': prev_releases_url, + 'next_releases_url': next_releases_url, + 'origin_context': origin_context}) @browse_route(r'origin/(?P[a-z]+)/url/(?P.+)/', view_name='browse-origin') def origin_browse(request, origin_type=None, origin_url=None): """Django view that produces an HTML display of a swh origin identified by its id or its url. The url scheme that points to it is :http:get:`/browse/origin/(origin_type)/url/(origin_url)/`. Args: request: input django http request origin_type: type of origin (git, svn, ...) origin_url: url of the origin (e.g. https://github.com//) Returns: The HMTL rendering for the metadata of the provided origin. """ # noqa try: origin_info = service.lookup_origin({ 'type': origin_type, 'url': origin_url }) origin_visits = get_origin_visits(origin_info) origin_visits.reverse() except Exception as exc: return handle_view_exception(request, exc) origin_info['last swh visit browse url'] = \ reverse('browse-origin-directory', kwargs={'origin_type': origin_type, 'origin_url': origin_url}) origin_visits_data = [] visits_splitted = [] visits_by_year = {} for i, visit in enumerate(origin_visits): visit_date = dateutil.parser.parse(visit['date']) visit_year = str(visit_date.year) url_date = format_utc_iso_date(visit['date'], '%Y-%m-%dT%H:%M:%S') visit['fmt_date'] = format_utc_iso_date(visit['date']) query_params = {} if i < len(origin_visits) - 1: if visit['date'] == origin_visits[i+1]['date']: query_params = {'visit_id': visit['visit']} if i > 0: if visit['date'] == origin_visits[i-1]['date']: query_params = {'visit_id': visit['visit']} visit['browse_url'] = reverse('browse-origin-directory', kwargs={'origin_type': origin_type, 'origin_url': origin_url, 'timestamp': url_date}, query_params=query_params) origin_visits_data.insert(0, {'date': visit_date.timestamp()}) if visit_year not in visits_by_year: # display 3 years by row in visits list view if len(visits_by_year) == 3: visits_splitted.insert(0, visits_by_year) visits_by_year = {} visits_by_year[visit_year] = [] visits_by_year[visit_year].append(visit) if len(visits_by_year) > 0: visits_splitted.insert(0, visits_by_year) return render(request, 'origin.html', {'empty_browse': False, 'heading': 'Origin information', - 'top_panel_visible': True, - 'top_panel_collapsible': True, - 'top_panel_text_left': 'SWH object: Origin', - 'top_panel_text_right': 'Url: ' + origin_info['url'], + 'top_panel_visible': False, + 'top_panel_collapsible': False, + 'top_panel_text': 'SWH object: Visits history', 'swh_object_metadata': origin_info, 'main_panel_visible': True, 'origin_visits_data': origin_visits_data, 'visits_splitted': visits_splitted, + 'origin_info': origin_info, 'browse_url_base': '/browse/origin/%s/url/%s/' % (origin_type, origin_url)}) @browse_route(r'origin/search/(?P.+)/', view_name='browse-origin-search') def origin_search(request, url_pattern): """Search for origins whose urls contain a provided string pattern or match a provided regular expression. The search is performed in a case insensitive way. - """ - offset = int(request.GET.get('offset', '0')) limit = int(request.GET.get('limit', '50')) regexp = request.GET.get('regexp', 'false') results = service.search_origin(url_pattern, offset, limit, bool(strtobool(regexp))) results = json.dumps(list(results), sort_keys=True, indent=4, separators=(',', ': ')) return HttpResponse(results, content_type='application/json') diff --git a/swh/web/browse/views/person.py b/swh/web/browse/views/person.py index fe40de61..1ab88143 100644 --- a/swh/web/browse/views/person.py +++ b/swh/web/browse/views/person.py @@ -1,42 +1,41 @@ # Copyright (C) 2017-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information from django.shortcuts import render from swh.web.common import service from swh.web.common.exc import handle_view_exception from swh.web.browse.browseurls import browse_route @browse_route(r'person/(?P[0-9]+)/', view_name='browse-person') def person_browse(request, person_id): """ Django view that produces an HTML display of a swh person identified by its id. The url that points to it is :http:get:`/browse/person/(person_id)/`. Args: request: input django http request person_id (int): a swh person id Returns: The HMTL rendering for the metadata of the provided person. """ try: person = service.lookup_person(person_id) except Exception as exc: return handle_view_exception(request, exc) return render(request, 'person.html', {'empty_browse': False, 'heading': 'Person information', 'top_panel_visible': True, 'top_panel_collapsible': False, - 'top_panel_text_left': 'SWH object: Person', - 'top_panel_text_right': 'Name: ' + person['name'], + 'top_panel_text': 'SWH object: Person', 'swh_object_metadata': person, 'main_panel_visible': False}) diff --git a/swh/web/browse/views/release.py b/swh/web/browse/views/release.py new file mode 100644 index 00000000..4e9c9e0d --- /dev/null +++ b/swh/web/browse/views/release.py @@ -0,0 +1,86 @@ +# Copyright (C) 2017-2018 The Software Heritage developers +# See the AUTHORS file at the top-level directory of this distribution +# License: GNU General Public License version 3, or any later version +# See top-level LICENSE file for more information + +from django.shortcuts import render +from swh.web.common import service +from swh.web.common.utils import reverse, format_utc_iso_date +from swh.web.common.exc import handle_view_exception +from swh.web.browse.browseurls import browse_route +from swh.web.browse.utils import ( + gen_person_link, gen_revision_link, + get_origin_context, gen_link +) + + +@browse_route(r'release/(?P[0-9a-f]+)/', + view_name='browse-release') +def release_browse(request, sha1_git): + """ + Django view that produces an HTML display of a SWH release + identified by its id. + + The url that points to it is :http:get:`/browse/release/(sha1_git)/`. + + Args: + request: input django http request + sha1_git: a SWH release id + + Returns: + The HMTL rendering for the metadata of the provided release. + """ + try: + release = service.lookup_release(sha1_git) + origin_context = None + origin_type = request.GET.get('origin_type', None) + origin_url = request.GET.get('origin_url', None) + timestamp = request.GET.get('timestamp', None) + visit_id = request.GET.get('visit_id', None) + if origin_type and origin_url: + origin_context = get_origin_context(origin_type, origin_url, + timestamp, visit_id) + except Exception as exc: + return handle_view_exception(request, exc) + + release_data = {} + + release_data['author'] = gen_person_link( + release['author']['id'], release['author']['name']) + release_data['date'] = format_utc_iso_date(release['date']) + release_data['id'] = sha1_git + release_data['message'] = release['message'] + release_data['name'] = release['name'] + release_data['synthetic'] = release['synthetic'] + release_data['target type'] = release['target_type'] + + if release['target_type'] == 'revision': + release_data['target'] = \ + gen_revision_link(release['target'], + origin_context=origin_context) + elif release['target_type'] == 'content': + content_url = \ + reverse('browse-content', + kwargs={'query_string': 'sha1_git:' + release['target']}) + release_data['target'] = gen_link(content_url, release['target']) + elif release['target_type'] == 'directory': + directory_url = \ + reverse('browse-directory', + kwargs={'sha1_git': release['target']}) + release_data['target'] = gen_link(directory_url, release['target']) + elif release['target_type'] == 'release': + release_url = \ + reverse('browse-release', + kwargs={'sha1_git': release['target']}) + release_data['target'] = gen_link(release_url, release['target']) + + return render(request, 'release.html', + {'empty_browse': False, + 'heading': 'Release information', + 'top_panel_visible': False, + 'top_panel_collapsible': False, + 'top_panel_text': 'SWH object: Release', + 'swh_object_metadata': None, + 'main_panel_visible': True, + 'release': release_data, + 'origin_context': origin_context}) diff --git a/swh/web/browse/views/revision.py b/swh/web/browse/views/revision.py index 42b34362..4c784cfd 100644 --- a/swh/web/browse/views/revision.py +++ b/swh/web/browse/views/revision.py @@ -1,210 +1,181 @@ # Copyright (C) 2017-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information import json from django.shortcuts import render from django.utils.safestring import mark_safe from swh.web.common import service from swh.web.common.utils import reverse, format_utc_iso_date from swh.web.common.exc import handle_view_exception from swh.web.browse.browseurls import browse_route from swh.web.browse.utils import ( gen_link, gen_person_link, gen_revision_link, - prepare_revision_log_for_display, gen_origin_link + prepare_revision_log_for_display, + get_origin_context, gen_origin_directory_link, + gen_revision_log_link, + gen_directory_link ) -def _gen_directory_link(sha1_git, link_text=None): - directory_url = reverse('browse-directory', - kwargs={'sha1_git': sha1_git}) - if not link_text: - link_text = directory_url - return gen_link(directory_url, link_text) - - -def _gen_origin_directory_link(origin_info, revision_id): - directory_url = reverse('browse-origin-directory', - kwargs={'origin_type': origin_info['type'], - 'origin_url': origin_info['url']}, - query_params={'revision': revision_id}) - return gen_link(directory_url, directory_url) - - -def _gen_revision_log_link(revision_id, origin_info=None, link_text=None): - if origin_info: - revision_log_url = reverse('browse-origin-log', - kwargs={'origin_type': origin_info['type'], - 'origin_url': origin_info['url']}, - query_params={'revision': revision_id}) - else: - revision_log_url = reverse('browse-revision-log', - kwargs={'sha1_git': revision_id}) - if not link_text: - link_text = revision_log_url - return gen_link(revision_log_url, link_text) - - @browse_route(r'revision/(?P[0-9a-f]+)/', view_name='browse-revision') def revision_browse(request, sha1_git): """ Django view that produces an HTML display of a SWH revision identified by its id. The url that points to it is :http:get:`/browse/revision/(sha1_git)/`. Args: request: input django http request sha1_git: a SWH revision id Returns: The HMTL rendering for the metadata of the provided revision. """ try: revision = service.lookup_revision(sha1_git) origin_info = None + origin_context = None origin_type = request.GET.get('origin_type', None) origin_url = request.GET.get('origin_url', None) + timestamp = request.GET.get('timestamp', None) + visit_id = request.GET.get('visit_id', None) if origin_type and origin_url: - origin_info = service.lookup_origin({'type': origin_type, - 'url': origin_url}) + origin_context = get_origin_context(origin_type, origin_url, + timestamp, visit_id) except Exception as exc: return handle_view_exception(request, exc) revision_data = {} revision_data['author'] = gen_person_link( revision['author']['id'], revision['author']['name']) revision_data['committer'] = gen_person_link( revision['committer']['id'], revision['committer']['name']) revision_data['committer date'] = format_utc_iso_date( revision['committer_date']) revision_data['date'] = format_utc_iso_date(revision['date']) - if origin_info: - revision_data['directory'] = _gen_origin_directory_link( - origin_info, sha1_git) - revision_data['history log'] = _gen_revision_log_link( - sha1_git, origin_info) + if origin_context: + revision_data['directory'] = \ + gen_origin_directory_link(origin_context, sha1_git) + revision_data['history log'] = \ + gen_revision_log_link(sha1_git, origin_context) else: - revision_data['directory'] = _gen_directory_link(revision['directory']) - revision_data['history log'] = _gen_revision_log_link(sha1_git) + revision_data['directory'] = \ + gen_directory_link(revision['directory']) + revision_data['history log'] = gen_revision_log_link(sha1_git) revision_data['id'] = sha1_git revision_data['merge'] = revision['merge'] revision_data['message'] = revision['message'] revision_data['metadata'] = json.dumps(revision['metadata'], sort_keys=True, indent=4, separators=(',', ': ')) if origin_info: browse_revision_url = reverse('browse-revision', kwargs={'sha1_git': sha1_git}) revision_data['browse revision url'] = gen_link(browse_revision_url, browse_revision_url) revision_data['origin id'] = origin_info['id'] revision_data['origin type'] = origin_info['type'] revision_data['origin url'] = gen_link(origin_info['url'], origin_info['url']) - top_panel_text_right = gen_origin_link(origin_info) - else: - top_panel_text_right = 'Sha1 git: ' + sha1_git parents = '' for p in revision['parents']: - parent_link = gen_revision_link(p, origin_info=origin_info) + parent_link = gen_revision_link(p, origin_context=origin_context) parents += parent_link + '
' revision_data['parents'] = mark_safe(parents) revision_data['synthetic'] = revision['synthetic'] revision_data['type'] = revision['type'] return render(request, 'revision.html', {'empty_browse': False, 'heading': 'Revision information', 'top_panel_visible': False, 'top_panel_collapsible': False, - 'top_panel_text_left': 'SWH object: Revision', - 'top_panel_text_right': top_panel_text_right, + 'top_panel_text': 'SWH object: Revision', 'swh_object_metadata': None, 'main_panel_visible': True, - 'revision': revision_data}) + 'revision': revision_data, + 'origin_context': origin_context}) NB_LOG_ENTRIES = 20 @browse_route(r'revision/(?P[0-9a-f]+)/log/', view_name='browse-revision-log') def revision_log_browse(request, sha1_git): """ Django view that produces an HTML display of the history log for a SWH revision identified by its id. The url that points to it is :http:get:`/browse/revision/(sha1_git)/log/`. Args: request: input django http request sha1_git: a SWH revision id Returns: The HMTL rendering of the revision history log. """ # noqa try: per_page = int(request.GET.get('per_page', NB_LOG_ENTRIES)) revision_log = service.lookup_revision_log(sha1_git, limit=per_page+1) revision_log = list(revision_log) except Exception as exc: return handle_view_exception(request, exc) revs_breadcrumb = request.GET.get('revs_breadcrumb', None) revision_log_display_data = prepare_revision_log_for_display( revision_log, per_page, revs_breadcrumb) prev_rev = revision_log_display_data['prev_rev'] prev_revs_breadcrumb = revision_log_display_data['prev_revs_breadcrumb'] prev_log_url = None if prev_rev: prev_log_url = \ reverse('browse-revision-log', kwargs={'sha1_git': prev_rev}, query_params={'revs_breadcrumb': prev_revs_breadcrumb, 'per_page': per_page}) next_rev = revision_log_display_data['next_rev'] next_revs_breadcrumb = revision_log_display_data['next_revs_breadcrumb'] next_log_url = None if next_rev: next_log_url = \ reverse('browse-revision-log', kwargs={'sha1_git': next_rev}, query_params={'revs_breadcrumb': next_revs_breadcrumb, 'per_page': per_page}) revision_log_data = revision_log_display_data['revision_log_data'] for log in revision_log_data: - log['directory'] = _gen_directory_link(log['directory'], 'Tree') + log['directory'] = gen_directory_link(log['directory'], 'Tree') return render(request, 'revision-log.html', {'empty_browse': False, 'heading': 'Revision history information', 'top_panel_visible': False, 'top_panel_collapsible': False, - 'top_panel_text_left': 'SWH object: Revision history', - 'top_panel_text_right': 'Sha1 git: ' + sha1_git, + 'top_panel_text': 'SWH object: Revision history', 'swh_object_metadata': None, 'main_panel_visible': True, 'revision_log': revision_log_data, 'next_log_url': next_log_url, 'prev_log_url': prev_log_url, 'breadcrumbs': None, - 'branches': None, - 'branch': None, 'top_right_link': None, 'top_right_link_text': None, 'include_top_navigation': False, - 'no_origin_context': True}) + 'origin_context': None}) diff --git a/swh/web/common/service.py b/swh/web/common/service.py index 0be80505..f59fdd05 100644 --- a/swh/web/common/service.py +++ b/swh/web/common/service.py @@ -1,886 +1,889 @@ # Copyright (C) 2015-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU Affero General Public License version 3, or any later version # See top-level LICENSE file for more information import os from collections import defaultdict from swh.model import hashutil from swh.web.common import converters from swh.web.common import query from swh.web.common.exc import NotFoundExc from swh.web import config storage = config.storage() vault = config.vault() idx_storage = config.indexer_storage() MAX_LIMIT = 50 # Top limit the users can ask for def _first_element(l): """Returns the first element in the provided list or None if it is empty or None""" return next(iter(l or []), None) def lookup_multiple_hashes(hashes): """Lookup the passed hashes in a single DB connection, using batch processing. Args: An array of {filename: X, sha1: Y}, string X, hex sha1 string Y. Returns: The same array with elements updated with elem['found'] = true if the hash is present in storage, elem['found'] = false if not. """ hashlist = [hashutil.hash_to_bytes(elem['sha1']) for elem in hashes] content_missing = storage.content_missing_per_sha1(hashlist) missing = [hashutil.hash_to_hex(x) for x in content_missing] for x in hashes: x.update({'found': True}) for h in hashes: if h['sha1'] in missing: h['found'] = False return hashes def lookup_expression(expression, last_sha1, per_page): """Lookup expression in raw content. Args: expression (str): An expression to lookup through raw indexed content last_sha1 (str): Last sha1 seen per_page (int): Number of results per page Returns: List of ctags whose content match the expression """ limit = min(per_page, MAX_LIMIT) ctags = idx_storage.content_ctags_search(expression, last_sha1=last_sha1, limit=limit) for ctag in ctags: ctag = converters.from_swh(ctag, hashess={'id'}) ctag['sha1'] = ctag['id'] ctag.pop('id') yield ctag def lookup_hash(q): """Checks if the storage contains a given content checksum Args: query string of the form Returns: Dict with key found containing the hash info if the hash is present, None if not. """ algo, hash = query.parse_hash(q) found = storage.content_find({algo: hash}) return {'found': found, 'algo': algo} def search_hash(q): """Checks if the storage contains a given content checksum Args: query string of the form Returns: Dict with key found to True or False, according to whether the checksum is present or not """ algo, hash = query.parse_hash(q) found = storage.content_find({algo: hash}) return {'found': found is not None} def lookup_content_provenance(q): """Return provenance information from a specified content. Args: q: query string of the form Yields: provenance information (dict) list if the content is found. """ algo, hash = query.parse_hash(q) provenances = storage.content_find_provenance({algo: hash}) if not provenances: return None return (converters.from_provenance(p) for p in provenances) def _lookup_content_sha1(q): """Given a possible input, query for the content's sha1. Args: q: query string of the form Returns: binary sha1 if found or None """ algo, hash = query.parse_hash(q) if algo != 'sha1': hashes = storage.content_find({algo: hash}) if not hashes: return None return hashes['sha1'] return hash def lookup_content_ctags(q): """Return ctags information from a specified content. Args: q: query string of the form Yields: ctags information (dict) list if the content is found. """ sha1 = _lookup_content_sha1(q) if not sha1: return None ctags = list(idx_storage.content_ctags_get([sha1])) if not ctags: return None for ctag in ctags: yield converters.from_swh(ctag, hashess={'id'}) def lookup_content_filetype(q): """Return filetype information from a specified content. Args: q: query string of the form Yields: filetype information (dict) list if the content is found. """ sha1 = _lookup_content_sha1(q) if not sha1: return None filetype = _first_element(list(idx_storage.content_mimetype_get([sha1]))) if not filetype: return None return converters.from_filetype(filetype) def lookup_content_language(q): """Return language information from a specified content. Args: q: query string of the form Yields: language information (dict) list if the content is found. """ sha1 = _lookup_content_sha1(q) if not sha1: return None lang = _first_element(list(idx_storage.content_language_get([sha1]))) if not lang: return None return converters.from_swh(lang, hashess={'id'}) def lookup_content_license(q): """Return license information from a specified content. Args: q: query string of the form Yields: license information (dict) list if the content is found. """ sha1 = _lookup_content_sha1(q) if not sha1: return None lang = _first_element(idx_storage.content_fossology_license_get([sha1])) if not lang: return None return converters.from_swh(lang, hashess={'id'}) def lookup_origin(origin): """Return information about the origin matching dict origin. Args: origin: origin's dict with keys either 'id' or ('type' AND 'url') Returns: origin information as dict. """ origin_info = storage.origin_get(origin) if not origin_info: if 'id' in origin and origin['id']: msg = 'Origin with id %s not found!' % origin['id'] else: msg = 'Origin of type %s and url %s not found!' % \ (origin['type'], origin['url']) raise NotFoundExc(msg) return converters.from_origin(origin_info) def search_origin(url_pattern, offset=0, limit=50, regexp=False): """Search for origins whose urls contain a provided string pattern or match a provided regular expression. Args: url_pattern: the string pattern to search for in origin urls offset: number of found origins to skip before returning results limit: the maximum number of found origins to return Returns: lisf of origin information as dict. """ origins = storage.origin_search(url_pattern, offset, limit, regexp) return map(converters.from_origin, origins) def lookup_person(person_id): """Return information about the person with id person_id. Args: person_id as string Returns: person information as dict. Raises: NotFoundExc if there is no person with the provided id. """ person = _first_element(storage.person_get([person_id])) if not person: raise NotFoundExc('Person with id %s not found' % person_id) return converters.from_person(person) def _to_sha1_bin(sha1_hex): _, sha1_git_bin = query.parse_hash_with_algorithms_or_throws( sha1_hex, ['sha1'], # HACK: sha1_git really 'Only sha1_git is supported.') return sha1_git_bin def lookup_directory(sha1_git): """Return information about the directory with id sha1_git. Args: sha1_git as string Returns: directory information as dict. """ sha1_git_bin = _to_sha1_bin(sha1_git) dir = _first_element(storage.directory_get([sha1_git_bin])) if not dir: raise NotFoundExc('Directory with sha1_git %s not found' % sha1_git) directory_entries = storage.directory_ls(sha1_git_bin) or [] return map(converters.from_directory_entry, directory_entries) def lookup_directory_with_path(directory_sha1_git, path_string): """Return directory information for entry with path path_string w.r.t. root directory pointed by directory_sha1_git Args: - directory_sha1_git: sha1_git corresponding to the directory to which we append paths to (hopefully) find the entry - the relative path to the entry starting from the directory pointed by directory_sha1_git Raises: NotFoundExc if the directory entry is not found """ sha1_git_bin = _to_sha1_bin(directory_sha1_git) paths = path_string.strip(os.path.sep).split(os.path.sep) queried_dir = storage.directory_entry_get_by_path( sha1_git_bin, list(map(lambda p: p.encode('utf-8'), paths))) if not queried_dir: raise NotFoundExc(('Directory entry with path %s from %s not found') % (path_string, directory_sha1_git)) return converters.from_directory_entry(queried_dir) def lookup_release(release_sha1_git): """Return information about the release with sha1 release_sha1_git. Args: release_sha1_git: The release's sha1 as hexadecimal Returns: Release information as dict. Raises: ValueError if the identifier provided is not of sha1 nature. """ sha1_git_bin = _to_sha1_bin(release_sha1_git) - res = _first_element(storage.release_get([sha1_git_bin])) - return converters.from_release(res) + release = _first_element(storage.release_get([sha1_git_bin])) + if not release: + raise NotFoundExc('Release with sha1_git %s not found.' + % release_sha1_git) + return converters.from_release(release) def lookup_release_multiple(sha1_git_list): """Return information about the revisions identified with their sha1_git identifiers. Args: sha1_git_list: A list of revision sha1_git identifiers Returns: Release information as dict. Raises: ValueError if the identifier provided is not of sha1 nature. """ sha1_bin_list = (_to_sha1_bin(sha1_git) for sha1_git in sha1_git_list) releases = storage.release_get(sha1_bin_list) or [] return (converters.from_release(r) for r in releases) def lookup_revision(rev_sha1_git): """Return information about the revision with sha1 revision_sha1_git. Args: revision_sha1_git: The revision's sha1 as hexadecimal Returns: Revision information as dict. Raises: ValueError if the identifier provided is not of sha1 nature. NotFoundExc if there is no revision with the provided sha1_git. """ sha1_git_bin = _to_sha1_bin(rev_sha1_git) revision = _first_element(storage.revision_get([sha1_git_bin])) if not revision: raise NotFoundExc('Revision with sha1_git %s not found.' % rev_sha1_git) return converters.from_revision(revision) def lookup_revision_multiple(sha1_git_list): """Return information about the revisions identified with their sha1_git identifiers. Args: sha1_git_list: A list of revision sha1_git identifiers Returns: Generator of revisions information as dict. Raises: ValueError if the identifier provided is not of sha1 nature. """ sha1_bin_list = (_to_sha1_bin(sha1_git) for sha1_git in sha1_git_list) revisions = storage.revision_get(sha1_bin_list) or [] return (converters.from_revision(r) for r in revisions) def lookup_revision_message(rev_sha1_git): """Return the raw message of the revision with sha1 revision_sha1_git. Args: revision_sha1_git: The revision's sha1 as hexadecimal Returns: Decoded revision message as dict {'message': } Raises: ValueError if the identifier provided is not of sha1 nature. NotFoundExc if the revision is not found, or if it has no message """ sha1_git_bin = _to_sha1_bin(rev_sha1_git) revision = _first_element(storage.revision_get([sha1_git_bin])) if not revision: raise NotFoundExc('Revision with sha1_git %s not found.' % rev_sha1_git) if 'message' not in revision: raise NotFoundExc('No message for revision with sha1_git %s.' % rev_sha1_git) res = {'message': revision['message']} return res def lookup_revision_by(origin_id, branch_name="refs/heads/master", timestamp=None): """Lookup revisions by origin_id, branch_name and timestamp. If: - branch_name is not provided, lookup using 'refs/heads/master' as default. - ts is not provided, use the most recent Args: - origin_id: origin of the revision. - branch_name: revision's branch. - timestamp: revision's time frame. Yields: The revisions matching the criterions. Raises: NotFoundExc if no revision corresponds to the criterion """ res = _first_element(storage.revision_get_by(origin_id, branch_name, timestamp=timestamp, limit=1)) if not res: raise NotFoundExc('Revision for origin %s and branch %s not found.' % (origin_id, branch_name)) return converters.from_revision(res) def lookup_revision_log(rev_sha1_git, limit): """Return information about the revision with sha1 revision_sha1_git. Args: revision_sha1_git: The revision's sha1 as hexadecimal limit: the maximum number of revisions returned Returns: Revision information as dict. Raises: ValueError if the identifier provided is not of sha1 nature. NotFoundExc if there is no revision with the provided sha1_git. """ sha1_git_bin = _to_sha1_bin(rev_sha1_git) revision_entries = storage.revision_log([sha1_git_bin], limit) if not revision_entries: raise NotFoundExc('Revision with sha1_git %s not found.' % rev_sha1_git) return map(converters.from_revision, revision_entries) def lookup_revision_log_by(origin_id, branch_name, timestamp, limit): """Return information about the revision with sha1 revision_sha1_git. Args: origin_id: origin of the revision branch_name: revision's branch timestamp: revision's time frame limit: the maximum number of revisions returned Returns: Revision information as dict. Raises: NotFoundExc if no revision corresponds to the criterion """ revision_entries = storage.revision_log_by(origin_id, branch_name, timestamp, limit=limit) if not revision_entries: return None return map(converters.from_revision, revision_entries) def lookup_revision_with_context_by(origin_id, branch_name, ts, sha1_git, limit=100): """Return information about revision sha1_git, limited to the sub-graph of all transitive parents of sha1_git_root. sha1_git_root being resolved through the lookup of a revision by origin_id, branch_name and ts. In other words, sha1_git is an ancestor of sha1_git_root. Args: - origin_id: origin of the revision. - branch_name: revision's branch. - timestamp: revision's time frame. - sha1_git: one of sha1_git_root's ancestors. - limit: limit the lookup to 100 revisions back. Returns: Pair of (root_revision, revision). Information on sha1_git if it is an ancestor of sha1_git_root including children leading to sha1_git_root Raises: - BadInputExc in case of unknown algo_hash or bad hash. - NotFoundExc if either revision is not found or if sha1_git is not an ancestor of sha1_git_root. """ rev_root = _first_element(storage.revision_get_by(origin_id, branch_name, timestamp=ts, limit=1)) if not rev_root: raise NotFoundExc('Revision with (origin_id: %s, branch_name: %s' ', ts: %s) not found.' % (origin_id, branch_name, ts)) return (converters.from_revision(rev_root), lookup_revision_with_context(rev_root, sha1_git, limit)) def lookup_revision_with_context(sha1_git_root, sha1_git, limit=100): """Return information about revision sha1_git, limited to the sub-graph of all transitive parents of sha1_git_root. In other words, sha1_git is an ancestor of sha1_git_root. Args: sha1_git_root: latest revision. The type is either a sha1 (as an hex string) or a non converted dict. sha1_git: one of sha1_git_root's ancestors limit: limit the lookup to 100 revisions back Returns: Information on sha1_git if it is an ancestor of sha1_git_root including children leading to sha1_git_root Raises: BadInputExc in case of unknown algo_hash or bad hash NotFoundExc if either revision is not found or if sha1_git is not an ancestor of sha1_git_root """ sha1_git_bin = _to_sha1_bin(sha1_git) revision = _first_element(storage.revision_get([sha1_git_bin])) if not revision: raise NotFoundExc('Revision %s not found' % sha1_git) if isinstance(sha1_git_root, str): sha1_git_root_bin = _to_sha1_bin(sha1_git_root) revision_root = _first_element(storage.revision_get([sha1_git_root_bin])) # noqa if not revision_root: raise NotFoundExc('Revision root %s not found' % sha1_git_root) else: sha1_git_root_bin = sha1_git_root['id'] revision_log = storage.revision_log([sha1_git_root_bin], limit) parents = {} children = defaultdict(list) for rev in revision_log: rev_id = rev['id'] parents[rev_id] = [] for parent_id in rev['parents']: parents[rev_id].append(parent_id) children[parent_id].append(rev_id) if revision['id'] not in parents: raise NotFoundExc('Revision %s is not an ancestor of %s' % (sha1_git, sha1_git_root)) revision['children'] = children[revision['id']] return converters.from_revision(revision) def lookup_directory_with_revision(sha1_git, dir_path=None, with_data=False): """Return information on directory pointed by revision with sha1_git. If dir_path is not provided, display top level directory. Otherwise, display the directory pointed by dir_path (if it exists). Args: sha1_git: revision's hash. dir_path: optional directory pointed to by that revision. with_data: boolean that indicates to retrieve the raw data if the path resolves to a content. Default to False (for the api) Returns: Information on the directory pointed to by that revision. Raises: BadInputExc in case of unknown algo_hash or bad hash. NotFoundExc either if the revision is not found or the path referenced does not exist. NotImplementedError in case of dir_path exists but do not reference a type 'dir' or 'file'. """ sha1_git_bin = _to_sha1_bin(sha1_git) revision = _first_element(storage.revision_get([sha1_git_bin])) if not revision: raise NotFoundExc('Revision %s not found' % sha1_git) dir_sha1_git_bin = revision['directory'] if dir_path: paths = dir_path.strip(os.path.sep).split(os.path.sep) entity = storage.directory_entry_get_by_path( dir_sha1_git_bin, list(map(lambda p: p.encode('utf-8'), paths))) if not entity: raise NotFoundExc( "Directory or File '%s' pointed to by revision %s not found" % (dir_path, sha1_git)) else: entity = {'type': 'dir', 'target': dir_sha1_git_bin} if entity['type'] == 'dir': directory_entries = storage.directory_ls(entity['target']) or [] return {'type': 'dir', 'path': '.' if not dir_path else dir_path, 'revision': sha1_git, 'content': map(converters.from_directory_entry, directory_entries)} elif entity['type'] == 'file': # content content = storage.content_find({'sha1_git': entity['target']}) if with_data: c = _first_element(storage.content_get([content['sha1']])) content['data'] = c['data'] return {'type': 'file', 'path': '.' if not dir_path else dir_path, 'revision': sha1_git, 'content': converters.from_content(content)} else: raise NotImplementedError('Entity of type %s not implemented.' % entity['type']) def lookup_content(q): """Lookup the content designed by q. Args: q: The release's sha1 as hexadecimal Raises: NotFoundExc if the requested content is not found """ algo, hash = query.parse_hash(q) c = storage.content_find({algo: hash}) if not c: raise NotFoundExc('Content with %s checksum equals to %s not found!' % (algo, hashutil.hash_to_hex(hash))) return converters.from_content(c) def lookup_content_raw(q): """Lookup the content defined by q. Args: q: query string of the form Returns: dict with 'sha1' and 'data' keys. data representing its raw data decoded. Raises: NotFoundExc if the requested content is not found or if the content bytes are not available in the storage """ c = lookup_content(q) content = _first_element(storage.content_get([c['checksums']['sha1']])) if not content: algo, hash = query.parse_hash(q) raise NotFoundExc('Bytes of content with %s checksum equals to %s ' 'not available in SWH storage!' % (algo, hashutil.hash_to_hex(hash))) return converters.from_content(content) def stat_counters(): """Return the stat counters for Software Heritage Returns: A dict mapping textual labels to integer values. """ return storage.stat_counters() def _lookup_origin_visits(origin_id, last_visit=None, limit=10): """Yields the origin origin_ids' visits. Args: origin_id (int): origin to list visits for last_visit (int): last visit to lookup from limit (int): Number of elements max to display Yields: Dictionaries of origin_visit for that origin """ limit = min(limit, MAX_LIMIT) yield from storage.origin_visit_get( origin_id, last_visit=last_visit, limit=limit) def lookup_origin_visits(origin_id, last_visit=None, per_page=10): """Yields the origin origin_ids' visits. Args: origin_id: origin to list visits for Yields: Dictionaries of origin_visit for that origin """ visits = _lookup_origin_visits(origin_id, last_visit=last_visit, limit=per_page) for visit in visits: yield converters.from_origin_visit(visit) def lookup_origin_visit(origin_id, visit_id): """Return information about visit visit_id with origin origin_id. Args: origin_id: origin concerned by the visit visit_id: the visit identifier to lookup Yields: The dict origin_visit concerned """ visit = storage.origin_visit_get_by(origin_id, visit_id) if not visit: raise NotFoundExc('Origin with id %s or its visit ' 'with id %s not found!' % (origin_id, visit_id)) return converters.from_origin_visit(visit) def lookup_entity_by_uuid(uuid): """Return the entity's hierarchy from its uuid. Args: uuid: entity's identifier. Returns: List of hierarchy entities from the entity with uuid. """ uuid = query.parse_uuid4(uuid) for entity in storage.entity_get(uuid): entity = converters.from_swh(entity, convert={'last_seen', 'uuid'}, convert_fn=lambda x: str(x)) yield entity def lookup_revision_through(revision, limit=100): """Retrieve a revision from the criterion stored in revision dictionary. Args: revision: Dictionary of criterion to lookup the revision with. Here are the supported combination of possible values: - origin_id, branch_name, ts, sha1_git - origin_id, branch_name, ts - sha1_git_root, sha1_git - sha1_git Returns: None if the revision is not found or the actual revision. """ if 'origin_id' in revision and \ 'branch_name' in revision and \ 'ts' in revision and \ 'sha1_git' in revision: return lookup_revision_with_context_by(revision['origin_id'], revision['branch_name'], revision['ts'], revision['sha1_git'], limit) if 'origin_id' in revision and \ 'branch_name' in revision and \ 'ts' in revision: return lookup_revision_by(revision['origin_id'], revision['branch_name'], revision['ts']) if 'sha1_git_root' in revision and \ 'sha1_git' in revision: return lookup_revision_with_context(revision['sha1_git_root'], revision['sha1_git'], limit) if 'sha1_git' in revision: return lookup_revision(revision['sha1_git']) # this should not happen raise NotImplementedError('Should not happen!') def lookup_directory_through_revision(revision, path=None, limit=100, with_data=False): """Retrieve the directory information from the revision. Args: revision: dictionary of criterion representing a revision to lookup path: directory's path to lookup. limit: optional query parameter to limit the revisions log (default to 100). For now, note that this limit could impede the transitivity conclusion about sha1_git not being an ancestor of. with_data: indicate to retrieve the content's raw data if path resolves to a content. Returns: The directory pointing to by the revision criterions at path. """ rev = lookup_revision_through(revision, limit) if not rev: raise NotFoundExc('Revision with criterion %s not found!' % revision) return (rev['id'], lookup_directory_with_revision(rev['id'], path, with_data)) def vault_cook(obj_type, obj_id, email=None): """Cook a vault bundle. """ return vault.cook(obj_type, obj_id, email=email) def vault_fetch(obj_type, obj_id): """Fetch a vault bundle. """ return vault.fetch(obj_type, obj_id) def vault_progress(obj_type, obj_id): """Get the current progress of a vault bundle. """ return vault.progress(obj_type, obj_id) diff --git a/swh/web/static/css/style.css b/swh/web/static/css/style.css index aab6f185..0b9dec38 100644 --- a/swh/web/static/css/style.css +++ b/swh/web/static/css/style.css @@ -1,561 +1,582 @@ /* version: 0.1 date: 21/09/15 author: swh email: swh website: softwareheritage.org version history: /style.css */ @import url(https://fonts.googleapis.com/css?family=Alegreya:400,400italic,700,700italic); @import url(https://fonts.googleapis.com/css?family=Alegreya+Sans:400,400italic,500,500italic,700,700italic,100,300,100italic,300italic); html { height: 100%; } body { font-family: 'Alegreya Sans', sans-serif; font-size: 1.7rem; line-height: 1.5; color: rgba(0, 0, 0, 0.55); padding-bottom: 120px; min-height: 100%; margin: 0; position: relative; } .heading { font-family: 'Alegreya', serif; } .shell, .text { font-size: 0.7em; } .logo img { max-height: 40px; } .logo .navbar-brand { padding: 5px; } .logo .sitename { padding: 15px 5px; } .jumbotron { padding: 0; background-color: rgba(0, 0, 0, 0); position: fixed; top: 0; width: 100%; z-index: 10; } #swh-navbar-collapse { border-top-style: none; border-left-style: none; border-right-style: none; border-bottom: 5px solid; border-image: linear-gradient(to right, rgb(226, 0, 38) 0%, rgb(254, 205, 27) 100%) 1 1 1 1; width: 100%; padding: 5px; } .nav-horizontal { float: right; } h3[id], h4[id], a[id] { /* avoid in-page links covered by navbar */ padding-top: 80px; margin-top: -70px; } h1, h2, h3, h4 { margin: 0; color: #e20026; padding-bottom: 10px; } h1 { font-size: 1.8em; } h2 { font-size: 1.2em; } h3 { font-size: 1.1em; } a { color: rgba(0, 0, 0, 0.75); border-bottom-style: dotted; border-bottom-width: 1px; border-bottom-color: rgb(91, 94, 111); } a:hover { color: black; } ul.dropdown-menu a, .navbar-header a, ul.navbar-nav a { /* No decoration on links in dropdown menu */ border-bottom-style: none; color: #323232; font-weight: 700; } .navbar-header a:hover, ul.navbar-nav a:hover { color: #8f8f8f; } .sitename .first-word, .sitename .second-word { color: rgba(0, 0, 0, 0.75); font-weight: normal; font-size: 1.8rem; } .sitename .first-word { font-family: 'Alegreya Sans', sans-serif; } .sitename .second-word { font-family: 'Alegreya', serif; } ul.dropdown-menu > li, ul.dropdown-menu > li > ul > li { /* No decoration on bullet points in dropdown menu */ list-style-type: none; } .page { margin: 2em auto; width: 35em; border: 5px solid #ccc; padding: 0.8em; background: white; } .entries { list-style: none; margin: 0; padding: 0; } .entries li { margin: 0.8em 1.2em; } .entries li h2 { margin-left: -1em; } .add-entry { font-size: 0.9em; border-bottom: 1px solid #ccc; } .add-entry dl { font-weight: bold; } .metanav { text-align: right; font-size: 0.8em; padding: 0.3em; margin-bottom: 1em; background: #fafafa; } .flash { background: #cee5F5; padding: 0.5em; border: 1px solid #aacbe2; } .error { background: #f0d6d6; padding: 0.5em; } .file-found { color: #23BA49; } .file-notfound { color: #FF4747; } /* Bootstrap custom styling to correctly render multiple * form-controls in an input-group: * github.com/twbs/bootstrap/issues/12732 */ .input-group-field { display: table-cell; vertical-align: middle; border-radius:4px; min-width:1%; white-space: nowrap; } .input-group-field .form-control { border-radius: inherit !important; } .input-group-field:not(:first-child):not(:last-child) { border-radius:0; } .input-group-field:not(:first-child):not(:last-child) .form-control { border-left-width: 0; border-right-width: 0; } .input-group-field:last-child { border-top-left-radius:0; border-bottom-left-radius:0; } .input-group > span:not(:last-child) > button { border-radius: 0; } .multi-input-group > .input-group-btn { vertical-align: bottom; padding: 0; } .dataTables_filter { margin-top: 15px; } .dataTables_filter input { width: 70%; float: right; } tr.api-doc-route-upcoming > td, tr.api-doc-route-upcoming > td > a { font-size: 90%; } tr.api-doc-route-deprecated > td, tr.api-doc-route-deprecated > td > a { color: red; } #back-to-top { display: initial; position: fixed; bottom: 30px; right: 30px; z-index: 10; } #back-to-top a img { display: block; width: 32px; height: 32px; background-size: 32px 32px; text-indent: -999px; overflow: hidden; } .table > thead > tr > th { border-bottom: 1px solid #e20026; } .table > tbody > tr > td { border-style: none; } pre { background-color: #f5f5f5; } .dataTables_wrapper { position: static; } /* breadcrumbs */ .bread-crumbs{ display: inline-block; overflow: hidden; color: rgba(0, 0, 0, 0.55); } bread-crumbs ul { list-style-type: none; } .bread-crumbs li { float: left; list-style-type: none; } .bread-crumbs a { color: rgba(0, 0, 0, 0.75); border-bottom-style: none; } .bread-crumbs a:hover { color: rgba(0, 0, 0, 0.85); text-decoration: underline; } .title-small .bread-crumbs{ margin: -30px 0 25px; } #footer { background-color: #262626; color: hsl(0, 0%, 100%); font-size: 1.2rem; text-align: center; padding-top: 20px; padding-bottom: 20px; position: absolute; bottom: 0; left: 0; right: 0; } #footer a, #footer a:visited { color: hsl(0, 0%, 100%); } #footer a:hover { text-decoration: underline; } .highlightjs pre { background-color: transparent; border-radius: 0px; border-color: transparent; } .hljs { background-color: transparent; white-space: pre; } .scrollable-menu { max-height: 180px; overflow-x: hidden; } .swh-browse-top-navigation { border-bottom: 1px solid #ddd; min-height: 42px; padding: 4px 5px 0px 5px; } .swh-browse-bread-crumbs { font-size: inherit; vertical-align: text-top; margin-bottom: 1px; } .swh-browse-bread-crumbs li:nth-child(n+2)::before { content: ""; display: inline-block; margin: 0 2px; } .swh-metadata-table-row { border-top: 1px solid #ddd !important; } /* for block of numbers */ td.hljs-ln-numbers { -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; text-align: center; color: #ccc; border-right: 1px solid #CCC; vertical-align: top; padding-right: 5px; /* your custom style here */ } /* for block of code */ td.hljs-ln-code { padding-left: 10px; } .btn-swh { color: #6C6C6C; background-color: #EAEAEA; border-color: #ddd; background-image: linear-gradient(to bottom,#f5f5f5 0,#e8e8e8 100%); background-repeat: repeat-x; outline: none; } .btn-swh:hover, .btn-swh:focus, .btn-swh:active, .btn-swh.active, .open .dropdown-toggle.btn-swh { background-color: #e6ebf1; background-image: linear-gradient(to bottom,#f1f1f1 0,#e6e6e6 100%); border-color: rgb(197, 197, 197); } .btn-swh.disabled, .btn-swh[disabled], fieldset[disabled] .btn-swh, .btn-swh.disabled:hover, .btn-swh[disabled]:hover, fieldset[disabled] .btn-swh:hover, .btn-swh.disabled:focus, .btn-swh[disabled]:focus, fieldset[disabled] .btn-swh:focus, .btn-swh.disabled:active, .btn-swh[disabled]:active, fieldset[disabled] .btn-swh:active, .btn-swh.disabled.active, .btn-swh[disabled].active, fieldset[disabled] .btn-swh.active { background-color: #EAEAEA; border-color: #EAEAEA; } .btn-swh .badge { color: #EAEAEA; background-color: #6C6C6C; } .swh-http-error { margin: 0 auto; text-align: center; } .swh-http-error-head { color: #2d353c; font-size: 30px; } .swh-http-error-code { bottom: 60%; color: #2d353c; font-size: 96px; line-height: 80px; margin-bottom: 10px!important; } .swh-http-error-desc { font-size: 12px; color: #647788; text-align: center; } .swh-http-error-desc pre { display: inline-block; text-align: left; max-width: 800px; white-space: pre-wrap; } .swh-table { border-bottom: none !important; } .swh-counter { font-size: 150%; } .swh-loading { display : none; } .swh-loading.show { display:inline-block; position: fixed; background: white; border: 1px solid black; top: 50%; left: 50%; margin: -50px 0px 0px -50px; text-align: center; z-index:100; } .swh-readme a { outline: none; border: none; } .swh-readme table { border-collapse: collapse; } .swh-readme table, .swh-readme table th, .swh-readme table td { padding: 6px 13px; border: 1px solid #dfe2e5; } .swh-readme table tr:nth-child(even) { background-color: #f2f2f2; } .swh-web-app-link:hover { background-color: #efeff2; } .swh-web-app-link a { text-decoration: none; outline: none; border: none; } .pager a { outline: none; } .swh-content { background-image: none; border: none; background-color: white; } .swh-visit-full { color: green; position: relative; } .swh-visit-full:before { content: "\f00c"; font-family: FontAwesome; left:-20px; position:absolute; top:-2px; } .swh-visit-partial { color: #edc344; position: relative; } .swh-visit-partial:before { content: "\f071"; font-family: FontAwesome; left:-20px; position:absolute; top:-2px; } .swh-branches-releases { min-width: 200px; } .swh-branches-switch, .swh-releases-switch { padding: 5px 15px !important; } li.swh-branch:hover, li.swh-release:hover { background-color: #e8e8e8; } .swh-branch a, .swh-release a { outline:none; } .swh-branch a:hover, .swh-release a:hover { text-decoration: none; } + +.swh-origin-visit-details { + text-align: center; +} + +.swh-origin-visit-details ul { + list-style: none; + margin: 0; + padding: 0; +} + +.swh-origin-visit-details li { + display: inline-block; + vertical-align: middle; + margin-left: 10px; + margin-right: 10px; +} + +.swh-browse-nav li a { + border-radius: 4px; +} \ No newline at end of file diff --git a/swh/web/templates/branches.html b/swh/web/templates/branches.html new file mode 100644 index 00000000..d5542061 --- /dev/null +++ b/swh/web/templates/branches.html @@ -0,0 +1,59 @@ +{% extends "browse.html" %} + +{% block swh-browse-before-panels %} +{% if origin_context %} + {% include "includes/origin-visit-snapshot.html" %} +{% endif %} +{% endblock %} + +{% block swh-browse-main-panel-content %} + +
+
+

{{ top_panel_text }}

+
+
+
+ +
+ + + + + + + + + + + {% for branch in displayed_branches %} + + + + + + {% endfor %} + +
NameRevisionMessageDate
{{ branch.name }}{{ branch.revision|slice:":7" }}{{ branch.message|truncatechars:70 }}{{ branch.date }}
+
+{% endblock %} + +{% block swh-browse-after-panels %} + +{% if prev_branches_url or next_branches_url %} +
    + {% if prev_branches_url %} +
  • Previous
    • + {% else %} +
  • Older
    • + {% endif %} + {% if next_branches_url %} +
  • Next
    • + {% else %} +
  • Newer
    • + {% endif %} +
+{% endif %} + +{% endblock %} diff --git a/swh/web/templates/browse.html b/swh/web/templates/browse.html index c21af3f3..67618fdb 100644 --- a/swh/web/templates/browse.html +++ b/swh/web/templates/browse.html @@ -1,152 +1,154 @@ {% extends "layout.html" %} {% load swh_templatetags %} {% block title %}{{ heading }} – Software Heritage archive {% endblock %} {% block navbar-content %} - + {% endblock %} {% block content %} -
+
- + -
- {% include "includes/browse-help.html" %} -
+
+ {% include "includes/browse-help.html" %} +
-
+
+ + {% if empty_browse %} - {% if empty_browse %} -
-
-

Browse the Software Heritage archive

-
-
-

- No Software Heritage object currently browsed. -
- To browse the content of the archive, you can either use - the Search interface or refer to the URI scheme described - in the Help page. -

-
-
- {% else %} -
- {% if top_panel_visible %}
-
- {% if top_panel_collapsible %} - - {% endif %} +
+

Browse the Software Heritage archive

+
+
+

+ No Software Heritage object currently browsed. +
+ To browse the content of the archive, you can either use + the Search interface or refer to the URI scheme described + in the Help page. +

+
+
+ + {% else %} + +
+ + {% block swh-browse-before-panels %}{% endblock %} + + {% if top_panel_visible %} +
+
+ {% if top_panel_collapsible %} + + {% endif %}
-

{{ top_panel_text_left }}

-
-
-

{{ top_panel_text_right }}

+

{{ top_panel_text }}

+ {% if top_panel_collapsible %} + + {% endif %} +
{% if top_panel_collapsible %} - +
{% endif %} - -
- {% if top_panel_collapsible %} -
- {% endif %} {% for key, val in swh_object_metadata.items|dictsort:"0.lower" %} {% endfor %}
{{ key }} 
{{ val | safe | urlize_links_and_mails | safe }}
- {% if top_panel_collapsible %} + {% if top_panel_collapsible %} +
+ {% endif %}
- {% endif %} -
- {% endif %} - {% if main_panel_visible %} -
- {% block swh-browse-main-panel-content %}{% endblock %} -
- {% endif %} + {% endif %} - {% block swh-browse-panels-group-end %}{% endblock %} - -
+ {% if main_panel_visible %} +
+ {% block swh-browse-main-panel-content %}{% endblock %} +
+ {% endif %} - {% block swh-browse-after-panels %}{% endblock %} + {% block swh-browse-panels-group-end %}{% endblock %} -
- {% endif %} +
-
+ {% block swh-browse-after-panels %}{% endblock %} - + show_requested_tab(); + }); + {% endblock %} diff --git a/swh/web/templates/content.html b/swh/web/templates/content.html index 60fbf2fb..552a6e3f 100644 --- a/swh/web/templates/content.html +++ b/swh/web/templates/content.html @@ -1,134 +1,140 @@ {% extends "browse.html" %} {% load static %} {% block header %} {% endblock %} +{% block swh-browse-before-panels %} +{% if origin_context %} + {% include "includes/origin-visit-snapshot.html" %} +{% endif %} +{% endblock %} + {% block swh-browse-main-panel-content %} {% include "includes/top-navigation.html" %}
{% if "inode/x-empty" == mimetype %} File is empty {% elif "text/" in mimetype %} 
     {{ content }}
{% elif "image/" in mimetype and content %} {% else %} Content with mime type {{ mimetype }} can not be displayed {% endif %}
{% endblock %} diff --git a/swh/web/templates/directory.html b/swh/web/templates/directory.html index 8696ad62..d837d7df 100644 --- a/swh/web/templates/directory.html +++ b/swh/web/templates/directory.html @@ -1,75 +1,82 @@ {% extends "browse.html" %} {% load static %} {% block header %} {% endblock %} +{% block swh-browse-before-panels %} +{% if origin_context %} + {% include "includes/origin-visit-snapshot.html" %} +{% endif %} +{% endblock %} + {% block swh-browse-main-panel-content %} + {% include "includes/top-navigation.html" %}
{% for d in dirs %} {% endfor %} {% for f in files %} {% endfor %}
File Mode Size Sha1 git
{{ d.name }} {{ d.perms }} {{ d.target }}
{{ f.name }} {{ f.perms }} {{ f.length }} {{ f.target }}
{% endblock %} {% block swh-browse-panels-group-end %} {% if readme_name %}

{{ readme_name }}

{% endif %} {% endblock %} diff --git a/swh/web/templates/includes/origin-visit-snapshot.html b/swh/web/templates/includes/origin-visit-snapshot.html new file mode 100644 index 00000000..c4a712be --- /dev/null +++ b/swh/web/templates/includes/origin-visit-snapshot.html @@ -0,0 +1,18 @@ +
+
+ +

SWH origin: {{ origin_context.origin_info.url }}

+ +
+
+ +
+
diff --git a/swh/web/templates/includes/top-navigation.html b/swh/web/templates/includes/top-navigation.html index 3b24d766..fbb9e80d 100644 --- a/swh/web/templates/includes/top-navigation.html +++ b/swh/web/templates/includes/top-navigation.html @@ -1,125 +1,129 @@
- {% if branches %} + {% if origin_context %} {% endif %} {% if top_right_link %} {{ top_right_link_text }} {% endif %}
diff --git a/swh/web/templates/origin.html b/swh/web/templates/origin.html index f0b342e9..911d5228 100644 --- a/swh/web/templates/origin.html +++ b/swh/web/templates/origin.html @@ -1,68 +1,100 @@ {% extends "browse.html" %} {% load static %} {% load swh_templatetags %} +{% block swh-browse-before-panels %} + +
+
+ +

SWH origin: {{ origin_info.url }}

+
+ +
+
+ + + {% for key, val in swh_object_metadata.items|dictsort:"0.lower" %} + + + + + {% endfor %} + +
{{ key }} + 
{{ val | safe | urlize_links_and_mails | safe }}
+
+
+
+ +{% endblock %} + {% block swh-browse-main-panel-content %} +
+
+

{{ top_panel_text }}

+
+
+
-

Visits history

-

Calendar

+

Calendar

-

List

+

List

{% for visits_by_year in visits_splitted %}
{% for key, val in visits_by_year.items|dictsortreversed:"0.lower" %}
{% for visit in val %} {% endfor %}
{{ key }}
{{ visit.fmt_date }}
{% endfor %}
{% endfor %}
{% endblock %} diff --git a/swh/web/templates/release.html b/swh/web/templates/release.html index 5e5335c7..8521ce32 100644 --- a/swh/web/templates/release.html +++ b/swh/web/templates/release.html @@ -1,43 +1,28 @@ -{% extends "layout.html" %} -{% block title %}Release{% endblock %} -{% block content %} +{% extends "browse.html" %} +{% load swh_templatetags %} -{% if message is not none %} -{{ message }} +{% block swh-browse-before-panels %} +{% if origin_context %} + {% include "includes/origin-visit-snapshot.html" %} {% endif %} +{% endblock %} -{% if release is not none %} -
- {% for key in release.keys() %} - {% if key not in ['author', 'target_url', 'message', 'target', 'target_type', 'decoding_failures'] and release[key] is not none %} -
-
{{ key }}
-
{{ release[key] }}
-
- {% endif %} - {% endfor %} - {% if release['author'] is not none %} -
-
author
-
- {{ release['author']['name'] }} - {{ release['author']['email'] }} - {% if 'decoding_failures' in release['author'] %}(some decoding errors){% endif %} -
-
- {% endif %} -
- {% if release['target_url'] is not none %} -
-
{{ release['target_type'] }}
-
{{ release['target_url'] }}
-
- {% endif %} - {% if 'decoding_failures' in release %} -
-
(some decoding errors)
+{% block swh-browse-main-panel-content %} +
+
+

{{ top_panel_text }}

- {% endif %} +
+
-{% endif %} -{% endblock %} + + {% for key, val in release.items|dictsort:"0.lower" %} + + + + + {% endfor %} +
{{ key }}
{{ val }}
+ +{% endblock %} \ No newline at end of file diff --git a/swh/web/templates/releases.html b/swh/web/templates/releases.html new file mode 100644 index 00000000..e25e0ee1 --- /dev/null +++ b/swh/web/templates/releases.html @@ -0,0 +1,59 @@ +{% extends "browse.html" %} + +{% block swh-browse-before-panels %} +{% if origin_context %} + {% include "includes/origin-visit-snapshot.html" %} +{% endif %} +{% endblock %} + +{% block swh-browse-main-panel-content %} + +
+
+

{{ top_panel_text }}

+
+
+
+ +
+ + + + + + + + + + + {% for release in displayed_releases %} + + + + + + {% endfor %} + +
NameTypeMessageDate
{{ release.name }}{{ release.target_type }}{{ release.message|truncatechars:80 }}{{ release.date }}
+
+{% endblock %} + +{% block swh-browse-after-panels %} + +{% if prev_releases_url or next_releases_url %} +
    + {% if prev_releases_url %} +
  • Previous
    • + {% else %} +
  • Older
    • + {% endif %} + {% if next_releases_url %} +
  • Next
    • + {% else %} +
  • Newer
    • + {% endif %} +
+{% endif %} + +{% endblock %} diff --git a/swh/web/templates/revision-log.html b/swh/web/templates/revision-log.html index c3963027..bc19868d 100644 --- a/swh/web/templates/revision-log.html +++ b/swh/web/templates/revision-log.html @@ -1,62 +1,65 @@ {% extends "browse.html" %} +{% block swh-browse-before-panels %} +{% if origin_context %} + {% include "includes/origin-visit-snapshot.html" %} +{% endif %} +{% endblock %} + {% block swh-browse-main-panel-content %} -{% if no_origin_context %} +{% if not origin_context %}
-

{{ top_panel_text_left }}

-
-
-

{{ top_panel_text_right }}

+

{{ top_panel_text }}

{% endif %} {% if include_top_navigation %} {% include "includes/top-navigation.html" %} {% endif %}
{% for log in revision_log %} {% endfor %}
Author Revision Message Date
{{ log.author }} {{ log.revision }} {{ log.message_shorten }} {{ log.date }} {{ log.directory }}
{% endblock %} {% block swh-browse-after-panels %}
    {% if next_log_url %}
  • Newer
    • {% else %}
  • Newer
    • {% endif %} {% if prev_log_url %}
  • Older
    • {% else %}
  • Older
    • {% endif %}
{% endblock %} diff --git a/swh/web/templates/revision.html b/swh/web/templates/revision.html index 8081a5cd..93a3e5c7 100644 --- a/swh/web/templates/revision.html +++ b/swh/web/templates/revision.html @@ -1,24 +1,26 @@ {% extends "browse.html" %} +{% block swh-browse-before-panels %} +{% if origin_context %} + {% include "includes/origin-visit-snapshot.html" %} +{% endif %} +{% endblock %} + {% block swh-browse-main-panel-content %}
-

{{ top_panel_text_left }}

-
-
-

{{ top_panel_text_right }}

+

{{ top_panel_text }}

-
{% for key, val in revision.items|dictsort:"0.lower" %} {% endfor %}
{{ key }} 
{{ val }}
{% endblock %} \ No newline at end of file diff --git a/swh/web/tests/api/views/test_revision.py b/swh/web/tests/api/views/test_revision.py index 07cf4499..431df01e 100644 --- a/swh/web/tests/api/views/test_revision.py +++ b/swh/web/tests/api/views/test_revision.py @@ -1,920 +1,918 @@ # Copyright (C) 2015-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU Affero General Public License version 3, or any later version # See top-level LICENSE file for more information from nose.tools import istest from rest_framework.test import APITestCase from unittest.mock import patch from swh.web.common.exc import NotFoundExc from swh.web.api.views.revision import ( _revision_directory_by ) from swh.web.tests.testbase import SWHWebTestBase class ReleaseApiTestCase(SWHWebTestBase, APITestCase): @patch('swh.web.api.views.revision.service') @istest def api_revision(self, mock_service): # given stub_revision = { 'id': '18d8be353ed3480476f032475e7c233eff7371d5', 'directory': '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 'author_name': 'Software Heritage', 'author_email': 'robot@softwareheritage.org', 'committer_name': 'Software Heritage', 'committer_email': 'robot@softwareheritage.org', 'message': 'synthetic revision message', 'date_offset': 0, 'committer_date_offset': 0, 'parents': ['8734ef7e7c357ce2af928115c6c6a42b7e2a44e7'], 'type': 'tar', 'synthetic': True, 'metadata': { 'original_artifact': [{ 'archive_type': 'tar', 'name': 'webbase-5.7.0.tar.gz', 'sha1': '147f73f369733d088b7a6fa9c4e0273dcd3c7ccd', 'sha1_git': '6a15ea8b881069adedf11feceec35588f2cfe8f1', 'sha256': '401d0df797110bea805d358b85bcc1ced29549d3d73f' '309d36484e7edf7bb912' }] }, } mock_service.lookup_revision.return_value = stub_revision expected_revision = { 'id': '18d8be353ed3480476f032475e7c233eff7371d5', 'url': '/api/1/revision/18d8be353ed3480476f032475e7c233eff7371d5/', 'history_url': '/api/1/revision/18d8be353ed3480476f032475e7c233e' 'ff7371d5/log/', 'directory': '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 'directory_url': '/api/1/directory/7834ef7e7c357ce2af928115c6c6' 'a42b7e2a44e6/', 'author_name': 'Software Heritage', 'author_email': 'robot@softwareheritage.org', 'committer_name': 'Software Heritage', 'committer_email': 'robot@softwareheritage.org', 'message': 'synthetic revision message', 'date_offset': 0, 'committer_date_offset': 0, 'parents': [{ 'id': '8734ef7e7c357ce2af928115c6c6a42b7e2a44e7', 'url': '/api/1/revision/8734ef7e7c357ce2af928115c6c6a42b7e2a44e7/' # noqa }], 'type': 'tar', 'synthetic': True, 'metadata': { 'original_artifact': [{ 'archive_type': 'tar', 'name': 'webbase-5.7.0.tar.gz', 'sha1': '147f73f369733d088b7a6fa9c4e0273dcd3c7ccd', 'sha1_git': '6a15ea8b881069adedf11feceec35588f2cfe8f1', 'sha256': '401d0df797110bea805d358b85bcc1ced29549d3d73f' '309d36484e7edf7bb912' }] }, } # when rv = self.client.get('/api/1/revision/' '18d8be353ed3480476f032475e7c233eff7371d5/') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(expected_revision, rv.data) mock_service.lookup_revision.assert_called_once_with( '18d8be353ed3480476f032475e7c233eff7371d5') @patch('swh.web.api.views.revision.service') @istest def api_revision_not_found(self, mock_service): # given mock_service.lookup_revision.return_value = None # when rv = self.client.get('/api/1/revision/12345/') # then self.assertEquals(rv.status_code, 404) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(rv.data, { 'exception': 'NotFoundExc', 'reason': 'Revision with sha1_git 12345 not found.'}) @patch('swh.web.api.views.revision.service') @istest def api_revision_raw_ok(self, mock_service): # given stub_revision = {'message': 'synthetic revision message'} mock_service.lookup_revision_message.return_value = stub_revision # when rv = self.client.get('/api/1/revision/18d8be353ed3480476f032475e7c2' '33eff7371d5/raw/') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/octet-stream') self.assertEquals(rv.content, b'synthetic revision message') mock_service.lookup_revision_message.assert_called_once_with( '18d8be353ed3480476f032475e7c233eff7371d5') @patch('swh.web.api.views.revision.service') @istest def api_revision_raw_ok_no_msg(self, mock_service): # given mock_service.lookup_revision_message.side_effect = NotFoundExc( 'No message for revision') # when rv = self.client.get('/api/1/revision/' '18d8be353ed3480476f032475e7c233eff7371d5/raw/') # then self.assertEquals(rv.status_code, 404) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(rv.data, { 'exception': 'NotFoundExc', 'reason': 'No message for revision'}) self.assertEquals mock_service.lookup_revision_message.assert_called_once_with( '18d8be353ed3480476f032475e7c233eff7371d5') @patch('swh.web.api.views.revision.service') @istest def api_revision_raw_ko_no_rev(self, mock_service): # given mock_service.lookup_revision_message.side_effect = NotFoundExc( 'No revision found') # when rv = self.client.get('/api/1/revision/' '18d8be353ed3480476f032475e7c233eff7371d5/raw/') # then self.assertEquals(rv.status_code, 404) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(rv.data, { 'exception': 'NotFoundExc', 'reason': 'No revision found'}) mock_service.lookup_revision_message.assert_called_once_with( '18d8be353ed3480476f032475e7c233eff7371d5') @patch('swh.web.api.views.revision.service') @istest def api_revision_with_origin_not_found(self, mock_service): mock_service.lookup_revision_by.return_value = None rv = self.client.get('/api/1/revision/origin/123/') # then self.assertEquals(rv.status_code, 404) self.assertEquals(rv['Content-Type'], 'application/json') self.assertIn('Revision with (origin_id: 123', rv.data['reason']) self.assertIn('not found', rv.data['reason']) self.assertEqual('NotFoundExc', rv.data['exception']) mock_service.lookup_revision_by.assert_called_once_with( '123', 'refs/heads/master', None) @patch('swh.web.api.views.revision.service') @istest def api_revision_with_origin(self, mock_service): mock_revision = { 'id': '32', 'directory': '21', 'message': 'message 1', 'type': 'deb', } expected_revision = { 'id': '32', 'url': '/api/1/revision/32/', 'history_url': '/api/1/revision/32/log/', 'directory': '21', 'directory_url': '/api/1/directory/21/', 'message': 'message 1', 'type': 'deb', } mock_service.lookup_revision_by.return_value = mock_revision rv = self.client.get('/api/1/revision/origin/1/') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEqual(rv.data, expected_revision) mock_service.lookup_revision_by.assert_called_once_with( '1', 'refs/heads/master', None) @patch('swh.web.api.views.revision.service') @istest def api_revision_with_origin_and_branch_name(self, mock_service): mock_revision = { 'id': '12', 'directory': '23', 'message': 'message 2', 'type': 'tar', } mock_service.lookup_revision_by.return_value = mock_revision expected_revision = { 'id': '12', 'url': '/api/1/revision/12/', 'history_url': '/api/1/revision/12/log/', 'directory': '23', 'directory_url': '/api/1/directory/23/', 'message': 'message 2', 'type': 'tar', } rv = self.client.get('/api/1/revision/origin/1' '/branch/refs/origin/dev/') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEqual(rv.data, expected_revision) mock_service.lookup_revision_by.assert_called_once_with( '1', 'refs/origin/dev', None) @patch('swh.web.api.views.revision.parse_timestamp') @patch('swh.web.api.views.revision.service') @patch('swh.web.api.views.revision.utils') @istest def api_revision_with_origin_and_branch_name_and_timestamp(self, mock_utils, mock_service, mock_parse_timestamp): # noqa mock_revision = { 'id': '123', 'directory': '456', 'message': 'message 3', 'type': 'tar', } mock_service.lookup_revision_by.return_value = mock_revision expected_revision = { 'id': '123', 'url': '/api/1/revision/123/', 'history_url': '/api/1/revision/123/log/', 'directory': '456', 'directory_url': '/api/1/directory/456/', 'message': 'message 3', 'type': 'tar', } mock_parse_timestamp.return_value = 'parsed-date' mock_utils.enrich_revision.return_value = expected_revision rv = self.client.get('/api/1/revision' '/origin/1' '/branch/refs/origin/dev' '/ts/1452591542/') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEqual(rv.data, expected_revision) mock_service.lookup_revision_by.assert_called_once_with( '1', 'refs/origin/dev', 'parsed-date') mock_parse_timestamp.assert_called_once_with('1452591542') mock_utils.enrich_revision.assert_called_once_with( mock_revision) @patch('swh.web.api.views.revision.parse_timestamp') @patch('swh.web.api.views.revision.service') @patch('swh.web.api.views.revision.utils') @istest def api_revision_with_origin_and_branch_name_and_timestamp_with_escapes( self, mock_utils, mock_service, mock_parse_timestamp): mock_revision = { 'id': '999', } mock_service.lookup_revision_by.return_value = mock_revision expected_revision = { 'id': '999', 'url': '/api/1/revision/999/', 'history_url': '/api/1/revision/999/log/', } mock_parse_timestamp.return_value = 'parsed-date' mock_utils.enrich_revision.return_value = expected_revision rv = self.client.get('/api/1/revision' '/origin/1' '/branch/refs%2Forigin%2Fdev' '/ts/Today%20is%20' 'January%201,%202047%20at%208:21:00AM/') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEqual(rv.data, expected_revision) mock_service.lookup_revision_by.assert_called_once_with( '1', 'refs/origin/dev', 'parsed-date') mock_parse_timestamp.assert_called_once_with( 'Today is January 1, 2047 at 8:21:00AM') mock_utils.enrich_revision.assert_called_once_with( mock_revision) @patch('swh.web.api.views.revision.service') @istest def revision_directory_by_ko_raise(self, mock_service): # given mock_service.lookup_directory_through_revision.side_effect = NotFoundExc('not') # noqa # when with self.assertRaises(NotFoundExc): _revision_directory_by( {'sha1_git': 'id'}, None, '/api/1/revision/sha1/directory/') # then mock_service.lookup_directory_through_revision.assert_called_once_with( {'sha1_git': 'id'}, None, limit=100, with_data=False) @patch('swh.web.api.views.revision.service') @istest def revision_directory_by_type_dir(self, mock_service): # given mock_service.lookup_directory_through_revision.return_value = ( 'rev-id', { 'type': 'dir', 'revision': 'rev-id', 'path': 'some/path', 'content': [] }) # when actual_dir_content = _revision_directory_by( {'sha1_git': 'blah-id'}, 'some/path', '/api/1/revision/sha1/directory/') # then self.assertEquals(actual_dir_content, { 'type': 'dir', 'revision': 'rev-id', 'path': 'some/path', 'content': [] }) mock_service.lookup_directory_through_revision.assert_called_once_with( {'sha1_git': 'blah-id'}, 'some/path', limit=100, with_data=False) @patch('swh.web.api.views.revision.service') @istest def revision_directory_by_type_file(self, mock_service): # given mock_service.lookup_directory_through_revision.return_value = ( 'rev-id', { 'type': 'file', 'revision': 'rev-id', 'path': 'some/path', 'content': {'blah': 'blah'} }) # when actual_dir_content = _revision_directory_by( {'sha1_git': 'sha1'}, 'some/path', '/api/1/revision/origin/2/directory/', limit=1000, with_data=True) # then self.assertEquals(actual_dir_content, { 'type': 'file', 'revision': 'rev-id', 'path': 'some/path', 'content': {'blah': 'blah'} }) mock_service.lookup_directory_through_revision.assert_called_once_with( {'sha1_git': 'sha1'}, 'some/path', limit=1000, with_data=True) @patch('swh.web.api.views.revision.parse_timestamp') @patch('swh.web.api.views.revision._revision_directory_by') @patch('swh.web.api.views.revision.utils') @istest def api_directory_through_revision_origin_ko_not_found(self, mock_utils, mock_rev_dir, mock_parse_timestamp): # noqa mock_rev_dir.side_effect = NotFoundExc('not found') mock_parse_timestamp.return_value = '2012-10-20 00:00:00' rv = self.client.get('/api/1/revision' '/origin/10' '/branch/refs/remote/origin/dev' '/ts/2012-10-20' '/directory/') # then self.assertEquals(rv.status_code, 404) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEqual(rv.data, { 'exception': 'NotFoundExc', 'reason': 'not found'}) mock_rev_dir.assert_called_once_with( {'origin_id': '10', 'branch_name': 'refs/remote/origin/dev', 'ts': '2012-10-20 00:00:00'}, None, '/api/1/revision' '/origin/10' '/branch/refs/remote/origin/dev' '/ts/2012-10-20' '/directory/', with_data=False) @patch('swh.web.api.views.revision._revision_directory_by') @istest def api_directory_through_revision_origin(self, mock_revision_dir): expected_res = [{ 'id': '123' }] mock_revision_dir.return_value = expected_res rv = self.client.get('/api/1/revision/origin/3/directory/') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEqual(rv.data, expected_res) mock_revision_dir.assert_called_once_with({ 'origin_id': '3', 'branch_name': 'refs/heads/master', 'ts': None}, None, '/api/1/revision/origin/3/directory/', with_data=False) @patch('swh.web.api.views.revision.service') @istest def api_revision_log(self, mock_service): # given stub_revisions = [{ 'id': '18d8be353ed3480476f032475e7c233eff7371d5', 'directory': '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 'author_name': 'Software Heritage', 'author_email': 'robot@softwareheritage.org', 'committer_name': 'Software Heritage', 'committer_email': 'robot@softwareheritage.org', 'message': 'synthetic revision message', 'date_offset': 0, 'committer_date_offset': 0, 'parents': ['7834ef7e7c357ce2af928115c6c6a42b7e2a4345'], 'type': 'tar', 'synthetic': True, }] mock_service.lookup_revision_log.return_value = stub_revisions expected_revisions = [{ 'id': '18d8be353ed3480476f032475e7c233eff7371d5', 'url': '/api/1/revision/18d8be353ed3480476f032475e7c233eff7371d5/', 'history_url': '/api/1/revision/18d8be353ed3480476f032475e7c233ef' 'f7371d5/log/', 'directory': '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 'directory_url': '/api/1/directory/7834ef7e7c357ce2af928115c6c6a' '42b7e2a44e6/', 'author_name': 'Software Heritage', 'author_email': 'robot@softwareheritage.org', 'committer_name': 'Software Heritage', 'committer_email': 'robot@softwareheritage.org', 'message': 'synthetic revision message', 'date_offset': 0, 'committer_date_offset': 0, 'parents': [{ 'id': '7834ef7e7c357ce2af928115c6c6a42b7e2a4345', 'url': '/api/1/revision/7834ef7e7c357ce2af928115c6c6a42b7e2a4345/', # noqa }], 'type': 'tar', 'synthetic': True, }] # when rv = self.client.get('/api/1/revision/8834ef7e7c357ce2af928115c6c6a42' 'b7e2a44e6/log/') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(rv.data, expected_revisions) self.assertFalse(rv.has_header('Link')) mock_service.lookup_revision_log.assert_called_once_with( '8834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 11) @patch('swh.web.api.views.revision.service') @istest def api_revision_log_with_next(self, mock_service): # given stub_revisions = [] for i in range(27): stub_revisions.append({'id': i}) mock_service.lookup_revision_log.return_value = stub_revisions[:26] expected_revisions = [x for x in stub_revisions if x['id'] < 25] for e in expected_revisions: e['url'] = '/api/1/revision/%s/' % e['id'] e['history_url'] = '/api/1/revision/%s/log/' % e['id'] # when rv = self.client.get('/api/1/revision/8834ef7e7c357ce2af928115c6c6a42' 'b7e2a44e6/log/?per_page=25') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(rv.data, expected_revisions) self.assertEquals(rv['Link'], '; rel="next"') mock_service.lookup_revision_log.assert_called_once_with( '8834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 26) @patch('swh.web.api.views.revision.service') @istest def api_revision_log_not_found(self, mock_service): # given mock_service.lookup_revision_log.return_value = None # when rv = self.client.get('/api/1/revision/8834ef7e7c357ce2af928115c6c6' 'a42b7e2a44e6/log/') # then self.assertEquals(rv.status_code, 404) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(rv.data, { 'exception': 'NotFoundExc', 'reason': 'Revision with sha1_git' ' 8834ef7e7c357ce2af928115c6c6a42b7e2a44e6 not found.'}) self.assertFalse(rv.has_header('Link')) mock_service.lookup_revision_log.assert_called_once_with( '8834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 11) @patch('swh.web.api.views.revision.service') @istest def api_revision_log_context(self, mock_service): # given stub_revisions = [{ 'id': '18d8be353ed3480476f032475e7c233eff7371d5', 'directory': '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 'author_name': 'Software Heritage', 'author_email': 'robot@softwareheritage.org', 'committer_name': 'Software Heritage', 'committer_email': 'robot@softwareheritage.org', 'message': 'synthetic revision message', 'date_offset': 0, 'committer_date_offset': 0, 'parents': ['7834ef7e7c357ce2af928115c6c6a42b7e2a4345'], 'type': 'tar', 'synthetic': True, }] mock_service.lookup_revision_log.return_value = stub_revisions mock_service.lookup_revision_multiple.return_value = [{ 'id': '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 'directory': '18d8be353ed3480476f032475e7c233eff7371d5', 'author_name': 'Name Surname', 'author_email': 'name@surname.com', 'committer_name': 'Name Surname', 'committer_email': 'name@surname.com', 'message': 'amazing revision message', 'date_offset': 0, 'committer_date_offset': 0, 'parents': ['adc83b19e793491b1c6ea0fd8b46cd9f32e592fc'], 'type': 'tar', 'synthetic': True, }] expected_revisions = [ { 'url': '/api/1/revision/' '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6/', 'history_url': '/api/1/revision/' '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6/log/', 'id': '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 'directory': '18d8be353ed3480476f032475e7c233eff7371d5', 'directory_url': '/api/1/directory/' '18d8be353ed3480476f032475e7c233eff7371d5/', 'author_name': 'Name Surname', 'author_email': 'name@surname.com', 'committer_name': 'Name Surname', 'committer_email': 'name@surname.com', 'message': 'amazing revision message', 'date_offset': 0, 'committer_date_offset': 0, 'parents': [{ 'id': 'adc83b19e793491b1c6ea0fd8b46cd9f32e592fc', 'url': '/api/1/revision/adc83b19e793491b1c6ea0fd8b46cd9f32e592fc/', # noqa }], 'type': 'tar', 'synthetic': True, }, { 'url': '/api/1/revision/' '18d8be353ed3480476f032475e7c233eff7371d5/', 'history_url': '/api/1/revision/' '18d8be353ed3480476f032475e7c233eff7371d5/log/', 'id': '18d8be353ed3480476f032475e7c233eff7371d5', 'directory': '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 'directory_url': '/api/1/directory/' '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6/', 'author_name': 'Software Heritage', 'author_email': 'robot@softwareheritage.org', 'committer_name': 'Software Heritage', 'committer_email': 'robot@softwareheritage.org', 'message': 'synthetic revision message', 'date_offset': 0, 'committer_date_offset': 0, 'parents': [{ 'id': '7834ef7e7c357ce2af928115c6c6a42b7e2a4345', 'url': '/api/1/revision/7834ef7e7c357ce2af928115c6c6a42b7e2a4345/', # noqa }], 'type': 'tar', 'synthetic': True, }] # when rv = self.client.get('/api/1/revision/18d8be353ed3480476f0' '32475e7c233eff7371d5/prev/21145781e2' '6ad1f978e/log/') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(expected_revisions, rv.data) self.assertFalse(rv.has_header('Link')) mock_service.lookup_revision_log.assert_called_once_with( '18d8be353ed3480476f032475e7c233eff7371d5', 11) mock_service.lookup_revision_multiple.assert_called_once_with( ['21145781e26ad1f978e']) @patch('swh.web.api.views.revision.service') @istest def api_revision_log_by(self, mock_service): # given stub_revisions = [{ 'id': '18d8be353ed3480476f032475e7c233eff7371d5', 'directory': '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 'author_name': 'Software Heritage', 'author_email': 'robot@softwareheritage.org', 'committer_name': 'Software Heritage', 'committer_email': 'robot@softwareheritage.org', 'message': 'synthetic revision message', 'date_offset': 0, 'committer_date_offset': 0, 'parents': ['7834ef7e7c357ce2af928115c6c6a42b7e2a4345'], 'type': 'tar', 'synthetic': True, }] mock_service.lookup_revision_log_by.return_value = stub_revisions expected_revisions = [{ 'id': '18d8be353ed3480476f032475e7c233eff7371d5', 'url': '/api/1/revision/18d8be353ed3480476f032475e7c233eff7371d5/', 'history_url': '/api/1/revision/18d8be353ed3480476f032475e7c233ef' 'f7371d5/log/', 'directory': '7834ef7e7c357ce2af928115c6c6a42b7e2a44e6', 'directory_url': '/api/1/directory/7834ef7e7c357ce2af928115c6c6a' '42b7e2a44e6/', 'author_name': 'Software Heritage', 'author_email': 'robot@softwareheritage.org', 'committer_name': 'Software Heritage', 'committer_email': 'robot@softwareheritage.org', 'message': 'synthetic revision message', 'date_offset': 0, 'committer_date_offset': 0, 'parents': [{ 'id': '7834ef7e7c357ce2af928115c6c6a42b7e2a4345', 'url': '/api/1/revision/7834ef7e7c357ce2af928115c6c6a42b7e2a4345/' # noqa }], 'type': 'tar', 'synthetic': True, }] # when rv = self.client.get('/api/1/revision/origin/1/log/') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(rv.data, expected_revisions) self.assertFalse(rv.has_header('Link')) mock_service.lookup_revision_log_by.assert_called_once_with( '1', 'refs/heads/master', None, 11) @patch('swh.web.api.views.revision.service') @istest def api_revision_log_by_with_next(self, mock_service): # given stub_revisions = [] for i in range(27): stub_revisions.append({'id': i}) mock_service.lookup_revision_log_by.return_value = stub_revisions[:26] expected_revisions = [x for x in stub_revisions if x['id'] < 25] for e in expected_revisions: e['url'] = '/api/1/revision/%s/' % e['id'] e['history_url'] = '/api/1/revision/%s/log/' % e['id'] # when rv = self.client.get('/api/1/revision/origin/1/log/?per_page=25') # then self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertIsNotNone(rv['Link']) self.assertEquals(rv.data, expected_revisions) mock_service.lookup_revision_log_by.assert_called_once_with( '1', 'refs/heads/master', None, 26) @patch('swh.web.api.views.revision.service') @istest def api_revision_log_by_norev(self, mock_service): # given mock_service.lookup_revision_log_by.side_effect = NotFoundExc( 'No revision') # when rv = self.client.get('/api/1/revision/origin/1/log/') - print(rv.content) - # then self.assertEquals(rv.status_code, 404) self.assertEquals(rv['Content-Type'], 'application/json') self.assertFalse(rv.has_header('Link')) self.assertEquals(rv.data, {'exception': 'NotFoundExc', 'reason': 'No revision'}) mock_service.lookup_revision_log_by.assert_called_once_with( '1', 'refs/heads/master', None, 11) @patch('swh.web.api.views.revision.service') @istest def api_revision_history(self, mock_service): # for readability purposes, we use: # - sha1 as 3 letters (url are way too long otherwise to respect pep8) # - only keys with modification steps (all other keys are kept as is) # given stub_revision = { 'id': '883', 'children': ['777', '999'], 'parents': [], 'directory': '272' } mock_service.lookup_revision.return_value = stub_revision # then rv = self.client.get('/api/1/revision/883/prev/999/') self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(rv.data, { 'id': '883', 'url': '/api/1/revision/883/', 'history_url': '/api/1/revision/883/log/', 'history_context_url': '/api/1/revision/883/prev/999/log/', 'children': ['777', '999'], 'children_urls': ['/api/1/revision/777/', '/api/1/revision/999/'], 'parents': [], 'directory': '272', 'directory_url': '/api/1/directory/272/' }) mock_service.lookup_revision.assert_called_once_with('883') @patch('swh.web.api.views.revision._revision_directory_by') @istest def api_revision_directory_ko_not_found(self, mock_rev_dir): # given mock_rev_dir.side_effect = NotFoundExc('Not found') # then rv = self.client.get('/api/1/revision/999/directory/some/path/to/dir/') self.assertEquals(rv.status_code, 404) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(rv.data, { 'exception': 'NotFoundExc', 'reason': 'Not found'}) mock_rev_dir.assert_called_once_with( {'sha1_git': '999'}, 'some/path/to/dir', '/api/1/revision/999/directory/some/path/to/dir/', with_data=False) @patch('swh.web.api.views.revision._revision_directory_by') @istest def api_revision_directory_ok_returns_dir_entries(self, mock_rev_dir): stub_dir = { 'type': 'dir', 'revision': '999', 'content': [ { 'sha1_git': '789', 'type': 'file', 'target': '101', 'target_url': '/api/1/content/sha1_git:101/', 'name': 'somefile', 'file_url': '/api/1/revision/999/directory/some/path/' 'somefile/' }, { 'sha1_git': '123', 'type': 'dir', 'target': '456', 'target_url': '/api/1/directory/456/', 'name': 'to-subdir', 'dir_url': '/api/1/revision/999/directory/some/path/' 'to-subdir/', }] } # given mock_rev_dir.return_value = stub_dir # then rv = self.client.get('/api/1/revision/999/directory/some/path/') self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(rv.data, stub_dir) mock_rev_dir.assert_called_once_with( {'sha1_git': '999'}, 'some/path', '/api/1/revision/999/directory/some/path/', with_data=False) @patch('swh.web.api.views.revision._revision_directory_by') @istest def api_revision_directory_ok_returns_content(self, mock_rev_dir): stub_content = { 'type': 'file', 'revision': '999', 'content': { 'sha1_git': '789', 'sha1': '101', 'data_url': '/api/1/content/101/raw/', } } # given mock_rev_dir.return_value = stub_content # then url = '/api/1/revision/666/directory/some/other/path/' rv = self.client.get(url) self.assertEquals(rv.status_code, 200) self.assertEquals(rv['Content-Type'], 'application/json') self.assertEquals(rv.data, stub_content) mock_rev_dir.assert_called_once_with( {'sha1_git': '666'}, 'some/other/path', url, with_data=False) diff --git a/swh/web/tests/browse/test_utils.py b/swh/web/tests/browse/test_utils.py index 50b2ad13..dfcce275 100644 --- a/swh/web/tests/browse/test_utils.py +++ b/swh/web/tests/browse/test_utils.py @@ -1,399 +1,433 @@ # Copyright (C) 2017-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information +# flake8: noqa + import unittest from unittest.mock import patch from nose.tools import istest from swh.web.browse import utils from swh.web.common.exc import NotFoundExc from swh.web.common.utils import reverse from swh.web.tests.testbase import SWHWebTestBase from .views.data.revision_test_data import revision_history_log_test class SwhBrowseUtilsTestCase(SWHWebTestBase, unittest.TestCase): @istest def get_mimetype_and_encoding_for_content(self): text = b'Hello world!' self.assertEqual(utils.get_mimetype_and_encoding_for_content(text), ('text/plain', 'us-ascii')) @patch('swh.web.browse.utils.service') @istest def get_origin_visits(self, mock_service): mock_service.MAX_LIMIT = 2 def _lookup_origin_visits(*args, **kwargs): if kwargs['last_visit'] is None: return [{'visit': 1, 'date': '2017-05-06T00:59:10+00:00', 'metadata': {}}, {'visit': 2, 'date': '2017-08-06T00:59:10+00:00', 'metadata': {}} ] else: return [{'visit': 3, 'date': '2017-09-06T00:59:10+00:00', 'metadata': {}} ] mock_service.lookup_origin_visits.side_effect = _lookup_origin_visits origin_info = { 'id': 1, 'type': 'git', 'url': 'https://github.com/foo/bar', } origin_visits = utils.get_origin_visits(origin_info) self.assertEqual(len(origin_visits), 3) @patch('swh.web.browse.utils.get_origin_visits') @istest def get_origin_visit(self, mock_origin_visits): origin_info = { 'id': 2, 'type': 'git', 'url': 'https://github.com/foo/bar', } visits = \ [{'status': 'full', 'date': '2015-07-09T21:09:24+00:00', 'visit': 1, 'origin': origin_info['id'] }, {'status': 'full', 'date': '2016-02-23T18:05:23.312045+00:00', 'visit': 2, 'origin': origin_info['id'] }, {'status': 'full', 'date': '2016-03-28T01:35:06.554111+00:00', 'visit': 3, 'origin': origin_info['id'] }, {'status': 'full', 'date': '2016-06-18T01:22:24.808485+00:00', 'visit': 4, 'origin': origin_info['id'] }, {'status': 'full', 'date': '2016-08-14T12:10:00.536702+00:00', 'visit': 5, 'origin': origin_info['id'] }] mock_origin_visits.return_value = visits with self.assertRaises(NotFoundExc) as cm: visit_id = 12 visit = utils.get_origin_visit(origin_info, visit_id=visit_id) self.assertIn('Visit with id %s for origin with id %s not found' % (origin_info['id'], visit_id), cm.exception.args[0]) visit = utils.get_origin_visit(origin_info, visit_id=2) self.assertEqual(visit, visits[1]) visit = utils.get_origin_visit( origin_info, visit_ts='2016-02-23T18:05:23.312045+00:00') self.assertEqual(visit, visits[1]) visit = utils.get_origin_visit( origin_info, visit_ts='2016-02-20') self.assertEqual(visit, visits[1]) visit = utils.get_origin_visit( origin_info, visit_ts='2016-06-18T01:22') self.assertEqual(visit, visits[3]) visit = utils.get_origin_visit( origin_info, visit_ts='2016-06-18 01:22') self.assertEqual(visit, visits[3]) visit = utils.get_origin_visit( origin_info, visit_ts=1466208000) self.assertEqual(visit, visits[3]) visit = utils.get_origin_visit( origin_info, visit_ts='2014-01-01') self.assertEqual(visit, visits[0]) visit = utils.get_origin_visit( origin_info, visit_ts='2018-01-01') self.assertEqual(visit, visits[-1]) @patch('swh.web.browse.utils.service') @patch('swh.web.browse.utils.get_origin_visit') @istest def get_origin_visit_occurrences(self, mock_get_origin_visit, mock_service): mock_get_origin_visit.return_value = \ {'status': 'full', 'date': '2015-08-04T22:26:14.804009+00:00', 'visit': 1, 'origin': 1} mock_service.lookup_origin_visit.return_value = \ {'date': '2015-08-04T22:26:14.804009+00:00', 'metadata': {}, 'occurrences': { 'refs/heads/master': { 'target': '9fbd21adbac36be869514e82e2e98505dc47219c', 'target_type': 'revision', - 'target_url': '/api/1/revision/9fbd21adbac36be869514e82e2e98505dc47219c/' # noqa + 'target_url': '/api/1/revision/9fbd21adbac36be869514e82e2e98505dc47219c/' }, 'refs/tags/0.10.0': { 'target': '6072557b6c10cd9a21145781e26ad1f978ed14b9', 'target_type': 'release', - 'target_url': '/api/1/release/6072557b6c10cd9a21145781e26ad1f978ed14b9/' # noqa + 'target_url': '/api/1/release/6072557b6c10cd9a21145781e26ad1f978ed14b9/' }, 'refs/tags/0.10.1': { 'target': 'ecc003b43433e5b46511157598e4857a761007bf', 'target_type': 'release', - 'target_url': '/api/1/release/ecc003b43433e5b46511157598e4857a761007bf/' # noqa + 'target_url': '/api/1/release/ecc003b43433e5b46511157598e4857a761007bf/' } }, 'origin': 1, 'origin_url': '/api/1/origin/1/', 'status': 'full', 'visit': 1} mock_service.lookup_release_multiple.return_value = \ [{'name': '0.10.0', + 'message': 'release 0.10.0', 'id': '6072557b6c10cd9a21145781e26ad1f978ed14b9', + 'date': '2015-08-04T13:16:54+03:00', + 'target_type': 'revision', 'target': 'e9c6243371087d04848b7686888f6dd29dfaef0e'}, {'name': '0.10.1', + 'message': 'release 0.10.1', 'id': 'ecc003b43433e5b46511157598e4857a761007bf', + 'date': '2017-08-04T13:16:54+03:00', + 'target_type': 'revision', 'target': '6072557b6c10cd9a21145781e26ad1f978ed14b9'}] mock_service.lookup_revision_multiple.return_value = \ - [{'directory': '828da2b80e41aa958b2c98526f4a1d2cc7d298b7'}, - {'directory': '2df4cd84ecc65b50b1d5318d3727e02a39b8a4cf'}, - {'directory': '28ba64f97ef709e54838ae482c2da2619a74a0bd'}] + [{'date': '2015-08-04T13:16:54+03:00', + 'directory': '828da2b80e41aa958b2c98526f4a1d2cc7d298b7', + 'id': '9fbd21adbac36be869514e82e2e98505dc47219c', + 'message': 'Merge pull request #678 from algernon'}, + {'date': '2014-04-10T23:01:11-04:00', + 'directory': '2df4cd84ecc65b50b1d5318d3727e02a39b8a4cf', + 'id': '6072557b6c10cd9a21145781e26ad1f978ed14b9', + 'message': '0.10: The "Oh fuck it\'s PyCon" release\n'}, + {'date': '2014-10-10T09:45:23-04:00', + 'directory': '28ba64f97ef709e54838ae482c2da2619a74a0bd', + 'id': 'ecc003b43433e5b46511157598e4857a761007bf', + 'message': '0.10.1\n'}] expected_result = ( [{'name': 'refs/heads/master', + 'message': 'Merge pull request #678 from algernon', + 'date': '04 August 2015, 13:16 UTC', 'revision': '9fbd21adbac36be869514e82e2e98505dc47219c', 'directory': '828da2b80e41aa958b2c98526f4a1d2cc7d298b7'}], [{'name': '0.10.0', - 'release': '6072557b6c10cd9a21145781e26ad1f978ed14b9', - 'revision': 'e9c6243371087d04848b7686888f6dd29dfaef0e', + 'id': '6072557b6c10cd9a21145781e26ad1f978ed14b9', + 'message': 'release 0.10.0', + 'date': '04 August 2015, 13:16 UTC', + 'target_type': 'revision', + 'target': 'e9c6243371087d04848b7686888f6dd29dfaef0e', 'directory': '2df4cd84ecc65b50b1d5318d3727e02a39b8a4cf'}, {'name': '0.10.1', - 'release': 'ecc003b43433e5b46511157598e4857a761007bf', - 'revision': '6072557b6c10cd9a21145781e26ad1f978ed14b9', + 'id': 'ecc003b43433e5b46511157598e4857a761007bf', + 'message': 'release 0.10.1', + 'date': '04 August 2017, 13:16 UTC', + 'target_type': 'revision', + 'target': '6072557b6c10cd9a21145781e26ad1f978ed14b9', 'directory': '28ba64f97ef709e54838ae482c2da2619a74a0bd'}] ) origin_info = { 'id': 1, 'type': 'git', 'url': 'https://github.com/hylang/hy' } origin_visit_branches = \ utils.get_origin_visit_occurrences(origin_info, visit_id=1) self.assertEqual(origin_visit_branches, expected_result) @istest def gen_link(self): - self.assertEqual(utils.gen_link('https://www.softwareheritage.org/', 'SWH'), # noqa + self.assertEqual(utils.gen_link('https://www.softwareheritage.org/', 'SWH'), 'SWH') @istest def gen_person_link(self): person_id = 8221896 person_name = 'Antoine Lambert' person_url = reverse('browse-person', kwargs={'person_id': person_id}) self.assertEqual(utils.gen_person_link(person_id, person_name), '%s' % (person_url, person_name)) @istest def gen_revision_link(self): revision_id = '28a0bc4120d38a394499382ba21d6965a67a3703' revision_url = reverse('browse-revision', kwargs={'sha1_git': revision_id}) self.assertEqual(utils.gen_revision_link(revision_id), '%s' % (revision_url, revision_id)) self.assertEqual(utils.gen_revision_link(revision_id, shorten_id=True), - '%s' % (revision_url, revision_id[:7])) # noqa + '%s' % (revision_url, revision_id[:7])) @istest def prepare_revision_log_for_display_no_contex(self): per_page = 10 first_page_logs_data = revision_history_log_test[:per_page+1] - second_page_logs_data = revision_history_log_test[per_page:2*per_page+1] # noqa - third_page_logs_data = revision_history_log_test[2*per_page:3*per_page+1] # noqa - last_page_logs_data = revision_history_log_test[3*per_page:3*per_page+5] # noqa + second_page_logs_data = revision_history_log_test[per_page:2*per_page+1] + third_page_logs_data = revision_history_log_test[2*per_page:3*per_page+1] + last_page_logs_data = revision_history_log_test[3*per_page:3*per_page+5] revision_log_display_data = utils.prepare_revision_log_for_display( first_page_logs_data, per_page, None) self.assertEqual(revision_log_display_data['revision_log_data'], utils._format_log_entries(first_page_logs_data, per_page)) self.assertEqual(revision_log_display_data['prev_rev'], first_page_logs_data[-1]['id']) self.assertEqual(revision_log_display_data['prev_revs_breadcrumb'], first_page_logs_data[0]['id']) self.assertEqual(revision_log_display_data['next_rev'], None) self.assertEqual(revision_log_display_data['next_revs_breadcrumb'], None) - old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) # noqa + old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) revision_log_display_data = utils.prepare_revision_log_for_display( second_page_logs_data, per_page, old_prev_revs_bc) self.assertEqual(revision_log_display_data['revision_log_data'], utils._format_log_entries(second_page_logs_data, per_page)) self.assertEqual(revision_log_display_data['prev_rev'], second_page_logs_data[-1]['id']) self.assertEqual(revision_log_display_data['prev_revs_breadcrumb'], - old_prev_revs_bc + '/' + second_page_logs_data[0]['id']) # noqa + old_prev_revs_bc + '/' + second_page_logs_data[0]['id']) self.assertEqual(revision_log_display_data['next_rev'], old_prev_revs_bc) self.assertEqual(revision_log_display_data['next_revs_breadcrumb'], None) - old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) # noqa + old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) revision_log_display_data = utils.prepare_revision_log_for_display( third_page_logs_data, per_page, old_prev_revs_bc) self.assertEqual(revision_log_display_data['revision_log_data'], - utils._format_log_entries(third_page_logs_data, per_page)) # noqa + utils._format_log_entries(third_page_logs_data, per_page)) self.assertEqual(revision_log_display_data['prev_rev'], third_page_logs_data[-1]['id']) self.assertEqual(revision_log_display_data['prev_revs_breadcrumb'], - old_prev_revs_bc + '/' + third_page_logs_data[0]['id']) # noqa + old_prev_revs_bc + '/' + third_page_logs_data[0]['id']) self.assertEqual(revision_log_display_data['next_rev'], old_prev_revs_bc.split('/')[-1]) self.assertEqual(revision_log_display_data['next_revs_breadcrumb'], '/'.join(old_prev_revs_bc.split('/')[:-1])) - old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) # noqa + old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) revision_log_display_data = utils.prepare_revision_log_for_display( last_page_logs_data, per_page, old_prev_revs_bc) self.assertEqual(revision_log_display_data['revision_log_data'], - utils._format_log_entries(last_page_logs_data, per_page)) # noqa + utils._format_log_entries(last_page_logs_data, per_page)) self.assertEqual(revision_log_display_data['prev_rev'], None) self.assertEqual(revision_log_display_data['prev_revs_breadcrumb'], - None) # noqa + None) - self.assertEqual(revision_log_display_data['next_rev'], old_prev_revs_bc.split('/')[-1]) # noqa + self.assertEqual(revision_log_display_data['next_rev'], old_prev_revs_bc.split('/')[-1]) self.assertEqual(revision_log_display_data['next_revs_breadcrumb'], '/'.join(old_prev_revs_bc.split('/')[:-1])) @istest - def prepare_revision_log_for_display_origin_contex(self): + def prepare_revision_log_for_display_origin_context(self): per_page = 10 first_page_logs_data = revision_history_log_test[:per_page+1] - second_page_logs_data = revision_history_log_test[per_page:2*per_page+1] # noqa - third_page_logs_data = revision_history_log_test[2*per_page:3*per_page+1] # noqa - last_page_logs_data = revision_history_log_test[3*per_page:3*per_page+5] # noqa + second_page_logs_data = revision_history_log_test[per_page:2*per_page+1] + third_page_logs_data = revision_history_log_test[2*per_page:3*per_page+1] + last_page_logs_data = revision_history_log_test[3*per_page:3*per_page+5] + + origin_context = { + 'origin_info': {'type': 'git', + 'url': 'https://github.com/git/git'}, + 'url_args': {}, + 'query_params': {} + } revision_log_display_data = utils.prepare_revision_log_for_display( - first_page_logs_data, per_page, None, origin_context=True) + first_page_logs_data, per_page, None, origin_context=origin_context) self.assertEqual(revision_log_display_data['revision_log_data'], utils._format_log_entries(first_page_logs_data, - per_page)) + per_page, origin_context=origin_context)) self.assertEqual(revision_log_display_data['prev_rev'], first_page_logs_data[-1]['id']) self.assertEqual(revision_log_display_data['prev_revs_breadcrumb'], first_page_logs_data[-1]['id']) self.assertEqual(revision_log_display_data['next_rev'], None) self.assertEqual(revision_log_display_data['next_revs_breadcrumb'], None) - old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) # noqa + old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) revision_log_display_data = utils.prepare_revision_log_for_display( - second_page_logs_data, per_page, old_prev_revs_bc, origin_context=True) # noqa + second_page_logs_data, per_page, old_prev_revs_bc, origin_context=origin_context) self.assertEqual(revision_log_display_data['revision_log_data'], utils._format_log_entries(second_page_logs_data, - per_page)) + per_page, origin_context=origin_context)) self.assertEqual(revision_log_display_data['prev_rev'], second_page_logs_data[-1]['id']) self.assertEqual(revision_log_display_data['prev_revs_breadcrumb'], - old_prev_revs_bc + '/' + second_page_logs_data[-1]['id']) # noqa + old_prev_revs_bc + '/' + second_page_logs_data[-1]['id']) self.assertEqual(revision_log_display_data['next_rev'], old_prev_revs_bc) self.assertEqual(revision_log_display_data['next_revs_breadcrumb'], None) - old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) # noqa + old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) revision_log_display_data = utils.prepare_revision_log_for_display( - third_page_logs_data, per_page, old_prev_revs_bc, origin_context=True) # noqa + third_page_logs_data, per_page, old_prev_revs_bc, origin_context=origin_context) self.assertEqual(revision_log_display_data['revision_log_data'], - utils._format_log_entries(third_page_logs_data, per_page)) # noqa + utils._format_log_entries(third_page_logs_data, per_page, + origin_context=origin_context)) self.assertEqual(revision_log_display_data['prev_rev'], third_page_logs_data[-1]['id']) self.assertEqual(revision_log_display_data['prev_revs_breadcrumb'], - old_prev_revs_bc + '/' + third_page_logs_data[-1]['id']) # noqa + old_prev_revs_bc + '/' + third_page_logs_data[-1]['id']) self.assertEqual(revision_log_display_data['next_rev'], old_prev_revs_bc.split('/')[-1]) self.assertEqual(revision_log_display_data['next_revs_breadcrumb'], '/'.join(old_prev_revs_bc.split('/')[:-1])) - old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) # noqa + old_prev_revs_bc = str(revision_log_display_data['prev_revs_breadcrumb']) revision_log_display_data = utils.prepare_revision_log_for_display( - last_page_logs_data, per_page, old_prev_revs_bc, origin_context=True) # noqa + last_page_logs_data, per_page, old_prev_revs_bc, origin_context=origin_context) self.assertEqual(revision_log_display_data['revision_log_data'], - utils._format_log_entries(last_page_logs_data, per_page)) # noqa + utils._format_log_entries(last_page_logs_data, per_page, + origin_context=origin_context)) self.assertEqual(revision_log_display_data['prev_rev'], None) self.assertEqual(revision_log_display_data['prev_revs_breadcrumb'], - None) # noqa + None) - self.assertEqual(revision_log_display_data['next_rev'], old_prev_revs_bc.split('/')[-1]) # noqa + self.assertEqual(revision_log_display_data['next_rev'], old_prev_revs_bc.split('/')[-1]) self.assertEqual(revision_log_display_data['next_revs_breadcrumb'], '/'.join(old_prev_revs_bc.split('/')[:-1])) diff --git a/swh/web/tests/browse/views/data/origin_test_data.py b/swh/web/tests/browse/views/data/origin_test_data.py index 16993486..96858b0d 100644 --- a/swh/web/tests/browse/views/data/origin_test_data.py +++ b/swh/web/tests/browse/views/data/origin_test_data.py @@ -1,797 +1,726 @@ # Copyright (C) 2017-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information # flake8: noqa origin_info_test_data = { 'id': 2, 'type': 'git', 'url': 'https://github.com/torvalds/linux' } origin_visits_test_data = [ {'date': '2015-07-09T21:09:24+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 1}, {'date': '2016-02-23T18:05:23.312045+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 2}, {'date': '2016-03-28T01:35:06.554111+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 3}, {'date': '2016-06-18T01:22:24.808485+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 4}, {'date': '2016-08-14T12:10:00.536702+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 5}, {'date': '2016-08-17T09:16:22.052065+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 6}, {'date': '2016-08-29T18:55:54.153721+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 7}, {'date': '2016-09-07T08:44:47.861875+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 8}, {'date': '2016-09-14T10:36:21.505296+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 9}, {'date': '2016-09-23T10:14:02.169862+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 10}, {'date': '2017-02-16T07:53:39.467657+00:00', 'metadata': {}, 'origin': 2, 'status': 'partial', 'visit': 11}, {'date': '2017-05-04T19:40:09.336451+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 12}, {'date': '2017-09-07T18:43:13.021746+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 13}, {'date': '2017-09-09T05:14:33.466107+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 14}, {'date': '2017-09-09T17:18:54.307789+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 15}, {'date': '2017-09-10T05:29:01.462971+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 16}, {'date': '2017-09-10T17:35:20.158515+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 17}, {'date': '2017-09-11T05:49:58.300518+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 18}, {'date': '2017-09-11T18:00:15.037345+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 19}, {'date': '2017-09-12T06:06:34.703343+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 20}, {'date': '2017-09-12T18:12:35.344511+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 21}, {'date': '2017-09-13T06:26:36.580675+00:00', 'metadata': {}, 'origin': 2, 'status': 'full', 'visit': 22} ] stub_origin_info = { 'id': 7416001, 'type': 'git', 'url': 'https://github.com/webpack/webpack' } stub_visit_id = 10 stub_visit_unix_ts = 1493909263 stub_visit_iso_date = '2017-05-04T14:47:43+00:00' stub_origin_visits = [ {'date': '2015-08-05T18:55:20.899865+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 1}, {'date': '2016-03-06T12:16:26.240919+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 2}, {'date': '2016-03-21T11:40:10.329221+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 3}, {'date': '2016-03-29T08:05:17.602649+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 4}, {'date': '2016-07-26T20:11:03.827577+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 5}, {'date': '2016-08-13T04:10:22.142897+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 6}, {'date': '2016-08-16T22:57:46.201737+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 7}, {'date': '2016-08-17T17:58:43.346437+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 8}, {'date': '2016-08-29T23:29:09.445945+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 9}, {'date': '2016-09-07T13:49:15.096109+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 10}, {'date': '2016-09-14T15:01:09.017257+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 11}, {'date': '2016-09-23T12:29:15.921727+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 12}, {'date': '2017-02-16T07:44:23.302439+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'partial', 'visit': 13}, {'date': '2017-05-04T14:47:43.228455+00:00', 'metadata': {}, 'origin': 7416001, 'status': 'full', 'visit': 14} ] stub_origin_occurrences = ( [ {'directory': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'name': 'HEAD', - 'revision': '7bc08e1aa0b08cb23e18715a32aa38517ad34672'}, + 'revision': '7bc08e1aa0b08cb23e18715a32aa38517ad34672', + 'date': '04 May 2017, 13:27 UTC', + 'message': 'Merge pull request #4816 from webpack/bugfix/hoist-immutable-export'}, {'directory': 'c47a824f95109ca7cafdd1c3206332a0d10df55d', 'name': 'refs/heads/0.10', - 'revision': 'f944553c77254732c4ce22c0add32aa1f641959d'}, + 'revision': 'f944553c77254732c4ce22c0add32aa1f641959d', + 'date': '19 June 2013, 12:46 UTC', + 'message': 'webpack 0.10'}, {'directory': '45e31184ebb7699cd74175145c7eb11cce3f085e', 'name': 'refs/heads/0.11', - 'revision': '0a29109a6e4579926ebc9b03a6301c61861cce62'}, + 'revision': '0a29109a6e4579926ebc9b03a6301c61861cce62', + 'date': '31 December 2013, 12:43 UTC', + 'message': '0.11.18'}, {'directory': '42346b33e2d16019490c273ff586ee88817327b3', 'name': 'refs/heads/0.8', - 'revision': 'e42701dc6f9b035bfbb5d0fffded905d8b456db4'}, + 'revision': 'e42701dc6f9b035bfbb5d0fffded905d8b456db4', + 'date': 'e42701dc6f9b035bfbb5d0fffded905d8b456db4', + 'message': 'fixes #54'}, {'directory': '828c7e9385523f852f8d4dac3cb241e319a9ce61', 'name': 'refs/heads/0.9', - 'revision': '6c3f51e6d9491a2463ad099a2ca49255ec83ff00'}, + 'revision': '6c3f51e6d9491a2463ad099a2ca49255ec83ff00', + 'date': '19 March 2013, 07:56 UTC', + 'message': 'updated some small things on the cli'}, {'directory': '2c50e78d63bdc4441c8d2691f5729b04f0ab3ecd', 'name': 'refs/heads/1.0', - 'revision': 'fb7958d172e1ef6fb77f23bf56818ad24e896e5c'}, + 'revision': 'fb7958d172e1ef6fb77f23bf56818ad24e896e5c', + 'date': '03 March 2014, 14:37 UTC', + 'message': 'Merge pull request #188 from polotek/patch-1'}, {'directory': '31a3355c4d0a464aa311c5fa11c7f8b20aede6b4', 'name': 'refs/heads/IgnorePluginHotfix', - 'revision': 'fdc922a2fa007e71b7ec07252012ffab9a178d4a'}, + 'revision': 'fdc922a2fa007e71b7ec07252012ffab9a178d4a', + 'date': '08 April 2017, 15:50 UTC', + 'message': 'add tests for ignored context modules'}, {'directory': 'e566db1fc65cb61b3799c6e0f0ad06b2406f095f', 'name': 'refs/heads/beta', - 'revision': '40428853da5d9ce6a8751e13b5e54145337b6a7e'}, - {'directory': '0f3cf363d4184a2cc36fdbebe1657d40fad6a591', - 'name': 'refs/heads/break/add-timeout', - 'revision': '14c43e0cc54af67344f8304708ccdd7b8ab91110'}, - {'directory': '8dc14b0625b2280d630aeae9dd424054c37db820', - 'name': 'refs/heads/bugfix/child-records-cache', - 'revision': '101850c5a90dbc51f1a95813fe1fece42bc1b9dc'}, - {'directory': '08c703fdf5cdb4f9321a1e1ad616eeeb78c96670', - 'name': 'refs/heads/bugfix/disable-module-in-harmony', - 'revision': 'bebe688e6cd0cfe35b967069ddfe1ca42a83f99b'}, - {'directory': '2378f4c463a54f057e42b2e489cd641645f82517', - 'name': 'refs/heads/bugfix/dll-extension', - 'revision': '38264a092e130b83bfe521e6e35a3b3e7600f183'}, - {'directory': 'def1489e00e12ed6ed2515c782da4ed29bf7a2dc', - 'name': 'refs/heads/bugfix/order', - 'revision': '089356faa3d27c1ef4d5c9eee1c235bc8ea505ea'}, - {'directory': 'fe1f7ebe60b771b6494be316fc01c305e0ba5c3c', - 'name': 'refs/heads/bugfix/status', - 'revision': '206ef6d079515a57fbca113cbdcb53cec3def4d6'}, - {'directory': '4cb66b94d3f2438fc095271f7184ca643ce1cdc4', - 'name': 'refs/heads/ci/bench', - 'revision': '21af9e96908e62616eaf04337dfc1b69630765d9'}, - {'directory': 'c1aff7c49f9a38edb1d2e037cc401a9f9e2366ff', - 'name': 'refs/heads/dep/dependency-update', - 'revision': '0bb4b14118ce8ce745222c89c75c166f219a6193'}, - {'directory': 'b4db55e82f9d7b7a9ebc8ce6a2b511d86efb3012', - 'name': 'refs/heads/feature/emoji_presets_to_options', - 'revision': 'a6ebd61bb967d66e1573562f58b2d36893cf338d'}, - {'directory': '676474786d3e6334f1a71bf49adb1e53b0681d34', - 'name': 'refs/heads/feature/fix_errors_only_bug', - 'revision': '5dd1d0cb130032fe176e70b770c38e7df3d804d2'}, - {'directory': '8c8576394828f016d7981e10199ba7a4dee58cf8', - 'name': 'refs/heads/feature/fix_watch_test_cases_timeout_for_caching_harmony', - 'revision': 'd507632afaa4ec2257601e58e17b455ab2491a58'}, - {'directory': 'b1968bb5bbbd604ef52b10668b04869f5790f7c2', - 'name': 'refs/heads/feature/jsonp-to-push', - 'revision': 'cc26df3dd65062d19fca6268adb866dbf9ec0d8e'}, - {'directory': '2a13a1b4e098680cfc4a3a9a103873a0fce232c4', - 'name': 'refs/heads/feature/postinstall-autolink', - 'revision': '7d4e0b72491819e51e84a8747ebcb07bebcf0f6a'}, - {'directory': '27226447d3a8e6de4dec3878eac3617f922b358c', - 'name': 'refs/heads/feature/travis_yarn_command', - 'revision': 'd370967ac8874214023aa69a22c120d4a0cbdef9'}, - {'directory': '4bd9839b5ade32398ff62a7aced9a32cf89981d0', - 'name': 'refs/heads/feature/webpack_analytics', - 'revision': 'a3461fdc6232bef3e4df3bab5079ab5323df1216'}, - {'directory': '1d427c810ab43e1abfdda73a09af41ea4e314a9f', - 'name': 'refs/heads/feature/webpack_options_apply_coverage_increase', - 'revision': 'b92f3fd3ab21959fcdfe492fb927c70014f16def'}, - {'directory': 'fe6b88dd54f3c1043d32e8af812655ea9b8ba000', - 'name': 'refs/heads/fix/node_modules_mangle', - 'revision': '26f79f5b30ba51afae6219ba53bf52be138c2fd3'}, - {'directory': 'b01142c405b9dba0d73dd8232a310ec469c89379', - 'name': 'refs/heads/inline', - 'revision': '427798d4f0e6b72ca3ecb4bfe849b3a17de08729'}, - {'directory': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', - 'name': 'refs/heads/master', - 'revision': '7bc08e1aa0b08cb23e18715a32aa38517ad34672'}, - {'directory': '63fe66a1ecbb35be33f617f96080a78463f89948', - 'name': 'refs/heads/perf/chunks-set', - 'revision': 'f6f22ef0a733931e217050ad9c3b95265978a556'}, - {'directory': '6b813dd7a42991507ef11bc347d53a28340f563c', - 'name': 'refs/heads/perf/modules-set', - 'revision': 'df44599731b4b1d185b20ccd36e9d37d817ad8c2'}, - {'directory': '29cf488a00126c0e45c78b92f97cdbc733f4d07e', - 'name': 'refs/heads/test/circleci', - 'revision': '0f91f949e2d41ef5cb92493bcc6c1fa7578ac27d'}, - {'directory': 'ea3a49842790b4eb8c3805a3318d8ade15cea6c8', - 'name': 'refs/heads/test/dependency-upgrade', - 'revision': 'c6265492ec886405256e23b9fe4de6dfd1e39c49'}, - {'directory': '4de09be1628ed81def03f78d8d832c93efdf0af4', - 'name': 'refs/heads/test/move-entry', - 'revision': 'a244879a07e04e6b5951520ca3cd80c3ef160f8e'}, - {'directory': '0fa77c20564364056319570bd46607111c97cb42', - 'name': 'refs/heads/webpack-1', - 'revision': 'd4878a55be7a4b7ac4e5db1ae5eef89e15811072'} + 'revision': '40428853da5d9ce6a8751e13b5e54145337b6a7e', + 'date': '04 May 2017, 13:35 UTC', + 'message': 'Merge remote-tracking branch \'origin/perf/chunks-set\' into beta'} ], [{'name': 'v2.1.0-beta.6', - 'release': 'ae2e1a30e4f2ac701e8a6e2fe85a5f200d7e597a', - 'revision': 'ca8b693c2c17bd06778476381fae23b3b21c0475', + 'message': '2.1.0-beta.6', + 'date': '22 April 2016, 01:03 UTC', + 'id': 'ae2e1a30e4f2ac701e8a6e2fe85a5f200d7e597a', + 'target_type': 'revision', + 'target': 'ca8b693c2c17bd06778476381fae23b3b21c0475', 'directory': '4e1f9b3c2f5c4bd205051a14af4ade62349ee57a'}, {'name': 'v2.1.0-beta.7', - 'target': '46e94bbdc9e54cf6273a985732446b4c963bf1aa', - 'revision': '9162f9e6eea62137139f95b8aaedee335c870edd', + 'message': '2.1.0-beta.7', + 'date': '07 May 2016, 00:00 UTC', + 'id': '46e94bbdc9e54cf6273a985732446b4c963bf1aa', + 'target_type': 'revision', + 'target': '9162f9e6eea62137139f95b8aaedee335c870edd', 'directory': '713763f90f17371fec714c1660f229ba41b9f5e2'}, {'name': 'v2.1.0-beta.8', - 'release': '910ada6bf809f8f1c318e098f67f2c0b3c80c888', - 'revision': 'abf0cefd592700a19856c3ef9b6d65f905ec73c1', + 'message': '2.1.0-beta.8', + 'date': '29 May 2016, 20:53 UTC', + 'id': '910ada6bf809f8f1c318e098f67f2c0b3c80c888', + 'target_type': 'revision', + 'target': 'abf0cefd592700a19856c3ef9b6d65f905ec73c1', 'directory': 'd6a069fda992759670851dc38500b2e8dccdc595'}, {'name': 'v2.1.0-beta.9', - 'target': '63063663c86b0c7e5886adbd3c22aacba9b957b0', - 'revision': 'dc3bd055027d8d1ebbb0ebdd07fb73387a0ab6d1', + 'message': '2.1.0-beta.9', + 'date': '04 June 2016, 20:19 UTC', + 'id': '63063663c86b0c7e5886adbd3c22aacba9b957b0', + 'target_type': 'revision', + 'target': 'dc3bd055027d8d1ebbb0ebdd07fb73387a0ab6d1', 'directory': '467251807aea6ba83719194e9a1d65e8053f14e0'} ]) stub_origin_master_branch = 'HEAD' stub_origin_root_directory_sha1 = 'ae59ceecf46367e8e4ad800e231fc76adc3afffb' stub_origin_root_directory_entries = [ {'checksums': {'sha1': '1a17dd2c8245559b43a90aa7c084572e917effff', 'sha1_git': '012966bd94e648f23b53e71a3f9918e28abc5d81', 'sha256': 'd65ab1f8cdb323e2b568a8e99814b1b986a38beed85a380981b383c0feb93525'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 394, 'name': '.editorconfig', 'perms': 33188, 'status': 'visible', 'target': '012966bd94e648f23b53e71a3f9918e28abc5d81', 'type': 'file'}, {'checksums': {'sha1': '2e727ec452dc592ae6038d3e09cd35d83d7ea265', 'sha1_git': '291a4e25598633cd7c286ad8d6cbe9eee5a6291a', 'sha256': 'd5951c8b796288e0dae1da50575d1b8619462a8df2272cd250146872a1fe804a'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 1839, 'name': '.eslintrc.js', 'perms': 33188, 'status': 'visible', 'target': '291a4e25598633cd7c286ad8d6cbe9eee5a6291a', 'type': 'file'}, {'checksums': {'sha1': '5c59880c0576b2789ec126b61b09fad7a982763b', 'sha1_git': 'ac579eb7bc04ba44fe84f3c8d1082573e9f4f514', 'sha256': '8a59a61ff6c0f568a8f76bab434baf3318c80a75ef6fb1b6eb861a0c97518de0'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 67, 'name': '.gitattributes', 'perms': 33188, 'status': 'visible', 'target': 'ac579eb7bc04ba44fe84f3c8d1082573e9f4f514', 'type': 'file'}, {'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': None, 'name': '.github', 'perms': 16384, 'target': '93bdcf98e9c05307b39a9d9e00e48cda6dbd036c', 'type': 'dir'}, {'checksums': {'sha1': '7e1008eee2a373f0db7746d0416856aec6b95c22', 'sha1_git': '84bc35a3abab38bdf87a8f32cc82ce9c136d331e', 'sha256': '7de369f1d26bc34c7b6329de78973db07e341320eace6a8704a65d4c5bf5993f'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 167, 'name': '.gitignore', 'perms': 33188, 'status': 'visible', 'target': '84bc35a3abab38bdf87a8f32cc82ce9c136d331e', 'type': 'file'}, {'checksums': {'sha1': '06d96508b7d343ff42868f9b6406864517935da7', 'sha1_git': '79b049846744a2da3eb1c4ac3b01543f2bdca44a', 'sha256': '697733061d96dd2e061df04dcd86392bb792e2dbe5725a6cb14a436d3c8b76f1'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 706, 'name': '.jsbeautifyrc', 'perms': 33188, 'status': 'visible', 'target': '79b049846744a2da3eb1c4ac3b01543f2bdca44a', 'type': 'file'}, {'checksums': {'sha1': '8041a4a66f46e615c99a850700850a8bd1079dce', 'sha1_git': '90e4f1ef5beb167891b2e029da6eb9b14ab17add', 'sha256': '3d6a76a57351b9e3acc5843ff2127dc2cf70c023133312143f86ee74ba9ef6d3'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 1059, 'name': '.travis.yml', 'perms': 33188, 'status': 'visible', 'target': '90e4f1ef5beb167891b2e029da6eb9b14ab17add', 'type': 'file'}, {'checksums': {'sha1': 'cd52973e43c6f4294e8cdfd3106df602b9993f20', 'sha1_git': 'e5279ebcecd87445648d003c36e6abfebed0ed73', 'sha256': '130672b16dff61b1541b6d26c2e568ac11830a31d04faace1583d3ad4a38720e'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 2058, 'name': 'CONTRIBUTING.md', 'perms': 33188, 'status': 'visible', 'target': 'e5279ebcecd87445648d003c36e6abfebed0ed73', 'type': 'file'}, {'checksums': {'sha1': '3bebb9ba92e45dd02a0512e144f6a46b14a9b8ab', 'sha1_git': '8c11fc7289b75463fe07534fcc8224e333feb7ff', 'sha256': '9068a8782d2fb4c6e432cfa25334efa56f722822180570802bf86e71b6003b1e'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 1071, 'name': 'LICENSE', 'perms': 33188, 'status': 'visible', 'target': '8c11fc7289b75463fe07534fcc8224e333feb7ff', 'type': 'file'}, {'checksums': {'sha1': '6892825420196e84c7104a7ff71ec75db20a1fca', 'sha1_git': '8f96a0a6d3bfe7183765938483585f3981151553', 'sha256': 'b0170cfc28f56ca718b43ab086ca5428f853268687c8c033b4fbf028c66d663e'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 46700, 'name': 'README.md', 'perms': 33188, 'status': 'visible', 'target': '8f96a0a6d3bfe7183765938483585f3981151553', 'type': 'file'}, {'checksums': {'sha1': '9bc4902b282f9f1c9f8f885a6947f3bf0f6e6e5f', 'sha1_git': 'dd6912c8fc97eff255d64da84cfd9837ebf0a05a', 'sha256': 'e06dbc101195ec7ea0b9aa236be4bdc03784a01f64d6e11846ce3a3f6e1080c6'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 590, 'name': 'appveyor.yml', 'perms': 33188, 'status': 'visible', 'target': 'dd6912c8fc97eff255d64da84cfd9837ebf0a05a', 'type': 'file'}, {'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': None, 'name': 'benchmark', 'perms': 16384, 'target': '6bd2996b76e051982aa86499a2b485594e607fe3', 'type': 'dir'}, {'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': None, 'name': 'bin', 'perms': 16384, 'target': '681da97ea1ce9a2bd29e3e72781d80e8b961cd51', 'type': 'dir'}, {'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': None, 'name': 'buildin', 'perms': 16384, 'target': '35cfb25d1b3a4063bf04a43f9cbb7e1e87703708', 'type': 'dir'}, {'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': None, 'name': 'ci', 'perms': 16384, 'target': 'efccd3ce0a0304c8cbcffcfdfcafcf1e598819b8', 'type': 'dir'}, {'checksums': {'sha1': '9eb3d0e3711f68f82d29785e64ebff2c0d7cec7a', 'sha1_git': '1ecf877e445bcf865ef53cfcecadda7e9691aace', 'sha256': '2007e0883c2784bb82584a10d53a0f0c36286dd913741bfd5e4d22b812db529c'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 529, 'name': 'circle.yml', 'perms': 33188, 'status': 'visible', 'target': '1ecf877e445bcf865ef53cfcecadda7e9691aace', 'type': 'file'}, {'checksums': {'sha1': '63209428718e101492c3bb91509f1b4e319b0d7d', 'sha1_git': 'b3fa4e6abe22977e6267e9969a593e790bf2cd36', 'sha256': '5d14c8d70215f46a9722d29c7ebff8cc9bd24509650d7ee601fd461e52a52f7f'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 254, 'name': 'codecov.yml', 'perms': 33188, 'status': 'visible', 'target': 'b3fa4e6abe22977e6267e9969a593e790bf2cd36', 'type': 'file'}, {'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': None, 'name': 'examples', 'perms': 16384, 'target': '7e3ac01795317fbc36a031a9117e7963d6c7da90', 'type': 'dir'}, {'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': None, 'name': 'hot', 'perms': 16384, 'target': 'a5eea6ca952fba9f7ae4177627ed5e22754df9f5', 'type': 'dir'}, {'checksums': {'sha1': '92d9367db4ba049f698f5bf78b6946b8e2d91345', 'sha1_git': 'eaa9cc4a247b01d6a9c0adc91997fefe6a62be1f', 'sha256': 'd4b42fa0651cf3d99dea0ca5bd6ba64cc21e80be7d9ea05b2b4423ef8f16ec36'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 19, 'name': 'input.js', 'perms': 33188, 'status': 'visible', 'target': 'eaa9cc4a247b01d6a9c0adc91997fefe6a62be1f', 'type': 'file'}, {'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': None, 'name': 'lib', 'perms': 16384, 'target': '187d40104aa21475d8af88ccd77fc582cf6ac7a6', 'type': 'dir'}, {'checksums': {'sha1': 'f17ffa2dc14262292e2275efa3730a96fe060c44', 'sha1_git': 'd55b7110929cbba3d94da01494a272b39878ac0f', 'sha256': '012d4446ef8ab6656251b1b7f8e0217a5666ec04ad952e8a617b70946de17166'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 9132, 'name': 'open-bot.yaml', 'perms': 33188, 'status': 'visible', 'target': 'd55b7110929cbba3d94da01494a272b39878ac0f', 'type': 'file'}, {'checksums': {'sha1': '3a6638e72fcc2499f1a4c9b46d4d00d239bbe1c8', 'sha1_git': '6d1aa82c90ecd184d136151eb81d240e1fea723e', 'sha256': '00faf7dde1eb0742f3ca567af4dbcd8c01a38cf30d8faa7f0208f46dbc6b5201'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 4034, 'name': 'package.json', 'perms': 33188, 'status': 'visible', 'target': '6d1aa82c90ecd184d136151eb81d240e1fea723e', 'type': 'file'}, {'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': None, 'name': 'schemas', 'perms': 16384, 'target': 'f1f89c389f73c29e7a5d1a0ce5f9e0f166857815', 'type': 'dir'}, {'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': None, 'name': 'test', 'perms': 16384, 'target': '318c279189d186a1e06653fc5c78c539878c4d7d', 'type': 'dir'}, {'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': None, 'name': 'web_modules', 'perms': 16384, 'target': '93a5cc8e492d0b0323386814a72536381019ef7b', 'type': 'dir'}, {'checksums': {'sha1': '8047389fcc8e286ceed5536c677c2e803032cf84', 'sha1_git': 'eb8509f70158c231a3fd864aecf2649590bbedf3', 'sha256': '8cbe1ce94349ac3bc6cbcc952efd45d838c6b4524af8a773b18e1ebe8b4f936b'}, 'dir_id': 'ae59ceecf46367e8e4ad800e231fc76adc3afffb', 'length': 141192, 'name': 'yarn.lock', 'perms': 33188, 'status': 'visible', 'target': 'eb8509f70158c231a3fd864aecf2649590bbedf3', 'type': 'file'} ] stub_origin_sub_directory_path = 'lib/webworker' stub_origin_sub_directory_entries = [ {'checksums': {'sha1': '7bf366cd9f4a9835c73aafb70e44f640bab7ad16', 'sha1_git': '870252b7a175ee5ec2edfe2c22b2d56aa04bece4', 'sha256': 'e0af438932627dd9d53b36bfe69c3dbad6dc4d4569f6cdb29d606c9df2b128fa'}, 'dir_id': '02b626051e0935ecd28f50337f452db76803f980', 'length': 921, 'name': 'WebWorkerChunkTemplatePlugin.js', 'perms': 33188, 'status': 'visible', 'target': '870252b7a175ee5ec2edfe2c22b2d56aa04bece4', 'type': 'file'}, {'checksums': {'sha1': 'e2862b2787702bd3eb856f73627d5d8df5a8b550', 'sha1_git': 'b3e90d26a68ad9da0a7cc97a262db585fa4c73ba', 'sha256': '1c254e76248ff5ec7e2185cdb1cfd2e0338087244d2d617a868c346317b7646b'}, 'dir_id': '02b626051e0935ecd28f50337f452db76803f980', 'length': 1039, 'name': 'WebWorkerHotUpdateChunkTemplatePlugin.js', 'perms': 33188, 'status': 'visible', 'target': 'b3e90d26a68ad9da0a7cc97a262db585fa4c73ba', 'type': 'file'}, {'checksums': {'sha1': 'a1e04061d3e50bb8c024b07e9464da7392f37bf1', 'sha1_git': '1e503e028fdd5322c9f7d8ec50f54006cacf334e', 'sha256': '72dea06510d1a4435346f8dca20d8898a394c52c7382a97bd73d1840e31f90b3'}, 'dir_id': '02b626051e0935ecd28f50337f452db76803f980', 'length': 1888, 'name': 'WebWorkerMainTemplate.runtime.js', 'perms': 33188, 'status': 'visible', 'target': '1e503e028fdd5322c9f7d8ec50f54006cacf334e', 'type': 'file'}, {'checksums': {'sha1': 'b95c16e90784cf7025352839133b482149526da0', 'sha1_git': '46c9fe382d606ce19e556deeae6a23af47a8027d', 'sha256': 'c78c7ca9ee0aa341f843a431ef27c75c386607be3037d44ff530bfe3218edb3c'}, 'dir_id': '02b626051e0935ecd28f50337f452db76803f980', 'length': 4051, 'name': 'WebWorkerMainTemplatePlugin.js', 'perms': 33188, 'status': 'visible', 'target': '46c9fe382d606ce19e556deeae6a23af47a8027d', 'type': 'file'}, {'checksums': {'sha1': 'ec9df36b1e8dd689d84dbeeeb9f45fe9f9d96605', 'sha1_git': 'd850018bb0d2ad41dd0ae9e5c887dff8a23601e9', 'sha256': 'f995f6a13511955244850c2344c6cef09c10ab24c49f8448544e2b34aa69d03c'}, 'dir_id': '02b626051e0935ecd28f50337f452db76803f980', 'length': 763, 'name': 'WebWorkerTemplatePlugin.js', 'perms': 33188, 'status': 'visible', 'target': 'd850018bb0d2ad41dd0ae9e5c887dff8a23601e9', 'type': 'file'} ] stub_content_origin_info = { 'id': 10357753, 'type': 'git', 'url': 'https://github.com/KDE/kate' } stub_content_origin_visit_id = 10 stub_content_origin_visit_unix_ts = 1494032350 stub_content_origin_visit_iso_date = '2017-05-06T00:59:10+00:00' stub_content_origin_branch = 'HEAD' stub_content_origin_visits = [ {'date': '2015-09-26T09:30:52.373449+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 1}, {'date': '2016-03-10T05:36:11.118989+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 2}, {'date': '2016-03-24T07:39:29.727793+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 3}, {'date': '2016-03-31T22:55:31.402863+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 4}, {'date': '2016-05-26T06:25:54.879676+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 5}, {'date': '2016-06-07T17:16:33.964164+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 6}, {'date': '2016-07-27T01:38:20.345358+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 7}, {'date': '2016-08-13T04:46:45.987508+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 8}, {'date': '2016-08-16T23:24:13.214496+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 9}, {'date': '2016-08-17T18:10:39.841005+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 10}, {'date': '2016-08-30T17:28:02.476486+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 11}, {'date': '2016-09-08T09:32:37.152054+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 12}, {'date': '2016-09-15T09:47:37.758093+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 13}, {'date': '2016-12-04T06:14:02.688518+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 14}, {'date': '2017-02-16T08:45:57.719974+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'partial', 'visit': 15}, {'date': '2017-05-06T00:59:10.495727+00:00', 'metadata': {}, 'origin': 10357753, 'status': 'full', 'visit': 16} ] stub_content_origin_occurrences = ( [ {'directory': '08e8329257dad3a3ef7adea48aa6e576cd82de5b', 'name': 'HEAD', - 'revision': '11f15b0789344427ddf17b8d75f38577c4395ce0'}, + 'revision': '11f15b0789344427ddf17b8d75f38577c4395ce0', + 'date': '02 May 2017, 05:33 UTC', + 'message': 'GIT_SILENT made messages (after extraction)'}, {'directory': '2371baf0411e3adf12d65daf86c3b135633dd5e4', 'name': 'refs/heads/Applications/14.12', - 'revision': '5b27ad32f8c8da9b6fc898186d59079488fb74c9'}, + 'revision': '5b27ad32f8c8da9b6fc898186d59079488fb74c9', + 'date': '23 February 2015, 12:10 UTC', + 'message': 'SVN_SILENT made messages (.desktop file)'}, {'directory': '5d024d33a218eeb164936301a2f89231d1f0854a', 'name': 'refs/heads/Applications/15.04', - 'revision': '4f1e29120795ac643044991e91f24d02c9980202'}, + 'revision': '4f1e29120795ac643044991e91f24d02c9980202', + 'date': '04 July 2015, 12:34 UTC', + 'message': 'SVN_SILENT made messages (.desktop file)'}, {'directory': 'f33984df50ec29dbbc86295adb81ebb831e3b86d', 'name': 'refs/heads/Applications/15.08', - 'revision': '52722e588f46a32b480b5f304ba21480fc8234b1'}, + 'revision': '52722e588f46a32b480b5f304ba21480fc8234b1', + 'date': '12 June 2016, 20:28 UTC', + 'message': 'Correctly restore view config of all split views'}, {'directory': 'e706b836cf32929a48b6f92c07766f237f9d068f', 'name': 'refs/heads/Applications/15.12', - 'revision': '38c4e42c4a653453fc668c704bb8995ae31b5baf'}, + 'revision': '38c4e42c4a653453fc668c704bb8995ae31b5baf', + 'date': '06 September 2016, 12:01 UTC', + 'message': 'Fix crash in tab switcher plugin when using split views'}, {'directory': 'ebf8ae783b44df5c827bfa46227e5dbe98f25eb4', 'name': 'refs/heads/Applications/16.04', - 'revision': 'd0fce3b880ab37a551d75ec940137e0f46bf2143'}, - {'directory': '68ea0543fa80cc512d969fc2294d391a904e04fa', - 'name': 'refs/heads/Applications/16.08', - 'revision': '0b05000bfdde06aec2dc6528411ec24c9e20e672'}, - {'directory': 'b9481c652d57b2e0e36c63f2bf795bc6ffa0b6a1', - 'name': 'refs/heads/Applications/16.12', - 'revision': '2a52ca09fce28e29f5afd0ba4622635679036837'}, - {'directory': '415ea4716870c59feabde3210da6f60bcf897479', - 'name': 'refs/heads/Applications/17.04', - 'revision': 'c7ba6cef1ebfdb743e4f3f53f51f44917981524a'}, - {'directory': 'a9d27a5cd354f2f1e50304ef72818141231f7876', - 'name': 'refs/heads/KDE/4.10', - 'revision': 'e0bc3d8ab537d06c817c459f0be7c7f21d670b6e'}, - {'directory': 'a273331f42e6998099ac98934f33431eb244b222', - 'name': 'refs/heads/KDE/4.11', - 'revision': 'e9db108b584aabe88eff1969f408146b0b9eac32'}, - {'directory': '00be5902593157c55a9888b9e5c17c3b416d1f89', - 'name': 'refs/heads/KDE/4.12', - 'revision': 'c2a1c24f28613342985aa40573fb922370900a3a'}, - {'directory': 'f25aa509cc4ad99478a71407850575d267ae4106', - 'name': 'refs/heads/KDE/4.13', - 'revision': 'b739b7a67882408b4378d901c38b2c88108f1312'}, - {'directory': 'e39f1a6967c33635c9e0c3ee627fbd987612417b', - 'name': 'refs/heads/KDE/4.14', - 'revision': 'dd6530d110b165dfeed8dc1b20b8cfab0e4bd25b'}, - {'directory': '5ac8842a402fe3136be5e2ddd31cb24232152994', - 'name': 'refs/heads/KDE/4.7', - 'revision': '776b581f5f724b1179f2fe013c2da835bb0d5cfc'}, - {'directory': '1e6d88a64ecfa70a6883efd977bfd6248344b108', - 'name': 'refs/heads/KDE/4.8', - 'revision': 'fe3723f6ab789ecf21864e198c91092d10a5289b'}, - {'directory': 'aa03927b4d5738c67646509b4b5d55faef03f024', - 'name': 'refs/heads/KDE/4.9', - 'revision': '69121e434e25f8f4c8ee92a1771a8e87913b3559'}, - {'directory': '57844f10b9ade482ece88ae07a406570e5c0b35d', - 'name': 'refs/heads/goinnn-kate-plugins', - 'revision': 'f51e7810338fe5648319a88712d0ce560cc5f847'}, - {'directory': 'eed636cada058599df292eb59180896cd8aeceac', - 'name': 'refs/heads/kfunk/fix-katecompletionmodel', - 'revision': 'dbf7cae67c5db0737fcf37235000b867cd839f3e'}, - {'directory': '08e8329257dad3a3ef7adea48aa6e576cd82de5b', - 'name': 'refs/heads/master', - 'revision': '11f15b0789344427ddf17b8d75f38577c4395ce0'}, - {'directory': '7b5bdcb46cfaa25229af6b038190b004a26397ff', - 'name': 'refs/heads/plasma/sreich/declarative-kate-applet', - 'revision': '51ab3ea145abd3219c3fae06ff99fa911a6a8993'}, - {'directory': 'e39f1a6967c33635c9e0c3ee627fbd987612417b', - 'name': 'refs/pull/1/head', - 'revision': 'dd6530d110b165dfeed8dc1b20b8cfab0e4bd25b'} + 'revision': 'd0fce3b880ab37a551d75ec940137e0f46bf2143', + 'date': '06 September 2016, 12:01 UTC', + 'message': 'Fix crash in tab switcher plugin when using split views'} ], [{'name': 'v4.9.90', - 'release': 'f6a3a31474a86023377ce6fa1cbec3d9ab809d06', - 'revision': '4dd3d7de2f684fcdf27028bafdc022183e33610d', + 'message': 'KDE 4.9.90', + 'date': '09 December 2012, 23:15 UTC', + 'id': 'f6a3a31474a86023377ce6fa1cbec3d9ab809d06', + 'target_type': 'revision', + 'target': '4dd3d7de2f684fcdf27028bafdc022183e33610d', 'directory': 'a5b9c74c35732189b8aa7567f979f9ac36fdb8bc'}, {'name': 'v4.9.95', - 'release': '74bab04b34b243269354f6e5530d6d0edf92f84d', - 'revision': '6bd42579908cf62f094ebca0e100832208967428', + 'message': 'KDE 4.9.95', + 'date': '02 January 2013, 19:00 UTC', + 'id': '74bab04b34b243269354f6e5530d6d0edf92f84d', + 'target_type': 'revision', + 'target': '6bd42579908cf62f094ebca0e100832208967428', 'directory': 'aaeba0a71293465b9026249381c0a1f13a13a43f'}, {'name': 'v4.9.97', - 'release': 'd8bf93d6915c4ab17de882c443423f281c961a1c', - 'revision': '5fbd023fc46ecc57a6772be2aa04f532e8426f43', + 'message': 'KDE 4.9.97', + 'date': '05 January 2013, 20:34 UTC', + 'id': 'd8bf93d6915c4ab17de882c443423f281c961a1c', + 'target_type': 'revision', + 'target': '5fbd023fc46ecc57a6772be2aa04f532e8426f43', 'directory': '0ce36caec34ad7c930f35eca907148208b2a3f2b'}, {'name': 'v4.9.98', - 'release': '9bf0265d4fce650926bfd93b117584eb3fd0bd73', - 'revision': '670aff3a940fecf6a085fe71a5bead2edcad8a55', + 'message': 'KDE 4.9.98', + 'date': '21 January 2013, 19:36 UTC', + 'id': '9bf0265d4fce650926bfd93b117584eb3fd0bd73', + 'target_type': 'revision', + 'target': '670aff3a940fecf6a085fe71a5bead2edcad8a55', 'directory': '0747fbcc783dfab9e857040287ed400df145079d'} ]) diff --git a/swh/web/tests/browse/views/data/release_test_data.py b/swh/web/tests/browse/views/data/release_test_data.py new file mode 100644 index 00000000..fd3002e6 --- /dev/null +++ b/swh/web/tests/browse/views/data/release_test_data.py @@ -0,0 +1,19 @@ +# Copyright (C) 2018 The Software Heritage developers +# See the AUTHORS file at the top-level directory of this distribution +# License: GNU General Public License version 3, or any later version +# See top-level LICENSE file for more information + +# flake8: noqa + +stub_release = \ + {'target': '69c0db5050f623e8895b72dfe970392b1f9a0e2e', + 'author': {'name': 'Ned Deily', + 'fullname': 'Ned Deily ', + 'email': 'nad@python.org', + 'id': 8318464}, + 'id': '208f61cc7a5dbc9879ae6e5c2f95891e270f09ef', + 'name': 'v3.6.1', + 'date': '2017-03-21T02:46:28-04:00', + 'message': 'Tag v3.6.1\n-----BEGIN PGP SIGNATURE-----\n\niQIcBAABCgAGBQJY0MxgAAoJEC00fqaqZUIdkZ0QAJw9PR++cbpS3Pt8QrmgS+xG\nPxrZ1yPPNPNSfbmRLWOlHJ0nBzFPVXUWdrqnevmZVRghyrc78sjuBL8QczYsum22\n1B6X/63vX3dI9yj8FR5nldEYPBMOOD6ryObWoKMeqyQT3LhAqxIU/9oqAsbx+ZYw\nrXmRTuypenmZabq3yIv2hORMFgcS7JZFuVb181b0Cihji/7l+WRI9hkGO8POBeFq\ntfJ16beH8hbbDw/+MLpwJifsALWsQOqnWt2/C8tJeHtMX+FLuJflwcIwotv73E22\nulmpXNwTNxnK5l5/C9JC6kr5nN9VJatVpSpe6dftAmTy16O5OrADtePZYxOZ7S3X\n6ipOaiKl3s/2oykkmasxPeaVXllbWgd2UGqIBlAUxM6rVD/4DyVDUHqbDotQD8Kz\nZ8nSFxou1ZdRTSlC26ToGCNc+B6bqv9GTC1hph/ijJkhvXfIC9X1fc/uO1wrV+wB\ni2dxXKh1mQCXuogNAx6rv7gPaXbPgDHob7Tlvo5Ddhr7rQoAaMjceGfUMOTORSqO\nR4ssE6yyNASQtMjW+Y5WeVEgtX7ttGKBsgD0PsrZTCjnZfJkFtZGUyfkdwNzLK8v\nRBqi1r+tEuR5tpin4h+erdlVjeMhVMQZOhBYmxY2Ge70PMVrOz4KaFY1GD+aaxt7\n+PfOKUxMYGKvogv7gD/3\n=Peec\n-----END PGP SIGNATURE-----\n', + 'target_type': 'revision', + 'synthetic': False} diff --git a/swh/web/tests/browse/views/test_origin.py b/swh/web/tests/browse/views/test_origin.py index 0011bf55..fc68019a 100644 --- a/swh/web/tests/browse/views/test_origin.py +++ b/swh/web/tests/browse/views/test_origin.py @@ -1,575 +1,718 @@ # Copyright (C) 2017-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information # flake8: noqa from unittest.mock import patch from nose.tools import istest, nottest from django.test import TestCase from django.utils.html import escape from swh.web.common.exc import NotFoundExc from swh.web.common.utils import ( reverse, gen_path_info, format_utc_iso_date, parse_timestamp ) from swh.web.tests.testbase import SWHWebTestBase from .data.origin_test_data import ( origin_info_test_data, origin_visits_test_data, stub_content_origin_info, stub_content_origin_visit_id, stub_content_origin_visit_unix_ts, stub_content_origin_visit_iso_date, stub_content_origin_branch, stub_content_origin_visits, stub_content_origin_occurrences, stub_origin_info, stub_visit_id, stub_origin_visits, stub_origin_occurrences, stub_origin_root_directory_entries, stub_origin_master_branch, stub_origin_root_directory_sha1, stub_origin_sub_directory_path, stub_origin_sub_directory_entries, stub_visit_unix_ts, stub_visit_iso_date ) from .data.content_test_data import ( stub_content_root_dir, stub_content_text_data, stub_content_text_path ) class SwhBrowseOriginTest(SWHWebTestBase, TestCase): @patch('swh.web.browse.views.origin.get_origin_visits') @patch('swh.web.browse.views.origin.service') @istest def origin_browse(self, mock_service, mock_get_origin_visits): mock_service.lookup_origin.return_value = origin_info_test_data mock_get_origin_visits.return_value = origin_visits_test_data url = reverse('browse-origin', kwargs={'origin_type': origin_info_test_data['type'], 'origin_url': origin_info_test_data['url']}) resp = self.client.get(url) self.assertEquals(resp.status_code, 200) self.assertTemplateUsed('origin.html') self.assertContains(resp, '
%s
' % origin_info_test_data['type']) self.assertContains(resp, '
%s
' % (origin_info_test_data['url'], origin_info_test_data['url'])) self.assertContains(resp, '', count=len(origin_visits_test_data)) for visit in origin_visits_test_data: visit_date_iso = format_utc_iso_date(visit['date'], '%Y-%m-%dT%H:%M:%S') visit_date = format_utc_iso_date(visit['date']) browse_url = reverse('browse-origin-directory', kwargs={'origin_type': origin_info_test_data['type'], 'origin_url': origin_info_test_data['url'], 'timestamp': visit_date_iso}) self.assertContains(resp, 'href="%s">%s' % (browse_url, visit_date)) @nottest def origin_content_view_test(self, origin_info, origin_visits, origin_branches, origin_releases, origin_branch, root_dir_sha1, content_sha1, content_path, content_data, content_language, visit_id=None, timestamp=None): url_args = {'origin_type': origin_info['type'], 'origin_url': origin_info['url'], 'path': content_path} if not visit_id: visit_id = origin_visits[-1]['visit'] query_params = {} if timestamp: url_args['timestamp'] = timestamp - else: + + if visit_id: query_params['visit_id'] = visit_id url = reverse('browse-origin-content', kwargs=url_args, query_params=query_params) resp = self.client.get(url) self.assertEquals(resp.status_code, 200) self.assertTemplateUsed('content.html') self.assertContains(resp, '' % content_language) self.assertContains(resp, escape(content_data)) split_path = content_path.split('/') filename = split_path[-1] path = content_path.replace(filename, '')[:-1] path_info = gen_path_info(path) del url_args['path'] - query_params['branch'] = origin_branch if timestamp: url_args['timestamp'] = \ format_utc_iso_date(parse_timestamp(timestamp).isoformat(), '%Y-%m-%dT%H:%M:%S') root_dir_url = reverse('browse-origin-directory', kwargs=url_args, query_params=query_params) self.assertContains(resp, '
  • ', count=len(path_info)+1) self.assertContains(resp, '%s' % (root_dir_url, root_dir_sha1[:7])) for p in path_info: url_args['path'] = p['path'] dir_url = reverse('browse-origin-directory', kwargs=url_args, query_params=query_params) self.assertContains(resp, '%s' % (dir_url, p['name'])) self.assertContains(resp, '
  • %s
    • ' % filename) query_string = 'sha1_git:' + content_sha1 url_raw = reverse('browse-content-raw', kwargs={'query_string': query_string}, query_params={'filename': filename}) self.assertContains(resp, url_raw) + del url_args['path'] + + origin_branches_url = \ + reverse('browse-origin-branches', + kwargs=url_args, + query_params=query_params) + + self.assertContains(resp, 'Branches (%s)' % + (origin_branches_url, len(origin_branches))) + + origin_releases_url = \ + reverse('browse-origin-releases', + kwargs=url_args, + query_params=query_params) + + self.assertContains(resp, 'Releases (%s)' % + (origin_releases_url, len(origin_releases))) + self.assertContains(resp, '
  • ', count=len(origin_branches)) url_args['path'] = content_path for branch in origin_branches: query_params['branch'] = branch['name'] root_dir_branch_url = \ reverse('browse-origin-content', kwargs=url_args, query_params=query_params) self.assertContains(resp, '' % root_dir_branch_url) self.assertContains(resp, '
  • ', count=len(origin_releases)) query_params['branch'] = None for release in origin_releases: query_params['release'] = release['name'] root_dir_release_url = \ reverse('browse-origin-content', kwargs=url_args, query_params=query_params) self.assertContains(resp, '' % root_dir_release_url) @patch('swh.web.browse.utils.get_origin_visits') - @patch('swh.web.browse.views.origin.get_origin_visit_occurrences') + @patch('swh.web.browse.utils.get_origin_visit_occurrences') @patch('swh.web.browse.views.origin.service') + @patch('swh.web.browse.utils.service') @patch('swh.web.browse.views.origin.request_content') @istest - def origin_content_view(self, mock_request_content, mock_service, - mock_get_origin_visit_occurrences, - mock_get_origin_visits): + def origin_content_view(self, mock_request_content, mock_utils_service, + mock_service, mock_get_origin_visit_occurrences, + mock_get_origin_visits): stub_content_text_sha1 = stub_content_text_data['checksums']['sha1'] mock_get_origin_visits.return_value = stub_content_origin_visits mock_get_origin_visit_occurrences.return_value = stub_content_origin_occurrences mock_service.lookup_directory_with_path.return_value = \ {'target': stub_content_text_sha1} mock_request_content.return_value = stub_content_text_data - mock_service.lookup_origin.return_value = stub_content_origin_info + mock_utils_service.lookup_origin.return_value = stub_content_origin_info self.origin_content_view_test(stub_content_origin_info, stub_content_origin_visits, stub_content_origin_occurrences[0], stub_content_origin_occurrences[1], stub_content_origin_branch, stub_content_root_dir, stub_content_text_sha1, stub_content_text_path, stub_content_text_data['raw_data'], 'cpp') self.origin_content_view_test(stub_content_origin_info, stub_content_origin_visits, stub_content_origin_occurrences[0], stub_content_origin_occurrences[1], stub_content_origin_branch, stub_content_root_dir, stub_content_text_sha1, stub_content_text_path, stub_content_text_data['raw_data'], 'cpp', visit_id=stub_content_origin_visit_id) self.origin_content_view_test(stub_content_origin_info, stub_content_origin_visits, stub_content_origin_occurrences[0], stub_content_origin_occurrences[1], stub_content_origin_branch, stub_content_root_dir, stub_content_text_sha1, stub_content_text_path, stub_content_text_data['raw_data'], 'cpp', timestamp=stub_content_origin_visit_unix_ts) self.origin_content_view_test(stub_content_origin_info, stub_content_origin_visits, stub_content_origin_occurrences[0], stub_content_origin_occurrences[1], stub_content_origin_branch, stub_content_root_dir, stub_content_text_sha1, stub_content_text_path, stub_content_text_data['raw_data'], 'cpp', timestamp=stub_content_origin_visit_iso_date) @nottest def origin_directory_view(self, origin_info, origin_visits, origin_branches, origin_releases, origin_branch, root_directory_sha1, directory_entries, visit_id=None, timestamp=None, path=None): dirs = [e for e in directory_entries if e['type'] == 'dir'] files = [e for e in directory_entries if e['type'] == 'file'] if not visit_id: visit_id = origin_visits[-1]['visit'] url_args = {'origin_type': origin_info['type'], 'origin_url': origin_info['url']} query_params = {} if timestamp: url_args['timestamp'] = timestamp else: query_params['visit_id'] = visit_id if path: url_args['path'] = path url = reverse('browse-origin-directory', kwargs=url_args, query_params=query_params) resp = self.client.get(url) self.assertEquals(resp.status_code, 200) self.assertTemplateUsed('directory.html') self.assertContains(resp, '', count=len(dirs)) self.assertContains(resp, '', count=len(files)) - query_params['branch'] = origin_branch if timestamp: url_args['timestamp'] = \ format_utc_iso_date(parse_timestamp(timestamp).isoformat(), '%Y-%m-%dT%H:%M:%S') for d in dirs: dir_path = d['name'] if path: dir_path = "%s/%s" % (path, d['name']) dir_url_args = dict(url_args) dir_url_args['path'] = dir_path dir_url = reverse('browse-origin-directory', kwargs=dir_url_args, query_params=query_params) self.assertContains(resp, dir_url) for f in files: file_path = f['name'] if path: file_path = "%s/%s" % (path, f['name']) file_url_args = dict(url_args) file_url_args['path'] = file_path file_url = reverse('browse-origin-content', kwargs=file_url_args, query_params=query_params) self.assertContains(resp, file_url) if 'path' in url_args: del url_args['path'] root_dir_branch_url = \ reverse('browse-origin-directory', kwargs=url_args, query_params=query_params) nb_bc_paths = 1 if path: nb_bc_paths = len(path.split('/')) + 1 self.assertContains(resp, '
  • ', count=nb_bc_paths) self.assertContains(resp, '%s' % (root_dir_branch_url, root_directory_sha1[:7])) + origin_branches_url = \ + reverse('browse-origin-branches', + kwargs=url_args, + query_params=query_params) + + self.assertContains(resp, 'Branches (%s)' % + (origin_branches_url, len(origin_branches))) + + origin_releases_url = \ + reverse('browse-origin-releases', + kwargs=url_args, + query_params=query_params) + + self.assertContains(resp, 'Releases (%s)' % + (origin_releases_url, len(origin_releases))) + if path: url_args['path'] = path self.assertContains(resp, '
  • ', count=len(origin_branches)) for branch in origin_branches: query_params['branch'] = branch['name'] root_dir_branch_url = \ reverse('browse-origin-directory', kwargs=url_args, query_params=query_params) self.assertContains(resp, '' % root_dir_branch_url) self.assertContains(resp, '
  • ', count=len(origin_releases)) query_params['branch'] = None for release in origin_releases: query_params['release'] = release['name'] root_dir_release_url = \ reverse('browse-origin-directory', kwargs=url_args, query_params=query_params) self.assertContains(resp, '' % root_dir_release_url) @patch('swh.web.browse.utils.get_origin_visits') - @patch('swh.web.browse.views.origin.get_origin_visit_occurrences') + @patch('swh.web.browse.utils.get_origin_visit_occurrences') @patch('swh.web.browse.utils.service') @patch('swh.web.browse.views.origin.service') @istest def origin_root_directory_view(self, mock_origin_service, mock_utils_service, mock_get_origin_visit_occurrences, mock_get_origin_visits): mock_get_origin_visits.return_value = stub_origin_visits mock_get_origin_visit_occurrences.return_value = stub_origin_occurrences mock_utils_service.lookup_directory.return_value = \ stub_origin_root_directory_entries - mock_origin_service.lookup_origin.return_value = stub_origin_info + mock_utils_service.lookup_origin.return_value = stub_origin_info self.origin_directory_view(stub_origin_info, stub_origin_visits, stub_origin_occurrences[0], stub_origin_occurrences[1], stub_origin_master_branch, stub_origin_root_directory_sha1, stub_origin_root_directory_entries) self.origin_directory_view(stub_origin_info, stub_origin_visits, stub_origin_occurrences[0], stub_origin_occurrences[1], stub_origin_master_branch, stub_origin_root_directory_sha1, stub_origin_root_directory_entries, visit_id=stub_visit_id) self.origin_directory_view(stub_origin_info, stub_origin_visits, stub_origin_occurrences[0], stub_origin_occurrences[1], stub_origin_master_branch, stub_origin_root_directory_sha1, stub_origin_root_directory_entries, timestamp=stub_visit_unix_ts) self.origin_directory_view(stub_origin_info, stub_origin_visits, stub_origin_occurrences[0], stub_origin_occurrences[1], stub_origin_master_branch, stub_origin_root_directory_sha1, stub_origin_root_directory_entries, timestamp=stub_visit_iso_date) @patch('swh.web.browse.utils.get_origin_visits') - @patch('swh.web.browse.views.origin.get_origin_visit_occurrences') + @patch('swh.web.browse.utils.get_origin_visit_occurrences') @patch('swh.web.browse.utils.service') @patch('swh.web.browse.views.origin.service') @istest def origin_sub_directory_view(self, mock_origin_service, mock_utils_service, mock_get_origin_visit_occurrences, mock_get_origin_visits): mock_get_origin_visits.return_value = stub_origin_visits mock_get_origin_visit_occurrences.return_value = stub_origin_occurrences mock_utils_service.lookup_directory.return_value = \ stub_origin_sub_directory_entries mock_origin_service.lookup_directory_with_path.return_value = \ {'target': '120c39eeb566c66a77ce0e904d29dfde42228adb'} - mock_origin_service.lookup_origin.return_value = stub_origin_info + mock_utils_service.lookup_origin.return_value = stub_origin_info self.origin_directory_view(stub_origin_info, stub_origin_visits, stub_origin_occurrences[0], stub_origin_occurrences[1], stub_origin_master_branch, stub_origin_root_directory_sha1, stub_origin_sub_directory_entries, path=stub_origin_sub_directory_path) self.origin_directory_view(stub_origin_info, stub_origin_visits, stub_origin_occurrences[0], stub_origin_occurrences[1], stub_origin_master_branch, stub_origin_root_directory_sha1, stub_origin_sub_directory_entries, visit_id=stub_visit_id, path=stub_origin_sub_directory_path) self.origin_directory_view(stub_origin_info, stub_origin_visits, stub_origin_occurrences[0], stub_origin_occurrences[1], stub_origin_master_branch, stub_origin_root_directory_sha1, stub_origin_sub_directory_entries, timestamp=stub_visit_unix_ts, path=stub_origin_sub_directory_path) self.origin_directory_view(stub_origin_info, stub_origin_visits, stub_origin_occurrences[0], stub_origin_occurrences[1], stub_origin_master_branch, stub_origin_root_directory_sha1, stub_origin_sub_directory_entries, timestamp=stub_visit_iso_date, path=stub_origin_sub_directory_path) @patch('swh.web.browse.views.origin.request_content') @patch('swh.web.browse.utils.get_origin_visits') - @patch('swh.web.browse.views.origin.get_origin_visit_occurrences') + @patch('swh.web.browse.utils.get_origin_visit_occurrences') @patch('swh.web.browse.utils.service') @patch('swh.web.browse.views.origin.service') @istest def origin_request_errors(self, mock_origin_service, mock_utils_service, mock_get_origin_visit_occurrences, mock_get_origin_visits, mock_request_content): mock_origin_service.lookup_origin.side_effect = \ NotFoundExc('origin not found') url = reverse('browse-origin', kwargs={'origin_type': 'foo', 'origin_url': 'bar'}) resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertContains(resp, "origin not found", status_code=404) - mock_origin_service.lookup_origin.side_effect = None - mock_origin_service.lookup_origin.return_value = origin_info_test_data + mock_utils_service.lookup_origin.side_effect = None + mock_utils_service.lookup_origin.return_value = origin_info_test_data mock_get_origin_visits.return_value = [] url = reverse('browse-origin-directory', kwargs={'origin_type': 'foo', 'origin_url': 'bar'}) resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertContains(resp, "No SWH visit", status_code=404) mock_get_origin_visits.return_value = stub_origin_visits mock_get_origin_visit_occurrences.side_effect = \ NotFoundExc('visit not found') url = reverse('browse-origin-directory', kwargs={'origin_type': 'foo', 'origin_url': 'bar'}, query_params={'visit_id': len(stub_origin_visits)+1}) resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertRegex(resp.content.decode('utf-8'), 'Visit.*not found') mock_get_origin_visits.return_value = stub_origin_visits mock_get_origin_visit_occurrences.side_effect = None mock_get_origin_visit_occurrences.return_value = ([], []) url = reverse('browse-origin-directory', kwargs={'origin_type': 'foo', 'origin_url': 'bar'}) resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertRegex(resp.content.decode('utf-8'), 'Origin.*has an empty list of branches') mock_get_origin_visit_occurrences.return_value = stub_origin_occurrences mock_utils_service.lookup_directory.side_effect = \ NotFoundExc('Directory not found') url = reverse('browse-origin-directory', kwargs={'origin_type': 'foo', 'origin_url': 'bar'}) resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertContains(resp, 'Directory not found', status_code=404) mock_origin_service.lookup_origin.side_effect = None mock_origin_service.lookup_origin.return_value = origin_info_test_data mock_get_origin_visits.return_value = [] url = reverse('browse-origin-content', kwargs={'origin_type': 'foo', 'origin_url': 'bar', 'path': 'foo'}) resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertContains(resp, "No SWH visit", status_code=404) mock_get_origin_visits.return_value = stub_origin_visits mock_get_origin_visit_occurrences.side_effect = \ NotFoundExc('visit not found') url = reverse('browse-origin-content', kwargs={'origin_type': 'foo', 'origin_url': 'bar', 'path': 'foo'}, query_params={'visit_id': len(stub_origin_visits)+1}) resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertRegex(resp.content.decode('utf-8'), 'Visit.*not found') mock_get_origin_visits.return_value = stub_origin_visits mock_get_origin_visit_occurrences.side_effect = None mock_get_origin_visit_occurrences.return_value = ([], []) url = reverse('browse-origin-content', kwargs={'origin_type': 'foo', 'origin_url': 'bar', 'path': 'baz'}) resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertRegex(resp.content.decode('utf-8'), 'Origin.*has an empty list of branches') mock_get_origin_visit_occurrences.return_value = stub_origin_occurrences mock_origin_service.lookup_directory_with_path.return_value = \ {'target': stub_content_text_data['checksums']['sha1']} mock_request_content.side_effect = \ NotFoundExc('Content not found') url = reverse('browse-origin-content', kwargs={'origin_type': 'foo', 'origin_url': 'bar', 'path': 'baz'}) resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertContains(resp, 'Content not found', status_code=404) + + + @patch('swh.web.browse.utils.get_origin_visits') + @patch('swh.web.browse.utils.get_origin_visit_occurrences') + @patch('swh.web.browse.utils.service') + @patch('swh.web.browse.views.origin.service') + @istest + def origin_branches(self, mock_origin_service, + mock_utils_service, + mock_get_origin_visit_occurrences, + mock_get_origin_visits): + mock_get_origin_visits.return_value = stub_origin_visits + mock_get_origin_visit_occurrences.return_value = stub_origin_occurrences + mock_utils_service.lookup_origin.return_value = stub_origin_info + + url_args = {'origin_type': stub_origin_info['type'], + 'origin_url': stub_origin_info['url']} + + url = reverse('browse-origin-branches', + kwargs=url_args) + + resp = self.client.get(url) + self.assertEquals(resp.status_code, 200) + self.assertTemplateUsed('branches.html') + + origin_branches = stub_origin_occurrences[0] + origin_releases = stub_origin_occurrences[1] + + origin_branches_url = \ + reverse('browse-origin-branches', + kwargs=url_args) + + self.assertContains(resp, 'Branches (%s)' % + (origin_branches_url, len(origin_branches))) + + origin_releases_url = \ + reverse('browse-origin-releases', + kwargs=url_args) + + self.assertContains(resp, 'Releases (%s)' % + (origin_releases_url, len(origin_releases))) + + self.assertContains(resp, '', + count=len(origin_branches)) + + for branch in origin_branches: + browse_branch_url = reverse('browse-origin-directory', + kwargs={'origin_type': stub_origin_info['type'], + 'origin_url': stub_origin_info['url']}, + query_params={'branch': branch['name']}) + self.assertContains(resp, '%s' % (escape(browse_branch_url), branch['name'])) + + browse_revision_url = reverse('browse-revision', + kwargs={'sha1_git': branch['revision']}, + query_params={'origin_type': stub_origin_info['type'], + 'origin_url': stub_origin_info['url']}) + self.assertContains(resp, '%s' % (escape(browse_revision_url), branch['revision'][:7])) + + + @patch('swh.web.browse.utils.get_origin_visits') + @patch('swh.web.browse.utils.get_origin_visit_occurrences') + @patch('swh.web.browse.utils.service') + @patch('swh.web.browse.views.origin.service') + @istest + def origin_releases(self, mock_origin_service, + mock_utils_service, + mock_get_origin_visit_occurrences, + mock_get_origin_visits): + mock_get_origin_visits.return_value = stub_origin_visits + mock_get_origin_visit_occurrences.return_value = stub_origin_occurrences + mock_utils_service.lookup_origin.return_value = stub_origin_info + + url_args = {'origin_type': stub_origin_info['type'], + 'origin_url': stub_origin_info['url']} + + url = reverse('browse-origin-releases', + kwargs=url_args) + + resp = self.client.get(url) + self.assertEquals(resp.status_code, 200) + self.assertTemplateUsed('releases.html') + + origin_branches = stub_origin_occurrences[0] + origin_releases = stub_origin_occurrences[1] + + origin_branches_url = \ + reverse('browse-origin-branches', + kwargs=url_args) + + self.assertContains(resp, 'Branches (%s)' % + (origin_branches_url, len(origin_branches))) + + origin_releases_url = \ + reverse('browse-origin-releases', + kwargs=url_args) + + self.assertContains(resp, 'Releases (%s)' % + (origin_releases_url, len(origin_releases))) + + self.assertContains(resp, '', + count=len(origin_releases)) + + for release in origin_releases: + browse_release_url = reverse('browse-release', + kwargs={'sha1_git': release['id']}, + query_params={'origin_type': stub_origin_info['type'], + 'origin_url': stub_origin_info['url']}) + self.assertContains(resp, '%s' % (escape(browse_release_url), release['name'])) + diff --git a/swh/web/tests/browse/views/test_release.py b/swh/web/tests/browse/views/test_release.py new file mode 100644 index 00000000..1cadd381 --- /dev/null +++ b/swh/web/tests/browse/views/test_release.py @@ -0,0 +1,101 @@ +# Copyright (C) 2018 The Software Heritage developers +# See the AUTHORS file at the top-level directory of this distribution +# License: GNU General Public License version 3, or any later version +# See top-level LICENSE file for more information + +# flake8: noqa + +from unittest.mock import patch +from nose.tools import istest +from django.test import TestCase + +from swh.web.common.exc import NotFoundExc +from swh.web.common.utils import reverse, format_utc_iso_date +from swh.web.tests.testbase import SWHWebTestBase + +from .data.release_test_data import ( + stub_release +) + +from .data.origin_test_data import stub_origin_visits + + +class SwhBrowseReleaseTest(SWHWebTestBase, TestCase): + + @patch('swh.web.browse.views.release.service') + @patch('swh.web.browse.utils.service') + @istest + def release_browse(self, mock_service_utils, mock_service): + mock_service.lookup_release.return_value = stub_release + + url = reverse('browse-release', + kwargs={'sha1_git': stub_release['id']}) + + release_id = stub_release['id'] + release_name = stub_release['name'] + author_id = stub_release['author']['id'] + author_name = stub_release['author']['name'] + author_url = reverse('browse-person', + kwargs={'person_id': author_id}) + + release_date = stub_release['date'] + message = stub_release['message'] + target_type = stub_release['target_type'] + target = stub_release['target'] + target_url = reverse('browse-revision', kwargs={'sha1_git': target}) + + resp = self.client.get(url) + + self.assertEquals(resp.status_code, 200) + self.assertTemplateUsed('release.html') + self.assertContains(resp, '%s' % + (author_url, author_name)) + self.assertContains(resp, format_utc_iso_date(release_date)) + self.assertContains(resp, message) + self.assertContains(resp, release_id) + self.assertContains(resp, release_name) + self.assertContains(resp, target_type) + self.assertContains(resp, '%s' % + (target_url, target)) + + origin_info = { + 'id': 13706355, + 'type': 'git', + 'url': 'https://github.com/python/cpython' + } + + mock_service_utils.lookup_origin.return_value = origin_info + mock_service_utils.lookup_origin_visits.return_value = stub_origin_visits + mock_service_utils.MAX_LIMIT = 20 + + url = reverse('browse-release', + kwargs={'sha1_git': stub_release['id']}, + query_params={'origin_type': origin_info['type'], + 'origin_url': origin_info['url']}) + + resp = self.client.get(url) + self.assertEquals(resp.status_code, 200) + self.assertTemplateUsed('release.html') + + self.assertContains(resp, '%s' % + (author_url, author_name)) + self.assertContains(resp, format_utc_iso_date(release_date)) + self.assertContains(resp, message) + self.assertContains(resp, release_id) + self.assertContains(resp, release_name) + self.assertContains(resp, target_type) + + target_url = reverse('browse-revision', kwargs={'sha1_git': target}, + query_params={'origin_type': origin_info['type'], + 'origin_url': origin_info['url']}) + + self.assertContains(resp, '%s' % (target_url, target)) + + mock_service.lookup_release.side_effect = \ + NotFoundExc('Release not found') + url = reverse('browse-release', + kwargs={'sha1_git': 'ffff'}) + resp = self.client.get(url) + self.assertEquals(resp.status_code, 404) + self.assertTemplateUsed('error.html') + self.assertContains(resp, 'Release not found', status_code=404) diff --git a/swh/web/tests/browse/views/test_revision.py b/swh/web/tests/browse/views/test_revision.py index 33cd9d1a..b63f5109 100644 --- a/swh/web/tests/browse/views/test_revision.py +++ b/swh/web/tests/browse/views/test_revision.py @@ -1,258 +1,261 @@ # Copyright (C) 2017-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information # flake8: noqa from unittest.mock import patch from nose.tools import istest from django.test import TestCase from django.utils.html import escape from swh.web.common.exc import NotFoundExc from swh.web.common.utils import reverse, format_utc_iso_date from swh.web.tests.testbase import SWHWebTestBase from .data.revision_test_data import ( revision_id_test, revision_metadata_test, revision_history_log_test ) +from .data.origin_test_data import stub_origin_visits + class SwhBrowseRevisionTest(SWHWebTestBase, TestCase): @patch('swh.web.browse.views.revision.service') + @patch('swh.web.browse.utils.service') @istest - def revision_browse(self, mock_service): + def revision_browse(self, mock_service_utils, mock_service): mock_service.lookup_revision.return_value = revision_metadata_test url = reverse('browse-revision', kwargs={'sha1_git': revision_id_test}) author_id = revision_metadata_test['author']['id'] author_name = revision_metadata_test['author']['name'] committer_id = revision_metadata_test['committer']['id'] committer_name = revision_metadata_test['committer']['name'] dir_id = revision_metadata_test['directory'] author_url = reverse('browse-person', kwargs={'person_id': author_id}) committer_url = reverse('browse-person', kwargs={'person_id': committer_id}) directory_url = reverse('browse-directory', kwargs={'sha1_git': dir_id}) history_url = reverse('browse-revision-log', kwargs={'sha1_git': revision_id_test}) resp = self.client.get(url) self.assertEquals(resp.status_code, 200) self.assertTemplateUsed('revision.html') self.assertContains(resp, '%s' % (author_url, author_name)) self.assertContains(resp, '%s' % (committer_url, committer_name)) self.assertContains(resp, '%s' % (directory_url, directory_url)) self.assertContains(resp, '%s' % (history_url, history_url)) for parent in revision_metadata_test['parents']: parent_url = reverse('browse-revision', kwargs={'sha1_git': parent}) self.assertContains(resp, '%s' % (parent_url, parent)) author_date = revision_metadata_test['date'] committer_date = revision_metadata_test['committer_date'] message = revision_metadata_test['message'] self.assertContains(resp, format_utc_iso_date(author_date)) self.assertContains(resp, format_utc_iso_date(committer_date)) self.assertContains(resp, message) origin_info = { 'id': '7416001', 'type': 'git', 'url': 'https://github.com/webpack/webpack' } - mock_service.lookup_origin.return_value = origin_info + mock_service_utils.lookup_origin.return_value = origin_info + mock_service_utils.lookup_origin_visits.return_value = stub_origin_visits + mock_service_utils.MAX_LIMIT = 20 origin_directory_url = reverse('browse-origin-directory', kwargs={'origin_type': origin_info['type'], 'origin_url': origin_info['url']}, query_params={'revision': revision_id_test}) origin_revision_log_url = reverse('browse-origin-log', kwargs={'origin_type': origin_info['type'], 'origin_url': origin_info['url']}, query_params={'revision': revision_id_test}) url = reverse('browse-revision', kwargs={'sha1_git': revision_id_test}, query_params={'origin_type': origin_info['type'], 'origin_url': origin_info['url']}) resp = self.client.get(url) self.assertContains(resp, '%s' % (origin_directory_url, origin_directory_url)) self.assertContains(resp, '%s' % (origin_revision_log_url, origin_revision_log_url)) - self.assertContains(resp, '%s' % - (origin_info['url'], origin_info['url'])) - for parent in revision_metadata_test['parents']: parent_url = reverse('browse-revision', kwargs={'sha1_git': parent}, query_params={'origin_type': origin_info['type'], 'origin_url': origin_info['url']}) self.assertContains(resp, '%s' % (parent_url, parent)) @patch('swh.web.browse.views.revision.service') @istest def revision_log_browse(self, mock_service): per_page = 10 mock_service.lookup_revision_log.return_value = \ revision_history_log_test[:per_page+1] url = reverse('browse-revision-log', kwargs={'sha1_git': revision_id_test}, query_params={'per_page': per_page}) resp = self.client.get(url) prev_rev = revision_history_log_test[per_page]['id'] next_page_url = reverse('browse-revision-log', kwargs={'sha1_git': prev_rev}, query_params={'revs_breadcrumb': revision_id_test, 'per_page': per_page}) self.assertEquals(resp.status_code, 200) self.assertTemplateUsed('revision-log.html') self.assertContains(resp, '', count=per_page) self.assertContains(resp, '
  • Newer
    • ') self.assertContains(resp, '
  • Older
    • ' % escape(next_page_url)) for log in revision_history_log_test[:per_page]: author_url = reverse('browse-person', kwargs={'person_id': log['author']['id']}) revision_url = reverse('browse-revision', kwargs={'sha1_git': log['id']}) directory_url = reverse('browse-directory', kwargs={'sha1_git': log['directory']}) self.assertContains(resp, '%s' % (author_url, log['author']['name'])) self.assertContains(resp, '%s' % (revision_url, log['id'][:7])) self.assertContains(resp, '%s' % (directory_url, 'Tree')) mock_service.lookup_revision_log.return_value = \ revision_history_log_test[per_page:2*per_page+1] resp = self.client.get(next_page_url) prev_prev_rev = revision_history_log_test[2*per_page]['id'] prev_page_url = reverse('browse-revision-log', kwargs={'sha1_git': revision_id_test}, query_params={'per_page': per_page}) next_page_url = reverse('browse-revision-log', kwargs={'sha1_git': prev_prev_rev}, query_params={'revs_breadcrumb': revision_id_test + '/' + prev_rev, 'per_page': per_page}) self.assertEquals(resp.status_code, 200) self.assertTemplateUsed('revision-log.html') self.assertContains(resp, '', count=per_page) self.assertContains(resp, '
  • Newer
    • ' % escape(prev_page_url)) self.assertContains(resp, '
  • Older
    • ' % escape(next_page_url)) mock_service.lookup_revision_log.return_value = \ revision_history_log_test[2*per_page:3*per_page+1] resp = self.client.get(next_page_url) prev_prev_prev_rev = revision_history_log_test[3*per_page]['id'] prev_page_url = reverse('browse-revision-log', kwargs={'sha1_git': prev_rev}, query_params={'revs_breadcrumb': revision_id_test, 'per_page': per_page}) next_page_url = reverse('browse-revision-log', kwargs={'sha1_git': prev_prev_prev_rev}, query_params={'revs_breadcrumb': revision_id_test + '/' + prev_rev + '/' + prev_prev_rev, 'per_page': per_page}) self.assertEquals(resp.status_code, 200) self.assertTemplateUsed('revision-log.html') self.assertContains(resp, '', count=per_page) self.assertContains(resp, '
  • Newer
    • ' % escape(prev_page_url)) self.assertContains(resp, '
  • Older
    • ' % escape(next_page_url)) mock_service.lookup_revision_log.return_value = \ revision_history_log_test[3*per_page:3*per_page+per_page//2] resp = self.client.get(next_page_url) prev_page_url = reverse('browse-revision-log', kwargs={'sha1_git': prev_prev_rev}, query_params={'revs_breadcrumb': revision_id_test + '/' + prev_rev, 'per_page': per_page}) self.assertEquals(resp.status_code, 200) self.assertTemplateUsed('revision-log.html') self.assertContains(resp, '', count=per_page//2) self.assertContains(resp, '
  • Older
    • ') self.assertContains(resp, '
  • Newer
    • ' % escape(prev_page_url)) + @patch('swh.web.browse.utils.service') @patch('swh.web.browse.views.revision.service') @istest - def revision_request_errors(self, mock_service): + def revision_request_errors(self, mock_service, mock_utils_service): mock_service.lookup_revision.side_effect = \ NotFoundExc('Revision not found') url = reverse('browse-revision', kwargs={'sha1_git': revision_id_test}) resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertContains(resp, 'Revision not found', status_code=404) mock_service.lookup_revision_log.side_effect = \ NotFoundExc('Revision not found') url = reverse('browse-revision-log', kwargs={'sha1_git': revision_id_test}) resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertContains(resp, 'Revision not found', status_code=404) url = reverse('browse-revision', kwargs={'sha1_git': revision_id_test}, query_params={'origin_type': 'git', 'origin_url': 'https://github.com/foo/bar'}) mock_service.lookup_revision.side_effect = None - mock_service.lookup_origin.side_effect = \ + mock_utils_service.lookup_origin.side_effect = \ NotFoundExc('Origin not found') resp = self.client.get(url) self.assertEquals(resp.status_code, 404) self.assertTemplateUsed('error.html') self.assertContains(resp, 'Origin not found', status_code=404)