debug commit url and execOverFolder (ed233e32) · Commits · Forge tools / robot2doc

examples/SOL002/My-API/ScaleVNFTask.robot

0 → 100644

+136 −0

Original line number	Diff line number	Diff line
		* Settings *
		# Resource variables.txt
		#Library REST http://${VNFM_HOST}:${VNFM_PORT}
		# ... spec=SOL003-VNFLifecycleManagement-API.yaml
		#Library DependencyLibrary
		#Library OperatingSystem

		* Test Cases *
		Scale a vnfInstance
		[Documentation] Test Name: Scale VNF The POST method scales a VNF instance..
		... Another: The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
		... Applicability: Typically, this is due to the fact that the VNF instance resource is in NOT-INSTANTIATED state, or that another lifecycle management operation is ongoing.
		... Post-conditions: The response body shall contain a ProblemDetails structure, in which the detail attribute should convey more information about the error.
		... Reference: ETSI GS NFV-SOL 002
		Log Trying to scale a vnf Instance
		Set Headers {"Accept":"${ACCEPT}"}
		Set Headers {"Content-Type": "${CONTENT_TYPE}"}
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		${body}= Get File json/scaleVnfRequest.json
		Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
		Integer response status 202
		Log Status code validated

		Scale a vnfInstance Conflict (Not-Instantiated)
		# TODO: Need to set the pre-condition of the test. VNF instance shall be in NOT-INSTANTIATED state
		[Documentation] Prova: Conflict.
		... Another: The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
		... Applicability: Typically, this is due to the fact that the VNF instance resource is in NOT-INSTANTIATED state, or that another lifecycle management operation is ongoing.
		... The response body shall contain a ProblemDetails structure, in which the detail attribute should convey more information about the error.
		[Setup] Check resource not instantiated
		Log Trying to Scale a vnf Instance
		Set Headers {"Accept":"${ACCEPT}"}
		Set Headers {"Content-Type": "${CONTENT_TYPE}"}
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		${body}= Get File json/scaleVnfRequest.json
		Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
		Output response
		Integer response status 409
		Log Status code validated

		Scale a vnfInstance Conflict (parallel LCM operation)
		# TODO: Need to set the pre-condition of the test
		[Documentation] Example: Conflict
		... Maybe: The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource.
		... Typically, this is due to the fact that the VNF instance resource is in NOT-INSTANTIATED state, or that another lifecycle management operation is ongoing.
		... The response body shall contain a ProblemDetails structure, in which the detail attribute should convey more information about the error.
		[Setup] Launch another LCM operation
		log Trying to Scale a vnf Instance
		Set Headers {"Accept":"${ACCEPT}"}
		Set Headers {"Content-Type": "${CONTENT_TYPE}"}
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		${body}= Get File json/scaleVnfRequest.json
		Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
		Log Validate Status code
		Output response
		Integer response status 409
		[Teardown] #We cannot know if the "scale" operation is finished easily because the 202 indicates only whether the operation has been accepted, not whether the operation has been finished

		Scale a vnfInstance Not Found
		# TODO: Need to create a vnfInstance which's instantiatedVnfInfo.scaleStatus is absent
		[Documentation] Not Found
		... Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists.
		... Specifically in case of this task resource, the response code 404 shall also returned if the task is not supported for the VNF instance represented by the parent resource, which means that the task resource consequently does not exist.
		... In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the detail attribute shall convey more information about the error.
		[Setup] Check scale not supported
		Log Trying to scale a vnf Instance, not exist
		Set Headers {"Accept":"${ACCEPT}"}
		Set Headers {"Content-Type": "${CONTENT_TYPE}"}
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		${body}= Get File json/scaleVnfRequest.json
		Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale ${body}
		Integer response status 404
		Log Status code validated


		GET Scale VNFInstance - Method not implemented
		log Trying to perform a GET. This method should not be implemented
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale
		Log Validate Status code
		Output response
		Integer response status 405

		PUT Scale VNFInstance - Method not implemented
		log Trying to perform a PUT. This method should not be implemented
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		Put ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale
		Log Validate Status code
		Output response
		Integer response status 405

		PATCH Scale VNFInstance - Method not implemented
		log Trying to perform a PATCH. This method should not be implemented
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		Patch ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale
		Log Validate Status code
		Output response
		Integer response status 405

		DELETE Scale VNFInstance - Method not implemented
		log Trying to perform a DELETE. This method should not be implemented
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		Delete ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale
		Log Validate Status code
		Output response
		Integer response status 405

		* Keywords *
		Check resource existance
		Set Headers {"Accept":"${ACCEPT}"}
		Set Headers {"Content-Type": "${CONTENT_TYPE}"}
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
		Integer response status 200

		Check resource not instantiated
		Set Headers {"Accept":"${ACCEPT}"}
		Set Headers {"Content-Type": "${CONTENT_TYPE}"}
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
		String response body instantiationState NOT_INSTANTIATED

		Check scale not supported
		Set Headers {"Accept":"${ACCEPT}"}
		Set Headers {"Content-Type": "${CONTENT_TYPE}"}
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		Get ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}
		Missing response body instantiatedVnfInfo scaleStatus

		Launch another LCM operation
		Set Headers {"Accept":"${ACCEPT}"}
		Set Headers {"Content-Type": "${CONTENT_TYPE}"}
		Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"}
		${body}= Get File json/scaleVnfToLevelRequest.json
		Post ${apiRoot}/${apiName}/${apiVersion}/vnf_instances/${vnfInstanceId}/scale_to_level ${body}
		Integer response status 202
		No newline at end of file

