Python+Selenium框架设计篇之5-框架内封装基类和实现POM

前面文章，我们实现了框架的一部分功能，包括日志类和浏览器引擎类的封装，今天我们继续封装一个基类和介绍如何实现POM。关于基类，是这样定义的：把一些常见的页面操作的selenium封装到base_page.py这个类文件，以后每个POM中的页面类，都继承这个基类，这样每个页面类都有基类的方法，这个我们会在这篇文章实现。

1. 在实现封装基类里，我们实现了元素八大方式的定位和截图类封装。具体项目层级结构如下图。

2. 基类base_page.py的具体实现代码，这里就封装了几个常用方法，其他方法，你自己去练习封装下。

1. # coding=utf-8
2. import time
3. from selenium.common.exceptions import NoSuchElementException
4. import os.path
5. from framework.logger import Logger
7. # create a logger instance
8. logger = Logger(logger= "BasePage").getlog()
11. class BasePage(object):
12. """
13. 定义一个页面基类，让所有页面都继承这个类，封装一些常用的页面操作方法到这个类
14. """
16. def __init__(self, driver):
17. self.driver = driver
19. # quit browser and end testing
20. def quit_browser(self):
21. self.driver.quit()
23. # 浏览器前进操作
24. def forward(self):
25. self.driver.forward()
26. logger.info( "Click forward on current page.")
28. # 浏览器后退操作
29. def back(self):
30. self.driver.back()
31. logger.info( "Click back on current page.")
33. # 隐式等待
34. def wait(self, seconds):
35. self.driver.implicitly_wait(seconds)
36. logger.info( "wait for %d seconds." % seconds)
38. # 点击关闭当前窗口
39. def close(self):
40. try:
41. self.driver.close()
42. logger.info( "Closing and quit the browser.")
43. except NameError as e:
44. logger.error( "Failed to quit the browser with %s" % e)
46. # 保存图片
47. def get_windows_img(self):
48. """
49. 在这里我们把file_path这个参数写死，直接保存到我们项目根目录的一个文件夹.\Screenshots下
50. """
51. file_path = os.path.dirname(os.path.abspath( '.')) + '/screenshots/'
52. rq = time.strftime( '%Y%m%d%H%M', time.localtime(time.time()))
53. screen_name = file_path + rq + '.png'
54. try:
55. self.driver.get_screenshot_as_file(screen_name)
56. logger.info( "Had take screenshot and save to folder : /screenshots")
57. except NameError as e:
58. logger.error( "Failed to take screenshot! %s" % e)
59. self.get_windows_img()
61. # 定位元素方法
62. def find_element(self, selector):
63. """
64. 这个地方为什么是根据=>来切割字符串，请看页面里定位元素的方法
65. submit_btn = "id=>su"
66. login_lnk = "xpath => //*[@id='u1']/a[7]" # 百度首页登录链接定位
67. 如果采用等号，结果很多xpath表达式中包含一个=，这样会造成切割不准确，影响元素定位
68. :param selector:
69. :return: element
70. """
71. element = ''
72. if '=>' not in selector:
73. return self.driver.find_element_by_id(selector)
74. selector_by = selector.split( '=>')[ 0]
75. selector_value = selector.split( '=>')[ 1]
77. if selector_by == "i" or selector_by == 'id':
78. try:
79. element = self.driver.find_element_by_id(selector_value)
80. logger.info( "Had find the element \' %s \' successful "
81. "by %s via value: %s " % (element.text, selector_by, selector_value))
82. except NoSuchElementException as e:
83. logger.error( "NoSuchElementException: %s" % e)
84. self.get_windows_img() # take screenshot
85. elif selector_by == "n" or selector_by == 'name':
86. element = self.driver.find_element_by_name(selector_value)
87. elif selector_by == "c" or selector_by == 'class_name':
88. element = self.driver.find_element_by_class_name(selector_value)
89. elif selector_by == "l" or selector_by == 'link_text':
90. element = self.driver.find_element_by_link_text(selector_value)
91. elif selector_by == "p" or selector_by == 'partial_link_text':
92. element = self.driver.find_element_by_partial_link_text(selector_value)
93. elif selector_by == "t" or selector_by == 'tag_name':
94. element = self.driver.find_element_by_tag_name(selector_value)
95. elif selector_by == "x" or selector_by == 'xpath':
96. try:
97. element = self.driver.find_element_by_xpath(selector_value)
98. logger.info( "Had find the element \' %s \' successful "
99. "by %s via value: %s " % (element.text, selector_by, selector_value))
100. except NoSuchElementException as e:
101. logger.error( "NoSuchElementException: %s" % e)
102. self.get_windows_img()
103. elif selector_by == "s" or selector_by == 'selector_selector':
104. element = self.driver.find_element_by_css_selector(selector_value)
105. else:
106. raise NameError( "Please enter a valid type of targeting elements.")
108. return element
110. # 输入
111. def type(self, selector, text):
113. el = self.find_element(selector)
114. el.clear()
115. try:
116. el.send_keys(text)
117. logger.info( "Had type \' %s \' in inputBox" % text)
118. except NameError as e:
119. logger.error( "Failed to type in input box with %s" % e)
120. self.get_windows_img()
122. # 清除文本框
123. def clear(self, selector):
125. el = self.find_element(selector)
126. try:
127. el.clear()
128. logger.info( "Clear text in input box before typing.")
129. except NameError as e:
130. logger.error( "Failed to clear in input box with %s" % e)
131. self.get_windows_img()
133. # 点击元素
134. def click(self, selector):
136. el = self.find_element(selector)
137. try:
138. el.click()
139. logger.info( "The element \' %s \' was clicked." % el.text)
140. except NameError as e:
141. logger.error( "Failed to click the element with %s" % e)
143. # 或者网页标题
144. def get_page_title(self):
145. logger.info( "Current page title is %s" % self.driver.title)
146. return self.driver.title
148. @staticmethod
149. def sleep(seconds):
150. time.sleep(seconds)
151. logger.info( "Sleep for %d seconds" % seconds)

