使用Python訪問(wèn)CANoe COM接口實(shí)踐

CANoe提供的COM接口使得外部腳本能夠訪問(wèn)或控制CANoe軟件，從而實(shí)現(xiàn)自動(dòng)化測(cè)試任務(wù)，而易用且具有豐富生態(tài)的Python無(wú)疑是一個(gè)很好的選擇。本文將介紹CANoe COM基本構(gòu)成、常用COM對(duì)象以及Python腳本調(diào)用CANoe COM的方法，在此之前，先介紹一些基本概念。

CANoe COM Server & Python pywin32

COM全稱Component Object Model，是微軟為Windows平臺(tái)軟件提出的、實(shí)現(xiàn)軟件之間互操作的標(biāo)準(zhǔn)。它不會(huì)規(guī)定軟件的具體實(shí)現(xiàn)，而是聲明一種對(duì)象模型，使得滿足這種模型的對(duì)象之間能交互，這些對(duì)象通常被稱為組件（Component）。組件會(huì)實(shí)現(xiàn)特定的功能，而這些功能以特定的方式提供——即接口（Interface），其他組件通過(guò)接口使用它們。另外，組件需要經(jīng)過(guò)注冊(cè)（Registry），才能被其他軟件發(fā)現(xiàn)和使用。注冊(cè)后的組件向其他軟件提供服務(wù)，因此組件將作為服務(wù)端（COM Server），其他想要使用服務(wù)的作為客戶端（COM Client）。

在安裝完成CANoe軟件后，CANoe已經(jīng)在Windows組件服務(wù)管理器中注冊(cè)了CANoe COM Server，如果需要重新注冊(cè)，可以在安裝目錄下（默認(rèn)為C:\Program Files\Vector CANoe 14）的Exec64文件夾中找到RegisterComponents.exe，運(yùn)行即手動(dòng)注冊(cè)。

Python pywin32 package，它提供了許多Python擴(kuò)展以調(diào)用Windows API，其中就包括COM組件，由于Python腳本將使用CANoe COM提供的服務(wù)，因此Python腳本將作為COM Client，在pywin32包中就對(duì)應(yīng)win32com.client模塊，所以后續(xù)的Python腳本都要導(dǎo)入win32com.client模塊。

了解以上的概念后，下面就看看本文的主要內(nèi)容。

COM Object Hierarchy

在CANoe中，各個(gè)功能模塊按照一定的層級(jí)組織在一起構(gòu)成整個(gè)CANoe軟件。與這些功能模塊直接相關(guān)的COM組件同樣也是按照相應(yīng)的層級(jí)組織的，這就形成了COM Object Hierarchy：

如上圖所示，圖的最左側(cè)是Application對(duì)象，是訪問(wèn)其他對(duì)象的入口；通過(guò)它可以訪問(wèn)Configuration對(duì)象，而通過(guò)Configuration對(duì)象才能訪問(wèn)CommunicationSetup對(duì)象；要想設(shè)置CommunicationSetup，就需要按照Application->Configuration->CommunicationSetup從左向右的層級(jí)順序，找到相應(yīng)的屬性或是方法，從而實(shí)現(xiàn)設(shè)置。

Type Library

了解COM Object Hierarchy能幫助快速找到所需功能，但是不能知道實(shí)現(xiàn)所需功能對(duì)象的繼承關(guān)系，為此還需要了解CANoe Type Library。在CANoe軟件安裝目錄下（默認(rèn)為C:\Program Files\Vector CANoe 14）的Exec32\COMdev目錄中包含了注冊(cè)COM所用的類型庫(kù)，如下圖所示CANoe.h頭文件：

在CANoe.h頭文件中包含所有CANoe COM對(duì)象的接口定義，比如ITestConfiguration接口：

而如果想要設(shè)置TestConfigurationSettings對(duì)象，從COM Object Hierarchy得知需要從TestConfiguration對(duì)象訪問(wèn)：

但是在Type Library中Configuration對(duì)象有多個(gè)ITestConfiguration接口，比如：

可以看到，ITestConfiguration2繼承自ITestConfiguration，在它的基礎(chǔ)上又?jǐn)U充了許多方法，比如獲取TestConfigurationSettings對(duì)象的方法get_Settings就在其中。

也就是說(shuō)，要通過(guò)實(shí)現(xiàn)了ITestConfiguration2接口的TestConfiguration對(duì)象的get_Settings方法，才能獲得TestConfigurationSettings對(duì)象。

為此，通過(guò)win32com.client模塊中的CastTo方法，能將TestConfiguration轉(zhuǎn)換成基于ITestConfiguration2接口的對(duì)象。

COM Object

COM Object Hierarchy中有許多COM對(duì)象，短時(shí)間內(nèi)掌握所有COM對(duì)象是不現(xiàn)實(shí)的，下面僅針對(duì)常用的、與自動(dòng)化測(cè)試緊密相關(guān)的COM對(duì)象做介紹。

Application

