Skip to content

single_select

SingleSelect(browser, container, searchable=True, allow_new_values=False)

Bases: BaseControl

Entity-Component: Select, ComboBox

A dropdown which can select only one value

Parameters:

Name Type Description Default
browser

The selenium webdriver

 required
container

The locator of the container where the control is located in.

 required
searchable

Boolean indicating if the dropdown provides filter or not.

 True
allow_new_values

Boolean indicating if the dropdown allows for user-entered custom values excluding a predefined list.

 False
Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def __init__(self, browser, container, searchable=True, allow_new_values=False):
    """
    :param browser: The selenium webdriver
    :param container: The locator of the container where the control is located in.
    :param searchable: Boolean indicating if the dropdown provides filter or not.
    :param allow_new_values: Boolean indicating if the dropdown allows for user-entered custom values
     excluding a predefined list.
    """
    super().__init__(browser, container)
    self.searchable = searchable
    # Component is ComboBox in case of True
    self.allow_new_values = allow_new_values
    self.container = container

    if not self.searchable and self.allow_new_values:
        raise ValueError(
            "Invalid combination of values for searchable and allow_new_values flags"
        )

    self.element_selector = container.select + (
        ' [data-test="combo-box"]' if allow_new_values else ' [data-test="select"]'
    )

    self.elements.update(
        {
            "root": Selector(select=self.element_selector),
            "selected": Selector(
                select=container.select + ' [data-test="textbox"]'
            ),
            "cancel_selected": Selector(
                select=container.select + ' [data-test="clear"]'
            ),
        }
    )

allow_new_values()

Returns True if the SingleSelect accepts new values, False otherwise

Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
336
337
338
339
340
341
def allow_new_values(self) -> bool:
    """
    Returns True if the SingleSelect accepts new values, False otherwise
    """
    self.get_element("root")
    return True if self.allow_new_values else False

cancel_selected_value()

Cancels the currently selected value in the SingleSelect :return: Bool whether canceling the selected item was successful, else raises an error

Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
205
206
207
208
209
210
211
212
213
214
def cancel_selected_value(self):
    """
    Cancels the currently selected value in the SingleSelect
        :return: Bool whether canceling the selected item was successful, else raises an error
    """
    self.wait_to_be_clickable("root")
    self.root.click()
    self.wait_to_be_clickable("cancel_selected")
    self.cancel_selected.click()
    return True

get_list_count()

Gets the total count of the SingleSelect list :return: Int the count of the options within the Single Select

Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
307
308
309
310
311
312
def get_list_count(self):
    """
    Gets the total count of the SingleSelect list
        :return: Int the count of the options within the Single Select
    """
    return len(list(self.list_of_values()))

get_single_value()

Returns:

Type Description

one value from Single Select
Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
def get_single_value(self):
    """
    :return: one value from Single Select
    """
    selected_val = self.get_value()

    self.wait_to_be_clickable("root")
    self.root.click()
    popover_id = "#" + self.root.get_attribute("data-test-popover-id")
    if self.allow_new_values:
        if self.searchable:
            self.elements.update(
                {
                    "input": Selector(
                        select=self.container.select + ' [data-test="textbox"]'
                    )
                }
            )
        self.elements.update(
            {
                "values": Selector(
                    select=popover_id
                    + ' [data-test="option"]:not([data-test-selected="true"]) [data-test="label"]'
                )
            }
        )
    else:
        if self.searchable:
            self.elements.update(
                {"input": Selector(select=popover_id + ' [data-test="textbox"]')}
            )
        self.elements.update(
            {"values": Selector(select=popover_id + ' [data-test="option"]')}
        )

    single_element = self.get_element("values")

    if selected_val and not self.allow_new_values:
        # as the dropdown is already open, we don't try to open it
        self.select(selected_val, open_dropdown=False)
    elif self.searchable:
        self.input.send_keys(Keys.ESCAPE)
    else:
        self.select(single_element.text.strip(), open_dropdown=False)
    self.wait_for("root")
    return single_element

get_value()

Gets the selected value :return: The selected value’s text, or returns false if unsuccessful

Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
def get_value(self):
    """
    Gets the selected value
        :return: The selected value's text, or returns false if unsuccessful
    """
    if self.allow_new_values:
        # ComboBox do not support label
        return self.selected.get_attribute("value")
    else:
        if self.root.get_attribute(
            "data-test-loading"
        ) == "false" and self.root.get_attribute("data-test-value"):
            return self.root.get_attribute("label")
        else:
            return False

is_editable()

Returns True if the SingleSelect is editable, False otherwise

Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
def is_editable(self) -> bool:
    """
    Returns True if the SingleSelect is editable, False otherwise
    """
    if self.allow_new_values:
        return (
            not self.selected.get_attribute("readonly")
            and not self.selected.get_attribute("readOnly")
            and not self.selected.get_attribute("disabled")
        )
    else:
        return (
            not self.root.get_attribute("readonly")
            and not self.root.get_attribute("readOnly")
            and not self.root.get_attribute("disabled")
        )

list_of_values()

