Add comparison mode to sprint overview script

[happz]

Pull Request Checklist

• implement the feature
• write the documentation

[happz]

Based on #4672:

$ scripts/sprint-overview --sprint 'Sprint 12' --base sprint-12.overview.start.yaml
Fetching items from teemtee/project/1 for sprint 'Sprint 12'...
Page 1: 53 items
Total: 53 items

================================================================================
  Sprint:                 Sprint 12
  Total items:            36 => 53
  Total story points:     92 => 119
  Completed items:        43 vs 10
  Completed story points: 86 vs 33
  Added items:            18 vs 1
  Added story points:     28 1
================================================================================

  Completed (43) - 86 points
--------------------------------------------------------------------------------
  tmt#3945    [1]  tmt is getting stuck by waiting for sudo bootc status on non-bootc host system
  tmt#4333    [2]  Add KVM device access support to Podman
  tmt#4457    [2]  Drop step-specific "base Click command" implementations
  tmt#4557    [5]  Review flaky tests and make them reliable
  tmt#4599    [2]  Fix the xref formatting of `:tmt:story:` role to normal text
  tmt#4604    [5]  Duplicated issues, Jira Cloud integration, sprint overview
  tmt#4609    [2]  tmt gets stuck for a while on bootc?
  tmt#4618    [5]  Save warning messages to be picked up by testing-farm
  tmt#4631    [1]  Check for the presence of sudo before querying is_image_mode
  tmt#4635    [1]  Instruct `rpminspect` to ignore xml jinja templates
  tmt#4637    [2]  Add virtualization.confidential hardware requirement
  tmt#4638    [2]  Add `virtualization.confidential` hardware requirement
  tmt#4639    [1]  Use `uv` in `make docs` to be aligned with RTD builds
  tmt#4642    [3]  Save all warnings encountered in a warnings file
  tmt#4644    [5]  Create a Verify Install plugin which checks if packages are installed from the correct repo
  tmt#4650    [1]  Add a glossary section
  tmt#4657    [2]  Catastrophic regex backtracking in shell framework _extract_failures on long lines
  tmt#4658    [2]  Fix catastrophic regex backtracking in shell framework
  tmt#4660    [5]  Add a new feature plugin to verify package installation
  tmt#4662    [2]  Use dedicated temporary directory for all rsync pulls
  tmt#4663    [2]  Document `user tree`, `work tree` and `test tree` in the Glossary
  tmt#4667    [2]  Prepare and finish step will now fail when phase fails
  tmt#4672    [2]  Implement the `sprint-overview` script
  tmt#4674    [1]  Revert #4396
  tmt#4676    [1]  Expose typing.override
  tmt#4681    [3]  Refactor github workflow
  tmt#4682    [1]  Fix issues with `check-wheel-contents`
  tmt#4692    [2]  `copr.repository` provider should enumerate packages into artifacts.yaml
  upgrade#15  [1]  Run upgrade via `dnf5 offline reboot`
  upgrade#18  [1]  Use a different package for dependency test
  upgrade#20  [1]  Use `dnf config-manager setopt` to disable repositories
  tmt#4695    [2]  `copr.repository` provider creates a `Repository` object
  tmt#4699    [1]  Fix `TestJiraLink` unit tests failing with HTTP 503
  tmt#4704    [2]  Document tree handling and workdirs
  tmt#4705    [2]  Control which runner devices can be exposed to guests
  tmt#4706    [1]  Drop copr epel6 enablement
  tmt#4717    [3]  Fix flaky test, add retry to testcloud
  tmt#4720    [1]  Add missing `main.fmf` for copr-repository artifact provider test
  tmt#4724    [1]  Fix for `pint` fixing dimensionless units
  tmt#4725    [1]  Use a different package for upgrade dependency test
  tmt#4727    [2]  Add additional conversion methods to step & guest dataclasses
  tmt#4733    [1]  Fix a few other `pint` tests due to 0.25.3 update
  tmt#4745    [1]  Specify a different User-Agent for pages behind Cloudfront

  Pending (10) - 33 points
