robotframework-logxml2chunks 1.0.0__tar.gz → 1.1.1__tar.gz

{robotframework_logxml2chunks-1.0.0 → robotframework_logxml2chunks-1.1.1}/LogXML2Chunks/LogXML2Chunks.py

@@ -13,10 +13,25 @@ import os
 import sys
 import copy
 import re
+import hashlib
 from pathlib import Path
 
 class LogXML2Chunks:
 
+    def __init__(self, debug=True):
+        """
+        Initialize LogXML2Chunks instance.
+        
+        Args:
+            debug: Enable debug output (default: True)
+        """
+        self.debug = debug
+
+    def _debug_print(self, *args, **kwargs):
+        """Print only if debug mode is enabled."""
+        if self.debug:
+            print(*args, **kwargs)
+
     def _extract_steps_from_documentation(self, doc_text):
         """
         Extract steps from test documentation.
@@ -169,6 +184,10 @@ class LogXML2Chunks:
             if potential_log.exists():
                 log_filepath = str(potential_log)
             
+            # Calculate checksum based on test_name and documentation
+            checksum_data = f"{test_name}{test_doc}".encode('utf-8')
+            checksum = hashlib.md5(checksum_data).hexdigest()
+            
             # Build result dictionary
             result = {
                 'index': idx,
@@ -179,9 +198,10 @@ class LogXML2Chunks:
                 'steps': test_steps,
                 'source': test_source,
                 'xml_file': str(xml_filepath),
+                'checksum': checksum,
                 'success': True
-            }
-            
+            }            
+
             # Add log file if it exists
             if log_filepath:
                 result['log_file'] = log_filepath
@@ -222,33 +242,33 @@ class LogXML2Chunks:
         
         # Check if folder exists
         if not folder.exists():
-            print(f"Error: Folder does not exist: {folder_path}")
+            self._debug_print(f"Error: Folder does not exist: {folder_path}")
             return results
         
         if not folder.is_dir():
-            print(f"Error: Path is not a directory: {folder_path}")
+            self._debug_print(f"Error: Path is not a directory: {folder_path}")
             return results
         
         # Find all XML files in the folder
         xml_files = sorted(folder.glob('*.xml'))
         
         if not xml_files:
-            print(f"Warning: No XML files found in {folder_path}")
+            self._debug_print(f"Warning: No XML files found in {folder_path}")
             return results
         
-        print(f"Found {len(xml_files)} XML files in {folder_path}")
+        self._debug_print(f"Found {len(xml_files)} XML files in {folder_path}")
         
         # Process each XML file
         for xml_file in xml_files:
-            print(f"  Processing: {xml_file.name}")
+            self._debug_print(f"  Processing: {xml_file.name}")
             chunk_data = self.get_data_from_chunk(str(xml_file))
             results.append(chunk_data)
             
             # Print status
             if chunk_data.get('success', False):
-                print(f"    ✓ {chunk_data.get('test_name', 'Unknown')} - {chunk_data.get('status', 'Unknown')}")
+                self._debug_print(f"    ✓ {chunk_data.get('test_name', 'Unknown')} - {chunk_data.get('status', 'Unknown')}")
             else:
-                print(f"    ✗ Error: {chunk_data.get('error', 'Unknown error')}")
+                self._debug_print(f"    ✗ Error: {chunk_data.get('error', 'Unknown error')}")
         
         return results
 
@@ -275,7 +295,7 @@ class LogXML2Chunks:
             for test in suite.findall('test'):
                 test_cases.append((suite, test))
 
-        print(f"Found {len(test_cases)} test cases")
+        self._debug_print(f"Found {len(test_cases)} test cases")
 
         # Extract each test case
         for idx, (suite, test) in enumerate(test_cases, 1):
@@ -287,7 +307,7 @@ class LogXML2Chunks:
             xml_filename = f"{idx}_{safe_name}_{test_id}.xml"
             xml_filepath = output_path / xml_filename
 
-            print(f"\n[{idx}/{len(test_cases)}] Processing: {test_name}")
+            self._debug_print(f"\n[{idx}/{len(test_cases)}] Processing: {test_name}")
 
             # Create a new XML document with only this test case
             new_root = ET.Element('robot', root.attrib)
@@ -360,7 +380,7 @@ class LogXML2Chunks:
             ET.indent(new_tree, space='  ')
             new_tree.write(xml_filepath, encoding='UTF-8', xml_declaration=True)
 
-            print(f"  ✓ Created XML: {xml_filepath}")
+            self._debug_print(f"  ✓ Created XML: {xml_filepath}")
 
             # Generate HTML report using rebot
             # html_filename = f"{safe_name}_{test_id}.html"
@@ -388,13 +408,13 @@ class LogXML2Chunks:
                 # With --NoStatusRC, rebot returns 0 on success regardless of test results
                 # Only non-zero codes indicate actual errors (invalid data, missing files, etc.)
                 if result.returncode == 0:
-                    print(f"  ✓ Generated log: {log_filepath}")
+                    self._debug_print(f"  ✓ Generated log: {log_filepath}")
                 else:
-                    print(f"  ✗ Failed to generate report (exit code: {result.returncode})")
+                    self._debug_print(f"  ✗ Failed to generate report (exit code: {result.returncode})")
                     if result.stderr:
-                        print(f"     Error: {result.stderr}")
+                        self._debug_print(f"     Error: {result.stderr}")
 
             except FileNotFoundError:
-                print(f"  ✗ Error: rebot command not found. Please install robotframework.")
+                self._debug_print(f"  ✗ Error: rebot command not found. Please install robotframework.")
             except Exception as e:
-                print(f"  ✗ Error generating report: {str(e)}, index number = {idx}")
+                self._debug_print(f"  ✗ Error generating report: {str(e)}, index number = {idx}")

{robotframework_logxml2chunks-1.0.0/robotframework_logxml2chunks.egg-info → robotframework_logxml2chunks-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-logxml2chunks
-Version: 1.0.0
+Version: 1.1.1
 Summary: Extract individual test cases from Robot Framework output.xml into separate chunks
 Home-page: https://github.com/ajadach/robotframework-LogXML2Chunks
 Author: Artur Jadach
@@ -120,11 +120,25 @@ The `split_to_chunks()` method returns a list of dictionaries with:
     'source': '/path/to/test.robot',    # Source file path
     'xml_file': Path('...'),            # Generated XML file path
     'log_file': Path('...'),            # Generated log file path
+    'checksum': 'a1b2c3d4...',          # MD5 checksum of test_name + documentation
     'success': True,                    # Whether generation succeeded
     'error': None                       # Error message if failed
 }
 ```
 
+### Checksum Field
+
+The `checksum` field is automatically calculated for each test case using MD5 hash of the concatenated `test_name` and `documentation`. This provides a unique identifier for tracking test case changes:
+
+- **Format**: 32-character hexadecimal string
+- **Algorithm**: MD5
+- **Input**: `test_name + documentation`
+- **Use cases**: 
+  - Detect documentation changes
+  - Track test case modifications
+  - Integration with external test management systems
+  - Version control of test cases
+
 ## Step Extraction
 
 The library automatically extracts steps from test documentation that follow this format:

{robotframework_logxml2chunks-1.0.0 → robotframework_logxml2chunks-1.1.1}/README.md

@@ -80,11 +80,25 @@ The `split_to_chunks()` method returns a list of dictionaries with:
     'source': '/path/to/test.robot',    # Source file path
     'xml_file': Path('...'),            # Generated XML file path
     'log_file': Path('...'),            # Generated log file path
+    'checksum': 'a1b2c3d4...',          # MD5 checksum of test_name + documentation
     'success': True,                    # Whether generation succeeded
     'error': None                       # Error message if failed
 }
 ```
 
+### Checksum Field
+
+The `checksum` field is automatically calculated for each test case using MD5 hash of the concatenated `test_name` and `documentation`. This provides a unique identifier for tracking test case changes:
+
+- **Format**: 32-character hexadecimal string
+- **Algorithm**: MD5
+- **Input**: `test_name + documentation`
+- **Use cases**: 
+  - Detect documentation changes
+  - Track test case modifications
+  - Integration with external test management systems
+  - Version control of test cases
+
 ## Step Extraction
 
 The library automatically extracts steps from test documentation that follow this format:

{robotframework_logxml2chunks-1.0.0 → robotframework_logxml2chunks-1.1.1/robotframework_logxml2chunks.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-logxml2chunks
-Version: 1.0.0
+Version: 1.1.1
 Summary: Extract individual test cases from Robot Framework output.xml into separate chunks
 Home-page: https://github.com/ajadach/robotframework-LogXML2Chunks
 Author: Artur Jadach
@@ -120,11 +120,25 @@ The `split_to_chunks()` method returns a list of dictionaries with:
     'source': '/path/to/test.robot',    # Source file path
     'xml_file': Path('...'),            # Generated XML file path
     'log_file': Path('...'),            # Generated log file path
+    'checksum': 'a1b2c3d4...',          # MD5 checksum of test_name + documentation
     'success': True,                    # Whether generation succeeded
     'error': None                       # Error message if failed
 }
 ```
 
+### Checksum Field
+
+The `checksum` field is automatically calculated for each test case using MD5 hash of the concatenated `test_name` and `documentation`. This provides a unique identifier for tracking test case changes:
+
+- **Format**: 32-character hexadecimal string
+- **Algorithm**: MD5
+- **Input**: `test_name + documentation`
+- **Use cases**: 
+  - Detect documentation changes
+  - Track test case modifications
+  - Integration with external test management systems
+  - Version control of test cases
+
 ## Step Extraction
 
 The library automatically extracts steps from test documentation that follow this format:

robotframework_logxml2chunks-1.1.1/robotframework_logxml2chunks.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+setup.py
+LogXML2Chunks/LogXML2Chunks.py
+LogXML2Chunks/__init__.py
+LogXML2Chunks/cli.py
+robotframework_logxml2chunks.egg-info/PKG-INFO
+robotframework_logxml2chunks.egg-info/SOURCES.txt
+robotframework_logxml2chunks.egg-info/dependency_links.txt
+robotframework_logxml2chunks.egg-info/entry_points.txt
+robotframework_logxml2chunks.egg-info/not-zip-safe
+robotframework_logxml2chunks.egg-info/requires.txt
+robotframework_logxml2chunks.egg-info/top_level.txt
+tests/test_logxml2chunks.py

{robotframework_logxml2chunks-1.0.0 → robotframework_logxml2chunks-1.1.1}/setup.py

@@ -10,7 +10,7 @@ long_description = (this_directory / "README.md").read_text(encoding='utf-8')
 
 setup(
     name='robotframework-logxml2chunks',
-    version='1.0.0',
+    version='1.1.1',
     author='Artur Jadach',
     author_email='artur.k.ziolkowski@example.com',
     description='Extract individual test cases from Robot Framework output.xml into separate chunks',

{robotframework_logxml2chunks-1.0.0 → robotframework_logxml2chunks-1.1.1}/tests/test_logxml2chunks.py

@@ -47,7 +47,7 @@ class TestLogXML2Chunks:
         
         # Verify all required fields are present
         required_fields = ['index', 'test_name', 'test_id', 'status', 'documentation', 
-                          'steps', 'source', 'xml_file', 'success']
+                          'steps', 'source', 'xml_file', 'checksum', 'success']
         for field in required_fields:
             assert field in result, f"Field '{field}' should be present in result"
         
@@ -57,6 +57,12 @@ class TestLogXML2Chunks:
         assert result['status'] == 'PASS', f"Expected 'PASS', got '{result['status']}'"
         assert result['index'] == 1, f"Expected index 1, got {result['index']}"
         
+        # Verify checksum is present and valid
+        assert 'checksum' in result, "checksum field should be present"
+        assert isinstance(result['checksum'], str), "checksum should be a string"
+        assert len(result['checksum']) == 32, f"checksum should be 32 characters (MD5), got {len(result['checksum'])}"
+        assert result['checksum'].isalnum(), "checksum should be alphanumeric"
+        
         # Verify source path
         assert 'example.robot' in result['source'], f"Source should contain 'example.robot', got '{result['source']}'"
         
@@ -124,6 +130,7 @@ class TestLogXML2Chunks:
             assert 'steps' in result
             assert 'source' in result
             assert 'xml_file' in result
+            assert 'checksum' in result
             assert 'success' in result
             assert result['success'] is True
         

robotframework_logxml2chunks-1.0.0/requirements.txt

@@ -1,4 +0,0 @@
-# Production dependencies
-robotframework>=4.0
-pytest>=7.0
-pytest-cov>=4.0

robotframework_logxml2chunks-1.0.0/robotframework_logxml2chunks.egg-info/SOURCES.txt

@@ -1,25 +0,0 @@
-LICENSE
-README.md
-requirements.txt
-setup.py
-LogXML2Chunks/LogXML2Chunks.py
-LogXML2Chunks/__init__.py
-LogXML2Chunks/cli.py
-robotframework_logxml2chunks.egg-info/PKG-INFO
-robotframework_logxml2chunks.egg-info/SOURCES.txt
-robotframework_logxml2chunks.egg-info/dependency_links.txt
-robotframework_logxml2chunks.egg-info/entry_points.txt
-robotframework_logxml2chunks.egg-info/not-zip-safe
-robotframework_logxml2chunks.egg-info/requires.txt
-robotframework_logxml2chunks.egg-info/top_level.txt
-tests/__init__.py
-tests/test_logxml2chunks.py
-tests/example_logs/example.robot
-tests/example_logs/chunks/1_Example_Test_1_s1-t1.xml
-tests/example_logs/chunks/1_Example_Test_1_s1-t1_log.html
-tests/example_logs/chunks/2_Example_Test_2_s1-t2.xml
-tests/example_logs/chunks/2_Example_Test_2_s1-t2_log.html
-tests/example_logs/chunks/3_Example_Test_3_s1-t3.xml
-tests/example_logs/chunks/3_Example_Test_3_s1-t3_log.html
-tests/example_logs/chunks/4_Example_Test_4_s1-t4.xml
-tests/example_logs/chunks/4_Example_Test_4_s1-t4_log.html

robotframework_logxml2chunks-1.0.0/tests/__init__.py

@@ -1,3 +0,0 @@
-"""
-Tests initialization file.
-"""

robotframework_logxml2chunks-1.0.0/tests/example_logs/chunks/1_Example_Test_1_s1-t1.xml

@@ -1,45 +0,0 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<robot generator="Robot 7.3.2 (Python 3.10.12 on linux)" generated="2025-11-13T17:21:50.004523" rpa="false" schemaversion="5">
-  <suite id="s1" name="Example" source="/home/ajadach/GIT_LAB/robotframework-LogXML2Chunks/tests/example_logs/example.robot">
-    <test id="s1-t1" name="Example Test 1" line="15">
-      <kw name="Log" owner="BuiltIn">
-        <msg time="2025-11-13T17:21:50.036281" level="INFO">Executing Example Test 1</msg>
-        <arg>Executing Example Test 1</arg>
-        <doc>Logs the given message with the given level.</doc>
-        <status status="PASS" start="2025-11-13T17:21:50.035959" elapsed="0.000421" />
-      </kw>
-      <doc>Example Test 1 Documentation
-
-*Steps / Expected*
-- Log to HTML / pass
-
-*Expected*
-- Log should be successful.</doc>
-      <tag>test_1</tag>
-      <status status="PASS" start="2025-11-13T17:21:50.034956" elapsed="0.001694" />
-    </test>
-    <doc>Example suite level documentation.
-
-
-*Steps*
-- Example Test 1
-- Example Test 2
-- Example Test 3
-- Example Test 4
-
-*Expected*
-- All test cases should be successful.</doc>
-  </suite>
-  <statistics>
-    <total>
-      <stat pass="1" fail="0" skip="0">All Tests</stat>
-    </total>
-    <tag>
-      <stat pass="1" fail="0" skip="0">test_1</stat>
-    </tag>
-    <suite>
-      <stat name="Example" id="s1" pass="1" fail="0" skip="0" />
-    </suite>
-  </statistics>
-  <errors />
-</robot>