nicegui/tests/test_input.py

import asyncio
from typing import Literal, Optional

import pytest
from selenium.webdriver.common.by import By
from selenium.webdriver.common.keys import Keys

from nicegui import ui
from nicegui.testing import Screen


def test_input(screen: Screen):
    ui.input('Your name', value='John Doe')

    screen.open('/')
    screen.should_contain('Your name')
    element = screen.selenium.find_element(By.XPATH, '//*[@aria-label="Your name"]')
    assert element.get_attribute('type') == 'text'
    assert element.get_attribute('value') == 'John Doe'

    element.send_keys(' Jr.')
    assert element.get_attribute('value') == 'John Doe Jr.'


def test_password(screen: Screen):
    ui.input('Your password', value='123456', password=True)

    screen.open('/')
    screen.should_contain('Your password')

    element = screen.selenium.find_element(By.XPATH, '//*[@aria-label="Your password"]')
    assert element.get_attribute('type') == 'password'
    assert element.get_attribute('value') == '123456'

    element.send_keys('789')
    screen.wait(0.5)
    assert element.get_attribute('value') == '123456789'


def test_toggle_button(screen: Screen):
    ui.input('Your password', value='123456', password=True, password_toggle_button=True)

    screen.open('/')
    screen.should_contain('Your password')
    screen.should_contain('visibility_off')

    element = screen.selenium.find_element(By.XPATH, '//*[@aria-label="Your password"]')
    assert element.get_attribute('type') == 'password'
    assert element.get_attribute('value') == '123456'

    screen.click('visibility_off')
    screen.wait(0.5)
    assert element.get_attribute('type') == 'text'

    screen.click('visibility')
    screen.wait(0.5)
    assert element.get_attribute('type') == 'password'


@pytest.mark.parametrize('method', ['dict', 'sync', 'async'])
def test_input_validation(method: Literal['dict', 'sync', 'async'], screen: Screen):
    if method == 'sync':
        input_ = ui.input('Name', validation=lambda x: 'Short' if len(x) < 3 else 'Still short' if len(x) < 5 else None)
    elif method == 'dict':
        input_ = ui.input('Name', validation={'Short': lambda x: len(x) >= 3, 'Still short': lambda x: len(x) >= 5})
    else:
        async def validate(x: str) -> Optional[str]:
            await asyncio.sleep(0.1)
            return 'Short' if len(x) < 3 else 'Still short' if len(x) < 5 else None
        input_ = ui.input('Name', validation=validate)

    def assert_validation(expected: bool):
        if method == 'async':
            with pytest.raises(NotImplementedError):
                input_.validate()
            assert input_.validate(return_result=False)
        else:
            assert input_.validate() == expected

    screen.open('/')
    screen.should_contain('Name')

    element = screen.selenium.find_element(By.XPATH, '//*[@aria-label="Name"]')
    element.send_keys('Jo')
    screen.should_contain('Short')
    assert input_.error == 'Short'
    assert_validation(False)

    element.send_keys('hn')
    screen.should_contain('Still short')
    assert input_.error == 'Still short'
    assert_validation(False)

    element.send_keys(' Doe')
    screen.wait(1.0)
    screen.should_not_contain('Short')
    screen.should_not_contain('Still short')
    assert input_.error is None
    assert_validation(True)


def test_input_with_multi_word_error_message(screen: Screen):
    input_ = ui.input(label='some input')
    ui.button('set error', on_click=lambda: input_.props('error error-message="Some multi word error message"'))

    screen.open('/')
    screen.should_not_contain('Some multi word error message')

    screen.click('set error')
    screen.should_contain('Some multi word error message')


def test_autocompletion(screen: Screen):
    input_ = ui.input('Input', autocomplete=['foo', 'bar', 'baz'])

    screen.open('/')
    element = screen.selenium.find_element(By.XPATH, '//*[@aria-label="Input"]')
    element.send_keys('f')
    screen.should_contain('oo')

    element.send_keys('l')
    screen.wait(0.5)
    screen.should_not_contain('oo')

    element.send_keys(Keys.BACKSPACE)
    screen.should_contain('oo')

    element.send_keys(Keys.TAB)
    screen.wait(0.2)
    assert element.get_attribute('value') == 'foo'
    assert input_.value == 'foo'

    element.send_keys(Keys.BACKSPACE)
    element.send_keys(Keys.BACKSPACE)
    element.send_keys('x')
    element.send_keys(Keys.TAB)
    screen.wait(0.5)
    assert element.get_attribute('value') == 'fx'
    assert input_.value == 'fx'

    input_.set_autocomplete(['once', 'twice'])
    screen.wait(0.2)
    element.send_keys(Keys.BACKSPACE)
    element.send_keys(Keys.BACKSPACE)
    element.send_keys('o')
    screen.should_contain('nce')


def test_clearable_input(screen: Screen):
    input_ = ui.input(value='foo').props('clearable')
    ui.label().bind_text_from(input_, 'value', lambda value: f'value: {value}')

    screen.open('/')
    screen.should_contain('value: foo')
    screen.click('cancel')
    screen.should_contain('value: None')


def test_update_input(screen: Screen):
    input_ = ui.input('Name', value='Pete')

    screen.open('/')
    element = screen.selenium.find_element(By.XPATH, '//*[@aria-label="Name"]')
    assert element.get_attribute('value') == 'Pete'

    element.send_keys('r')
    screen.wait(0.5)
    assert element.get_attribute('value') == 'Peter'

    input_.value = 'Pete'
    screen.wait(0.5)
    assert element.get_attribute('value') == 'Pete'


def test_switching_focus(screen: Screen):
    input1 = ui.input()
    input2 = ui.input()
    ui.button('focus 1', on_click=lambda: input1.run_method('focus'))
    ui.button('focus 2', on_click=lambda: input2.run_method('focus'))

    screen.open('/')
    elements = screen.selenium.find_elements(By.XPATH, '//input')
    assert len(elements) == 2
    screen.click('focus 1')
    screen.wait(0.3)
    assert elements[0] == screen.selenium.switch_to.active_element
    screen.click('focus 2')
    screen.wait(0.3)
    assert elements[1] == screen.selenium.switch_to.active_element