深刻淺出開源性能測試工具 Locust (使用篇 1)

在《【LocustPlus序】漫談服務端性能測試》中，我對服務端性能測試的基礎概念和性能測試工具的基本原理進行了介紹，而且重點推薦了Locust這一款開源性能測試工具。然而，當前在網絡上針對Locust的教程極少，無論是中文仍是英文，基本都是介紹安裝方法和簡單的測試案例演示，但對於較複雜測試場景的案例演示卻基本沒有，所以不少測試人員都感受難以將Locust應用到實際的性能測試工做當中。

通過一段時間的摸索，包括通讀Locust官方文檔和項目源碼，而且在多個性能測試項目中對Locust進行應用實踐，事實證實，Locust徹底能知足平常的性能測試需求，LoadRunner能實現的功能Locust也基本都能實現。

本文將從Locust的功能特性出發，結合實例對Locust的使用方法進行介紹。考慮到大衆廣泛對LoadRunner比較熟悉，在講解Locust時也會採用LoadRunner的一些概念進行類比。

概述

先從Locust的名字提及。Locust的原意是蝗蟲，原做者之因此選擇這個名字，估計也是聽過這麼一句俗語，「蝗蟲過境，寸草不生」。我在網上找了張圖片，你們能夠感覺下。

而Locust工具生成的併發請求就跟一大羣蝗蟲通常，對咱們的被測系統發起攻擊，以此檢測系統在高併發壓力下是否能正常運轉。

在《【LocustPlus序】漫談服務端性能測試》中說過，服務端性能測試工具最核心的部分是壓力發生器，而壓力發生器的核心要點有兩個，一是真實模擬用戶操做，二是模擬有效併發。

在Locust測試框架中，測試場景是採用純Python腳本進行描述的。對於最多見的HTTP(S)協議的系統，Locust採用Python的requests庫做爲客戶端，使得腳本編寫大大簡化，富有表現力的同時且極具美感。而對於其它協議類型的系統，Locust也提供了接口，只要咱們能採用Python編寫對應的請求客戶端，就能方便地採用Locust實現壓力測試。從這個角度來講，Locust能夠用於壓測任意類型的系統。

在模擬有效併發方面，Locust的優點在於其摒棄了進程和線程，徹底基於事件驅動，使用gevent提供的非阻塞IO和coroutine來實現網絡層的併發請求，所以即便是單臺壓力機也能產生數千併發請求數；再加上對分佈式運行的支持，理論上來講，Locust能在使用較少壓力機的前提下支持極高併發數的測試。

腳本編寫

編寫Locust腳本，是使用Locust的第一步，也是最爲重要的一步。

簡單示例

先來看一個最簡單的示例。

from locust import HttpLocust, TaskSet, task

class WebsiteTasks(TaskSet):
    def on_start(self):
        self.client.post("/login", {
            "username": "test",
            "password": "123456"
        })

 @task(2)
    def index(self):
        self.client.get("/")

 @task(1)
    def about(self):
        self.client.get("/about/")

class WebsiteUser(HttpLocust):
    task_set = WebsiteTasks
    host = "http://debugtalk.com"
    min_wait = 1000
    max_wait = 5000複製代碼

在這個示例中，定義了針對http://debugtalk.com網站的測試場景：先模擬用戶登陸系統，而後隨機地訪問首頁（/）和關於頁面（/about/），請求比例爲2:1；而且，在測試過程當中，兩次請求的間隔時間爲1~5秒間的隨機值。

那麼，如上Python腳本是如何表達出以上測試場景的呢？

從腳本中能夠看出，腳本主要包含兩個類，一個是WebsiteUser（繼承自HttpLocust，而HttpLocust繼承自Locust），另外一個是WebsiteTasks（繼承自TaskSet）。事實上，在Locust的測試腳本中，全部業務測試場景都是在Locust和TaskSet兩個類的繼承子類中進行描述的。

那如何理解Locust和TaskSet這兩個類呢？

簡單地說，Locust類就比如是一羣蝗蟲，而每一隻蝗蟲就是一個類的實例。相應的，TaskSet類就比如是蝗蟲的大腦，控制着蝗蟲的具體行爲，即實際業務場景測試對應的任務集。

這個比喻可能不是很準確，接下來，我將分別對Locust和TaskSet兩個類進行詳細介紹。

class HttpLocust(Locust)

在Locust類中，具備一個client屬性，它對應着虛擬用戶做爲客戶端所具有的請求能力，也就是咱們常說的請求方法。一般狀況下，咱們不會直接使用Locust類，由於其client屬性沒有綁定任何方法。所以在使用Locust時，須要先繼承Locust類，而後在繼承子類中的client屬性中綁定客戶端的實現類。

