catocli 2.0.2__tar.gz → 2.0.4__tar.gz

{catocli-2.0.2/catocli.egg-info → catocli-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: catocli
-Version: 2.0.2
+Version: 2.0.4
 Summary: Cato Networks cli wrapper for the GraphQL API.
 Home-page: https://github.com/Cato-Networks/cato-cli
 Author: Cato Networks

{catocli-2.0.2 → catocli-2.0.4}/catocli/Utils/clidriver.py

@@ -256,6 +256,9 @@ def main(args=None):
 		else:
 			if response!=None:
 				print(json.dumps(response[0], sort_keys=True, indent=4))
+	except KeyboardInterrupt:
+		print("\n\nOperation interrupted by user (Ctrl+C). Exiting gracefully...")
+		exit(130)  # Standard exit code for SIGINT
 	except Exception as e:
 		if isinstance(e, AttributeError):
 			print('Missing arguments. Usage: catocli <operation> -h')
@@ -265,4 +268,4 @@ def main(args=None):
 		else:
 			print('ERROR: ',e)
 			traceback.print_exc()
-		exit(1)
+	exit(1)

{catocli-2.0.2 → catocli-2.0.4}/catocli/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "2.0.2"
+__version__ = "2.0.4"
 __cato_host__ = "https://api.catonetworks.com/api/v1/graphql2"

{catocli-2.0.2 → catocli-2.0.4}/catocli/parsers/custom/__init__.py

@@ -1,7 +1,8 @@
 
 import catocli.parsers.custom.customLib as customLib
 from catocli.parsers.custom.export_rules import export_rules_parse
-from catocli.parsers.custom.import_rules_to_tf import import_parse
+from catocli.parsers.custom.import_rules_to_tf import rule_import_parse
+from catocli.parsers.custom.import_sites_to_tf import site_import_parse
 from catocli.parsers.configure import configure_parse
 from catocli.parsers.custom.export_sites import export_sites_parse
 
@@ -33,14 +34,14 @@ def custom_parse(subparsers):
 
 	# Add additional custom parsers here 
 	export_rules_parse(subparsers)
-	import_parse(subparsers)
+	import_parser = rule_import_parse(subparsers)
+	site_import_parse(subparsers, import_parser)
 	configure_parse(subparsers)
 
 def get_help_custom(path):
 	matchCmd = "catocli "+path.replace("_"," ")
 	import os
 	pwd = os.path.dirname(__file__)
-	# doc = path+"/README.md"
 	abs_path = os.path.join(pwd, "README.md")
 	new_line = "\nEXAMPLES:\n"
 	lines = open(abs_path, "r").readlines()

{catocli-2.0.2 → catocli-2.0.4}/catocli/parsers/custom/customLib.py

@@ -1,5 +1,8 @@
 import os
 import json
+import subprocess
+import glob
+from pathlib import Path
 from graphql_client.api.call_api import ApiClient, CallApi
 from graphql_client.api_client import ApiException
 import logging
@@ -320,4 +323,239 @@ def getAccountID(args, configuration):
     if not account_id:
         raise ValueError("Account ID is required. Provide it using the -accountID flag or set CATO_ACCOUNT_ID environment variable.")
     
-    return account_id
+    return account_id
+
+def check_terraform_binary():
+    """Check if terraform binary is available"""
+    try:
+        result = subprocess.run(['terraform', '--version'], capture_output=True, text=True)
+        if result.returncode == 0:
+            return True, result.stdout.strip().split('\n')[0]
+        else:
+            return False, "Terraform binary not found or not working"
+    except FileNotFoundError:
+        return False, "Terraform binary not found in PATH"
+    except Exception as e:
+        return False, f"Error checking terraform binary: {e}"
+
+
+def check_terraform_config_files():
+    """Check if Terraform configuration files exist in current directory"""
+    tf_files = glob.glob('*.tf') + glob.glob('*.tf.json')
+    if tf_files:
+        return True, tf_files
+    else:
+        return False, []
+
+
+def check_terraform_init():
+    """Check if Terraform has been initialized"""
+    terraform_dir = Path('.terraform')
+    if terraform_dir.exists() and terraform_dir.is_dir():
+        # Check for providers
+        providers_dir = terraform_dir / 'providers'
+        if providers_dir.exists():
+            return True, "Terraform is initialized"
+        else:
+            return False, "Terraform directory exists but no providers found"
+    else:
+        return False, "Terraform not initialized (.terraform directory not found)"
+
+
+def check_module_exists(module_name):
+    """Check if the specified module exists in Terraform configuration"""
+    try:
+        # Remove 'module.' prefix if present
+        clean_module_name = module_name.replace('module.', '')
+        
+        # Method 1: Check .tf files directly for module definitions
+        tf_files = glob.glob('*.tf') + glob.glob('*.tf.json')
+        for tf_file in tf_files:
+            try:
+                with open(tf_file, 'r') as f:
+                    content = f.read()
+                    # Look for module "module_name" blocks
+                    if f'module "{clean_module_name}"' in content or f"module '{clean_module_name}'" in content:
+                        return True, f"Module '{clean_module_name}' found in {tf_file}"
+            except Exception as e:
+                print(f"Warning: Could not read {tf_file}: {e}")
+                continue
+        
+        # Method 2: Try terraform show -json as fallback
+        try:
+            result = subprocess.run(
+                ['terraform', 'show', '-json'],
+                capture_output=True,
+                text=True,
+                cwd=Path.cwd()
+            )
+            
+            if result.returncode == 0:
+                state_data = json.loads(result.stdout)
+                
+                # Check if module exists in configuration
+                if 'configuration' in state_data and state_data['configuration']:
+                    modules = state_data.get('configuration', {}).get('root_module', {}).get('module_calls', {})
+                    if clean_module_name in modules:
+                        return True, f"Module '{clean_module_name}' found in Terraform state"
+                
+                # Also check in planned_values for modules
+                if 'planned_values' in state_data and state_data['planned_values']:
+                    modules = state_data.get('planned_values', {}).get('root_module', {}).get('child_modules', [])
+                    for module in modules:
+                        module_addr = module.get('address', '')
+                        if clean_module_name in module_addr:
+                            return True, f"Module '{clean_module_name}' found in planned values"
+        except (subprocess.SubprocessError, json.JSONDecodeError) as e:
+            print(f"Warning: Could not check terraform state: {e}")
+        
+        return False, f"Module '{clean_module_name}' not found in Terraform configuration files"
+            
+    except Exception as e:
+        return False, f"Error checking module existence: {e}"
+
+
+def validate_terraform_environment(module_name, verbose=False):
+    """Validate the complete Terraform environment"""
+    print("\n Validating Terraform environment...")
+    
+    # 1. Check terraform binary
+    print("\n Checking Terraform binary...")
+    has_terraform, terraform_msg = check_terraform_binary()
+    if not has_terraform:
+        raise Exception(f" Terraform not available: {terraform_msg}")
+    if verbose:
+        print(f" {terraform_msg}")
+    else:
+        print(" Terraform binary found")
+    
+    # 2. Check for configuration files
+    print("\n Checking Terraform configuration files...")
+    has_config, config_files = check_terraform_config_files()
+    if not has_config:
+        raise Exception(" No Terraform configuration files (.tf or .tf.json) found in current directory")
+    if verbose:
+        print(f" Found {len(config_files)} configuration files: {', '.join(config_files)}")
+    else:
+        print(f" Found {len(config_files)} Terraform configuration files")
+    
+    # 3. Check if terraform is initialized
+    print("\n Checking Terraform initialization...")
+    is_initialized, init_msg = check_terraform_init()
+    if not is_initialized:
+        raise Exception(f" {init_msg}. Run 'terraform init' first.")
+    if verbose:
+        print(f" {init_msg}")
+    else:
+        print(" Terraform is initialized")
+    
+    # 4. Check if the specified module exists
+    print(f"\n Checking if module '{module_name}' exists...")
+    module_exists, module_msg = check_module_exists(module_name)
+    if not module_exists:
+        raise Exception(f" {module_msg}. Please add the module to your Terraform configuration first.")
+    if verbose:
+        print(f" {module_msg}")
+    else:
+        print(f" Module '{module_name}' found")
+    
+    # 5. Check if modules are properly installed by running terraform validate
+    print("\n Checking if modules are properly installed...")
+    try:
+        result = subprocess.run(
+            ['terraform', 'validate'],
+            capture_output=True,
+            text=True,
+            cwd=Path.cwd()
+        )
+        
+        if result.returncode != 0:
+            error_output = result.stderr.strip()
+            if "module is not yet installed" in error_output or "Module not installed" in error_output:
+                raise Exception(f" Terraform modules are not installed. Please run 'terraform init' to install all required modules.")
+            else:
+                raise Exception(f" Terraform validation failed:\n\n{error_output}")
+        
+        print(" All modules are properly installed")
+        
+    except subprocess.SubprocessError as e:
+        raise Exception(f" Failed to validate Terraform configuration: {e}")
+    
+    print("\n All Terraform environment checks passed!")
+
+
+
+def check_terraform_config_files():
+    """Check if Terraform configuration files exist in current directory"""
+    tf_files = glob.glob('*.tf') + glob.glob('*.tf.json')
+    if tf_files:
+        return True, tf_files
+    else:
+        return False, []
+
+
+def check_terraform_init():
+    """Check if Terraform has been initialized"""
+    terraform_dir = Path('.terraform')
+    if terraform_dir.exists() and terraform_dir.is_dir():
+        # Check for providers
+        providers_dir = terraform_dir / 'providers'
+        if providers_dir.exists():
+            return True, "Terraform is initialized"
+        else:
+            return False, "Terraform directory exists but no providers found"
+    else:
+        return False, "Terraform not initialized (.terraform directory not found)"
+
+
+def check_module_exists(module_name):
+    """Check if the specified module exists in Terraform configuration"""
+    try:
+        # Remove 'module.' prefix if present
+        clean_module_name = module_name.replace('module.', '')
+        
+        # Method 1: Check .tf files directly for module definitions
+        tf_files = glob.glob('*.tf') + glob.glob('*.tf.json')
+        for tf_file in tf_files:
+            try:
+                with open(tf_file, 'r') as f:
+                    content = f.read()
+                    # Look for module "module_name" blocks
+                    if f'module "{clean_module_name}"' in content or f"module '{clean_module_name}'" in content:
+                        return True, f"Module '{clean_module_name}' found in {tf_file}"
+            except Exception as e:
+                print(f"Warning: Could not read {tf_file}: {e}")
+                continue
+        
+        # Method 2: Try terraform show -json as fallback
+        try:
+            result = subprocess.run(
+                ['terraform', 'show', '-json'],
+                capture_output=True,
+                text=True,
+                cwd=Path.cwd()
+            )
+            
+            if result.returncode == 0:
+                state_data = json.loads(result.stdout)
+                
+                # Check if module exists in configuration
+                if 'configuration' in state_data and state_data['configuration']:
+                    modules = state_data.get('configuration', {}).get('root_module', {}).get('module_calls', {})
+                    if clean_module_name in modules:
+                        return True, f"Module '{clean_module_name}' found in Terraform state"
+                
+                # Also check in planned_values for modules
+                if 'planned_values' in state_data and state_data['planned_values']:
+                    modules = state_data.get('planned_values', {}).get('root_module', {}).get('child_modules', [])
+                    for module in modules:
+                        module_addr = module.get('address', '')
+                        if clean_module_name in module_addr:
+                            return True, f"Module '{clean_module_name}' found in planned values"
+        except (subprocess.SubprocessError, json.JSONDecodeError) as e:
+            print(f"Warning: Could not check terraform state: {e}")
+        
+        return False, f"Module '{clean_module_name}' not found in Terraform configuration files"
+            
+    except Exception as e:
+        return False, f"Error checking module existence: {e}"

{catocli-2.0.2 → catocli-2.0.4}/catocli/parsers/custom/export_rules/__init__.py

@@ -20,6 +20,7 @@ def export_rules_parse(subparsers):
     
     if_rules_parser.add_argument('-accountID', help='Account ID to export rules from (uses CATO_ACCOUNT_ID environment variable if not specified)', required=False)
     if_rules_parser.add_argument('--output-file-path', help='Full path including filename and extension for output file. If not specified, uses default: config_data/all_ifw_rules_and_sections_{account_id}.json')
+    if_rules_parser.add_argument('--append-timestamp', action='store_true', help='Append timestamp to the filename after account ID (format: YYYY-MM-DD_HH-MM-SS)')
     if_rules_parser.add_argument('-v', '--verbose', action='store_true', help='Verbose output')
     
     if_rules_parser.set_defaults(func=export_rules.export_if_rules_to_json)
@@ -33,6 +34,7 @@ def export_rules_parse(subparsers):
     
     wf_rules_parser.add_argument('-accountID', help='Account ID to export rules from (uses CATO_ACCOUNT_ID environment variable if not specified)', required=False)
     wf_rules_parser.add_argument('--output-file-path', help='Full path including filename and extension for output file. If not specified, uses default: config_data/all_wf_rules_and_sections_{account_id}.json')
+    wf_rules_parser.add_argument('--append-timestamp', action='store_true', help='Append timestamp to the filename after account ID (format: YYYY-MM-DD_HH-MM-SS)')
     wf_rules_parser.add_argument('-v', '--verbose', action='store_true', help='Verbose output')
     
     wf_rules_parser.set_defaults(func=export_rules.export_wf_rules_to_json)

{catocli-2.0.2 → catocli-2.0.4}/catocli/parsers/custom/export_rules/export_rules.py

@@ -1,6 +1,7 @@
 import os
 import json
 import sys
+from datetime import datetime
 from graphql_client.api.call_api import ApiClient, CallApi
 from graphql_client.api_client import ApiException
 from ..customLib import writeDataToFile, makeCall, getAccountID
@@ -64,10 +65,15 @@ def export_if_rules_to_json(args, configuration):
         processed_data['data']['policy']['internetFirewall']['policy']['rules'] = filtered_rules
         
         # Add index_in_section to each rule
-        # Group rules by section and add index_in_section
+        # Handle empty section names by assigning a default section name
         section_counters = {}
         for rule_data in processed_data['data']['policy']['internetFirewall']['policy']['rules']:
             section_name = rule_data['rule']['section']['name']
+            # If section name is empty, use "Default Section" as the section name
+            if not section_name or section_name.strip() == "":
+                section_name = "Default Section"
+                rule_data['rule']['section']['name'] = section_name
+            
             if section_name not in section_counters:
                 section_counters[section_name] = 0
             section_counters[section_name] += 1
@@ -104,12 +110,18 @@ def export_if_rules_to_json(args, configuration):
         
         # Replace the original sections array with the reformatted one
         processed_data['data']['policy']['internetFirewall']['policy']['sections'] = processed_sections
+        
+        # Handle timestamp in filename if requested
+        filename_template = "all_ifw_rules_and_sections_{account_id}.json"
+        if hasattr(args, 'append_timestamp') and args.append_timestamp:
+            timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+            filename_template = "all_ifw_rules_and_sections_{account_id}_" + timestamp + ".json"
             
         output_file = writeDataToFile(
             data=processed_data,
             args=args,
             account_id=account_id,
-            default_filename_template="all_ifw_rules_and_sections_{account_id}.json",
+            default_filename_template=filename_template,
             default_directory="config_data"
         )
 
@@ -157,9 +169,15 @@ def export_wf_rules_to_json(args, configuration):
         processed_data['data']['policy']['wanFirewall']['policy']['rules'] = filtered_rules
         
         # Add index_in_section to each rule
+        # Handle empty section names by assigning a default section name
         section_counters = {}
         for rule_data in processed_data['data']['policy']['wanFirewall']['policy']['rules']:
             section_name = rule_data['rule']['section']['name']
+            # If section name is empty, use "Default Section" as the section name
+            if not section_name or section_name.strip() == "":
+                section_name = "Default Section"
+                rule_data['rule']['section']['name'] = section_name
+            
             if section_name not in section_counters:
                 section_counters[section_name] = 0
             section_counters[section_name] += 1
@@ -174,8 +192,8 @@ def export_wf_rules_to_json(args, configuration):
                 "section_name": rule_info['section']['name'],
                 "rule_name": rule_info['name']
             })
