Add script for crate structure comparison #63

igorostrowskiq · 2025-08-05T10:57:42Z

Add script for crate structure analysis and comparison with older results

Copilot

Pull Request Overview

This PR introduces a new Python script for analyzing and comparing Rust crate structure, specifically focusing on coverage checking. The script can parse crate structure data, filter by visibility and item types, and compare results with reference data to track coverage progress.

Key changes:

Added comprehensive crate structure analysis functionality with tree-based data representation
Implemented filtering capabilities for visibility levels and item types (functions, structs, enums, etc.)
Added reference comparison feature to track coverage changes over time

Comments suppressed due to low confidence (1)

scripts/coverage_checker.py:345

Variable name 'all' shadows the built-in function. Consider using 'total' or 'total_nodes' instead.

    all = tree.count_leaf_nodes()

scripts/coverage_checker.py

PiotrKorkus

Take a look into copilot comments. They aren't that bad and even caught a bug.
I would suggest following structure:

create an extra directory coverage_checker in scripts and place script there
add bash script with command to generate input file
We will need some docstrings for sure.
Let's have a call, as when I try to run it I get quite messy tabs in the output.

PiotrKorkus · 2025-08-05T11:15:01Z

scripts/coverage_checker.py

+        with open(args.input, "r") as f:
+            input_lines = f.readlines()
+    else:
+        input_lines = sys.stdin.readlines()


Lets stop using stdin. Arguments are all we need

PiotrKorkus · 2025-08-05T11:28:03Z

scripts/coverage_checker.py

+
+        self.data = line_parts[0]
+        self.comment = line_parts[-1] if len(line_parts) > 1 else None
+        self.tab_count = line.count("\t") if self.comment is not None else None


if self.comment else None is enough

PiotrKorkus · 2025-08-05T11:30:29Z

scripts/coverage_checker.py

+            if token.startswith("pub"):
+                return Visibility(token)
+
+        raise RuntimeError("Visibility not detected for: " + data_line)


make it f-string

PiotrKorkus · 2025-08-05T11:38:11Z

scripts/coverage_checker.py

+        if found != -1:
+            return Entry(line, item_type, found)
+
+    raise RuntimeError("No known item type found for parsed line: " + line)


f-string here as well

arkjedrz

I don't think parsing languages using scripts is a good idea. In my experience - it is working shabby at best, and causing unsustainable burden to maintain at worst.
I feel there might be an overlap with what is expected with https://github.com/cargo-public-api/cargo-public-api
I'm missing any kind of rationale or example what's this script for.
I was unable to find one file from Persistency repo that will work with this scripts.

arkjedrz · 2025-08-06T06:25:08Z

scripts/coverage_checker.py

@@ -0,0 +1,346 @@
+import argparse


Missing shebang and docstring.

Still to check

arkjedrz · 2025-08-06T06:25:27Z

scripts/coverage_checker.py

File is missing exe rights.

Please take ruff rules from impl: add pre-commit hooks #62 and run ruff on this file. I get some issues reported.

Still to check

Added exe rights

Fixed or suppressed issues found by ruff

arkjedrz · 2025-08-06T06:26:27Z

scripts/coverage_checker.py

+
+
+class TreeNode:
+    def __init__(self, entries: list[Entry], ndx: Indexer, parent: Union["TreeNode", None] = None):


Union["TreeNode", None] -> "TreeNode" | None

I have tried that initially, but looks that incomplete type is not supported in this syntax:

File "/home/igor/repos/testing_tools/scripts/coverage_checker.py", line 132, in TreeNode def __init__(self, entries: list[Entry], ndx: Indexer, parent: "TreeNode" | None = None): ~~~~~~~~~~~^~~~~~ TypeError: unsupported operand type(s) for |: 'str' and 'NoneType'

yep, it won't work since we are referring to the type through string literal. You can leave it as it is, or use Optional["TreeNode"] but | wont work

Used Optional

igorostrowskiq · 2025-08-11T12:26:19Z

Take a look into copilot comments. They aren't that bad and even caught a bug. I would suggest following structure:
* create an extra directory `coverage_checker` in scripts and place script there