--------------------------------------------------------------------------------
  tmt#4280    [5]  Add Polarion story export with test case linking and custom fields - features inside polarion
  tmt#4437    [2]  Mock provision: make detection of finished processes more deterministic
  tmt#4531    [5]  Implement full loading of the recipe
  tmt#4606    [3]  Improve test coverage for `prepare` plugins in image mode
  tmt#4645    [3]  All providers should list the artifacts in `artifacts.yaml`
  tmt#4646    [5]  Link the verify install plugin to the artifact plugin
  tmt#4661    [3]  Add support for full recipe loading
  tmt#4703    [2]  List packages from repository providers in `artifacts.yaml`
  tmt#4719    [-]  Improve test coverage for `prepare` plugins in image mode
  tmt#4726    [5]  Auto-verify artifact packages against require/recommend

  Added (18) - 28 points
--------------------------------------------------------------------------------
  upgrade#15  [1]  Run upgrade via `dnf5 offline reboot`
  upgrade#18  [1]  Use a different package for dependency test
  upgrade#20  [1]  Use `dnf config-manager setopt` to disable repositories
  tmt#4695    [2]  `copr.repository` provider creates a `Repository` object
  tmt#4699    [1]  Fix `TestJiraLink` unit tests failing with HTTP 503
  tmt#4703    [2]  List packages from repository providers in `artifacts.yaml`
  tmt#4704    [2]  Document tree handling and workdirs
  tmt#4705    [2]  Control which runner devices can be exposed to guests
  tmt#4706    [1]  Drop copr epel6 enablement
  tmt#4717    [3]  Fix flaky test, add retry to testcloud
  tmt#4719    [-]  Improve test coverage for `prepare` plugins in image mode
  tmt#4720    [1]  Add missing `main.fmf` for copr-repository artifact provider test
  tmt#4724    [1]  Fix for `pint` fixing dimensionless units
  tmt#4725    [1]  Use a different package for upgrade dependency test
  tmt#4726    [5]  Auto-verify artifact packages against require/recommend
  tmt#4727    [2]  Add additional conversion methods to step & guest dataclasses
  tmt#4733    [1]  Fix a few other `pint` tests due to 0.25.3 update
  tmt#4745    [1]  Specify a different User-Agent for pages behind Cloudfront

  Removed (1) - 1 points
--------------------------------------------------------------------------------
  tmt#4634    [1]  Revert #4630

  Completed original items (28) - 65 points
--------------------------------------------------------------------------------
  tmt#3945    [1]  tmt is getting stuck by waiting for sudo bootc status on non-bootc host system
  tmt#4333    [2]  Add KVM device access support to Podman
  tmt#4457    [2]  Drop step-specific "base Click command" implementations
  tmt#4557    [5]  Review flaky tests and make them reliable
  tmt#4599    [2]  Fix the xref formatting of `:tmt:story:` role to normal text
  tmt#4604    [5]  Duplicated issues, Jira Cloud integration, sprint overview
  tmt#4609    [2]  tmt gets stuck for a while on bootc?
  tmt#4618    [5]  Save warning messages to be picked up by testing-farm
  tmt#4631    [1]  Check for the presence of sudo before querying is_image_mode
  tmt#4635    [1]  Instruct `rpminspect` to ignore xml jinja templates
  tmt#4637    [2]  Add virtualization.confidential hardware requirement
  tmt#4638    [2]  Add `virtualization.confidential` hardware requirement
  tmt#4639    [1]  Use `uv` in `make docs` to be aligned with RTD builds
  tmt#4642    [3]  Save all warnings encountered in a warnings file
  tmt#4644    [5]  Create a Verify Install plugin which checks if packages are installed from the correct repo
  tmt#4650    [1]  Add a glossary section
  tmt#4657    [2]  Catastrophic regex backtracking in shell framework _extract_failures on long lines
  tmt#4658    [2]  Fix catastrophic regex backtracking in shell framework
  tmt#4660    [5]  Add a new feature plugin to verify package installation
  tmt#4662    [2]  Use dedicated temporary directory for all rsync pulls
  tmt#4663    [2]  Document `user tree`, `work tree` and `test tree` in the Glossary
  tmt#4667    [2]  Prepare and finish step will now fail when phase fails
  tmt#4672    [2]  Implement the `sprint-overview` script
  tmt#4674    [1]  Revert #4396
  tmt#4676    [1]  Expose typing.override
  tmt#4681    [3]  Refactor github workflow
  tmt#4682    [1]  Fix issues with `check-wheel-contents`
  tmt#4692    [2]  `copr.repository` provider should enumerate packages into artifacts.yaml

  Incomplete original items (7) - 26 points
