robotframework-logxml2chunks 1.1.0__tar.gz → 1.1.3__tar.gz

{robotframework_logxml2chunks-1.1.0 → robotframework_logxml2chunks-1.1.3}/LogXML2Chunks/LogXML2Chunks.py

@@ -18,6 +18,28 @@ from pathlib import Path
 
 class LogXML2Chunks:
 
+    def __init__(self, debug=True, filename_prefix_pattern=None):
+        """
+        Initialize LogXML2Chunks instance.
+        
+        Args:
+            debug: Enable debug output (default: True)
+            filename_prefix_pattern: Regex pattern to extract a custom prefix for chunk filenames.
+                                    Must contain one capture group that captures the prefix value.
+                                    The captured value will be added to the beginning of XML and HTML filenames.
+                                    Example: r"open_session\('(\w+)'" would extract 'DB' from 
+                                            "open_session('DB', '10.0.0.1')" and create files like:
+                                            "1_DB_TestName_s1-t1.xml"
+                                    Default: None (no prefix extraction)
+        """
+        self.debug = debug
+        self.filename_prefix_pattern = re.compile(filename_prefix_pattern) if filename_prefix_pattern else None
+
+    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.
@@ -106,6 +128,83 @@ class LogXML2Chunks:
 
         return steps
 
+    def _extract_requirements_from_documentation(self, doc_text):
+        """
+        Extract requirements from test documentation.
+
+        Looks for sections marked as *Requirements*, *Requirements:* or Requirements:
+        and extracts the list items that follow (numbered or bulleted).
+
+        Args:
+            doc_text: The documentation text to parse
+
+        Returns:
+            List of requirement strings extracted from the documentation.
+            Returns empty list if no requirements found.
+        """
+        if not doc_text:
+            return []
+
+        requirements = []
+
+        # Pattern to find the Requirements section (case-insensitive, with or without asterisks/colon)
+        requirements_pattern = r'(?:\*)?Requirements(?:\*)?:?'
+
+        # Find the Requirements section
+        match = re.search(requirements_pattern, doc_text, re.IGNORECASE | re.MULTILINE)
+        if not match:
+            return []
+
+        # Get text after the Requirements marker
+        text_after_requirements = doc_text[match.end():]
+
+        # Split into lines and process
+        lines = text_after_requirements.split('\n')
+
+        for line in lines:
+            line = line.strip()
+
+            # Stop if we hit another section (starts with * and ends with *, or starts with * and contains :)
+            if line.startswith('*'):
+                if line.endswith('*') or ':' in line:
+                    break
+
+            # Skip empty lines
+            if not line or line == '...':
+                continue
+
+            # Remove leading "..." from Robot Framework documentation
+            if line.startswith('...'):
+                line = line[3:].strip()
+
+            req_text = None
+
+            # Check for numbered list items (1. , 2. , etc.)
+            numbered_match = re.match(r'^\d+\.\s+(.+)$', line)
+            if numbered_match:
+                req_text = numbered_match.group(1).strip()
+
+            # Check for bulleted list items (- , * , etc.)
+            if not req_text:
+                bullet_match = re.match(r'^[-*]\s+(.+)$', line)
+                if bullet_match:
+                    req_text = bullet_match.group(1).strip()
+
+            # If no list marker, treat as plain text requirement
+            if not req_text and line:
+                req_text = line
+
+            if req_text:
+                requirements.append(req_text)
+                continue
+
+            # If we already have requirements and this line doesn't match any pattern,
+            # it might be the end of the requirements section
+            if requirements and not line.startswith(('1', '2', '3', '4', '5', '6', '7', '8', '9', '-', '*')):
+                break
+
+        return requirements
+
     def get_data_from_chunk(self, xml_filepath):
         """
         Extract and structure data from a test chunk XML file.
@@ -117,6 +216,7 @@ class LogXML2Chunks:
             Dictionary with test case data, or None if parsing fails
         """
         try:
+
             # Parse the XML file
             tree = ET.parse(xml_filepath)
             root = tree.getroot()
@@ -153,6 +253,9 @@ class LogXML2Chunks:
             # Extract steps from documentation
             test_steps = self._extract_steps_from_documentation(test_doc)
             
+            # Extract requirements from documentation
+            test_requirements = self._extract_requirements_from_documentation(test_doc)
+            
             # Get test status
             status_element = test.find('status')
             test_status = status_element.get('status', 'UNKNOWN') if status_element is not None else 'UNKNOWN'
@@ -173,7 +276,7 @@ class LogXML2Chunks:
             # 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,
@@ -182,6 +285,7 @@ class LogXML2Chunks:
                 'status': test_status,
                 'documentation': test_doc,
                 'steps': test_steps,
+                'requirements': test_requirements,
                 'source': test_source,
                 'xml_file': str(xml_filepath),
                 'checksum': checksum,
