Page MenuHomeSoftware Heritage
Differential D4525

Move SWH-specific tags to the https://www.softwareheritage.org/schema/2018/deposit namespace
ClosedPublic
Actions

Authored by vlorentz on Nov 19 2020, 1:59 PM.

Details

Reviewers
ardumont
Group Reviewers
Reviewers
Maniphest Tasks
T2759: Allow the deposit protocol to use SWH tags in the deposit namespace
Commits
rDDEP794402c0f52a: Move SWH-specific tags to the https://www.softwareheritage.
Summary

They don't belong in SWORD.

We're keeping the old ones for existing clients, and we will have to
notify them of the change before removing the old tags.

Diff Detail

Event Timeline

vlorentz created this revision.Nov 19 2020, 1:59 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptNov 19 2020, 1:59 PM
swh-public-ci added a comment.Nov 19 2020, 2:04 PM

Build is green

Patch application report for D4525 (id=16035)

Could not rebase; Attempt merge onto 85416fb165...

Updating 85416fb1..ca3422a2
Fast-forward
 swh/deposit/templates/deposit/content.xml           | 21 +++++++++++----------
 swh/deposit/templates/deposit/deposit_receipt.xml   | 11 ++++++++++-
 swh/deposit/templates/deposit/status.xml            | 16 +++++++++++++++-
 .../tests/api/test_collection_post_binary.py        |  6 ++++++
 swh/deposit/tests/api/test_get_file.py              |  4 ++--
 .../tests/data/https_deposit.swh.test/1_test        | 10 +++++++++-
 .../tests/data/https_deposit.test.metadata/1_test   | 10 +++++++++-
 .../https_deposit.test.metadata/1_test_666_metadata |  9 ++++++++-
 8 files changed, 70 insertions(+), 17 deletions(-)
Changes applied before test
commit ca3422a27365c543db76db003cc2c82b329dc29b
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:59:37 2020 +0100

    Move SWH-specific tags to the https://www.softwareheritage.org/schema/2018/deposit namespace
    
    They don't belong in SWORD.
    
    We're keeping the old ones for existing clients, and we will have to
    notify them of the change before removing the old tags.

commit 918d39057abe4a9194b0f7a0cc04e39bd297ec13
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:56:39 2020 +0100

    Remove <sword:request>.
    
    Motivation:
    
    1. it is not a SWORD tag
    2. I don't think there is any use for this
    3. Its content is buggy, as it only handles one level of hierarchy for the metadata values.

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

Harbormaster completed remote builds in B17241: Diff 16035.Nov 19 2020, 2:04 PM
vlorentz updated this revision to Diff 16051.Nov 19 2020, 3:17 PM

extra fixes

swh-public-ci added a comment.Nov 19 2020, 3:21 PM

Build has FAILED

Patch application report for D4525 (id=16051)

Could not rebase; Attempt merge onto 85416fb165...

Updating 85416fb1..36f75b43
Fast-forward
 swh/deposit/templates/deposit/content.xml           | 21 +++++++++++----------
 swh/deposit/templates/deposit/deposit_receipt.xml   | 11 ++++++++++-
 swh/deposit/templates/deposit/status.xml            | 16 +++++++++++++++-
 swh/deposit/tests/api/test_collection.py            |  6 +++---
 .../tests/api/test_collection_post_binary.py        |  6 ++++++
 swh/deposit/tests/api/test_deposit_private_check.py |  2 +-
 swh/deposit/tests/api/test_deposit_schedule.py      |  2 +-
 swh/deposit/tests/api/test_get_file.py              |  4 ++--
 swh/deposit/tests/cli/test_client.py                |  2 +-
 .../tests/data/https_deposit.swh.test/1_test        | 10 +++++++++-
 .../tests/data/https_deposit.test.metadata/1_test   | 10 +++++++++-
 .../https_deposit.test.metadata/1_test_666_metadata |  9 ++++++++-
 12 files changed, 76 insertions(+), 23 deletions(-)
Changes applied before test
commit 36f75b434cfe6954f9959cda0180f6807b96e89f
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:59:37 2020 +0100

    Move SWH-specific tags to the https://www.softwareheritage.org/schema/2018/deposit namespace
    
    They don't belong in SWORD.
    
    We're keeping the old ones for existing clients, and we will have to
    notify them of the change before removing the old tags.

commit 918d39057abe4a9194b0f7a0cc04e39bd297ec13
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:56:39 2020 +0100

    Remove <sword:request>.
    
    Motivation:
    
    1. it is not a SWORD tag
    2. I don't think there is any use for this
    3. Its content is buggy, as it only handles one level of hierarchy for the metadata values.