Gets the list of value from the Single Select :return: list of options avaialble within the single select

Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
def list_of_values(self):
    """
    Gets the list of value from the Single Select
        :return: list of options avaialble within the single select
    """
    selected_val = self.get_value()
    self.wait_to_be_clickable("root")
    self.root.click()
    first_element = None
    list_of_values = []

    popover_id = "#" + self.root.get_attribute("data-test-popover-id")
    if self.allow_new_values:
        if self.searchable:
            self.elements.update(
                {
                    "input": Selector(
                        select=self.container.select + ' [data-test="textbox"]'
                    )
                }
            )
    else:
        if self.searchable:
            self.elements.update(
                {"input": Selector(select=popover_id + ' [data-test="textbox"]')}
            )
    self.elements.update(
        {"values": Selector(select=popover_id + ' [data-test="option"]')}
    )

    for each in self.get_elements("values"):
        if not first_element:
            first_element = each
        list_of_values.append(each.text.strip())
    if selected_val and not self.allow_new_values:
        # as the dropdown is already open we dont try to open it
        self.select(selected_val, open_dropdown=False)
    elif self.searchable:
        self.input.send_keys(Keys.ESCAPE)
    elif first_element:
        self.select(first_element.text.strip(), open_dropdown=False)
    self.wait_for("root")
    return list_of_values

search(value, open_dropdown=True)

search with the singleselect input :param value: string value to search :assert Asserts whether the single select is searchable

Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
def search(self, value, open_dropdown=True):
    """
    search with the singleselect input
        :param value: string value to search
        :assert Asserts whether the single select is searchable
    """
    assert self.searchable, "Can not search, as the Singleselect is not searchable"
    if open_dropdown:
        self.wait_to_be_clickable("root")
        self.root.click()
    if self.searchable:
        if self.allow_new_values:
            self.elements.update(
                {
                    "input": Selector(
                        select=self.element_selector + ' [data-test="textbox"]'
                    )
                }
            )
        else:
            popover_id = "#" + self.root.get_attribute("data-test-popover-id")
            self.elements.update(
                {"input": Selector(select=popover_id + ' [data-test="textbox"]')}
            )

    self.input.send_keys(value)

search_get_list(value)

search with the singleselect input and return the list :param value: string value to search :return: a list of values

Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
def search_get_list(self, value):
    """
    search with the singleselect input and return the list
        :param value: string value to search
        :return: a list of values
    """

    if self.searchable:
        if self.allow_new_values:
            self.elements.update(
                {
                    "input": Selector(
                        select=self.element_selector + ' [data-test="textbox"]'
                    )
                }
            )
        else:
            self.wait_to_be_clickable("root")
            self.root.click()
            popover_id = "#" + self.root.get_attribute("data-test-popover-id")
            self.elements.update(
                {"input": Selector(select=popover_id + ' [data-test="textbox"]')}
            )
    # as the dropdown is already open we dont try to open it
    self.search(value, open_dropdown=False)
    if self.allow_new_values:
        searched_values = list(self._list_visible_values())
    else:
        self.wait_for_search_list()
        searched_values = list(self._list_visible_values(open_dropdown=False))
        self.input.send_keys(Keys.ESCAPE)
        self.wait_for("root")

    return searched_values

select(value, open_dropdown=True)

Selects the value within the select dropdown :param value: the value to select :param open_dropdown: Whether the dropdown should be opened :return: Bool if successful in selection, else raises an error

Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def select(self, value, open_dropdown=True):
    """
    Selects the value within the select dropdown
        :param value: the value to select
        :param open_dropdown: Whether the dropdown should be opened
        :return: Bool if successful in selection, else raises an error
    """
    if open_dropdown:
        self.wait_to_be_clickable("root")
        self.root.click()

    if self.allow_new_values and self.get_value():
        self.wait_to_be_clickable("cancel_selected")
        self.cancel_selected.click()

    popover_id = "#" + self.root.get_attribute("data-test-popover-id")

    self.elements.update(
        {
            "values": Selector(select=popover_id + ' [data-test="option"]'),
            "dropdown": Selector(select=popover_id + ' [data-test="menu"]'),
            "combobox": Selector(select=popover_id + ' [data-test="menu"]'),
        }
    )

    for each in self.get_elements("values"):
        if each.text.strip().lower() == value.lower():
            each.click()
            return True
    else:
        raise ValueError("{} not found in select list".format(value))

wait_for_search_list()

Wait for SingleSelect search to populate

Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
324
325
326
327
328
329
330
331
332
333
334
def wait_for_search_list(self):
    """
    Wait for SingleSelect search to populate
    """

    def _wait_for_search_list(driver):
        return len(list(self._list_visible_values(open_dropdown=False))) > 0

    self.wait_for(
        _wait_for_search_list, msg="No values found in SingleSelect search"
    )

wait_for_values()

Wait for dynamic values to load in SingleSelect

Source code in pytest_splunk_addon_ui_smartx/components/controls/single_select.py 
314
315
316
317
318
319
320
321
322
def wait_for_values(self):
    """
    Wait for dynamic values to load in SingleSelect
    """

    def _wait_for_values(driver):
        return self.get_single_value()

    self.wait_for(_wait_for_values, msg="No values found in SingleSelect")