對於常見的HTTP(S)協議，Locust已經實現了HttpLocust類，其client屬性綁定了HttpSession類，而HttpSession又繼承自requests.Session。所以在測試HTTP(S)的Locust腳本中，咱們能夠經過client屬性來使用Python requests庫的全部方法，包括GET/POST/HEAD/PUT/DELETE/PATCH等，調用方式也與requests徹底一致。另外，因爲requests.Session的使用，所以client的方法調用之間就自動具備了狀態記憶的功能。常見的場景就是，在登陸系統後能夠維持登陸狀態的Session，從然後續HTTP請求操做都能帶上登陸態。

而對於HTTP(S)之外的協議，咱們一樣可使用Locust進行測試，只是須要咱們自行實現客戶端。在客戶端的具體實現上，可經過註冊事件的方式，在請求成功時觸發events.request_success，在請求失敗時觸發events.request_failure便可。而後建立一個繼承自Locust類的類，對其設置一個client屬性並與咱們實現的客戶端進行綁定。後續，咱們就能夠像使用HttpLocust類同樣，測試其它協議類型的系統。

原理就是這樣簡單！

在Locust類中，除了client屬性，還有幾個屬性須要關注下：

• task_set: 指向一個TaskSet類，TaskSet類定義了用戶的任務信息，該屬性爲必填；
• max_wait/min_wait: 每一個用戶執行兩個任務間隔時間的上下限（毫秒），具體數值在上下限中隨機取值，若不指定則默認間隔時間固定爲1秒；
• host：被測系統的host，當在終端中啓動locust時沒有指定--host參數時纔會用到；
• weight：同時運行多個Locust類時會用到，用於控制不一樣類型任務的執行權重。

測試開始後，每一個虛擬用戶（Locust實例）的運行邏輯都會遵循以下規律：

1. 先執行WebsiteTasks中的on_start（只執行一次），做爲初始化；
2. 從WebsiteTasks中隨機挑選（若是定義了任務間的權重關係，那麼就是按照權重關係隨機挑選）一個任務執行；
3. 根據Locust類中min_wait和max_wait定義的間隔時間範圍（若是TaskSet類中也定義了min_wait或者max_wait，以TaskSet中的優先），在時間範圍中隨機取一個值，休眠等待；
4. 重複2~3步驟，直至測試任務終止。

class TaskSet

再說下TaskSet類。

性能測試工具要模擬用戶的業務操做，就須要經過腳本模擬用戶的行爲。在前面的比喻中說到，TaskSet類比如蝗蟲的大腦，控制着蝗蟲的具體行爲。

具體地，TaskSet類實現了虛擬用戶所執行任務的調度算法，包括規劃任務執行順序（schedule_task）、挑選下一個任務（execute_next_task）、執行任務（execute_task）、休眠等待（wait）、中斷控制（interrupt）等等。在此基礎上，咱們就能夠在TaskSet子類中採用很是簡潔的方式來描述虛擬用戶的業務測試場景，對虛擬用戶的全部行爲（任務）進行組織和描述，並能夠對不一樣任務的權重進行配置。

在TaskSet子類中定義任務信息時，能夠採起兩種方式，@task裝飾器和tasks屬性。

採用@task裝飾器定義任務信息時，描述形式以下：

from locust import TaskSet, task

class UserBehavior(TaskSet):
 @task(1)
    def test_job1(self):
        self.client.get('/job1')

 @task(2)
    def test_job2(self):
        self.client.get('/job2')複製代碼

採用tasks屬性定義任務信息時，描述形式以下：

from locust import TaskSet

def test_job1(obj):
    obj.client.get('/job1')

def test_job2(obj):
    obj.client.get('/job2')

class UserBehavior(TaskSet):
    tasks = {test_job1:1, test_job2:2}
    # tasks = [(test_job1,1), (test_job1,2)] # 兩種方式等價複製代碼

在如上兩種定義任務信息的方式中，均設置了權重屬性，即執行test_job2的頻率是test_job1的兩倍。

若不指定執行任務的權重，則至關於比例爲1:1。

from locust import TaskSet, task

class UserBehavior(TaskSet):
 @task
    def test_job1(self):
        self.client.get('/job1')

 @task
    def test_job2(self):
        self.client.get('/job2')複製代碼

from locust import TaskSet

def test_job1(obj):
    obj.client.get('/job1')

def test_job2(obj):
    obj.client.get('/job2')

class UserBehavior(TaskSet):
    tasks = [test_job1, test_job2]
    # tasks = {test_job1:1, test_job2:1} # 兩種方式等價複製代碼