3. 页面对象中，百度主页的元素定位和简单的操作函数，页面类主要是元素定位和页面操作写成函数，供测试类调用。

baidu_homepage.py

1. # coding=utf-8
2. from framework.base_page import BasePage
5. class HomePage(BasePage):
7. input_box = "id=>kw"
8. search_submit_btn = "xpath=>//*[@id='su']"
10. def type_search(self, text):
11. self.type(self.input_box, text)
13. def send_submit_btn(self):
14. self.click(self.search_submit_btn)

这里注意下元素定位写法，=>和base_page.py中find_element()方法元素定位切割有关系，网上有些人写根据逗号切割或者等号切割，在实际使用xpath定位，发现单独逗号或者单独等号切割都不精确，造成元素定位失败。

4. 测试类的写法举例

1. # coding=utf-8
2. import time
3. import unittest
4. from framework.browser_engine import BrowserEngine
5. from pageobjects.baidu_homepage import HomePage
8. class BaiduSearch(unittest.TestCase):
10. def setUp(self):
11. """
12. 测试固件的setUp()的代码，主要是测试的前提准备工作
13. :return:
14. """
15. browse = BrowserEngine(self)
16. self.driver = browse.open_browser(self)
18. def tearDown(self):
19. """
20. 测试结束后的操作，这里基本上都是关闭浏览器
21. :return:
22. """
23. self.driver.quit()
25. def test_baidu_search(self):
26. """
27. 这里一定要test开头，把测试逻辑代码封装到一个test开头的方法里。
28. :return:
29. """
30. homepage = HomePage(self.driver)
31. homepage.type_search( 'selenium') # 调用页面对象中的方法
32. homepage.send_submit_btn() #调用页面对象类中的点击搜索按钮方法
33. time.sleep( 2)
34. homepage.get_windows_img() # 调用基类截图方法
35. try:
36. assert 'selenium' in homepage.get_page_title() # 调用页面对象继承基类中的获取页面标题方法
37. print ( 'Test Pass.')
38. except Exception as e:
39. print ( 'Test Fail.', format(e))
41. if __name__ == '__main__':
42. unittest.main()

 homepage = HomePage(self.driver)

      上面这行代码要注意，意思是，到一个页面，第一件事情是初始化这个页面的一个页面对象实例。注意，一定要带self.driver，不然会报错，这个self.driver，可以这样理解：在当前测试类里面，self.driver是来自浏览器引擎类中方法得到的，在初始化一个页面对象的时候，也把这个来自浏览器引擎类的driver给赋值给当前的页面对象，这样，才能执行页面对象或者基类里面的相关driver方法。写多了selenium的自动化脚本，你会明白，最重要的是保持前后driver的唯一性。

测试结果：会在logs文件夹生成一个日志文件，也会在screenshots文件夹生成一个png图片。