nucypher/tests/integration/cli/test_ursula_cli_ip_detection.py

from nucypher.blockchain.eth.actors import Operator
from nucypher.blockchain.eth.trackers.dkg import ActiveRitualTracker
from nucypher.cli.commands import ursula
from nucypher.cli.main import nucypher_cli
from nucypher.config.characters import UrsulaConfiguration
from nucypher.config.constants import TEMPORARY_DOMAIN
from nucypher.utilities.networking import UnknownIPAddress
from tests.constants import (
    FAKE_PASSWORD_CONFIRMED,
    INSECURE_DEVELOPMENT_PASSWORD,
    MOCK_ETH_PROVIDER_URI,
    MOCK_IP_ADDRESS,
    TEST_POLYGON_PROVIDER_URI,
    YES_ENTER,
)


def test_ursula_startup_ip_checkup(click_runner, mocker, test_registry_source_manager):
    target = "nucypher.cli.actions.configure.determine_external_ip_address"

    # Patch the get_external_ip call
    mocker.patch(target, return_value=MOCK_IP_ADDRESS)
    mocker.patch.object(UrsulaConfiguration, "to_configuration_file", return_value=None)
    mocker.patch.object(
        ursula, "get_nucypher_password", return_value=INSECURE_DEVELOPMENT_PASSWORD
    )
    mocker.patch.object(
        ursula, "get_client_password", return_value=INSECURE_DEVELOPMENT_PASSWORD
    )

    args = (
        "ursula",
        "init",
        "--network",
        TEMPORARY_DOMAIN,
        "--eth-provider",
        MOCK_ETH_PROVIDER_URI,
        "--payment-provider",
        TEST_POLYGON_PROVIDER_URI,
        "--force",
    )
    user_input = YES_ENTER + "0\n0\n"
    result = click_runner.invoke(
        nucypher_cli, args, catch_exceptions=False, input=user_input
    )
    assert result.exit_code == 0, result.output
    assert MOCK_IP_ADDRESS in result.output

    args = (
        "ursula",
        "init",
        "--network",
        TEMPORARY_DOMAIN,
        "--force",
        "--eth-provider",
        MOCK_ETH_PROVIDER_URI,
        "--payment-provider",
        TEST_POLYGON_PROVIDER_URI,
    )
    result = click_runner.invoke(
        nucypher_cli, args, catch_exceptions=False, input=FAKE_PASSWORD_CONFIRMED
    )
    assert result.exit_code == 0, result.output

    # Patch get_external_ip call to error output
    mocker.patch(target, side_effect=UnknownIPAddress)
    args = (
        "ursula",
        "init",
        "--network",
        TEMPORARY_DOMAIN,
        "--force",
        "--eth-provider",
        MOCK_ETH_PROVIDER_URI,
        "--payment-provider",
        TEST_POLYGON_PROVIDER_URI,
    )
    result = click_runner.invoke(
        nucypher_cli, args, catch_exceptions=True, input=FAKE_PASSWORD_CONFIRMED
    )
    assert result.exit_code == 1, result.output
    assert isinstance(result.exception, UnknownIPAddress)


def test_ursula_run_ip_checkup(
    testerchain,
    custom_filepath,
    click_runner,
    mocker,
    ursulas,
    monkeypatch,
    ursula_test_config,
    tempfile_path,
):

    # Mock DKG
    mocker.patch.object(ActiveRitualTracker, 'start', autospec=True)

    # Mock IP determination
    target = 'nucypher.cli.actions.configure.determine_external_ip_address'
    mocker.patch(target, return_value=MOCK_IP_ADDRESS)

    # Mock Teacher Resolution
    from nucypher.characters.lawful import Ursula

    teacher = ursulas[0]
    mocker.patch.object(Ursula, 'from_teacher_uri', return_value=teacher)

    # Mock worker qualification
    staking_provider = ursulas[1]

    def set_staking_provider_address(operator, *args, **kwargs):
        operator.checksum_address = staking_provider.checksum_address
        return True

    monkeypatch.setattr(Operator, "block_until_ready", set_staking_provider_address)

    ursula_test_config.rest_host = MOCK_IP_ADDRESS
    mocker.patch.object(
        UrsulaConfiguration, "from_configuration_file", return_value=ursula_test_config
    )

    # Setup
    teacher = ursulas[2]

    # manual teacher
    run_args = (
        "ursula",
        "run",
        "--dry-run",
        "--debug",
        "--config-file",
        str(tempfile_path.absolute()),
        "--teacher",
        teacher.rest_url(),
    )
    result = click_runner.invoke(
        nucypher_cli, run_args, catch_exceptions=False, input=FAKE_PASSWORD_CONFIRMED
    )
    assert result.exit_code == 0, result.output

    # default teacher
    run_args = (
        "ursula",
        "run",
        "--dry-run",
        "--debug",
        "--config-file",
        str(tempfile_path.absolute()),
    )
    result = click_runner.invoke(
        nucypher_cli, run_args, catch_exceptions=False, input=FAKE_PASSWORD_CONFIRMED
    )
    assert result.exit_code == 0, result.output

    ursulas.clear()