跳到主要內容

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去清空資料庫。

留言

這個網誌中的熱門文章

PostgreSQL - Unattended installation on windows

Introduction 要將別人軟體包裝到自己軟體中,不可或缺的東西就是Unattended installation。以Unattended installation來說,我們可以選擇透過Installer的silent mode安裝,也可以透過把目標軟體做成portable的版本。本篇文章分享這兩種方法,教導大家如何將PostgreSQL透過Unattended installation方式安裝到目標系統成為service。 Note. 本篇以PostgreSQL 10.7為例。 Install with installer Tips 安裝程式或反安裝程式的參數,除了可以直接上官網搜尋Installation User Guide以外,也可以直接使用help參數查詢: postgresql- 10.7 - 2 -windows-x64.exe --help Windows安裝程式主要有EnterpriseDB與BigSQL兩種。BigSQL版本安裝元件是透過網路下載且支援參數不如EnterpriseDB版本多,以我們需求來說,我們傾向於使用EnterpriseDB版本。接下來分享給大家安裝與反安裝方法。 Installation @ echo off set INSTALL_DIR =C:\postgres10 set INSTALLER =postgresql- 10.7 - 2 -windows-x64.exe   rem options for installation set SSMDB_SERVICE =postgresql- 10 set MODE =--unattendedmodeui none --mode unattended   set DB_PASSWD =--superpassword postgres set DB_PORT =--serverport 5432   set SERVICE_NAME =--servicename % SSMDB_SERVICE %   set PREFIX =--prefix "%INSTALL_DIR%" set DATA_DIR =--datadir "%INSTALL_DIR%\data"   set OPTIONS =

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。

Hello World!

即將要搬家,因此舊網頁內容將慢慢轉移至Blogger。 如果要存取舊網頁,可以使用以下連結: https://wiki.tonylin.idv.tw/dokuwiki/doku.php