This is a sample paragraph.
18 | 19 |This is a simple list of links: 20 |
This is a sample drop-down list: 27 | 32 |
33 | 34 |This is a sample radio button list: 35 |
40 | 41 | 42 |This is a sample web form: 43 |
49 | 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /tests/test_actions.py: -------------------------------------------------------------------------------- 1 | '''Tests for Radio Buttons and DropDown boxes.''' 2 | from websmith.actions import ( 3 | Choose, 4 | FillForm, 5 | FindByName, 6 | FindByXPATH, 7 | Go, 8 | Select, 9 | ) 10 | from websmith.ui import Session 11 | 12 | 13 | def test_go_to_page(browser, page): 14 | with Session(browser): 15 | Go(page) 16 | assert browser.title == 'WebSmith' 17 | 18 | 19 | def test_fill_form(browser, page): 20 | '''Fill out form with values.''' 21 | with Session(browser): 22 | Go(page) 23 | FillForm({'firstname': 'John', 'lastname': 'Steinbeck'}) 24 | 25 | assert FindByName('firstname').value == 'John' 26 | assert FindByName('lastname').value == 'Steinbeck' 27 | 28 | 29 | def test_select_radio_button(browser, page): 30 | '''Select the "John Steinbeck" radio button''' 31 | with Session(browser): 32 | Go(page) 33 | Choose('writers', 'steinbeck') 34 | element = FindByXPATH( 35 | ('//input[contains(@type, "radio")' 36 | 'and contains(@value, "steinbeck")]')) 37 | element.click() 38 | assert element.checked 39 | assert element.value == 'steinbeck' 40 | 41 | 42 | def test_select_from_dropdown_by_value(browser, page): 43 | '''Select individual item from a web dropdown by its value.''' 44 | with Session(browser): 45 | Go(page) 46 | Select('writers', 'bradbury') 47 | assert FindByXPATH( 48 | '//option[contains(@value, "bradbury")]').checked 49 | 50 | 51 | def test_select_from_dropdown_by_text(browser, page): 52 | '''Select individual item from a web dropdown by its text.''' 53 | with Session(browser): 54 | Go(page) 55 | Select('writers', 'John Steinbeck', True) 56 | assert FindByXPATH( 57 | '//option[contains(@value, "steinbeck")]').checked 58 | -------------------------------------------------------------------------------- /tests/test_finders.py: -------------------------------------------------------------------------------- 1 | '''Tests for finding web elements.''' 2 | from websmith.actions import ( 3 | FindByCSS, 4 | FindByID, 5 | FindByName, 6 | FindByTag, 7 | FindByText, 8 | FindByValue, 9 | FindByXPATH, 10 | Go, 11 | ) 12 | from websmith.ui import Session 13 | 14 | 15 | def test_find_by_css(browser, page): 16 | '''Find web elements by its css attribute.''' 17 | with Session(browser): 18 | Go(page) 19 | elements = FindByCSS('li') 20 | 21 | for element in elements: 22 | assert element.tag_name == 'li' 23 | 24 | 25 | def test_find_by_id(browser, page): 26 | '''Find web elements by its id.''' 27 | with Session(browser): 28 | Go(page) 29 | assert FindByID('login').tag_name == 'form' 30 | 31 | 32 | def test_find_by_name(browser, page): 33 | '''Find web elements by its name.''' 34 | with Session(browser): 35 | Go(page) 36 | assert FindByName('firstname').tag_name == 'input' 37 | 38 | 39 | def test_find_by_tag(browser, page): 40 | '''Find web elements by its tag.''' 41 | with Session(browser): 42 | Go(page) 43 | elements = FindByTag('li') 44 | 45 | for element in elements: 46 | assert element.tag_name == 'li' 47 | 48 | 49 | def test_find_by_text(browser, page): 50 | '''Find web elements by its text.''' 51 | with Session(browser): 52 | Go(page) 53 | elements = FindByText('John Steinbeck') 54 | 55 | for element in elements: 56 | assert element.text == 'John Steinbeck' 57 | 58 | 59 | def test_find_by_value(browser, page): 60 | '''Find web elements by its value.''' 61 | with Session(browser): 62 | Go(page) 63 | elements = FindByValue('steinbeck') 64 | 65 | for element in elements: 66 | assert element.value == 'steinbeck' 67 | 68 | 69 | def test_find_by_xpath(browser, page): 70 | '''Find web element by its XPATH.''' 71 | with Session(browser): 72 | Go(page) 73 | element = FindByXPATH( 74 | ('//input[contains(@type, "radio")' 75 | 'and contains(@value, "steinbeck")]')) 76 | assert element.checked is not True 77 | assert element.value == 'steinbeck' 78 | -------------------------------------------------------------------------------- /tests/test_links.py: -------------------------------------------------------------------------------- 1 | '''Tests for finding web link elements.''' 2 | from websmith.actions import ( 3 | LinkByHREF, 4 | LinkByPartialHREF, 5 | LinkByPartialText, 6 | LinkByText, 7 | Go, 8 | ) 9 | from websmith.ui import Session 10 | 11 | 12 | def test_link_by_href(browser, page): 13 | '''Find web link elements by its href attribute.''' 14 | with Session(browser): 15 | Go(page) 16 | element = LinkByHREF('https://github.com/omaciel/websmith') 17 | assert element.tag_name == 'a' 18 | assert element.value == 'WebSmith' 19 | 20 | 21 | def test_link_by_partial_href(browser, page): 22 | '''Find web link elements by its partial href attribute.''' 23 | with Session(browser): 24 | Go(page) 25 | element = LinkByPartialHREF('Bradbury') 26 | assert element.tag_name == 'a' 27 | assert element.value == 'Ray Bradbury' 28 | 29 | 30 | def test_link_by_partial_text(browser, page): 31 | '''Find web link elements by its partial text value.''' 32 | with Session(browser): 33 | Go(page) 34 | element = LinkByPartialText('John') 35 | assert element.tag_name == 'a' 36 | assert element.value == 'John Steinbeck' 37 | 38 | 39 | def test_link_by_text(browser, page): 40 | '''Find web link elements by its href attribute.''' 41 | with Session(browser): 42 | Go(page) 43 | element = LinkByText('WebSmith') 44 | assert element.tag_name == 'a' 45 | assert element.value == 'WebSmith' 46 | -------------------------------------------------------------------------------- /websmith/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/omaciel/websmith/b0316099a9ff7ed3600cc85203e17a3e5ead95dd/websmith/__init__.py -------------------------------------------------------------------------------- /websmith/__version__.py: -------------------------------------------------------------------------------- 1 | __version__ = '0.0.1' 2 | -------------------------------------------------------------------------------- /websmith/actions.py: -------------------------------------------------------------------------------- 1 | """Implements VERB-like objects that allow interction with DOM elements.""" 2 | import logging 3 | import threading 4 | 5 | 6 | logging.basicConfig(level=logging.INFO) 7 | LOGGER = logging.getLogger(__name__) 8 | 9 | 10 | class Action(object): 11 | '''Base class for all web actions.''' 12 | data = threading.local() 13 | 14 | def __init__(self): 15 | LOGGER.info('ACTION: {} on {}'.format( 16 | self.__class__.__name__, 17 | self.__dict__ 18 | )) 19 | self._run() 20 | 21 | def _run(self): 22 | raise NotImplementedError() 23 | 24 | 25 | def Check(name): 26 | '''Mark a checkbox as checked. 27 | 28 | Example: 29 | 30 | >>> Check('some-check-box') 31 | ''' 32 | browser = Action.browser 33 | 34 | return browser.check(name) 35 | 36 | 37 | def Choose(name, value): 38 | '''Mark a radiobox as checked. 39 | 40 | Borrowed from https://github.com/cobrateam/splinter 41 | 42 | Example: 43 | 44 | >>> Choose('some-radiobox-name', 'some-radiobutton-value') 45 | ''' 46 | browser = Action.browser 47 | 48 | browser.choose(name, value) 49 | 50 | 51 | def Click(element): 52 | '''Executes a 'click' on a web element. 53 | 54 | There is no real need to call this `Click` method, since most web elements 55 | returned by all other methods should already expose its own `click` method, 56 | but this is made available for more verbose, explicitly calls. 57 | 58 | Example: 59 | 60 | >>> Find( 61 | ''' 62 | element.click() 63 | 64 | 65 | def Fill(name, value): 66 | '''Fill a web element (by its name) with a value. 67 | 68 | Example: 69 | 70 | >>> Fill({'some-text-box': 'some value'}) 71 | >>> Fill({'some-check-box': True}) 72 | >>> Fill({'some-select-field': 'some-choice'}) 73 | ''' 74 | browser = Action.browser 75 | 76 | browser.fill(name, value) 77 | 78 | 79 | def FillForm(field_values, form_id=None, name=None): 80 | '''Fill a web form. 81 | 82 | Fills a web form, filling each field with its corresponding value as 83 | provided by the dictionary `field_values`, where its `keys` provide the 84 | `name` for a field in the form, and its values are used to populate it. 85 | 86 | Example: 87 | 88 | >>> FillForm({ 89 | ... 'some-text-box': 'some value', 90 | ... 'some-check-box': True, 91 | ... 'some-select-field': 'some-choice'}) 92 | ''' 93 | browser = Action.browser 94 | 95 | browser.fill_form(field_values, form_id, name) 96 | 97 | 98 | def FindByCSS(css): 99 | '''Find a web element by using its CSS attribute. 100 | 101 | Example: 102 | 103 | >>> FindByCSS('h1') 104 | ''' 105 | browser = Action.browser 106 | 107 | return browser.find_by_css(css) 108 | 109 | 110 | def FindByXPATH(xpath): 111 | '''Find a web element by using its XPATH. 112 | 113 | Example: 114 | 115 | >>> FindByXPATH('//input') 116 | ''' 117 | browser = Action.browser 118 | 119 | return browser.find_by_xpath(xpath) 120 | 121 | 122 | def FindByTag(tag): 123 | '''Find a web element by using its tag. 124 | 125 | Example: 126 | 127 | >>> FindByTag('input') 128 | ''' 129 | browser = Action.browser 130 | 131 | return browser.find_by_tag(tag) 132 | 133 | 134 | def FindByName(name): 135 | '''Find a web element by using its name. 136 | 137 | Example: 138 | 139 | >>> FindByName('name') 140 | ''' 141 | browser = Action.browser 142 | 143 | return browser.find_by_name(name) 144 | 145 | 146 | def FindByText(text): 147 | '''Find a web element by using its text attribute. 148 | 149 | Example: 150 | 151 | >>> FindByText('John Steinbeck') 152 | ''' 153 | browser = Action.browser 154 | 155 | return browser.find_by_text(text) 156 | 157 | 158 | def FindByID(ID): 159 | '''Find a web element by using its ID. 160 | 161 | Example: 162 | 163 | >>> FindByID('first-column') 164 | ''' 165 | browser = Action.browser 166 | 167 | return browser.find_by_id(ID) 168 | 169 | 170 | def FindByValue(value): 171 | '''Find a web element by using its value. 172 | 173 | Example: 174 | 175 | >>> FindByValue('steinbeck') 176 | ''' 177 | browser = Action.browser 178 | 179 | return browser.find_by_value(value) 180 | 181 | 182 | def LinkByHREF(href): 183 | '''Find a link by using its HREF value. 184 | 185 | Example: 186 | 187 | >>> LinkByHREF('http://example.com') 188 | ''' 189 | browser = Action.browser 190 | 191 | return browser.find_link_by_href(href) 192 | 193 | 194 | def LinkByPartialHREF(href): 195 | '''Find a link by using its partial HREF value. 196 | 197 | Example: 198 | 199 | >>> LinkByPartialHREF('example') 200 | ''' 201 | browser = Action.browser 202 | 203 | return browser.find_link_by_partial_href(href) 204 | 205 | 206 | def LinkByPartialText(text): 207 | '''Find a link by using its partial text value. 208 | 209 | Example: 210 | 211 | >>> LinkByPartialText('example') 212 | ''' 213 | browser = Action.browser 214 | 215 | return browser.find_link_by_partial_text(text) 216 | 217 | 218 | def LinkByText(text): 219 | '''Find a link by using its text value. 220 | 221 | Example: 222 | 223 | >>> LinkByText('example') 224 | ''' 225 | browser = Action.browser 226 | 227 | return browser.find_link_by_text(text) 228 | 229 | 230 | def Go(URL): 231 | '''Load URL in the web browser. 232 | 233 | Example: 234 | 235 | >>> Go('https://www.google.com') 236 | ''' 237 | browser = Action.browser 238 | 239 | browser.visit(URL) 240 | 241 | 242 | def Hover(element): 243 | '''Move and hover the mouse focus to a web element. 244 | 245 | Example: 246 | 247 | >>> Hover(element) 248 | ''' 249 | element.mouse_over() 250 | 251 | 252 | def Select(name, value, by_text=False): 253 | '''Select a choice from a list of web elements. 254 | 255 | Example: 256 | 257 | >>> Select('some-dropdown', 'some-choice-value') 258 | >>> Select('some-dropdown','some-choice-text', True) 259 | ''' 260 | browser = Action.browser 261 | 262 | if by_text is True: 263 | return browser.select_by_text(name, value) 264 | else: 265 | return browser.select(name, value) 266 | 267 | 268 | def SendKeys(name, value, slowly=False): 269 | '''Send value to a web element that can receive text input. 270 | 271 | Example: 272 | 273 | >>> SendKeys('q', 'WebSmith') 274 | ''' 275 | browser = Action.browser 276 | 277 | return browser.type(name, value, slowly) 278 | 279 | 280 | def Uncheck(name): 281 | '''Mark a checkbox as checked. 282 | 283 | Example: 284 | 285 | >>> Uncheck('some-check-box') 286 | ''' 287 | browser = Action.browser 288 | 289 | return browser.uncheck(name) 290 | -------------------------------------------------------------------------------- /websmith/ui.py: -------------------------------------------------------------------------------- 1 | """Browser and UI Elements.""" 2 | from splinter.driver.webdriver import BaseWebDriver, WebDriverElement 3 | from splinter.driver.webdriver.cookie_manager import CookieManager 4 | 5 | from websmith.actions import Action 6 | 7 | 8 | class WebDriver(BaseWebDriver): 9 | """Wrapper for Splinter BaseWebDriver that accepts a real Selenium 10 | webdriver instance. 11 | """ 12 | def __init__(self, browser, wait_time=2): 13 | self.driver = browser 14 | self.element_class = WebDriverElement 15 | self._cookie_manager = CookieManager(self.driver) 16 | super(WebDriver, self).__init__(wait_time) 17 | 18 | 19 | class Session(object): 20 | """A convenient object for working with Web UI elements.""" 21 | 22 | def __init__(self, browser): 23 | """Base client for handling web ui elements.""" 24 | self.browser = WebDriver(browser) 25 | Action.browser = self.browser 26 | 27 | def __enter__(self): 28 | return self 29 | 30 | def __exit__(self, exc_type, exc_val, exc_tb): 31 | delattr(Action, 'browser') 32 | --------------------------------------------------------------------------------