/
ExecuteGoalResult.ts
109 lines (94 loc) · 2.66 KB
/
ExecuteGoalResult.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/*
* Copyright © 2018 Atomist, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { SdmGoalState } from "../../typings/types";
/**
* Result from goal execution with additional details that will be
* persisted on the currently executing goal.
*/
export interface GoalDetails {
/**
* Optional description to be set on the goal
*/
description?: string;
/**
* Optional state for the goal
*/
state?: SdmGoalState;
/**
* Optional phase to return from the goal execution
*/
phase?: string;
/**
* Optional targetUrl to be set on the goal as externalUrl
* @deprecated use externalsUrls
*/
targetUrl?: string;
/**
* Optional targetUrls to be set on the goal as externalUrls
* @deprecated use externalsUrls
*/
targetUrls?: Array<{ label?: string, url: string}>;
/**
* Optional externalUrls to be set on the goal
*/
externalUrls?: Array<{ label?: string, url: string}>;
/**
* Optional flag to indicate if this goal requires approval now
* @deprecated use state = SdmGoalState.waiting_for_approval instead
*/
requireApproval?: boolean;
/**
* Update the goals data field
*/
data?: string;
}
/**
* Result from goal execution.
*
* Instead of returning ExecuteGoalResult, it is ok to throw an Error
* to signal errors during goal execution.
*/
export interface ExecuteGoalResult extends GoalDetails {
/**
* 0, undefined or null is success; non-zero exit codes will mark the goal as failed,
* if state is not defined
*/
code?: number;
/**
* The simple text message describing the result
*/
message?: string;
}
/**
* Assert if a given ExecuteGoalResult describe a successful result
* @param result
*/
export function isSuccess(result: ExecuteGoalResult | void): boolean {
if (result) {
if (!result.code) {
return true;
}
return false;
}
return true;
}
/**
* Assert if a given ExecuteGoalResult describe a failure result
* @param result
*/
export function isFailure(result: ExecuteGoalResult | void): boolean {
return !isSuccess(result);
}