使用Python控制CANoe，首先要獲取關(guān)聯(lián)整個(gè)CANoe進(jìn)程的COM對(duì)象，也就是Application對(duì)象。通過(guò)Dispatch方法就可以獲得關(guān)聯(lián)到當(dāng)前CANoe進(jìn)程的COM對(duì)象，如果當(dāng)前并沒(méi)有CANoe進(jìn)程，則會(huì)啟動(dòng)一個(gè)CANoe進(jìn)程；而如果想要另外獲得一個(gè)CANoe進(jìn)程，則可以使用DispatchEx方法。

下面是獲取Application對(duì)象的代碼示例：

在以上示例中，CANoe各部分功能封裝在CANoe類中，在CANoe類初始化時(shí)，把獲得的Application對(duì)象保存在CANoe類的App成員中，這樣在CANoe類的其他方法中，就可以通過(guò)使用App成員來(lái)訪問(wèn)Application對(duì)象。

有了Application對(duì)象，才能訪問(wèn)CANoe工程的各個(gè)功能模塊，比如打開CANoe工程：

而在open_canoe_config方法中，使用Application對(duì)象的Open方法打開特定的CANoe工程，具體Application對(duì)象的接口定義（這里僅展示IApplication的部分方法，其他方法以及后續(xù)擴(kuò)展的方法并未展示）如下：

Measurement

要想控制CANoe啟動(dòng)測(cè)量，就需要獲取Measurement對(duì)象，對(duì)于上面獲得的Application對(duì)象，使用self.App.Measurement獲得。

在Measurement對(duì)象的接口定義中，可以看到Start方法，使用Measurement.Start（）就能啟動(dòng)CANoe測(cè)量。

下面是啟動(dòng)CANoe測(cè)量的代碼示例：

System Variables

系統(tǒng)變量作為CANoe中重要的部分，要想獲取任意系統(tǒng)變量的值，就要獲取對(duì)應(yīng)系統(tǒng)變量的對(duì)象。

從COM Object Hierarchy中可以看到，系統(tǒng)變量Variable對(duì)象是按照Application->System->Namespaces->Namespace->Variables->Variable順序訪問(wèn)的。

其中Namespaces和Variables分別表示Namespace和Variable對(duì)象的集合，因此可以使用Namespace名稱（Variable名稱）作為索引，從Namespaces（Variables）中獲得相應(yīng)的Namespace（Variable）對(duì)象。

另外，在Variable對(duì)象的接口定義中，可以看到get_Value和put_Value方法，而Python將這兩種方法轉(zhuǎn)變成了Value屬性，也就是說(shuō)可以直接對(duì)Variable.Value取值或賦值。

下面是獲得系統(tǒng)變量值的代碼示例：

在以上示例中，添加了簡(jiǎn)單的異常處理可以暫且不看，僅考察if分支中的語(yǔ)句。首先，使用self.App.System.Namespaces獲得Namespaces對(duì)象，將其保存在system_namespaces變量中；然后使用剛保存的變量，以ns_name作為索引獲得Namespace對(duì)象并保存在sys_namespace變量中；再通過(guò)sysvar_name索引獲得Variable對(duì)象sys_variable，最后返回sys_variable.Value屬性值。

Test Configuration & Test Unit

與自動(dòng)化測(cè)試（這里僅介紹Test Configuration配置，即與vTESTstudio軟件聯(lián)合使用的自動(dòng)化測(cè)試）直接相關(guān)的就是Test Configuration以及Test Unit，前者對(duì)應(yīng)整個(gè)測(cè)試執(zhí)行的設(shè)置，后者包含具體執(zhí)行的測(cè)試用例。在COM Object Hierarchy中可以看到，它們的層級(jí)構(gòu)成為Application->Configuration->TestConfigurations->TestConfiguration->TestUnits->TestUnit：

其中，TestConfigurations與TestUnits跟前文類似，表示TestConfiguration和TestUnit的集合，同樣可以通過(guò)索引訪問(wèn)。除了可以使用相應(yīng)TestConfiguration（TestUnit）名稱作為索引以外，還能使用數(shù)字索引，但是切記索引起始為1。對(duì)于僅有一個(gè)TestConfiguration的情況，僅需要TestConfigurations(1)來(lái)獲得唯一的TestConfiguration對(duì)象。

當(dāng)CANoe工程中還沒(méi)有TestConfiguration或者TestUnit時(shí)，就需要先添加。查看它們的接口定義：

可以看到Add方法能添加相應(yīng)的對(duì)象，對(duì)于TestConfigurations.Add（）不需要其他參數(shù)，即可添加并獲得新的TestConfiguration對(duì)象；而TestUnits.Add（）需要提供所要添加的TestUnit的絕對(duì)路徑，同樣可以獲得對(duì)應(yīng)的TestUnit對(duì)象。另外值得注意的是，TestUnits的Add方法是在ITestUnits2接口上擴(kuò)展的，所以要通過(guò)前文所述的CastTo方法將TestUnits（默認(rèn)為基于ITestUnits接口）轉(zhuǎn)換成基于ITestUnits2的對(duì)象。

