diff --git a/docs/images/status.png b/docs/images/status.png new file mode 100644 index 00000000..00137fff Binary files /dev/null and b/docs/images/status.png differ diff --git a/docs/specs/spec-loading.rst b/docs/specs/spec-loading.rst index 4aeebdbc..6173bb0e 100644 --- a/docs/specs/spec-loading.rst +++ b/docs/specs/spec-loading.rst @@ -1,320 +1,427 @@ Loading specification ===================== -This part specifies the ingestion of the deposit in the SWH archive, using +AN important part of the deposit specifications is the loading procedure whereas +a deposit is ingested into the Software Heritage (archive), using the tarball loader and the complete schema of software artifacts creation in the archive. Tarball Loading --------------- The ``swh-loader-tar`` module is already able to inject tarballs in swh with very limited metadata (mainly the origin). The loading of the deposit will use the deposit's associated data: * the metadata * the archive(s) -SWH artifacts creation +Artifacts creation ---------------------- Deposit to artifacts mapping ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This is a global view of the deposit ingestion -+-----------------------------------+----------------------------------------+ -|swh artifact | representation in deposit | -+===================================+========================================+ -|origin | https://hal.inria.fr/hal-id | -+-----------------------------------+----------------------------------------+ -|origin_visit | 1 :reception_date | -+-----------------------------------+----------------------------------------+ -|origin_metadata | aggregated metadata | -+-----------------------------------+----------------------------------------+ -|snapshot | at visit of all occurences | -+-----------------------------------+----------------------------------------+ -|occurrence & occurrence_history | branch: client's version n° (e.g hal) | -+-----------------------------------+----------------------------------------+ -|revision | synthetic_revision (tarball) | -+-----------------------------------+----------------------------------------+ -|directory | upper level of the uncompressed archive| -+-----------------------------------+----------------------------------------+ ++------------------------------------+-----------------------------------------+ +| swh artifact | representation in deposit | ++====================================+=========================================+ +| origin | https://hal.inria.fr/hal-id | ++------------------------------------+-----------------------------------------+ +| origin_metadata | aggregated metadata | ++------------------------------------+-----------------------------------------+ +| snapshot | reception of all occurrences (branches) | ++------------------------------------+-----------------------------------------+ +| branches | master & | +| | branch (optional): tag to release | ++------------------------------------+-----------------------------------------+ +| release | (optional) synthetic release created | +| | from metadata | ++------------------------------------+-----------------------------------------+ +| revision | synthetic revision pointing to | +| | the expanded submitted tarball | ++------------------------------------+-----------------------------------------+ +| directory | root directory of the expanded submitted| +| | tarball | ++------------------------------------+-----------------------------------------+ Origin artifact ~~~~~~~~~~~~~~~~ -An origin using the url in the deposited metadata is created. +We create an origin using the url in the deposited metadata. The current deposit and future deposits with the same url or external_id -will be associated with this origin. +will be associated to this origin. .. code-block:: json - { + origin: { "id": 89283768, "origin_visits_url": "/api/1/origin/89283768/visits/", "type": "deposit", "url": "https://hal.archives-ouvertes.fr/hal-02140606" } Visits ~~~~~~~ -Each push of the same origin or external_id will generate a visit of the origin. +We identify with a visit each deposit push of the same external_id. Here in the example below, two snapshots are identified by two different visits. .. code-block:: json - [ + visits: [ { "date": "2019-06-03T09:28:10.223007+00:00", "origin": 89283768, "origin_visit_url": "/api/1/origin/89283768/visit/2/", "snapshot": "a3773941561cc557853898773a19c07cfe2efc5a", "snapshot_url": "/api/1/snapshot/a3773941561cc557853898773a19c07cfe2efc5a/", "status": "full", "type": "deposit", "visit": 2 }, { "date": "2019-05-27T12:23:31.037273+00:00", "origin": 89283768, "origin_visit_url": "/api/1/origin/89283768/visit/1/", "snapshot": "43fdb8291f1bf6962211c370e394f6abb1cbe01d", "snapshot_url": "/api/1/snapshot/43fdb8291f1bf6962211c370e394f6abb1cbe01d/", "status": "full", "type": "deposit", "visit": 1 } ] Snapshot artifact ~~~~~~~~~~~~~~~~ -The snapshot represents one deposit push. +The snapshot represents one deposit push. The master branch points to a +synthetic revision. We will create a second branch pointing to a release +artifact, if the indicate that the deposit is a release with a `releaseNotes`. .. code-block:: json - { + snapshot: { "branches": { "master": { "target": "396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52", "target_type": "revision", "target_url": "/api/1/revision/396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52/" } + "refs/tags/v1.1": { + "target": "a9f3396f372ed4a51d75e15ca16c1c2df1fc5c97", + "target_type": "release", + "target_url": "/api/1/release/a9f3396f372ed4a51d75e15ca16c1c2df1fc5c97/" + } }, "id": "a3773941561cc557853898773a19c07cfe2efc5a", "next_branch": null } -Revision artifact +Release artifact ~~~~~~~~~~~~~~~~ -A ``synthetic`` revision is created because the deposit is not a commit and -is created by the ``swh-loader-tar`` module. +The content is deposited with a set of descriptive metadata in the CodeMeta +vocabulary. The following CodeMeta terms implies that the +artifact is a release: + +- `releaseNotes` +- `softwareVersion` + +If present, a release artifact will be created with the mapping below: + ++-------------------+-----------------------------------+-----------------+----------------+ +| SWH release field | Description | CodeMeta term | Fallback value | ++===================+===================================+=================+================+ +| target | revision containing all metadata | X |X | ++-------------------+-----------------------------------+-----------------+----------------+ +| target_type | revision | X |X | ++-------------------+-----------------------------------+-----------------+----------------+ +| name | release or tag name (mandatory) | softwareVersion | X | ++-------------------+-----------------------------------+-----------------+----------------+ +| message | message associated with release | releaseNotes | X | ++-------------------+-----------------------------------+-----------------+----------------+ +| date | release date = publication date | datePublished | deposit_date | ++-------------------+-----------------------------------+-----------------+----------------+ +| author | deposit client | author | client | ++-------------------+-----------------------------------+-----------------+----------------+ -The metadata sent with the deposit will be included in the revision and will -affect the hash computation, thus resulting in a unique identifier. -This way, by depositing the same content with different metadata will be two -different revisions in the archive. .. code-block:: json - { - "author": { - "email": "robot@softwareheritage.org", - "fullname": "Software Heritage", - "id": 18233048, - "name": "Software Heritage" - }, - "author_url": "/api/1/person/18233048/", - "committer": { - "email": "robot@softwareheritage.org", - "fullname": "Software Heritage", - "id": 18233048, - "name": "Software Heritage" - }, - "committer_date": "2019-05-27T16:28:33+02:00", - "committer_url": "/api/1/person/18233048/", - "date": "2012-01-01T00:00:00+00:00", - "directory": "fb13b51abbcfd13de85d9ba8d070a23679576cd7", - "directory_url": "/api/1/directory/fb13b51abbcfd13de85d9ba8d070a23679576cd7/", - "history_url": "/api/1/revision/396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52/log/", - "id": "396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52", - "merge": false, - "message": "hal: Deposit 282 in collection hal", - "metadata": { - "@xmlns": "http://www.w3.org/2005/Atom", - "@xmlns:codemeta": "https://doi.org/10.5063/SCHEMA/CODEMETA-2.0", - "author": { - "email": "hal@ccsd.cnrs.fr", - "name": "HAL" - }, - "client": "hal", - "codemeta:applicationCategory": "info", - "codemeta:author": { - "codemeta:name": "Morane Gruenpeter" - }, - "codemeta:codeRepository": "www.code-repository.com", - "codemeta:contributor": "Morane Gruenpeter", - "codemeta:dateCreated": "2012", - "codemeta:datePublished": "2019-05-27T16:28:33+02:00", - "codemeta:description": "description\\_en test v2", - "codemeta:developmentStatus": "Inactif", - "codemeta:keywords": "mot_cle_en,mot_cle_2_en,mot_cle_fr", - "codemeta:license": [ - { - "codemeta:name": "MIT License" - }, - { - "codemeta:name": "CeCILL Free Software License Agreement v1.1" - } - ], - "codemeta:name": "Test\\_20190527\\_01", - "codemeta:operatingSystem": "OS", - "codemeta:programmingLanguage": "Java", - "codemeta:referencePublication": null, - "codemeta:relatedLink": null, - "codemeta:releaseNotes": "releaseNote", - "codemeta:runtimePlatform": "outil", - "codemeta:softwareVersion": "1.0.1", - "codemeta:url": "https://hal.archives-ouvertes.fr/hal-02140606", - "codemeta:version": "2", - "external_identifier": "hal-02140606", - "id": "hal-02140606", - "original_artifact": [ - { - "archive_type": "zip", - "blake2s256": "96be3ddedfcee9669ad9c42b0bb3a706daf23824d04311c63505a4d8db02df00", - "length": 193072, - "name": "archive.zip", - "sha1": "5b6ecc9d5bb113ff69fc275dcc9b0d993a8194f1", - "sha1_git": "bd10e4d3ede17162692d7e211e08e87e67994488", - "sha256": "3e2ce93384251ce6d6da7b8f2a061a8ebdaf8a28b8d8513223ca79ded8a10948" - } - ] - }, - "parents": [ - { - "id": "a9fdc3937d2b704b915852a64de2ab1b4b481003", - "url": "/api/1/revision/a9fdc3937d2b704b915852a64de2ab1b4b481003/" - } - ], - "synthetic": true, - "type": "tar", - "url": "/api/1/revision/396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52/" + release: { + "author": { + "email": "hal@ccsd.cnrs.fr", + "fullname": "HAL ", + "id": x, + "name": "HAL" + }, + "author_url": "/api/1/person/x/", + "date": "2019-05-27T16:28:33+02:00", + "id": "a9f3396f372ed4a51d75e15ca16c1c2df1fc5c97", + "message": "AffectationRO Version 1.1 - added new feature\n", + "name": "1.1", + "synthetic": true, + "target": "396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52", + "target_type": "revision", + "target_url": "/api/1/revision/396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52/" } + +Revision artifact +~~~~~~~~~~~~~~~~ +The metadata sent with the deposit is included in the revision which affects +the hash computation, thus resulting in a unique identifier. +This way, by depositing the same content with different metadata, will result +in two different revisions in the SWH archive. + +The date mapping +^^^^^^^^^^^^^^^ +A deposit may contain 4 different dates concerning the software artifacts. + +The deposit's revision will reflect the most accurate point in time available. +Here are all dates that can be available in a deposit: + ++-------------------+-----------------------------------+-----------------------------------------------+ +| dates | location | Description | ++===================+===================================+===============================================+ +| reception_date | On SWORD reception (automatic) |the deposit was received at this ts | ++-------------------+-----------------------------------+-----------------------------------------------+ +| complete_date | On SWH ingestion (automatic) |the ingestion was completed by SWH at this ts | ++-------------------+-----------------------------------+-----------------------------------------------+ +| dateCreated | metadata in codeMeta (optional) |the software artifact was created at this ts | ++-------------------+-----------------------------------+----------------------+------------------------+ +| datePublished | metadata in codeMeta (optional) |the software was published (contributed in HAL)| ++-------------------+-----------------------------------+----------------------+------------------------+ + +A visit targeting a snapshot contains one date: + ++-------------------+----------------------------------------------+----------------+ +| SWH visit field | Description | value | ++===================+==============================================+================+ +| date | the origin pushed the deposit at this date | reception_date | ++-------------------+----------------------------------------------+----------------+ + +A revision contains two dates: + ++-------------------+-----------------------------------------+----------------+----------------+ +| SWH revision field| Description | CodeMeta term | Fallback value | ++===================+=========================================+================+================+ +| date | date of software artifact modification | dateCreated | reception_date | ++-------------------+-----------------------------------------+----------------+----------------+ +| committer_date | date of the commit in VCS | datePublished | reception_date | ++-------------------+-----------------------------------------+----------------+----------------+ + + +A release contains one date: + ++-------------------+----------------------------------+---------------+----------------+ +| SWH release field |Description |CodeMeta term | Fallback value | ++===================+==================================+===============+================+ +| date |release date = publication date |datePublished |reception_date | ++-------------------+----------------------------------+---------------+----------------+ + + +.. code-block:: json + + revision: { + "author": { + "email": "robot@softwareheritage.org", + "fullname": "Software Heritage", + "id": 18233048, + "name": "Software Heritage" + }, + "author_url": "/api/1/person/18233048/", + "committer": { + "email": "robot@softwareheritage.org", + "fullname": "Software Heritage", + "id": 18233048, + "name": "Software Heritage" + }, + "committer_date": "2019-05-27T16:28:33+02:00", + "committer_url": "/api/1/person/18233048/", + "date": "2012-01-01T00:00:00+00:00", + "directory": "fb13b51abbcfd13de85d9ba8d070a23679576cd7", + "directory_url": "/api/1/directory/fb13b51abbcfd13de85d9ba8d070a23679576cd7/", + "history_url": "/api/1/revision/396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52/log/", + "id": "396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52", + "merge": false, + "message": "hal: Deposit 282 in collection hal", + "metadata": { + "@xmlns": "http://www.w3.org/2005/Atom", + "@xmlns:codemeta": "https://doi.org/10.5063/SCHEMA/CODEMETA-2.0", + "author": { + "email": "hal@ccsd.cnrs.fr", + "name": "HAL" + }, + "client": "hal", + "codemeta:applicationCategory": "info", + "codemeta:author": { + "codemeta:name": "Morane Gruenpeter" + }, + "codemeta:codeRepository": "www.code-repository.com", + "codemeta:contributor": "Morane Gruenpeter", + "codemeta:dateCreated": "2012", + "codemeta:datePublished": "2019-05-27T16:28:33+02:00", + "codemeta:description": "description\\_en test v2", + "codemeta:developmentStatus": "Inactif", + "codemeta:keywords": "mot_cle_en,mot_cle_2_en,mot_cle_fr", + "codemeta:license": [ + { + "codemeta:name": "MIT License" + }, + { + "codemeta:name": "CeCILL Free Software License Agreement v1.1" + } + ], + "codemeta:name": "Test\\_20190527\\_01", + "codemeta:operatingSystem": "OS", + "codemeta:programmingLanguage": "Java", + "codemeta:referencePublication": null, + "codemeta:relatedLink": null, + "codemeta:releaseNotes": "releaseNote", + "codemeta:runtimePlatform": "outil", + "codemeta:softwareVersion": "1.0.1", + "codemeta:url": "https://hal.archives-ouvertes.fr/hal-02140606", + "codemeta:version": "2", + "external_identifier": "hal-02140606", + "id": "hal-02140606", + "original_artifact": [ + { + "archive_type": "zip", + "blake2s256": "96be3ddedfcee9669ad9c42b0bb3a706daf23824d04311c63505a4d8db02df00", + "length": 193072, + "name": "archive.zip", + "sha1": "5b6ecc9d5bb113ff69fc275dcc9b0d993a8194f1", + "sha1_git": "bd10e4d3ede17162692d7e211e08e87e67994488", + "sha256": "3e2ce93384251ce6d6da7b8f2a061a8ebdaf8a28b8d8513223ca79ded8a10948" + } + ] + }, + "parents": [ + { + "id": "a9fdc3937d2b704b915852a64de2ab1b4b481003", + "url": "/api/1/revision/a9fdc3937d2b704b915852a64de2ab1b4b481003/" + } + ], + "synthetic": true, + "type": "tar", + "url": "/api/1/revision/396b1ff29f7c75a0a3cc36f30e24ff7bae70bb52/" + } + Directory artifact ~~~~~~~~~~~~~~~~ -The directory artifact is the actual content deposited. +The directory artifact is the archive(s)' raw content deposited. .. code-block:: json - [ + directory: [ { "dir_id": "fb13b51abbcfd13de85d9ba8d070a23679576cd7", "length": null, "name": "AffectationRO", "perms": 16384, "target": "fbc418f9ac2c39e8566b04da5dc24b14e65b23b1", "target_url": "/api/1/directory/fbc418f9ac2c39e8566b04da5dc24b14e65b23b1/", "type": "dir" } ] Questions raised concerning loading ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - A deposit has one origin, yet an origin can have multiple deposits? No, an origin can have multiple requests for the same deposit. Which should end up in one single deposit (when the client pushes its final request saying deposit 'done' through the header In-Progress). Only update of existing 'partial' deposit is permitted. Other than that, the deposit 'update' operation. To create a new version of a software (already deposited), the client must prior to this create a new deposit. Illustration First deposit loading: HAL's deposit 01535619 = SWH's deposit **01535619-1** :: + 1 origin with url:https://hal.inria.fr/medihal-01535619 + 1 synthetic revision + 1 directory HAL's update on deposit 01535619 = SWH's deposit **01535619-2** (\*with HAL updates can only be on the metadata and a new version is required if the content changes) :: + 1 origin with url:https://hal.inria.fr/medihal-01535619 + new synthetic revision (with new metadata) + same directory HAL's deposit 01535619-v2 = SWH's deposit **01535619-v2-1** :: + same origin + new revision + new directory Scheduling loading ~~~~~~~~~~~~~~~~~~ All ``archive`` and ``metadata`` deposit requests should be aggregated before loading. The loading should be scheduled via the scheduler's api. Only ``deposited`` deposit are concerned by the loading. -When the loading is done and successful, the deposit entry is updated: - -``status`` is updated to ``done`` - ``swh-id`` is populated with the resulting -hash (cf. `swh identifier <#swh-identifier-returned>`__) - ``complete_date`` is -updated to the loading's finished time +When the loading is done and successful, the deposit entry is updated: + + - ``status`` is updated to ``done`` + - ``swh-id`` is populated with the resulting `SWH persistent identifier `_ + - ``complete_date`` is updated to the loading's finished time -When the loading is failed, the deposit entry is updated: - ``status`` is -updated to ``failed`` - ``swh-id`` and ``complete_data`` remains as is +When the loading has failed, the deposit entry is updated: + - ``status`` is updated to ``failed`` + - ``swh-id`` and ``complete_data`` remains as is *Note:* As a further improvement, we may prefer having a retry policy with graceful delays for further scheduling. Metadata loading ~~~~~~~~~~~~~~~~ -- the metadata received with the deposit are also kept in the - ``origin_metadata`` table before translation as part of the loading process - and an indexation process should be scheduled. +- the metadata received with the deposit are kept in the `metadata` fields + of the revision and in the ```origin_metadata`` table to facilitate search + over origin metadata. - provider\_id and tool\_id are resolved by the prepare\_metadata method in the loader-core - the origin\_metadata entry is sent to storage by the send\_origin\_metadata in the loader-core origin\_metadata table: :: id bigint PK origin bigint discovery_date date provider_id bigint FK // (from provider table) tool_id bigint FK // indexer_configuration_id tool used for extraction metadata jsonb // before translation diff --git a/docs/specs/spec-technical.rst b/docs/specs/spec-technical.rst index 45177365..d1111b8a 100644 --- a/docs/specs/spec-technical.rst +++ b/docs/specs/spec-technical.rst @@ -1,81 +1,100 @@ Technical specifications ======================== Requirements ~~~~~~~~~~~~ * one dedicated database to store the deposit's state - swh-deposit -* one dedicated temporary objstorage to store archives before loading +* one dedicated temporary storage to store archives before loading * one client to test the communication with SWORD protocol Deposit reception schema ~~~~~~~~~~~~~~~~~~~~~~~~ * SWORD imposes the use of basic authentication, so we need a way to authenticate client. Also, a client can access collections: - **deposit\_client** table: - id (bigint): Client's identifier - username - (str): Client's username - password (pass): Client's crypted password - - collections ([id]): List of collections the client can access + **deposit\_client** table: + + - id (bigint): Client's identifier + - username (str): Client's username + - password (pass): Client's encrypted password + - collections ([id]): List of collections the client can access * Collections group deposits together: - **deposit\_collection** table: - id (bigint): Collection's identifier - name - (str): Collection's human readable name + **deposit\_collection** table: + + - id (bigint): Collection's identifier + - name (str): Collection's human readable name * A deposit is the main object the repository is all about: **deposit** table: - * id (bigint): deposit's identifier - * reception\_date (date): First deposit's reception date - * complete\_data (date): Date when the deposit is deemed complete and ready + - id (bigint): deposit's identifier + - reception\_date (date): First deposit's reception date + - complete\_data (date): Date when the deposit is deemed complete and ready for loading - * collection (id): The collection the deposit belongs to - * external id (text): client's internal identifier (e.g hal's id, etc...). - * client\_id (id) : Client which did the deposit - * swh\_id (str) : swh identifier result once the loading is complete - * status (enum): The deposit's current status + - collection (id): The collection the deposit belongs to + - external id (text): client's internal identifier (e.g hal's id, etc...). + - client\_id (id) : Client which did the deposit + - swh\_id (str) : swh identifier result once the loading is complete + - status (enum): The deposit's current status - As mentioned, a deposit can have a status, whose possible values are: .. code:: text 'partial', -- the deposit is new or partially received since it -- can be done in multiple requests 'expired', -- deposit has been there too long and is now deemed -- ready to be garbage collected 'deposited' -- deposit complete, it is ready to be checked to ensure data consistency 'verified', -- deposit is fully received, checked, and ready for loading 'loading', -- loading is ongoing on swh's side 'done', -- loading is successful 'failed' -- loading is a failure * A deposit is stateful and can be made in multiple requests: **deposit\_request** table: - * id (bigint): identifier - * type (id): deposit request's type (possible values: 'archive', 'metadata') - * deposit\_id (id): deposit whose request belongs to - * metadata: metadata associated to the request - * date (date): date of the requests + + - id (bigint): identifier + - type (id): deposit request's type (possible values: 'archive', 'metadata') + - deposit\_id (id): deposit whose request belongs to + - metadata: metadata associated to the request + - date (date): date of the requests Information sent along a request are stored in a ``deposit_request`` row. They can be either of type ``metadata`` (atom entry, multipart's atom entry part) or of type ``archive`` (binary upload, multipart's binary upload part). When the deposit is complete (status ``deposited``), those ``metadata`` and ``archive`` deposit requests will be read and aggregated. They will then be sent as parameters to the loading routine. During loading, some of those metadata are kept in the ``origin_metadata`` table and some other are stored in the ``revision`` table (see `metadata loading <#metadata-loading>`__). - The only update actions occurring on the deposit table are in regards of: - - status changing: - ``partial`` -> {``expired``/``deposited``}, - - ``deposited`` -> {``rejected``/``verified``}, - ``verified`` -> ``loading`` - - ``loading`` -> {``done``/``failed``} - ``complete_date`` when the deposit is - finalized (when the status is changed to ``deposited``) - ``swh-id`` is - populated once we have the loading result + The only update actions occurring on the deposit table are in regards of: + + - status changes (see figure below): + + - ``partial`` -> {``expired``/``deposited``}, + - ``deposited`` -> {``rejected``/``verified``}, + - ``verified`` -> ``loading`` + - ``loading`` -> {``done``/``failed``} + + - ``complete_date`` when the deposit is + finalized (when the status is changed to ``deposited``) + - ``swh-id`` is populated once we have the loading result + +.. raw:: html + + + +.. figure:: ../images/status.png + :alt: diff --git a/docs/tests/tests_HAL.rst b/docs/tests/tests_HAL.rst index c99a63cc..0a1eeb4c 100644 --- a/docs/tests/tests_HAL.rst +++ b/docs/tests/tests_HAL.rst @@ -1,65 +1,67 @@ Tests scenarios for client ========================== Scenarios for HAL- on HAL's platform ------------------------------------ The same procedure is used for all tests: Software Author: #. prepare content #. fill out form #. submit HAL moderator: #. review content submitted #. check metadata fields on HAL #. validate submission SWH side: 1. check content in SWH: - directory was created - revision was created - release was created when releaseNotes and softwareVersion was included (new feature!) - origin corresponds to HAL url 2. check metadata fields on SWH (in revision) 3. check directory 4. check swh-id on HAL 5. check browsability when entering SWH artifact from HAL 6. check vault artifact recreation 7. access deposit's origin from SWH -+-----------+------------------------------------------+----------+-------+-----------------------------------------+ -|scenario |test case |data |result |exceptions or specific checks | -+===========+==========================================+==========+=======+=========================================+ -|submit code|content: .tar.gz |.zip |success| | -+-----------+------------------------------------------+----------+-------+-----------------------------------------+ -|submit code|content: .zip |.tar.gz |success| | -+-----------+------------------------------------------+----------+-------+-----------------------------------------+ -|submit code|content: no content |empty |fail |blocked on HAL | -+-----------+------------------------------------------+----------+-------+-----------------------------------------+ -|submit code|content: double compression (.zip in .zip)|.zip x 2 |fail |status `failed` on SWH | -+-----------+------------------------------------------+----------+-------+-----------------------------------------+ -|submit code|all metadata-single entry |metadata |success|check that all metadata is transmitted | -+-----------+------------------------------------------+----------+-------+-----------------------------------------+ -|submit code|multiple entries |metadata |success|languages / authors / descriptions | -+-----------+------------------------------------------+----------+-------+-----------------------------------------+ -|new version|new content- same metadata |content |success|check new swh-id in SWH and HAL | -+-----------+------------------------------------------+----------+-------+-----------------------------------------+ -|new version|same content- new metadata |metadata | ? |dead angle- doesn't arrives to SWH | -+-----------+------------------------------------------+----------+-------+-----------------------------------------+ -|new version|new content-new metadata | C & M |success|check artifacts history in revisions | -+-----------+------------------------------------------+----------+-------+-----------------------------------------+ -|submit code+ deposit on another hal platform + C & M +success+ | -+-----------+------------------------------------------+----------+-------+-----------------------------------------+ ++-------------+-------------------------------------------+----------+---------+-----------------------------------------+ +| scenario | test case | data | result | exceptions or specific checks | ++=============+===========================================+==========+=========+=========================================+ +| submit code | content: .tar.gz | .zip | success | | ++-------------+-------------------------------------------+----------+---------+-----------------------------------------+ +| submit code | content: .zip | .tar.gz | success | | ++-------------+-------------------------------------------+----------+---------+-----------------------------------------+ +| submit code | content: no content | empty | fail | blocked on HAL | ++-------------+-------------------------------------------+----------+---------+-----------------------------------------+ +| submit code | content: double compression (.zip in .zip)| .zip x 2 | fail | status `failed` on SWH | ++-------------+-------------------------------------------+----------+---------+-----------------------------------------+ +| submit code | all metadata-single entry | metadata | success | check that all metadata is transmitted | ++-------------+-------------------------------------------+----------+---------+-----------------------------------------+ +| submit code | multiple entries | metadata | success | languages / authors / descriptions | ++-------------+-------------------------------------------+----------+---------+-----------------------------------------+ +| new version | new content- same metadata | content | success | check new swh-id in SWH and HAL | ++-------------+-------------------------------------------+----------+---------+-----------------------------------------+ +| new version | same content- new metadata | metadata | ? | dead angle- doesn't arrives to SWH | ++-------------+-------------------------------------------+----------+---------+-----------------------------------------+ +| new version | new content-new metadata | C & M | success | check artifacts history in revisions | ++-------------+-------------------------------------------+----------+---------+-----------------------------------------+ +| submit code | deposit on another hal platform | C & M | success | | ++-------------+-------------------------------------------+----------+---------+-----------------------------------------+ Past known bugs: -- v2 problem keeps swh-id from first version +- v2 problem, where swh-id from first version is kept in the second version + instead of the new swh-id. - when deposit workers are down- error 500 is returned on HAL without real - explanation (because there is no error on SWH- deposit status stays `deposited`) + explanation (because there is no error on SWH- deposit status + stays `deposited`).