| OLD | NEW |
| 1 syntax = "proto3"; | 1 syntax = "proto3"; |
| 2 | 2 |
| 3 package recipe_engine; | 3 package recipe_engine; |
| 4 | 4 |
| 5 import "package.proto"; | 5 import "package.proto"; |
| 6 | 6 |
| 7 // The result of a recipe execution. | 7 // The result of a recipe execution. |
| 8 message Result { | 8 message Result { |
| 9 oneof oneof_result { | 9 oneof oneof_result { |
| 10 // The json result of a recipe. Guaranteed to be a JSON 'object' (e.g. | 10 // The json result of a recipe. Guaranteed to be a JSON 'object' (e.g. |
| (...skipping 10 matching lines...) Expand all Loading... |
| 21 | 21 |
| 22 message Failure { | 22 message Failure { |
| 23 // A reason readable by humans. Printed to the UI, and will be seen by users. | 23 // A reason readable by humans. Printed to the UI, and will be seen by users. |
| 24 string human_reason = 1; | 24 string human_reason = 1; |
| 25 | 25 |
| 26 // The cause of this failure. | 26 // The cause of this failure. |
| 27 oneof failure_type { | 27 oneof failure_type { |
| 28 // Step timed out. | 28 // Step timed out. |
| 29 Timeout timeout = 2; | 29 Timeout timeout = 2; |
| 30 | 30 |
| 31 // Step threw an exception. | 31 // Recipe engine threw an exception. |
| 32 Exception exception = 3; | 32 Exception exception = 3; |
| 33 | 33 |
| 34 // A recipe threw an exception. |
| 35 RecipeException recipe_exception = 6; |
| 36 |
| 34 // Step accessed invalid step data. | 37 // Step accessed invalid step data. |
| 35 StepData step_data = 4; | 38 StepData step_data = 4; |
| 36 | 39 |
| 37 // Step failed (return code not ok). | 40 // Step failed (return code not ok). |
| 38 StepFailure failure = 5; | 41 StepFailure failure = 5; |
| 39 } | 42 } |
| 40 } | 43 } |
| 41 | 44 |
| 42 // An unexpected exception occured during execution. Caused by the builtin | 45 // Recipe engine raised an unexpected exception during execution. |
| 43 // Exception class. | 46 // Caused by the builtin Exception class. |
| 44 message Exception { | 47 message Exception { |
| 45 // Traceback of an exception which occured. | 48 // Traceback of an exception which occured. |
| 46 repeated string traceback = 1; | 49 repeated string traceback = 1; |
| 47 } | 50 } |
| 48 | 51 |
| 52 // A recipe raised an unexpected exception during execution. |
| 53 // Caused by the builtin Exception class. |
| 54 message RecipeException { |
| 55 // Traceback of an exception which occured. |
| 56 repeated string traceback = 1; |
| 57 } |
| 58 |
| 49 // A step timed out during its execution. Caused by StepTimeout in | 59 // A step timed out during its execution. Caused by StepTimeout in |
| 50 // recipe_api.py | 60 // recipe_api.py |
| 51 message Timeout { | 61 message Timeout { |
| 52 // The timeout set for the step. | 62 // The timeout set for the step. |
| 53 float timeout_s = 1; | 63 float timeout_s = 1; |
| 54 } | 64 } |
| 55 | 65 |
| 56 // A step attempted to access data which did not exist. Caused by | 66 // A step attempted to access data which did not exist. Caused by |
| 57 // StepDataAttributeError in types.py. | 67 // StepDataAttributeError in types.py. |
| 58 message StepData { | 68 message StepData { |
| 59 // The step which attempted to access invalid data. | 69 // The step which attempted to access invalid data. |
| 60 string step = 1; | 70 string step = 1; |
| 61 } | 71 } |
| 62 | 72 |
| 63 // A step failed to execute "correctly". Correct generally is indicated by a | 73 // A step failed to execute "correctly". Correct generally is indicated by a |
| 64 // return code of 0, but the step can allow for other return codes as well. | 74 // return code of 0, but the step can allow for other return codes as well. |
| 65 message StepFailure { | 75 message StepFailure { |
| 66 // The step which failed. | 76 // The step which failed. |
| 67 string step = 1; | 77 string step = 1; |
| 68 } | 78 } |
| 69 | 79 |
| OLD | NEW |