/seldom

WebUI/HTTP automation testing framework based on unittest

Primary LanguagePythonApache License 2.0Apache-2.0

PyPI version PyPI - Python Version

WebUI/HTTP automation testing framework based on unittest.

基于unittest 的 Web UI/HTTP自动化测试框架。

特点

  • 提供更加简单API编写自动化测试
  • 提供脚手架,快速生成自动化测试项目
  • 全局启动和关闭浏览器,减少浏览器的启动次数
  • 提供支持多种数据文件参数化
  • 支持用例失败/错误重跑
  • 支持生成HTML/XML测试报告
  • 支持HTTP接口测试 (v 2.0)

安装

> pip install seldom

If you want to keep up with the latest version, you can install with github repository url:

> pip install -U git+https://github.com/SeldomQA/seldom.git@master

Quick Start

1、查看帮助:

> seldom -h
usage: seldom [-h] [-v] [-project PROJECT] [-r R] [-m M] [-install INSTALL]

WebUI automation testing framework based on Selenium.

optional arguments:
  -h, --help        show this help message and exit
  -v, --version     show version
  -project PROJECT  Create an Seldom automation test project.
  -r R              run test case
  -m M              run tests modules, classes or even individual test methods
                    from the command line
  -install INSTALL  Install the browser driver, For example, 'chrome',
                    'firefox'.

2、创建项目:

> seldom -project mypro

目录结构如下:

mypro/
├── test_dir/
│   ├── test_sample.py
├── test_data/
│   ├── data.json
├── reports/
└── run.py
  • test_dir/ 测试用例目录。
  • test_data/ 测试数据文件目录。
  • reports/ 测试报告目录。
  • run.py 运行测试用例主文件。

3、运行项目:

> python3 run.py
2021-05-07 17:51:48 [INFO]
              __    __
   ________  / /___/ /___  ____ ____
  / ___/ _ \/ / __  / __ \/ __ ` ___/
 (__  )  __/ / /_/ / /_/ / / / / / /
/____/\___/_/\__,_/\____/_/ /_/ /_/
-----------------------------------------
                             @itest.info

2021-05-07 17:51:48 [INFO] 📖 https://www.baidu.com

DevTools listening on ws://127.0.0.1:59657/devtools/browser/f518d762-2e96-41d8-8bcc-80d6dd8ca124
2021-05-07 17:51:50 [INFO] ✅ Find 1 element: id=kw , input 'seldom'.
2021-05-07 17:51:51 [INFO] ✅ Find 1 element: css selector=#su , click.
2021-05-07 17:51:52 [INFO] 👀 assertIn title: seldom_百度搜索.
2021-05-07 17:51:52 [INFO] 📖 https://www.baidu.com
2021-05-07 17:51:53 [INFO] ✅ Find 1 element: id=kw , input 'poium'.
2021-05-07 17:51:54 [INFO] ✅ Find 1 element: css selector=#su , click.
2021-05-07 17:51:55 [INFO] 👀 assertIn title: poium_百度搜索.
2021-05-07 17:51:55 [INFO] 📖 https://www.baidu.com
2021-05-07 17:51:56 [INFO] ✅ Find 1 element: id=kw , input 'HTMLTestRunner'.
2021-05-07 17:51:57 [INFO] ✅ Find 1 element: css selector=#su , click.
2021-05-07 17:51:58 [INFO] 👀 assertIn title: HTMLTestRunner_百度搜索.
2021-05-07 17:51:58 [INFO] 📖 http://www.itest.info
2021-05-07 17:52:05 [INFO] 👀 assertIn url: http://www.itest.info/.
2021-05-07 17:52:05 [INFO] generated html file: file:///D:\mypro\reports\2021_05_07_17_51_48_result.html
.1.2.3.4

4、查看报告

你可以到 mypro\reports\ 目录查看测试报告。

test report

Demo

simple demo

demo 提供了丰富实例,帮你快速了解seldom的用法。

简单的实例 demo/test_dir/test_first_demo.py

import seldom


class BaiduTest(seldom.TestCase):

    def test_case(self):
        """a simple test case """
        self.open("https://www.baidu.com")
        self.type(id_="kw", text="seldom")
        self.click(css="#su")
        self.assertTitle("seldom_百度搜索")


if __name__ == '__main__':
    seldom.main()

说明:

  • 创建测试类必须继承 seldom.TestCase
  • 测试用例文件命名必须以 test 开头。
  • seldom的封装了assertTitleassertUrlassertText等断言方法。

HTTP 测试

seldom 2.0 支持HTTP测试

import seldom


class TestRequest(seldom.TestCase):

    def test_put_method(self):
        self.put('/put', data={'key': 'value'})
        self.assertStatusCode(200)

    def test_post_method(self):
        self.post('/post', data={'key':'value'})
        self.assertStatusCode(200)

    def test_get_method(self):
        payload = {'key1': 'value1', 'key2': 'value2'}
        self.get("/get", params=payload)
        self.assertStatusCode(200)

    def test_delete_method(self):
        self.delete('/delete')
        self.assertStatusCode(200)


if __name__ == '__main__':
    seldom.main(base_url="http://httpbin.org")

Run the test

import seldom

seldom.main()  # 默认运行当前测试文件
seldom.main(path="./")  # 当前目录下的所有测试文件
seldom.main(path="./test_dir/")  # 指定目录下的所有测试文件
seldom.main(path="./test_dir/test_sample.py")  # 指定目录下的测试文件

Document

中文文档

English document(readthedocs)

项目实例

基于seldom的web UI自动化项目:

https://github.com/BarryYBL/UIAutoDemo

基于seldom的接口自动化项目:

https://github.com/defnngj/pyrequest2

感谢

感谢从以下项目中得到思路和帮助。

交流

QQ群:948994709