[cutter-commit 04423] clear-code/cutter@41fb686 [master] doc: update XML report format

[Kouhei S. <nul...@cl...>]

Kouhei Sutou	2013-11-12 12:53:19 +0900 (Tue, 12 Nov 2013)

  New Revision: 41fb6862e930130a89f85db9aad254586623dabd
  https://github.com/clear-code/cutter/commit/41fb6862e930130a89f85db9aad254586623dabd

  Message:
    doc: update XML report format
    
    [cutter-users-ja:91]
    
    Reported by Siganai SE. Thanks!!!

  Modified files:
    README
    README.ja

  Modified: README (+14 -4)
===================================================================
--- README    2013-11-07 12:01:16 +0900 (f80b091)
+++ README    2013-11-12 12:53:19 +0900 (e33bed4)
@@ -205,23 +205,32 @@ option is specified. A reported XML has the following
 structure:
 
   <report>
+    <!-- "result" tag is generated for a test result.
+          Normally, a "result" tag is generated for a test.
+          If you use cut_message(), you will get two or more "result" tags
+          for a test. -->
     <result>
       <test-case>
         <name>TEST CASE NAME</name>
         <description>DESCRIPTION OF TEST CASE (if exists)</description>
+        <start-time>START TIME OF TEST CASE (ISO 8601 format) [e.g.: 2013-11-12T03:32:56.691676Z]</start-time>
+        <elapsed>ELAPSED TIME OF TEST CASE (in seconds) [e.g.: 0.030883]</elapsed>
       </test-case>
       <test>
         <name>TEST NAME</name>
         <description>DESCRIPTION OF TEST CASE (if exists)</description>
+        <start-time>START TIME OF TEST (ISO 8601 format) [e.g.: 2013-11-12T03:32:56.691823Z]</start-time>
+        <elapsed>ELAPSED TIME OF TEST (in seconds) [e.g.: 0.030883]</elapsed>
         <option><!-- ATTRIBUTE INFORMATION (if exists) -->
-          <name>ATTRIBUTE NAME (e.g.: bug)</name>
-          <value>ATTRIBUTE VALUE (e.g.: 1234)</value>
+          <name>ATTRIBUTE NAME [e.g.: bug]</name>
+          <value>ATTRIBUTE VALUE [e.g.: 1234]</value>
         </option>
         <option>
           ...
         </option>
+        ...
       </test>
-      <status>TEST RESULT ([success|failure|error|pending|notification])</status>
+      <status>TEST RESULT (one of them: success, notification, omission, pending, failure, error, crash)</status>
       <detail>DETAIL OF TEST RESULT (if exists)</detail>
       <backtrace><!-- BACKTRACE (if exists) -->
         <entry>
@@ -233,7 +242,8 @@ structure:
           ...
         </entry>
       </backtrace>
-      <elapsed>ELAPSED TIME (e.g.: 0.000010)</elapsed>
+      <start-time>START TIME OF TEST (ISO 8601 format) [e.g.: 2013-11-12T03:32:56.691823Z]</start-time>
+      <elapsed>ELAPSED TIME OF TEST (in seconds) [e.g.: 0.030883]</elapsed>
     </result>
     <result>
       ...

  Modified: README.ja (+13 -4)
===================================================================
--- README.ja    2013-11-07 12:01:16 +0900 (61aaca6)
+++ README.ja    2013-11-12 12:53:19 +0900 (6effccf)
@@ -216,23 +216,31 @@ test_test_case_count()関数内で起こったことがわかります。
 います。
 
   <report>
+    <!-- テスト結果毎にresultタグを出力する。
+         通常は1つのテストにつき1つだが、
+         cut_message()を使うと1つのテストにつき複数のテスト結果が含まれる。 -->
     <result>
       <test-case>
         <name>テストケース名</name>
         <description>テストケースの説明（もしあれば）</description>
+        <start-time>テストケースの開始時間（ISO 8601形式）[例：2013-11-12T03:32:56.691676Z]</start-time>
+        <elapsed>テストケースの実行時間（単位は秒）[例：0.030883]</elapsed>
       </test-case>
       <test>
         <name>テスト名</name>
         <description>テストの説明（もしあれば）</description>
+        <start-time>テストの開始時間（ISO 8601形式）[例：2013-11-12T03:32:56.691823Z]</start-time>
+        <elapsed>テストの実行時間（単位は秒）[例：0.030883]</elapsed>
         <option><!-- 属性情報（もしあれば） -->
-          <name>属性名（例: bug）</name>
-          <value>属性値（例: 1234）</value>
+          <name>属性名[例：bug]</name>
+          <value>属性値[例：1234]</value>
         </option>
         <option>
           ...
         </option>
+        ...
       </test>
-      <status>テスト結果（[success|failure|error|pending|notification]）</status>
+      <status>テスト結果（次のうちのどれか：success, notification, omission, pending, failure, error, crash）</status>
       <detail>テスト結果の詳細（もしあれば）</detail>
       <backtrace><!-- バックトレース（もしあれば） -->
         <entry>
@@ -244,7 +252,8 @@ test_test_case_count()関数内で起こったことがわかります。
           ...
         </entry>
       </backtrace>
-      <elapsed>実行時間（例: 0.000010）</elapsed>
+      <start-time>テストの開始時間（ISO 8601形式）[例：2013-11-12T03:32:56.691823Z]</start-time>
+      <elapsed>テストの実行時間（単位は秒）[例：0.030883]</elapsed>
     </result>
     <result>
       ...