Page MenuHomeSoftware Heritage
Differential D4834

deposit.client.cli: Expose --create-origin flag and deprecate --slug
ClosedPublic
Actions

Authored by ardumont on Jan 11 2021, 2:00 PM.

Details

Reviewers
vlorentz
moranegg
Group Reviewers
Reviewers
Maniphest Tasks
T2860: Change parameter `slug` in swh-deposit cli to `create_origin`
Commits
rDDEP2c47667ab625: deposit.client.cli: Expose --create-origin flag and deprecate --slug
Summary

The --slug behavior is marked as deprecated but still usable. The new --create-origin
flag allows to generate the proper xml stanza when the client does not provide any
metadata xml file.

Related to T2860

Test Plan

tox

Diff Detail

Repository
rDDEP Push deposit
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

ardumont created this revision.Jan 11 2021, 2:00 PM
swh-public-ci added a comment.Jan 11 2021, 2:02 PM

Build is green

Patch application report for D4834 (id=17126)

Rebasing onto 83a5ded409...

Current branch diff-target is up to date.
Changes applied before test
commit fecd951e9d0ea1d8ead230ab4d1a1deb0fa85743
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Mon Jan 11 13:58:04 2021 +0100

    deposit.client.cli: Expose --create-origin flag and deprecate --slug
    
    Related to T2860

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

Harbormaster completed remote builds in B18270: Diff 17126.Jan 11 2021, 2:02 PM
ardumont requested review of this revision.Jan 11 2021, 2:02 PM
vlorentz requested changes to this revision.Jan 11 2021, 4:05 PM

missing tests

swh/deposit/cli/client.py
432–436

this one should be an error

This revision now requires changes to proceed.Jan 11 2021, 4:05 PM
ardumont updated this revision to Diff 17145.Jan 12 2021, 1:47 PM
  • Add tests
  • Generate proper xml stanza for the --create-origin flag
  • Improve commit message
ardumont edited the summary of this revision. (Show Details)Jan 12 2021, 1:47 PM
swh-public-ci added a comment.Jan 12 2021, 1:50 PM

Build is green

Patch application report for D4834 (id=17145)

Rebasing onto 82a26b5e86...

Current branch diff-target is up to date.
Changes applied before test
commit 40e04b73519a74eada25844fdf3375bd8bdbaab4
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Mon Jan 11 13:58:04 2021 +0100

    deposit.client.cli: Expose --create-origin flag and deprecate --slug
    
    The --slug behavior is marked as deprecated but still usable. The new --create-origin
    flag allows to generate the proper xml stanza when the client does not provide any
    metadata xml file.
    
    Related to T2860

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

Harbormaster completed remote builds in B18289: Diff 17145.Jan 12 2021, 1:50 PM
ardumont updated this revision to Diff 17146.Jan 12 2021, 1:51 PM

Update --create-origin flag docstring

swh-public-ci added a comment.Jan 12 2021, 1:54 PM

Build is green

Patch application report for D4834 (id=17146)

Rebasing onto 82a26b5e86...

Current branch diff-target is up to date.
Changes applied before test
commit 565bb8fefeeb25acb03fbc5be780e8a14a191b4f
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Mon Jan 11 13:58:04 2021 +0100

    deposit.client.cli: Expose --create-origin flag and deprecate --slug
    
    The --slug behavior is marked as deprecated but still usable. The new --create-origin
    flag allows to generate the proper xml stanza when the client does not provide any
    metadata xml file.
    
    Related to T2860

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

Harbormaster completed remote builds in B18290: Diff 17146.Jan 12 2021, 1:54 PM
vlorentz added inline comments.Jan 14 2021, 10:30 AM
swh/deposit/cli/client.py
113

?

ardumont updated this revision to Diff 17203.Jan 14 2021, 10:33 AM

Drop duplicated xmlns:codemeta header introduced by mistake

(that must have been my initial attempt to add the xmlns:swh header which started as a
duplicate)

ardumont marked an inline comment as done.Jan 14 2021, 10:34 AM
ardumont added inline comments.
swh/deposit/cli/client.py
113

indeed, fixed.

swh-public-ci added a comment.Jan 14 2021, 10:36 AM

Build is green

Patch application report for D4834 (id=17203)

Rebasing onto 82a26b5e86...

Current branch diff-target is up to date.
Changes applied before test
commit 89fa88ab697afc8d0c2e6d2654cf91a81638ab86
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Mon Jan 11 13:58:04 2021 +0100

    deposit.client.cli: Expose --create-origin flag and deprecate --slug
    
    The --slug behavior is marked as deprecated but still usable. The new --create-origin
    flag allows to generate the proper xml stanza when the client does not provide any
    metadata xml file.
    
    Related to T2860

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

Harbormaster completed remote builds in B18346: Diff 17203.Jan 14 2021, 10:36 AM
vlorentz accepted this revision.Jan 14 2021, 12:13 PM
This revision is now accepted and ready to land.Jan 14 2021, 12:13 PM
ardumont updated this revision to Diff 17211.Jan 14 2021, 1:23 PM
ardumont marked an inline comment as done.

Rebase

swh-public-ci added a comment.Jan 14 2021, 1:25 PM

Build is green

Patch application report for D4834 (id=17211)

Rebasing onto 38788d907c...

Current branch diff-target is up to date.
Changes applied before test
commit 2c47667ab6257aed298baff0330a6e5ee1e0ac26
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Mon Jan 11 13:58:04 2021 +0100

    deposit.client.cli: Expose --create-origin flag and deprecate --slug
    
    The --slug behavior is marked as deprecated but still usable. The new --create-origin
    flag allows to generate the proper xml stanza when the client does not provide any
    metadata xml file.
    
    Related to T2860

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

Harbormaster completed remote builds in B18355: Diff 17211.Jan 14 2021, 1:25 PM
ardumont added a comment.Jan 15 2021, 9:14 AM

@vlorentz @moranegg

That diff annoyed me a bit. It felt incomplete so far without pinpointing exactly the issue.
I think i grok it now.

It deprecates the --slug behavior by telling it as much through a warning. So the behavior is kept.
It introduces a new --create-origin which "only" allows to generate the <create_origin>
stanza when users do not provide the xml themselves.

That's what feels incomplete. That leaves totally alone the current users which do provide their xml.
I don't really know how to take care of that part though.

any thought on whether we want to take care of this at all? And if so, how to properly do it?

Thanks for the input.

Cheers,

vlorentz added a comment.Jan 15 2021, 9:34 AM

You can make an other diff to make the client parse the XML and check if there is <swh:create_origin>/<swh:add_to_origin> in it; and show a warning if there isn't.

ardumont added a comment.Jan 15 2021, 10:26 AM

You can make an other diff to make the client parse the XML and check if there is <swh:create_origin>/<swh:add_to_origin> in it; and show a warning if there isn't.

sounds good, thanks.

Closed by commit rDDEP2c47667ab625: deposit.client.cli: Expose --create-origin flag and deprecate --slug (authored by ardumont). · Explain WhyJan 15 2021, 1:32 PM
This revision was automatically updated to reflect the committed changes.
ardumont added a commit: rDDEP2c47667ab625: deposit.client.cli: Expose --create-origin flag and deprecate --slug.
ardumont mentioned this in T2860: Change parameter `slug` in swh-deposit cli to `create_origin`.Jan 15 2021, 1:34 PM

Revision Contents
Changeset List

PathSize
swh/
deposit/
cli/
64 lines
tests/
cli/
76 lines

Diff 17259

View Options

swh/deposit/cli/client.py

Loading...
View Options

swh/deposit/tests/cli/test_client.py

Loading...
About · Developer information · Legal