跳到主要內容

Robot Framework Keyword: wget - 下載網頁上的資料

Problem

網站大都有提供下載功能，驗證下載功能與內容是否正常是必要的測試項目之一。然而，SeleniumLibrary並沒有提供類似的keyword。本篇文章分享我們解決這個問題的歷程。

How to?

方法1: 透過外部程式wget

起初我們透過外部程式去達到測試需求。要達成此目的，有幾個步驟:

  1. 測試環境可以執行wget。
  2. 取得下載位置的連結。
  3. 設定Cookie。
  4. 執行下載。
  5. 驗證內容。

步驟1: 測試環境可以執行wget

大部分linux安裝起來就有wget，如果沒有就自行安裝；而windows可以從這裡下載執行檔，將它放到你的測試環境中。

步驟2: 取得下載位置的連結

在這裡我使用的是Get Element Attribute去取得hyper link的內容:

Get Element Attribute | //a[@id='link_id']@href

步驟3: 設定Cookie

假如你的網站是需要登入才能夠操作，這部分就是必要的。首先可以透過SeleniumLibrary提供的Get Cookies來取得當前session內容；它所拿到的內容是使用name1=value1; name2=value2;形式組成，只要挑你需要的屬性出來即可。對我們而言，JSESSIONID記載我們的登入資訊。

接著是要組成wget所需要的cookie file格式，詳細格式可以參考此連結，大致上如下:

${domain_ip}   FALSE   ${path}   FALSE   9999999999   JSESSIONID   ${jsession_id}

假如你是使用localhost連線，${domain_ip}就是localhost，否則就是要連線的機器IP。

步驟4: 執行下載

假如參數連結位置為${fileUrl}而下載檔案路徑${fileName}，wget的執行指令如下:

${wget} --cookies=on --load-cookies ${cookie_file} --output-document ${fileName} ${fileUrl}

如果下載的位置為https，為了略過Certificate驗證，會搭配–no-check-certificate參數:

${wget} --cookies=on --no-check-certificate --load-cookies ${cookie_file} --output-document ${fileName} ${fileUrl}

步驟5: 驗證內容

這部分就是看各位的業務需求去做assertion。我的Keyword提供給大家參考:

Download File Wit Wget
    [Arguments]    ${fileUrl}    ${fileName}
    Log    ${fileUrl}
    ${cookies}    Get Cookies
    @{jessonid}    Split String    ${cookies}    JSESSIONID=
    ${location}    Get Location IP
    ${cookies}    Set Variable    ${location}\tFALSE\t//\tFALSE\t0\tJSESSIONID\t@{jessonid}[1]\r\n localhost\tFALSE\t//\tFALSE\t0\tJSESSIONID\t@{jessonid}[1]
    Log    ${cookies}
    Create File    ./cookies    ${cookies}
    ${currentdir}    Get Suite Directory
    ${isLinux}    Is Linux
    ${wget}    Set Variable If    '${isLinux}'!='TRUE'    ${currentdir}${/}..${/}commonResource${/}wget${/}wget    '${isLinux}'!='FALSE'    wget
    @{output}    Run And Return Rc And Output    ${wget} --cookies=on --no-check-certificate --load-cookies cookies --output-document ${fileName} \ ${fileUrl}
    Should Be Equal As Integers    @{output}[0]    0    @{output}[1]

方法2: 透過HttpClient Library

由於我們將預設連線修改為https，並且只允許TLS1.2，這導致在舊版本的Linux如RHEL6.0上無法透過預設的wget進行測試。因此改為自己實作TestLibrary去提供wget的功能。我所使用的HttpClient版本為httpclient-4.3.5，我直接將程式分享給各位，這可能會根據你的需求或library版本需要做些微調:

Robot Keyword:

Download File
    [Arguments]    ${fileUrl}    ${fileName}
    Log    ${fileUrl}
    ${cookies}    Get Cookies
    @{jessonid}    Split String    ${cookies}    JSESSIONID=
    ${location}    Get Location IP
    ${ret}    wget    ${fileUrl}    ${fileName}    JSESSIONID=@{jessonid}[1]    ${location}
    log    ${ret}

Test Library WgetLibrary:

import java.io.File;
import java.io.FileOutputStream;
 
import javax.net.ssl.SSLContext;
 
