Pull request #22: Release v2.7.0

Merge in SIE-BB/netapp-dataops-toolkit from release-v2.7.0 to release-v3.0.0

* commit '1f16f19afe627e9ddffe77b1efa341bf5a4758db':
  Remove note re: keyring env var from README
  Updates: - fixing path for mcp server - renaming gcnv tests readme file
  Replaced default values with None for some parameters in create_volume function
  using keyring_service_name from constants.py
  constants module as a source of truth
  replacing .env approach by module-level constants
  keyring module in setup.cfg
  remove .env file
  adding default service name while creating config
  default service_name for keyring, and user instructions
  replacing print statements with logger
  adding keyring to dependencies
  modifying base name
  .env for single source of truth
  remove decoding password
  using keyring to set and get ontap credentials

Author: mboglesby

netapp_dataops_traditional/README.md

@@ -42,6 +42,10 @@ netapp_dataops_cli.py config
 
 Note: The toolkit requires an ONTAP account with API access. The toolkit will use this account to access the ONTAP API. NetApp recommends using an SVM-level account. Usage of a cluster admin account should be avoided for security reasons.
 
+> **Note: Keyring Service Configuration**
+> 
+> The toolkit stores ONTAP credentials securely using your system's keyring service. By default, it uses the service name `netapp:dataops:ontap` to store and retrieve credentials. 
+
 #### Example Usage
 
 ```sh

netapp_dataops_traditional/netapp_dataops/constants.py

@@ -0,0 +1,4 @@
+"""Constants used across the NetApp DataOps Toolkit."""
+
+# Keyring configuration constants
+KEYRING_SERVICE_NAME = "netapp:dataops:ontap"

netapp_dataops_traditional/netapp_dataops/netapp_dataops_cli.py

@@ -9,6 +9,7 @@
 import sys
 sys.path.insert(0, "/root/netapp-dataops-toolkit/netapp_dataops_traditional/netapp_dataops")
 
+import keyring
 from netapp_dataops import traditional
 from netapp_dataops.traditional import (
     clone_volume,
@@ -44,10 +45,10 @@
 )
 
 from netapp_dataops.logging_utils import setup_logger
+from netapp_dataops.constants import KEYRING_SERVICE_NAME
 
 logger = setup_logger(__name__)
 
-
 ## Define contents of help text
 helpTextStandard = '''
 The NetApp DataOps Toolkit is a Python library that makes it simple for data scientists and data engineers to perform various data management tasks, such as provisioning a new data volume, near-instantaneously cloning a data volume, and near-instantaneously snapshotting a data volume for traceability/baselining.
@@ -634,14 +635,15 @@ def createConfig(configDirPath: str = "~/.netapp_dataops", configFilename: str =
 
         # Prompt user to enter additional config details
         config["defaultAggregate"] = input("Enter aggregate to use by default when creating new FlexVol volumes: ")
-        config["username"] = input("Enter ONTAP API username (Recommendation: Use SVM account): ")
+        username = input("Enter ONTAP API username (Recommendation: Use SVM account): ")
         passwordString = getpass("Enter ONTAP API password (Recommendation: Use SVM account): ")
 
-        # Convert password to base64 enconding
-        passwordBytes = passwordString.encode("ascii")
-        passwordBase64Bytes = base64.b64encode(passwordBytes)
-        config["password"] = passwordBase64Bytes.decode("ascii")
-
+         # Store the password securely using keyring
+        if username is not None:
+            keyring.set_password(KEYRING_SERVICE_NAME, "username", username)
+        if passwordString is not None:
+            keyring.set_password(KEYRING_SERVICE_NAME, "password", passwordString)
+        
         # Prompt user to enter value denoting whether or not to verify SSL cert when calling ONTAP API
         # Verify value entered; prompt user to re-enter if invalid
         while True:

netapp_dataops_traditional/netapp_dataops/traditional/__init__.py

@@ -17,6 +17,7 @@
 from concurrent.futures import ThreadPoolExecutor
 import boto3
 from botocore.client import Config as BotoConfig
+import keyring
 from netapp_ontap import config as netappConfig
 from netapp_ontap.error import NetAppRestError
 from netapp_ontap.host_connection import HostConnection as NetAppHostConnection
@@ -32,6 +33,7 @@
 import requests
 from tabulate import tabulate
 import yaml
+from netapp_dataops.constants import KEYRING_SERVICE_NAME
 
 from netapp_dataops.logging_utils import setup_logger
 
@@ -201,17 +203,17 @@ def _instantiate_connection(config: dict, connectionType: str = "ONTAP", print_o
         try:
             ontapClusterMgmtHostname = config["hostname"]
             ontapClusterAdminUsername = config["username"]
-            ontapClusterAdminPasswordBase64 = config["password"]
+            ontapClusterAdminPassword = config["password"]
             verifySSLCert = config["verifySSLCert"]
         except:
             if print_output:
                 _print_invalid_config_error()
             raise InvalidConfigError()
 
         # Decode base64-encoded password
-        ontapClusterAdminPasswordBase64Bytes = ontapClusterAdminPasswordBase64.encode("ascii")
-        ontapClusterAdminPasswordBytes = base64.b64decode(ontapClusterAdminPasswordBase64Bytes)
-        ontapClusterAdminPassword = ontapClusterAdminPasswordBytes.decode("ascii")
+        # ontapClusterAdminPasswordBase64Bytes = ontapClusterAdminPasswordBase64.encode("ascii")
+        # ontapClusterAdminPasswordBytes = base64.b64decode(ontapClusterAdminPasswordBase64Bytes)
+        # ontapClusterAdminPassword = ontapClusterAdminPasswordBytes.decode("ascii")
 
         # Instantiate connection to ONTAP cluster
         netappConfig.CONNECTION = NetAppHostConnection(
@@ -253,6 +255,25 @@ def _retrieve_config(configDirPath: str = "~/.netapp_dataops", configFilename: s
         with open(configFilePath, 'r') as configFile:
             # Read connection details from config file; read into dict
             config = json.load(configFile)
+
+        # Retrieve username and password from os-default credential manager
+        username = keyring.get_password(KEYRING_SERVICE_NAME, "username")
+        password = keyring.get_password(KEYRING_SERVICE_NAME, "password")
+
+        if username:
+            config["username"] = username
+        else:
+            if print_output:
+                logger.error("Error: Missing username in credential manager.")
+            raise InvalidConfigError()
+        
+        if password:
+            config["password"] = password
+        else:
+            if print_output:
+                logger.error("Error: Missing password in credential manager.")
+            raise InvalidConfigError()
+
     except:
         if print_output:
             _print_invalid_config_error()
@@ -820,8 +841,8 @@ def create_snapshot(volume_name: str, cluster_name: str = None, svm_name: str =
 
 
 def create_volume(volume_name: str, volume_size: str, guarantee_space: bool = False, cluster_name: str = None, svm_name: str = None,
-                  volume_type: str = "flexvol", unix_permissions: str = "0777",
-                  unix_uid: str = "0", unix_gid: str = "0", export_policy: str = "default", snaplock_type: str = None,
+                  volume_type: str = None, unix_permissions: str = None,
+                  unix_uid: str = None, unix_gid: str = None, export_policy: str = None, snaplock_type: str = None,
                   snapshot_policy: str = None, aggregate: str = None, mountpoint: str = None, junction: str = None, readonly: bool = False,
                   print_output: bool = False, tiering_policy: str = None, vol_dp: bool = False):
     # Retrieve config details from config file

netapp_dataops_traditional/setup.cfg

@@ -42,6 +42,7 @@ install_requires =
     boto3
     pyyaml
     fastmcp
+    keyring
 python_requires = >=3.8,<3.14
 
 [options.extras_require]

…tapp_dataops_traditional/tests/README.md …s_traditional/tests/gcnv_tests_readme.mdnetapp_dataops_traditional/tests/README.md renamed to netapp_dataops_traditional/tests/gcnv_tests_readme.md netapp_dataops_traditional/tests/README.md renamed to netapp_dataops_traditional/tests/gcnv_tests_readme.md

@@ -57,24 +57,24 @@
 
 def test_mcp_server_instance_exists():
     """Test that the MCP server instance is created correctly"""
-    from netapp_dataops.netapp_dataops_gcnv_mcp import mcp
+    from netapp_dataops.mcp_server.netapp_dataops_gcnv_mcp import mcp
     assert mcp is not None
     assert hasattr(mcp, 'name')
     assert mcp.name == "NetApp DataOps Traditional GCNV Toolkit MCP"
 
 
 def test_main_function():
     """Test the main entry point function"""
-    with patch('netapp_dataops.netapp_dataops_gcnv_mcp.asyncio.run') as mock_run:
-        with patch('netapp_dataops.netapp_dataops_gcnv_mcp.mcp.run') as mock_mcp_run:
-            from netapp_dataops.netapp_dataops_gcnv_mcp import main
+    with patch('netapp_dataops.mcp_server.netapp_dataops_gcnv_mcp.asyncio.run') as mock_run:
+        with patch('netapp_dataops.mcp_server.netapp_dataops_gcnv_mcp.mcp.run') as mock_mcp_run:
+            from netapp_dataops.mcp_server.netapp_dataops_gcnv_mcp import main
             main()
             mock_run.assert_called_once_with(mock_mcp_run.return_value)
 
 
 def test_imports_from_traditional_gcnv():
     """Test that the MCP server correctly imports from traditional GCNV module"""
-    import netapp_dataops.netapp_dataops_gcnv_mcp as mcp_module
+    import netapp_dataops.mcp_server.netapp_dataops_gcnv_mcp as mcp_module
 
     # Check that the required functions are imported
     assert hasattr(mcp_module, 'create_volume')
@@ -397,7 +397,7 @@ def test_error_message_patterns():
 
 def test_mcp_module_structure():
     """Test that the MCP module has expected structure"""
-    import netapp_dataops.netapp_dataops_gcnv_mcp as mcp_module
+    import netapp_dataops.mcp_server.netapp_dataops_gcnv_mcp as mcp_module
 
     # Check that key components exist
     assert hasattr(mcp_module, 'mcp')
@@ -417,7 +417,7 @@ def test_mcp_module_structure():
 def test_mcp_module_can_be_imported():
     """Test that the MCP module can be imported without errors"""
     try:
-        import netapp_dataops.netapp_dataops_gcnv_mcp
+        import netapp_dataops.mcp_server.netapp_dataops_gcnv_mcp
         # If we get here, import was successful
         assert True
     except ImportError as e:
@@ -426,7 +426,7 @@ def test_mcp_module_can_be_imported():
 
 def test_logging_configuration():
     """Test that logging is properly configured"""
-    import netapp_dataops.netapp_dataops_gcnv_mcp as mcp_module
+    import netapp_dataops.mcp_server.netapp_dataops_gcnv_mcp as mcp_module
 
     assert hasattr(mcp_module, 'logger')
     logger = mcp_module.logger
@@ -435,4 +435,4 @@ def test_logging_configuration():
     assert hasattr(logger, 'error')
     assert hasattr(logger, 'info')
     assert hasattr(logger, 'warning')
-    assert logger.name == 'netapp_dataops.netapp_dataops_gcnv_mcp'
+    assert logger.name == 'netapp_dataops.mcp_server.netapp_dataops_gcnv_mcp'