aboutsummaryrefslogtreecommitdiffstats
path: root/lib/xdsserver/sdk.go
blob: e5d4d7cc33ab441909d692cdd45190c010671017 (plain)
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
/*
 * Copyright (C) 2017 "IoT.bzh"
 * Author Sebastien Douheret <sebastien@iot.bzh>
 *
 * 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.
 */

package xdsserver

import (
	"encoding/json"
	"fmt"
	"os"
	"os/exec"
	"path"
	"strconv"
	"strings"
	"time"

	"github.com/Sirupsen/logrus"
	common "github.com/iotbzh/xds-common/golib"
	"github.com/iotbzh/xds-common/golib/eows"
	"github.com/iotbzh/xds-server/lib/xsapiv1"
	uuid "github.com/satori/go.uuid"
)

// Definition of scripts used to managed SDKs
const (
	scriptAdd          = "add"
	scriptDbDump       = "db-dump"
	scriptDbUpdate     = "db-update"
	scriptGetFamConfig = "get-family-config"
	scriptGetSdkInfo   = "get-sdk-info"
	scriptRemove       = "remove"
)

var scriptsAll = []string{
	scriptAdd,
	scriptDbDump,
	scriptDbUpdate,
	scriptGetFamConfig,
	scriptGetSdkInfo,
	scriptRemove,
}

var sdkCmdID = 0

// CrossSDK Hold SDK config
type CrossSDK struct {
	*Context
	sdk        xsapiv1.SDK
	scripts    map[string]string
	installCmd *eows.ExecOverWS
	removeCmd  *eows.ExecOverWS

	bufStdout string
	bufStderr string
}

// ListCrossSDK List all available and installed SDK  (call "db-dump" script)
func ListCrossSDK(scriptDir string, log *logrus.Logger) ([]xsapiv1.SDK, error) {
	sdksList := []xsapiv1.SDK{}

	// Retrieve SDKs list and info
	cmd := exec.Command(path.Join(scriptDir, scriptDbDump))
	stdout, err := cmd.CombinedOutput()
	if err != nil {
		return sdksList, fmt.Errorf("Cannot get sdks list: %v", err)
	}

	if err = json.Unmarshal(stdout, &sdksList); err != nil {
		log.Errorf("SDK %s script output:\n%v\n", scriptDbDump, string(stdout))
		return sdksList, fmt.Errorf("Cannot decode sdk list %v", err)
	}

	return sdksList, nil
}

// GetSDKInfo Used get-sdk-info script to extract SDK get info from a SDK file/tarball
func GetSDKInfo(scriptDir, url, filename, md5sum string, log *logrus.Logger) (xsapiv1.SDK, error) {
	sdk := xsapiv1.SDK{}

	args := []string{}
	if url != "" {
		args = append(args, "--url", url)
	} else if filename != "" {
		args = append(args, "--file", filename)
		if md5sum != "" {
			args = append(args, "--md5", md5sum)
		}
	} else {
		return sdk, fmt.Errorf("url of filename must be set")
	}

	cmd := exec.Command(path.Join(scriptDir, scriptGetSdkInfo), args...)
	stdout, err := cmd.CombinedOutput()
	if err != nil {
		return sdk, fmt.Errorf("%v %v", string(stdout), err)
	}

	if err = json.Unmarshal(stdout, &sdk); err != nil {
		log.Errorf("SDK %s script output:\n%v\n", scriptGetSdkInfo, string(stdout))
		return sdk, fmt.Errorf("Cannot decode sdk info %v", err)
	}
	return sdk, nil
}

