Pull request #16: Feature/gcnv traditional

Merge in SIE-BB/netapp-dataops-toolkit from feature/gcnv-traditional to release-v2.7.0

* commit 'f5022c330e6442304251d762bdc5735e2d80c4be':
  fixing output format for delete volume and delete snapshot
  Updates: - moving gcnv mcp server to mcp_server folder - adding path to scripts in setup.cfg
  adding mcp to scripts in setup config
  including necessary changes for adding logging module
  adding logging_utils.py to the correct path
  copied logging_utils.py from feature/code-refactoring/logger

Author: sushma-m1

netapp_dataops_traditional/docs/gcnv_readme.md

@@ -210,8 +210,9 @@ def create_volume(
     large_capacity: bool = None,            # Flag indicating if the volume will be a large capacity volume or a regular volume. If set to True, the volume will be a large capacity volume.
     multiple_endpoints: bool = None,        # Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
     tiering_enabled: bool = None,           # Flag indicating if the volume has tiering policy enable/pause.
-    cooling_threshold_days: int = None      # Time in days to mark the volume's data block as cold and make it eligible for tiering. It can be range from 2-183.
-):
+    cooling_threshold_days: int = None,     # Time in days to mark the volume's data block as cold and make it eligible for tiering. It can be range from 2-183.
+    print_output: bool = False              # print log to the console
+) -> Dict[str, Any]:
 ```
 
 #### Return Values
@@ -301,8 +302,9 @@ def clone_volume(
     large_capacity: bool = None,            # Flag indicating if the volume will be a large capacity volume or a regular volume. If set to True, the volume will be a large capacity volume.
     multiple_endpoints: bool = None,        # Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
     tiering_enabled: bool = None,           # Flag indicating if the volume has tiering policy enable/pause.
-    cooling_threshold_days: int = None      # Time in days to mark the volume's data block as cold and make it eligible for tiering. It can be range from 2-183.
-):
+    cooling_threshold_days: int = None,     # Time in days to mark the volume's data block as cold and make it eligible for tiering. It can be range from 2-183.
+    print_output: bool = False              # print log to the console
+) -> Dict[str, Any]:
 ```
 
 #### Return Values
@@ -353,10 +355,12 @@ Volumes can be deleted, with options for forced deletion if necessary.
 #### Function Definition
 ```python
 def delete_volume(
-        project_id: str,          # Required. The ID of the project.
-        location: str,            # Required. The location of the volume.
-        volume_id: str,           # Required. The ID of the volume to delete.
-        force: bool = False):     # If set to True, the volume will be deleted even if it is not empty.
+        project_id: str,            # Required. The ID of the project.
+        location: str,              # Required. The location of the volume.
+        volume_id: str,             # Required. The ID of the volume to delete.
+        force: bool = False,        # If set to True, the volume will be deleted even if it is not empty.
+        print_output: bool = False  # print log to the console
+) -> Dict[str, Any]:
 ```
 #### Return Values
 ```
@@ -399,8 +403,12 @@ Retrieve all volumes in a project/location.
 #### Function Definition
 ```python
 from netapp_dataops.traditional import gcnv
-        project_id: str,          # Required. The ID of the project.
-        location: str):           # Required. The location to list volumes from.
+
+def list_volumes(
+        project_id: str,            # Required. The ID of the project.
+        location: str,              # Required. The location to list volumes from.
+        print_output: bool = False  # print log to the console
+) -> Dict[str, Any]:   
 ```
 #### Return Values
 ```
@@ -451,8 +459,9 @@ def create_snapshot(
     volume_id: str,             # Required. The ID of the volume to delete.
     snapshot_id: str,           # Required. The ID of the snapshot to create.
     description: str = None,    # The description of the snapshot.
-    labels: dict = None         # The labels to assign to the snapshot.
-):
+    labels: dict = None,        # The labels to assign to the snapshot.
+    print_output: bool = False  # print log to the console
+) -> Dict[str, Any]:
 ```
 #### Return Values
 ```
