{"id":50714145,"url":"https://github.com/rticommunity/rticonnextdds-qos-diff","last_synced_at":"2026-06-09T17:32:19.286Z","repository":{"id":355670514,"uuid":"1119824228","full_name":"rticommunity/rticonnextdds-qos-diff","owner":"rticommunity","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-04T18:22:53.000Z","size":111,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-04T19:34:47.170Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rticommunity.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-19T23:10:14.000Z","updated_at":"2026-05-04T18:22:57.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/rticommunity/rticonnextdds-qos-diff","commit_stats":null,"previous_names":["rticommunity/rticonnextdds-qos-diff"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/rticommunity/rticonnextdds-qos-diff","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rticommunity%2Frticonnextdds-qos-diff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rticommunity%2Frticonnextdds-qos-diff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rticommunity%2Frticonnextdds-qos-diff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rticommunity%2Frticonnextdds-qos-diff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rticommunity","download_url":"https://codeload.github.com/rticommunity/rticonnextdds-qos-diff/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rticommunity%2Frticonnextdds-qos-diff/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34118751,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-09T17:32:17.154Z","updated_at":"2026-06-09T17:32:19.278Z","avatar_url":"https://github.com/rticommunity.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QosDiff and QosExpand\n\nThis script will allow you to diff Qos XML files across different versions of Connext and will expand Qos profiles to account for profile inheritance and composition.\n\n## Prerequisites\n\n- Python 3.8+ (tested with Python 3.12)\n- cmake\n- git (for commit-based diffing)\n- One or more RTI Connext DDS installations (version \u003e= 6.1.0)\n\n## Cloning\n\n```bash\ngit clone --recurse-submodules https://bitbucket.org/brianr114/qos_diff.git\n```\n\n## Build QosDiff Utility\nBuild the submodules with the `build.py` script.  The build tool will look in the parent of `connext_dir` for other Connext installations.  The build utility expects the Connext installation folder to be named `rti_connext_dds-x.x.x`, which is the default installation name. If you use RTI scripts to setup your environment (environment variables `NDDSHOME` and `CONNEXTDDS_ARCH`), you can simply use the build script as follows:\n\n```bash\npython3 build.py\n```\n\nOtherwise, you must specify those parameters as required arguments:\n\n```bash\nusage: build.py [-h] --connext_dir CONNEXT_DIR --connext_arch CONNEXT_ARCH\n```\n\u003cpre\u003e\n--connext_dir       /path/to/rti_connext_dds-x.x.x\n--connext_arch      Specify your Connext DDS architecture.\n\u003c/pre\u003e\n\n## Usage\n\nRun the utility with the `qos_diff.py` script.\n\n```bash\nusage: qos_diff.py [-h] --qos_file QOS_FILE [--diff_file DIFF_FILE] [--commit COMMIT] [--profile PROFILE]\n                   [--new_profile NEW_PROFILE] [--out_dir OUT_DIR] [--rm] [--break_on_failure] [--versions] [--expand]\n```\n\u003cpre\u003e\n--qos_file          Required argument. Specify the Qos file.\n--diff_file         Specify a Qos file to diff.\n--commit            Specify the Git commit hash of the base file.\n--profile           Specify the Qos profile as specified in the README. Otherwise all profiles will be diffed.\n--new_profile       If the profile has been renamed in the diff file, specify the new Qos Profile as specified in the README.\n--out_dir           Output directory for Qos files, diffs, and logs. Default is ${CWD}/output.\n--rm                Delete intermediary diff output.\n--break_on_failure  Break on diff failure.\n--versions          Compare across different versions of Connext.\n--expand            Expand the Qos profile.  Do not diff.\n--delta             Only show the delta from default profile values.  Only valid with --expand.\n--ignore_nddshome   Ignore NDDSHOME as the default Connext version.\n\u003c/pre\u003e\n\n### Connext Version\n\nBecause QoS configuration evolves across Connext releases, it is important to use the correct version of the underlying version-specific tool. QosDiff will attempt to determine the appropriate version automatically using the `NDDSHOME` environment variable. If this lookup fails, if the user specifies `--ignore_nddshome`, or if the diff is performed across different Connext versions using `--versions`, the user will be prompted to select the version(s) to use.\n\n### Expand Qos Files\n\n`expand` is the only additionally required flag.  Add the `delta` flag to limit the output to only show changes from the default profile.\n\n### Diff Qos Files\n\nEither `diff_file` or `commit` must be specified.  If both are specified, `diff_file` will be ignored.  The user will be prompted by the application to select a Connext version, and if `versions` is selected, the user will be prompted to select both the base and diff versions of Connext.\n\n### Profile Specification\n\nTo operate on a single profile instead of the entire file, you can use the `--profile` command with arguments in the format `LIBRARY::PROFILE[::[ENTITY_NAME]::TOPIC_FILTER::ENTITY_TYPE]`.  If you choose to specify a `TOPIC_FILTER`, `ENTITY_TYPE` is required and `ENTITY_NAME` is optional.  Valid options for `ENTITY_TYPE` are: `datawriter_qos`, `datareader_qos`, `topic_qos`.\n\nThis same argument pattern is required for the `new_profile` argument.\n\n## Common Scenarios\n\n```bash\n# Expand all profiles in QOS_FILE\npython3 qos_diff.py --qos_file \u003cQOS_FILE\u003e --expand\n\n# Diff all profiles in QOS_FILE against the same file in a previous Git COMMIT\npython3 qos_diff.py --qos_file \u003cQOS_FILE\u003e --commit \u003cCOMMIT\u003e\n\n# Diff PROFILE in QOS_FILE against the same profile in a previous Git COMMIT\npython3 qos_diff.py --qos_file \u003cQOS_FILE\u003e --commit \u003cCOMMIT\u003e --profile \u003cPROFILE\u003e\n\n# Diff NEW_PROFILE in QOS_FILE against PROFILE in a previous Git COMMIT\npython3 qos_diff.py --qos_file \u003cQOS_FILE\u003e --commit \u003cCOMMIT\u003e --profile \u003cPROFILE\u003e --new_profile \u003cNEW_PROFILE\u003e\n\n# Diff all profiles in QOS_FILE against the a second DIFF_FILE\npython3 qos_diff.py --qos_file \u003cQOS_FILE\u003e --diff_file \u003cDIFF_FILE\u003e\n\n# Diff PROFILE in QOS_FILE against the same profile in DIFF_FILE\npython3 qos_diff.py --qos_file \u003cQOS_FILE\u003e --diff_file \u003cDIFF_FILE\u003e --profile \u003cPROFILE\u003e\n\n# Diff PROFILE in QOS_FILE against NEW_PROFILE in DIFF_FILE\npython3 qos_diff.py --qos_file \u003cQOS_FILE\u003e --diff_file \u003cDIFF_FILE\u003e --profile \u003cPROFILE\u003e --new_profile \u003cNEW_PROFILE\u003e\n```\n\n## Troubleshooting\n\n### Build Issues\n- Ensure `NDDSHOME` and `CONNEXTDDS_ARCH` environment variables are set if using RTI scripts\n- Verify cmake is installed and accessible in your PATH\n- Check that your Connext installation directory follows the naming convention `rti_connext_dds-x.x.x`\n\n### Runtime Issues\n- Check the `output/log.txt` file for detailed error messages\n- Ensure the QoS XML file is valid and well-formed\n- Verify that specified profiles exist in the XML file\n\n\u003c!--\n##############################################################################################\n# (c) 2024-2025 Copyright, Real-Time Innovations, Inc. (RTI) All rights reserved.\n#\n# RTI grants Licensee a license to use, modify, compile, and create derivative works of the\n# software solely for use with RTI Connext DDS. Licensee may redistribute copies of the\n# software, provided that all such copies are subject to this license. The software is\n# provided \"as is\", with no warranty of any type, including any warranty for fitness for any\n# purpose. RTI is under no obligation to maintain or support the software. RTI shall not be\n# liable for any incidental or consequential damages arising out of the use or inability to\n# use the software.\n#\n##############################################################################################\n--\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frticommunity%2Frticonnextdds-qos-diff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frticommunity%2Frticonnextdds-qos-diff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frticommunity%2Frticonnextdds-qos-diff/lists"}