odsbox-diff 1.0.0__tar.gz

odsbox_diff-1.0.0/LICENSE

@@ -0,0 +1,200 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may accept support,
+      warranty, indemnity, or other liability obligations and/or rights
+      consistent with this License. However, in accepting such obligations,
+      You may act only on Your own behalf and on Your sole responsibility,
+      not on behalf of any other Contributor, and only if You agree to
+      indemnify, defend, and hold each Contributor harmless for any
+      liability incurred by, or claims asserted against, such Contributor
+      by reason of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Peak Solution GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing permissions and
+   limitations under the License.

odsbox_diff-1.0.0/PKG-INFO

@@ -0,0 +1,274 @@
+Metadata-Version: 2.4
+Name: odsbox-diff
+Version: 1.0.0
+Summary: Compare two ASAM ODS hierarchy instances and write a structured diff result.
+Keywords: ASAM,ODS,measurement data,diff,regression testing
+Author: A. Krantz
+Author-email: A. Krantz <a.krantz@peak-solution.de>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Testing
+Requires-Dist: deepdiff>=9.0.0
+Requires-Dist: keyring>=24.0.0
+Requires-Dist: odsbox[oidc]>=1.2.0
+Requires-Python: >=3.14
+Project-URL: Homepage, https://github.com/peak-solution/odsbox-diff
+Project-URL: Repository, https://github.com/peak-solution/odsbox-diff
+Project-URL: Issues, https://github.com/peak-solution/odsbox-diff/issues
+Project-URL: Changelog, https://github.com/peak-solution/odsbox-diff/releases
+Description-Content-Type: text/markdown
+
+# odsbox-diff
+
+[![Build](https://github.com/peak-solution/odsbox-diff/actions/workflows/build.yml/badge.svg)](https://github.com/peak-solution/odsbox-diff/actions/workflows/build.yml)
+[![PyPI version](https://img.shields.io/pypi/v/odsbox-diff.svg)](https://pypi.org/project/odsbox-diff/)
+[![Python versions](https://img.shields.io/pypi/pyversions/odsbox-diff.svg)](https://pypi.org/project/odsbox-diff/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+A CLI and Python library to compare two instance hierarchies on one or two ASAM ODS
+servers and write a structured diff result. Built on
+[odsbox](https://pypi.org/project/odsbox/) for ODS access and
+[deepdiff](https://pypi.org/project/deepdiff/) for the comparison.
+
+Typical use cases:
+
+- Verify that a test, test step or measurement was migrated faithfully between
+  two servers.
+- Detect unintended changes between two snapshots of the same instance.
+- Hash bulk LocalColumn data to detect changes in measured signals.
+- **Regression testing** — compare a saved baseline file against a live server
+  instance.
+- **Create baselines** — collect a hierarchy snapshot to a file for later
+  comparison, with optional round-trip validation.
+- **Offline comparison** — diff two previously saved hierarchy files without
+  any server connection.
+
+> **Full user guide:** see [`docs/usage.md`](docs/usage.md) for comprehensive
+> CLI examples, Python API reference, pytest integration patterns, and
+> troubleshooting.
+
+## Installation
+
+```powershell
+uv add odsbox-diff
+# or, with pip
+pip install odsbox-diff
+```
+
+The package requires Python 3.14+ and ships a console script `odsbox-diff`.
+
+## Quick start
+
+1. Copy one of the example configs from `configs/` and adjust it:
+
+   - `config.example.toml` — basic auth (single or multiple servers)
+   - `config.m2m.example.toml` — OAuth2 machine-to-machine
+   - `config.oidc.example.toml` — OIDC (interactive browser login)
+
+2. Store the secret (password / `client_secret`) in your OS keyring (see
+   [Keyring secrets](#keyring-secrets) below) or inline it in the config file.
+
+3. Run the diff:
+
+   ```powershell
+   uv run odsbox-diff `
+       --config my-config.toml `
+       --entity TestStep `
+       -id1 5 `
+       -id2 7
+   ```
+
+   With multiple named servers, prefix instance IDs with the server name:
+
+   ```powershell
+   uv run odsbox-diff `
+       --config my-config.toml `
+       --entity TestStep `
+       -id1 prod:1898 `
+       -id2 staging:2
+   ```
+
+   Compare two saved JSON files (no server connection needed):
+
+   ```powershell
+   uv run odsbox-diff `
+       --config my-config.toml `
+       --entity TestStep `
+       -id1 file:baseline.json `
+       -id2 file:current.json
+   ```
+
+   Collect a hierarchy to a file and self-validate:
+
+   ```powershell
+   uv run odsbox-diff collect `
+       --config my-config.toml `
+       --entity TestStep `
+       -id 42 `
+       -o baseline.json `
+       --validate
+   ```
+
+## CLI reference
+
+### `odsbox-diff` (diff mode)
+
+| Flag | Description |
+| --- | --- |
+| `-c`, `--config` | Path to a TOML or JSON config file (required). |
+| `--entity` | Root entity name to compare (e.g. `TestStep`, `Measurement`). |
+| `-id1` / `-id2` | Instance reference: plain ID (`42`), `server:id` (`prod:5`), or `file:path.json` to load from disk. |
+| `-rf`, `--result_file` | Override the result-file path from config defaults. |
+| `-ep`, `--exclude_path` | Extra DeepDiff path to exclude (repeatable). |
+| `-erp`, `--exclude_regex_path` | Extra regex path exclusion (repeatable). |
+| `-dd`, `--dump_dictionaries` | Also dump the collected hierarchies as `<result>.inst1.json` / `.inst2.json`. |
+| `-bn`, `--no_bulk` | Skip bulk LocalColumn hashing. |
+| `-bpb`, `--bulk_progress_bar` | Show a progress bar during bulk hashing. |
+| `--cached-related ENTITY [...]` | Resolve relation IDs to names for the listed entities. |
+| `-v`, `--verbose` | INFO logging with timestamps. |
+| `-q`, `--quiet` | Suppress all logging. |
+
+CLI flags always override config defaults. List options (`exclude_path`,
+`exclude_regex_path`, `cached-related`) extend the config defaults rather than
+replacing them.
+
+### `odsbox-diff collect` (collect mode)
+
+| Flag | Description |
+| --- | --- |
+| `-c`, `--config` | Path to a TOML or JSON config file (required). |
+| `--entity` | Root entity name to collect. |
+| `-id` | Instance ID or `server:id`. |
+| `-o`, `--output` | Output file path (`.json` or `.zip`). |
+| `--validate` | After saving, reload and self-diff to verify round-trip fidelity. |
+| `-rf`, `--result_file` | Path for the self-diff result (only with `--validate`). |
+| `-bn`, `--no_bulk` | Skip bulk LocalColumn hashing. |
+| `-bpb`, `--bulk_progress_bar` | Show a progress bar during bulk hashing. |
+| `--cached-related ENTITY [...]` | Resolve relation IDs to names. |
+| `-v`, `--verbose` | INFO logging with timestamps. |
+| `-q`, `--quiet` | Suppress all logging. |
+
+## Exit codes
+
+| Code | Meaning |
+| --- | --- |
+| `0` | No differences found (or collect completed successfully). |
+| `100` | Differences found; result file written. |
+| `1` | Argument or `server:id` validation error. |
+| `-1` | Uncaught exception. |
+
+## Keyring secrets
+
+Secrets are read from the OS keyring under the service name `odsbox-diff`:
+
+| Auth method | Keyring key |
+| --- | --- |
+| `basic` | `<url>:<username>` (password) |
+| `m2m` / `oidc` | `<token_endpoint>:<client_id>` (`client_secret`) |
+
+Example with the `keyring` CLI:
+
+```powershell
+keyring set odsbox-diff "http://localhost:57481/api:admin"
+```
+
+## Library usage
+
+### High-level API (recommended for test frameworks)
+
+```python
+from odsbox_diff import diff_file_to_file, diff_file_to_server, collect_to_file
+from odsbox_diff.connection import AppConfig, ServerConfig, AuthMethod
+
+# Compare two saved files — no server needed
+diff = diff_file_to_file("baseline.json", "current.json")
+assert not diff  # falsy = no differences
+
+# Regression test: baseline file vs live server
+diff = diff_file_to_server("my-config.toml", "TestStep", 42, "baseline.json")
+assert not diff
+
+# Build config in code (no config file needed)
+cfg = AppConfig(servers={"default": ServerConfig(
+    url="http://localhost:8080/api",
+    username="admin",
+    password="secret",
+)})
+diff = diff_file_to_server(cfg, "TestStep", 42, "baseline.json")
+
+# Collect a baseline and validate round-trip fidelity
+result = collect_to_file("my-config.toml", "TestStep", 42, "baseline.json", validate=True)
+assert not result  # falsy = round-trip is clean
+```
+
+### Low-level building blocks
+
+```python
+from odsbox_diff import (
+    collect,
+    diff_dictionaries,
+    dump_diff_as_json,
+    save_collect_results,
+)
+from odsbox_diff.connection import create_connection, load_config
+
+app_config = load_config("my-config.toml")
+server = next(iter(app_config.servers.values()))
+
+with create_connection(server) as con_i:
+    tree_a, _ = collect(con_i, "TestStep", 5)
+    tree_b, _ = collect(con_i, "TestStep", 7)
+
+diff = diff_dictionaries(tree_a, tree_b, [], [])
+dump_diff_as_json("diff.json", diff)
+```
+
+## Configuration reference
+
+### `[server]` / `[servers.<name>]`
+
+Either a single `[server]` table (stored internally as the `default` server) or
+one `[servers.<name>]` table per named server. Common fields:
+
+| Field | Type | Notes |
+| --- | --- | --- |
+| `url` | string | ODS REST endpoint (required). |
+| `verify_certificate` | bool | Default `true`. |
+| `method` | string | `basic`, `m2m`, or `oidc`. Default `basic`. |
+
+Method-specific fields are documented in the example configs in `configs/`.
+
+When using file-to-file comparisons only, the `[server]` section can be omitted
+entirely — only `[defaults]` is needed.
+
+### `[defaults]`
+
+Optional defaults for diff behavior:
+
+| Field | Type | Default |
+| --- | --- | --- |
+| `result_file` | string | `"diff_ods_tests_result.json"` |
+| `exclude_paths` | list | `[]` |
+| `exclude_regex_paths` | list | `[]` (default `Id` / `DateCreated` / `Version` exclusions are always applied) |
+| `cached_related` | list | `[]` |
+| `bulk_progress_bar` | bool | `false` |
+| `no_bulk` | bool | `false` |
+| `dump_dictionaries` | bool | `false` |
+| `verbose` | bool | `false` |
+| `quiet` | bool | `false` |
+
+## Development
+
+```powershell
+uv sync
+uv run pytest
+uv run ruff check src tests
+uv run mypy src
+```