cli-test-framework 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

cli_test_framework/__init__.py

@@ -5,7 +5,7 @@ This package provides tools for testing command-line applications and scripts
 with support for parallel execution and advanced file comparison capabilities.
 """
 
-__version__ = "0.2.2"
+__version__ = "0.2.4"
 __author__ = "Xiaotong Wang"
 __email__ = "xiaotongwang98@gmail.com"
 

cli_test_framework/commands/__init__.py

@@ -0,0 +1,9 @@
+"""
+Command-line commands for the CLI Testing Framework
+"""
+
+from . import compare
+
+__all__ = [
+    'compare'
+] 

cli_test_framework/commands/compare.py

@@ -0,0 +1,180 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+@file compare.py
+@brief Command for comparing files in cli-test-framework
+@author Xiaotong Wang
+@date 2024
+"""
+
+import sys
+import os
+import argparse
+import logging
+from pathlib import Path
+from ..file_comparator.factory import ComparatorFactory
+from ..file_comparator.result import ComparisonResult
+
+def configure_logging():
+    """Configure logging settings for the application"""
+    logger = logging.getLogger("cli_test_framework.file_comparator")
+    logger.setLevel(logging.INFO)
+    
+    ch = logging.StreamHandler()
+    ch.setLevel(logging.INFO)
+    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+    ch.setFormatter(formatter)
+    logger.addHandler(ch)
+    
+    return logger
+
+def parse_arguments():
+    """Parse command line arguments"""
+    parser = argparse.ArgumentParser(description="Compare two files.")
+    parser.add_argument("file1", help="Path to the first file")
+    parser.add_argument("file2", help="Path to the second file")
+    parser.add_argument("--start-line", type=int, default=1, help="Starting line number (1-based)")
+    parser.add_argument("--end-line", type=int, help="Ending line number (1-based)")
+    parser.add_argument("--start-column", type=int, default=1, help="Starting column number (1-based)")
+    parser.add_argument("--end-column", type=int, help="Ending column number (1-based)")
+    parser.add_argument("--file-type", help="Type of the files to compare", default="auto")
+    parser.add_argument("--encoding", default="utf-8", help="File encoding for text files")
+    parser.add_argument("--chunk-size", type=int, default=8192, help="Chunk size for binary comparison")
+    parser.add_argument("--output-format", choices=["text", "json", "html"], default="text",
+                        help="Output format for the comparison result")
+    parser.add_argument("--verbose", "-v", action="store_true", help="Enable verbose output")
+    parser.add_argument("--debug", action="store_true", help="Enable debug mode with detailed logging")
+    parser.add_argument("--similarity", action="store_true",
+                        help="When comparing binary files, compute and show similarity index")
+    parser.add_argument("--num-threads", type=int, default=4, help="Number of threads for parallel processing")
+    
+    # JSON comparison options
+    json_group = parser.add_argument_group('JSON comparison options')
+    json_group.add_argument("--json-compare-mode", choices=["exact", "key-based"], default="exact",
+                      help="JSON comparison mode: exact (default) or key-based")
+    json_group.add_argument("--json-key-field", help="Key field(s) to use for key-based JSON comparison")
+    
+    # H5 comparison options
+    h5_group = parser.add_argument_group('HDF5 comparison options')
+    h5_group.add_argument("--h5-table", help="Comma-separated list of table names to compare in HDF5 files")
+    h5_group.add_argument("--h5-table-regex", help="Regular expression pattern to match table names in HDF5 files")
+    h5_group.add_argument("--h5-structure-only", action="store_true", 
+                         help="Only compare HDF5 file structure without comparing content")
+    h5_group.add_argument("--h5-show-content-diff", action="store_true",
+                         help="Show detailed content differences when content differs")
+    h5_group.add_argument("--h5-rtol", type=float, default=1e-5,
+                         help="Relative tolerance for numerical comparison in HDF5 files")
+    h5_group.add_argument("--h5-atol", type=float, default=1e-8,
+                         help="Absolute tolerance for numerical comparison in HDF5 files")
+    
+    return parser.parse_args()
+
+def detect_file_type(file_path):
+    """Detect the type of file based on its extension"""
+    ext = file_path.suffix.lower()
+    if ext in ['.txt', '.py', '.md', '.json', '.xml', '.html', '.css', '.js']:
+        return 'text'
+    elif ext == '.json':
+        return 'json'
+    elif ext in ['.h5', '.hdf5']:
+        return 'h5'
+    else:
+        return 'binary'
+
+def format_result(result, output_format):
+    """Format the comparison result according to the specified output format"""
+    if output_format == "json":
+        return result.to_json()
+    elif output_format == "html":
+        return result.to_html()
+    else:
+        return str(result)
+
+def main():
+    """Main entry point for the compare-files command"""
+    logger = configure_logging()
+
+    try:
+        args = parse_arguments()
+        
+        if args.debug:
+            logger.setLevel(logging.DEBUG)
+            logger.debug("Debug mode enabled")
+
+        # Adjust for 0-based indexing
+        start_line = max(0, args.start_line - 1)
+        end_line = None if args.end_line is None else max(0, args.end_line - 1)
+        start_column = max(0, args.start_column - 1)
+        end_column = None if args.end_column is None else max(0, args.end_column - 1)
+
+        # Resolve file paths
+        file1_path = Path(args.file1).resolve()
+        file2_path = Path(args.file2).resolve()
+
+        if not file1_path.exists():
+            raise ValueError(f"File not found: {file1_path}")
+        if not file2_path.exists():
+            raise ValueError(f"File not found: {file2_path}")
+
+        # Determine file type
+        file_type = args.file_type
+        if file_type == "auto":
+            file_type = detect_file_type(file1_path)
+            logger.info(f"Auto-detected file type: {file_type}")
+
+        # Prepare comparator kwargs
+        comparator_kwargs = {
+            "encoding": args.encoding,
+            "chunk_size": args.chunk_size,
+            "verbose": args.verbose or args.debug,
+            "num_threads": args.num_threads
+        }
+        
+        # Add file type specific arguments
+        if file_type == "json":
+            comparator_kwargs["compare_mode"] = args.json_compare_mode
+            if args.json_key_field:
+                key_fields = [field.strip() for field in args.json_key_field.split(',')]
+                comparator_kwargs["key_field"] = key_fields[0] if len(key_fields) == 1 else key_fields
+        
+        if file_type == "h5":
+            if args.h5_table:
+                tables = [table.strip() for table in args.h5_table.split(',')]
+                comparator_kwargs["tables"] = tables
+            if args.h5_table_regex:
+                comparator_kwargs["table_regex"] = args.h5_table_regex
+            comparator_kwargs["structure_only"] = args.h5_structure_only
+            comparator_kwargs["show_content_diff"] = args.h5_show_content_diff
+            comparator_kwargs["rtol"] = args.h5_rtol
+            comparator_kwargs["atol"] = args.h5_atol
+        
+        if file_type == "binary":
+            comparator_kwargs["similarity"] = args.similarity
+
+        # Create comparator and perform comparison
+        comparator = ComparatorFactory.create_comparator(file_type, **comparator_kwargs)
+        result = comparator.compare_files(
+            file1_path,
+            file2_path,
+            start_line,
+            end_line,
+            start_column,
+            end_column
+        )
+
+        # Output result
+        output = format_result(result, args.output_format)
+        print(output)
+
+        sys.exit(0 if result.identical else 1)
+
+    except ValueError as ve:
+        logger.error(f"ValueError: {ve}")
+        sys.exit(1)
+    except Exception as e:
+        logger.exception(f"An unexpected error occurred")
+        sys.exit(1)
+
+if __name__ == "__main__":
+    main() 

