跳到主要內容

RFDoc

Introduction

RFDoc是一個讓你可以將所有的Keyowrd文件集中管理的Web應用程式。對於一個Team的開發人員來說,除了透過瀏覽各個Keyword文件外,也可以透過搜尋功能去知道目前專案中有哪些既有的Keyword可以用。這篇文章除了教你如何安裝使用RFDoc外,還會分享給你自動匯入文件到RFDoc的方式。

Install and Setup

RFDoc使用Django為Web的Framework並以sqlite3為資料庫。我分為兩部分做介紹,一個以Django做為Web Server,一個是以Apache做為Web Server。(官網的教學實在令我覺得OOXX,照著它做8成以上不能work)

Django Web Server

Django提供的Web Server目的是為了開發與測試使用,但如果只是拿來跑RFDoc也無妨吧!

  1. 安裝Djando:
    apt-get install python-django
  2. 下載rfdoc並解壓縮,我解壓縮至/usr/src/rfdoc-0.2。
  3. 建置與安裝: 至安裝目錄下執行以下指令,會產生src的資料夾,
    python setup.py install
  4. 設置DB:
    python src/rfdoc/manage.py syncdb
  5. 啟動: 可根據需求決定要使用的port,
    python src/rfdoc/manage.py runserver 0.0.0.0:8000

如果要重新初始化RFDoc使用的database,可以執行

python src/rfdoc/manage.py reset rfdocapp

Apache Web Server

它是透過WSGI的interface讓Apache Web Server去存取RFDoc。除了要安裝Django的部分,還要做以下安裝:

它是透過WSGI的interface讓Apache Web Server去存取RFDoc。除了要安裝Django的部分,還要做以下安裝:

  1. 安裝apache:
    sudo apt-get install apache2
  2. 安裝wsgi模組:
    sudo apt-get install libapache2-mod-wsgi
  3. 產生wsgi檔: 直接使用Template,
    cp /usr/src/rfdoc-0.2/src/rfdoc/rfdoc.wsgi.tmpl /usr/src/rfdoc-0.2/src/rfdoc/rfdoc.wsgi
    加入src/rfdoc的路徑到PATHS中,
    PATHS = ['/usr/src/rfdoc-0.2/src/rfdoc']
  4. 設定檔: 新增對rfdoc的apache設定擋,
    WSGIScriptAlias / /opt/tmp/rfdoc-0.2/src/rfdoc/rfdoc.wsgi
  5. 修改資料庫存取權限: 目的是要讓apache有rfdoc資料庫存取的權限,
    chown www-data:www-data /tmp/rfdoc.db

由於RFDoc程式碼都是使用Web Root的方式去存取,目前還在尋找可以讓它透過其它URL存取的方式。(主因是它網頁的寫法都會存取URL的Root)

How to use?

它UI設計非常簡單,底下是我匯入Keyword文件後的Screenshot:

  • 右上角的Upload: 提供讓你上傳文件的功能。上傳的文件是透過Robot提供的libdoc工具所產生,必須為xml格式,可以參考先前提過產生文件的方法
  • Search Keywords區塊: 提供你搜尋這些文件的功能。假如你不知道Team Members是否做了某個Keyword,不妨輸入些關鍵字試試看。如果它命名成K1、K2、K3,就去找你的Team membe吧。
  • Libraries區塊: 列出系統中現有的文件,可以直接參考官網Screenshot

如果你想把Robot Builtin的Library也匯進去,就必須要下載它的source code,由source code去產生。

Automatic Gen&Upload

當每次改完Robot後,就要手動去產生文件並上傳至RFDoc。如果只有改一兩個檔案還好,如果一次改很多且又在不同的資料夾呢? 我光第一次要匯入10來個檔案就懶了,索性寫一個script替我解決問題。主要有兩個需要知道的:

  1. 如何產生xml的Keyword文件?
  2. 如何透過script上傳至RFDoc?

產生XML的Document

先前介紹過產生Robot文件的方法了。主要是透過-f XML的參數:

libdoc.sh -f XML example.html example.xml

這個範例就是將library檔案example.html匯入為文件檔案example.xml。

