[Chaffelson]

Summary

Uplifts nipyapi to NiFi/Registry 2.12.0 and adds generic helpers for parameter providers, context inheritance and controller-level services. Along the way, a few existing helpers are aligned with library conventions. This PR also carries the 1.8.0 release prep. Full details are in docs/history.rst (1.8.0, dated 2026-10-22) and docs/parameters.rst.

Version: 1.8.0 is a minor bump over 1.7.0. No public function is removed and no signature changes, but some existing functions change behaviour. They are listed under Behaviour Changes at the top of the 1.8.0 release notes, led by get_process_group, which is the highest-traffic of them.

Supported versions and generated clients

• Both clients are regenerated against the 2.12.0 OpenAPI specs. The surface change is additive: no API methods or models were removed or renamed.
• Template fixes:
  • ParameterGroupConfigurationEntity.parameter_sensitivities now validates map values rather than keys, and accepts an unset (None) sensitivity. Before this, provider fetch and apply responses could not be deserialized.
  • New Configuration.client_side_validation flag.

New helpers

• nipyapi.parameters:
  • Provider list and get, type lookup, property update, fetch, apply, and a combined fetch-and-apply.
  • Apply keeps the staged sensitivity and synchronized choices unless the caller overrides them. Unset choices default to sensitive and synchronized, matching NiFi.
  • Apply rejects unknown parameter names in sensitivities, and logs a warning when no selected group is synchronized.
• set_inherited_parameter_contexts (prepend or replace), get_process_group_parameter_context, and connect_parameter_provider_group.
  • connect_parameter_provider_group inherits a provider-created context and sets local sensitive aliases, in one atomic update.
  • If the source context is already inherited, it keeps its position unless a higher-precedence context shadows one of the mapped names.
  • It rejects non-sensitive source parameters, because NiFi would leave a sensitive alias to them unresolved.
• canvas.list_all_management_controllers and canvas.get_management_controller, which return controller-level services only.

Behaviour changes to existing functions (full list in the release notes)

• canvas.get_process_group returns None for a missing ID, instead of raising ValueError("Unable to locate group ..."). That is what its 404 handler intends, and matches get_processor and get_parameter_context. The nipyapi.ci commands already handled None; their error message is now Process group not found: <id>.
• update_parameter_context (and the rename, upsert and delete-parameter helpers that call it) and verify_controller/verify_processor now share utils.wait_for_request:
  • a request-level failure raises ValueError;
  • a completed request is deleted, including a failed one;
  • a timeout or interruption no longer issues a DELETE, which would cancel the server-side work.
• canvas.ensure_management_controller matches controller-level services only, and raises if several share the name.
• The canvas.get_controller docstring is corrected; its behaviour is unchanged.
• Version guards and branches for NiFi releases before 2.0 are removed. This also drops an extra /flow/about request on every parameter call.

Build tooling

• make dist, wheel, sdist and install no longer delete the test certificates or coverage reports.
• check-dist and test-dist reuse an existing build. They still build when dist/ is empty, which CI relies on.
• rebuild-all failed after its own clean-all, because wait-ready imports nipyapi once the clients are gone. It now removes the generated code just before regenerating it.

Test plan

• make rebuild-all completes:
  • certs, spec fetch and augmentation, client regeneration;
  • all three profiles: single-user 777 passed / 33 skipped, secure-ldap 784 / 26, secure-mtls 777 / 33;
  • dist build, twine check, the clean-venv import test, and docs.
• The regenerated clients and the structured docs are byte-identical to the committed ones.
• Behaviour is tested against the real NiFi 2.12.0 containers wherever the server can produce the condition. That includes the 409 for circular inheritance, the no-synchronized-group apply, stale-revision rejection, argument validation, and cleanup of completed requests (checked by a 404 afterwards).
• Fakes are limited to cases a live server can't easily produce, such as a completed request with failure_reason. Each one's docstring says why, and they follow NiFi's StandardAsynchronousWebRequest semantics.
• The built wheel was validated against a remote NiFi 2.x runtime with a cloud-secrets parameter provider: fetch, apply, connect, secret rotation and the CLI one-liner.
• make lint / pre-commit is clean.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.27%. Comparing base (9668cc1) to head (94cbb61).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #415      +/-   ##
==========================================
+ Coverage   77.24%   78.27%   +1.03%     
==========================================
  Files          41       41              
  Lines        4966     5115     +149     
==========================================
+ Hits         3836     4004     +168     
+ Misses       1130     1111      -19     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[ottobackwards]

If we change behavior of functions and or / return values we'll have to make sure the version bump is appropriate