学习笔记之BBS_project_demo，内附自动化测试用例编写原则

功能：登录、个人中心、发帖、查看帖子、搜索、签到

自动化测试用例编写原则

1. 一个用例为一个完整的场景，从用户登录系统到最终退出并关闭浏览器
2. 一个用例只验证一个功能点，不要试图在用户登录系统后把所有的功能都验证一遍
3. 尽量少的编写逆向逻辑用例，一方面因为逆向逻辑的用例很多（例如，手机号输入错误有很多种情况）；另一方面自动化脚本本身比较脆弱，对于复杂的逆向逻辑用例实现麻烦且容易出错。
4. 用例和用例之间尽量避免产生依赖
5. 一条用例完成测试之后需要对测试场景进行还原，以免影响其他用例的执行

自动化测试项目结构：
项目结构：

myproject目录：
bbs：用来存放bbs项目的测试用例、测试报告和测试数据等
package：用于存放自动化用到的扩展包。例如HTMLTestRunner.py属于一个单独模块，并对其做了修改，所以，在执行测试前需要将它复制到python的lib目录下
driver：用于存放浏览器驱动，如selenium-server-standalone3.141.59.jar、Chromedriver.exe等等，在执行测试前根据执行场景将浏览器驱动复制到系统环境变量path目录下
start_up.bat：用于启动selenium server，默认启动driver目录下的selenium-server-standalone3.141.59.jar
run_bbs_test.py：项目主程序，用来运行bbs自动化用例
自动化测试项目说明文档.docx：介绍当前项目的架构、配置和使用说明
bbs目录：
data：该目录用来存测试相关的数据
report：用来存放HTML测试报告，其下面创建了image目录用于存放测试过程中的截图
test_case：测试用例目录，用于存放测试用例及相关模块
test_case目录：
modules：该目录下存放了一些公共的配置函数及公共类
page_object：该目录用于存放测试用例的页面对象（Page Object），根据自定义规则，以*Page.py命名的文件为封装的页面对象文件
*sta.py：测试用例文件。根据测试文件匹配规则，以_sta.py命名的文件将被当做为自动化测试用例执行。

***************************************************************************************************************************

首先定义驱动文件：…\myproject\bbs\test_case\models\driver.py

from selenium.webdriver import Remote
from selenium import webdriver
#启动浏览器驱动
import time
def browser():
    # driver = webdriver.chrome()
    host = '127.0.0.1:4444' #运行主机：端口号
    dc = {'browserName':'firefox'} #指定浏览器('chrome','firefox')
    driver = Remote(command_executor='http://'+ host + '/wd/hub',desired_capabilities=dc)
    return driver
if __name__=='__main__':
    dr = browser()
    dr.get("http://www.baidu.com")
    time.sleep(2)
    dr.quit()

这里整成驱动文件，是因为，需要在其他主机上跑的时候，只需要更改这个驱动文件的IP地址就可以了，要不然需要重新写这个启动浏览器的方法。
然后定义浏览器驱动函数browser()，函数可以进行配置，根据需求，配置测试用例在不同的主机及浏览器下运行

自定义测试框架类：…\myproject\bbs\test_case\models\myunit.py

from selenium import webdriver
from .driver import browser
import unittest
import os
class MyTest(unittest.TestCase):

    def setUp(self):
        self.driver=browser()
        self.driver.implicitly_wait(10)
        self.driver.maximize_window()
        
    def tearDown(self):
        self.driver.quit()

定义MyTest()类用于继承unittest.TestCase类，因为创建所有的测试类中setup()和teardown()方法所做的事情都相同，所以将它们抽象为MyTest()类，好处就是在编写测试用例时，不再考虑这两个方法的实现

定义截图函数：…\myproject\bbs\test_case\models\function.py

from selenium import webdriver
import os
#截图函数
def insert_img(driver,file_name):
    base_dir=os.path.dirname(os.path.dirname(__file__))
    base_dir=str(base_dir)
    base=base_dir.split('/test_case')[0]
    file_path = base +"/report/image/"+file_name
    driver.get_screenshot_as_file(file_path)
if __name__=='__main__':
    driver = webdriver.firefox()
    driver.get("http://www.baidu.com")
    insert_img(driver,'baidu.jpg')
    driver.quit()

创建截图函数insert_img()，为了保持自动化项目的移植性，采用相对路径的方式将测试截图保存到\report\image\目录下

编写Page Object

我们将使用Page Object设计模式来编写测试用例
首先创建基础Page基础类：…\myproject\bbs\test_case\page_obj\base.py

