From 27ed6c60173a273db5c343816ab7ea60f21a5272 Mon Sep 17 00:00:00 2001 From: Michal Jagiello Date: Fri, 5 May 2023 12:44:22 +0000 Subject: Fix cps steps doc Add information which settings values are used by steps Issue-ID: TEST-123 Signed-off-by: Michal Jagiello Change-Id: I4b9a723a38cde45788c7cc2d3b73a7b3cc6514fa --- src/onaptests/steps/onboard/cps.py | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/src/onaptests/steps/onboard/cps.py b/src/onaptests/steps/onboard/cps.py index 1c59086..e582489 100644 --- a/src/onaptests/steps/onboard/cps.py +++ b/src/onaptests/steps/onboard/cps.py @@ -27,7 +27,12 @@ class CreateCpsDataspaceStep(CpsBaseStep): @BaseStep.store_state def execute(self) -> None: - """Create a dataspace.""" + """Create a dataspace. + + Use settings values: + - DATASPACE_NAME. + + """ super().execute() Dataspace.create(settings.DATASPACE_NAME) @@ -58,7 +63,13 @@ class CreateCpsSchemaSetStep(CpsBaseStep): @BaseStep.store_state def execute(self) -> None: - """Get dataspace created on substep and create schema-set.""" + """Get dataspace created on substep and create schema-set. + + Use settings values: + - DATASPACE_NAME, + - SCHEMA_SET_NAME. + + """ super().execute() dataspace: Dataspace = Dataspace(settings.DATASPACE_NAME) with settings.SCHEMA_SET_FILE.open("rb") as schema_set_file: @@ -95,6 +106,12 @@ class CreateCpsAnchorStep(CpsBaseStep): """Create anchor. Get dataspace and schema-set created substeps and create anchor. + + Use settings values: + - DATASPACE_NAME, + - SCHEMA_SET_NAME, + - ANCHOR_DATA. + """ super().execute() dataspace: Dataspace = Dataspace(settings.DATASPACE_NAME) @@ -129,7 +146,14 @@ class CreateCpsAnchorNodeStep(CpsBaseStep): @BaseStep.store_state def execute(self) -> None: - """Create a node on an anchor created on substep.""" + """Create a node on an anchor created on substep. + + Use settings values: + - DATASPACE_NAME, + - ANCHOR_NAME, + - ANCHOR_DATA. + + """ super().execute() dataspace: Dataspace = Dataspace(settings.DATASPACE_NAME) anchor: Anchor = dataspace.get_anchor(settings.ANCHOR_NAME) -- cgit 1.2.3-korg