CR: Unit tests for tests/module_utils/sender_file.py (DCNE-689)

[allenrobel]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Tracking code review comment to add unit tests for tests/module_utils/sender_file.py

New or Affected Module(s):

• infrastructure related. No new modules.

ND version and ND Platform

• V 4.2

Collection versions

• Future work

References

• Add RestSend framework, enums, and shared unit test infrastructure #185 (comment)

[allenrobel]

Deferring until nd42_rest_send is merged into shared integration branch nd42_integration with nd42_smart_endpoints and nd42_logging

[allenrobel]

Test Plan for tests/unit/module_utils/sender_file.py

Here's a breakdown of the unit test coverage needed for the Sender class:

Initialization

• Verify all instance variables default to None and logger is set up.

commit()

• Normal path: calls commit() without error (just logs, no side effects to assert beyond no exception).
• Simulated exception: set raise_method="commit" + raise_exception=ValueError("boom"), assert it raises ValueError.
• Non-matching method: raise_method set to something other than "commit" — should not raise even if raise_exception is set.

Property getters that raise on None

• gen, path, verb all raise ValueError if accessed before being set. One test each.

gen setter validation

The interesting one — it duck-types via value.implements:

• Rejects objects without an implements attribute (TypeError).
• Rejects objects where implements != "response_generator" (TypeError).
• Accepts a valid ResponseGenerator instance.

raise_exception validation

Both getter and setter validate issubclass(type(value), BaseException):

• Accepts ValueError("test"), None.
• Rejects non-exception types like "not an exception".

response property

Returns copy.deepcopy(self.gen.next):

• Returns the next response from the generator.
• The returned value is a deep copy (mutating it doesn't affect subsequent calls).

payload

No validation, accepts dict or None. Straightforward get/set.

path, verb

Setters accept anything (no validation), getters raise on None.

Note

Sender is itself a test utility, so the value of unit-testing it is more about documenting its contract for teammates than catching regressions. Tests should be lightweight — mostly verifying error-path behaviors so someone extending Sender knows what to expect. Trivial pass-through setters like path.setter and raise_method.setter can be skipped.