[client] Implement output contracts and findings (#86)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Romuald Lemesle <[email protected]>

Author: 3 people

pyobas/contracts/contract_builder.py

@@ -1,18 +1,24 @@
 from typing import List
 
-from pyobas.contracts.contract_config import ContractElement
+from pyobas.contracts.contract_config import ContractElement, ContractOutputElement
 
 
 class ContractBuilder:
     fields: List[ContractElement]
+    outputs: List[ContractOutputElement]
 
     def __init__(self):
         self.fields = []
+        self.outputs = []
 
     def add_fields(self, fields: List[ContractElement]):
         self.fields = self.fields + fields
         return self
 
+    def add_outputs(self, outputs: List[ContractOutputElement]):
+        self.outputs = self.outputs + outputs
+        return self
+
     def mandatory(self, element: ContractElement):
         element.mandatory = True
         self.fields.append(element)
@@ -31,5 +37,8 @@ def mandatory_group(self, elements: List[ContractElement]):
             self.fields.append(element)
         return self
 
-    def build(self) -> List[ContractElement]:
+    def build_fields(self) -> List[ContractElement]:
         return self.fields
+
+    def build_outputs(self) -> List[ContractOutputElement]:
+        return self.outputs

pyobas/contracts/contract_config.py

@@ -14,7 +14,7 @@ class SupportedLanguage(str, Enum):
     en: str = "en"
 
 
-class ContractType(str, Enum):
+class ContractFieldType(str, Enum):
     Text: str = "text"
     Number: str = "number"
     Tuple: str = "tuple"
@@ -32,6 +32,14 @@ class ContractType(str, Enum):
     Payload: str = "payload"
 
 
+class ContractOutputType(str, Enum):
+    Text: str = "text"
+    Number: str = "number"
+    Port: str = "port"
+    IPv4: str = "ipv4"
+    IPv6: str = "ipv6"
+
+
 class ExpectationType(str, Enum):
     text: str = "TEXT"
     document: str = "DOCUMENT"
@@ -53,7 +61,7 @@ class Expectation:
 @dataclass
 class LinkedFieldModel:
     key: str
-    type: ContractType
+    type: ContractFieldType
 
 
 @dataclass
@@ -82,6 +90,14 @@ class ContractCardinalityElement(ContractElement, ABC):
     defaultValue: List[str] = field(default_factory=list)
 
 
+@dataclass
+class ContractOutputElement(ABC):
+    type: str
+    field: str
+    labels: List[str]
+    isMultiple: bool
+
+
 @dataclass
 class ContractConfig:
     type: str
@@ -96,6 +112,7 @@ class Contract:
     contract_id: str
     label: dict[SupportedLanguage, str]
     fields: List[ContractElement]
+    outputs: List[ContractOutputElement]
     config: ContractConfig
     manual: bool
     variables: List[ContractVariable] = field(
@@ -121,7 +138,7 @@ def add_variable(self, var: ContractVariable):
 class ContractTeam(ContractCardinalityElement):
     @property
     def get_type(self) -> str:
-        return ContractType.Team.value
+        return ContractFieldType.Team.value
 
 
 @dataclass
@@ -131,7 +148,7 @@ class ContractText(ContractCardinalityElement):
 
     @property
     def get_type(self) -> str:
-        return ContractType.Text.value
+        return ContractFieldType.Text.value
 
 
 def prepare_contracts(contracts):
@@ -161,7 +178,7 @@ def __post_init__(self):
 
     @property
     def get_type(self) -> str:
-        return ContractType.Tuple.value
+        return ContractFieldType.Tuple.value
 
 
 @dataclass
@@ -172,7 +189,7 @@ class ContractTextArea(ContractCardinalityElement):
 
     @property
     def get_type(self) -> str:
-        return ContractType.Textarea.value
+        return ContractFieldType.Textarea.value
 
 
 @dataclass
@@ -182,15 +199,15 @@ class ContractCheckbox(ContractElement):
 
     @property
     def get_type(self) -> str:
-        return ContractType.Checkbox.value
+        return ContractFieldType.Checkbox.value
 
 
 @dataclass
 class ContractAttachment(ContractCardinalityElement):
 
     @property
     def get_type(self) -> str:
-        return ContractType.Attachment.value
+        return ContractFieldType.Attachment.value
 
 
 @dataclass
@@ -200,7 +217,7 @@ class ContractExpectations(ContractCardinalityElement):
 
     @property
     def get_type(self) -> str:
-        return ContractType.Expectation.value
+        return ContractFieldType.Expectation.value
 
 
 @dataclass
@@ -210,28 +227,28 @@ class ContractSelect(ContractCardinalityElement):
 
     @property
     def get_type(self) -> str:
-        return ContractType.Select.value
+        return ContractFieldType.Select.value
 
 
 @dataclass
 class ContractAsset(ContractCardinalityElement):
 
     @property
     def get_type(self) -> str:
-        return ContractType.Asset.value
+        return ContractFieldType.Asset.value
 
 
 @dataclass
 class ContractAssetGroup(ContractCardinalityElement):
 
     @property
     def get_type(self) -> str:
-        return ContractType.AssetGroup.value
+        return ContractFieldType.AssetGroup.value
 
 
 @dataclass
 class ContractPayload(ContractCardinalityElement):
 
     @property
     def get_type(self) -> str:
-        return ContractType.Payload.value
+        return ContractFieldType.Payload.value

test-requirements.txt

@@ -1,4 +1,4 @@
-black==24.10.0
+black==25.1.0
 isort>=5.10
 build>=0.7
 isort>=5.10