// NewCrossSDK creates a new instance of CrossSDK
func NewCrossSDK(ctx *Context, sdk xsapiv1.SDK, scriptDir string) (*CrossSDK, error) {
	s := CrossSDK{
		Context: ctx,
		sdk:     sdk,
		scripts: make(map[string]string),
	}

	// Execute get-config script to retrieve SDK configuration
	getConfFile := path.Join(scriptDir, scriptGetFamConfig)
	if !common.Exists(getConfFile) {
		return &s, fmt.Errorf("'%s' script file not found in %s", scriptGetFamConfig, scriptDir)
	}

	cmd := exec.Command(getConfFile)
	stdout, err := cmd.CombinedOutput()
	if err != nil {
		return &s, fmt.Errorf("Cannot get sdk config using %s: %v", getConfFile, err)
	}

	err = json.Unmarshal(stdout, &s.sdk.FamilyConf)
	if err != nil {
		s.Log.Errorf("SDK config script output:\n%v\n", string(stdout))
		return &s, fmt.Errorf("Cannot decode sdk config %v", err)
	}
	famName := s.sdk.FamilyConf.FamilyName

	// Sanity check
	if s.sdk.FamilyConf.RootDir == "" {
		return &s, fmt.Errorf("SDK config not valid (rootDir not set)")
	}
	if s.sdk.FamilyConf.EnvSetupFile == "" {
		return &s, fmt.Errorf("SDK config not valid (envSetupFile not set)")
	}

	// Check that other mandatory scripts are present
	for _, scr := range scriptsAll {
		s.scripts[scr] = path.Join(scriptDir, scr)
		if !common.Exists(s.scripts[scr]) {
			return &s, fmt.Errorf("Script named '%s' missing in SDK family '%s'", scr, famName)
		}
	}

	// Fixed default fields value
	sdk.LastError = ""
	if sdk.Status == "" {
		sdk.Status = xsapiv1.SdkStatusNotInstalled
	}

	// Sanity check
	errMsg := "Invalid SDK definition "
	if sdk.Name == "" {
		return &s, fmt.Errorf(errMsg + "(name not set)")
	} else if sdk.Profile == "" {
		return &s, fmt.Errorf(errMsg + "(profile not set)")
	} else if sdk.Version == "" {
		return &s, fmt.Errorf(errMsg + "(version not set)")
	} else if sdk.Arch == "" {
		return &s, fmt.Errorf(errMsg + "(arch not set)")
	}
	if sdk.Status == xsapiv1.SdkStatusInstalled {
		if sdk.SetupFile == "" {
			return &s, fmt.Errorf(errMsg + "(setupFile not set)")
		} else if !common.Exists(sdk.SetupFile) {
			return &s, fmt.Errorf(errMsg + "(setupFile not accessible)")
		}
		if sdk.Path == "" {
			return &s, fmt.Errorf(errMsg + "(path not set)")
		} else if !common.Exists(sdk.Path) {
			return &s, fmt.Errorf(errMsg + "(path not accessible)")
		}
	}

	// Use V3 to ensure that we get same uuid on restart
	nm := s.sdk.Name
	if nm == "" {
		nm = s.sdk.Profile + "_" + s.sdk.Arch + "_" + s.sdk.Version
	}
	s.sdk.ID = uuid.NewV3(uuid.FromStringOrNil("sdks"), nm).String()

	s.LogSillyf("New SDK: ID=%v, Family=%s, Name=%v", s.sdk.ID[:8], s.sdk.FamilyConf.FamilyName, s.sdk.Name)

	return &s, nil
}

