Differential D1617 Diff 5376 docs/tests/tests_HAL.rst

Changeset View

Standalone View

docs/tests/tests_HAL.rst

This file was added.

				Tests scenarios for client
				==========================

				Scenarios for HAL- on HAL's platform
				------------------------------------
				zackUnsubmitted Not Done Inline Actions Why does this belong to our repo? swh-deposit is not HAL-specific, if anything it's SWORD specific. So if there're HAL-specific specs, maybe they belong to some HAL-specific website? zack: Why does this belong to our repo? swh-deposit is not HAL-specific, if anything it's SWORD…
				moraneggAuthorUnsubmitted Not Done Inline Actions Today this information is only in my head. There are no testers on HAL and if it were for them, the users are the testers. In my opinion, it should be kept somewhere on our side, if we don't want this process to disappear.. Also, at some point we want to automate this tests on with integration tests, so the automated tests should be detailed before implementation. SWH as an archival service recommends HAL as a way to inject code into the archive, and we need to be sure it works. If you have a better SWH location for it, I don't mind changing it. moranegg: Today this information is only in my head. There are no testers on HAL and if it were for them…

				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+ \|
				ardumontUnsubmitted Done Inline Actions why do you use + on that line here? ardumont: why do you use + on that line here?
				moraneggAuthorUnsubmitted Done Inline Actions oh no. thanks! moranegg: oh no. thanks!
				+-----------+------------------------------------------+----------+-------+-----------------------------------------+

				Past known bugs:

				- v2 problem keeps swh-id from first version
				ardumontUnsubmitted Done Inline Actions `with` first ardumont: `with` first
				moraneggAuthorUnsubmitted Done Inline Actions the bug was that v2 had the swh-id identifier that was generated for v1. I will reword. moranegg: the bug was that v2 had the swh-id identifier that was generated for v1. I will reword.
				- 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`)
				ardumontUnsubmitted Not Done Inline Actions There should be some way on hal's side to deal with us down. Even though, that should not happen, it still could due to 'reasons' (migration comes to mind...). ardumont: There should be some way on hal's side to deal with us down. Even though, that should not…
				moraneggAuthorUnsubmitted Not Done Inline Actions yes you are right. let's hope it will happen someday:-) moranegg: yes you are right. let's hope it will happen someday:-)