examples/SOL002/My-API/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 - ETSI GS NFV-SOL 003 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 - ETSI GS NFV-SOL 003 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 - ETSI GS NFV-SOL 003 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 - ETSI GS NFV-SOL 003 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 - ETSI GS NFV-SOL 003 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 - ETSI GS NFV-SOL 003 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 - ETSI GS NFV-SOL 003 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 - ETSI GS NFV-SOL 003 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 - ETSI GS NFV-SOL 003 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 - ETSI GS NFV-SOL 003 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 - ETSI GS NFV-SOL 003 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

execOverFolder.sh

+2 −2

Original line number	Diff line number	Diff line
		@@ -24,8 +24,8 @@ if [ "$1" != "" ]; then
		echo "api: $API"
		for file in $DIR/*.robot; do
		filename=$(basename "$file")
		if [[ $filename != "$EXCLUDE" ]]; then
		python robot2doc/main.py $file "${filename%.}.docx" "${filename%.}" $COMMIT $SOL $API
		if [ "$filename" != "$EXCLUDE" ]; then
		python3 robot2doc/main.py $file "${filename%.}.docx" "${filename%.}" $COMMIT $SOL $API
		else
		echo "excluded file: $filename"
		fi

robot2doc/config.py

+1 −1

Original line number	Diff line number	Diff line
		@@ -30,4 +30,4 @@ QUIET = False
		# 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_PREFIX = "https://forge.etsi.org/gitlab/nfv/api-tests/raw/XX-commit-XX/SOL00Y/AAA-API/"
		No newline at end of file
		GIT_COMMIT_PREFIX = "https://forge.etsi.org/rep/nfv/api-tests/raw/deadbeef"
		No newline at end of file

robot2doc/testpurpose.py

+4 −3

Original line number	Diff line number	Diff line
		@@ -29,6 +29,9 @@ class TP():
		self.tp_id = None

		for field in self.tp_fields:
		if field.key == "Test ID":
		self.tp_id = field.value
		continue
		if field.value and not field.value[0].isupper():
		raise Exception("Found field starting with lowercase character: " + field.value)
		if field.key.startswith("Reference"):
		@@ -37,8 +40,6 @@ class TP():
		"Reference possibly incorrect ('ETSI GS NFV-SOL' not found): " +
		field.value
		)
		if field.key == "Test ID":
		self.tp_id = field.value

		def __str__(self):
		return str(self.lines)
		@@ -53,5 +54,5 @@ class TP():
		spec.add_commit_url(robot_file, commit_id, sol, api)
		else:
		if config.GIT_COMMIT_PREFIX != "":
		spec.add_commit_url( robot_file, "", "", config.GIT_COMMIT_PREFIX)
		spec.add_commit_url(robot_file, config.GIT_COMMIT_PREFIX, "SOLAAA", "MyAPI")