catocli 2.0.1__py3-none-any.whl → 2.0.3__py3-none-any.whl

schema/catolib.py

@@ -552,7 +552,7 @@ def show_version_info(args, configuration=None):
 			print("Unable to check for updates (check your internet connection)")
 	return [{"success": True, "current_version": catocli.__version__, "latest_version": latest_version if not args.current_only else None}]
 
-def get_configuration():
+def get_configuration(skip_api_key=False):
 	configuration = Configuration()
 	configuration.verify_ssl = False
 	configuration.debug = CATO_DEBUG
@@ -574,7 +574,9 @@ def get_configuration():
 		print(f"Run 'catocli configure set --profile {profile_name}' to update your credentials.")
 		exit(1)
 	
-	configuration.api_key["x-api-key"] = credentials['cato_token']
+	# Only set API key if not using custom headers file
+	if not skip_api_key:
+		configuration.api_key["x-api-key"] = credentials['cato_token']
 	configuration.host = credentials['endpoint']
 	configuration.accountID = credentials['account_id']
 	
@@ -590,6 +592,7 @@ https://github.com/catonetworks/cato-api-explorer
 parser = argparse.ArgumentParser(prog='catocli', usage='%(prog)s <operationType> <operationName> [options]', description=defaultReadmeStr)
 parser.add_argument('--version', action='version', version=catocli.__version__)
 parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
 subparsers = parser.add_subparsers()
 
 # Version command - enhanced with update checking
@@ -624,6 +627,28 @@ def parse_headers(header_strings):
 			headers[key.strip()] = value.strip()
 	return headers
 
+def parse_headers_from_file(file_path):
+	headers = {}
+	try:
+		with open(file_path, 'r') as f:
+			for line_num, line in enumerate(f, 1):
+				line = line.strip()
+				if not line or line.startswith('#'):
+					# Skip empty lines and comments
+					continue
+				if ':' not in line:
+					print(f"ERROR: Invalid header format in {file_path} at line {line_num}: '{line}'. Use 'Key: Value' format.")
+					exit(1)
+				key, value = line.split(':', 1)
+				headers[key.strip()] = value.strip()
+	except FileNotFoundError:
+		print(f"ERROR: Headers file '{file_path}' not found.")
+		exit(1)
+	except IOError as e:
+		print(f"ERROR: Could not read headers file '{file_path}': {e}")
+		exit(1)
+	return headers
+
 def main(args=None):
 	# Check if no arguments provided or help is requested
 	if args is None:
@@ -644,13 +669,20 @@ def main(args=None):
 		if hasattr(args, 'func') and hasattr(args.func, '__module__') and 'configure' in str(args.func.__module__):
 			response = args.func(args, None)
 		else:
+			# Check if using headers file to determine if we should skip API key
+			using_headers_file = hasattr(args, 'headers_file') and args.headers_file
+			
 			# Get configuration from profiles
-			configuration = get_configuration()
+			configuration = get_configuration(skip_api_key=using_headers_file)
 			
 			# Parse custom headers if provided
+			custom_headers = {}
 			if hasattr(args, 'headers') and args.headers:
-				custom_headers = parse_headers(args.headers)
-				configuration.custom_headers.update(custom_headers)					
+				custom_headers.update(parse_headers(args.headers))
+			if hasattr(args, 'headers_file') and args.headers_file:
+				custom_headers.update(parse_headers_from_file(args.headers_file))
+			if custom_headers:
+				configuration.custom_headers.update(custom_headers)
 			# Handle account ID override
 			if args.func.__name__ != "createRawRequest":
 				if hasattr(args, 'accountID') and args.accountID is not None:
@@ -685,10 +717,13 @@ def writeOperationParsers(catoApiSchema):
 from ..parserApiClient import createRawRequest, get_help
 
 def raw_parse(raw_parser):
-	raw_parser.add_argument('json', help='Query, Variables and opertaionName in JSON format.')
-	raw_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print test request preview without sending api call')
+	raw_parser.add_argument('json', nargs='?', default='{{}}', help='Query, Variables and opertaionName in JSON format (defaults to empty object if not provided).')
+	raw_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
 	raw_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
 	raw_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	raw_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	raw_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
