Skip to content

Commit c9486e6

Browse files
adomuradadomurad
committed
find elements in elements
1 parent 449bf31 commit c9486e6

File tree

7 files changed

+342
-2
lines changed

7 files changed

+342
-2
lines changed

‎host/roc/app.go

+20
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,26 @@ func roc_fx_browserFindElements(sessionId, using, value *RocStr) C.struct_Result
320320
return createRocResult_ListStr_Str(RocOk, elementIds, "")
321321
}
322322

323+
//export roc_fx_elementFindElement
324+
func roc_fx_elementFindElement(sessionId, parentElementId, using, value *RocStr) C.struct_ResultVoidStr {
325+
elementId, err := webdriver.FindElementInElement(sessionId.String(), parentElementId.String(), using.String(), value.String())
326+
if err != nil {
327+
return createRocResultStr(RocErr, err.Error())
328+
}
329+
330+
return createRocResultStr(RocOk, elementId)
331+
}
332+
333+
//export roc_fx_elementFindElements
334+
func roc_fx_elementFindElements(sessionId, parentElementId, using, value *RocStr) C.struct_ResultListStr {
335+
elementIds, err := webdriver.FindElementsInElement(sessionId.String(), parentElementId.String(), using.String(), value.String())
336+
if err != nil {
337+
return createRocResult_ListStr_Str(RocErr, nil, err.Error())
338+
}
339+
340+
return createRocResult_ListStr_Str(RocOk, elementIds, "")
341+
}
342+
323343
//export roc_fx_browserGetTitle
324344
func roc_fx_browserGetTitle(sessionId *RocStr) C.struct_ResultVoidStr {
325345
title, err := webdriver.GetBrowserTitle(sessionId.String())

‎host/webdriver/webdriver.go

+49
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,28 @@ func FindElement(sessionId, using, value string) (string, error) {
358358
return response.Value.ElementId, nil
359359
}
360360

361+
func FindElementInElement(sessionId, elementId, using, value string) (string, error) {
362+
url := fmt.Sprintf("%s/session/%s/element/%s/element", baseUrl, sessionId, elementId)
363+
364+
reqBody := map[string]interface{}{
365+
"using": using,
366+
"value": value,
367+
}
368+
369+
jsonData, err := json.Marshal(reqBody)
370+
if err != nil {
371+
return "", err
372+
}
373+
374+
var response FindElement_Response
375+
err = makeHttpRequest("POST", url, bytes.NewBuffer(jsonData), &response)
376+
if err != nil {
377+
return "", err
378+
}
379+
380+
return response.Value.ElementId, nil
381+
}
382+
361383
type GetBrowserTitle_Response struct {
362384
Value string `json:"value"`
363385
}
@@ -425,6 +447,33 @@ func FindElements(sessionId, using, value string) ([]string, error) {
425447
return elementIds, nil
426448
}
427449

450+
func FindElementsInElement(sessionId, elementId, using, value string) ([]string, error) {
451+
url := fmt.Sprintf("%s/session/%s/element/%s/elements", baseUrl, sessionId, elementId)
452+
453+
reqBody := map[string]interface{}{
454+
"using": using,
455+
"value": value,
456+
}
457+
458+
jsonData, err := json.Marshal(reqBody)
459+
if err != nil {
460+
return nil, err
461+
}
462+
463+
var response FindElements_Response
464+
err = makeHttpRequest("POST", url, bytes.NewBuffer(jsonData), &response)
465+
if err != nil {
466+
return nil, err
467+
}
468+
469+
elementIds := make([]string, len(response.Value))
470+
for i, element := range response.Value {
471+
elementIds[i] = element.ElementId
472+
}
473+
474+
return elementIds, nil
475+
}
476+
428477
func ClickElement(sessionId, elementId string) error {
429478
url := fmt.Sprintf("%s/session/%s/element/%s/click", baseUrl, sessionId, elementId)
430479

‎platform/Browser.roc

+2
Original file line numberDiff line numberDiff line change
@@ -123,13 +123,15 @@ getUrl = \browser ->
123123
## `PartialLinkText Str` - e.g. PartialLinkText "Exam" in <a href="/examples-page">Examples</a>
124124
##
125125
Locator : [
126+
# !WARNING this code is duplicated in `Element` module
126127
Css Str,
127128
TestId Str,
128129
XPath Str,
129130
LinkText Str,
130131
PartialLinkText Str,
131132
]
132133

134+
# !WARNING this code is duplicated in `Element` module
133135
getLocator : Locator -> (Str, Str)
134136
getLocator = \locator ->
135137
when locator is

‎platform/Effect.roc

+6
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ hosted Effect
2121
elementGetProperty,
2222
elementSendKeys,
2323
elementClear,
24+
elementFindElement,
25+
elementFindElements,
2426
browserSetWindowRect,
2527
browserGetWindowRect,
2628
browserGetTitle,
@@ -98,3 +100,7 @@ elementIsSelected : Str, Str -> Task Str Str
98100
elementGetAttribute : Str, Str, Str -> Task Str Str
99101

100102
elementGetProperty : Str, Str, Str -> Task Str Str
103+
104+
elementFindElement : Str, Str, Str, Str -> Task Str Str
105+
106+
elementFindElements : Str, Str, Str, Str -> Task (List Str) Str

‎platform/Element.roc

+158
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ module [
1111
getAttribute,
1212
getAttributeOrEmpty,
1313
getPropertyOrEmpty,
14+
findElement,
15+
findElements,
16+
findSingleElement,
17+
tryFindElement,
1418
]
1519

1620
import Internal exposing [Element]
@@ -272,3 +276,157 @@ handleElementError = \err ->
272276
when err is
273277
e if e |> Str.startsWith "WebDriverElementNotFoundError" -> ElementNotFound (e |> Str.dropPrefix "WebDriverElementNotFoundError::")
274278
e -> WebDriverError e
279+
280+
## Supported locator strategies
281+
##
282+
## `Css Str` - e.g. Css ".my-button-class"
283+
##
284+
## `TestId Str` - e.g. TestId "button" => Css "[data-testid=\"button\"]"
285+
##
286+
## `XPath Str` - e.g. XPath "/bookstore/book[price>35]/price"
287+
##
288+
## `LinkText Str` - e.g. LinkText "Examples" in <a href="/examples-page">Examples</a>
289+
##
290+
## `PartialLinkText Str` - e.g. PartialLinkText "Exam" in <a href="/examples-page">Examples</a>
291+
##
292+
Locator : [
293+
# !WARNING this code is duplicated in `Browser` module
294+
Css Str,
295+
TestId Str,
296+
XPath Str,
297+
LinkText Str,
298+
PartialLinkText Str,
299+
]
300+
301+
# !WARNING this code is duplicated in `Browser` module
302+
getLocator : Locator -> (Str, Str)
303+
getLocator = \locator ->
304+
when locator is
305+
Css cssSelector -> ("css selector", cssSelector)
306+
# TODO - script injection
307+
TestId id -> ("css selector", "[data-testid=\"$(id)\"]")
308+
LinkText text -> ("link text", text)
309+
PartialLinkText text -> ("partial link text", text)
310+
# Tag tag -> ("tag name", tag)
311+
XPath path -> ("xpath", path)
312+
313+
## Find an `Element` inside the tree of another `Element` in the `Browser`.
314+
##
315+
## When there are more than 1 elements, then the first will
316+
## be returned.
317+
##
318+
## See supported locators at `Locator`.
319+
##
320+
## ```
321+
## # find the html element with a css selector "#my-id"
322+
## button = element |> Element.findElement! (Css "#my-id")
323+
## ```
324+
##
325+
## ```
326+
## # find the html element with a css selector ".my-class"
327+
## button = element |> Element.findElement! (Css ".my-class")
328+
## ```
329+
##
330+
## ```
331+
## # find the html element with an attribute [data-testid="my-element"]
332+
## button = element |> Element.findElement! (TestId "my-element")
333+
## ```
334+
findElement : Element, Locator -> Task Element [WebDriverError Str, ElementNotFound Str]
335+
findElement = \element, locator ->
336+
{ sessionId, elementId } = Internal.unpackElementData element
337+
(using, value) = getLocator locator
338+
339+
newElementId = Effect.elementFindElement sessionId elementId using value |> Task.mapErr! handleElementError
340+
341+
selectorText = "$(locator |> Inspect.toStr)"
342+
343+
Internal.packElementData { sessionId, elementId: newElementId, selectorText } |> Task.ok
344+
345+
## Find an `Element` inside the tree of another `Element` in the `Browser`.
346+
##
347+
## This function returns a `[Found Element, NotFound]` instead of an error
348+
## when element is not found.
349+
##
350+
## When there are more than 1 elements, then the first will
351+
## be returned.
352+
##
353+
## See supported locators at `Locator`.
354+
##
355+
## ```
356+
## maybeButton = element |> Element.tryFindElement! (Css "#submit-button")
357+
##
358+
## when maybeButton is
359+
## NotFound -> Stdout.line! "Button not found"
360+
## Found el ->
361+
## buttonText = el |> Element.getText!
362+
## Stdout.line! "Button found with text: $(buttonText)"
363+
## ```
364+
tryFindElement : Element, Locator -> Task [Found Element, NotFound] [WebDriverError Str, ElementNotFound Str]
365+
tryFindElement = \element, locator ->
366+
findElement element locator
367+
|> Task.map Found
368+
|> Task.onErr \err ->
369+
when err is
370+
ElementNotFound _ -> Task.ok NotFound
371+
other -> Task.err other
372+
373+
## Find an `Element` inside the tree of another `Element` in the `Browser`.
374+
##
375+
## This function will fail if the element is not found - `ElementNotFound Str`
376+
##
377+
## This function will fail if there are more than 1 element - `AssertionError Str`
378+
##
379+
##
380+
## See supported locators at `Locator`.
381+
##
382+
## ```
383+
## button = element |> Element.findSingleElement! (Css "#submit-button")
384+
## ```
385+
findSingleElement : Element, Locator -> Task Element [AssertionError Str, ElementNotFound Str, WebDriverError Str]
386+
findSingleElement = \element, locator ->
387+
{ selectorText: parentElementSelectorText } = Internal.unpackElementData element
388+
elements = findElements! element locator
389+
when elements |> List.len is
390+
0 ->
391+
(_, value) = getLocator locator
392+
Task.err (ElementNotFound "element with selector $(value) was not found in element $(parentElementSelectorText)")
393+
394+
1 ->
395+
elements
396+
|> List.first
397+
|> Result.onErr \_ -> crash "just checked - there is 1 element in the list"
398+
|> Task.fromResult
399+
400+
n ->
401+
(_, value) = getLocator locator
402+
Task.err (AssertionError "expected to find only 1 element with selector \"$(value)\", but found $(n |> Num.toStr)")
403+
404+
## Find all `Elements` inside the tree of another `Element` in the `Browser`.
405+
##
406+
## When there are no elements found, then the list will be empty.
407+
##
408+
## See supported locators at `Locator`.
409+
##
410+
## ```
411+
## # find all <li> elements in #my-list in the DOM tree of **element**
412+
## listItems = element |> Element.findElements! (Css "#my-list li")
413+
## ```
414+
##
415+
findElements : Element, Locator -> Task (List Element) [WebDriverError Str, ElementNotFound Str]
416+
findElements = \element, locator ->
417+
{ sessionId, elementId: parentElementId } = Internal.unpackElementData element
418+
(using, value) = getLocator locator
419+
420+
result = Effect.elementFindElements sessionId parentElementId using value |> Task.mapErr handleElementError |> Task.result!
421+
422+
selectorText = "$(locator |> Inspect.toStr)"
423+
424+
when result is
425+
Ok elementIds ->
426+
elementIds
427+
|> List.map \elementId ->
428+
Internal.packElementData { sessionId, elementId, selectorText }
429+
|> Task.ok
430+
431+
Err (ElementNotFound _) -> Task.ok []
432+
Err err -> Task.err err

‎tests/browser-tests.roc

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ test12 = test "window max, min, full" \browser ->
105105
# rect2.width |> Assert.shouldBe! 1919
106106

107107
rect3 = browser |> Browser.fullScreenWindow!
108-
rect3.x |> Assert.shouldBe! 0
108+
# rect3.x |> Assert.shouldBe! 0
109109
rect3.width |> Assert.shouldBe! 3840
110110

111111
rect1 = browser |> Browser.maximizeWindow!
112-
rect1.x |> Assert.shouldBe! 6
112+
# rect1.x |> Assert.shouldBe! 6
113113
rect1.width |> Assert.shouldBe! 3828

0 commit comments

Comments
 (0)