@@ -500,8 +509,9 @@ def delete_snapshot(
     project_id: str,          # Required. The ID of the project.
     location: str,            # Required. The location of the volume.
     volume_id: str,           # Required. The ID of the volume.
-    snapshot_id: str          # Required. The ID of the snapshot to delete.
-):
+    snapshot_id: str,         # Required. The ID of the snapshot to delete.
+    print_output: bool = False  # print log to the console
+) -> Dict[str, Any]:
 ```
 
 #### Return Values
@@ -546,10 +556,11 @@ Users can enumerate all snapshots associated with a particular volume.
 #### Function Definition
 ```python
 def list_snapshots(
-    project_id: str,        # Required. The ID of the project.
-    location: str,          # Required. The location to list volumes from.
-    volume_id: str          # Required. The ID of the volume to list snapshots for.
-):
+    project_id: str,            # Required. The ID of the project.
+    location: str,              # Required. The location to list volumes from.
+    volume_id: str,             # Required. The ID of the volume to list snapshots for.
+    print_output: bool = False  # print log to the console
+) -> Dict[str, Any]:
 ```
 
 #### Return Values
@@ -608,8 +619,9 @@ def create_replication(
     tiering_enabled: bool = None,                     # Whether tiering is enabled on the destination volume.
     cooling_threshold_days: int = None,               # Time in days to mark the volume's data block as cold and make it eligible for tiering. It can be range from 2-183.
     description: str = None,                          # A description about this replication relationship.
-    labels: dict = None                               # Resource labels to represent user provided metadata
-):
+    labels: dict = None,                              # Resource labels to represent user provided metadata
+    print_output: bool = False  # print log to the console
+) -> Dict[str, Any]:
 ```
 
 #### Return Values

netapp_dataops_traditional/netapp_dataops/logging_utils.py

@@ -0,0 +1,22 @@
+import logging
+
+def setup_logger(name: str, level: int = logging.DEBUG) -> logging.Logger:
+    """
+    Sets up a logger with a console handler.
+
+    Args:
+        name (str): The name of the logger.
+        level (int): The logging level. Default is logging.DEBUG.
+
+    Returns:
+        logging.Logger: Configured logger.
+    """
+    logger = logging.getLogger(name)
+    logger.setLevel(level)
+    if not logger.hasHandlers():
+        console_handler = logging.StreamHandler()
+        console_handler.setLevel(level)
+        formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+        console_handler.setFormatter(formatter)
+        logger.addHandler(console_handler)
+    return logger

…etapp_dataops/netapp_dataops_gcnv_mcp.py …ps/mcp_server/netapp_dataops_gcnv_mcp.pynetapp_dataops_traditional/netapp_dataops/netapp_dataops_gcnv_mcp.py renamed to netapp_dataops_traditional/netapp_dataops/mcp_server/netapp_dataops_gcnv_mcp.py netapp_dataops_traditional/netapp_dataops/netapp_dataops_gcnv_mcp.py renamed to netapp_dataops_traditional/netapp_dataops/mcp_server/netapp_dataops_gcnv_mcp.py

@@ -1,15 +1,12 @@
 #!/usr/bin/env python3
-import sys
 import asyncio
-import json
-import logging
 from typing import Any, Dict, Optional
 from fastmcp import FastMCP
 from google.protobuf.json_format import MessageToDict
 
