-
Notifications
You must be signed in to change notification settings - Fork 169
feat: unit test for 'endpoint.py' #1290
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
0bf5343
unit test for 'endpoint.py'
mukundkumarjha 0f7f6ec
Created tests for endpoint.py to reach 90% test coverage
mukundkumarjha 3308abc
changes as per coderabbit
mukundkumarjha 88bc489
changes as per coderabbit
mukundkumarjha fb7d500
round serialization test added
mukundkumarjha a3e08cc
code updated as per pytest convention
mukundkumarjha File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| import pytest | ||
| from unittest.mock import MagicMock | ||
| from src.hiero_sdk_python.address_book.endpoint import Endpoint | ||
|
|
||
| pytestmark = pytest.mark.unit | ||
|
|
||
| def test_getter_setter(): | ||
|
|
||
| """Test for Endpoint constructor, getters, and setters with fluent interface.""" | ||
|
|
||
| endpoint = Endpoint(address=None, port=None, domain_name=None) | ||
| endpoint.set_port(77777) # Currently accepted but invalid | ||
|
|
||
| # Test boundary conditions | ||
| endpoint.set_port(1) # Minimum valid port | ||
| endpoint.set_port(65535) # Maximum valid port | ||
|
|
||
| # Test None values | ||
| endpoint.set_port(None) | ||
| endpoint.set_address(None) | ||
| endpoint.set_domain_name(None) | ||
|
|
||
| # Test fluent interface (method chaining) | ||
| result = endpoint.set_address(b'127.0.1.1') | ||
| assert result is endpoint, "set_address should return self for method chaining" | ||
|
|
||
| result = endpoint.set_port(77777) | ||
| assert result is endpoint, "set_port should return self for method chaining" | ||
|
|
||
| result = endpoint.set_domain_name("redpanda.com") | ||
| assert result is endpoint, "set_domain_name should return self for method chaining" | ||
|
|
||
| # Protect against breaking changes - verify attributes exist | ||
| assert hasattr(endpoint, 'get_address'), "Missing get_address method" | ||
| assert hasattr(endpoint, 'get_port'), "Missing get_port method" | ||
| assert hasattr(endpoint, 'get_domain_name'), "Missing get_domain_name method" | ||
|
|
||
| assert endpoint.get_address() == b'127.0.1.1' | ||
| assert endpoint.get_port() == 77777 | ||
| assert endpoint.get_domain_name() == "redpanda.com" | ||
exploreriii marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| def test_constructor_with_values(): | ||
| """Test Endpoint constructor with actual values.""" | ||
| endpoint = Endpoint(address=b'192.168.1.1', port=8080, domain_name="example.com") | ||
|
|
||
| assert endpoint.get_address() == b'192.168.1.1' | ||
| assert endpoint.get_port() == 8080 | ||
| assert endpoint.get_domain_name() == "example.com" | ||
coderabbitai[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| ("input_port", "expected_port"), | ||
| [ | ||
| (0, 50211), | ||
| (50111, 50211), | ||
| (80, 80), | ||
| ], | ||
| ) | ||
| def test_from_proto_port_mapping(input_port, expected_port): | ||
| """Tests port mapping logic when converting Protobuf ServiceEndpoint to Endpoint. | ||
| Port mapping rules: | ||
| - Port 0 or 50111 maps to 50211 (legacy/default behavior) | ||
| - Other ports pass through unchanged | ||
| """ | ||
|
|
||
| mock_proto = MagicMock() | ||
| mock_proto.port = input_port | ||
| mock_proto.ipAddressV4 = b"127.0.1.1" | ||
| mock_proto.domain_name = "redpanda.com" | ||
|
|
||
| endpoint = Endpoint._from_proto(mock_proto) | ||
|
|
||
| # Verify port mapping | ||
| assert endpoint.get_port() == expected_port | ||
|
|
||
| # Verify all fields are mapped correctly (not just port) | ||
| assert endpoint.get_address() == b"127.0.1.1", "Address must be mapped from proto" | ||
| assert endpoint.get_domain_name() == "redpanda.com", "Domain name must be mapped from proto" | ||
|
|
||
| # Protect against breaking changes - PRIORITY 1 | ||
| assert isinstance(endpoint, Endpoint), "Must return Endpoint instance" | ||
|
|
||
| def test_to_proto(): | ||
|
|
||
| """Verifies that an Endpoint instance can be correctly serialized back into | ||
| a Protobuf ServiceEndpoint object with all fields intact.""" | ||
|
|
||
| endpoint = Endpoint(address=b'127.0.1.1', port=77777, domain_name="redpanda.com") | ||
| proto = endpoint._to_proto() | ||
| assert proto.ipAddressV4 == b'127.0.1.1' | ||
| assert proto.port == 77777 | ||
| assert proto.domain_name == "redpanda.com" | ||
|
|
||
| def test_str(): | ||
|
|
||
| """Tests the human-readable string representation of the Endpoint.""" | ||
|
|
||
| endpoint = Endpoint(address=b'127.0.1.1', port=77777, domain_name="redpanda.com") | ||
| result = str(endpoint) | ||
|
|
||
| # Verify return type | ||
| assert isinstance(result, str), "String representation should return a string" | ||
| assert result == '127.0.1.1:77777' | ||
|
|
||
|
|
||
| def test_str_with_none_values(): | ||
| """Test string representation when address or port is None.""" | ||
| endpoint = Endpoint(address=None, port=None, domain_name="example.com") | ||
| with pytest.raises(AttributeError): | ||
| str(endpoint) | ||
|
|
||
| @pytest.mark.parametrize("invalid_data", [ | ||
| {"port": 77777, "domain_name": "test.com"}, | ||
| {"ip_address_v4": "127.0.0.1", "domain_name": "test.com"}, | ||
| {"ip_address_v4": "127.0.0.1", "port": 77777}, | ||
| ]) | ||
| def test_from_dict_missing_fields(invalid_data): | ||
| """Test that from_dict raises ValueError when required fields are missing.""" | ||
| with pytest.raises(ValueError, match="JSON data must contain"): | ||
| Endpoint.from_dict(invalid_data) | ||
|
|
||
| def test_from_dict_error(): | ||
|
|
||
| """Validates 'Guard Clause' error handling""" | ||
|
|
||
| invalid_data = {"port": 77777} | ||
| with pytest.raises(ValueError, match="JSON data must contain"): | ||
| Endpoint.from_dict(invalid_data) | ||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| def test_from_dict_success(): | ||
| """ Tests successful creation of an Endpoint from a dictionary (JSON format) """ | ||
| data = { | ||
| "ip_address_v4": "127.0.0.1", | ||
| "port": 77777, | ||
| "domain_name": "redpanda.com" | ||
| } | ||
| endpoint = Endpoint.from_dict(data) | ||
|
|
||
| assert endpoint.get_address() == b"127.0.0.1" | ||
| assert endpoint.get_port() == 77777 | ||
| assert endpoint.get_domain_name() == "redpanda.com" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.