快捷導(dǎo)航

簡(jiǎn)單幾步教你學(xué)會(huì)Python接口自動(dòng)化測(cè)試

更新時(shí)間：2023年08月15日 10:25:23 作者：老-程序員

這篇文章主要介紹了簡(jiǎn)單幾步教你學(xué)會(huì)Python接口自動(dòng)化測(cè)試,本文從一個(gè)簡(jiǎn)單的登錄接口測(cè)試入手，一步步調(diào)整優(yōu)化接口調(diào)用姿勢(shì),期望讀者可以通過本文對(duì)接口自動(dòng)化測(cè)試有一個(gè)大致的了解,需要的朋友可以參考下

一、簡(jiǎn)介

本文從一個(gè)簡(jiǎn)單的登錄接口測(cè)試入手，一步步調(diào)整優(yōu)化接口調(diào)用姿勢(shì)；

然后簡(jiǎn)單討論了一下接口測(cè)試框架的要點(diǎn)；

最后介紹了一下我們目前正在使用的接口測(cè)試框架 pithy。

期望讀者可以通過本文對(duì)接口自動(dòng)化測(cè)試有一個(gè)大致的了解。

二、引言

為什么要做接口自動(dòng)化測(cè)試？

在當(dāng)前互聯(lián)網(wǎng)產(chǎn)品迭代頻繁的背景下，回歸測(cè)試的時(shí)間越來越少，很難在每個(gè)迭代都對(duì)所有功能做完整回歸。

但接口自動(dòng)化測(cè)試因其實(shí)現(xiàn)簡(jiǎn)單、維護(hù)成本低，容易提高覆蓋率等特點(diǎn)，越來越受重視。

為什么要自己寫框架呢？

使用 requets + unittest 很容易實(shí)現(xiàn)接口自動(dòng)化測(cè)試，而且 requests 的api已經(jīng)非常人性化，非常簡(jiǎn)單。

但通過封裝以后（特別是針對(duì)公司內(nèi)特定接口），再加上對(duì)一些常用工具的封裝，可以進(jìn)一步提高業(yè)務(wù)腳本編寫效率。

三、環(huán)境準(zhǔn)備

確保本機(jī)已安裝 python2.7 以上版本，然后安裝如下庫：

pip install flaskpip install requests

后面我們會(huì)使用 flask 寫一個(gè)用來測(cè)試的接口，使用requests去測(cè)試。

四、測(cè)試接口準(zhǔn)備

下面使用 flask 實(shí)現(xiàn)兩個(gè) http 接口，一個(gè)登錄，另外一個(gè)查詢?cè)斍?，但需要登錄后才可以，新建一個(gè) demo.py 文件（注意，不要使用windows記事本），把下面代碼 copy 進(jìn)去，然后保存、關(guān)閉。

接口代碼

#!/usr/bin/python# coding=utf-8from flask import Flask, request, session, jsonify
USERNAME = 'admin'PASSWORD = '123456'app = Flask(__name__)
app.secret_key = 'pithy'@app.route('/login', methods=['GET', 'POST'])def login():
    error = None
    if request.method == 'POST':        if request.form['username'] != USERNAME:
            error = 'Invalid username'
        elif request.form['password'] != PASSWORD:
            error = 'Invalid password'
        else:
            session['logged_in'] = True
            return jsonify({'code': 200, 'msg': 'success'})    return jsonify({'code': 401, 'msg': error}), 401@app.route('/info', methods=['get'])def info():
    if not session.get('logged_in'):        return jsonify({'code': 401, 'msg': 'please login !!'})    return jsonify({'code': 200, 'msg': 'success', 'data': 'info'})if __name__ == '__main__':
    app.run(debug=True)

最后執(zhí)行如下命令：

python demo.py

響應(yīng)如下：

* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with sta

大家可以看到服務(wù)已經(jīng)起來了。

接口信息

登錄接口

請(qǐng)求url

/login

請(qǐng)求方法

post

請(qǐng)求參數(shù)

| 參數(shù)名稱 | 參數(shù)類型 | 參數(shù)說明 |

| :————: | :——-: | :——: |

| username | String | 登錄名稱 |

| password | String | 登錄密碼 |

