thirtyfour 0.37.0

Thirtyfour is a Selenium / WebDriver library for Rust, for automated website UI testing. Tested on Chrome and Firefox, but any webdriver-capable browser should work.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
64
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
96
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
123
124
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
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
259
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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
use futures_util::future::{BoxFuture, FutureExt};
use std::future::Future;
use std::sync::Arc;
use std::{fmt, time::Duration};

use serde::{Deserialize, Serialize};

use crate::WebElement;
use crate::error::WebDriverResult;

mod sealed {
    use crate::error::{WebDriverError, WebDriverResult};
    use std::borrow::Cow;
    use std::rc::Rc;
    use std::sync::Arc;
    use url::Url;

    pub trait IntoTransfer {
        fn into(self) -> Arc<str>;
    }

    pub trait IntoUrl {
        fn into_url(self) -> WebDriverResult<Url>;
    }

    impl IntoTransfer for &str {
        fn into(self) -> Arc<str> {
            Arc::from(self)
        }
    }

    impl IntoUrl for &str {
        fn into_url(self) -> WebDriverResult<Url> {
            Url::parse(self).map_err(|e| WebDriverError::ParseError(format!("url parse err {e}")))
        }
    }

    macro_rules! deref_impl {
        ($trait: path => $meth:ident -> $ret:ty {on} ($($T: ty),*)) => {$(
            impl $trait for $T {
                #[inline]
                fn $meth(self) -> $ret {
                    <&$T as $trait>::$meth(&self)
                }
            }

            impl $trait for &$T {
                #[inline]
                fn $meth(self) -> $ret {
                    <&str as $trait>::$meth(&self)
                }
            }
        )*};
    }

    deref_impl! {
        IntoTransfer => into -> Arc<str> {on} (String, Box<str>, Rc<str>, Cow<'_, str>)
    }

    deref_impl! {
        IntoUrl => into_url -> WebDriverResult<Url> {on} (String)
    }

    impl IntoTransfer for Arc<str> {
        fn into(self) -> Arc<str> {
            self
        }
    }

    impl IntoTransfer for &Arc<str> {
        fn into(self) -> Arc<str> {
            Arc::clone(self)
        }
    }

    impl IntoUrl for Url {
        fn into_url(self) -> WebDriverResult<Url> {
            Ok(self)
        }
    }

    impl IntoUrl for &Url {
        fn into_url(self) -> WebDriverResult<Url> {
            Ok(self.clone())
        }
    }
}

/// trait for turning a string into a cheaply cloneable and transferable String
pub trait IntoArcStr: sealed::IntoTransfer {}
impl<T: sealed::IntoTransfer> IntoArcStr for T {}

/// A trait to try to convert some type into an `Url`.
pub trait IntoUrl: sealed::IntoUrl {}
impl<T: sealed::IntoUrl> IntoUrl for T {}

/// Rectangle representing the dimensions of an element.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ElementRect {
    /// The x coordinate of the top-left corner.
    pub x: f64,
    /// The y coordinate of the top-left corner.
    pub y: f64,
    /// The element width.
    pub width: f64,
    /// The element height.
    pub height: f64,
}

impl ElementRect {
    /// The coordinates of the rectangle center point, rounded to integers.
    pub fn icenter(&self) -> (i64, i64) {
        let (x, y) = self.center();
        (x as i64, y as i64)
    }

    /// The coordinates of the rectangle center point.
    pub fn center(&self) -> (f64, f64) {
        (self.x + (self.width / 2.0), self.y + (self.height / 2.0))
    }
}

/// Helper to Serialize/Deserialize ElementRef from JSON Value.
#[derive(Debug, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ElementRef {
    /// Reference for a regular element.
    Element {
        /// Element id, as returned by the webdriver.
        #[serde(rename = "element-6066-11e4-a52e-4f735466cecf")]
        id: String,
    },
    /// Reference for a shadow element.
    ShadowElement {
        /// Element id, as returned by the webdriver.
        #[serde(rename = "shadow-6066-11e4-a52e-4f735466cecf")]
        id: String,
    },
}

impl ElementRef {
    /// The element id, as returned by the webdriver.
    pub fn id(&self) -> &str {
        match self {
            ElementRef::Element {
                id,
            } => id,
            ElementRef::ShadowElement {
                id,
            } => id,
        }
    }
}

/// Newtype for the session id.
#[derive(Debug, Clone, Serialize, Deserialize, Hash, Eq, PartialEq)]
pub struct SessionId {
    id: Arc<str>,
}

impl<S> From<S> for SessionId
where
    S: IntoArcStr,
{
    fn from(value: S) -> Self {
        SessionId {
            id: value.into(),
        }
    }
}