--------------------------------------------------------------------------------
  tmt#4280    [5]  Add Polarion story export with test case linking and custom fields - features inside polarion
  tmt#4437    [2]  Mock provision: make detection of finished processes more deterministic
  tmt#4531    [5]  Implement full loading of the recipe
  tmt#4606    [3]  Improve test coverage for `prepare` plugins in image mode
  tmt#4645    [3]  All providers should list the artifacts in `artifacts.yaml`
  tmt#4646    [5]  Link the verify install plugin to the artifact plugin
  tmt#4661    [3]  Add support for full recipe loading

  Completed added items (15) - 21 points
--------------------------------------------------------------------------------
  upgrade#15  [1]  Run upgrade via `dnf5 offline reboot`
  upgrade#18  [1]  Use a different package for dependency test
  upgrade#20  [1]  Use `dnf config-manager setopt` to disable repositories
  tmt#4695    [2]  `copr.repository` provider creates a `Repository` object
  tmt#4699    [1]  Fix `TestJiraLink` unit tests failing with HTTP 503
  tmt#4704    [2]  Document tree handling and workdirs
  tmt#4705    [2]  Control which runner devices can be exposed to guests
  tmt#4706    [1]  Drop copr epel6 enablement
  tmt#4717    [3]  Fix flaky test, add retry to testcloud
  tmt#4720    [1]  Add missing `main.fmf` for copr-repository artifact provider test
  tmt#4724    [1]  Fix for `pint` fixing dimensionless units
  tmt#4725    [1]  Use a different package for upgrade dependency test
  tmt#4727    [2]  Add additional conversion methods to step & guest dataclasses
  tmt#4733    [1]  Fix a few other `pint` tests due to 0.25.3 update
  tmt#4745    [1]  Specify a different User-Agent for pages behind Cloudfront

  Incompleted added items (3) - 7 points
--------------------------------------------------------------------------------
  tmt#4703    [2]  List packages from repository providers in `artifacts.yaml`
  tmt#4719    [-]  Improve test coverage for `prepare` plugins in image mode
  tmt#4726    [5]  Auto-verify artifact packages against require/recommend

[gemini-code-assist]

Code Review

This pull request adds a comparison mode to the sprint overview script. The implementation is mostly solid, but I've found a few issues related to correctness and clarity. There are potential TypeError and ZeroDivisionError exceptions that need to be handled. I've also suggested a refactoring of the comparison logic to make the output report clearer and more intuitive.

[psss]

Nice! Just two suggestions.

[psss]

Suggested change

	items = YAML().load(f)
	items = [Item(**item) for item in YAML().load(f)]

We need to unpack these too, right? Otherwise I get:

  File "/home/psss/git/tmt/./scripts/sprint-overview", line 289, in display_comparison
    current_map = {item.id: item for item in current}
                   ^^^^^^^
AttributeError: 'CommentedMap' object has no attribute 'id'

[psss]

Perhaps add a metavar with PATH? The default TEXT is a bit confusing:

  --base TEXT     Instead of reporting, compare the current sprint against
                  this saved state.
  --current TEXT  If set, compare --base against --current instead of the live
                  sprint state.

Similar below.