-
Notifications
You must be signed in to change notification settings - Fork 13
/
reservation.go
208 lines (176 loc) · 5.59 KB
/
reservation.go
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
package provision
import (
"bytes"
"encoding/json"
"fmt"
"strconv"
"strings"
"time"
"github.com/pkg/errors"
"github.com/threefoldtech/tfexplorer/models/generated/workloads"
)
// ReservationType type
type ReservationType string
// Reservation struct
type Reservation struct {
// ID of the reservation
ID string `json:"id"`
// NodeID of the node where to deploy this reservation
NodeID string `json:"node_id"`
// Identification of the user requesting the reservation
User string `json:"user_id"`
// Type of the reservation (container, zdb, vm, etc...)
Type ReservationType `json:"type"`
// Data is the reservation type arguments.
Data json.RawMessage `json:"data,omitempty"`
// Date of creation
Created time.Time `json:"created"`
// Duration of the reservation
Duration time.Duration `json:"duration"`
// Signature is the signature to the reservation
// it contains all the field of this struct except the signature itself and the Result field
Signature []byte `json:"signature,omitempty"`
// This flag is set to true when a reservation needs to be deleted
// before its expiration time
ToDelete bool `json:"to_delete"`
// Tag object is mainly used for debugging.
Tag Tag `json:"-"`
// Reference is a pointer to an existing reservation
// this is used to allow a new type of workload to point to an existing one
// so the provision engine know both are linked
Reference string `json:"reference"`
Result Result `json:"result"`
Version int `json:"version"`
}
// AppendTag appends tags
func AppendTag(t, n Tag) Tag {
if t == nil {
t = Tag{}
}
for k, v := range n {
t[k] = v
}
return t
}
// Tag is custom tag to mark certain reservations
type Tag map[string]string
func (t Tag) String() string {
var builder strings.Builder
for k, v := range t {
if builder.Len() != 0 {
builder.WriteString(", ")
}
builder.WriteString(k)
builder.WriteString(": ")
builder.WriteString(v)
}
return builder.String()
}
//SplitID gets the reservation part and the workload part from a full reservation ID
func (r *Reservation) SplitID() (reservation uint64, workload uint64, err error) {
parts := strings.SplitN(r.ID, "-", 2)
if len(parts) != 2 {
return reservation, workload, fmt.Errorf("invalid reservation id format (wront length)")
}
reservation, err = strconv.ParseUint(parts[0], 10, 64)
if err != nil {
return reservation, workload, errors.Wrap(err, "invalid reservation id format (reservation part)")
}
workload, err = strconv.ParseUint(parts[1], 10, 64)
if err != nil {
return reservation, workload, errors.Wrap(err, "invalid reservation id format (workload part)")
}
return
}
// Expired returns a boolean depending if the reservation
// has expire or not at the time of the function call
func (r *Reservation) Expired() bool {
expire := r.Created.Add(r.Duration)
return time.Now().After(expire)
}
func (r *Reservation) validate() error {
// TODO: during testnet phase seems we don't need to verify this
// if err := Verify(r); err != nil {
// log.Warn().
// Err(err).
// Str("id", string(r.ID)).
// Msg("verification of reservation signature failed")
// return errors.Wrapf(err, "verification of reservation %s signature failed", r.ID)
// }
if r.Duration <= 0 {
return fmt.Errorf("reservation %s has not duration", r.ID)
}
if r.Created.IsZero() {
return fmt.Errorf("wrong creation date in reservation %s", r.ID)
}
if r.Expired() {
return fmt.Errorf("reservation %s has expired", r.ID)
}
return nil
}
// ResultState type
type ResultState workloads.ResultStateEnum
const (
// StateError constant
StateError = ResultState(workloads.ResultStateError)
// StateOk constant
StateOk = ResultState(workloads.ResultStateOK)
//StateDeleted constant
StateDeleted = ResultState(workloads.ResultStateDeleted)
)
func (s ResultState) String() string {
return workloads.ResultStateEnum(s).String()
}
// Result is the struct filled by the node
// after a reservation object has been processed
type Result struct {
Type ReservationType `json:"type"`
//Reservation ID
ID string `json:"id"`
// Time when the result is sent
Created time.Time `json:"created"`
// State of the deployment (ok,error)
State ResultState `json:"state"`
// if State is "error", then this field contains the error
// otherwise it's nil
Error string `json:"message"`
// Data is the information generated by the provisioning of the workload
// its type depend on the reservation type
Data json.RawMessage `json:"data_json"`
// Signature is the signature to the result
// is generated by signing the bytes returned from call to Result.Bytes()
// and hex
Signature string `json:"signature"`
}
// IsNil checks if Result is the zero values
func (r *Result) IsNil() bool {
// ideally this should be implemented like this
// emptyResult := Result{}
// return reflect.DeepEqual(r, &emptyResult)
//
// but unfortunately, the empty Result coming from the explorer already have some fields set
// (like the type)
// so instead we gonna check the Data and the Created filed
return (r.Created.Equal(epoch) || r.Created.Equal(nullTime)) && (len(r.Data) == 0 || bytes.Equal(r.Data, nullRaw))
}
var (
//emptyResult is the Result zero value
epoch = time.Unix(0, 0)
nullTime = time.Time{}
nullRaw, _ = json.Marshal(nil)
)
// Bytes returns a slice of bytes container all the information
// used to sign the Result object
func (r *Result) Bytes() ([]byte, error) {
buf := &bytes.Buffer{}
if err := buf.WriteByte(byte(r.State)); err != nil {
return nil, err
}
if _, err := buf.WriteString(r.Error); err != nil {
return nil, err
}
if _, err := buf.Write(r.Data); err != nil {
return nil, err
}
return buf.Bytes(), nil
}