|
11 | 11 | # SPDX-License-Identifier: Apache-2.0 |
12 | 12 | # ******************************************************************************* |
13 | 13 |
|
| 14 | +from types import SimpleNamespace |
14 | 15 | from typing import Any, cast |
| 16 | +from unittest.mock import MagicMock |
15 | 17 |
|
16 | 18 | import pytest |
17 | 19 | import score_metrics.traceability_metrics as metrics |
18 | 20 | from score_metamodel import ScoreNeedType |
19 | 21 | from score_metamodel.tests import need as test_need |
20 | 22 | from score_pytest.attribute_plugin import add_test_properties |
21 | | -from sphinx_needs.data import NeedsView |
22 | | -from sphinx_needs.need_item import NeedItem |
| 23 | +from sphinx.environment import BuildEnvironment |
| 24 | +from sphinx_needs.data import NeedsView, SphinxNeedsData |
| 25 | +from sphinx_needs.need_item import NeedItem, NeedItemSourceExternal |
23 | 26 |
|
24 | 27 |
|
25 | 28 | @add_test_properties( |
@@ -266,3 +269,91 @@ def test_calculate_test_metrics_counts_linked_tests_and_broken_refs() -> None: |
266 | 269 | assert result["broken_references"] == [ |
267 | 270 | {"testcase": "TC_2", "missing_need": "REQ_404"} |
268 | 271 | ] |
| 272 | + |
| 273 | + |
| 274 | +@add_test_properties( |
| 275 | + partially_verifies=["tool_req__docs_test_linkage_metrics"], |
| 276 | + test_type="requirements-based", |
| 277 | + derivation_technique="equivalence-classes", |
| 278 | +) |
| 279 | +@pytest.mark.parametrize( |
| 280 | + ("include_external", "feature_ids", "feature_total", "component_total"), |
| 281 | + [ |
| 282 | + (False, None, 1, 1), |
| 283 | + (True, None, 6, 2), |
| 284 | + (True, [], 6, 2), |
| 285 | + (False, ["feat__lifecycle"], 1, 1), |
| 286 | + (True, ["feat__lifecycle"], 4, 1), |
| 287 | + (True, ["feat__lifecycle", "feat__other"], 5, 1), |
| 288 | + (True, ["feat__missing"], 1, 1), |
| 289 | + ], |
| 290 | +) |
| 291 | +def test_calculate_full_need_metrics_optional_external_feature_scope( |
| 292 | + monkeypatch: pytest.MonkeyPatch, |
| 293 | + include_external: bool, |
| 294 | + feature_ids: list[str] | None, |
| 295 | + feature_total: int, |
| 296 | + component_total: int, |
| 297 | +) -> None: |
| 298 | + """Scope external requirements by feature without hiding untested requirements.""" |
| 299 | + external_requirements = [ |
| 300 | + test_need( |
| 301 | + id="feat_req__linked", |
| 302 | + type="feat_req", |
| 303 | + satisfied_by=["feat__lifecycle"], |
| 304 | + testlink="TC_1", |
| 305 | + ), |
| 306 | + test_need( |
| 307 | + id="feat_req__untested", |
| 308 | + type="feat_req", |
| 309 | + satisfied_by=["feat__lifecycle"], |
| 310 | + ), |
| 311 | + test_need( |
| 312 | + id="feat_req__unrelated", |
| 313 | + type="feat_req", |
| 314 | + satisfied_by=["feat__other"], |
| 315 | + ), |
| 316 | + test_need( |
| 317 | + id="feat_req__shared", |
| 318 | + type="feat_req", |
| 319 | + satisfied_by=["feat__lifecycle", "feat__other"], |
| 320 | + ), |
| 321 | + test_need(id="feat_req__unassigned", type="feat_req"), |
| 322 | + test_need(id="comp_req__external", type="comp_req"), |
| 323 | + ] |
| 324 | + for need in external_requirements: |
| 325 | + monkeypatch.setattr( |
| 326 | + need, |
| 327 | + "_source", |
| 328 | + NeedItemSourceExternal(url=f"https://example.org/{need.id}"), |
| 329 | + ) |
| 330 | + needs = [ |
| 331 | + *external_requirements, |
| 332 | + test_need(id="feat_req__local", type="feat_req"), |
| 333 | + test_need(id="comp_req__local", type="comp_req"), |
| 334 | + test_need(id="TC_1", type="testcase", fully_verifies=["feat_req__linked"]), |
| 335 | + ] |
| 336 | + monkeypatch.setattr(metrics, "CALCULATED_METRICS", {}) |
| 337 | + app = MagicMock() |
| 338 | + app.env = MagicMock(spec=BuildEnvironment) |
| 339 | + needs_data = SphinxNeedsData(app.env) |
| 340 | + for need in needs: |
| 341 | + needs_data.add_need(need) |
| 342 | + needs_data.needs_is_post_processed = True |
| 343 | + app.config = SimpleNamespace( |
| 344 | + score_metamodel_yaml=None, |
| 345 | + score_metrics_requirement_types="feat_req,comp_req", |
| 346 | + ) |
| 347 | + if feature_ids is not None: |
| 348 | + app.config.score_metrics_external_feature_ids = feature_ids |
| 349 | + |
| 350 | + metrics.calculate_full_need_metrics(app, include_external) |
| 351 | + |
| 352 | + result = metrics.CALCULATED_METRICS |
| 353 | + assert result["metrics_by_type"]["feat_req"]["total"] == feature_total |
| 354 | + assert result["metrics_by_type"]["comp_req"]["total"] == component_total |
| 355 | + assert result["overall_metrics"]["total"] == feature_total + component_total |
| 356 | + expected_linked = int(include_external and feature_ids != ["feat__missing"]) |
| 357 | + assert result["metrics_by_type"]["feat_req"]["with_test_link"] == expected_linked |
| 358 | + assert result["tests"]["linked_to_requirements"] == 1 |
| 359 | + assert result["tests"]["broken_references"] == [] |
0 commit comments