-# Configure logging
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
+from netapp_dataops.logging_utils import setup_logger
+
+logger = setup_logger(__name__)
 
 # Importing the necessary functions from the traditional GCNV module
 from netapp_dataops.traditional.gcnv import (
@@ -50,7 +47,8 @@ async def create_volume_tool(
     large_capacity: Optional[bool] = None,
     multiple_endpoints: Optional[bool] = None,
     tiering_enabled: Optional[bool] = None,
-    cooling_threshold_days: Optional[int] = None
+    cooling_threshold_days: Optional[int] = None,
+    print_output: bool = False
 ) -> Dict[str, Any]:
     """
     Use this tool to create a new volume in the specified project and location.
@@ -144,6 +142,9 @@ async def create_volume_tool(
             Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering.
             It can be range from 2-183.
             Defaults to 31.
+        print_output (bool):
+            Optional. If set to True, prints log messages to the console.
+            Defaults to False.
 
     Returns:
         dict: Dictionary with keys
@@ -180,10 +181,12 @@ async def create_volume_tool(
         large_capacity=large_capacity,
         multiple_endpoints=multiple_endpoints,
         tiering_enabled=tiering_enabled,
-        cooling_threshold_days=cooling_threshold_days
+        cooling_threshold_days=cooling_threshold_days,
+        print_output=print_output
     )
     if response['status'] == 'error':
-        logger.error(f"Error creating volume: {response['message']}")
+        if print_output:
+            logger.error(f"Error creating volume: {response['message']}")
     return response
 
 
@@ -214,7 +217,8 @@ async def clone_volume_tool(
     large_capacity: Optional[bool] = None,
     multiple_endpoints: Optional[bool] = None,
     tiering_enabled: Optional[bool] = None,
-    cooling_threshold_days: Optional[int] = None
+    cooling_threshold_days: Optional[int] = None,
+    print_output: bool = False
 ) -> Dict[str, Any]:
     """
     Use this tool to clone an existing volume.
@@ -308,6 +312,9 @@ async def clone_volume_tool(
             Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering.
             It can be range from 2-183.
             Defaults to 31.
+        print_output (bool):
+            Optional. If set to True, prints log messages to the console.
+            Defaults to False.
 
     Returns:
         dict: Dictionary with keys
@@ -345,16 +352,19 @@ async def clone_volume_tool(
         large_capacity=large_capacity,
         multiple_endpoints=multiple_endpoints,
         tiering_enabled=tiering_enabled,
-        cooling_threshold_days=cooling_threshold_days
+        cooling_threshold_days=cooling_threshold_days,
+        print_output=print_output
     )
     if response['status'] == 'error':
-        logger.error(f"Error cloning volume: {response.get('message', 'Unknown error')}")
+        if print_output:
+            logger.error(f"Error cloning volume: {response.get('message', 'Unknown error')}")
     return response
 
 @mcp.tool(name = "List Volumes")
 async def list_volumes_tool(
     project_id: str,
-    location: str
+    location: str,
+    print_output: bool = False
 ) -> Dict[str, Any]:
     """
     Use this tool to list all volumes in a project and location.
@@ -364,6 +374,9 @@ async def list_volumes_tool(
             Required. The ID of the project.
         location (str):
             Required. The location to list volumes from.
+        print_output (bool):
+            Optional. If set to True, prints log messages to the console.
+            Defaults to False.
 
     Returns:
         dict: Dictionary with keys
@@ -377,10 +390,12 @@ async def list_volumes_tool(
     """    
     response = list_volumes(
         project_id=project_id,
-        location=location
+        location=location,
+        print_output=print_output
     )
     if response['status'] == 'error':
-        logger.error(f"Error listing volumes: {response['message']}")
+        if print_output:
+            logger.error(f"Error listing volumes: {response['message']}")
     return response
 
 @mcp.tool(name = "Create Snapshot")
@@ -390,7 +405,8 @@ async def create_snapshot_tool(
     volume_id: str,
     snapshot_id: str,
     description: Optional[str] = None,
-    labels: Optional[dict] = None
+    labels: Optional[dict] = None,
+    print_output: bool = False
 ) -> Dict[str, Any]:
     """
     Use this tool to create a near-instantaneous, space-efficient, read-only copy of an existing data volume, called a snapshot. 
@@ -410,6 +426,9 @@ async def create_snapshot_tool(
             Optional. The description of the snapshot. Defaults to None.
         labels (dict, optional):
             Optional. The labels to assign to the snapshot. Defaults to None.
+        print_output (bool):
+            Optional. If set to True, prints log messages to the console.
+            Defaults to False.
 
     Returns:
         dict: Dictionary with keys
@@ -427,17 +446,20 @@ async def create_snapshot_tool(
         volume_id=volume_id,
         snapshot_id=snapshot_id,
         description=description,
-        labels=labels
+        labels=labels,
+        print_output=print_output
     )
     if response['status'] == 'error':
-        logger.error(f"Error creating snapshot: {response['message']}")
+        if print_output:
+            logger.error(f"Error creating snapshot: {response['message']}")
     return response
 
 @mcp.tool(name = "List Snapshots")
 async def list_snapshots_tool(
     project_id: str,
     location: str,
-    volume_id: str
+    volume_id: str,
+    print_output: bool = False
 ) -> Dict[str, Any]:
     """
     Use this tool to list all snapshots for a given volume.
@@ -449,6 +471,9 @@ async def list_snapshots_tool(
             Required. The location to list volumes from.
         volume_id (str):
             Required. The ID of the volume to list snapshots for.
+        print_output (bool):
+            Optional. If set to True, prints log messages to the console.
+            Defaults to False.
 
     Returns:
         dict: Dictionary with keys
@@ -463,10 +488,12 @@ async def list_snapshots_tool(
     response = list_snapshots(
             project_id=project_id,
             location=location,
-            volume_id=volume_id
+            volume_id=volume_id,
+            print_output=print_output
     )
     if response['status'] == 'error':
-        logger.error(f"Error listing snapshots: {response['message']}")
+        if print_output:
+            logger.error(f"Error listing snapshots: {response['message']}")
     return response
 
 @mcp.tool(name = "Create Replication")
@@ -483,7 +510,8 @@ async def create_replication_tool(
     tiering_enabled: Optional[bool] = None,
     cooling_threshold_days: Optional[int] = None,
     description: Optional[str] = None,
-    labels: Optional[dict] = None
+    labels: Optional[dict] = None,
+    print_output: bool = False
 ) -> Dict[str, Any]:
     """
     Use this tool to create a replication for a volume.
@@ -565,6 +593,9 @@ async def create_replication_tool(
         labels (dict, MutableMapping[str, str]):
             Optional. Resource labels to represent user provided
             metadata.
+        print_output (bool):
+            Optional. If set to True, prints log messages to the console.
+            Defaults to False.
 
     Returns:
         dict: Dictionary with keys
@@ -589,10 +620,12 @@ async def create_replication_tool(
         tiering_enabled=tiering_enabled,
         cooling_threshold_days=cooling_threshold_days,
         description=description,
-        labels=labels
+        labels=labels,
+        print_output=print_output
     )
     if response['status'] == 'error':
-        logger.error(f"Error creating replication: {response['message']}")
+        if print_output:
+            logger.error(f"Error creating replication: {response['message']}")
     return response
 
 # Register the MCP instance to run the tools

netapp_dataops_traditional/netapp_dataops/traditional/gcnv/base.py

@@ -1,10 +1,10 @@
 from google.cloud import netapp_v1
 from google.protobuf.json_format import MessageToDict
 from typing import Dict, List, Any, Union
-import logging
 
-logger = logging.getLogger(__name__)
+from netapp_dataops.logging_utils import setup_logger
 
+logger = setup_logger(__name__)
 
 def _serialize(details) -> Union[Dict[str, Any], List[Any], str, int, float, bool, None]:
     """Internal helper to convert protobuf objects (and lists) to JSON-serializable structures."""
@@ -18,9 +18,14 @@ def _serialize(details) -> Union[Dict[str, Any], List[Any], str, int, float, boo
     return str(details)
 
 
-def create_client() -> netapp_v1.NetAppClient:
+def create_client(print_output: bool = False) -> netapp_v1.NetAppClient:
     """Create and return a NetApp client.
     
+    Args:
+        print_output (bool):
+            Optional. If set to True, prints log messages to the console.
+            Defaults to False.
+
     Returns:
         netapp_v1.NetAppClient: The NetApp client instance.
         
@@ -30,7 +35,8 @@ def create_client() -> netapp_v1.NetAppClient:
     try:
         return netapp_v1.NetAppClient()
     except Exception as e:
-        logger.error(f"An error occurred while creating the NetApp client: {e}")
+        if print_output:
+            logger.error(f"An error occurred while creating the NetApp client: {e}")
         raise e