下面請(qǐng)看加載測(cè)試配置的代碼示例：

在以上示例中，首先通過(guò)TestConfigurations.Add（）方法新添加一個(gè)TestConfiguration對(duì)象，并把它保存為類成員self.test_config；之后使用CastTo方法將新添加的TestConfiguration中的TestUnits對(duì)象轉(zhuǎn)換成基于ITestUnits2接口的TestUnits對(duì)象（默認(rèn)為ITestUnits接口）；最后使用轉(zhuǎn)換后的TestUnits對(duì)象的Add方法，添加test_unit_path路徑下的測(cè)試單元（.vtuexe文件）。

加載測(cè)試配置后，還需要啟動(dòng)測(cè)試執(zhí)行，查看ITestConfiguration接口定義，可以發(fā)現(xiàn)Start方法：

下面是執(zhí)行測(cè)試的代碼示例（這里使用了之前保存的類成員self.test_config）：

執(zhí)行完測(cè)試后，需要獲得測(cè)試結(jié)果，可以通過(guò)CANoe軟件為Test Configuration創(chuàng)建的系統(tǒng)變量VerdictSummary查看：

下面是獲得測(cè)試結(jié)果的代碼示例：

這里get_test_result方法有一個(gè)帶有默認(rèn)值的參數(shù)test_config_name表示實(shí)際執(zhí)行測(cè)試的TestConfiguration名稱，它的默認(rèn)值是Test_Configuration_1，如果沒(méi)有修改過(guò)就不需要提供參數(shù)，否則需要提供；get_test_result返回保存在VerdictSummary中的測(cè)試結(jié)果，其數(shù)據(jù)類型是整型，需要在接口定義中查詢具體數(shù)值對(duì)應(yīng)的結(jié)果：

Test demo

聯(lián)合使用上述COM對(duì)象就能夠?qū)崿F(xiàn)自動(dòng)化測(cè)試，下面展示完整的代碼示例：

基于Canoe類，就可以通過(guò)實(shí)例化Canoe類，調(diào)用實(shí)例對(duì)象的方法來(lái)實(shí)現(xiàn)自動(dòng)化測(cè)試，下面是簡(jiǎn)單的代碼示例：

首先，實(shí)例化Canoe類，將實(shí)例化后的對(duì)象保存在canoe變量中；之后定義了canoePrj變量表示CANoe工程的絕對(duì)路徑，然后使用open_canoe_config方法打開此工程；接著定義testPrj變量表示測(cè)試單元可執(zhí)行文件的絕對(duì)路徑，使用load_test_config方法加載測(cè)試單元；然后使用start_canoe方法啟動(dòng)CANoe測(cè)量，等待2s后，使用run_test_config方法執(zhí)行測(cè)試，等待10s后測(cè)試停止；最后打印通過(guò)get_test_result方法獲得的測(cè)試結(jié)果。

這里使用了Vector CANoe 14自帶的PythonBasicEmpty.cfg demo工程作為測(cè)試工程，下面是關(guān)于此demo的介紹文檔：

這個(gè)demo中有更豐富的COM對(duì)象的應(yīng)用、更完善的信息提示，比如對(duì)測(cè)試啟動(dòng)、停止等事件的控制，對(duì)CANoe運(yùn)行狀態(tài)的打印，在此不再贅述。

最后，運(yùn)行以上腳本后，可以獲得自動(dòng)化測(cè)試結(jié)果，對(duì)照前文的VerdictState，可以確定測(cè)試通過(guò)：

總結(jié)

本文介紹了使用Python訪問(wèn)CANoe COM以實(shí)現(xiàn)自動(dòng)化測(cè)試的基本方法，通過(guò)幾個(gè)常用的COM對(duì)象及方法，構(gòu)建了簡(jiǎn)單的自動(dòng)化測(cè)試示例工程。對(duì)于更復(fù)雜的工程，同樣可以根據(jù)基本方法，靈活運(yùn)用COM以滿足測(cè)試需求。進(jìn)一步，可以將CANoe COM封裝成Python庫(kù)，利用可復(fù)用性高效地完成針對(duì)不同需求的自動(dòng)化測(cè)試。

CANoe是德國(guó)Vector公司出的一款總線開發(fā)環(huán)境，是網(wǎng)絡(luò)和ECU開發(fā)、測(cè)試和分析的專業(yè)工具，支持從需求分析到系統(tǒng)實(shí)現(xiàn)的整個(gè)系統(tǒng)開發(fā)過(guò)程；其豐富的功能和配置選項(xiàng)被OEM和供應(yīng)商的網(wǎng)絡(luò)設(shè)計(jì)工程師、開發(fā)工程師和測(cè)試工程師所廣泛使用。

北匯信息作為Vector中國(guó)的合作伙伴，不僅提供相應(yīng)的工具和技術(shù)支持服務(wù)及培訓(xùn)，還針對(duì)不同的應(yīng)用提供相應(yīng)的解決方案，助力中國(guó)客戶的研發(fā)效率提升。

注：本文部分圖片來(lái)自Vector。