-            # rule_info.pop("index_in_section", None)
-            # rule_info.pop("index", None)
+            rule_info.pop("index_in_section", None)
+            rule_info.pop("index", None)
             # rule_info["enabled"] = True
 
         # Add rules_in_sections to the policy structure
@@ -187,19 +205,25 @@ def export_wf_rules_to_json(args, configuration):
         processed_sections = [] 
         for index, section_data in enumerate(sections_with_ids):
             processed_sections.append({
-                "section_index": index,
+                "section_index": index+1,
                 "section_name": section_data['section']['name'],
                 "section_id": section_data['section']['id']
             })
         
         # Replace the original sections array with the reformatted one
         processed_data['data']['policy']['wanFirewall']['policy']['sections'] = processed_sections
+        
+        # Handle timestamp in filename if requested
+        filename_template = "all_wf_rules_and_sections_{account_id}.json"
+        if hasattr(args, 'append_timestamp') and args.append_timestamp:
+            timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+            filename_template = "all_wf_rules_and_sections_{account_id}_" + timestamp + ".json"
             
         output_file = writeDataToFile(
             data=processed_data,
             args=args,
             account_id=account_id,
-            default_filename_template="all_wf_rules_and_sections_{account_id}.json",
+            default_filename_template=filename_template,
             default_directory="config_data"
         )
         

{catocli-2.0.2 → catocli-2.0.4}/catocli/parsers/custom/export_sites/__init__.py

@@ -13,6 +13,7 @@ def export_sites_parse(subparsers):
     socket_sites_parser.add_argument('-accountID', help='Account ID to export data from (uses CATO_ACCOUNT_ID environment variable if not specified)', required=False)
     socket_sites_parser.add_argument('-siteIDs', help='Comma-separated list of site IDs to export (e.g., "132606,132964,133511")', required=False)
     socket_sites_parser.add_argument('--output-file-path', help='Full path including filename and extension for output file. If not specified, uses default: config_data/socket_site_data_{account_id}.json')
+    socket_sites_parser.add_argument('--append-timestamp', action='store_true', help='Append timestamp to the filename after account ID (format: YYYY-MM-DD_HH-MM-SS)')
     socket_sites_parser.add_argument('-v', '--verbose', action='store_true', help='Verbose output')
     
     socket_sites_parser.set_defaults(func=export_sites.export_socket_site_to_json)