commit 2ad5adb7423a11bf78e65de752d977e7f00e8037
author Aviv Keshet <akeshet@chromium.org> Thu Sep 12 17:35:47 2019 -0700
committer Commit Bot <commit-bot@chromium.org> Fri Sep 13 23:54:29 2019 +0000
tree b194f30d9763c595d496b94f6e2f30f37f1558d0
parent 94768cd918f5523b680dd1658540792dfcba4225

test_platform: add documentation to TaskState.Verdict

BUG=None
TEST=None

Change-Id: I3eb2995765ed89223b52bbe6ac59a98efb63aaa0
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/infra/proto/+/1802370
Tested-by: Aviv Keshet <akeshet@chromium.org>
Auto-Submit: Aviv Keshet <akeshet@chromium.org>
Commit-Queue: Alex Zamorzaev <zamorzaev@chromium.org>
Reviewed-by: Alex Zamorzaev <zamorzaev@chromium.org>

go/test_platform/taskstate.pb.go

diff --git a/go/test_platform/taskstate.pb.go b/go/test_platform/taskstate.pb.go
index 215d19e..a686db4 100644
--- a/go/test_platform/taskstate.pb.go
+++ b/go/test_platform/taskstate.pb.go
@@ -104,10 +104,22 @@
 type TaskState_Verdict int32
 
 const (
+	// The task produced no usable verdict (possibly because it never
+	// ran, or never finished, or the results were unparseable).
+	//
+	// Under most circumstances, this should be treated as a failure or
+	// an infrastructure failure.
 	TaskState_VERDICT_UNSPECIFIED TaskState_Verdict = 0
-	TaskState_VERDICT_PASSED      TaskState_Verdict = 1
-	TaskState_VERDICT_FAILED      TaskState_Verdict = 2
-	TaskState_VERDICT_NO_VERDICT  TaskState_Verdict = 3
+	// The task produced a definitive verdict: it passed.
+	TaskState_VERDICT_PASSED TaskState_Verdict = 1
+	// The task produced a definitive verdict: it failed.
+	TaskState_VERDICT_FAILED TaskState_Verdict = 2
+	// The task definitively produced no verdict (for instance, because
+	// the test is irrelevant in the given environment).
+	//
+	// Under most circumstances, this should be treated as a passing
+	// (but uninteresting).
+	TaskState_VERDICT_NO_VERDICT TaskState_Verdict = 3
 )
 
 var TaskState_Verdict_name = map[int32]string{

src/test_platform/taskstate.proto

diff --git a/src/test_platform/taskstate.proto b/src/test_platform/taskstate.proto
index ee4de4c..688a97a 100644
--- a/src/test_platform/taskstate.proto
+++ b/src/test_platform/taskstate.proto
@@ -46,9 +46,21 @@
     LifeCycle life_cycle = 1;
 
     enum Verdict {
+        // The task produced no usable verdict (possibly because it never
+        // ran, or never finished, or the results were unparseable).
+        //
+        // Under most circumstances, this should be treated as a failure or
+        // an infrastructure failure.
         VERDICT_UNSPECIFIED = 0;
+        // The task produced a definitive verdict: it passed.
         VERDICT_PASSED = 1;
+        // The task produced a definitive verdict: it failed.
         VERDICT_FAILED = 2;
+        // The task definitively produced no verdict (for instance, because
+        // the test is irrelevant in the given environment).
+        //
+        // Under most circumstances, this should be treated as a passing
+        // (but uninteresting).
         VERDICT_NO_VERDICT = 3;
     }