impl fmt::Display for SessionId {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.id)
    }
}

impl SessionId {
    /// Create a placeholder SessionId for cases where it's not used.
    ///
    /// E.g., session creation.
    pub fn null() -> Self {
        SessionId {
            id: Arc::from(""),
        }
    }
}

/// New-type for the element id.
#[derive(Debug, Clone, Serialize, Deserialize, Hash, Eq, PartialEq)]
#[serde(transparent)]
pub struct ElementId {
    id: Arc<str>,
}

impl<S> From<S> for ElementId
where
    S: IntoArcStr,
{
    fn from(value: S) -> Self {
        ElementId {
            id: value.into(),
        }
    }
}

impl fmt::Display for ElementId {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.id)
    }
}

/// New-type for the window handle.
#[derive(Debug, Clone, Serialize, Deserialize, Hash, Eq, PartialEq)]
pub struct WindowHandle {
    handle: Arc<str>,
}

impl<S> From<S> for WindowHandle
where
    S: IntoArcStr,
{
    fn from(value: S) -> Self {
        WindowHandle {
            handle: value.into(),
        }
    }
}

impl fmt::Display for WindowHandle {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.handle)
    }
}

/// The window type. The webdriver spec treats tabs and windows as windows.
#[derive(Debug, Clone)]
pub enum WindowType {
    /// A browser tab.
    Tab,
    /// A browser window.
    Window,
}

impl fmt::Display for WindowType {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "{}",
            match self {
                WindowType::Tab => "tab",
                WindowType::Window => "window",
            }
        )
    }
}

/// Rectangle position and dimensions.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct Rect {
    /// The x coordinate of the top-left corner.
    pub x: i64,
    /// The y coordinate of the top-left corner.
    pub y: i64,
    /// The rectangle width.
    pub width: i64,
    /// The rectangle height.
    pub height: i64,
}

impl Rect {
    /// Create a new `Rect`.
    pub fn new(x: i64, y: i64, width: i64, height: i64) -> Self {
        Rect {
            x,
            y,
            width,
            height,
        }
    }
}

/// Generic element query function that returns some type T.
pub trait ElementQueryFn<T>: Send + Sync {
    /// the future returned by ElementQueryFn::query
    type Fut: Future<Output = WebDriverResult<T>> + Send;

    /// the implementation of the query function
    fn call(&self, arg: WebElement) -> Self::Fut;
}

impl<T, Fut, Fun> ElementQueryFn<T> for Fun
where
    Fun: Fn(WebElement) -> Fut + Send + Sync + ?Sized,
    Fut: Future<Output = WebDriverResult<T>> + Send,
{
    type Fut = Fut;

    fn call(&self, arg: WebElement) -> Fut {
        self(arg)
    }
}

/// element predicates.
pub trait ElementPredicate: ElementQueryFn<bool> {}

impl<Fn: ElementQueryFn<bool> + ?Sized> ElementPredicate for Fn {}

/// a dynamically dispatched query function
pub type DynElementQueryFn<T> = dyn ElementQueryFn<T, Fut = BoxFuture<'static, WebDriverResult<T>>>;

/// a dynamically dispatched element predicate
pub type DynElementPredicate = DynElementQueryFn<bool>;

impl<T: 'static> DynElementQueryFn<T> {
    fn wrap<F: ElementQueryFn<T, Fut: 'static>>(
        fun: F,
    ) -> impl ElementQueryFn<T, Fut = BoxFuture<'static, WebDriverResult<T>>> {
        move |arg: WebElement| fun.call(arg).boxed()
    }

    /// erases the type of ElementQueryFn, and dynamically dispatches it using a Box smart pointer
    pub fn boxed<F: ElementQueryFn<T, Fut: 'static> + 'static>(fun: F) -> Box<Self> {
        Box::new(Self::wrap(fun)) as Box<Self>
    }

    /// erases the type of ElementQueryFn, and dynamically dispatches it using an Arc smart pointer
    pub fn arc<F: ElementQueryFn<T, Fut: 'static> + 'static>(fun: F) -> Arc<Self> {
        Arc::new(Self::wrap(fun)) as Arc<Self>
    }
}

/// Rect struct with optional fields.
#[derive(Debug, Default, Clone, Eq, PartialEq, Serialize)]
pub struct OptionRect {
    /// The x coordinate of the top-left corner.
    pub x: Option<i64>,
    /// The y coordinate of the top-left corner.
    pub y: Option<i64>,
    /// The rectangle width.
    pub width: Option<i64>,
    /// The rectangle height.
    pub height: Option<i64>,
}

impl OptionRect {
    /// Create a new `OptionRect`.
    pub fn new() -> Self {
        Default::default()
    }

