跳到主要內容

React - How to test component with static method?

Problem

在撰寫程式時,我會習慣將同性質的utility method放在同一個class中。以實作Login、Logout的功能來說,我就會建立一個class叫Auth,會包含以下methods:

import React, { Component } from 'react';
 
const session_token_key = 'session_token';
 
export default class Auth extends Component {
 
    static signIn(username, password){
        // check credential
        sessionStorage.setItem(session_token_key, 'session_info');
    }
 
    static signOut(){
        sessionStorage.clear();
    }
 
    static checkLogin(){
        if( !sessionStorage.getItem(session_token_key) ) {
            throw new Error("no session info");
        }
    }
};

而Logout的元件中,則會透過Auth.signOut去執行登出的動作:

import React, { useContext } from 'react';
import Auth from './Auth'
import { NavItem, NavLink} from 'reactstrap';
import { AuthContext }  from './AuthContext';
 
 
function Logout(){
    const [ authState, setAuthState ] = useContext(AuthContext);
 
    const signOut = ()=>{
        Auth.signOut();
        setAuthState(false);
        window.location.href = '/';
    };
 
    return (
        <NavItem aria-label="logout-nav-item" className="d-md-down-none" onClick={signOut}>
            <NavLink href="#" ><i className="icon-logout"></i></NavLink>
        </NavItem>
    );
}
 
export default Logout;

在先前針對useContext的使用文章中,參考過別人使用jest mock static的寫法如下:

const auth_do_nothing = jest.fn();
auth_do_nothing.mockImplementation(()=>{});
Auth.signOut = auth_do_nothing.bind(Auth);

但這寫法存在會將狀態延續至下一個testcase中(testsuite似乎沒影響);因此本篇文章將分享透過Sinon去mock static method並且清除mock狀態的做法。

How to?

以Logout為例,我想要模擬使用者點擊Logout並透過Auth.signOut執行登出動作,完整的測試程式碼如下:

import Logout from '../Logout'
import React, { useState, useEffect } from 'react';
import { AuthContext } from '../AuthContext';
import { render, fireEvent } from 'react-testing-library';
import Auth from '../Auth';
import sinon from 'sinon';
 
let authState = true;
function LogoutComp(){
    const [ state, setState ] = useState(true);
    useEffect(()=>{
        authState = state;
    });
    return <AuthContext.Provider value={[state, setState]}><Logout/></AuthContext.Provider>;
}
 
describe('<Logout/>',()=>{
  let stubSignOut;
  beforeEach(()=>{
    stubSignOut = sinon.stub(Auth, 'signOut');
  });
 
  afterEach(()=>{
    stubSignOut.restore();
  });
 
  it('Test logout', () => {
    // given
    const utils = render(<LogoutComp/>);
    const logout_nav_item = utils.getByLabelText('logout-nav-item');
 
    // when
    fireEvent.click(logout_nav_item);
 
    // then
    expect(authState).toBe(false);
    expect(stubSignOut.called).toBe(true);
  });  
});

在test beforeEach中,我透過sinon.stub去模擬Auth.signOut doNothing的動作,即不給予任何的動作;而在afterEach中,我可以透過stub產生的instance去做restore的動作,讓Auth.signOut回復到模擬之前:

  let stubSignOut;
  beforeEach(()=>{
    stubSignOut = sinon.stub(Auth, 'signOut');
  });
 
  afterEach(()=>{
    stubSignOut.restore();
  });

如果要驗證stub method是否有被呼叫,可以使用下面的做法:

expect(stubSignOut.called).toBe(true);

假如我是在Login form中想要模擬登入失敗的情形呢? 這裡我一樣用signOut當範例,我可以在stubSignOut instance上指定要拋出怎樣的例外:

  it('Test stub with throw', ()=> {
    stubSignOut.throws("name", "message");
    try {
      Auth.signOut();
      fail("should be failed");
    } catch(e) {
      expect(e.name).toBe("name");
      expect(e.message).toBe("message");
    }
    expect(stubSignOut.called).toBe(true);
  });