在TaskSet子類中除了定義任務信息，還有一個是常常用到的，那就是on_start函數。這個和LoadRunner中的vuser_init功能相同，在正式執行測試前執行一次，主要用於完成一些初始化的工做。例如，當測試某個搜索功能，而該搜索功能又要求必須爲登陸態的時候，就能夠先在on_start中進行登陸操做；前面也提到，HttpLocust使用到了requests.Session，所以後續全部任務執行過程當中就都具備登陸態了。

腳本加強

掌握了HttpLocust和TaskSet，咱們就基本具有了編寫測試腳本的能力。此時再回過頭來看前面的案例，相信你們都能很好的理解了。

然而，當面對較複雜的測試場景，可能有的同窗仍是會感受無從下手；例如，不少時候腳本須要作關聯或參數化處理，這些在LoadRunner中集成的功能，換到Locust中就不知道怎麼實現了。可能也是這方面的緣由，形成不少測試人員都感受難以將Locust應用到實際的性能測試工做當中。

其實這也跟Locust的目標定位有關，Locust的定位就是small and very hackable。可是小巧並不意味着功能弱，咱們徹底能夠經過Python腳本自己來實現各類各樣的功能，若是你們有疑問，咱們不妨逐項分解來看。

在LoadRunner這款功能全面應用普遍的商業性能測試工具中，腳本加強無非就涉及到四個方面：

• 關聯
• 參數化
• 檢查點
• 集合點

先說關聯這一項。在某些請求中，須要攜帶以前從Server端返回的參數，所以在構造請求時須要先從以前請求的Response中提取出所需的參數，常見場景就是session_id。針對這種狀況，LoadRunner雖然可能經過錄制腳本進行自動關聯，可是效果並不理想，在實際測試過程當中也基本都是靠測試人員手動的來進行關聯處理。

在LoadRunner中手動進行關聯處理時，主要是經過使用註冊型函數，例如web_reg_save_param，對前一個請求的響應結果進行解析，根據左右邊界或其它特徵定位到參數值並將其保存到參數變量，而後在後續請求中使用該參數。採用一樣的思想，咱們在Locust腳本中也徹底能夠實現一樣的功能，畢竟只是Python腳本，經過官方庫函數re.search就能實現全部需求。甚至針對html頁面，咱們也能夠採用lxml庫，經過etree.HTML(html).xpath來更優雅地實現元素定位。

而後再來看參數化這一項。這一項極其廣泛，主要是用在測試數據方面。但經過概括，發現其實也能夠歸納爲三種類型。

• 循環取數據，數據可重複使用：e.g. 模擬3用戶併發請求網頁，總共有100個URL地址，每一個虛擬用戶都會依次循環加載這100個URL地址；
• 保證併發測試數據惟一性，不循環取數據：e.g. 模擬3用戶併發註冊帳號，總共有90個帳號，要求註冊帳號不重複，註冊完畢後結束測試；
• 保證併發測試數據惟一性，循環取數據：模擬3用戶併發登陸帳號，總共有90個帳號，要求併發登陸帳號不相同，但數據可循環使用。

經過以上概括，能夠確信地說，以上三種類型基本上能夠覆蓋咱們平常性能測試工做中的全部參數化場景。

在LoadRunner中是有一個集成的參數化模塊，能夠直接配置參數化策略。那在Locust要怎樣實現該需求呢？

答案依舊很簡單，使用Python的list和queue數據結構便可！具體作法是，在WebsiteUser定義一個數據集，而後全部虛擬用戶在WebsiteTasks中就能夠共享該數據集了。若是不要求數據惟一性，數據集選擇list數據結構，從頭至尾循環遍歷便可；若是要求數據惟一性，數據集選擇queue數據結構，取數據時進行queue.get()操做便可，而且這也不會循環取數據；至於涉及到須要循環取數據的狀況，那也簡單，每次取完數據後再將數據插入到隊尾便可，queue.put_nowait(data)。

最後再說下檢查點。該功能在LoadRunner中一般是使用web_reg_find這類註冊函數進行檢查的。在Locust腳本中，處理就更方便了，只須要對響應的內容關鍵字進行assert xxx in response操做便可。

針對如上各類腳本加強的場景，我也經過代碼示例分別進行了演示。但考慮到文章中插入太多代碼會影響到閱讀，所以將代碼示例部分剝離了出來，若有須要請點擊查看《深刻淺出開源性能測試工具Locust（腳本加強）》。

GitHub項目地址

Stormer

硬廣

歡迎關注個人我的博客和微信公衆號。

• 我的博客: debugtalk.com
• 微信公衆號: DebugTalk