Looks good to me! I think the smartdevice ctor change should also go into this PR, as that will allow writing some unittests to make sure it's all working as expected.

Now done. Also changed the default of username and password to None and removed the check in discovery for 255 as per comments on #477. Also had to tweak the cli handling of the json parameter because tests failed if they appeared after the test_json_output because echo remained a noop

Codecov Report

Patch coverage is 97.95% of modified lines.

📢 Thoughts on this report? Let us know!.

Looks good to me! I think the smartdevice ctor change should also go into this PR, as that will allow writing some unittests to make sure it's all working as expected.

Now done. Also changed the default of username and password to None and removed the check in discovery for 255 as per comments on #477. Also had to tweak the cli handling of the json parameter because tests failed if they appeared after the test_json_output because echo remained a noop

Hi @rytilahti, any thoughts on the latest here? It should have everything you wanted now.

Thanks for the ping, I've been busy and forgot to reply here earlier. Would you mind adding a parametrized test for the constructors of smartdevice classes to verify that the input parameters are stored as expected?

I think I have done this by passing in all the discovery fixtures and calling cli with the --type parameter.

I think I have done this by passing in all the discovery fixtures and calling cli with the --type parameter.

It's more important to test against the API as that's likely more consumed by external users than the cli tool. Tests for both are obviously better, but the API takes priority.

I think I have done this by passing in all the discovery fixtures and calling cli with the --type parameter.

It's more important to test against the API as that's likely more consumed by external users than the cli tool. Tests for both are obviously better, but the API takes priority.

Ok, so a test that creates an instance itself and then checks the credentials are there? With parameters of all the possible derived classes of SmartDevice?

Ok, so a test that creates an instance itself and then checks the credentials are there? With parameters of all the possible derived classes of SmartDevice?

Something like this should suffice, the idea is just to avoid breaking that API by chance:

@pytest.mark.parametrize("cls", [SmartDevice, SmartBulb, ...])
def test_device_class_ctors(cls): 
    host = "127.0.0.1"
    port = 1234
    credentials = ...
    dev = cls(host, port=port, credentials=credentials)
    assert dev.host = host
    assert dev.port = port
    assert dev.credentials = credentials

I'm not sure which file it should go to, though...

Ok, so a test that creates an instance itself and then checks the credentials are there? With parameters of all the possible derived classes of SmartDevice?

Something like this should suffice, the idea is just to avoid breaking that API by chance:

@pytest.mark.parametrize("cls", [SmartDevice, SmartBulb, ...])
def test_device_class_ctors(cls): 
    host = "127.0.0.1"
    port = 1234
    credentials = ...
    dev = cls(host, port=port, credentials=credentials)
    assert dev.host = host
    assert dev.port = port
    assert dev.credentials = credentials

I'm not sure which file it should go to, though...

Ok so added this test to test_smartdevice.py.

Do you mean override it for every test other than json? The issue here is that if any test runs after the json test then the global echo is still set to noop. It just happens I'm the first person to add a test after the json test. (I guess this could affect any other code calling the cli module directly but not sure if that's a use case)

Another way to do it without introducing another global could be to introduce a function that gets the echo function:

try:
    from rich import print as rich_print
except ImportError:
    pass

def _get_echo_function():
    def _strip_rich_formatting(echo_func):

        @wraps(echo_func)
        def wrapper(message=None, *args, **kwargs):
            if message is not None:
                message = re.sub(r"\[/?.+?]", "", message)
            echo_func(message, *args, **kwargs)

        return wrapper

    return rich_print if rich_print else _strip_rich_formatting(click.echo)

Then just:

    # If JSON output is requested, disable echo
    global echo
    if json:

        def _nop_echo(*args, **kwargs):
            pass

        echo = _nop_echo
    else:
        # Set back to default is required if running tests with CliRunner
        echo = _get_echo_function()

I don't currently have the energy nor the time to dig into that, so let's just add a comment, keep it as it is for now and let's get this merged (after fixing the test that does not really test the real output) :-)

I don't currently have the energy nor the time to dig into that, so let's just add a comment, keep it as it is for now and let's get this merged (after fixing the test that does not really test the real output) :-)

That's done. Re: the test that doesn't check the real output it does check that credentials when properly supplied are passed from the cli to the device so I think this should be good to go