* add bash script with command to generate input file
  We will need some docstrings for sure.
  Let's have a call, as when I try to run it I get quite messy tabs in the output.

Moved to directory coverage_checker
Added readme with commandline
Added docstrings

PiotrKorkus

Please add information about setting tabs 4 for best output representation

PiotrKorkus · 2025-08-11T12:25:36Z

scripts/coverage_checker/README.md

+`cd <inc_orchestrator_repo>`
+`cargo modules structure --package orchestration | sed 's/\x1b\[[0-9;]*m//g' > input_report.txt` - sed is required to remove colored output
+`python3 scripts/coverage_checker.py -r <older_orchestration_report> input_report.txt`


It doesn't look good when rendered, replace it with single block of code ```.

Path in commands shall be relative to README, so just coverage_checker.py

Also please install https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint and solve issues

Added double spaces at the end to force new lines. Do not switched to block to avoid having there also explanation for the command.

Fixed

Done

PiotrKorkus · 2025-08-11T12:30:03Z

scripts/coverage_checker.py

+
+
+class TreeNode:
+    def __init__(self, entries: list[Entry], ndx: Indexer, parent: Union["TreeNode", None] = None):


yep, it won't work since we are referring to the type through string literal. You can leave it as it is, or use Optional["TreeNode"] but | wont work

igorostrowskiq · 2025-08-11T13:07:42Z

I don't think parsing languages using scripts is a good idea. In my experience - it is working shabby at best, and causing unsustainable burden to maintain at worst.

I feel there might be an overlap with what is expected with https://github.com/cargo-public-api/cargo-public-api

I'm missing any kind of rationale or example what's this script for.

I was unable to find one file from Persistency repo that will work with this scripts.

It is intermediate solution for our coverage reporting. Once requirements are available we will switch to this metric and abandon the script. There should be no issues with the maintenance.
Similar functionality, also needs filtering and visualization is less human user friendly
Added info in the readme
Should also work with persistency. For now only runtime and orchestrator is checked (https://github.com/qorix-group/inc_orchestrator_internal/discussions/212)

igorostrowskiq · 2025-08-11T13:28:24Z

Please add information about setting tabs 4 for best output representation

Added in the readme

igorostrowskiq requested review from PiotrKorkus, arkjedrz and Copilot August 5, 2025 10:57

Copilot AI reviewed Aug 5, 2025

View reviewed changes

PiotrKorkus requested changes Aug 5, 2025

View reviewed changes

arkjedrz requested changes Aug 6, 2025

View reviewed changes

igorostrowskiq force-pushed the igorostrowskiq-add-module-coverage-script branch 2 times, most recently from f81630a to 95da068 Compare August 11, 2025 11:48

igorostrowskiq force-pushed the igorostrowskiq-add-module-coverage-script branch from 95da068 to d795ea1 Compare August 11, 2025 12:42

PiotrKorkus reviewed Aug 11, 2025

View reviewed changes

igorostrowskiq force-pushed the igorostrowskiq-add-module-coverage-script branch from d795ea1 to e76683e Compare August 11, 2025 13:26

igorostrowskiq marked this pull request as ready for review August 11, 2025 13:30

PiotrKorkus approved these changes Aug 11, 2025

View reviewed changes

Add script for crate structure comparison

fe727ed

igorostrowskiq force-pushed the igorostrowskiq-add-module-coverage-script branch from e76683e to fe727ed Compare August 12, 2025 06:47

igorostrowskiq merged commit c658427 into main Aug 12, 2025

igorostrowskiq deleted the igorostrowskiq-add-module-coverage-script branch August 12, 2025 06:53



		class TreeNode:
		def __init__(self, entries: list[Entry], ndx: Indexer, parent: Union["TreeNode", None] = None):

Add script for crate structure comparison #63

Add script for crate structure comparison #63

Uh oh!

Conversation

igorostrowskiq commented Aug 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PiotrKorkus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arkjedrz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

igorostrowskiq Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

igorostrowskiq commented Aug 11, 2025

Uh oh!

PiotrKorkus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

igorostrowskiq commented Aug 11, 2025

Uh oh!

igorostrowskiq commented Aug 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

igorostrowskiq Aug 6, 2025 •

edited

Loading