Page MenuHomeSoftware Heritage
Differential D4258

deposit-delete-chart: Clarify sequence diagram
ClosedPublic
Actions

Authored by ardumont on Oct 14 2020, 3:06 PM.

Details

Reviewers
vlorentz
Group Reviewers
Reviewers
Maniphest Tasks
T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml
Commits
rDDEP4ee6ab25853c: deposit-delete-chart: Clarify sequence diagram
Summary

There is no need for the while loop in there.

Also the status 'ready' does not exist, it's name 'deposited' status.

This drops the deprecated png file and integrate the svg output instead.

Related to T2618

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.Oct 14 2020, 3:06 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptOct 14 2020, 3:06 PM
swh-public-ci added a comment.Oct 14 2020, 3:15 PM

Build is green

Patch application report for D4258 (id=15046)

Could not rebase; Attempt merge onto 2f5300e60a...

Updating 2f5300e6..e40e295f
Fast-forward
 docs/images/.gitignore               |   2 +-
 docs/images/deposit-delete-chart.png | Bin 56979 -> 0 bytes
 docs/images/deposit-delete-chart.svg |  45 +++++
 docs/images/deposit-delete-chart.uml |  29 ++--
 docs/images/deposit-update-chart.png | Bin 61584 -> 0 bytes
 docs/images/deposit-update-chart.svg |  51 ++++++
 docs/images/deposit-update-chart.uml |  20 ++-
 swh/deposit/api/deposit_update.py    |  24 +++
 swh/deposit/cli/admin.py             |  80 +++++----
 swh/deposit/tests/cli/conftest.py    |  12 ++
 swh/deposit/tests/cli/test_admin.py  | 317 +++++++++++++++++++++++++++++++++++
 swh/deposit/tests/cli/test_client.py |   8 +-
 12 files changed, 519 insertions(+), 69 deletions(-)
 delete mode 100644 docs/images/deposit-delete-chart.png
 create mode 100644 docs/images/deposit-delete-chart.svg
 delete mode 100644 docs/images/deposit-update-chart.png
 create mode 100644 docs/images/deposit-update-chart.svg
 create mode 100644 swh/deposit/tests/cli/conftest.py
 create mode 100644 swh/deposit/tests/cli/test_admin.py
Changes applied before test
commit e40e295ff31e9109b0c137256487d37cb8920230
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:55:15 2020 +0200

    deposit-delete-chart: Clarify schema
    
    There is no need for the while loop in there.
    Also the status ready does not exist, it's name 'deposited' status.

commit 1abb2dc63e3a7a7e085b6773c09c13339d80a90c
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:54:30 2020 +0200

    deposit-update-chart: Clarify schema
    
    There is no need for the while loop in there

commit 34e710d07e88bb18e63a035e594a0bff7675b927
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 12:40:03 2020 +0200

    cli.admin: Add remaining coverage on `swh deposit reschedule` cli

commit 06f437255a222dbd42d788f6f143366ce1b41979
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 11:44:08 2020 +0200

    Add validation step after metadata ingestion of a metadata-only deposit
    
    Related to T2681

commit 51446a11df5cbd6608b282135ea5f2ff30791397
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Tue Oct 13 14:59:50 2020 +0200

    deposit.cli.admin: Add types and coverage on module
    
    This will allow to be more confident when we will refactor the configuration
    part.

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

Harbormaster completed remote builds in B16273: Diff 15046.Oct 14 2020, 3:15 PM
ardumont edited the summary of this revision. (Show Details)Oct 14 2020, 3:22 PM
ardumont edited the summary of this revision. (Show Details)Oct 14 2020, 3:26 PM
ardumont added a task: T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml.
ardumont updated this revision to Diff 15054.Oct 14 2020, 4:31 PM

Rebase

swh-public-ci added a comment.Oct 14 2020, 4:36 PM

Build is green

Patch application report for D4258 (id=15054)

Could not rebase; Attempt merge onto 4bb8a36d7a...

Updating 4bb8a36d..080ced79
Fast-forward
 docs/images/.gitignore               |   2 +-
 docs/images/deposit-delete-chart.png | Bin 56979 -> 0 bytes
 docs/images/deposit-delete-chart.svg |  45 +++++++++++++++++++++++++++++++
 docs/images/deposit-delete-chart.uml |  29 +++++++++-----------
 docs/images/deposit-update-chart.png | Bin 61584 -> 0 bytes
 docs/images/deposit-update-chart.svg |  51 +++++++++++++++++++++++++++++++++++
 docs/images/deposit-update-chart.uml |  20 +++++++-------
 swh/deposit/api/deposit_update.py    |  24 +++++++++++++++++
 8 files changed, 144 insertions(+), 27 deletions(-)
 delete mode 100644 docs/images/deposit-delete-chart.png
 create mode 100644 docs/images/deposit-delete-chart.svg
 delete mode 100644 docs/images/deposit-update-chart.png
 create mode 100644 docs/images/deposit-update-chart.svg