如果是要用回傳值的方式,則可以透過以下方式:

  it('Test stub with return value', ()=> {
    stubSignOut.returns(true);
    expect(Auth.signOut()).toBe(true);
    expect(stubSignOut.called).toBe(true);
  });

假如我要模擬像signIn有帶參數的情況呢? 以login失敗為例,可以使用withArgs來達到這個需求:

  it('Test stub with arguments', ()=> {
    stubSignIn.withArgs('root', '123456').throws("login failed", "wrong password");
    try {
      Auth.signIn('root', '123456');
      fail("should be failed");
    } catch(e) {
      expect(e.name).toBe("login failed");
      expect(e.message).toBe("wrong password");
    }
    expect(stubSignIn.called).toBe(true);
  }); 

可以看到sinon stub可以滿足我們基本的需求,而且使用也相當容易。我唯一在意的是它stub方式,需要將method name傳遞進去;假如以後有rename的需求,這會不容易馬上察覺。針對這個問題,如果之後有看到其它方法,會再分享給各位。

留言

這個網誌中的熱門文章

解決RobotFramework從3.1.2升級到3.2.2之後,Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護,我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情,主要先把明確的runtime語法錯誤與deprecate item處理好,這部分內容可以參考: link 。 直到最近才發現,透過SeleniumLibrary執行Choose File去上傳檔案的動作,會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法,我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住,有些測試案例是可以執行的,但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作,因為我使用 Remote Selenium ,所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現,在3.2.2的最後一個TCP封包,比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容,還有HTTP Content-Length的計算,我都確認過沒有問題。 最後發現問題是出在socket API的使用上,就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料,但沒處理到尚未送完的資料內容,而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方,在他們出新的版本之前,我是將改完的_socket.py放在我們自己的Lib底下,好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後,安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數,以前試驗過是可以安裝完成的。因此在發生這個問題後,我檢查了它的debug console: 從console得知,eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認,有問題的是有接網路線的網卡,且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制,因此發現在Anaconda的說明文件中( link ),有提到dhcptimeout這個boot參數。看了一些人的使用範例,應該是可以直接串在isolinux.cfg中,如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串,問問Google大師,想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ,關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中;在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知,它讀取的檔案是answer file而不是boot command line。因此我接下來的測試,就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --...

第一次寫MIB就上手

SNMP(Simple Network Management Protocol)是用來管理網路設備的一種Protocol,我對它的認識也是從工作接觸開始。雖說是管理網路設備,但是主機、電源供應器、RAID等也都可以透過它來做管理。如果你做了一個應用程式,當然所有的操作也都可以透過SNMP來完成,不過可能會很痛苦。前陣子遇到一個學弟,它告訴我說:「我可能不會想寫程式。」為什麼? 因為這是他痛苦的根源。 在這篇文章中,不是要告訴你SNMP是什麼,會看這篇文章的大哥們,應該已經對SNMP有些認識了。 是的!主題是MIB(Management information base)! 對於一個3th-party的SNMP oid,有MIB可以幫助你去了解它所提供的資訊是什麼,且可以對它做什麼操作。最近我運氣很好剛好做到關於修改MIB的工作,也讓我順便了解一下它的語法,接下來我要交給大家MIB的基礎認識。 smidump 我並非使用什麼高強的Editor去編寫MIB,我僅透過Nodepad++編輯和smidump編譯而已。smidump是Kay教我使用的一個將MIB module轉成樹狀結構或oid列表的工具,唯一的缺點是不會告訴你哪一行打錯。當然有錢直接買編輯樹狀結構的工具就可以不需要了解語法了! 安裝 在Ubuntu上可先輸入smidump確認是否安裝,如果沒安裝可透過apt-get install libsmi2ldbl安裝。(CentOS可以透過yum install libsmi) root@tonylin:~/multi-boot-server# smidump The program 'smidump' is currently not installed. You can install it by typing: apt-get install libsmi2ldbl 使用 透過下面兩行指令,就可以將mib file產生出對應的tree與oid列表的檔案。也可以透過這個結果確認MIB是不是你想要的。 smidump -f tree example1.mib > xtree.txt smidump -f identifiers example1.mib > xiden.txt 如果有參考其它檔案要加上p的參數: smidum...