forked from mattfair/SeleniumFactory-for-Python
/
SeleniumFactory.py
147 lines (119 loc) · 5.96 KB
/
SeleniumFactory.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
import os
from selenium import webdriver
from selenium import selenium
from ParseSauceURL import *
from SauceRest import *
"""
This class wraps a webdriver/selenium instance. It delegates most method calls to the underlying webdriver/selenium
instance, and provides some helper methods to set the build number and job status using the Sauce REST API.
It also outputs the Sauce Session ID, which will be parsed by the Jenkins/Bamboo plugins so as to associate the CI build with
the Sauce job.
"""
class Wrapper:
def __init__(self, selenium, parse):
self.__dict__['selenium'] = selenium
self.username = os.environ['SAUCE_USER_NAME']
self.accessKey = os.environ['SAUCE_API_KEY']
self.jobName = parse.getJobName()
def id(self):
if hasattr(self.selenium, 'session_id'):
return self.selenium.session_id
else:
return self.selenium.sessionId
def dump_session_id(self):
print "\rSauceOnDemandSessionID=%s job-name=%s" % (self.id(), self.jobName)
def set_build_number(self, buildNumber):
sauceRest = SauceRest(self.username, self.accessKey)
sauceRest.update(self.id(), {'build': buildNumber})
def job_passed(self):
sauceRest = SauceRest(self.username, self.accessKey)
sauceRest.update(self.id(), {'passed': True})
def job_failed(self):
sauceRest = SauceRest(self.username, self.accessKey)
sauceRest.update(self.id(), {'passed': False})
# automatic delegation:
def __getattr__(self, attr):
return getattr(self.selenium, attr)
def __setattr__(self, attr, value):
return setattr(self.selenium, attr, value)
"""
Simple interface factory to create Selenium objects, inspired by the SeleniumFactory interface
from https://github.com/infradna/selenium-client-factory for Java.
<p>
Compared to directly initializing {@link com.thoughtworks.selenium.DefaultSelenium}, this additional indirection
allows the build script or a CI server to control how you connect to the selenium.
This makes it easier to run the same set of tests in different environments without
modifying the test code.
<p>
This is analogous to how you connect to JDBC — you normally don't directly
instantiate a specific driver, and instead you do {@link DriverManager#getConnection(String)}.
"""
class SeleniumFactory:
def __init__(self):
pass
"""
Uses a driver specified by the 'SELENIUM_DRIVER' environment variable,
and run the test against the domain specified in 'SELENIUM_URL' system property or the environment variable.
If no variables exist, a local Selenium driver is created.
"""
def create(self):
if 'SELENIUM_STARTING_URL' not in os.environ:
startingUrl = "http://saucelabs.com"
else:
startingUrl = os.environ['SELENIUM_STARTING_URL']
if 'SELENIUM_DRIVER' in os.environ and 'SELENIUM_HOST' in os.environ and 'SELENIUM_PORT' in os.environ:
parse = ParseSauceURL(os.environ["SELENIUM_DRIVER"])
driver = selenium(os.environ['SELENIUM_HOST'], os.environ['SELENIUM_PORT'], parse.toJSON(), startingUrl)
driver.start()
if parse.getMaxDuration() != 0:
driver.set_timeout(parse.getMaxDuration())
wrapper = Wrapper(driver, parse)
wrapper.dump_session_id()
return wrapper
else:
driver = selenium("localhost", 4444, "*firefox", startingUrl)
driver.start()
return driver
"""
Uses a driver specified by the 'SELENIUM_DRIVER' system property or the environment variable,
and run the test against the domain specified in 'SELENIUM_STARTING_URL' system property or the environment variable.
If no variables exist, a local Selenium web driver is created.
"""
def createWebDriver(self):
if 'SELENIUM_STARTING_URL' not in os.environ:
startingUrl = "http://saucelabs.com"
else:
startingUrl = os.environ['SELENIUM_STARTING_URL']
if 'SELENIUM_DRIVER' in os.environ and 'SELENIUM_HOST' in os.environ and 'SELENIUM_PORT' in os.environ:
parse = ParseSauceURL(os.environ["SELENIUM_DRIVER"])
browser = os.environ["SELENIUM_BROWSER"]
desired_capabilities = {}
desired_capabilities['browserName'] = browser
desired_capabilities['version'] = os.environ["SELENIUM_VERSION"]
if 'SELENIUM_PLATFORM' in os.environ:
desired_capabilities['platform'] = os.environ['SELENIUM_PLATFORM']
else:
#work around for name issues in Selenium 2
if 'Windows 2003' in parse.getOS():
desired_capabilities['platform'] = 'XP'
elif 'Windows 2008' in parse.getOS():
desired_capabilities['platform'] = 'VISTA'
elif 'Linux' in parse.getOS():
desired_capabilities['platform'] = 'LINUX'
else:
desired_capabilities['platform'] = parse.getOS()
desired_capabilities['name'] = parse.getJobName()
command_executor="http://%s:%s@%s:%s/wd/hub"%(os.environ['SAUCE_USER_NAME'], os.environ['SAUCE_API_KEY'], os.environ['SELENIUM_HOST'], os.environ['SELENIUM_PORT'])
#make sure the test doesn't run forever if if the test crashes
if parse.getMaxDuration() != 0:
desired_capabilities['max-duration'] = parse.getMaxDuration()
desired_capabilities['command-timeout'] = parse.getMaxDuration()
if parse.getIdleTimeout() != 0:
desired_capabilities['idle-timeout'] = parse.getIdleTimeout()
driver=webdriver.Remote(desired_capabilities=desired_capabilities, command_executor=command_executor)
driver.get(startingUrl)
wrapper = Wrapper(driver, parse)
wrapper.dump_session_id()
return wrapper
else:
return webdriver.Firefox()