PyPI - robotframework-xmlvalidator - Versions diffs - 1.0.1__tar.gz → 2.0.0__tar.gz - Mend

robotframework-xmlvalidator 1.0.1tar.gz → 2.0.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

{robotframework_xmlvalidator-1.0.1 → robotframework_xmlvalidator-2.0.0}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: robotframework-xmlvalidator
-Version: 1.0.1
+Version: 2.0.0
 Summary: A Robot Framework test library for validating XML files against XSD schemas
 License: Apache-2.0
 Keywords: robotframework,xml,xsd,validation,test-library,test,testing,test-automation
@@ -51,12 +51,18 @@ Description-Content-Type: text/markdown
     - [Examples](#examples)
       - [Using a preloaded schema](#using-a-preloaded-schema)
       - [Defer schema loading to the test case(s)](#defer-schema-loading-to-the-test-cases)
-      - [Importing with preloaded XSD that requires a base\_url](#importing-with-preloaded-xsd-that-requires-a-base_url)
-      - [Importing with custom error\_facets](#importing-with-custom-error_facets)
+      - [Importing with preloaded XSD that requires a `base_url`](#importing-with-preloaded-xsd-that-requires-a-base_url)
+      - [Importing with custom `error_facets`](#importing-with-custom-error_facets)
+      - [Importing with \`fail\_on\_errors=True](#importing-with-fail_on_errorstrue)
       - [Further examples](#further-examples)
   - [Using the library](#using-the-library)
     - [Keyword overview](#keyword-overview)
-    - [Error collection](#error-collection)
+      - [Error collection](#error-collection)
+      - [Batch mode](#batch-mode)
+      - [Single file mode](#single-file-mode)
+      - [Test case status - fail\_on\_error](#test-case-status---fail_on_error)
+      - [Dyanmic XSD resolution](#dyanmic-xsd-resolution)
+    - [Error collection](#error-collection-1)
       - [XSD Schema violations.](#xsd-schema-violations)
       - [Malformed XML](#malformed-xml)
       - [File-level issues](#file-level-issues)
@@ -64,6 +70,7 @@ Description-Content-Type: text/markdown
     - [Keyword documentation](#keyword-documentation)
     - [Keyword example usage](#keyword-example-usage)
       - [A few basic examples](#a-few-basic-examples)
+      - [Demo test suite file as examples](#demo-test-suite-file-as-examples)
       - [Integration tests as examples](#integration-tests-as-examples)
     - [Example console output](#example-console-output)
     - [Example CSV output](#example-csv-output)
@@ -85,6 +92,8 @@ Description-Content-Type: text/markdown
     - [Continuous Integration \& GitHub templates](#continuous-integration--github-templates)
   - [Class architecture (Simplified)](#class-architecture-simplified)
   - [Project Structure](#project-structure)
+  - [Changelog](#changelog)
+  - [Roadmap](#roadmap)
   - [License](#license)
   - [Author](#author)
@@ -157,11 +166,12 @@ See the [Robot Framework Library Scope docs](https://robotframework.org/robotfra
 ### Library arguments
-| Argument       | Type        | Required? | Description                                                                        |
-|----------------|-------------|-----------|------------------------------------------------------------------------------------|
-| `xsd_path`     | `str`       | No        | Path to an XSD file or folder to preload during initialization. In case of a folder, the folder must hold one file only.                                                                                                             |
-| `base_url`     | `str`       | No        | Base path used to resolve includes/imports within the provided XSD schema.         |
-| `error_facets` | `list[str]` | No        | The attributes of validation errors to collect and report (e.g., `path`, `reason`) |
+| Argument        | Type        | Required? | Description                                                                                                            | Default         |
+|-----------------|-------------|-----------|------------------------------------------------------------------------------------------------------------------------|-----------------|
+| `xsd_path`      | `str`       | No        | Path to an XSD file/folder to preload during initialization. In case of a folder, the folder must hold one file only.  | None            |
+| `base_url`      | `str`       | No        | Base path used to resolve includes/imports within the provided XSD schema.                                             | None            |
+| `error_facets`  | `list[str]` | No        | The attributes of validation errors to collect and report (e.g., `path`, `reason`)                                     | [path, reason]  |
+| `fail_on_error` | `bool`      | No        | Whether to fail the test case if one or more XML validation errors are found. Can be overridden per keyword call.      | True            |
 ### Examples
@@ -178,7 +188,7 @@ Library    xmlvalidator    xsd_path=path/to/schema.xsd
 Library    xmlvalidator
 ```
-#### Importing with preloaded XSD that requires a base_url
+#### Importing with preloaded XSD that requires a `base_url`
 ```robotframework
 Library    xmlvalidator    xsd_path=path/to/schema_with_include.xsd
@@ -187,7 +197,7 @@ Library    xmlvalidator    xsd_path=path/to/schema_with_include.xsd
 Use `base_url` when your XSD uses `<xs:include>` or `<xs:import>` with relative paths.
-#### Importing with custom error_facets
+#### Importing with custom `error_facets`
 Use the `error_facets` argument to control which attributes of detected errors will be collected and reported.
@@ -206,6 +216,21 @@ Library    xmlvalidator    xsd_path=schemas/schema.xsd
 ...                        error_facets=value, namespaces
 ```
+#### Importing with `fail_on_errors=True
+The fail_on_errors argument controls whether a test case should fail if XML validation errors are detected.
+It defaults to True.
+The library's batch validation behavior remains unchanged. That is, `fail_on_errors=True` does *not* short-circuit the validation process in any way.
+Set `fail_on_errors=False` to log validation issues without failing the test. This is useful for:
+- Non-blocking checks in dashboards or QA reports.
+- Legacy or transitional systems where some invalid files are expected.
+- Schema discovery or diagnostics, where conformance isn’t yet enforced.
+- Soft rollout of stricter validation rules, allowing time to adapt.
 #### Further examples
 See also the [library initialization Robot test file](test/integration/01_library_initialization.robot).
@@ -216,39 +241,63 @@ See also the [library initialization Robot test file](test/integration/01_librar
 ### Keyword overview
-| Keyword                  | Description |
-|--------------------------|-------------|
+Thi section merely provides a short summary of the library's capabilities.
+For more details, please see the [keyword documentation](https://michaelhallik.github.io/robotframework-xmlvalidator/XmlValidator.html).
+| Keyword                  | Description                                                         |
+|--------------------------|---------------------------------------------------------------------|
 | `Validate Xml Files`     | Validate one or more XML files against one or more XSD schema files |
-| `Reset Schema`           | Clear the currently loaded XSD schema |
-| `Reset Errors`           | Clear the set of collected errors |
-| `Get Schema`             | Get the current schema name or object |
-| `Log Schema`             | Log the currently loaded schema |
-| `Get Error Facets`       | Returns a list of the currently active error facets |
-| `Reset Error Facets`     | Reset the error facets to default (`path`, `reason`) |
+| `Reset Schema`           | Clear the currently loaded XSD schema                               |
+| `Reset Errors`           | Clear the set of collected errors                                   |
+| `Get Schema`             | Get the current schema name or object                               |
+| `Log Schema`             | Log the currently loaded schema                                     |
+| `Get Error Facets`       | Returns a list of the currently active error facets                 |
+| `Reset Error Facets`     | Reset the error facets to default (`path`, `reason`)                |
 The main keyword is `Validate Xml Files`. The other keywords are convenience/helper functions, e.g. 'Reset Error Facets'.
+#### Error collection
 The `Validate Xml Files` validates one or more XML files against one or more XSD schema files and collects and reports all encountered errors.
-The type of error that the keyword can detect is not limited to XSD violations, but may also pertain to malformed XML files (e.g. parse errors), empty files, unmatched XML files (no XSD match found), etc.
+The type of error that the keyword can detect is not limited to XSD violations, but may also pertain to malformed XML files, empty files, unmatched XML files (no XSD match found), etc.
 Errors that result from malformed XML files or from XSD violations support detailed error reporting. Using the `error_facets` argument you may specify the details the keyword should collect and report about captured errors.
-When operating in batch mode, the `Validate Xml Files` keyword always validates the entire set of passed XML files.
+#### Batch mode
-That is, when it encounters an error in a file, it does not fail. Rather, it collects the error details (as determined by the `error_facets` arg) and then continues validating the current file as well as any subsequent file(s).
+The `Validate Xml Files` keyword always validates the entire set of passed XML files.
+That is, when it encounters an error in a file, it does not fail and stop execution. Rather, it collects the error details (as determined by the `error_facets` arg) and then continues validating the current file as well as any subsequent file(s).
 In that fashion the keyword works through the entire set of files.
-Once all files are processed it will log a summary of the test run and then proceed to report all collected errors in the console, in the RF log and, optionally, in the form of a CSV file.
+Once *all* files are processed it will log a summary of the test run and then proceed to report all collected errors in the console, in the RF log and, optionally, in the form of a CSV file.
-However, in case you want your test case to fail when one or more errors have been detected, you can use the ``fail_on_errors`` (bool) argument to make it so. It defaults to False. When setting it to True, the keyword will still check each XML file (and collect possible errors), but after it has thus processed the batch, it will fail if one or more errors will have been detected.
+For example:
+- If you validate fifteen XML files and five of them contain schema violations or other errors, all files will still be processed.
+- Errors are simply collected throughout the run and reported collectively, only after the final file has been (fully) processed.
+- The test case will fail (assuming `fail_on_errors=True`) only after all files have been checked, ensuring comprehensive diagnostics.
-The keyword further supports the dynamic matching (i.e. pairing) of XML and XSD files, using either a 'by filename' or a 'by namespace' strategy. That means you can simply pass the paths to a folder containing XML files and to a folder containing XSD files and the keyword will determine which XSD schema file to use for each XML file. If the XML and XSD files reside in the same folder, you only have to pass one folder path. When no matching XSD schema could be identified for an XML file, this will be integrated into the mentioned summary and error reporting (the keyword will not fail).
+#### Single file mode
 Of course, you may also refer to specific XML/XSD files (instead of to folders). In that case, no matching will be attempted, but the keyword will simply try to validate the specified XML file against the specified XSD file.
-For more details, please see the [keyword documentation](https://michaelhallik.github.io/robotframework-xmlvalidator/XmlValidator.html).
+Actually, almost anything goes:
+- one folder with: one or more XML files and one or more XSD files
+- one folder with one or more XML files and another folder with one or more XSD files
+- one folder with one or more XML files and a single XSD file
+- a single XML file and a sigle XSD file
+#### Test case status - fail_on_error
+A test case that has resulted in the collection of one or more errors (of whatever type) will receive a status of FAIL. You can use the ``fail_on_errors`` (bool) argument to change this default behaviour. When set to `False`, the test cases's status will always be PASS, regardless whether errors were collected or not.
+#### Dyanmic XSD resolution
+The keyword further supports the dynamic matching (i.e. pairing) of XML and XSD files, using either a 'by filename' or a 'by namespace' strategy. That means you can simply pass the paths to a folder containing XML files and to a folder containing XSD files and the keyword will determine which XSD schema file to use for each XML file. If the XML and XSD files reside in the same folder, you only have to pass one folder path. When no matching XSD schema could be identified for an XML file, this will be integrated into the mentioned summary and error reporting (the keyword will not fail).
 ### Error collection
@@ -333,9 +382,9 @@ General errors that do not pertain to syntax or schema issues:
 #### Final note on error collection
-On account of the purpose of this library, all encountered errors (regardless the involved types) are collected and reported. The validator analyzes all files, collects encountered errors (if any) and, finally, reports the results of the run in the console and in the Robot Framework log
+On account of the purpose of this library, all encountered errors (regardless the involved types) are collected and reported. The validator analyzes all files, collects encountered errors (if any) and, finally, reports the results of the run in the console and in the Robot Framework log.
-If you want the test run to receive a FAIL status when, at the end of test run, one or more errors have been found, then set: `fail_on_errors=True`.
+Every test case in which one or more errors have been collected, will receive status FAIL unless `fail_on_errors=True` (see earlier explanations).
 ### Keyword documentation
@@ -384,6 +433,10 @@ Validate Folder With Multiple Schemas By File Name
     Validate Xml Files    ${FOLDER_MULTIPLE_XML_XSD_FN}    xsd_search_strategy=by_file_name
 ```
+#### Demo test suite file as examples
+See the [demo test suite](test/demo/demo.robot) for a demo test suite that demonstrates the most important features of the library in a concise fashion.
 #### Integration tests as examples
 Note that the [integration test](test/integration) folder contains seven Robot Framework test suite files.
@@ -772,6 +825,18 @@ requirements.txt                     # Requirements file for users (pip)
 ---
+## Changelog
+For a list of changes across versions, including recent behavioral changes in validation logic, see the [CHANGELOG](https://github.com/MichaelHallik/robotframework-xmlvalidator/blob/main/CHANGELOG.md).
+---
+## Roadmap
+See the [project roadmap](ROADMAP.md) for upcoming features and ideas.
+---
 ## License
 Licensed under the Apache License 2.0. See [LICENSE](LICENSE).

{robotframework_xmlvalidator-1.0.1 → robotframework_xmlvalidator-2.0.0}/README.md RENAMED Viewed

@@ -24,12 +24,18 @@
     - [Examples](#examples)
       - [Using a preloaded schema](#using-a-preloaded-schema)
       - [Defer schema loading to the test case(s)](#defer-schema-loading-to-the-test-cases)
-      - [Importing with preloaded XSD that requires a base\_url](#importing-with-preloaded-xsd-that-requires-a-base_url)
-      - [Importing with custom error\_facets](#importing-with-custom-error_facets)
+      - [Importing with preloaded XSD that requires a `base_url`](#importing-with-preloaded-xsd-that-requires-a-base_url)
+      - [Importing with custom `error_facets`](#importing-with-custom-error_facets)
+      - [Importing with \`fail\_on\_errors=True](#importing-with-fail_on_errorstrue)
       - [Further examples](#further-examples)
   - [Using the library](#using-the-library)
     - [Keyword overview](#keyword-overview)
-    - [Error collection](#error-collection)
+      - [Error collection](#error-collection)
+      - [Batch mode](#batch-mode)
+      - [Single file mode](#single-file-mode)
+      - [Test case status - fail\_on\_error](#test-case-status---fail_on_error)
+      - [Dyanmic XSD resolution](#dyanmic-xsd-resolution)
+    - [Error collection](#error-collection-1)
       - [XSD Schema violations.](#xsd-schema-violations)
       - [Malformed XML](#malformed-xml)
       - [File-level issues](#file-level-issues)
@@ -37,6 +43,7 @@
     - [Keyword documentation](#keyword-documentation)
     - [Keyword example usage](#keyword-example-usage)
       - [A few basic examples](#a-few-basic-examples)
+      - [Demo test suite file as examples](#demo-test-suite-file-as-examples)
       - [Integration tests as examples](#integration-tests-as-examples)
     - [Example console output](#example-console-output)
     - [Example CSV output](#example-csv-output)
@@ -58,6 +65,8 @@
     - [Continuous Integration \& GitHub templates](#continuous-integration--github-templates)
   - [Class architecture (Simplified)](#class-architecture-simplified)
   - [Project Structure](#project-structure)
+  - [Changelog](#changelog)
+  - [Roadmap](#roadmap)
   - [License](#license)
   - [Author](#author)
@@ -130,11 +139,12 @@ See the [Robot Framework Library Scope docs](https://robotframework.org/robotfra
 ### Library arguments
-| Argument       | Type        | Required? | Description                                                                        |
-|----------------|-------------|-----------|------------------------------------------------------------------------------------|
-| `xsd_path`     | `str`       | No        | Path to an XSD file or folder to preload during initialization. In case of a folder, the folder must hold one file only.                                                                                                             |
-| `base_url`     | `str`       | No        | Base path used to resolve includes/imports within the provided XSD schema.         |
-| `error_facets` | `list[str]` | No        | The attributes of validation errors to collect and report (e.g., `path`, `reason`) |
+| Argument        | Type        | Required? | Description                                                                                                            | Default         |
+|-----------------|-------------|-----------|------------------------------------------------------------------------------------------------------------------------|-----------------|
+| `xsd_path`      | `str`       | No        | Path to an XSD file/folder to preload during initialization. In case of a folder, the folder must hold one file only.  | None            |
+| `base_url`      | `str`       | No        | Base path used to resolve includes/imports within the provided XSD schema.                                             | None            |
+| `error_facets`  | `list[str]` | No        | The attributes of validation errors to collect and report (e.g., `path`, `reason`)                                     | [path, reason]  |
+| `fail_on_error` | `bool`      | No        | Whether to fail the test case if one or more XML validation errors are found. Can be overridden per keyword call.      | True            |
 ### Examples
@@ -151,7 +161,7 @@ Library    xmlvalidator    xsd_path=path/to/schema.xsd
 Library    xmlvalidator
 ```
-#### Importing with preloaded XSD that requires a base_url
+#### Importing with preloaded XSD that requires a `base_url`
 ```robotframework
 Library    xmlvalidator    xsd_path=path/to/schema_with_include.xsd
@@ -160,7 +170,7 @@ Library    xmlvalidator    xsd_path=path/to/schema_with_include.xsd
 Use `base_url` when your XSD uses `<xs:include>` or `<xs:import>` with relative paths.
-#### Importing with custom error_facets
+#### Importing with custom `error_facets`
 Use the `error_facets` argument to control which attributes of detected errors will be collected and reported.
@@ -179,6 +189,21 @@ Library    xmlvalidator    xsd_path=schemas/schema.xsd
 ...                        error_facets=value, namespaces
 ```
+#### Importing with `fail_on_errors=True
+The fail_on_errors argument controls whether a test case should fail if XML validation errors are detected.
+It defaults to True.
+The library's batch validation behavior remains unchanged. That is, `fail_on_errors=True` does *not* short-circuit the validation process in any way.
+Set `fail_on_errors=False` to log validation issues without failing the test. This is useful for:
+- Non-blocking checks in dashboards or QA reports.
+- Legacy or transitional systems where some invalid files are expected.
+- Schema discovery or diagnostics, where conformance isn’t yet enforced.
+- Soft rollout of stricter validation rules, allowing time to adapt.
 #### Further examples
 See also the [library initialization Robot test file](test/integration/01_library_initialization.robot).
@@ -189,39 +214,63 @@ See also the [library initialization Robot test file](test/integration/01_librar
 ### Keyword overview
-| Keyword                  | Description |
-|--------------------------|-------------|
+Thi section merely provides a short summary of the library's capabilities.
+For more details, please see the [keyword documentation](https://michaelhallik.github.io/robotframework-xmlvalidator/XmlValidator.html).
+| Keyword                  | Description                                                         |
+|--------------------------|---------------------------------------------------------------------|
 | `Validate Xml Files`     | Validate one or more XML files against one or more XSD schema files |
-| `Reset Schema`           | Clear the currently loaded XSD schema |
-| `Reset Errors`           | Clear the set of collected errors |
-| `Get Schema`             | Get the current schema name or object |
-| `Log Schema`             | Log the currently loaded schema |
-| `Get Error Facets`       | Returns a list of the currently active error facets |
-| `Reset Error Facets`     | Reset the error facets to default (`path`, `reason`) |
+| `Reset Schema`           | Clear the currently loaded XSD schema                               |
+| `Reset Errors`           | Clear the set of collected errors                                   |
+| `Get Schema`             | Get the current schema name or object                               |
+| `Log Schema`             | Log the currently loaded schema                                     |
+| `Get Error Facets`       | Returns a list of the currently active error facets                 |
+| `Reset Error Facets`     | Reset the error facets to default (`path`, `reason`)                |
 The main keyword is `Validate Xml Files`. The other keywords are convenience/helper functions, e.g. 'Reset Error Facets'.
+#### Error collection
 The `Validate Xml Files` validates one or more XML files against one or more XSD schema files and collects and reports all encountered errors.
-The type of error that the keyword can detect is not limited to XSD violations, but may also pertain to malformed XML files (e.g. parse errors), empty files, unmatched XML files (no XSD match found), etc.
+The type of error that the keyword can detect is not limited to XSD violations, but may also pertain to malformed XML files, empty files, unmatched XML files (no XSD match found), etc.
 Errors that result from malformed XML files or from XSD violations support detailed error reporting. Using the `error_facets` argument you may specify the details the keyword should collect and report about captured errors.
-When operating in batch mode, the `Validate Xml Files` keyword always validates the entire set of passed XML files.
+#### Batch mode
-That is, when it encounters an error in a file, it does not fail. Rather, it collects the error details (as determined by the `error_facets` arg) and then continues validating the current file as well as any subsequent file(s).
+The `Validate Xml Files` keyword always validates the entire set of passed XML files.
+That is, when it encounters an error in a file, it does not fail and stop execution. Rather, it collects the error details (as determined by the `error_facets` arg) and then continues validating the current file as well as any subsequent file(s).
 In that fashion the keyword works through the entire set of files.
-Once all files are processed it will log a summary of the test run and then proceed to report all collected errors in the console, in the RF log and, optionally, in the form of a CSV file.
+Once *all* files are processed it will log a summary of the test run and then proceed to report all collected errors in the console, in the RF log and, optionally, in the form of a CSV file.
-However, in case you want your test case to fail when one or more errors have been detected, you can use the ``fail_on_errors`` (bool) argument to make it so. It defaults to False. When setting it to True, the keyword will still check each XML file (and collect possible errors), but after it has thus processed the batch, it will fail if one or more errors will have been detected.
+For example:
+- If you validate fifteen XML files and five of them contain schema violations or other errors, all files will still be processed.
+- Errors are simply collected throughout the run and reported collectively, only after the final file has been (fully) processed.
+- The test case will fail (assuming `fail_on_errors=True`) only after all files have been checked, ensuring comprehensive diagnostics.
-The keyword further supports the dynamic matching (i.e. pairing) of XML and XSD files, using either a 'by filename' or a 'by namespace' strategy. That means you can simply pass the paths to a folder containing XML files and to a folder containing XSD files and the keyword will determine which XSD schema file to use for each XML file. If the XML and XSD files reside in the same folder, you only have to pass one folder path. When no matching XSD schema could be identified for an XML file, this will be integrated into the mentioned summary and error reporting (the keyword will not fail).
+#### Single file mode
 Of course, you may also refer to specific XML/XSD files (instead of to folders). In that case, no matching will be attempted, but the keyword will simply try to validate the specified XML file against the specified XSD file.
-For more details, please see the [keyword documentation](https://michaelhallik.github.io/robotframework-xmlvalidator/XmlValidator.html).
+Actually, almost anything goes:
+- one folder with: one or more XML files and one or more XSD files
+- one folder with one or more XML files and another folder with one or more XSD files
+- one folder with one or more XML files and a single XSD file
+- a single XML file and a sigle XSD file
+#### Test case status - fail_on_error
+A test case that has resulted in the collection of one or more errors (of whatever type) will receive a status of FAIL. You can use the ``fail_on_errors`` (bool) argument to change this default behaviour. When set to `False`, the test cases's status will always be PASS, regardless whether errors were collected or not.
+#### Dyanmic XSD resolution
+The keyword further supports the dynamic matching (i.e. pairing) of XML and XSD files, using either a 'by filename' or a 'by namespace' strategy. That means you can simply pass the paths to a folder containing XML files and to a folder containing XSD files and the keyword will determine which XSD schema file to use for each XML file. If the XML and XSD files reside in the same folder, you only have to pass one folder path. When no matching XSD schema could be identified for an XML file, this will be integrated into the mentioned summary and error reporting (the keyword will not fail).
 ### Error collection
@@ -306,9 +355,9 @@ General errors that do not pertain to syntax or schema issues:
 #### Final note on error collection
-On account of the purpose of this library, all encountered errors (regardless the involved types) are collected and reported. The validator analyzes all files, collects encountered errors (if any) and, finally, reports the results of the run in the console and in the Robot Framework log
+On account of the purpose of this library, all encountered errors (regardless the involved types) are collected and reported. The validator analyzes all files, collects encountered errors (if any) and, finally, reports the results of the run in the console and in the Robot Framework log.
-If you want the test run to receive a FAIL status when, at the end of test run, one or more errors have been found, then set: `fail_on_errors=True`.
+Every test case in which one or more errors have been collected, will receive status FAIL unless `fail_on_errors=True` (see earlier explanations).
 ### Keyword documentation
@@ -357,6 +406,10 @@ Validate Folder With Multiple Schemas By File Name
     Validate Xml Files    ${FOLDER_MULTIPLE_XML_XSD_FN}    xsd_search_strategy=by_file_name
 ```
+#### Demo test suite file as examples
+See the [demo test suite](test/demo/demo.robot) for a demo test suite that demonstrates the most important features of the library in a concise fashion.
 #### Integration tests as examples
 Note that the [integration test](test/integration) folder contains seven Robot Framework test suite files.
@@ -745,6 +798,18 @@ requirements.txt                     # Requirements file for users (pip)
 ---
+## Changelog
+For a list of changes across versions, including recent behavioral changes in validation logic, see the [CHANGELOG](https://github.com/MichaelHallik/robotframework-xmlvalidator/blob/main/CHANGELOG.md).
+---
+## Roadmap
+See the [project roadmap](ROADMAP.md) for upcoming features and ideas.
+---
 ## License
 Licensed under the Apache License 2.0. See [LICENSE](LICENSE).

{robotframework_xmlvalidator-1.0.1 → robotframework_xmlvalidator-2.0.0}/pyproject.toml RENAMED Viewed

@@ -1,7 +1,7 @@
 # General.
 [tool.poetry]
 name = "robotframework-xmlvalidator"
-version = "1.0.1"
+version = "2.0.0"
 description = "A Robot Framework test library for validating XML files against XSD schemas"
 authors = ["Michael Hallik <hallik.michael@gmail.com>"]
 license = "Apache-2.0"

{robotframework_xmlvalidator-1.0.1 → robotframework_xmlvalidator-2.0.0}/src/xmlvalidator/XmlValidator.py RENAMED Viewed

@@ -98,10 +98,10 @@ class XmlValidator:
     When operating in batch mode, the ``Validate Xml Files`` keyword
     always validates the entire set of passed XML files. That is, when
-    it encounters an error in a file, it does not simply fail. Rather,
-    it collects the error details (as determined by the error_facets
-    arg) and then continues validating the current file as well as any
-    subsequent file(s).
+    it encounters an error in a file, it does not simply then fail.
+    Rather, it collects the error details (as determined by the
+    error_facets arg) and then continues validating the current file as
+    well as any subsequent file(s).
     In that fashion the keyword works through the entire set of files.
@@ -158,12 +158,14 @@ class XmlValidator:
      - Namespace errors.
      - Etc.
-    - Captures malformed XML.
+    - Captures malformed XML (e.g. missing closing tag, encoding
+      issues).
     - Handles edge cases like empty files or XML files that could not be
       matched to an XSD schema file.
-    - Does not fail on errors, but collects encountered errors in all
-      files and reports them in a structured format in the console and
-      RF log.
+    - Does not immediately fail on errors, but collects encountered all
+      errors in all files and reports them in a structured format in the
+      console and RF log. Only *then* fails (assuming one or more
+      errors have been collected).
     - Supports specifying the details that should be collected for
       encountered errors.
     - Optionally exports the error report to a CSV file, providing the
@@ -236,23 +238,13 @@ class XmlValidator:
     Enables resolution of schema imports/includes via a custom base URL,
     via the ``base_url`` arg.
-    Use ``base_url`` when your XSD uses <xs:include> or <xs:import> with
-    relative paths.
+    Use ``base_url`` when your XSD uses ``<xs:include>`` or ``<xs:import>``
+    with relative paths.
     You can pass ``base_url`` with the library import (together with
     passing ``xsd_path``) and/or when calling ``Validate Xml Files``
     with ``xsd_path``.
-    ** Optional test case fail **
-    The ``Validate Xml Files`` keyword collects one or more errors for
-    one or more XML files. As mentioned earlier, the keyword is designed
-    so as to not fail upon encountering errors.
-    However, in case you want your test case to fail when one or more
-    errors have been detected, you can use the ``fail_on_errors`` (bool)
-    argument to make it so. It defaults to ${False}.
     **Basic usage examples**
     For a comprehensive set of example test cases, please see the
@@ -266,6 +258,18 @@ class XmlValidator:
     It further contains a detailed instruction on
     `how to run Robot Framework tests <https://github.com/MichaelHallik/robotframework-xmlvalidator/blob/main/test/_doc/integration/README.md>`_.
+    Finally, the repo also contains a `demo test suite file <https://github.com/MichaelHallik/robotframework-xmlvalidator/blob/main/test/demo/demo.robot>`_ containing
+    eight self-contained test cases to demonstrates the following features:
+    - Single and batch XML validation
+    - Schema matching by filename and namespace
+    - Custom error facets
+    - Malformed XML handling
+    - XSD includes/imports
+    - CSV export
+    A test suite file may look like the following:
 	.. code:: robotframework
 		*** Settings ***
@@ -361,21 +365,8 @@ class XmlValidator:
         [ WARN ]    XML is invalid:
         [ WARN ]        Error #0:
         [ WARN ]            reason: No matching XSD found for: no_xsd_match_2.xml.
-        Validation errors exported to 'C:\\test\\01_Advanced_Validation\\errors_2025-03-29_13-54-46-552150.csv'.
-        Total_files validated: 11.
-        Valid files: 6.
-        Invalid files: 5
-        01 Advanced Validation:: Demo XML validation | PASS |
-        21 errors have been detected.
-        ========================================================
-        01 Advanced Validation:: Demo XML validation | PASS |
-        1 test, 1 passed, 0 failed
-    In case ``fail_on_errors`` is True, the console output will look like this:
-    .. code:: console
-        Validation errors exported to 'C:\\test\\01_Advanced_Validation\\errors_2025-03-29_13-54-46-552150.csv'.
+        Validation errors exported to:
+            'C:\\test\\01_Advanced_Validation\\errors_2025-03-29_13-54-46-552150.csv'.
         Total_files validated: 11.
         Valid files: 6.
         Invalid files: 5.
@@ -384,8 +375,8 @@ class XmlValidator:
         ========================================================
         01 Advanced Validation:: Demo XML validation | FAIL |
         1 test, 0 passed, 1 failed
-    The corresponding CSV output would in both cases look like:
+    The corresponding CSV output will look like:
     .. code:: text
@@ -402,16 +393,17 @@ class XmlValidator:
     """
-    __version__ = '1.0.1'
+    __version__ = '2.0.0'
     ROBOT_LIBRARY_DOC_FORMAT = 'reST'
     nr_instances = 0
     def __init__(
         self,
-        xsd_path: Optional[str|Path] = None,
-        base_url: Optional[str] = None,
-        error_facets: Optional[List[str]] = None
-        ) -> None:
+        xsd_path: str | Path | None = None,
+        base_url: str | None = None,
+        error_facets: List[str] | None = None,
+        fail_on_errors: bool = True
+    ) -> None:
         """
         **Library Scope**
@@ -421,16 +413,19 @@ class XmlValidator:
         **Library Arguments**
-        +--------------+--------------+-----------+---------------------------------------------------------------------------------------------+
-        | Argument     | Type         | Required  | Description                                                                                 |
-        +==============+==============+===========+=============================================================================================+
-        | xsd_path     | str          | No        | Path to an XSD file or folder to preload during initialization.                             |
-        |              |              |           | In case of a folder, the folder must hold one file only.                                    |
-        +--------------+--------------+-----------+---------------------------------------------------------------------------------------------+
-        | base_url     | str          | No        | Base path used to resolve includes/imports within the provided XSD schema.                  |
-        +--------------+--------------+-----------+---------------------------------------------------------------------------------------------+
-        | error_facets | list of str  | No        | The attributes of validation errors to collect and report. E.g. ``path``, ``reason``.       |
-        +--------------+--------------+-----------+---------------------------------------------------------------------------------------------+
+        +---------------+-------------+----------+---------------------------------------------------------------------------------------------+----------------+
+        | Argument      | Type        | Required | Description                                                                                 | Default        |
+        +===============+=============+==========+=============================================================================================+================+
+        | xsd_path      | str         | No       | Path to an XSD file or folder to preload during initialization.                             | None           |
+        |               |             |          | In case of a folder, the folder must hold one file only.                                    |                |
+        +---------------+-------------+----------+---------------------------------------------------------------------------------------------+----------------+
+        | base_url      | str         | No       | Base path used to resolve includes/imports within the provided XSD schema.                  | None           |
+        +---------------+-------------+----------+---------------------------------------------------------------------------------------------+----------------+
+        | error_facets  | list of str | No       | The attributes of validation errors to collect and report. E.g. ``path``, ``reason``.       | [path, reason] |
+        +---------------+-------------+----------+---------------------------------------------------------------------------------------------+----------------+
+        | fail_on_error | bool        | No       | Whether to fail the test case if one or more XML validation errors are found.               | True           |
+        |               |             |          | Can be overridden per keyword call.                                                         |                |
+        +---------------+-------------+----------+---------------------------------------------------------------------------------------------+----------------+
         All arguments are optional.
@@ -485,6 +480,30 @@ class XmlValidator:
         See the introduction for more details on the purpose and usage
         of error facets.
+        ``fail_on_error``
+        The ``fail_on_errors`` argument controls whether a test case
+        should fail if one or more XML validation errors are detected.
+        It defaults to True. A test case that has resulted in the
+        collection of one or more errors (of whatever type) will then
+        receive a status of FAIL.
+        You can use the ``fail_on_errors`` argument to change this
+        default behaviour. When set to False, a test cases's status will
+        always be PASS, regardless whether errors were collected or not.
+        This may be useful for:
+        - Non-blocking checks in dashboards or QA reports.
+        - Legacy or transitional systems where some invalid files are expected.
+        - Schema discovery or diagnostics, where conformance isn’t yet enforced.
+        - Soft rollout of stricter validation rules, allowing time to adapt.
+        Note that with ``fail_on_error=True`` the library's batch
+        validation behavior remains unchanged by the latter. That is,
+        fail_on_errors=True does not short-circuit the validation
+        process in any way.
         **Examples**
@@ -530,6 +549,8 @@ class XmlValidator:
         For more examples see the project's
         `Robot Framework integration test suite <https://github.com/MichaelHallik/robotframework-xmlvalidator/blob/main/test/integration/01_library_initialization.robot>`_.
+        And also the `demo test suite file <https://github.com/MichaelHallik/robotframework-xmlvalidator/blob/main/test/demo/demo.robot>`_.
         **Raises**
         +---------------+--------------------------------------------------------------+
@@ -550,20 +571,27 @@ class XmlValidator:
         self.validator_results = ValidatorResultRecorder()
         # Initialize the xsd schema from the xsd_path, if provided.
         self.schema = self._try_load_initial_schema(
-            xsd_path=xsd_path,
-            base_url=base_url
-            )
+            xsd_path=xsd_path, base_url=base_url
+        )
         # Set the error facets to collect for failed XML validations.
         self.error_facets = error_facets if error_facets else [
             'path', 'reason'
-            ]
+        ]
         logger.info(
             f"Collecting error facets: {self.error_facets}.",
             also_console=True
-            )
+        )
+        # Set the validation strictness.
+        self.fail_on_errors = fail_on_errors
+        logger.info(
+            f"Fail on errors: {self.fail_on_errors}.", also_console=True
+        )
+        # Report readiness.
         logger.info("XML Validator ready for use!", also_console=True)
         self.nr_instances += 1
-        logger.info(f'Number of library instances: {self.nr_instances}.')
+        logger.info(
+            f'Number of library instances: {self.nr_instances}.'
+        )
     def _determine_validations(
         self,
@@ -784,15 +812,15 @@ class XmlValidator:
                 "No schema: provide an XSD path during keyword call(s)."
                 )
         if self.schema and not xsd_path :
-            logger.info(
-                f'No new schema set: keeping existing schema {self.schema}.'
-                )
+            # logger.info(
+            #     f'No new schema set: keeping existing schema {self.schema}.'
+            #     )
             return ValidatorResult(success=True, value=self.schema)
         if not self.schema and xsd_path:
             logger.info(f'Setting schema file: {xsd_path}.', also_console=True)
         if self.schema and xsd_path:
             logger.info(
-                f'Setting new schema file: {xsd_path}.',
+                f'\tUsing schema: {xsd_path}.',
                 also_console=True
                 )
         return self._load_schema(xsd_path, base_url) # pyright: ignore
@@ -895,13 +923,13 @@ class XmlValidator:
                 # Catch and handle any exception.
                 except Exception as err: # pylint: disable=W0718:broad-exception-caught
                     # Inform the user.
-                    logger.warn('Processing XML file failed.')
+                    logger.info('\t\tProcessing XML file failed.')
                     # Collect the error to be mapped to the xml file.
                     validations[xml_file_path] = err
                     continue
                 # Test each XSD file for a matching namespace.
                 for xsd_file_path in xsd_file_paths:
-                    logger.info(f"Testing schema: {xsd_file_path}.")
+                    logger.info(f"\t\tTesting schema: {xsd_file_path}.")
                     # Load the schema.
                     result = self._load_schema(
                         xsd_file_path, base_url=base_url
@@ -929,7 +957,7 @@ class XmlValidator:
                     logger.info(f"\t\t\tTesting file name: {xsd_file_path}.")
                     # Compare the XSD/XML file names.
                     if xsd_file_path.stem == xml_file_path.stem:
-                        logger.info("\t\t\tFound match.")
+                        logger.info("\t\tFound match.")
                         # Assign current XSD path in case of a match & break.
                         validations[xml_file_path] = xsd_file_path
                         break
@@ -941,7 +969,7 @@ class XmlValidator:
                 raise ValueError(f"Unsupported search strategy: {search_by}.")
             # If no match has been found.
             if not validations[xml_file_path]:
-                logger.info(f"No valid XSD found for {xml_file_path}.")
+                logger.info(f"\t\tNo valid XSD found for {xml_file_path}.")
                 validations[xml_file_path] = FileNotFoundError(
                     f'No matching XSD found for: {xml_file_path.stem}.'
                     )
@@ -1238,7 +1266,7 @@ class XmlValidator:
         """
         # Log informative.
         logger.info(
-            f"Validating '{xml_file_path.stem}'.", also_console=True
+            f"Validating '{xml_file_path.name}", also_console=True
             )
         # Check upstream XSD matching led to an err pertaining to the XML.
         if isinstance(xsd_file_path, BaseException):
@@ -1256,7 +1284,7 @@ class XmlValidator:
             )
         if not sanity_check_result.success:
             # Abort validation if one or more sanity checks failed.
-            logger.warn("File(s) failed basic sanity check.")
+            # logger.warn("File(s) failed basic sanity check.")
             return False, sanity_check_result.error
         # Ensure a valid schema is loaded.
         loading_result = self._ensure_schema(
@@ -1432,7 +1460,7 @@ class XmlValidator:
         write_to_csv: Optional[bool] = True,
         timestamped: Optional[bool] = True,
         reset_errors: bool = True,
-        fail_on_errors: Optional[bool] = False
+        fail_on_errors: Optional[bool] = None
         ) -> Tuple[
             List[ Dict[str, Any] ],
             str | None
@@ -1595,6 +1623,12 @@ class XmlValidator:
         # Reset attributes, if requested.
         if reset_errors:
             self.validator_results.reset()
+        # Determine the validation strictness.
+        fail_on_errors = (
+            fail_on_errors \
+                if fail_on_errors is not None \
+                    else self.fail_on_errors
+        )
         # Determine and resolve/normalize the XML file path(s).
         xml_file_paths, is_single_xml_file = (
             self.validator_utils.get_file_paths(

{robotframework_xmlvalidator-1.0.1 → robotframework_xmlvalidator-2.0.0}/src/xmlvalidator/__init__.py RENAMED Viewed

@@ -55,6 +55,6 @@ try:
     __version__ = version("robotframework-xmlvalidator")
 except PackageNotFoundError:
     # Fall back when package not installed (default version for development).
-    __version__ = "1.0.1"
+    __version__ = "2.0.0"
     import warnings
     warnings.warn("Package metadata not found, using fallback version.")

{robotframework_xmlvalidator-1.0.1 → robotframework_xmlvalidator-2.0.0}/src/xmlvalidator/xml_validator_results.py RENAMED Viewed

@@ -75,7 +75,7 @@ class ValidatorResultRecorder:
     and export validation results.
     """
-    __version__ = '1.0.1'
+    __version__ = '2.0.0'
     errors_by_file: List[Dict[str, Any]] = field(default_factory=list)
     validation_summary: Dict[str, List[str]] = field(
@@ -331,7 +331,7 @@ class ValidatorResultRecorder:
         try:
             df.to_csv(output_csv_path, index=False)
             logger.info(
-                f"Validation errors exported to '{output_csv_path}'.",
+                f"Validation errors exported to: \n\t'{output_csv_path}'.",
                 also_console=True
                 )
         except IOError as e:

{robotframework_xmlvalidator-1.0.1 → robotframework_xmlvalidator-2.0.0}/src/xmlvalidator/xml_validator_utils.py RENAMED Viewed

@@ -43,7 +43,6 @@ from pathlib import Path
 from typing import List, Optional, Tuple, Union, TYPE_CHECKING
 # Third party library imports.
 from lxml import etree
-from robot.api import logger
 # Local application imports.
 from .xml_validator_results import ValidatorResult
 if TYPE_CHECKING:
@@ -67,7 +66,7 @@ class ValidatorUtils:
     All methods are static and the class maintains no internal state.
     """
-    __version__ = '1.0.1'
+    __version__ = '2.0.0'
     @staticmethod
     def _resolve_path(path: str | Path) -> Path:
@@ -472,9 +471,9 @@ class ValidatorUtils:
                         if isinstance(value, tuple):
                             value = f"Line {value[0]}, Column {value[1]}."
                         error_details[facet] = value
-                    logger.warn(
-                        f"Facet '{facet}' is not an attribute of error type'{type(e).__name__}'."
-                        )
+                    # logger.warn(
+                    #     f"Facet '{facet}' is not an attribute of error type'{type(e).__name__}'."
+                    #     )
                 # Add the error type to the error details
                 error_details['Error type'] = type(e).__name__
                 # Append the error to the return list.

{robotframework_xmlvalidator-1.0.1 → robotframework_xmlvalidator-2.0.0}/LICENSE RENAMED Viewed

File without changes

robotframework-xmlvalidator 1.0.1__tar.gz → 2.0.0__tar.gz

robotframework-xmlvalidator 1.0.1tar.gz → 2.0.0tar.gz