@@ -228,36 +332,94 @@ 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
 
+    def _extract_filename_prefix(self, test, suite, root=None):
+        """
+        Extract a custom prefix for filenames from test case or suite setup messages.
+        
+        Uses the regex pattern provided in constructor to search XML messages
+        and extract a prefix value for chunk filenames.
+        
+        Searches in this order:
+        1. Current suite's SETUP keywords
+        2. All parent suites' SETUP keywords (if root is provided)
+        3. Test case keywords
+
+        Args:
+            test: Test case XML element
+            suite: Suite XML element containing the test
+            root: Root XML element (optional, for searching parent suites)
+
+        Returns:
+            Extracted prefix string (uppercase) or None if not found or pattern not set
+        """
+        if not self.filename_prefix_pattern:
+            return None
+        
+        # Search in suite setup keywords first (current suite)
+        for msg in suite.findall('.//kw[@type="SETUP"]//msg'):
+            if msg.text:
+                match = self.filename_prefix_pattern.search(msg.text)
+                if match:
+                    return match.group(1).upper()
+
+        # Search in parent suites' SETUP keywords (if root is provided)
+        if root is not None:
+            suite_id = suite.get('id', '')
+            # Build list of parent suite IDs: s1-s1-s1-s1 -> [s1-s1-s1, s1-s1, s1]
+            parent_ids = []
+            parts = suite_id.split('-')
+            for i in range(len(parts) - 1, 0, -1):
+                parent_ids.append('-'.join(parts[:i]))
+
+            # Search in each parent suite
+            for parent_id in parent_ids:
+                parent_suite = root.find(f".//suite[@id='{parent_id}']")
+                if parent_suite is not None:
+                    for msg in parent_suite.findall('.//kw[@type="SETUP"]//msg'):
+                        if msg.text:
+                            match = self.filename_prefix_pattern.search(msg.text)
+                            if match:
+                                return match.group(1).upper()
+
+        # Search in test case keywords
+        for msg in test.findall('.//msg'):
+            if msg.text:
+                match = self.filename_prefix_pattern.search(msg.text)
+                if match:
+                    return match.group(1).upper()
+        
+        return None
+
     def split_to_chunks(self, output_xml_path, output_dir="chunked_results"):
         """
         Extract each test case from output.xml into separate XML files
@@ -281,19 +443,28 @@ 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):
             test_name = test.get('name')
             test_id = test.get('id')
+            
+            # Extract filename prefix (if pattern is configured)
+            prefix = self._extract_filename_prefix(test, suite, root)
 
-            # Create a safe filename
+            # Create a safe filename (with prefix if available)
             safe_name = test_name.replace(' ', '_').replace('/', '_').replace('\\', '_')
-            xml_filename = f"{idx}_{safe_name}_{test_id}.xml"
+            if prefix:
+                xml_filename = f"{idx}_{prefix}_{safe_name}_{test_id}.xml"
+            else:
+                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}")
+            if prefix:
+                self._debug_print(f"\n[{idx}/{len(test_cases)}] Processing: {test_name} (Prefix: {prefix})")
+            else:
+                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)
@@ -366,12 +537,13 @@ 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"
-            log_filename = f"{idx}_{safe_name}_{test_id}_log.html"
-            # html_filepath = output_path / html_filename
+            if prefix:
+                log_filename = f"{idx}_{prefix}_{safe_name}_{test_id}_log.html"
+            else:
+                log_filename = f"{idx}_{safe_name}_{test_id}_log.html"
             log_filepath = output_path / log_filename
 
             try:
@@ -394,13 +566,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.1.0/robotframework_logxml2chunks.egg-info → robotframework_logxml2chunks-1.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-logxml2chunks
-Version: 1.1.0
+Version: 1.1.3
 Summary: Extract individual test cases from Robot Framework output.xml into separate chunks
 Home-page: https://github.com/ajadach/robotframework-LogXML2Chunks
 Author: Artur Jadach

{robotframework_logxml2chunks-1.1.0 → robotframework_logxml2chunks-1.1.3/robotframework_logxml2chunks.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-logxml2chunks
-Version: 1.1.0
+Version: 1.1.3
 Summary: Extract individual test cases from Robot Framework output.xml into separate chunks
 Home-page: https://github.com/ajadach/robotframework-LogXML2Chunks
 Author: Artur Jadach

robotframework_logxml2chunks-1.1.3/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.1.0 → robotframework_logxml2chunks-1.1.3}/setup.py

@@ -10,7 +10,7 @@ long_description = (this_directory / "README.md").read_text(encoding='utf-8')
 
 setup(
     name='robotframework-logxml2chunks',
-    version='1.1.0',
+    version='1.1.3',
     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.1.0/requirements.txt

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

robotframework_logxml2chunks-1.1.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.1.0/tests/__init__.py

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

robotframework_logxml2chunks-1.1.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>