import org.apache.commons.io.IOUtils;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.conn.ssl.SSLContextBuilder;
import org.apache.http.conn.ssl.TrustSelfSignedStrategy;
import org.apache.http.impl.client.BasicCookieStore;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.impl.cookie.BasicClientCookie;
 
public class WgetLibrary {	
	 public static final String ROBOT_LIBRARY_SCOPE = "TEST CASE";
	 public static final String ROBOT_LIBRARY_VERSION = "1.0.0";
 
	private BasicCookieStore createCookieStore(String cookies, String domain, String path){
		if( cookies == null || cookies.isEmpty() )
			return null;
 
		BasicCookieStore cookieStore = new BasicCookieStore();
		String[] cookiePairs = cookies.split(";");
		for( String cookiePair : cookiePairs){
			String[] cookieToken = cookiePair.split("=");
			BasicClientCookie cookie = new BasicClientCookie(cookieToken[0], cookieToken[1]);
			cookie.setDomain(domain);
			cookie.setPath(path);
			cookieStore.addCookie(cookie);
		}
		return cookieStore;
	}
 
	public long wget(String url, String destFile, String cookies, String domain){
		return wget(url, destFile, cookies, domain, "/");
	}
 
	public long wget(String url, String destFile, String cookies, String domain, String path){
		CloseableHttpClient httpClient = null;
		FileOutputStream fos = null;
		CloseableHttpResponse response = null;
		try {
			HttpClientBuilder builder = HttpClientBuilder.create();
 
			SSLContext sslContext = new SSLContextBuilder().loadTrustMaterial(null, new TrustSelfSignedStrategy()).build();
			SSLConnectionSocketFactory sslSocketFactory = new SSLConnectionSocketFactory(sslContext, SSLConnectionSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER);
			builder.setSSLSocketFactory(sslSocketFactory);
 
			BasicCookieStore cookieStore = createCookieStore(cookies, domain, path);
			if( cookieStore != null ) {
				builder.setDefaultCookieStore(cookieStore);
			}
 
			httpClient = builder.build();
			response = httpClient.execute(new HttpGet(url));
			fos = new FileOutputStream(new File(destFile));
			IOUtils.copy(response.getEntity().getContent(), fos);
			return response.getStatusLine().getStatusCode();
		} catch( Exception e ){
			throw new RuntimeException(e);
		} finally {
			Cleaner.close(fos);
			Cleaner.close(response);
			Cleaner.close(httpClient);
		}
	}
}

Reference

標籤：

留言

張貼留言

這個網誌中的熱門文章

解決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而產生的樣子..)
張貼留言
閱讀完整內容

第一次寫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...
張貼留言
閱讀完整內容

升級SeleniumLibrary到4.5.0與Selenium到3.141.0

最近我們將RobotFramework升級至4.1.2，因為Jython的關係這個是目前可以使用Java執行的最後版本。 我們目前Selenium相關的Libraries版本如下: Selenium2Library - 3.0.0 (Latest, https://github.com/robotframework/Selenium2Library ) SeleniumLibrary - 3.0.0 ( https://github.com/robotframework/SeleniumLibrary/releases ) Selenium - 3.8.0 其中Selenium2Library已經沒在維護，也是最後一個版本，它所做的事情僅僅是把keyword forward給SeleniumLibrary。所以升級重點在SeleniumLibrary與Selenium。 而要升級這些Libraries，最重要的就是要知道它們彼此之間的相依，還有python版本的支援度。在我查詢套件的release note之後，因為4.1.2版本的jython只能支援到python 2.7.x，所以能升級的版本就有限制。其中SeleniumLibrary的情況如下: SeleniumLibrary 5.0.0 - 不支援Python 2 and Jython  SeleniumLibrary 4.5.0 - Python 2.7 and Selenium 3.141.0+  SeleniumLibrary 3.3.1 - Python 2.7 and Selenium 3.4+ 所以搭配了Selenium後，以下為我的第一個升級計畫: Selenium - 3.141.0 SeleniumLibrary - 3.3.。主要想確定是否會有deprecated items產生。 升級方式就是把以上原始碼丟到Lib底下，執行robot測試的時候會透過jython重新編譯。在我執行後，出現了urllib3找不到的問題: 我想可能是原本的套件中有包含urllib3，因此我到urllib3的package網站查了release note，找了可以匹配python 2.7的版本: urllib3 - 1.26.20 (https://pypi.org/project/...
張貼留言
閱讀完整內容