class Page(object):
    '''页面基类，用于所有页面的继承'''
    bbs_url = 'http://bbs.meizu.cn'
    def __init__(self,selenium_driver,base_url=bbs_url,parent=None):
        self.base_url=base_url
        self.driver = selenium_driver
        self.timeout = 30
        self.parent=parent
    def _open(self,url):
        url = self.base_url+url
        self.driver.get(url)
        assert self.on_page(),'Did not land on %s' % url
    def find_element(self,*loc):
        return self.driver.find_element(*loc)
    def find_elements(self,*loc):
        return self.driver.find_elements(*loc)
    def open(self):
        self.open(self.url)
    def on_page(self):
        return self.driver.current_url == (self.base_url+self.url)
    def script(self,src):
        return self.driver.execute_script(src)

创建页面基类，通过__init__（）方法初始化参数：浏览器驱动、URL地址、超时时长等。定义基本方法：open()用于打开BBS地址；find_element()和find_elements()分别用来定位单个与多个元素；创建script()方法可以更简单的调用JavaScript代码。当然还可以对更多的webdriver方法进行重定义。

创建BBS登录对象类：…\myproject\bbs\test_case\page_obj\loginPage.py

以下代码是按2016年魅族的登录页面的定位元素查找的，现在最新的魅族登录页面的提示框已经发生改变，所以根据相应的页面元素，重新进行定位，这里的代码是为了自己将来用来查看用的。

from selenium.webdriver.common.action_chains import ActionChains
from selenium.webdriver.common.by import By
from .base import Page
from time import sleep

class login(Page):
    '''用户登录页面'''
    url = '/'
    #Action
    bbs_login_user_loc = (By.XPATH,'//div[@id="mzCust"]/div/img')
    bbs_login_button_loc = (By.ID,"mzLogin")
    #以上两步是为了定位元素，成功跳转到登录页面
    def bbs_login(self):
        self.find_element(*self.bbs_login_user_loc).click()
        sleep(1)
        self.find_element(*self.bbs_login_button_loc).click()
    login_username_loc = (By.ID,"account")
    login_password_loc = (By.ID,"password")
    bbs_login_button_loc = (By.ID,"login")

    #登录用户名
    def login_uername(self,username):
        self.find_element(*self.login_username_loc).send_keys(username)
    #登录密码
    def login_password(self,password):
        self.find_element(*self.login_password_loc).send_keys(password)
    #登录按钮
    def login_button(self):
        self.find_element(*self.login_button_loc).click()

    #定义统一登录入口
    def user_login(self,username="username",password = "123456"):
        '''获取用户名和密码'''
        self.open()
        self.bbs_login()
        self.login_username(username)
        self.login_password(password)
        self.login_button()
        sleep(1)
    user_error_hint_loc = (By.XPATH,"//span[@for='account']")
    pawd_error_hint_loc = (By.XPATH,"//span[@for='password']")
    user_login_success_loc=(By.ID,"mzCustName")
    
    #用户名错误提示，获取到错误信息，就可以断言，看是否有提示错误信息
    def user_error_hint(self):
        return self.find_element(*self.user_error_hint_loc).text
    #密码错误提示
    def pawd_error_hint(self):
        return self.find_element(*self.pawd_error_hint_loc).text
    #登录成功用户名
    def user_login_success(self):
        return self.find_element(*self.user_login_success_loc).text

编写测试用例

创建BBS登录类：…\myproject\bbs\test_case\login_sta.py
在此处需要注意文件名的创建，例如，假设登录页的对象命名为loginPage.py，那么关于测试登录的用例文件名应该为login_sta.py，这样方便后期用例报错时问题的追踪，尽量把一个页面上的元素定位封装到一个*Page.py文件中，把针对这个页面的测试用例集中到一个 *_sta.py文件中

from time import sleep
import unittest,random,sys
sys.path.append("./models")
sys.path.append("./page_obj")
from models import myunit,function
from page_obj.loginPage import login

class loginTest(myunit.MyTest):
    '''社区登录测试'''
    #测试用户登录
    def user_login_verify(self,username="",password=""):
        login(self.driver).user_login(username,password)
    def test_login1(self):
        '''用户名、密码为空'''
        self.user_login_verify()
        po =login(self.driver)
        self.assertEqual(po.user_error_hint(),"账号不能为空")
        self.assertEqual(po.pawd_error_hint(), "密码不能为空")
        function.insert_img(self.driver, "user_pawd_empty.jpg")
    def test_login2(self):
        '''用户名正确、密码为空登录'''
        self.user_login_verify(username='pytest')
        po =login(self.driver)
        self.assertEqual(po.pawd_error_hint(), "密码不能为空")
        function.insert_img(self.driver,"pawd_empty.jpg")
    def test_login3(self):
        '''用户名为空、密码正确'''
        self.user_login_verify(password='123456')
        po =login(self.driver)
        self.assertEqual(po.user_error_hint(),"账号不能为空")
        function.insert_img(self.driver,"user_empty.jpg")
    def test_login4(self):
        '''用户名与密码不匹配'''
        character = random.choice('zsddsdssdsddw')
        username = "lisi"+character
        self.user_login_verify(username=username,password='123456')
        po =login(self.driver)
        self.assertEqual(po.paws_error_hint(),"账号与密码不匹配")
        function.insert_img(self.driver,"user_pawd_error.jpg")
    def test_login5(self):
        '''用户名、密码正确'''
        self.user_login_verify(username="MoLi_DD",password="123456")
        sleep(2)
        po = login(self.driver)
        self.assertEqual(po.user_login_success(), "MoLi_DD")
        function.insert_img(self.driver, "user_pawd_true.jpg")
if __name__=='__main__':
    unittest.main()

首先创建loginTest()类，继承myunit.MyTest()类，关于MyTest()类的实现，请翻看代码。这样就省去了在每个测试类中创建一个setUp()和tearDown()方法。
创建user_login_verify()方法，并调用loginPage.py中定义的user_login()方法，为什么不直接调用呢？因为user_login()的入参设置了默认值，这里需要重新将入参的默认值设置为空即可。
前三条测试用例：

1. 用户名密码为空，单击登录
2. 用户名正确，密码为空，单击登录
3. 用户名为空，密码正确，单击登录
   第四条用例验证错误的用户名和密码登录

创建用例执行主程序

创建用例执行程序：…\myproject\run_bbs_test.py

from HTMLTestRunner import HTMLTestRunner
from email.mime.text import MIMEText
from email.header import Header
import smtplib
import unittest
import time
import os
#===================发送邮件=======================
def send_mail(file_new):
    f=open(file_new,'rb')
    mail_body=f.read()
    f.close()

    # 编写HTML类型的邮件正文
    msg = MIMEText(mail_body, 'html', 'utf-8')
    msg['Subject'] = Header("自动化测试报告", 'utf-8')
    # 链接发送邮件
    smtp = smtplib.SMTP()
    smtp.connect("smtp.QQ.com")
    smtp.login("user", "password")
    smtp.sendmail("sender", "receiver", msg.as_string())
    smtp.quit()
#===================发送邮件=======================
def new_report(testreport):
    lists = os.listdir(testreport)
    lists.sort(key=lambda fn:os.path.getmtime(testreport+'\\'+fn))
    file_new = os.path.join(testreport,lists[-1])
    print(file_new)
    return file_new
if __name__=='__main__':
    now = time.strftime("%Y-%m-%d %H_%M_%S")
    filename = './bbs/report/'+now+'result.html'
    fp = open(filename,'wb')
    runner = HTMLTestRunner(
                            stream=fp,
                            title='魅族社区自动化测试报告',
                            description='环境：Windows 10 浏览器：Chrome',)
    discover = unittest.defaultTestLoader.discover('./bbs/test_case',pattern='*_sta.py')
    runner.run(discover)
    fp.close()#关闭生成的报告
    file_path = new_report('./bbs/report')#查找新生成的报告

执行程序中并没有做任何改动，集成了 HTMLTestRunner生成HTML测试报告，以及集成自动发邮件功能，唯一需要注意的是，脚本中的路径使用相对路径，便于项目移动到任何目录下执行。
打开…\models\driver.py文件，修改脚本运行的节点及浏览器，现在可以通过运行run_bbs_test.py来执行测试项目了。

本章小结

这个测试项目是我通过看2016年的视频，对魅族网页进行自动化测试，现在的魅族网页已经不再是之前那么定位元素，它的登录页面是在一个form表单内，所以查找元素之前，需要先找到那个form表单，然后再定位文本框，这里我没有仔细些，在以后会专门出一个项目测试实例。这里主要是将做自动化测试的框架设计出来，让自己也知道想要进行自动化测试，就必须先把基本架构设计完成，后面大部分工作就是编写各个页面的*Page.py，以及测试用例 *_sta.py。在这个过程中会遇到各种问题，，如元素的定位、架构的扩展，都需要自己在日后的工作中克服。