cli_test_framework/utils/path_resolver.py

@@ -2,6 +2,7 @@ from pathlib import Path
 from typing import List
 import shlex
 import os
+import shutil
 
 class PathResolver:
     def __init__(self, workspace: Path):
@@ -24,9 +25,18 @@ class PathResolver:
         """
         解析命令路径
         - 系统命令（如echo, ping, dir等）保持原样
+        - 已安装的命令（在PATH中可找到）保持原样
         - 相对路径的可执行文件转换为绝对路径
         """
-        # 常见的系统命令列表
+        # 如果是绝对路径，保持原样
+        if Path(command).is_absolute():
+            return command
+        
+        # 检查命令是否在系统PATH中
+        if shutil.which(command) is not None:
+            return command
+        
+        # 常见的系统命令列表（作为备用，以防shutil.which在某些情况下失效）
         system_commands = {
             'echo', 'ping', 'dir', 'ls', 'cat', 'grep', 'find', 'sort', 
             'head', 'tail', 'wc', 'curl', 'wget', 'git', 'python', 'node',
@@ -34,8 +44,8 @@ class PathResolver:
             'kubectl', 'helm', 'terraform', 'ansible', 'ssh', 'scp', 'rsync'
         }
         
-        # 如果是系统命令或绝对路径，保持原样
-        if command in system_commands or Path(command).is_absolute():
+        # 如果在系统命令列表中，保持原样
+        if command in system_commands:
             return command
         
         # 否则当作相对路径处理

