Fixes TP headers, URL is a prefix + filename (e724f267) · Commits · Forge tools / robot2doc

examples/VNFPackageArtifacts.robot

0 → 100644

+147 −0

Original line number	Diff line number	Diff line
		* Settings *
		Library JSONSchemaLibrary schemas/
		Resource environment/variables.txt # Generic Parameters
		Resource environment/vnfPackageArtifacts.txt
		Resource VNFPackageManagementKeywords.robot
		Library JSONLibrary
		Library REST ${NFVO_SCHEMA}://${NFVO_HOST}:${NFVO_PORT}

		* Test Cases *
		GET Individual VNF Package Artifact
		[Documentation] Test ID: 7.3.3.5.1
		... Test title: GET Individual VNF Package Artifact
		... Test objective: The objective is to test the retrieval of an individual VNF package artifact
		... Pre-conditions: One or more VNF packages are onboarded in the NFVO.
		... Reference: section 10.4.6.3.2 - SOL003 v2.4.1
		... Config ID: Config_prod_NFVO
		... Applicability: none
		... Post-Conditions: none
		GET Individual VNF Package Artifact
		Check HTTP Response Status Code Is 200


		GET Individual VNF Package Artifact in octet stream format
		[Documentation] Test ID: 7.3.3.5.2
		... Test title: GET Individual VNF Package Artifact in octet stream format
		... Test objective: The objective is to test the retrieval of an individual VNF package artifact when the NFVO cannot determine the artifact content type. The test performs a validation that the returned artifcat in is octet-stream format
		... Pre-conditions: One or more VNF packages are onboarded in the NFVO.
		... Reference: section 10.4.6.3.2 - SOL003 v2.4.1
		... Config ID: Config_prod_NFVO
		... Applicability: The NFVO cannot determine the content type of the artifact
		... Post-Conditions: none
		GET Individual VNF Package Artifact in octet stream format
		Check HTTP Response Status Code Is 200
		Check HTTP Response Header Content-Type Is application/octet-stream

		GET Individual VNF Package Artifact with Range Request and NFVO supporting Range Requests
		[Documentation] Test ID: 7.3.3.5.3
		... Test title: GET Individual VNF Package Artifact with Range Request and NFVO supporting Range Requests
		... Test objective: The objective is to test the retrieval of an individual VNF package artifact when using a range request to return single range of bytes from the file, with the NFVO supporting it. The test also perform a validation that returned content matches the issued range
		... Pre-conditions: One or more VNF packages are onboarded in the NFVO.
		... Reference: section 10.4.6.3.2 - SOL003 v2.4.1
		... Config ID: Config_prod_NFVO
		... Applicability: The NFVO supports range requests to return single range of bytes from the VNF package artifact
		... Post-Conditions: none
		GET Individual VNF Package Artifact with Range Request
		Check HTTP Response Status Code Is 206
		Check HTTP Response Header Content-Range Is Present and Matches the requested range
		Check HTTP Response Header Content-Length Is Present and Matches the requested range length

		GET Individual VNF Package Artifact with Range Request and NFVO not supporting Range Requests
		[Documentation] Test ID: 7.3.3.5.4
		... Test title: GET Individual VNF Package Artifact with Range Request and NFVO not supporting Range Requests
		... Test objective: The objective is to test that the retrieval of an individual VNF package artifact, when using a range request to return single range of bytes from the file and the NFVO not supporting it, returns the full VNF Package artifact.
		... Pre-conditions: One or more VNF packages are onboarded in the NFVO.
		... Reference: section 10.4.6.3.2 - SOL003 v2.4.1
		... Config ID: Config_prod_NFVO
		... Applicability: The NFVO does not support range requests to return single range of bytes from the VNF package artifact
		... Post-Conditions: none
		GET Individual VNF Package Artifact with Range Request
		Check HTTP Response Status Code Is 200

		GET Individual VNF Package Artifact with invalid Range Request
		[Documentation] Test ID: 7.3.3.5.5
		... Test title: GET Individual VNF Package Artifact with invalid Range Request
		... Test objective: The objective is to test that the retrieval of an individual VNF package artifact fails when using a range request that does not match any available byte range in the file.
		... Pre-conditions: One or more VNF packages are onboarded in the NFVO.
		... Reference: section 10.4.6.3.2 - SOL003 v2.4.1
		... Config ID: Config_prod_NFVO
		... Applicability: The NFVO supports range requests to return single range of bytes from the VNF package artifact
		... Post-Conditions: none
		GET Individual VNF Package Artifact with invalid Range Request
		Check HTTP Response Status Code Is 416

		GET Individual VNF Package Artifact with invalid resource identifier
		[Documentation] Test ID: 7.3.3.5.6
		... Test title: GET Individual VNF Package Artifact with invalid resource identifier
		... Test objective: The objective is to test that the retrieval of an individual VNF package artifact fails when using an invalid resource identifier
		... Pre-conditions: One or more VNF packages are onboarded in the NFVO.
		... Reference: section 10.4.6.3.2 - SOL003 v2.4.1
		... Config ID: Config_prod_NFVO
		... Applicability: none
		... Post-Conditions: none
		GET Individual VNF Package Artifact with invalid resource identifier
		Check HTTP Response Status Code Is 404

		GET Individual VNF Package Artifact with conflict due to onboarding state
		[Documentation] Test ID: 7.3.3.5.7
		... Test title: GET Individual VNF Package Artifact with conflict due to onboarding state
		... Test objective: The objective is to test that the retrieval of an individual VNF package artifact fails due to a conflict when the VNF Package is not in onboarding state ONBOARDED in the NFVO. The test also performs a validation of the JSON schema validation of the failed operation HTTP response
		... Pre-conditions: The onboarding state of the VNF package for which the content is requested is different from ONBOARDED.
		... Reference: section 10.4.6.3.2 - SOL003 v2.4.1
		... Config ID: Config_prod_NFVO
		... Applicability: none
		... Post-Conditions: none
		GET Artifact for VNF Package in onboarding state different from ONBOARDED
		Check HTTP Response Status Code Is 409
		Check HTTP Response Body Json Schema Is ProblemDetails

		POST Individual VNF Package Artifact - Method not implemented
		[Documentation] Test ID: 7.3.3.5.8
		... Test title: POST Individual VNF Package Artifact - Method not implemented
		... Test objective: The objective is to test that POST method is not allowed to create new VNF Package artifact
		... Pre-conditions: none
		... Reference: section 10.4.6.3.1 - SOL003 v2.4.1
		... Config ID: Config_prod_NFVO
		... Applicability: none
		... Post-Conditions: none
		Send POST Request for individual VNF Package Artifact
		Check HTTP Response Status Code Is 405

		PUT Individual VNF Package Artifact - Method not implemented
		[Documentation] Test ID: 7.3.3.5.9
		... Test title: PUT Individual VNF Package Artifact - Method not implemented
		... Test objective: The objective is to test that PUT method is not allowed to modify a VNF Package artifact
		... Pre-conditions: One or more VNF packages are onboarded in the NFVO.
		... Reference: section 10.4.6.3.3 - SOL003 v2.4.1
		... Config ID: Config_prod_NFVO
		... Applicability: none
		... Post-Conditions: none
		Send PUT Request for individual VNF Package Artifact
		Check HTTP Response Status Code Is 405

		PATCH Individual VNF Package Artifact - Method not implemented
		[Documentation] Test ID: 7.3.3.5.10
		... Test title: PATCH Individual VNF Package Artifact - Method not implemented
		... Test objective: The objective is to test that PATCH method is not allowed to update a VNF Package artifact
		... Pre-conditions: One or more VNF packages are onboarded in the NFVO.
		... Reference: section 10.4.6.3.4 - SOL003 v2.4.1
		... Config ID: Config_prod_NFVO
		... Applicability: none
		... Post-Conditions: none
		Send PATCH Request for individual VNF Package Artifact
		Check HTTP Response Status Code Is 405

		DELETE Individual VNF Package Artifact - Method not implemented
		[Documentation] Test ID: 7.3.3.5.11
		... Test title: DELETE Individual VNF Package Artifact - Method not implemented
		... Test objective: The objective is to test that DELETE method is not allowed to delete a VNF Package artifact
		... Pre-conditions: One or more VNF packages are onboarded in the NFVO.
		... Reference: section 10.4.6.3.5 - SOL003 v2.4.1
		... Config ID: Config_prod_NFVO
		... Applicability: none
		... Post-Conditions: The VNF Package artifact is not deleted by the failed operation
		Send DELETE Request for individual VNF Package Artifact
		Check HTTP Response Status Code Is 405
		Check Postcondition VNF Package Artifact Exist

robot2doc/config.py

+5 −4

Original line number	Diff line number	Diff line
		@@ -25,8 +25,9 @@ DRY_RUN = False
		# If QUIET is True, output on stdout is minimized
		QUIET = False

		# Commit URL that may be added after each table. If the GIT_COMMIT
		# is the empty string, nothing is added
		# Prefix for the commit URL that may be added after each table. If the GIT_COMMIT
		# is the empty string, nothing is added. The prefix is concatenated with the filename of
		# the Robot file. NOTE: if the final slash is not present it will not be included.
		# Example:
		# GIT_COMMIT = "http://acme.com/my/example/abcde"
		GIT_COMMIT = ""
		No newline at end of file
		# GIT_COMMIT = "http://acme.com/my/example/abcde/"
		GIT_COMMIT_PREFIX = "https://forge.etsi.org/gitlab/nfv/api-tests/raw/XX-commit-XX/SOL00Y/AAA-API/"
		No newline at end of file

robot2doc/main.py

+10 −1

Original line number	Diff line number	Diff line
		@@ -54,7 +54,7 @@ def gen_test(suite, this_test, spec, sec, subsec, workspace):
		else:
		subsec = subsec + 1
		spec.add_heading(str(this_test), DOC_TC_LEVEL, DOC_CLAUSE_LVL_1, sec, DOC_CLAUSE_LVL_3, subsec)
		tp.add_to_spec(spec, keywords_to_text(this_test.keywords))
		tp.add_to_spec(spec, keywords_to_text(this_test.keywords), str(suite)+".robot")

		def gen_doc(src, doc_fn, doc_main_tit):
		'''
		@@ -88,6 +88,7 @@ def gen_doc(src, doc_fn, doc_main_tit):
		exit(-1)

		not QUIET and print("Loaded "+ str(len(workspace.suites)) + " test suites.")
		not QUIET and print("Loaded "+ str(len(workspace.tests)) + " tests.")
		sec = DOC_CLAUSE_LVL_2 - 1

		spec.add_main_heading(doc_main_tit)
		@@ -100,6 +101,14 @@ def gen_doc(src, doc_fn, doc_main_tit):
		for i in suite.tests:
		gen_test(suite, i, spec, sec, subsec, workspace)

		if len(workspace.suites) == 0:
		sec = sec + 1
		subsec = DOC_CLAUSE_LVL_4
		suite = str(workspace)
		spec.add_sub_heading(suite, DOC_CLAUSE_LVL_1, sec, DOC_CLAUSE_LVL_3, subsec)
		for i in workspace.tests:
		gen_test(suite, i, spec, sec, subsec, workspace)

		not QUIET and print("Saving to: " + doc_fn)
		not DRY_RUN and spec.save(doc_fn)
		not QUIET and print("Finished.")

robot2doc/testpurpose.py

+10 −6

Original line number	Diff line number	Diff line
		#!/env/python

		import config
		import testspec

		class TpField():
		'''
		@@ -20,10 +21,10 @@ class TP():
		Defines a test purpose. The constructor parses a set of lines
		with key value pairs, each separated by ":".
		'''
		def __init__(self, text):
		def __init__(self, text : str):
		# t = text.encode('ascii')
		self.lines = text.split("\\n")
		self.tp_fields = map(TpField, self.lines)
		self.tp_fields = [TpField(l) for l in self.lines]
		self.tp_id = None

		for field in self.tp_fields:
		@@ -33,7 +34,10 @@ class TP():
		def __str__(self):
		return str(self.lines)

		def add_to_spec(self, spec, test):
		spec.add_tp(self.tp_fields, test)
		if config.GIT_COMMIT != "":
		spec.add_commit_url(config.GIT_COMMIT)
		No newline at end of file
		def add_to_spec(self, spec : testspec.TestSpec, testbehaviour: str, robot_file : str):
		'''
		Given a Test Spec, executes the addition of the this TP in the document.
		'''
		spec.add_tp(self.tp_fields, testbehaviour)
		if config.GIT_COMMIT_PREFIX != "":
		spec.add_commit_url(config.GIT_COMMIT_PREFIX, robot_file)
		No newline at end of file

robot2doc/testspec.py

+6 −2

Original line number	Diff line number	Diff line
		@@ -68,8 +68,12 @@ class TestSpec():
		TestSpec.cell_text_bold(hdr_cells[0])
		TestSpec.cell_text_centered(hdr_cells[0])

		def add_commit_url(self, commit):
		self.doc.add_paragraph("Note: Robot code can be found at " + commit)
		def add_commit_url(self, commit : str, robot_file : str):
		'''
		Adds a note to the document containing the URL to the location of the
		file, according to the configured URL prefix configured.
		'''
		self.doc.add_paragraph("Note: Robot code can be found at " + commit + robot_file)

		def add_tp(self, fields, testbehaviour):
		table = self.doc.add_table(cols=2, rows=1)