響應(yīng)信息

| 參數(shù)名稱 | 參數(shù)類型 | 參數(shù)說明 |

| :————: | :——-: | :——: |

| code | Integer | 結(jié)果code |

| msg | String | 結(jié)果信息 |

詳情接口

請(qǐng)求url

/info

請(qǐng)求方法

get

請(qǐng)求 cookies

| 參數(shù)名稱 | 參數(shù)類型 | 參數(shù)說明 |

| :————: | :——-: | :——: |

| session | String | session |

響應(yīng)信息

| 參數(shù)名稱 | 參數(shù)類型 | 參數(shù)說明 |

| :————: | :——-: | :——: |

| code | Integer | 結(jié)果code |

| msg | String | 結(jié)果信息 |

| data | String | 數(shù)據(jù)信息 |

五、編寫接口測(cè)試

測(cè)試思路

使用 requests庫模擬發(fā)送 HTTP 請(qǐng)求。
使用 python 標(biāo)準(zhǔn)庫里 unittest 寫測(cè)試 case。

腳本實(shí)現(xiàn)

#!/usr/bin/python# coding=utf-8import requestsimport unittestclass TestLogin(unittest.TestCase):
    @classmethod
    def setUpClass(cls):
        cls.login_url = 'http://127.0.0.1:5000/login'
        cls.info_url = 'http://127.0.0.1:5000/info'
        cls.username = 'admin'
        cls.password = '123456'
    def test_login(self):
        """
        測(cè)試登錄
        """
        data = {            'username': self.username,            'password': self.password
        }
        response = requests.post(self.login_url, data=data).json()        assert response['code'] == 200
        assert response['msg'] == 'success'
    def test_info(self):
        """
        測(cè)試info接口
        """
        data = {            'username': self.username,            'password': self.password
        }
        response_cookies = requests.post(self.login_url, data=data).cookies
        session = response_cookies.get('session')        assert session
        info_cookies = {            'session': session
        }
        response = requests.get(self.info_url, cookies=info_cookies).json()        assert response['code'] == 200
        assert response['msg'] == 'success'
        assert response['data'] == 'info'

六、優(yōu)化

封裝接口調(diào)用

寫完這個(gè)測(cè)試登錄腳本，你或許會(huì)發(fā)現(xiàn)，在整個(gè)項(xiàng)目的測(cè)試過程，登錄可能不止用到一次，如果每次都這么寫，會(huì)不會(huì)太冗余了？

對(duì)，確實(shí)太冗余了，下面做一下簡(jiǎn)單的封裝，把登錄接口的調(diào)用封裝到一個(gè)方法里，把調(diào)用參數(shù)暴漏出來，示例腳本如下：

#!/usr/bin/python# coding=utf-8import requestsimport unittesttry:    from urlparse import urljoinexcept ImportError:    from urllib.parse import urljoinclass DemoApi(object):
    def __init__(self, base_url):
        self.base_url = base_url    def login(self, username, password):
        """
        登錄接口
        :param username: 用戶名
        :param password: 密碼
        """
        url = urljoin(self.base_url, 'login')
        data = {            'username': username,            'password': password
        }        return requests.post(url, data=data).json()    def get_cookies(self, username, password):
        """
        獲取登錄cookies
        """
        url = urljoin(self.base_url, 'login')
        data = {            'username': username,            'password': password
        }        return requests.post(url, data=data).cookies    def info(self, cookies):
        """
        詳情接口
        """
        url = urljoin(self.base_url, 'info')        return requests.get(url, cookies=cookies).json()class TestLogin(unittest.TestCase):
    @classmethod
    def setUpClass(cls):
        cls.base_url = 'http://127.0.0.1:5000'
        cls.username = 'admin'
        cls.password = '123456'
        cls.app = DemoApi(cls.base_url)    def test_login(self):
        """
        測(cè)試登錄
        """
        response = self.app.login(self.username, self.password)        assert response['code'] == 200
        assert response['msg'] == 'success'
    def test_info(self):
        """
        測(cè)試獲取詳情信息
        """
        cookies = self.app.get_cookies(self.username, self.password)
        response = self.app.info(cookies)        assert response['code'] == 200
        assert response['msg'] == 'success'
        assert response['data'] == 'info'

