Page MenuHomeSoftware Heritage
Differential D3696

browse: Restrict view timestamp parameters to ISO 8601 dates
ClosedPublic
Actions

Authored by anlambert on Aug 4 2020, 4:46 PM.

Details

Reviewers
ardumont
Group Reviewers
Reviewers
Maniphest Tasks
T2375: Restrict date string query parameters to ISO 8601 format
Commits
rDWAPPS55f380a80006: browse: Restrict view timestamp parameters to ISO 8601 dates
Summary

For consistency with other swh components, only accept datetime string
view parameters in ISO 8601 format.

This change drops the dateutil requirement in favor of the iso8601 one.

Closes T2375

Diff Detail

Repository
rDWAPPS Web applications
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

anlambert created this revision.Aug 4 2020, 4:46 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptAug 4 2020, 4:46 PM
ardumont accepted this revision.Aug 4 2020, 4:53 PM
ardumont added a subscriber: ardumont.
ardumont added inline comments.
swh/web/tests/common/test_utils.py
49–50

pytest.mark.parametrize is nice for those kind of tests ;)

This revision is now accepted and ready to land.Aug 4 2020, 4:53 PM
swh-public-ci added a comment.Aug 4 2020, 4:53 PM

Build is green

Patch application report for D3696 (id=13025)

Rebasing onto 957fd2fdfe...

Current branch diff-target is up to date.
Changes applied before test
commit 6d192093d9fd70521f817d7e35822e05fe6edc16
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Tue Aug 4 14:44:16 2020 +0200

    browse: Restrict view timestamp parameters to ISO 8601 dates
    
    For consistency with other swh components, only accept datetime string
    view parameters in ISO 8601 format.
    
    This change drops the dateutil requirement in favor of the iso8601 one.
    
    Closes T2375

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/303/ for more details.

Harbormaster completed remote builds in B14268: Diff 13025.Aug 4 2020, 4:53 PM
anlambert updated this revision to Diff 13026.Aug 4 2020, 5:22 PM

Update: Use pytest.mark.parametrize in updated tests

swh-public-ci added a comment.Aug 4 2020, 5:29 PM

Build is green

Patch application report for D3696 (id=13026)

Rebasing onto 957fd2fdfe...

Current branch diff-target is up to date.
Changes applied before test
commit 55f380a80006f4008d450c2195d68adcf38ca9ae
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Tue Aug 4 14:44:16 2020 +0200

    browse: Restrict view timestamp parameters to ISO 8601 dates
    
    For consistency with other swh components, only accept datetime string
    view parameters in ISO 8601 format.
    
    This change drops the dateutil requirement in favor of the iso8601 one.
    
    Closes T2375

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/304/ for more details.

Harbormaster completed remote builds in B14269: Diff 13026.Aug 4 2020, 5:29 PM
Closed by commit rDWAPPS55f380a80006: browse: Restrict view timestamp parameters to ISO 8601 dates (authored by anlambert). · Explain WhyAug 4 2020, 5:56 PM
This revision was automatically updated to reflect the committed changes.
anlambert added a commit: rDWAPPS55f380a80006: browse: Restrict view timestamp parameters to ISO 8601 dates.

Revision Contents
Changeset List

PathSize
docs/
69 lines
12 lines
1 line
3 lines
2 lines
swh/
web/
browse/
6 lines
views/
4 lines
common/
4 lines
14 lines
40 lines
tests/
browse/
views/
75 lines
4 lines
common/
3 lines
49 lines

Diff 13027

View Options

docs/uri-scheme-browse-origin.rst

Show First 20 Lines • Show All 85 Lines • ▼ Show 20 Lines.. http:get:: /browse/origin/directory/
:query string path: optional parameter used to specify the path of a directory :query string path: optional parameter used to specify the path of a directory
reachable from the origin root one reachable from the origin root one
:query string branch: specify the origin branch name from which :query string branch: specify the origin branch name from which
to retrieve the root directory to retrieve the root directory
:query string release: specify the origin release name from which :query string release: specify the origin release name from which
to retrieve the root directory to retrieve the root directory
:query string revision: specify the origin revision, identified by the hexadecimal :query string revision: specify the origin revision, identified by the hexadecimal
representation of its **sha1_git** value, from which to retrieve the root directory representation of its **sha1_git** value, from which to retrieve the root directory
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) :query string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:query int visit_id: specify a visit id to retrieve the directory from instead :query int visit_id: specify a visit id to retrieve the directory from instead
of using the latest full visit by default of using the latest full visit by default
:statuscode 200: no error :statuscode 200: no error
:statuscode 400: no origin url has been provided as parameter :statuscode 400: no origin url has been provided as parameter
:statuscode 404: requested origin can not be found in the archive :statuscode 404: requested origin can not be found in the archive
or the provided path does not exist from the origin root directory or the provided path does not exist from the origin root directory
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
:swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux` :swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux`
:swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux&path=net/ethernet` :swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux&path=net/ethernet`
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython` :swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython`
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&path=Python` :swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&path=Python`
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&branch=refs/heads/2.7` :swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&branch=refs/heads/2.7`
:swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux&timestamp=1493926809`
:swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux&path=net/ethernet&timestamp=2016-09-14T10:36:21Z` :swh_web_browse:`origin/directory/?origin_url=https://github.com/torvalds/linux&path=net/ethernet&timestamp=2016-09-14T10:36:21Z`
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&timestamp=1474620651`
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&path=Python&timestamp=2017-05-05` :swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&path=Python&timestamp=2017-05-05`
:swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&branch=refs/heads/2.7&timestamp=2015-08` :swh_web_browse:`origin/directory/?origin_url=https://github.com/python/cpython&branch=refs/heads/2.7&timestamp=2015-08`
.. http:get:: /browse/origin/(origin_url)/directory/[(path)/] .. http:get:: /browse/origin/(origin_url)/directory/[(path)/]
:deprecated: :deprecated:
.. warning:: .. warning::
▲ Show 20 Lines • Show All 64 Lines • ▼ Show 20 Lines :deprecated:
The view also enables to easily switch between the origin branches The view also enables to easily switch between the origin branches
and releases through a dropdown menu. and releases through a dropdown menu.
The origin branch (default to HEAD) from which to retrieve the directory The origin branch (default to HEAD) from which to retrieve the directory
content can also be specified by using the branch query parameter. content can also be specified by using the branch query parameter.
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) :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`_) :param string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:param path: optional parameter used to specify the path of a directory :param path: optional parameter used to specify the path of a directory
reachable from the origin root one reachable from the origin root one
:type path: string :type path: string
:query string branch: specify the origin branch name from which :query string branch: specify the origin branch name from which
to retrieve the root directory to retrieve the root directory
:query string release: specify the origin release name from which :query string release: specify the origin release name from which
to retrieve the root directory to retrieve the root directory
:query string revision: specify the origin revision, identified by the hexadecimal :query string revision: specify the origin revision, identified by the hexadecimal
▲ Show 20 Lines • Show All 49 Lines • ▼ Show 20 Lines :query string origin_url: mandatory parameter providing the url of the origin
(e.g. https://github.com/(user)/(repo)) (e.g. https://github.com/(user)/(repo))
:query string path: path of a content reachable from the origin root directory :query string path: path of a content reachable from the origin root directory
:query string branch: specify the origin branch name from which :query string branch: specify the origin branch name from which
to retrieve the content to retrieve the content
:query string release: specify the origin release name from which :query string release: specify the origin release name from which
to retrieve the content to retrieve the content
:query string revision: specify the origin revision, identified by the hexadecimal :query string revision: specify the origin revision, identified by the hexadecimal
representation of its **sha1_git** value, from which to retrieve the content representation of its **sha1_git** value, from which to retrieve the content
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) :query string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:query int visit_id: specify a visit id to retrieve the content from instead :query int visit_id: specify a visit id to retrieve the content from instead
of using the latest full visit by default of using the latest full visit by default
:statuscode 200: no error :statuscode 200: no error
:statuscode 400: no origin url has been provided as parameter :statuscode 400: no origin url has been provided as parameter
:statuscode 404: requested origin can not be found in the archive, :statuscode 404: requested origin can not be found in the archive,
or the provided content path does not exist from the origin root directory or the provided content path does not exist from the origin root directory
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
:swh_web_browse:`origin/content/?origin_url=https://github.com/git/git?path=git.c` :swh_web_browse:`origin/content/?origin_url=https://github.com/git/git?path=git.c`
:swh_web_browse:`origin/content/?origin_url=https://github.com/mozilla/gecko-dev&path=js/src/json.cpp` :swh_web_browse:`origin/content/?origin_url=https://github.com/mozilla/gecko-dev&path=js/src/json.cpp`
:swh_web_browse:`origin/content/?origin_url=https://github.com/git/git?path=git.c&branch=refs/heads/next` :swh_web_browse:`origin/content/?origin_url=https://github.com/git/git?path=git.c&branch=refs/heads/next`
:swh_web_browse:`origin/content/?origin_url=https://github.com/git/git&path=git.c&timestamp=1473933564`
:swh_web_browse:`origin/content/?origin_url=https://github.com/git/git&path=git.c&timestamp=2016-05-05T00:0:00+00:00Z` :swh_web_browse:`origin/content/?origin_url=https://github.com/git/git&path=git.c&timestamp=2016-05-05T00:0:00+00:00Z`
:swh_web_browse:`origin/content/?origin_url=https://github.com/mozilla/gecko-dev&path=js/src/json.cpp&timestamp=1490126182`
:swh_web_browse:`origin/content/?origin_url=https://github.com/mozilla/gecko-dev&path=js/src/json.cpp&timestamp=2017-03-21#L904-L931` :swh_web_browse:`origin/content/?origin_url=https://github.com/mozilla/gecko-dev&path=js/src/json.cpp&timestamp=2017-03-21#L904-L931`
:swh_web_browse:`origin/content/?origin_url=https://github.com/git/git&path=git.c&branch=refs/heads/next&timestamp=2017-09-15` :swh_web_browse:`origin/content/?origin_url=https://github.com/git/git&path=git.c&branch=refs/heads/next&timestamp=2017-09-15`
.. http:get:: /browse/origin/(origin_url)/content/ .. http:get:: /browse/origin/(origin_url)/content/
:deprecated: :deprecated:
.. warning:: .. warning::
Show All 26 Lines :deprecated:
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) :param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/)
:query string path: path of a content reachable from the origin root directory :query string path: path of a content reachable from the origin root directory
:query string branch: specify the origin branch name from which :query string branch: specify the origin branch name from which
to retrieve the content to retrieve the content
:query string release: specify the origin release name from which :query string release: specify the origin release name from which
to retrieve the content to retrieve the content
:query string revision: specify the origin revision, identified by the hexadecimal :query string revision: specify the origin revision, identified by the hexadecimal
representation of its **sha1_git** value, from which to retrieve the content representation of its **sha1_git** value, from which to retrieve the content
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) :query string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:query int visit_id: specify a visit id to retrieve the content from instead :query int visit_id: specify a visit id to retrieve the content from instead
of using the latest full visit by default of using the latest full visit by default
:statuscode 200: no error :statuscode 200: no error
:statuscode 400: no origin url has been provided as parameter :statuscode 400: no origin url has been provided as parameter
:statuscode 404: requested origin can not be found in the archive, :statuscode 404: requested origin can not be found in the archive,
or the provided content path does not exist from the origin root directory or the provided content path does not exist from the origin root directory
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
:swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c` :swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c`
:swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/content/?path=js/src/json.cpp` :swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/content/?path=js/src/json.cpp`
:swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c&branch=refs/heads/next` :swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c&branch=refs/heads/next`
:swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c&timestamp=1473933564`
:swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c&timestamp=2016-05-05T00:0:00+00:00Z` :swh_web_browse:`origin/https://github.com/git/git/content/?path=git.c&timestamp=2016-05-05T00:0:00+00:00Z`
:swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/content?path=js/src/json.cpp&timestamp=1490126182`
:swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/content?path=js/src/json.cpp&timestamp=2017-03-21#L904-L931` :swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/content?path=js/src/json.cpp&timestamp=2017-03-21#L904-L931`
:swh_web_browse:`origin/https://github.com/git/git/content/git.c/?branch=refs/heads/next&timestamp=2017-09-15` :swh_web_browse:`origin/https://github.com/git/git/content/git.c/?branch=refs/heads/next&timestamp=2017-09-15`
.. http:get:: /browse/origin/(origin_url)/content/(path)/ .. http:get:: /browse/origin/(origin_url)/content/(path)/
:deprecated: :deprecated:
.. warning:: .. warning::
▲ Show 20 Lines • Show All 73 Lines • ▼ Show 20 Lines :deprecated:
The view also enables to easily switch between the origin branches The view also enables to easily switch between the origin branches
and releases through a dropdown menu. and releases through a dropdown menu.
The origin branch (default to HEAD) from which to retrieve the content The origin branch (default to HEAD) from which to retrieve the content
can also be specified by using the branch query parameter. can also be specified by using the branch query parameter.
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) :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`_) :param string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:param string path: path of a content reachable from the origin root directory :param string path: path of a content reachable from the origin root directory
:query string branch: specify the origin branch name from which :query string branch: specify the origin branch name from which
to retrieve the content to retrieve the content
:query string release: specify the origin release name from which :query string release: specify the origin release name from which
to retrieve the content to retrieve the content
:query string revision: specify the origin revision, identified by the hexadecimal :query string revision: specify the origin revision, identified by the hexadecimal
representation of its **sha1_git** value, from which to retrieve the content representation of its **sha1_git** value, from which to retrieve the content
:query int visit_id: specify a visit id to retrieve the content from instead :query int visit_id: specify a visit id to retrieve the content from instead
of using the provided timestamp of using the provided timestamp
:statuscode 200: no error :statuscode 200: no error
:statuscode 404: requested origin can not be found in the archive, :statuscode 404: requested origin can not be found in the archive,
requested visit timestamp does not exist or the provided content path does requested visit timestamp does not exist or the provided content path does
not exist from the origin root directory not exist from the origin root directory
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
:swh_web_browse:`origin/https://github.com/git/git/visit/1473933564/content/git.c/`
:swh_web_browse:`origin/https://github.com/git/git/visit/2016-05-05T00:0:00+00:00Z/content/git.c/` :swh_web_browse:`origin/https://github.com/git/git/visit/2016-05-05T00:0:00+00:00Z/content/git.c/`
:swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/visit/1490126182/content/js/src/json.cpp/`
:swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/visit/2017-03-21/content/js/src/json.cpp/#L904-L931` :swh_web_browse:`origin/https://github.com/mozilla/gecko-dev/visit/2017-03-21/content/js/src/json.cpp/#L904-L931`
:swh_web_browse:`origin/https://github.com/git/git/visit/2017-09-15/content/git.c/?branch=refs/heads/next` :swh_web_browse:`origin/https://github.com/git/git/visit/2017-09-15/content/git.c/?branch=refs/heads/next`
Origin history Origin history
"""""""""""""" """"""""""""""
.. http:get:: /browse/origin/log/ .. http:get:: /browse/origin/log/
Show All 35 Lines.. http:get:: /browse/origin/log/
:query str revs_ordering: specify the revisions ordering, possible values are ``committer_date``, :query str revs_ordering: specify the revisions ordering, possible values are ``committer_date``,
``dfs``, ``dfs_post`` and ``bfs`` ``dfs``, ``dfs_post`` and ``bfs``
:query string branch: specify the origin branch name from which :query string branch: specify the origin branch name from which
to retrieve the commit log to retrieve the commit log
:query string release: specify the origin release name from which :query string release: specify the origin release name from which
to retrieve the commit log to retrieve the commit log
:query string revision: specify the origin revision, identified by the hexadecimal :query string revision: specify the origin revision, identified by the hexadecimal
representation of its **sha1_git** value, from which to retrieve the commit log representation of its **sha1_git** value, from which to retrieve the commit log
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) :query string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:query int visit_id: specify a visit id to retrieve the history log from instead :query int visit_id: specify a visit id to retrieve the history log from instead
of using the latest visit by default of using the latest visit by default
:statuscode 200: no error :statuscode 200: no error
:statuscode 400: no origin url has been provided as parameter :statuscode 400: no origin url has been provided as parameter
:statuscode 404: requested origin can not be found in the archive :statuscode 404: requested origin can not be found in the archive
**Examples:** **Examples:**
▲ Show 20 Lines • Show All 51 Lines • ▼ Show 20 Lines :deprecated:
:query str revs_ordering: specify the revisions ordering, possible values are ``committer_date``, :query str revs_ordering: specify the revisions ordering, possible values are ``committer_date``,
``dfs``, ``dfs_post`` and ``bfs`` ``dfs``, ``dfs_post`` and ``bfs``
:query string branch: specify the origin branch name from which :query string branch: specify the origin branch name from which
to retrieve the commit log to retrieve the commit log
:query string release: specify the origin release name from which :query string release: specify the origin release name from which
to retrieve the commit log to retrieve the commit log
:query string revision: specify the origin revision, identified by the hexadecimal :query string revision: specify the origin revision, identified by the hexadecimal
representation of its **sha1_git** value, from which to retrieve the commit log representation of its **sha1_git** value, from which to retrieve the commit log
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) :query string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:query int visit_id: specify a visit id to retrieve the history log from instead :query int visit_id: specify a visit id to retrieve the history log from instead
of using the latest visit by default of using the latest visit by default
:statuscode 200: no error :statuscode 200: no error
:statuscode 404: requested origin can not be found in the archive :statuscode 404: requested origin can not be found in the archive
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
:swh_web_browse:`origin/https://github.com/videolan/vlc/log/` :swh_web_browse:`origin/https://github.com/videolan/vlc/log/`
:swh_web_browse:`origin/https://github.com/Kitware/CMake/log/` :swh_web_browse:`origin/https://github.com/Kitware/CMake/log/`
:swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?branch=refs/heads/release` :swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?branch=refs/heads/release`
:swh_web_browse:`origin/https://github.com/videolan/vlc/log/?visit=1459651262`
:swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?timestamp=2016-04-01` :swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?timestamp=2016-04-01`
:swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?branch=refs/heads/release&timestamp=1438116814`
:swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?branch=refs/heads/release&timestamp=2017-05-05T03:14:23Z` :swh_web_browse:`origin/https://github.com/Kitware/CMake/log/?branch=refs/heads/release&timestamp=2017-05-05T03:14:23Z`
.. http:get:: /browse/origin/(origin_url)/visit/(timestamp)/log/ .. http:get:: /browse/origin/(origin_url)/visit/(timestamp)/log/
:deprecated: :deprecated:
.. warning:: .. warning::
That endpoint is deprecated, use :http:get:`/browse/origin/log/` instead. That endpoint is deprecated, use :http:get:`/browse/origin/log/` instead.
Show All 22 Lines :deprecated:
The view also enables to easily switch between the origin branches The view also enables to easily switch between the origin branches
and releases through a dropdown menu. and releases through a dropdown menu.
The origin branch (default to HEAD) from which to retrieve the content The origin branch (default to HEAD) from which to retrieve the content
can also be specified by using the branch query parameter. can also be specified by using the branch query parameter.
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) :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`_) :param string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:query int per_page: the number of log entries to display per page :query int per_page: the number of log entries to display per page
(default is 20, max is 50) (default is 20, max is 50)
:query string branch: specify the origin branch name from which :query string branch: specify the origin branch name from which
to retrieve the commit log to retrieve the commit log
:query string release: specify the origin release name from which :query string release: specify the origin release name from which
to retrieve the commit log to retrieve the commit log
:query string revision: specify the origin revision, identified by the hexadecimal :query string revision: specify the origin revision, identified by the hexadecimal
representation of its **sha1_git** value, from which to retrieve the commit log representation of its **sha1_git** value, from which to retrieve the commit log
:query int visit_id: specify a visit id to retrieve the history log from instead :query int visit_id: specify a visit id to retrieve the history log from instead
of using the provided timestamp of using the provided timestamp
:statuscode 200: no error :statuscode 200: no error
:statuscode 404: requested origin can not be found in the archive :statuscode 404: requested origin can not be found in the archive
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
:swh_web_browse:`origin/https://github.com/videolan/vlc/visit/1459651262/log/`
:swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2016-04-01/log/` :swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2016-04-01/log/`
:swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/1438116814/log/?branch=refs/heads/release`
:swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2017-05-05T03:14:23Z/log/?branch=refs/heads/release` :swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2017-05-05T03:14:23Z/log/?branch=refs/heads/release`
Origin branches Origin branches
""""""""""""""" """""""""""""""
.. http:get:: /browse/origin/branches/ .. http:get:: /browse/origin/branches/
HTML view that produces a display of the list of branches HTML view that produces a display of the list of branches
found during the latest full visit of a software origin. found during the latest full visit of a software origin.
The following data are displayed for each branch: The following data are displayed for each branch:
* its name * its name
* a link to browse the associated directory * a link to browse the associated directory
* a link to browse the associated revision * a link to browse the associated revision
* last commit message * last commit message
* last commit date * last commit date
That list of branches is paginated, each page displaying a maximum of 100 branches. That list of branches is paginated, each page displaying a maximum of 100 branches.
:query string origin_url: mandatory parameter providing the url of the origin :query string origin_url: mandatory parameter providing the url of the origin
(e.g. https://github.com/(user)/(repo)) (e.g. https://github.com/(user)/(repo))
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) :query string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:statuscode 200: no error :statuscode 200: no error
:statuscode 400: no origin url has been provided as parameter :statuscode 400: no origin url has been provided as parameter
:statuscode 404: requested origin can not be found in the archive :statuscode 404: requested origin can not be found in the archive
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
Show All 18 Lines The following data are displayed for each branch:
* a link to browse the associated directory * a link to browse the associated directory
* a link to browse the associated revision * a link to browse the associated revision
* last commit message * last commit message
* last commit date * last commit date
That list of branches is paginated, each page displaying a maximum of 100 branches. That list of branches is paginated, each page displaying a maximum of 100 branches.
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) :param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/)
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) :query string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:statuscode 200: no error :statuscode 200: no error
:statuscode 404: requested origin can not be found in the archive :statuscode 404: requested origin can not be found in the archive
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
:swh_web_browse:`origin/deb://Debian/packages/linux/branches/` :swh_web_browse:`origin/deb://Debian/packages/linux/branches/`
Show All 17 Lines The following data are displayed for each branch:
* a link to browse the associated directory * a link to browse the associated directory
* a link to browse the associated revision * a link to browse the associated revision
* last commit message * last commit message
* last commit date * last commit date
That list of branches is paginated, each page displaying a maximum of 100 branches. That list of branches is paginated, each page displaying a maximum of 100 branches.
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) :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`_) :param string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:statuscode 200: no error :statuscode 200: no error
:statuscode 404: requested origin can not be found in the archive :statuscode 404: requested origin can not be found in the archive
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
:swh_web_browse:`origin/https://github.com/kripken/emscripten/visit/2017-05-05T12:02:03Z/branches/` :swh_web_browse:`origin/https://github.com/kripken/emscripten/visit/2017-05-05T12:02:03Z/branches/`
Show All 14 Lines The following data are displayed for each release:
* its target type (revision, directory, content or release) * its target type (revision, directory, content or release)
* its associated message * its associated message
* its date * its date
That list of releases is paginated, each page displaying a maximum of 100 releases. That list of releases is paginated, each page displaying a maximum of 100 releases.
:query string origin_url: mandatory parameter providing the url of the origin :query string origin_url: mandatory parameter providing the url of the origin
(e.g. https://github.com/(user)/(repo)) (e.g. https://github.com/(user)/(repo))
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) :query string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:statuscode 200: no error :statuscode 200: no error
:statuscode 400: no origin url has been provided as parameter :statuscode 400: no origin url has been provided as parameter
:statuscode 404: requested origin can not be found in the archive :statuscode 404: requested origin can not be found in the archive
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
Show All 18 Lines The following data are displayed for each release:
* a link to browse the release details * a link to browse the release details
* its target type (revision, directory, content or release) * its target type (revision, directory, content or release)
* its associated message * its associated message
* its date * its date
That list of releases is paginated, each page displaying a maximum of 100 releases. That list of releases is paginated, each page displaying a maximum of 100 releases.
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) :param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/)
:query string timestamp: a date string (any format parsable by `dateutil.parser.parse`_) :query string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:statuscode 200: no error :statuscode 200: no error
:statuscode 404: requested origin can not be found in the archive :statuscode 404: requested origin can not be found in the archive
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
:swh_web_browse:`origin/https://github.com/git/git/releases/` :swh_web_browse:`origin/https://github.com/git/git/releases/`
Show All 17 Lines The following data are displayed for each release:
* a link to browse the release details * a link to browse the release details
* its target type (revision, directory, content or release) * its target type (revision, directory, content or release)
* its associated message * its associated message
* its date * its date
That list of releases is paginated, each page displaying a maximum of 100 releases. That list of releases is paginated, each page displaying a maximum of 100 releases.
:param string origin_url: the url of the origin (e.g. https://github.com/(user)/(repo)/) :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`_) :param string timestamp: an ISO 8601 datetime string to parse in order to find the
or Unix timestamp to parse in order to find the closest visit. closest visit.
:statuscode 200: no error :statuscode 200: no error
:statuscode 404: requested origin can not be found in the archive :statuscode 404: requested origin can not be found in the archive
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
:swh_web_browse:`origin/https://github.com/torvalds/linux/visit/2017-11-21T19:37:42Z/releases/` :swh_web_browse:`origin/https://github.com/torvalds/linux/visit/2017-11-21T19:37:42Z/releases/`
:swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2016-09-23T14:06:35Z/releases/` :swh_web_browse:`origin/https://github.com/Kitware/CMake/visit/2016-09-23T14:06:35Z/releases/`
.. _highlightjs: https://highlightjs.org/ .. _highlightjs: https://highlightjs.org/
.. _dateutil.parser.parse: http://dateutil.readthedocs.io/en/stable/parser.html
View Options

docs/uri-scheme-browse-revision.rst

Show All 14 Lines.. http:get:: /browse/revision/(sha1_git)/
Last but not least, the view displays the list of file changes introduced Last but not least, the view displays the list of file changes introduced
in the revision but also the diffs of each changed files. in the revision but also the diffs of each changed files.
:param string sha1_git: hexadecimal representation for the **sha1_git** :param string sha1_git: hexadecimal representation for the **sha1_git**
identifier of a revision identifier of a revision
:query string origin_url: used internally to associate an origin url :query string origin_url: used internally to associate an origin url
(e.g. https://github.com/user/repo) to the revision (e.g. https://github.com/user/repo) to the revision
:query string timestamp: used internally to associate an origin visit to the :query string timestamp: an ISO 8601 datetime string to parse in order to find the
revision, must be a date string (any format parsable by `dateutil.parser.parse`_) closest visit.
or Unix timestamp to parse in order to find the closest visit. :query int visit_id: specify a visit id instead of
:query int visit_id: used internally to specify a visit id instead of
using the provided timestamp using the provided timestamp
:query string path: used internally when navigating in the source tree :query string path: optional relative path from the revision root directory
associated to the revision
:statuscode 200: no error :statuscode 200: no error
:statuscode 404: requested revision can not be found in the archive :statuscode 404: requested revision can not be found in the archive
**Examples:** **Examples:**
.. parsed-literal:: .. parsed-literal::
:swh_web_browse:`revision/f1b94134a4b879bc55c3dacdb496690c8ebdc03f/` :swh_web_browse:`revision/f1b94134a4b879bc55c3dacdb496690c8ebdc03f/`
:swh_web_browse:`revision/d1aa2b3f607b35dc5dbf613b2334b6d243ec2bda/` :swh_web_browse:`revision/d1aa2b3f607b35dc5dbf613b2334b6d243ec2bda/`
.. _dateutil.parser.parse: http://dateutil.readthedocs.io/en/stable/parser.html
.. http:get:: /browse/revision/(sha1_git)/log/ .. http:get:: /browse/revision/(sha1_git)/log/
HTML view that displays the list of revisions heading to HTML view that displays the list of revisions heading to
a given one. In other words, it shows a commit log. a given one. In other words, it shows a commit log.
The following data are displayed for each log entry: The following data are displayed for each log entry:
* link to browse the revision * link to browse the revision
* author of the revision * author of the revision
Show All 30 Lines
View Options

docs/uri-scheme-browse.rst

Show First 20 Lines • Show All 63 Lines • ▼ Show 20 Lines
- **branch** name is given as per the corresponding VCS (e.g., Git) as - **branch** name is given as per the corresponding VCS (e.g., Git) as
a query parameter to the requested URL. a query parameter to the requested URL.
- **timestamp** is given in a format as liberal as possible, to uphold the - **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 principle of least surprise. At the very minimum it is possible to
enter timestamps as: 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`) - 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
- YYYY[-MM[-DD[ HH:[MM:[SS:]]]]] ad-hoc format - YYYY[-MM[-DD[ HH:[MM:[SS:]]]]] ad-hoc format
swh-web Browse Urls swh-web Browse Urls
------------------- -------------------
Show All 13 Lines
View Options

mypy.ini

Show All 15 Lines
ignore_missing_imports = True ignore_missing_imports = True
[mypy-django_js_reverse.*] [mypy-django_js_reverse.*]
ignore_missing_imports = True ignore_missing_imports = True
[mypy-htmlmin.*] [mypy-htmlmin.*]
ignore_missing_imports = True ignore_missing_imports = True
[mypy-iso8601.*]
ignore_missing_imports = True
[mypy-keycloak.*] [mypy-keycloak.*]
ignore_missing_imports = True ignore_missing_imports = True
[mypy-magic.*] [mypy-magic.*]
ignore_missing_imports = True ignore_missing_imports = True
[mypy-pkg_resources.*] [mypy-pkg_resources.*]
ignore_missing_imports = True ignore_missing_imports = True
Show All 21 Lines
View Options

requirements.txt

Loading...
View Options

swh/web/browse/snapshot_context.py

Loading...
View Options

swh/web/browse/views/origin.py

Loading...
View Options

swh/web/common/origin_save.py

Loading...
View Options

swh/web/common/origin_visits.py

Loading...
View Options

swh/web/common/utils.py

Loading...
View Options

swh/web/tests/browse/views/test_origin.py

Loading...
View Options

swh/web/tests/browse/views/test_revision.py

Loading...
View Options

swh/web/tests/common/test_origin_visits.py

Loading...
View Options

swh/web/tests/common/test_utils.py

Loading...
About · Developer information · Legal