// Install a SDK (non blocking command, IOW run in background)
func (s *CrossSDK) Install(file string, force bool, timeout int, args []string, sess *ClientSession) error {

	if s.sdk.Status == xsapiv1.SdkStatusInstalled {
		return fmt.Errorf("already installed")
	}
	if s.sdk.Status == xsapiv1.SdkStatusInstalling {
		return fmt.Errorf("installation in progress")
	}

	// Compute command args
	cmdArgs := []string{}
	if file != "" {
		cmdArgs = append(cmdArgs, "--file", file)
	} else {
		cmdArgs = append(cmdArgs, "--url", s.sdk.URL)
	}
	if force {
		cmdArgs = append(cmdArgs, "--force")
	}

	// Append additional args (passthrough arguments)
	if len(args) > 0 {
		cmdArgs = append(cmdArgs, args...)
	}

	// Unique command id
	sdkCmdID++
	cmdID := "sdk-install-" + strconv.Itoa(sdkCmdID)

	// Create new instance to execute command and sent output over WS
	s.installCmd = eows.New(s.scripts[scriptAdd], cmdArgs, sess.IOSocket, sess.ID, cmdID)
	s.installCmd.Log = s.Log
	if timeout > 0 {
		s.installCmd.CmdExecTimeout = timeout
	} else {
		s.installCmd.CmdExecTimeout = 30 * 60 // default 30min
	}

	// FIXME: temporary hack
	s.bufStdout = ""
	s.bufStderr = ""
	SizeBufStdout := 10
	SizeBufStderr := 2000
	if valS, ok := os.LookupEnv("XDS_SDK_BUF_STDOUT"); ok {
		if valI, err := strconv.Atoi(valS); err == nil {
			SizeBufStdout = valI
		}
	}
	if valS, ok := os.LookupEnv("XDS_SDK_BUF_STDERR"); ok {
		if valI, err := strconv.Atoi(valS); err == nil {
			SizeBufStderr = valI
		}
	}

	// Define callback for output (stdout+stderr)
	s.installCmd.OutputCB = func(e *eows.ExecOverWS, stdout, stderr string) {
		// paranoia
		data := e.UserData
		sdkID := (*data)["SDKID"].(string)
		if sdkID != s.sdk.ID {
			s.Log.Errorln("BUG: sdk ID differs: %v != %v", sdkID, s.sdk.ID)
		}

		// IO socket can be nil when disconnected
		so := s.sessions.IOSocketGet(e.Sid)
		if so == nil {
			s.Log.Infof("%s not emitted: WS closed (sid:%s, msgid:%s)", xsapiv1.EVTSDKInstall, e.Sid, e.CmdID)
			return
		}

		if s.LogLevelSilly {
			s.Log.Debugf("%s emitted - WS sid[4:] %s - id:%s - SDK ID:%s:", xsapiv1.EVTSDKInstall, e.Sid[4:], e.CmdID, sdkID[:16])
			if stdout != "" {
				s.Log.Debugf("STDOUT <<%v>>", strings.Replace(stdout, "\n", "\\n", -1))
			}
			if stderr != "" {
				s.Log.Debugf("STDERR <<%v>>", strings.Replace(stderr, "\n", "\\n", -1))
			}
		}

		// Temporary "Hack": Buffered sent data to avoid freeze in web Browser
		// FIXME: remove bufStdout & bufStderr and implement better algorithm
		s.bufStdout += stdout
		s.bufStderr += stderr
		if len(s.bufStdout) > SizeBufStdout || len(s.bufStderr) > SizeBufStderr {
			// Emit event
			err := (*so).Emit(xsapiv1.EVTSDKInstall, xsapiv1.SDKManagementMsg{
				CmdID:     e.CmdID,
				Timestamp: time.Now().String(),
				Sdk:       s.sdk,
				Progress:  0, // TODO add progress
				Exited:    false,
				Stdout:    s.bufStdout,
				Stderr:    s.bufStderr,
			})
			if err != nil {
				s.Log.Errorf("WS Emit : %v", err)
			}
			s.bufStdout = ""
			s.bufStderr = ""
		}
	}

	// Define callback for output
	s.installCmd.ExitCB = func(e *eows.ExecOverWS, code int, exitError error) {
		// paranoia
		data := e.UserData
		sdkID := (*data)["SDKID"].(string)
		if sdkID != s.sdk.ID {
			s.Log.Errorln("BUG: sdk ID differs: %v != %v", sdkID, s.sdk.ID)
		}

		s.Log.Infof("Command SDK ID %s [Cmd ID %s]  exited: code %d, exitError: %v", sdkID[:16], e.CmdID, code, exitError)

		// IO socket can be nil when disconnected
		so := s.sessions.IOSocketGet(e.Sid)
		if so == nil {
			s.Log.Infof("%s (exit) not emitted - WS closed (id:%s)", xsapiv1.EVTSDKInstall, e.CmdID)
			return
		}

		// Emit event remaining data in bufStdout/err
		if len(s.bufStderr) > 0 || len(s.bufStdout) > 0 {
			err := (*so).Emit(xsapiv1.EVTSDKInstall, xsapiv1.SDKManagementMsg{
				CmdID:     e.CmdID,
				Timestamp: time.Now().String(),
				Sdk:       s.sdk,
				Progress:  50, // TODO add progress
				Exited:    false,
				Stdout:    s.bufStdout,
				Stderr:    s.bufStderr,
			})
			if err != nil {
				s.Log.Errorf("WS Emit : %v", err)
			}
			s.bufStdout = ""
			s.bufStderr = ""
		}

		// Update SDK status
		if code == 0 && exitError == nil {
			s.sdk.LastError = ""
			s.sdk.Status = xsapiv1.SdkStatusInstalled

			// FIXME: better update it using monitoring install dir (inotify)
			// (see sdks.go / monitorSDKInstallation )
			// Update SetupFile when n
			if s.sdk.SetupFile == "" {
				sdkDef, err := GetSDKInfo(s.sdk.FamilyConf.ScriptsDir, s.sdk.URL, "", "", s.Log)
				if err != nil || sdkDef.SetupFile == "" {
					code = 1
					s.sdk.LastError = "Installation failed (cannot init SetupFile path)"
					s.sdk.Status = xsapiv1.SdkStatusNotInstalled
				} else {
					s.sdk.SetupFile = sdkDef.SetupFile
				}
			}

		} else {
			s.sdk.LastError = "Installation failed (code " + strconv.Itoa(code) +
				")"
			if exitError != nil {
				s.sdk.LastError = ". Error: " + exitError.Error()
			}
			s.sdk.Status = xsapiv1.SdkStatusNotInstalled
		}

		emitErr := ""
		if exitError != nil {
			emitErr = exitError.Error()
		}
		if emitErr == "" && s.sdk.LastError != "" {
			emitErr = s.sdk.LastError
		}

		// Emit event
		errSoEmit := (*so).Emit(xsapiv1.EVTSDKInstall, xsapiv1.SDKManagementMsg{
			CmdID:     e.CmdID,
			Timestamp: time.Now().String(),
			Sdk:       s.sdk,
			Progress:  100,
			Exited:    true,
			Code:      code,
			Error:     emitErr,
		})
		if errSoEmit != nil {
			s.Log.Errorf("WS Emit : %v", errSoEmit)
		}

		// Cleanup command for the next time
		s.installCmd = nil
	}

	// User data (used within callbacks)
	data := make(map[string]interface{})
	data["SDKID"] = s.sdk.ID
	s.installCmd.UserData = &data

	// Start command execution
	s.Log.Infof("Install SDK %s: cmdID=%v, cmd=%v, args=%v", s.sdk.Name, s.installCmd.CmdID, s.installCmd.Cmd, s.installCmd.Args)

	s.sdk.Status = xsapiv1.SdkStatusInstalling
	s.sdk.LastError = ""

	err := s.installCmd.Start()

	return err
}