OK，在這一個(gè)版本中，我們不但在把登錄接口的調(diào)用封裝成了一個(gè)實(shí)例方法，實(shí)現(xiàn)了復(fù)用，而且還把 host（self.base_url）提取了出來。

但問題又來了，登錄之后，登錄接口的 http 響應(yīng)會(huì)把 session 以 cookie 的形式 set 到客戶端，之后的接口都會(huì)使用此 session 去請(qǐng)求。

還有，就是在接口調(diào)用過程中，希望可以把日志打印出來，以便調(diào)試或者出錯(cuò)時(shí)查看。

好吧，我們?cè)賮砀囊话妗?/p>

保持 cookies &增加 log 信息

使用 requests 庫里的同一個(gè) Session 對(duì)象 (它也會(huì)在同一個(gè) Session 實(shí)例發(fā)出的所有請(qǐng)求之間保持 cookie )，即可解決上面的問題，示例代碼如下：

#!/usr/bin/python# coding=utf-8import unittestfrom pprint import pprintfrom requests.sessions import Sessiontry:    from urlparse import urljoinexcept ImportError:    from urllib.parse import urljoinclass DemoApi(object):
    def __init__(self, base_url):
        self.base_url = base_url        # 創(chuàng)建session實(shí)例
        self.session = Session()    def login(self, username, password):
        """
        登錄接口
        :param username: 用戶名
        :param password: 密碼
        """
        url = urljoin(self.base_url, 'login')
        data = {            'username': username,            'password': password
        }
        response = self.session.post(url, data=data).json()
        print('\n*****************************************')
        print(u'\n1、請(qǐng)求url: \n%s' % url)
        print(u'\n2、請(qǐng)求頭信息:')
        pprint(self.session.headers)
        print(u'\n3、請(qǐng)求參數(shù):')
        pprint(data)
        print(u'\n4、響應(yīng):')
        pprint(response)        return response    def info(self):
        """
        詳情接口
        """
        url = urljoin(self.base_url, 'info')
        response = self.session.get(url).json()
        print('\n*****************************************')
        print(u'\n1、請(qǐng)求url: \n%s' % url)
        print(u'\n2、請(qǐng)求頭信息:')
        pprint(self.session.headers)
        print(u'\n3、請(qǐng)求cookies:')
        pprint(dict(self.session.cookies))
        print(u'\n4、響應(yīng):')
        pprint(response)        return responseclass TestLogin(unittest.TestCase):
    @classmethod
    def setUpClass(cls):
        cls.base_url = 'http://127.0.0.1:5000'
        cls.username = 'admin'
        cls.password = '123456'
        cls.app = DemoApi(cls.base_url)    def test_login(self):
        """
        測(cè)試登錄
        """
        response = self.app.login(self.username, self.password)        assert response['code'] == 200
        assert response['msg'] == 'success'
    def test_info(self):
        """
        測(cè)試獲取詳情信息
        """
        self.app.login(self.username, self.password)
        response = self.app.info()        assert response['code'] == 200
        assert response['msg'] == 'success'
        assert response['data'] == 'info'

大功告成，我們把多個(gè)相關(guān)接口調(diào)用封裝到一個(gè)類中，使用同一個(gè) requests Session 實(shí)例來保持 cookies，并且在調(diào)用過程中打印出了日志，我們所有目標(biāo)都實(shí)現(xiàn)了。

但再看下腳本，又會(huì)感覺不太舒服，在每個(gè)方法里，都要寫一遍print 1、2、3… 要拼url、還要很多細(xì)節(jié)等等。

但其實(shí)我們真正需要做的只是拼出關(guān)鍵的參數(shù)（url 參數(shù)、body 參數(shù)或者傳入 headers 信息），可不可以只需定義必須的信息，然后把其它共性的東西都封裝起來呢，統(tǒng)一放到一個(gè)地方去管理？

到此這篇關(guān)于簡(jiǎn)單幾步教你學(xué)會(huì)Python接口自動(dòng)化測(cè)試的文章就介紹到這了,更多相關(guān)Python接口自動(dòng)化測(cè)試內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: