跳到主要內容

Ant - 透過SCP執行某些跨平台工作

Problem

某天我們有了要在exe檔上sign certificate的需求,而我們目前狀況如下:

  • Signtool Server: Windows Server 2003,32位元。
  • Build Server: Jenkins,CentOS6,64位元。
  • 簡化後的Build Process: 從版控系統checkout code後,開始編譯,產生各專案artifacts;透過installanywhre產生出installer;計算CRC code,並包成一個壓縮檔。

Thinking

基於以上需求,我開始思考有哪些做法:

  1. 拆解build job: 將步驟拆成多個build job。signtool server為jenkins slave,其中一個job可以將產生的installer丟過去執行。
  2. 不拆解build job: 讓Signtool Server上有類似jenkins slave的程式,可以接收我們的指令,而動作可以在一個build流成內完成。

使用第一種做法,我需要refactor build script,並且要考慮installer傳輸或放置在可抓取位置問題。而第二個做法呢? 考慮容易且可以傳輸檔案、執行指令的protocol:

  1. 透過ssh server: 可使用cygwin或其它現有的ssh server。
  2. 透過rest api: 可基於sprint restapi去實作,有sprint boot後,實作或發布app簡單很多。

為了簡單也不需要額外實作,我選擇了ssh server的方式。

How to?

select ssh server - apache sshd

在ssh server的選擇上,首先我使用了cygwin。在Signtool Server上安裝cygwin後,首先遇到類似以下的訊息

could not be located in the dynamic link library KERNEL32.dll

嘗試過不同版本的cygwin依然無法解決,接著改用apache sshd。我使用的是1.2.0的版本,我遇到以下問題:

  1. sshd.bat找不到main class: 從source code得知,bat launch的class名稱需改為org.apache.sshd.server.SshServer。
  2. 連線後該如何登入: 從source code得知,只要給一個帳號與密碼是相同即可登入。如果有疑慮就需要自己override PasswordAuthenticator。
  3. 執行發生找不到jvm.dll的問題: 由於apache sshd必須使用java7以上,且windows 2003不支援java8,因此我使用java 7。而這個問題只要將jre7/bin/client複製到jre7/bin/server後,即可解決。

在成功啟動apache sshd後,可以透過putty連線測試一下。

register the sshd as a service

(此部分需參考後記)

將程式註冊為service有不少方法,最簡單的方法是透過mssm。首先透過mssm執行:

mssm.exe install apache-sshd

接著會出現如下圖畫面,去選擇你sshd.bat:

(後記: 預設Logon帳號為System Account,但在sign certificate上會有問題,需特別指定帳號。可參考下個章節。)

安裝完成後,可以透過sc指令確認並啟動:

sc query apache-sshd
sc start apache-sshd

請記得再次確認:

  1. 重新啟動後會自動啟動。
  2. 可透過putty連線。

run scp with ant

ant scp的task會基於jsch,請記得先下載並放置於ANT_HOME/lib下。以下為我client side的ant script:

<project name="test-sign">
	<target name="test-sign">
		<property name="exe.file.name" value="test.exe"></property>
		<scp file="build/${exe.file.name}" todir="root:root@10.146.127.213:/apache-sshd-1.2.0/build" port="8000" trust="true"/>
		<sshexec command="sign.bat ${exe.file.name}" host="10.146.127.213" port="8000" username="root" password="root" trust="true"/>
		<scp file="root:root@10.146.127.213:/apache-sshd-1.2.0/build/${exe.file.name}" todir="dist" port="8000" trust="true"/>
	</target>
</project>

簡單說明一下我的ant script,

  1. 要sign的執行檔為test.exe,sign之前放至於build資料夾,sign之後放於dist。
  2. signtool server為10.146.127.213,apache-sshd-1.2.0為預設工作目錄。
  3. 首先會將test.exe丟到signtool server,接著透過sign.bat執行sign的動作,最後再將結果抓回放置到dist中。

sign.bat首先會確認檔案是否存在,接著就是執行signtool:

@echo off
 
cd /d "D:\\apache-sshd-1.2.0"
 
if "%1" == "" (
	echo Please enter the file name
	exit /b 1
)
 
set sign_file=D:\\apache-sshd-1.2.0\build\%1
 
if not exist "%sign_file%" (
	echo Can't find %sign_file%
	exit /b 1
)
 
C:\WinDDK\6000\bin\setenv.bat C:\WinDDK\6000\ fre AMD64 WLH & signtool sign /v /ac D:\my.cer /s My /n "IssueToName" /t http://timestamp.verisign.com/scripts/timestamp.dll "%sign_file%" 

然而,事情並不如想像中順利,執行後發生以下錯誤:

這個問題是sshd執行環境找不到我所要求的certificate,我嘗試過修改/s與certificte放置路徑皆無法成功。我在想,這應該是執行apache-sshd的使用者所造成的吧? 後來,我先透過了psexe.exe遠端連線執行的方式解決了這個問題:

  1. 在D:\\apache-sshd-1.2.0中放置psexe.exe。
  2. 將client ant的sshexec改為以下內容,目的是為了透過administrator登入去執行sign.bat:

<sshexec command="psexec -accepteula -u administrator -p 123456 \\localhost -w D:\apache-sshd-1.2.0 cmd.exe /c call sign.bat ${exe.file.name}" host="10.146.127.213" port="8000" username="root" password="root" trust="true" />

果然成功了:

後來睡覺前,一直在思考,為什麼會有使用者區別? 應該是和註冊service的login帳戶有關吧? 於是我首先嘗試改用batch啟動apache-sshd,發現可以正常sign certificate;接著重新註冊service並將Logon帳戶從system改為特定的:
然後改用原本的sshexec,果不其然,成功了:

後記

某天正式開始啟用此功能後,發現傳大檔案都會發生問題。經過trace,發現是由於nssm註冊為service後,會一分鐘重新啟動一次:

詳細原因我沒有深究,但我把啟動的prcoess由bat改為exe就正常了:
使用的Arguments如下,請改成你自己對應路徑,我是echo bat內容複製貼上的:

-server -Xmx512M -Dcom.sun.management.jmxremote  -classpath ";D:\apache-sshd-1.2.0\scripts\..\lib\bcpg-jdk15on-1.54.jar;D:\apache-sshd-1.2.0\scripts\..\lib\bcpkix-jdk15on-1.54.jar;D:\apache-sshd-1.2.0\scripts\..\lib\bcprov-jdk15on-1.54.jar;D:\apache-sshd-1.2.0\scripts\..\lib\slf4j-api-1.7.16.jar;D:\apache-sshd-1.2.0\scripts\..\lib\slf4j-jdk14-1.7.16.jar;D:\apache-sshd-1.2.0\scripts\..\lib\sshd-core-1.2.0.jar;D:\apache-sshd-1.2.0\scripts\..\lib\tomcat-apr-5.5.23.jar" -Dsshd.home="D:\apache-sshd-1.2.0\scripts\.." org.apache.sshd.server.SshServer

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而產生的樣子..)

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的方式...