// AbortInstallRemove abort an install or remove command
func (s *CrossSDK) AbortInstallRemove(timeout int) error {

	if s.installCmd == nil {
		return fmt.Errorf("no installation in progress for this sdk")
	}

	s.sdk.Status = xsapiv1.SdkStatusNotInstalled
	return s.installCmd.Signal("SIGKILL")
}

// Remove Used to remove/uninstall a SDK
func (s *CrossSDK) Remove(timeout int, sess *ClientSession) error {

	if s.sdk.Status != xsapiv1.SdkStatusInstalled {
		return fmt.Errorf("this sdk is not installed")
	}

	// IO socket can be nil when disconnected
	so := s.sessions.IOSocketGet(sess.ID)
	if so == nil {
		return fmt.Errorf("Cannot retrieve socket ")
	}

	s.sdk.Status = xsapiv1.SdkStatusUninstalling

	// Emit Remove event
	if err := (*so).Emit(xsapiv1.EVTSDKStateChange, s.sdk); err != nil {
		s.Log.Warningf("Cannot notify SDK remove: %v", err)
	}

	script := s.scripts[scriptRemove]
	args := s.sdk.Path
	s.Log.Infof("Uninstall SDK %s: script=%v args=%v", s.sdk.Name, script, args)

	cmd := exec.Command(script, args)
	stdout, err := cmd.CombinedOutput()

	s.sdk.Status = xsapiv1.SdkStatusNotInstalled
	s.Log.Debugf("SDK uninstall err %v, output:\n %v", err, string(stdout))

	if err != nil {

		// Emit Remove event
		evData := xsapiv1.SDKManagementMsg{
			Timestamp: time.Now().String(),
			Sdk:       s.sdk,
			Progress:  100,
			Exited:    true,
			Code:      1,
			Error:     err.Error(),
		}
		if err := (*so).Emit(xsapiv1.EVTSDKRemove, evData); err != nil {
			s.Log.Warningf("Cannot notify SDK remove end: %v", err)
		}

		return fmt.Errorf("Error while uninstalling sdk: %v", err)
	}

	// Emit Remove event
	evData := xsapiv1.SDKManagementMsg{
		Timestamp: time.Now().String(),
		Sdk:       s.sdk,
		Progress:  100,
		Exited:    true,
		Code:      0,
		Error:     "",
	}
	if err := (*so).Emit(xsapiv1.EVTSDKRemove, evData); err != nil {
		s.Log.Warningf("Cannot notify SDK remove end: %v", err)
	}

	return nil
}

// Get Return SDK definition
func (s *CrossSDK) Get() *xsapiv1.SDK {
	return &s.sdk
}

// GetEnvCmd returns the command used to initialized the environment
func (s *CrossSDK) GetEnvCmd() []string {
	return []string{"source", s.sdk.SetupFile}
}