Link to build: https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/391/
See console output for more information: https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/391/console

Harbormaster failed remote builds in B17255: Diff 16051!Nov 19 2020, 3:21 PM
ardumont added a subscriber: ardumont.EditedNov 20 2020, 10:06 AM

Can you also update the xml described in docs/* to match those changes?
My trail of though is to stop entertaining the old ways (even if we support it a bit longer).

vlorentz added a comment.Nov 20 2020, 10:08 AM

Right!

ardumont added inline comments.Nov 20 2020, 10:09 AM
swh/deposit/templates/deposit/content.xml
3

what does sd stand for?

sword deposit? swh deposit?

in the deposit metadata, i recall using xmlns:swh instead...

swh/deposit/tests/api/test_collection.py
124 ↗(On Diff #16051)

sd:deposit_id?

vlorentz added inline comments.Nov 20 2020, 10:43 AM
swh/deposit/templates/deposit/content.xml
3

swh deposit, yeah.

I'm using both to highlight it's a detail of the serialization and doesn't actually matter.

swh/deposit/tests/api/test_collection.py
124 ↗(On Diff #16051)

nope, the swh prefix comes from the definition in parsers.py.

vlorentz updated this revision to Diff 16098.Nov 20 2020, 11:05 AM

rebase + update doc

vlorentz updated this revision to Diff 16099.Nov 20 2020, 11:05 AM

rebase

ardumont added inline comments.Nov 20 2020, 11:05 AM
swh/deposit/tests/api/test_collection.py
124 ↗(On Diff #16051)

ah yeah, right.
Well, i'll let you debug the issue then.

I did not look at the error message so it was a long shot ;)

ardumont added a comment.Nov 20 2020, 11:06 AM

I think you updated the wrong diff ¯\_(ツ)_/¯

vlorentz added a comment.Nov 20 2020, 11:07 AM

oh jeez

vlorentz updated this revision to Diff 16103.Nov 20 2020, 11:09 AM

fix diff

swh-public-ci added a comment.Nov 20 2020, 11:11 AM

Build is green

Patch application report for D4525 (id=16098)

Could not rebase; Attempt merge onto cb733dd49a...

Updating cb733dd4..0ef9273d
Fast-forward
 docs/endpoints/collection.rst                      | 17 ++++++---
 docs/endpoints/content.rst                         | 43 ++++++----------------
 docs/endpoints/status.rst                          | 28 +++++++++-----
 swh/deposit/templates/deposit/content.xml          | 21 ++++++-----
 swh/deposit/templates/deposit/deposit_receipt.xml  | 11 +++++-
 swh/deposit/templates/deposit/status.xml           | 16 +++++++-
 swh/deposit/tests/api/test_collection.py           |  6 +--
 .../tests/api/test_collection_post_binary.py       |  6 +++
 .../tests/api/test_deposit_private_check.py        |  2 +-
 swh/deposit/tests/api/test_deposit_schedule.py     |  2 +-
 swh/deposit/tests/api/test_get_file.py             |  4 +-
 swh/deposit/tests/cli/test_client.py               |  7 ----
 .../tests/data/https_deposit.swh.test/1_test       | 10 ++++-
 .../tests/data/https_deposit.test.metadata/1_test  | 10 ++++-
 .../1_test_666_metadata                            |  9 ++++-
 15 files changed, 117 insertions(+), 75 deletions(-)
Changes applied before test
commit 0ef9273dd85904185116d123fdc55be2a3149dc0
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:59:37 2020 +0100

    Move SWH-specific tags to the https://www.softwareheritage.org/schema/2018/deposit namespace
    
    They don't belong in SWORD.
    
    We're keeping the old ones for existing clients, and we will have to
    notify them of the change before removing the old tags.

commit 8ff2e68d8c32ebed6b11f062f643612e6a569725
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:56:39 2020 +0100

    Remove <sword:request>.
    
    Motivation:
    
    1. it is not a SWORD tag
    2. I don't think there is any use for this
    3. Its content is buggy, as it only handles one level of hierarchy for the metadata values.

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

Harbormaster completed remote builds in B17296: Diff 16098.Nov 20 2020, 11:11 AM
swh-public-ci added a comment.Nov 20 2020, 11:14 AM

Build is green

Patch application report for D4525 (id=16099)

Could not rebase; Attempt merge onto cb733dd49a...

Updating cb733dd4..0d7948b2
Fast-forward
 docs/endpoints/collection.rst                      | 17 ++++++---
 docs/endpoints/content.rst                         | 43 ++++++----------------
 docs/endpoints/status.rst                          | 28 +++++++++-----
 swh/deposit/parsers.py                             |  2 +-
 swh/deposit/templates/deposit/content.xml          | 23 ++++++------
 swh/deposit/templates/deposit/deposit_receipt.xml  | 13 ++++++-
 swh/deposit/templates/deposit/error.xml            |  2 +-
 swh/deposit/templates/deposit/status.xml           | 18 ++++++++-
 swh/deposit/tests/api/test_collection.py           |  6 +--
 .../tests/api/test_collection_post_binary.py       |  6 +++
 .../tests/api/test_deposit_private_check.py        |  2 +-
 swh/deposit/tests/api/test_deposit_schedule.py     |  2 +-
 swh/deposit/tests/api/test_get_file.py             |  4 +-
 swh/deposit/tests/cli/test_client.py               |  7 ----
 .../tests/data/https_deposit.swh.test/1_test       | 10 ++++-
 .../tests/data/https_deposit.test.metadata/1_test  | 12 +++++-
 .../1_test_666_metadata                            | 11 +++++-
 .../https_deposit.test.metadata/1_test_666_status  |  2 +-
 .../https_deposit.test.status/1_test_1033_status   |  2 +-
 .../1_test_123_metadata                            |  2 +-
 .../1_test_123_status                              |  2 +-
 .../1_test_321_status                              |  2 +-
 22 files changed, 129 insertions(+), 87 deletions(-)
Changes applied before test
commit 0d7948b2f393f9f3145bb8be34b81313d4c8d86a
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 14:45:21 2020 +0100

    Fix SWORD XMLNS (http://purl.org/net/sword/ -> http://purl.org/net/sword/terms/)

commit 0ef9273dd85904185116d123fdc55be2a3149dc0
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:59:37 2020 +0100

    Move SWH-specific tags to the https://www.softwareheritage.org/schema/2018/deposit namespace
    
    They don't belong in SWORD.
    
    We're keeping the old ones for existing clients, and we will have to
    notify them of the change before removing the old tags.

commit 8ff2e68d8c32ebed6b11f062f643612e6a569725
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:56:39 2020 +0100

    Remove <sword:request>.
    
    Motivation:
    
    1. it is not a SWORD tag
    2. I don't think there is any use for this
    3. Its content is buggy, as it only handles one level of hierarchy for the metadata values.

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

Harbormaster completed remote builds in B17297: Diff 16099.Nov 20 2020, 11:14 AM
swh-public-ci added a comment.Nov 20 2020, 11:26 AM

Build is green

Patch application report for D4525 (id=16103)

Could not rebase; Attempt merge onto cb733dd49a...

Updating cb733dd4..0ef9273d
Fast-forward
 docs/endpoints/collection.rst                      | 17 ++++++---
 docs/endpoints/content.rst                         | 43 ++++++----------------
 docs/endpoints/status.rst                          | 28 +++++++++-----
 swh/deposit/templates/deposit/content.xml          | 21 ++++++-----
 swh/deposit/templates/deposit/deposit_receipt.xml  | 11 +++++-
 swh/deposit/templates/deposit/status.xml           | 16 +++++++-
 swh/deposit/tests/api/test_collection.py           |  6 +--
 .../tests/api/test_collection_post_binary.py       |  6 +++
 .../tests/api/test_deposit_private_check.py        |  2 +-
 swh/deposit/tests/api/test_deposit_schedule.py     |  2 +-
 swh/deposit/tests/api/test_get_file.py             |  4 +-
 swh/deposit/tests/cli/test_client.py               |  7 ----
 .../tests/data/https_deposit.swh.test/1_test       | 10 ++++-
 .../tests/data/https_deposit.test.metadata/1_test  | 10 ++++-
 .../1_test_666_metadata                            |  9 ++++-
 15 files changed, 117 insertions(+), 75 deletions(-)
Changes applied before test
commit 0ef9273dd85904185116d123fdc55be2a3149dc0
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:59:37 2020 +0100

    Move SWH-specific tags to the https://www.softwareheritage.org/schema/2018/deposit namespace
    
    They don't belong in SWORD.
    
    We're keeping the old ones for existing clients, and we will have to
    notify them of the change before removing the old tags.

commit 8ff2e68d8c32ebed6b11f062f643612e6a569725
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:56:39 2020 +0100

    Remove <sword:request>.
    
    Motivation:
    
    1. it is not a SWORD tag
    2. I don't think there is any use for this
    3. Its content is buggy, as it only handles one level of hierarchy for the metadata values.

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

Harbormaster completed remote builds in B17301: Diff 16103.Nov 20 2020, 11:26 AM
ardumont accepted this revision.Nov 20 2020, 11:33 AM

lgtm

This revision is now accepted and ready to land.Nov 20 2020, 11:33 AM
vlorentz updated this revision to Diff 16127.Nov 20 2020, 3:37 PM

rebase

swh-public-ci added a comment.Nov 20 2020, 3:43 PM

Build is green

Patch application report for D4525 (id=16127)

Could not rebase; Attempt merge onto f4b4c25e44...

Updating f4b4c25e..794402c0
Fast-forward
 docs/endpoints/collection.rst                      | 17 ++++++---
 docs/endpoints/content.rst                         | 43 ++++++----------------
 docs/endpoints/status.rst                          | 28 +++++++++-----
 swh/deposit/templates/deposit/content.xml          | 21 ++++++-----
 swh/deposit/templates/deposit/deposit_receipt.xml  | 11 +++++-
 swh/deposit/templates/deposit/status.xml           | 16 +++++++-
 swh/deposit/tests/api/test_collection.py           |  6 +--
 .../tests/api/test_collection_post_binary.py       |  6 +++
 .../tests/api/test_deposit_private_check.py        |  2 +-
 swh/deposit/tests/api/test_deposit_schedule.py     |  2 +-
 swh/deposit/tests/api/test_get_file.py             |  4 +-
 swh/deposit/tests/cli/test_client.py               |  7 ----
 .../tests/data/https_deposit.swh.test/1_test       | 10 ++++-
 .../tests/data/https_deposit.test.metadata/1_test  | 10 ++++-
 .../1_test_666_metadata                            |  9 ++++-
 15 files changed, 117 insertions(+), 75 deletions(-)
Changes applied before test
commit 794402c0f52a312bf53c757b650795f0ceb0e50a
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:59:37 2020 +0100

    Move SWH-specific tags to the https://www.softwareheritage.org/schema/2018/deposit namespace
    
    They don't belong in SWORD.
    
    We're keeping the old ones for existing clients, and we will have to
    notify them of the change before removing the old tags.

commit 405b577f42efdb678aefa044b10599c7d2a1e97b
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 19 13:56:39 2020 +0100

    Remove <sword:request>.
    
    Motivation:
    
    1. it is not a SWORD tag
    2. I don't think there is any use for this
    3. Its content is buggy, as it only handles one level of hierarchy for the metadata values.

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

Harbormaster completed remote builds in B17327: Diff 16127.Nov 20 2020, 3:43 PM
Closed by commit rDDEP794402c0f52a: Move SWH-specific tags to the https://www.softwareheritage. (authored by vlorentz). · Explain WhyNov 20 2020, 4:52 PM
This revision was automatically updated to reflect the committed changes.
vlorentz added a commit: rDDEP794402c0f52a: Move SWH-specific tags to the https://www.softwareheritage..
vlorentz added a task: T2759: Allow the deposit protocol to use SWH tags in the deposit namespace.Nov 27 2020, 4:14 PM

Revision Contents
Changeset List

PathSizeCoverage (All)Coverage (Touched)
swh/
deposit/
2 lines100%
Loading...
templates/
deposit/
2 lines--
2 lines--
2 lines--
2 lines--
tests/
data/
https_deposit.test.metadata/
2 lines--
2 lines--
2 lines--
https_deposit.test.status/
2 lines--
https_deposit.test.updateswhid/
2 lines--
2 lines--
2 lines--

Diff 16099

View Options

swh/deposit/parsers.py

Loading...
View Options

swh/deposit/templates/deposit/content.xml

Loading...
View Options

swh/deposit/templates/deposit/deposit_receipt.xml

Loading...
View Options

swh/deposit/templates/deposit/error.xml

Loading...
View Options

swh/deposit/templates/deposit/status.xml

Loading...
View Options

swh/deposit/tests/data/https_deposit.test.metadata/1_test

Loading...
View Options

swh/deposit/tests/data/https_deposit.test.metadata/1_test_666_metadata

Loading...
View Options

swh/deposit/tests/data/https_deposit.test.metadata/1_test_666_status

Loading...
View Options

swh/deposit/tests/data/https_deposit.test.status/1_test_1033_status

Loading...
View Options

swh/deposit/tests/data/https_deposit.test.updateswhid/1_test_123_metadata

Loading...
View Options

swh/deposit/tests/data/https_deposit.test.updateswhid/1_test_123_status

Loading...
View Options

swh/deposit/tests/data/https_deposit.test.updateswhid/1_test_321_status

Loading...
About · Developer information · Legal