GitHub | Gitee |

Seldom is an automation testing framework based on unittest.

seldom 是基于unittest 的自动化测试框架。

Features

⭐ web/app/api全功能测试框架

⭐ 提供脚手架快速创建自动化项目

⭐ 集成XTestRunner测试报告，现代美观

⭐ 提供丰富的断言

⭐ 提供强大的数据驱动

⭐ 平台化支持

Install

pip install seldom

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

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

🤖 Quick Start

1、查看帮助：

seldom --help
                                                                                                    
 Usage: seldom [OPTIONS]                                                                            
                                                                                                    
 seldom CLI.                                                                                        
                                                                                                    
                                                                                                    
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --version             -v                 Show version.                                           │
│ --project-api         -api      TEXT     Create a project of API type. [default: None]           │
│ --project-app         -app      TEXT     Create a project of App type [default: None]            │
│ --project-web         -web      TEXT     Create a project of Web type [default: None]            │
│ --clear-cache         -cc                Clear all caches of seldom.                             │
│ --log-level           -ll       TEXT     Set the log level [TRACE |DEBUG | INFO | SUCCESS |      │
│                                          WARNING | ERROR].                                       │
│                                          [default: None]                                         │
│ --mod                 -m        TEXT     Run tests modules, classes or even individual test      │
│                                          methods from the command line.                          │
│                                          [default: None]                                         │
│ --path                -p        TEXT     Run test case file path. [default: None]                │
│ --env                 -e        TEXT     Set the Seldom run environment Seldom.env.            │
│                                          [default: None]                                         │
│ --browser             -b        TEXT     The browser that runs the Web UI automation tests       │
│                                          [chrome | edge | firefox | chromium]. Need the --path.  │
│                                          [default: None]                                         │
│ --base-url            -u        TEXT     The base-url that runs the HTTP automation tests. Need  │
│                                          the --path.                                             │
│                                          [default: None]                                         │
│ --debug               -d                 Debug mode. Need the --path/--mod.                      │
│ --rerun               -rr       INTEGER  The number of times a use case failed to run again.     │
│                                          Need the --path.                                        │
│                                          [default: 0]                                            │
│ --report              -r        TEXT     Set the test report for output. Need the --path.        │
│                                          [default: None]                                         │
│ --collect             -c                 Collect project test cases. Need the --path.            │
│ --level               -l        TEXT     Parse the level of use cases [data | case]. Need the    │
│                                          --path.                                                 │
│                                          [default: data]                                         │
│ --case-json           -j        TEXT     Test case files. Need the --path. [default: None]       │
│ --har2case            -h2c      TEXT     HAR file converts an seldom test case. [default: None]  │
│ --swagger2case        -s2c      TEXT     Swagger file converts an seldom test case.              │
│                                          [default: None]                                         │
│ --api-excel                     TEXT     Run the api test cases in the excel file.               │
│                                          [default: None]                                         │
│ --install-completion                     Install completion for the current shell.               │
│ --show-completion                        Show completion for the current shell, to copy it or    │
│                                          customize the installation.                             │
│ --help                                   Show this message and exit.                             │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯

2、创建项目：

> seldom -api myapi  # API automation test project.
> seldom -app myapp  # or App automation test project.
> seldom -web myweb  # or Web automation test project.

目录结构如下：

myweb/
├── test_dir/
│   ├── init.py
│   └── test_sample.py
├── test_data/
│   └── data.json
├── reports/
└── confrun.py

• test_dir/ 测试用例目录。
• test_data/ 测试数据文件目录。
• reports/ 测试报告目录。
• confrun.py 运行配置文件。

• ❌️ 在PyCharm中右键执行。

• ✔️ 通过命令行工具执行。

> seldom -p testdir # 运行 testdir 测试目录
          / // /   __   / /  \/ /   /  \/   _/  (  )  / / // / // / / / / / / /_/\//\,/\_// // //  v3.x.x 
                              @itest.info ...

2022-04-30 18:37:36 log.py | INFO | ✅ Find 1 element: id=sbformq  -&gt; input &#39;seldom&#39;. 2022-04-30 18:37:39 log.py | INFO | 👀 assertIn title: seldom - 搜索. .52022-04-30 18:37:39 log.py | INFO | 📖 https://cn.bing.com 2022-04-30 18:37:41 log.py | INFO | ✅ Find 1 element: id=sbformq  -&gt; input &#39;poium&#39;. 2022-04-30 18:37:42 log.py | INFO | 👀 assertIn title: poium - 搜索. .62022-04-30 18:37:42 log.py | INFO | 📖 https://cn.bing.com 2022-04-30 18:37:43 log.py | INFO | ✅ Find 1 element: id=sbformq  -&gt; input &#39;XTestRunner&#39;. 2022-04-30 18:37:44 log.py | INFO | 👀 assertIn title: XTestRunner - 搜索. .72022-04-30 18:37:44 log.py | INFO | 📖 http://www.itest.info 2022-04-30 18:37:52 log.py | INFO | 👀 assertIn url: http://www.itest.info/. .82022-04-30 18:37:52 log.py | SUCCESS | generated html file: file:///D:\mypro\reports\20220430183729result.html 2022-04-30 18:37:52 log.py | SUCCESS | generated log file: file:///D:\mypro\reports\seldom_log.log</code></pre>
4、查看报告
你可以到 mypro\reports\ 目录查看测试报告。