{cli_test_framework-0.2.2.dist-info → cli_test_framework-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cli-test-framework
-Version: 0.2.2
+Version: 0.2.4
 Summary: A small command line testing framework in Python with file comparison capabilities.
 Home-page: https://github.com/yourusername/cli-test-framework
 Author: Xiaotong Wang

{cli_test_framework-0.2.2.dist-info → cli_test_framework-0.2.4.dist-info}/RECORD

@@ -1,5 +1,7 @@
-cli_test_framework/__init__.py,sha256=MoSrLTpw-nT6hv20PjLohyWKn5vdLPNC4pODsUhj4kk,612
+cli_test_framework/__init__.py,sha256=03ejVkeXhQj_JPYSuPXkJ0CD30kN76tcSNGRgafcYJw,612
 cli_test_framework/cli.py,sha256=RgFyXOo-Dxj1bUjeqhj0l-vXaaMH8lAQcTlVQyzWcdU,4860
+cli_test_framework/commands/__init__.py,sha256=xSnEAKY71h2k-uDpbxzHvoUMU17zAX80686nRRdSV9E,120
+cli_test_framework/commands/compare.py,sha256=qxXU684J7ObHfG-PUa3GhoTFSbmQYbyhXnhplw7Al_k,7706
 cli_test_framework/core/__init__.py,sha256=yDI5DhuduA76F4SvfahJ3KAMyGOxrzoSifauTLY7SOk,304
 cli_test_framework/core/assertions.py,sha256=UEm87MxQ_KS1hTdA7lPBbhroEZtmfvsVK8kxtGgRIXI,1256
 cli_test_framework/core/base_runner.py,sha256=idcFPY2-SEMZmWydBZ93VuNvuVTvSAxkoMqUAVoQb2s,2152
@@ -21,10 +23,10 @@ cli_test_framework/runners/json_runner.py,sha256=i6h9G7tTIhY9uT-i-Jm50qvnn6myw3c
 cli_test_framework/runners/parallel_json_runner.py,sha256=XUHOljkpEADuNSCtnrbUcGgZo7sdbLGbUVyRa2GmH5k,4607
 cli_test_framework/runners/yaml_runner.py,sha256=rIwCmuKQ32dUdp1y3189StIAGGNpQ5175hknI4xvewc,3714
 cli_test_framework/utils/__init__.py,sha256=kiSQretb8Jnm8nuRRTOtweUgFZoM2a5WZOk28JpLlzg,216
-cli_test_framework/utils/path_resolver.py,sha256=gkICP-qP_18f2nsH9ekOg21jP7Yrf3hBcQuJ8cOxf4Y,8670
+cli_test_framework/utils/path_resolver.py,sha256=7BWpuZLzJFY0i4REVY5Qfvx_cVnmI9T1d8O6BPPIUPw,9036
 cli_test_framework/utils/report_generator.py,sha256=SEJ4psyQFQ94wXprupmy6QyE2j3c8D9Nwn4KPBYslYo,2924
-cli_test_framework-0.2.2.dist-info/METADATA,sha256=UTLy384eEx0IRVsYrAfCyHMEelb4RTIicbM2LPklQc0,13149
-cli_test_framework-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cli_test_framework-0.2.2.dist-info/entry_points.txt,sha256=Gsx18WQq8ICp-F6OkHsUxyO-RSYY8vrvvNwF16enEfM,114
-cli_test_framework-0.2.2.dist-info/top_level.txt,sha256=kCcU27wQVPOFxkzCAlS0IInGH2dHXqH-LO4oxYRBkuE,19
-cli_test_framework-0.2.2.dist-info/RECORD,,
+cli_test_framework-0.2.4.dist-info/METADATA,sha256=hLdOzzSyAX5tLhUL_38EDJN5ihLReJkR8VSGHd1HCjw,13149
+cli_test_framework-0.2.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cli_test_framework-0.2.4.dist-info/entry_points.txt,sha256=Gsx18WQq8ICp-F6OkHsUxyO-RSYY8vrvvNwF16enEfM,114
+cli_test_framework-0.2.4.dist-info/top_level.txt,sha256=kCcU27wQVPOFxkzCAlS0IInGH2dHXqH-LO4oxYRBkuE,19
+cli_test_framework-0.2.4.dist-info/RECORD,,