Software Testing — Integrate PowerShell Remote Control Into Jenkins Freestyle Job

Introduction

最近需要用到Jenkins做Remote Control ，PowerShell輕便而且用途廣泛，在Windows上他是個很強力的工具，於是想到用PowerShell來進行控制。

PowerShell可以簡單地撰寫WinRM的操作 ，不過事前的設定有點繁雜 ，而且針對不同情形 ，遠端script的寫法也可以分為很多種 ，故寫下這篇做記錄。

Fundamental of writing a PowerShell scripts

在進入Remote Control前先介紹PowerShell的基本撰寫規則 ，包涵參數 ，字串格式化以及常使用的操作。

Parameters

PowerShell中以params定義參數列表 ，參數列表中可以指定參數類型 ，預設值 ，或是預設動作 ，例如在使用者未輸入該參數時丟出exception message或是跳出提示框要使用者輸入字串。

String format

PowerShell的格式化方式如下:

Basic usage: Check Windows User/Password is valid

Basic usage: Check Network connection type

Environment setting for PowerShell remote control

在進行Remote Control前有以下幾個步驟是要先進行的 ，分為server端(控制方)跟client端(被控制方):

server端

1.替目標機器建立使用者帳號及密碼。 2.Enable powerShell script for Windows:

%SystemRoot%\system32\WindowsPowerShell\v1.0\powershell.exe -command  "Set-ExecutionPolicy unrestricted -force"

3.設定網路環境: -關閉防火牆:

netsh advfirewall set allprofiles state off

-將connection type改為private或是work connection:

4.Enable PowerShell Remote ability:

%SystemRoot%\system32\WindowsPowerShell\v1.0\powershell.exe -command "Enable-PSRemoting -Force"

5.檢查細節:

6. 嘗試看看Remote Login。

client端

Enable PowerShell Remote ability:

%SystemRoot%\system32\WindowsPowerShell\v1.0\powershell.exe -command "Enable-PSRemoting -Force"

Remote Login

遠端登入在概念上有點像是Linux系統上的ssh ，需要條件為IP ，帳號及密碼 ，登入後就可以對該台機器進行操作。

成功登入後的畫面如下:

再輸入exit即可離開。

Remote control

除了登入外也可以遠端呼叫該機器上的script檔案 ，這邊分為執行.ps1及exe ，在分為是否使用start-process ，共四種情形 ，最後談談在Jenkins上Remote Control的執行情形。

1. Run powerShell script — use start-process

用start-process啟動powershell以執行.ps1 ，缺點是在某些使用上可能會hang住 ，作法如下:

2. Run PowerShell script- not use start-process

替代方式是直接在ScriptBlock呼叫當地的script，以個人的經驗來看 ，使用這種方式應該可以避免hang住的情形。

3. Run exe — use start-process

利用start-process來啟動執行檔 ，並指定參數 ，適用於不需要得到output的場景 ，缺點是在某些使用上可能會hang住。

如果需要得到output可以用以下的方式:

4. Run exe — not use start-process

Jenkins Freestyle tasks

在已裝好Jenkins為前提下 ，先建立一個Freestyle job ，再來將原本在params的參數都換成參數化建置中的參數 ，並寫入預設值。

這麼做在下次建置時就可以很方便的輸入參數:

接著本原來的程式碼中的params拿掉 ，而參數化建置的參數前是$env開頭 ， 如下所示:

Summary

謝謝你耐心地讀到Summary，我是Sean HS， 是位軟體工程師。 這片文章是我在研究過程時的筆記，若有錯誤之處，期待您的見解，與您交流討論。

Other topics

Software Testing

[Software as a Service] Modern APM & Logging Services

[DevOps] Ansible Provisioning for Windows: