/
client.go
209 lines (188 loc) · 6.08 KB
/
client.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
209
/*
* === This file is part of ALICE O² ===
*
* Copyright 2018 CERN and copyright holders of ALICE O².
* Author: Teo Mrnjavac <teo.mrnjavac@cern.ch>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* In applying this license CERN does not waive the privileges and
* immunities granted to it by virtue of its status as an
* Intergovernmental Organization or submit itself to any jurisdiction.
*/
// Package executorcmd contains the gRPC client, as well as facilities
// for processing and committing incoming transition events.
package executorcmd
import (
"context"
"errors"
"fmt"
"os/exec"
"strconv"
"time"
"github.com/AliceO2Group/Control/common/logger/infologger"
"github.com/AliceO2Group/Control/executor/executorcmd/nopb"
"google.golang.org/grpc"
"google.golang.org/grpc/backoff"
"github.com/AliceO2Group/Control/common/controlmode"
"github.com/AliceO2Group/Control/executor/executorcmd/transitioner"
pb "github.com/AliceO2Group/Control/executor/protos"
"github.com/sirupsen/logrus"
"google.golang.org/grpc/status"
)
type ControlTransport uint32
const (
ProtobufTransport = ControlTransport(0)
JsonTransport = ControlTransport(1)
)
const GRPC_DIAL_TIMEOUT = 30 * time.Second
func NewClient(
controlPort uint64,
controlMode controlmode.ControlMode,
controlTransport ControlTransport,
log *logrus.Entry,
) *RpcClient {
endpoint := fmt.Sprintf("127.0.0.1:%d", controlPort)
controlTransportS := "Protobuf"
if controlTransport == JsonTransport {
controlTransportS = "JSON"
}
cxt, cancel := context.WithTimeout(context.Background(), GRPC_DIAL_TIMEOUT)
conn, err := grpc.DialContext(cxt, endpoint, grpc.WithInsecure(), grpc.WithBlock(), grpc.WithReturnConnectionError(), grpc.WithConnectParams(grpc.ConnectParams{
Backoff: backoff.Config{
BaseDelay: 200 * time.Millisecond,
Multiplier: 1.1,
Jitter: 0.02,
MaxDelay: GRPC_DIAL_TIMEOUT,
},
MinConnectTimeout: 5 * time.Second,
}))
if err != nil {
log.WithField("error", err.Error()).
WithField("endpoint", endpoint).
WithField("transport", controlTransportS).
WithField("level", infologger.IL_Trace).
Error("gRPC client can't dial")
log.WithField("error", err.Error()).
WithField("endpoint", endpoint).
WithField("level", infologger.IL_Ops).
Error("AliECS executor could not connect to task, possible crash on startup")
cancel()
if conn != nil {
log.WithField("endpoint", endpoint).
WithField("transport", controlTransportS).
Warn("gRPC client connection failure: cleaning up leftover connection")
_ = conn.Close()
}
return nil
} else {
log.WithField("endpoint", endpoint).
WithField("transport", controlTransportS).
Debug("gRPC client dial successful")
}
var occClient pb.OccClient
if controlTransport == JsonTransport {
occClient = nopb.NewOccClient(conn)
} else {
occClient = pb.NewOccClient(conn)
}
client := &RpcClient{
OccClient: occClient,
conn: conn,
}
client.Transitioner = transitioner.NewTransitioner(controlMode, client.doTransition)
client.Log = log
return client
}
type RpcClient struct {
pb.OccClient
conn *grpc.ClientConn
Transitioner transitioner.Transitioner
TaskCmd *exec.Cmd
Log *logrus.Entry
}
func (r *RpcClient) Close() error {
if r != nil && r.conn != nil {
return r.conn.Close()
}
return nil
}
func (r *RpcClient) FromDeviceState(state string) string {
return r.Transitioner.FromDeviceState(state)
}
func (r *RpcClient) doTransition(ei transitioner.EventInfo) (newState string, err error) {
r.Log.WithField("event", ei.Evt).
Debug("executor<->occplugin interface requesting transition")
var response *pb.TransitionReply
argsToPush := func() (cfg []*pb.ConfigEntry) {
cfg = make([]*pb.ConfigEntry, 0)
if len(ei.Args) == 0 {
return
}
for k, v := range ei.Args {
cfg = append(cfg, &pb.ConfigEntry{Key: k, Value: v})
r.Log.WithField("key", k).
WithField("value", v).
Trace("pushing argument")
}
return
}()
response, err = r.Transition(context.TODO(), &pb.TransitionRequest{
TransitionEvent: ei.Evt,
Arguments: argsToPush,
SrcState: ei.Src,
}, grpc.EmptyCallOption{})
if err != nil {
status, ok := status.FromError(err)
if ok {
r.Log.WithFields(logrus.Fields{
"code": status.Code().String(),
"message": status.Message(),
"details": status.Details(),
"error": status.Err().Error(),
"level": infologger.IL_Devel,
}).
Error("transition call error")
err = errors.New(fmt.Sprintf("occplugin returned %s: %s", status.Code().String(), status.Message()))
} else {
err = errors.New("invalid gRPC status")
r.Log.WithField("error", "invalid gRPC status response received from occplugin").
WithField("level", infologger.IL_Support).
Error("transition call error")
}
return
}
taskId, _ := r.Log.Data["id"]
if response != nil &&
response.GetOk() &&
response.GetTrigger() == pb.StateChangeTrigger_EXECUTOR &&
response.GetTransitionEvent() == ei.Evt &&
response.GetState() == ei.Dst {
newState = response.GetState()
err = nil
r.Log.WithField("dst", newState).Debug("occ transition complete")
} else if response != nil {
newState = response.GetState()
err = fmt.Errorf("transition unsuccessful: ok: %s, trigger: %s, event: %s, state: %s, id: %s",
strconv.FormatBool(response.GetOk()),
response.GetTrigger().String(),
response.GetTransitionEvent(),
response.GetState(),
taskId)
} else {
newState = ""
err = fmt.Errorf("transition unsuccessful: id: %s invalid response but no gRPC error", taskId)
}
return
}