Save Profile Properties to Config File & Secure Vault Storage (#73, #72)

CHANGELOG.md

@@ -2,3 +2,6 @@
 
 All notable changes to the Zowe Client Python SDK will be documented in this file.
 
+## Recent Changes
+
+- Feature: Added method to Save profile properties to zowe.config.json file

src/core/zowe/core_for_zowe_sdk/config_file.py

@@ -340,3 +340,60 @@ def load_secure_props(self) -> None:
                 f" with error '{error_msg}'",
                 SecurePropsNotFoundWarning,
             )
+
+    def __is_secure(self, json_path: str) -> bool:
+        """
+        Check whether the given JSON path corresponds to a secure property.
+
+        Parameters:
+            json_path (str): The JSON path of the property to check.
+
+        Returns:
+            bool: True if the property should be stored securely, False otherwise.
+        """
+        profile_name, property_name = json_path.split(".")[1:]
+        profile = self.find_profile(profile_name, self.profiles)
+        if profile and profile.get("secure"):
+            return property_name in profile["secure"]
+        return False
+
+    def set_property(self, json_path, value, secure=False):
+        """
+        Set a property in the profile, storing it securely if necessary.
+
+        Parameters:
+            json_path (str): The JSON path of the property to set.
+            value (str): The value to be set for the property.
+            secure (bool): If True, the property will be stored securely. Default is False.
+        """
+        if self.profiles is None:
+            self.init_from_file()
+
+        segments = json_path.split(".")
+        updated_profiles = self.profiles
+
+        while len(segments) > 1:
+            profile_name = segments[0]
+            updated_profiles[profile_name] = updated_profiles.get(profile_name, {})
+            updated_profiles = updated_profiles[profile_name]
+            segments.pop(0)
+
+        # If the property should be stored securely, add it to the secure layer
+        if secure or self.__is_secure(json_path):
+            updated_profiles["secure"] = updated_profiles.get("secure", [])
+            property_name = segments[1]
+            if property_name not in updated_profiles["secure"]:
+                updated_profiles["secure"].append(property_name)
+
+
+        else:
+            # Store the property in plain text
+            updated_profiles["properties"] = updated_profiles.get("properties", {})
+            updated_profiles["properties"][segments[1]] = value
+
+        # Save the updated profile to the file
+        self.save()
+    def save(self) :
+        """
+        working on it
+        """   

src/core/zowe/core_for_zowe_sdk/profile_manager.py

@@ -247,3 +247,46 @@ def load(
         warnings.resetwarnings()
 
         return profile_props
+
+    def get_highest_priority_layer(self, profile_name: str, layers: list[ConfigFile]) -> Optional[ConfigFile]:
+        """
+        Get the highest priority layer (configuration file) based on the given profile name and the list of layers.
+
+        Parameters:
+            profile_name (str): The name of the profile to look for in the layers.
+            layers (list[ConfigFile]): The list of ConfigFile objects representing different configuration files.
+
+        Returns:
+            Optional[ConfigFile]: The highest priority layer (configuration file) that contains the specified profile,
+                                or None if the profile is not found in any layer.
+        """
+        highest_priority_layer = None
+
+        for layer in layers:
+            try:
+                profile = layer.get_profile(profile_name=profile_name, profile_type=None)
+                if profile.name:
+                    highest_priority_layer = layer
+                    break
+            except ProfileNotFound:
+                pass
+
+        return highest_priority_layer
+
+    def set_property(self, json_path, value, secure=False):
+            # Get all layers to search for the highest priority layer
+            layers = [self.project_user_config, self.project_config, self.global_user_config, self.global_config]
+            profile_name = ".".join(json_path.split(".")[:2])
+
+            # Find the highest priority layer for the given profile name
+            highest_priority_layer = self.get_highest_priority_layer(profile_name, layers)
+
+            # If the profile doesn't exist in any layer, use the project user config as the default location
+            if not highest_priority_layer:
+                highest_priority_layer = self.project_user_config
+
+            # Set the property in the highest priority layer
+            highest_priority_layer.set_property(json_path, value, highest_priority_layer, secure=secure)
+
+            # Save the modified configuration file
+            highest_priority_layer.save()