🔬 Demo
> seldom继承unittest单元测试框架，完全遵循unittest编写用例规范。
demo 提供了丰富实例，帮你快速了解seldom的用法。
Web UI 测试
<pre><code class="lang-python">import seldom from seldom import Steps
class BaiduTest(seldom.TestCase):
def testcaseone(self):         &quot;&quot;&quot;a simple test case &quot;&quot;&quot;         self.open(&quot;https://www.baidu.com&quot;)         self.type(id_=&quot;kw&quot;, text=&quot;seldom&quot;)         self.click(css=&quot;#su&quot;)         self.assertTitle(&quot;seldom_百度搜索&quot;)
def testcasetwo(self):         &quot;&quot;&quot;method chaining &quot;&quot;&quot;         Steps().open(&quot;https://www.baidu.com&quot;).find(&quot;#kw&quot;).type(&quot;seldom&quot;).find(&quot;#su&quot;).click()         self.assertTitle(&quot;seldom_百度搜索&quot;)
if name == &#39;main&#39;:     seldom.main(browser=&quot;chrome&quot;)</code></pre>
说明：
seldom.main() 通过 browser 指定运行的浏览器。


HTTP 测试
seldom 2.0 支持HTTP测试
<pre><code class="lang-python">import seldom
class TestRequest(seldom.TestCase):
def testputmethod(self):         self.put(&#39;/put&#39;, data={&#39;key&#39;: &#39;value&#39;})         self.assertStatusCode(200)
def testpostmethod(self):         self.post(&#39;/post&#39;, data={&#39;key&#39;: &#39;value&#39;})         self.assertStatusCode(200)
def testgetmethod(self):         payload = {&#39;key1&#39;: &#39;value1&#39;, &#39;key2&#39;: &#39;value2&#39;}         self.get(&quot;/get&quot;, params=payload)         self.assertStatusCode(200)
def testdeletemethod(self):         self.delete(&#39;/delete&#39;)         self.assertStatusCode(200)
if name == &#39;main&#39;:     seldom.main(base_url=&quot;http://httpbin.org&quot;)</code></pre>
说明：
seldom.main() 通过 base_url 指定接口项目基本URL地址。


App 测试
seldom 3.0 支持App测试
<pre><code class="lang-python">import seldom from seldom.appium_lab.keyboard import KeyEvent from seldom.appium_lab.android import UiAutomator2Options
class TestBingApp(seldom.TestCase):
def start(self):         self.ke = KeyEvent(self.driver)
def testbingsearch(self):         &quot;&quot;&quot;         test bing App search         &quot;&quot;&quot;         self.sleep(2)         self.click(id=&quot;com.microsoft.bing:id/sahpheadersearch_box&quot;)         self.type(id=&quot;com.microsoft.bing:id/sapphiresearchheaderinput&quot;, text=&quot;seldomQA&quot;)         self.ke.press_key(&quot;ENTER&quot;)         self.sleep(1)         elem = self.get_elements(xpath=&#39;//android.widget.TextView&#39;)         self.assertIn(&quot;seldom&quot;, elem[0].text.lower())
if name == &#39;main&#39;:     capabilities = {         &#39;deviceName&#39;: &#39;ELS-AN00&#39;,         &#39;automationName&#39;: &#39;UiAutomator2&#39;,         &#39;platformName&#39;: &#39;Android&#39;,         &#39;appPackage&#39;: &#39;com.microsoft.bing&#39;,         &#39;appActivity&#39;: &#39;com.microsoft.sapphire.app.main.MainSapphireActivity&#39;,         &#39;noReset&#39;: True,     }     options = UiAutomator2Options().load_capabilities(capabilities)     seldom.main(appserver=&quot;http://127.0.0.1:4723&quot;, appinfo=options, debug=True)</code></pre>
说明：
seldom.main() 通过 appinfo 指定App信息； appserver` 指定appium server 地址。

📖 Document
中文文档
项目实例
B站实战视频：
https://www.bilibili.com/video/BV1QHQVYoEHC
基于seldom的web UI自动化项目：
https://github.com/SeldomQA/seldom-web-testing
基于seldom的接口自动化项目:
https://github.com/defnngj/seldom-api-testing
微信（WeChat）
相关书籍推荐， 基于 SeldomQA 相关开源项目，虫师 编著。
            

欢迎添加微信，交流和反馈问题。
     
 

Star History

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

utx

贡献者
    
交流
QQ群：948994709