Add Segment-Trait validation

Throw InvalidSegmentTraitError when there is an invalid segment trait combination.

Signed-off-by: Elijah Swift <elijah.swift@ibm.com>

Author: ElijahSwiftIBM

pyracf/common/invalid_segment_trait_error.py

@@ -0,0 +1,18 @@
+"""Exception to use when the user passes invalid segment-trait(s) in the traits dictionary."""
+
+
+class InvalidSegmentTraitError(Exception):
+    """
+    Raised when a user passes an invalid segment-trait combination in the traits dictionary.
+    """
+
+    def __init__(self, invalid_traits: list) -> None:
+        self.message = "Building of Security Request failed.\n\n"
+        for trait in invalid_traits:
+            self.message += (
+                "Could not find "
+                + f"'{trait}' in valid segment traits for the requested operation.\n"
+            )
+
+    def __str__(self) -> str:
+        return self.message

pyracf/common/security_admin.py

@@ -5,6 +5,7 @@
 from datetime import datetime
 from typing import Any, List, Tuple, Union
 
+from .invalid_segment_trait_error import InvalidSegmentTraitError
 from .irrsmo00 import IRRSMO00
 from .logger import Logger
 from .security_request import SecurityRequest
@@ -266,9 +267,21 @@ def _build_bool_segment_dictionaries(self, segments: dict) -> None:
 
     def _build_segment_dictionaries(self, traits: dict) -> None:
         """Build segemnt dictionaries for each segment."""
+        invalid_traits = []
         for trait in traits:
+            trait_valid = False
             for segment in self._valid_segment_traits:
-                self.__validate_and_add_trait(trait, segment, traits[trait])
+                trait_valid = self.__validate_and_add_trait(
+                    trait, segment, traits[trait]
+                )
+                if trait_valid:
+                    break
+            if not trait_valid:
+                invalid_traits.append(trait)
+
+        if invalid_traits:
+            raise InvalidSegmentTraitError(invalid_traits)
+
         # preserve segment traits for debug logging.
         self.__preserved_segment_traits = self._segment_traits
 

tests/user/test_user_constants.py

@@ -229,12 +229,16 @@ def get_sample(sample_file: str) -> Union[str, bytes]:
 # ============================================================================
 
 # Alter User Traits
-TEST_ALTER_USER_CSDATA_REQUEST_TRAITS = {
+TEST_ALTER_USER_CSDATA_AND_OMVS_REQUEST_TRAITS = {
     "base:special": False,
     "omvs:home": "/u/clarinet",
     "omvs:program": False,
     "csdata:tstcsfld": "testval",
 }
+TEST_ALTER_USER_CSDATA_REQUEST_TRAITS = {
+    "base:special": False,
+    "csdata:tstcsfld": "testval",
+}
 
 # Valid Segment Traits Updates
 TEST_USER_REPLACE_SEGMENT_TRAITS = {

tests/user/test_user_request_builder.py

@@ -104,7 +104,8 @@ def test_user_admin_build_alter_request_update_existing_segment_traits(self):
             update_existing_segment_traits=TestUserConstants.TEST_USER_ADDITIONAL_SEGMENT_TRAITS,
         )
         result = user_admin.alter(
-            "squidwrd", traits=TestUserConstants.TEST_ALTER_USER_CSDATA_REQUEST_TRAITS
+            "squidwrd",
+            traits=TestUserConstants.TEST_ALTER_USER_CSDATA_AND_OMVS_REQUEST_TRAITS,
         )
         self.assertEqual(
             result,