-
Notifications
You must be signed in to change notification settings - Fork 346
/
Copy pathselenium_hub_browser_test.py
executable file
·190 lines (164 loc) · 6.74 KB
/
selenium_hub_browser_test.py
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
#!/usr/bin/env python3
# coding=utf-8
# vim:ts=4:sts=4:sw=4:et
#
# Author: Hari Sekhon
# Date: 2021-05-12 09:55:01 +0100 (Wed, 12 May 2021)
#
# https://github.com/HariSekhon/DevOps-Python-tools
#
# License: see accompanying Hari Sekhon LICENSE file
#
# If you're using my code you're welcome to connect with me on LinkedIn
# and optionally send me feedback to help steer this or other code I publish
#
# https://www.linkedin.com/in/HariSekhon
#
"""
Tests a Selenium Hub / Selenoid using the given browsers eg. FIREFOX, CHROME
against a given URL and content (defaults to google.com)
Browsers default to 'FIREFOX' and 'CHROME' if not specified
URL defaults to 'google.com' checking for content 'google'
If you define a different URL then you must specify a --content or --regex validation otherwise none is used
Example:
./selenium_hub_browser_test.py --host <selenium_hub_host> [<browsers>] [<options>]
./selenium_hub_browser_test.py --hub-url http://<selenium_hub_host>:4444/wd/hub/ [<browsers>] [<options>]
Where browsers are one or more of these and must be supported by the remote Selenium Hub:
ANDROID
CHROME
EDGE
FIREFOX
HTMLUNIT
HTMLUNITWITHJS
INTERNETEXPLORER
IPAD
IPHONE
OPERA
PHANTOMJS
SAFARI
WEBKITGTK
Examples:
./selenium_hub_browser_test.py --host x.x.x.x
./selenium_hub_browser_test.py --host x.x.x.x FIREFOX CHROME
./selenium_hub_browser_test.py --host x.x.x.x FIREFOX CHROME --url google.com --content google
./selenium_hub_browser_test.py --host x.x.x.x FIREFOX CHROME --url google.com --regex 'goog.*'
Tested on Selenium Grid Hub v.3.141.59, v4.0.0 and Selenoid 1.10.1
"""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
import os
import re
import sys
import time
import traceback
from selenium import webdriver
from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
srcdir = os.path.abspath(os.path.dirname(__file__))
libdir = os.path.join(srcdir, 'pylib')
sys.path.append(libdir)
try:
# pylint: disable=wrong-import-position
from harisekhon import CLI
from harisekhon.utils import log, validate_host, validate_port, validate_url, validate_regex, die
except ImportError as _:
print(traceback.format_exc(), end='')
sys.exit(4)
__author__ = 'Hari Sekhon'
__version__ = '0.3'
class SeleniumHubBrowserTest(CLI):
def __init__(self):
# Python 2.x
super(SeleniumHubBrowserTest, self).__init__()
# Python 3.x
# super().__init__()
self.host = None
self.port = None
self.protocol = 'http'
self.name = 'Selenium Hub'
self.path = 'wd/hub'
self.hub_url = None
self.url_default = 'http://google.com'
self.url = self.url_default
self.expected_content = None
self.expected_content_default = 'google'
self.expected_regex = None
self.timeout_default = 600
self.verbose_default = 2
def add_options(self):
super(SeleniumHubBrowserTest, self).add_options()
self.add_hostoption(name='Selenium Hub', default_port=4444)
self.add_opt('-U', '--hub-url', help='Selenium Hub URL (takes priority over --host/--port/--ssl)')
self.add_opt('-u', '--url', default=self.url_default,
help='URL to use for the test (default: {})'.format(self.url_default))
self.add_opt('-c', '--content', help='URL content to expect')
self.add_opt('-r', '--regex', help='URL content to expect')
self.add_opt('-S', '--ssl', action='store_true', help='Use SSL to connect to Selenium Hub')
def process_options(self):
super(SeleniumHubBrowserTest, self).process_options()
self.hub_url = self.get_opt('hub_url')
if self.hub_url:
validate_url(self.hub_url, 'hub')
else:
self.host = self.get_opt('host')
self.port = self.get_opt('port')
validate_host(self.host)
validate_port(self.port)
if self.get_opt('ssl') or int(self.port) == 443:
self.protocol = 'https'
self.hub_url = '{protocol}://{host}:{port}/{path}'\
.format(protocol=self.protocol, \
host=self.host, \
port=self.port, \
path=self.path)
self.url = self.get_opt('url')
if ':' not in self.url:
self.url = 'http://' + self.url
validate_url(self.url)
self.expected_content = self.get_opt('content')
self.expected_regex = self.get_opt('regex')
if self.expected_regex:
validate_regex(self.expected_regex)
self.expected_regex = re.compile(self.expected_regex)
elif self.url == self.url_default:
self.expected_content = self.expected_content_default
if not self.args:
# test basic Chrome and Firefox are available
self.args.append('chrome')
self.args.append('firefox')
def check_selenium(self, browser):
log.info("Connecting to '%s' for browser '%s'", self.hub_url, browser)
driver = webdriver.Remote(
command_executor=self.hub_url,
desired_capabilities=getattr(DesiredCapabilities, browser)
)
log.info("Checking url '%s'", self.url)
driver.get(self.url)
content = driver.page_source
title = driver.title
driver.quit()
if self.expected_regex:
log.info("Checking url content matches regex")
if not self.expected_regex.search(content):
die('ERROR: Page source content failed regex search')
elif self.expected_content:
log.info("Checking url content matches '%s'", self.expected_content)
if self.expected_content not in content:
die('ERROR: Page source content failed content match')
# not really recommended but in this case we cannot predict
# what to expect on a random url if not specified by --content/--regex (provided in the default test case)
#
# https://www.selenium.dev/documentation/en/worst_practices/http_response_codes/
elif '404' in title:
die('ERROR: Page title contains a 404 / error ' +
'(if this is expected, specify --content / --regex to check instead): {}'.format(title))
log.info("Succeeded for browser '%s' against url '%s'", browser, self.url)
def run(self):
start_time = time.time()
for browser in self.args:
self.check_selenium(browser.upper())
query_time = time.time() - start_time
log.info('Finished checks in {:.2f} secs'.format(query_time))
if __name__ == '__main__':
SeleniumHubBrowserTest().main()