    /// Set the x coordinate of the top-left corner.
    pub fn with_x(mut self, value: i64) -> Self {
        self.x = Some(value);
        self
    }

    /// Set the y coordinate of the top-left corner.
    pub fn with_y(mut self, value: i64) -> Self {
        self.y = Some(value);
        self
    }

    /// Set the rectangle width.
    pub fn with_width(mut self, value: i64) -> Self {
        self.width = Some(value);
        self
    }

    /// Set the rectangle height.
    pub fn with_height(mut self, value: i64) -> Self {
        self.height = Some(value);
        self
    }

    /// Set the rectangle position.
    pub fn with_pos(mut self, x: i64, y: i64) -> Self {
        self.x = Some(x);
        self.y = Some(y);
        self
    }

    /// Set the rectangle size.
    pub fn with_size(mut self, width: i64, height: i64) -> Self {
        self.width = Some(width);
        self.height = Some(height);
        self
    }
}

impl From<Rect> for OptionRect {
    fn from(value: Rect) -> Self {
        OptionRect {
            x: Some(value.x),
            y: Some(value.y),
            width: Some(value.width),
            height: Some(value.height),
        }
    }
}

/// The timeout configuration.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct TimeoutConfiguration {
    /// The script timeout.
    #[serde(skip_serializing_if = "Option::is_none")]
    script: Option<u64>,
    /// The page load timeout.
    #[serde(rename = "pageLoad", skip_serializing_if = "Option::is_none")]
    page_load: Option<u64>,
    /// The implicit wait timeout.
    #[serde(skip_serializing_if = "Option::is_none")]
    implicit: Option<u64>,
}

impl Default for TimeoutConfiguration {
    fn default() -> Self {
        TimeoutConfiguration::new(
            Some(Duration::from_secs(60)),
            Some(Duration::from_secs(60)),
            // NOTE: Implicit wait must default to zero to support ElementQuery.
            Some(Duration::from_secs(0)),
        )
    }
}

impl TimeoutConfiguration {
    /// Create a new `TimeoutConfiguration`.
    pub fn new(
        script: Option<Duration>,
        page_load: Option<Duration>,
        implicit: Option<Duration>,
    ) -> Self {
        TimeoutConfiguration {
            script: script.map(|x| x.as_millis() as u64),
            page_load: page_load.map(|x| x.as_millis() as u64),
            implicit: implicit.map(|x| x.as_millis() as u64),
        }
    }

    /// Get the script timeout, if set.
    pub fn script(&self) -> Option<Duration> {
        self.script.map(Duration::from_millis)
    }

    /// Set the script timeout.
    pub fn set_script(&mut self, timeout: Option<Duration>) {
        self.script = timeout.map(|x| x.as_millis() as u64);
    }

    /// Get the page load timeout, if set.
    pub fn page_load(&self) -> Option<Duration> {
        self.page_load.map(Duration::from_millis)
    }

    /// Set the page load timeout.
    pub fn set_page_load(&mut self, timeout: Option<Duration>) {
        self.page_load = timeout.map(|x| x.as_millis() as u64);
    }

    /// Get the implicit wait timeout, if set.
    pub fn implicit(&self) -> Option<Duration> {
        self.implicit.map(Duration::from_millis)
    }

    /// Set the implicit wait timeout.
    pub fn set_implicit(&mut self, timeout: Option<Duration>) {
        self.implicit = timeout.map(|x| x.as_millis() as u64);
    }
}

/// The WebDriver status.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WebDriverStatus {
    /// Whether the webdriver is ready to accept new sessions.
    pub ready: bool,
    /// The current status message.
    pub message: String,
}

#[cfg(test)]
mod tests {
    use super::*;
    use assert_matches::assert_matches;
    use serde_json::json;

    #[test]
    fn test_element_ref() {
        let id = "daaea226-43aa-400f-896c-210e5af2ac62";
        let value = json!({ "element-6066-11e4-a52e-4f735466cecf": id });
        let elem_ref: ElementRef = serde_json::from_value(value).unwrap();
        assert_matches!(&elem_ref, ElementRef::Element { id: x} if x == id);
        assert_eq!(elem_ref.id(), id);
    }

    #[test]
    fn test_shadow_element_ref() {
        let id = "daaea226-43aa-400f-896c-210e5af2ac62";
        let value = json!({ "shadow-6066-11e4-a52e-4f735466cecf": id });
        let elem_ref: ElementRef = serde_json::from_value(value).unwrap();
        assert_matches!(&elem_ref, ElementRef::ShadowElement { id: x} if x == id);
        assert_eq!(elem_ref.id(), id);
    }
}