處理不必要的Log

SeleniumLibrary某些Keyword，有提供loglevel的參數；在發生錯誤時，會將所有的網頁內容抓下來。當你有做retry時，或沒有做retry，這log的量都非常可觀，甚至可能讓你out of memory。然而，並非每個開發人員都會注意到這點。因此我希望能透過工具或程式化的偵測方式，去找出這些問題並修改。

處理純文字檔的方式比較簡單，但不幸地，我們使用html的原始檔，也造成判別上比較困難些。慶幸的是，Robot在html的格式上，有固定規則: 一個tr包含5個td，而主要內容由第二個td開始。因此，我們只要針對要處理的keyword，分別在其它四個位置所造成影響，做整理與探討。

目前我所使用的偵測方式是Eclipse的File Search with Regular Expression :


以下是我針對參數數量所做的分類: (可以參考官方文件，確認你的測試中所用的keywords，哪些有支援loglevel的參數)

以下圖為例，包含六個不必要的log，


我們要處理的情況，包含五種樣式:

Keyword與參數皆在同一行，代表著Keyword被放在第二或第三的位置，而第四或第五則為空:

<tr>
<td class="name"></td>
<td>Page Should Contain</td>
<td>${text}</td>
<td></td>
<td></td>
</tr>

語法只要定義為${text}後的loglevel為空即可:

<td>Page Should Contain</td>\s<td>.+</td>\s<td></td>

在無內縮情況下，Keyword被放在第五個位置，因此參數text會跑到下一行的第三位置(第二位置為…)，第四位置為空:

<tr>
<td class="name"></td>
<td>Run Keyword If</td>
<td>${cond}</td>
<td>Run Keyword And Ignore Error</td>
<td>Page Should Contain</td>
</tr>
<tr>
<td class="name"></td>
<td>...</td>
<td>${text}</td>
<td></td>
<td></td>
</tr>

由於${text}在下一行，所以語法要將樣式A的調整為，下一行${text}後的loglevel為空即可:

<td>Page Should Contain</td>\s</tr>\s<tr>\s<td class="name"></td>\s<td>...</td>\s<td>.+</td>\s<td></td>

在無內縮情況下，Keyword被放在第四個位置，第五位置為text:

<tr>
<td class="name"></td>
<td>Run Keyword If</td>
<td>${cond}</td>
<td>Page Should Contain</td>
<td>${text}</td>
</tr>

由於在有設定loglevel的情況下，必會在下一行，所以語法使用不包含的方式去做偵測:

<td>.+</td>\s<td>.+</td>\s<td>Page Should Contain</td>\s<td>.+</td>\s</tr>(?!\s<tr>\s<td class="name"></td>\s<td>...</td>\s<td>NONE</td>)$

在有内縮的情況下，Keyword被放在第四個位置，第五位置為text:

<tr>
<td class="name"></td>
<td></td>
<td>Run Keyword And Ignore Error</td>
<td>Page Should Contain</td>
<td>${text}</td>
</tr>

由於在有設定loglevel的情況下，必會在下一行，所以語法使用不包含的方式去做偵測；與樣式C最大差異在於有内縮情況下，Keyword那行與loglevel那行都會有一個空格，因此語法有些微調整:

<td></td>\s<td>.+</td>\s<td>Page Should Contain</td>\s<td>.+</td>\s</tr>(?!\s<tr>\s<td class="name"></td>\s<td></td>\s<td>...</td>\s<td>NONE</td>)$

在有内縮的情況下，Keyword被放在第五個位置，因此參數text會跑到下一行的第四位置，第五位置為空:

<tr>
<td class="name"></td>
<td></td>
<td>Run Keyword If</td>
<td>${cond}</td>
<td>Page Should Contain</td>
</tr>
<tr>
<td class="name"></td>
<td></td>
<td>...</td>
<td>${text}</td>
<td></td>
</tr>

與樣式A類似，主要區別是語法要定義為兩行的顯示方式:

<td></td>\s<td>.+</td>\s<td>.+</td>\s<td>Page Should Contain</td>\s</tr>\s<tr>\s<td class="name"></td>\s<td></td>\s<td>...</td>\s<td>.+</td>\s<td></td>

由於A、B、E的修改方式相同，因此我將偵測方式調整為一種:

<td>Page Should Contain</td>\s(</tr>\s<tr>\s<td class="name"></td>\s(<td></td>\s)?<td>...</td>\s<td>.+</td>\s<td></td>|<td>.+</td>\s<td></td>)

依照html修改方法，分成三類: (1) 在已有的<td> - loglevel欄位填入NONE；(2) 在內縮區塊，必須額外插入<tr>；(3) 在無內縮區塊，必須額外插入<tr>:

由於偵測時都是針對${text}之後的loglevel為空白，因此我們只要將loglevel那欄改為NONE即可:

<!-- 修改前 -->
<tr>
<td class="name"></td>
<td>Page Should Contain</td>
<td>${text}</td>
<td></td>
<td></td>
</tr>
<!-- 修改後 -->
<tr>
<td class="name"></td>
<td>Page Should Contain</td>
<td>${text}</td>
<td>NONE</td>
<td></td>
</tr>

第二種情況必須視第一個區塊<td>數量，去加入新的<tr>與對應的<td>:

<!-- 修改前 -->
<tr>
<td class="name"></td>
<td>Run Keyword If</td>
<td>${col_count} == 0</td>
<td>Page Should Contain</td>
<td>Not Available</td>
</tr>
<!-- 插入下方區塊 -->
<tr>
<td class="name"></td>
<td>...</td>
<td>NONE</td>
<td></td>
<td></td>
</tr>

To Do

與Page Should Contain比較起來，在於Keyword多一個參數。因此要做小小的調整:

<td>Page Should (Not )?Contain Element</td>\s<td>.*</td>\s(<td></td>|</tr>(?!\s<tr>\s<td class="name"></td>\s<td>...</td>\s<td>NONE</td>)$)

直接修改網頁的方式，第一種情況只要直接加上NONE即可:

<!-- 修改前 -->
<tr>
<td class="name"></td>
<td>Page Should Contain Element</td>
<td>//span[text()='test']</td>
<td>MSG</td>
<td></td>
</tr>
<!-- 修改後 -->
<tr>
<td class="name"></td>
<td>Page Should Contain Element</td>
<td>//span[text()='test']</td>
<td>MSG</td>
<td>NONE</td>
</tr>

---