Changes applied before test
commit 080ced795c5aab33ab77a67ab7b44aafc73d5107
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:55:15 2020 +0200

    deposit-delete-chart: Clarify schema
    
    There is no need for the while loop in there.
    Also the status ready does not exist, it's name 'deposited' status.

commit e39814c4af487fca889106b6cfe223b00f7672b7
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:54:30 2020 +0200

    deposit-update-chart: Clarify schema
    
    There is no need for the while loop in there

commit 92634764f00a0c561523f4fed8073cd9132a5c81
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 11:44:08 2020 +0200

    Add validation step after metadata ingestion of a metadata-only deposit
    
    Related to T2681

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

Harbormaster completed remote builds in B16281: Diff 15054.Oct 14 2020, 4:37 PM
vlorentz requested changes to this revision.Oct 15 2020, 10:26 AM
vlorentz added a subscriber: vlorentz.

same comments as D4257

This revision now requires changes to proceed.Oct 15 2020, 10:26 AM
vlorentz added a comment.EditedOct 15 2020, 10:27 AM

and you should update blueprint.rst, so it stops mentioning the "ready" status as well

EDIT: nvm, I just saw D4260

ardumont updated this revision to Diff 15068.Oct 15 2020, 10:45 AM
  • Drop svg
  • Rework commit message
swh-public-ci added a comment.Oct 15 2020, 10:48 AM

Build is green

Patch application report for D4258 (id=15068)

Rebasing onto 4bb8a36d7a...

Current branch diff-target is up to date.
Changes applied before test
commit 2576c73a490956b8fd0c9573af504dbfb7ebdadf
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:55:15 2020 +0200

    deposit-delete-chart: Clarify schema
    
    There is no loop, either the status is partial, either it's not. Removing it
    clarifies the reading.
    
    This drops the out-of-sync png diagram from the repository. This also renames
    the inexistent `ready` status to the correct 'deposited' status.

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

Harbormaster completed remote builds in B16294: Diff 15068.Oct 15 2020, 10:48 AM
vlorentz requested changes to this revision.Oct 15 2020, 11:33 AM

first line of the commit msg still says "schema"

This revision now requires changes to proceed.Oct 15 2020, 11:33 AM
ardumont updated this revision to Diff 15075.Oct 15 2020, 11:41 AM

Rework commit message (which i modified the body of but not the title ¯\_(ツ)_/¯)

and of course, it's the base commit for all other diffs, *for crying out loud* ;)

swh-public-ci added a comment.Oct 15 2020, 11:44 AM

Build is green

Patch application report for D4258 (id=15075)

Rebasing onto 4bb8a36d7a...

Current branch diff-target is up to date.
Changes applied before test
commit 4ee6ab25853c1eb3eb9f10763a4c2f48bfd30696
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Wed Oct 14 14:55:15 2020 +0200

    deposit-delete-chart: Clarify sequence diagram
    
    There is no loop, either the status is partial, either it's not. Removing it
    clarifies the reading.
    
    This drops the out-of-sync png diagram from the repository. This also renames
    the inexistent `ready` status to the correct 'deposited' status.

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

Harbormaster completed remote builds in B16301: Diff 15075.Oct 15 2020, 11:44 AM
ardumont retitled this revision from deposit-delete-chart: Clarify schema to deposit-delete-chart: Clarify sequence diagram.Oct 15 2020, 1:25 PM
vlorentz accepted this revision.Oct 15 2020, 2:02 PM
This revision is now accepted and ready to land.Oct 15 2020, 2:02 PM
Closed by commit rDDEP4ee6ab25853c: deposit-delete-chart: Clarify sequence diagram (authored by ardumont). · Explain WhyOct 15 2020, 2:25 PM
This revision was automatically updated to reflect the committed changes.
ardumont added a commit: rDDEP4ee6ab25853c: deposit-delete-chart: Clarify sequence diagram.

Revision Contents
Changeset List

Diff 15087

View Options

docs/images/.gitignore

Loading...
View Options

docs/images/deposit-delete-chart.png

Loading...
View Options

docs/images/deposit-delete-chart.uml

Loading...
About · Developer information · Legal