上傳至RFDoc

透過Linux的CURL工具讓我可以透過script上傳文件:

OUTPUT_FILE=/tmp/rf_doc/example.xml
RFDOC_URL=http://192.168.1.113
curl --form file=@$OUTPUT_FILE \
           --form override=on $RFDOC_URL/upload  > /dev/null 2>&1

主要有兩個重要的參數: file為上傳檔案的本機路徑,override為是否要覆蓋資料。

摻在一起做懶人腳本

我的需求就是能夠將多個資料夾中的Robot Libraries檔案變成文件,並上傳至RFDoc。所以,

  1. 透過變數RFLIB_FOLDERS記錄我有哪些資料夾放著這些Libraries,以逗號(,)分開。
  2. 設置IFS為逗號(,),Loop變數RFLIB_FOLDERS。
  3. 取得各個資料夾中html結尾的檔案。
  4. 取得檔案名稱並執行libdoc匯出同名的xml文件。
  5. 最後透過curl上傳至RFDoc。

script如下:

#!/bin/bash
BASE=`dirname "$0"`
LIBDOC_CMD=$BAE/libdoc.sh
OUTPUT=$BASE/doc
RFDOC_URL=http://192.168.1.113
RFLIB_FOLDERS=("$BASE/../libs","$BASE/../testcases")
 
if [ ! -e $OUTPUT ]; then
        mkdir $OUTPUT
fi
 
IFS=$','
for folder in ${RFLIB_FOLDERS[@]}; do
        for file in $folder/*.html; do
                filename=`basename "$file" | cut -d'.' -f1`
                OUTPUT_FILE=$OUTPUT/$filename.xml
                $LIBDOC_CMD -f XML "$file" "$OUTPUT_FILE"
                curl --form file=@$OUTPUT_FILE \
                        --form override=on $RFDOC_URL/upload > /dev/null 2>&1
        done
 
done

最後就是將這些東西放入build script中。當你commmit code後,持續整合系統就會替你搞定這些事情啦! 你再也不用手動去做這些事情了!

History

  • 2013-09-10 在更換新版本robot後,RFDoc發生DB Table找不到的問題。主要原因猜測不能使用舊版本的robot jar檔去產生document,在更新產生document用的robotframework jar檔後,執行src/rfdoc/manage.py syncdb去清空資料庫。

留言

這個網誌中的熱門文章

解決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 --...

Robot Framework - Evaluate該怎麼用?

Evaluate該怎麼用? 前言 Builtin的RobotFramework Library提供了Evaluate Keyword。它所提供的功能是「執行Python描述句」。但實際上到底有什麼用途呢?原本我僅僅拿來將string轉為int的功用,經過一些查詢與試驗,我將心得整理給大家。 Builtin Builtin的function可以參考Library Doc for Evaluate。我以有使用過的function做說明。 數字轉換 Python提供了int、long、float與complex等function讓你可以將字串轉為數字,也可以透過它們做四則運算。首先以字串轉數字為例,我將8設於${num_str}中,再透過Evaluate+int轉為數字。這裡必須注意的是: 「int()中放變數必須以單引號'括起」。否則,假如你設定的數字為08,在轉換int時會出現Syntax Error。 ${num_str} | Set Variable | 8 ${num} | Evaluate | int('${num_str}') 其中int與long的第二個參數為base,這是根據你的input所決定: Comment | num = 9 ${num} | Evaluate | int('11', 8) Comment | num = 11 ${num} | Evaluate | int('11', 10) Comment | num = 17 ${num} | Evaluate | int('11', 16) 其它還有像bin、oct、hex,可以將整數轉為2、8、16進位。 運算 四則運算: 直接將運算子加上即可: ${num} | Evaluate | int('${hour}')*60 + int('${min}') 指數: 可以用pow。以下面兩個例子來說,第一個是2的3次方為8,第二個是2的3次方再mod 7為1。需注意的是: 「傳入值必須是數字不可為字串」。 ${num} | Evaluate | pow(2,3) ${num} | Evaluate | pow(2,3,7) 取最大最小值: 使用max/min,可以選擇丟一個array的方式...