+	raw_parser.add_argument('--endpoint', dest='endpoint', help='Override the API endpoint URL (e.g., https://api.catonetworks.com/api/v1/graphql2)')
 	raw_parser.set_defaults(func=createRawRequest,operation_name='raw')
 """
 	parserPath = "../catocli/parsers/raw"
@@ -704,15 +739,11 @@ def query_siteLocation_parse(query_subparsers):
 	query_siteLocation_parser = query_subparsers.add_parser('siteLocation', 
 			help='siteLocation local cli query', 
 			usage=get_help("query_siteLocation"))
-
-	query_siteLocation_parser.add_argument('json', help='Variables in JSON format.')
+	query_siteLocation_parser.add_argument('json', nargs='?', default='{{}}', help='Variables in JSON format (defaults to empty object if not provided).')
 	query_siteLocation_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_siteLocation_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	query_siteLocation_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	query_siteLocation_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	query_siteLocation_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	query_siteLocation_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	query_siteLocation_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
 	query_siteLocation_parser.set_defaults(func=querySiteLocation,operation_name='query.siteLocation')
 """
 	parserPath = "../catocli/parsers/query_siteLocation"
@@ -738,14 +769,13 @@ def {parserName}_parse({operationType}_subparsers):
 """
 			if "path" in parser:
 				cliDriverStr += f"""
-	{parserName}_parser.add_argument('json', help='Variables in JSON format.')
+	{parserName}_parser.add_argument('json', nargs='?', default='{{}}', help='Variables in JSON format (defaults to empty object if not provided).')
 	{parserName}_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	{parserName}_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	{parserName}_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	{parserName}_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	{parserName}_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	{parserName}_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	{parserName}_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	{parserName}_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	{parserName}_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
 	{parserName}_parser.set_defaults(func=createRequest,operation_name='{parserName.replace("_",".")}')
 """
 			else:
@@ -770,14 +800,13 @@ def renderSubParser(subParser,parentParserPath):
 		if "path" in subOperation:
 			command = parentParserPath.replace("_"," ")+" "+subOperationName
 			cliDriverStr += f"""
-	{subParserPath}_parser.add_argument('json', help='Variables in JSON format.')
+	{subParserPath}_parser.add_argument('json', nargs='?', default='{{}}', help='Variables in JSON format (defaults to empty object if not provided).')
 	{subParserPath}_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	{subParserPath}_parser.add_argument('-t', const=True, default=False, nargs='?', 
-		help='Print test request preview without sending api call')
-	{subParserPath}_parser.add_argument('-v', const=True, default=False, nargs='?', 
-		help='Verbose output')
-	{subParserPath}_parser.add_argument('-p', const=True, default=False, nargs='?', 
-		help='Pretty print')
+	{subParserPath}_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+	{subParserPath}_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+	{subParserPath}_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+	{subParserPath}_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+	{subParserPath}_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
 	{subParserPath}_parser.set_defaults(func=createRequest,operation_name='{subOperation["path"]}')
 """
 		else:
@@ -803,6 +832,10 @@ def writeReadmes(catoApiSchema):
 `catocli raw '{ "query": "query operationNameHere($yourArgument:String!) { field1 field2 }", "variables": { "yourArgument": "string", "accountID": "10949" }, "operationName": "operationNameHere" } '`
 
 `catocli raw '{ "query": "mutation operationNameHere($yourArgument:String!) { field1 field2 }", "variables": { "yourArgument": "string", "accountID": "10949" }, "operationName": "operationNameHere" } '`
+
+#### Override API endpoint
+
+`catocli raw --endpoint https://custom-api.example.com/graphql '<json>'`
 """
 	parserPath = "../catocli/parsers/raw"
 	if not os.path.exists(parserPath):
@@ -1009,7 +1042,7 @@ def generateGraphqlPayload(variablesObj,operation,operationName):
 	queryStr += ") {\n" + renderArgsAndFields("", variablesObj, operation, operation["type"]["definition"], "		") + "	}"
 	queryStr += indent + "\n}";
 	body = {
-		"query":queryStr.replace("\n", " ").replace("\t", " ").replace("	", " ").replace("   ", " ").replace("  ", " "),
+		"query":queryStr,
 		"variables":variablesObj,
 		"operationName":renderCamelCase(".".join(operationAry)),
 	}