2 * Copyright (C) 2017-2018 "IoT.bzh"
3 * Author Sebastien Douheret <sebastien@iot.bzh>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
29 common "gerrit.automotivelinux.org/gerrit/src/xds/xds-common.git/golib"
30 "gerrit.automotivelinux.org/gerrit/src/xds/xds-common.git/golib/eows"
31 "gerrit.automotivelinux.org/gerrit/src/xds/xds-server/lib/xsapiv1"
32 "github.com/Sirupsen/logrus"
33 uuid "github.com/satori/go.uuid"
36 // Definition of scripts used to managed SDKs
39 scriptDbDump = "db-dump"
40 scriptDbUpdate = "db-update"
41 scriptGetFamConfig = "get-family-config"
42 scriptGetSdkInfo = "get-sdk-info"
43 scriptRemove = "remove"
46 var scriptsAll = []string{
57 // CrossSDK Hold SDK config
58 type CrossSDK struct {
61 scripts map[string]string
62 installCmd *eows.ExecOverWS
63 removeCmd *eows.ExecOverWS
66 // ListCrossSDK List all available and installed SDK (call "db-dump" script)
67 func ListCrossSDK(scriptDir string, update bool, log *logrus.Logger) ([]xsapiv1.SDK, error) {
68 sdksList := []xsapiv1.SDK{}
70 // First update sdk DB when requested
72 out, err := UpdateSDKDb(scriptDir, log)
74 log.Errorf("SDK DB update failure (%v): %v", err, out)
75 return sdksList, fmt.Errorf("Error while updating SDK DB (%v)", err)
79 // Retrieve SDKs list and info
80 cmd := exec.Command(path.Join(scriptDir, scriptDbDump))
81 stdout, err := cmd.CombinedOutput()
83 return sdksList, fmt.Errorf("Cannot get sdks list: %v", err)
86 if err = json.Unmarshal(stdout, &sdksList); err != nil {
87 log.Errorf("SDK %s script output:\n%v\n", scriptDbDump, string(stdout))
88 return sdksList, fmt.Errorf("Cannot decode sdk list %v", err)
94 // GetSDKInfo Used get-sdk-info script to extract SDK get info from a SDK file/tarball
95 func GetSDKInfo(scriptDir, url, filename, md5sum string, log *logrus.Logger) (xsapiv1.SDK, error) {
100 args = append(args, "--url", url)
101 } else if filename != "" {
102 args = append(args, "--file", filename)
104 args = append(args, "--md5", md5sum)
107 return sdk, fmt.Errorf("url of filename must be set")
110 cmd := exec.Command(path.Join(scriptDir, scriptGetSdkInfo), args...)
111 stdout, err := cmd.CombinedOutput()
113 return sdk, fmt.Errorf("%v %v", string(stdout), err)
116 if err = json.Unmarshal(stdout, &sdk); err != nil {
117 log.Errorf("SDK %s script output:\n%v\n", scriptGetSdkInfo, string(stdout))
118 return sdk, fmt.Errorf("Cannot decode sdk info %v", err)
123 // UpdateSDKDb Used db-update script to update SDK database
124 func UpdateSDKDb(scriptDir string, log *logrus.Logger) (string, error) {
126 cmd := exec.Command(path.Join(scriptDir, scriptDbUpdate), args...)
127 stdout, err := cmd.CombinedOutput()
129 return string(stdout), err
132 // NewCrossSDK creates a new instance of CrossSDK
133 func NewCrossSDK(ctx *Context, sdk xsapiv1.SDK, scriptDir string) (*CrossSDK, error) {
137 scripts: make(map[string]string),
140 // Execute get-config script to retrieve SDK configuration
141 getConfFile := path.Join(scriptDir, scriptGetFamConfig)
142 if !common.Exists(getConfFile) {
143 return &s, fmt.Errorf("'%s' script file not found in %s", scriptGetFamConfig, scriptDir)
146 cmd := exec.Command(getConfFile)
147 stdout, err := cmd.CombinedOutput()
149 return &s, fmt.Errorf("Cannot get sdk config using %s: %v", getConfFile, err)
152 err = json.Unmarshal(stdout, &s.sdk.FamilyConf)
154 s.Log.Errorf("SDK config script output:\n%v\n", string(stdout))
155 return &s, fmt.Errorf("Cannot decode sdk config %v", err)
157 famName := s.sdk.FamilyConf.FamilyName
160 if s.sdk.FamilyConf.RootDir == "" {
161 return &s, fmt.Errorf("SDK config not valid (rootDir not set)")
163 if s.sdk.FamilyConf.EnvSetupFile == "" {
164 return &s, fmt.Errorf("SDK config not valid (envSetupFile not set)")
167 // Check that other mandatory scripts are present
168 for _, scr := range scriptsAll {
169 s.scripts[scr] = path.Join(scriptDir, scr)
170 if !common.Exists(s.scripts[scr]) {
171 return &s, fmt.Errorf("Script named '%s' missing in SDK family '%s'", scr, famName)
175 // Fixed default fields value
177 if sdk.Status == "" {
178 sdk.Status = xsapiv1.SdkStatusNotInstalled
182 errMsg := "Invalid SDK definition "
184 return &s, fmt.Errorf(errMsg + "(name not set)")
185 } else if sdk.Profile == "" {
186 return &s, fmt.Errorf(errMsg + "(profile not set)")
187 } else if sdk.Version == "" {
188 return &s, fmt.Errorf(errMsg + "(version not set)")
189 } else if sdk.Arch == "" {
190 return &s, fmt.Errorf(errMsg + "(arch not set)")
192 if sdk.Status == xsapiv1.SdkStatusInstalled {
193 if sdk.SetupFile == "" {
194 return &s, fmt.Errorf(errMsg + "(setupFile not set)")
195 } else if !common.Exists(sdk.SetupFile) {
196 return &s, fmt.Errorf(errMsg + "(setupFile not accessible)")
199 return &s, fmt.Errorf(errMsg + "(path not set)")
200 } else if !common.Exists(sdk.Path) {
201 return &s, fmt.Errorf(errMsg + "(path not accessible)")
205 // Use V3 to ensure that we get same uuid on restart
208 nm = s.sdk.Profile + "_" + s.sdk.Arch + "_" + s.sdk.Version
210 s.sdk.ID = uuid.NewV3(uuid.FromStringOrNil("sdks"), nm).String()
212 s.LogSillyf("New SDK: ID=%v, Family=%s, Name=%v", s.sdk.ID[:8], s.sdk.FamilyConf.FamilyName, s.sdk.Name)
217 // Install a SDK (non blocking command, IOW run in background)
218 func (s *CrossSDK) Install(file string, force bool, timeout int, args []string, sess *ClientSession) error {
220 if s.sdk.Status == xsapiv1.SdkStatusInstalled {
221 return fmt.Errorf("already installed")
223 if s.sdk.Status == xsapiv1.SdkStatusInstalling {
224 return fmt.Errorf("installation in progress")
227 // Compute command args
228 cmdArgs := []string{}
230 cmdArgs = append(cmdArgs, "--file", file)
232 cmdArgs = append(cmdArgs, "--url", s.sdk.URL)
235 cmdArgs = append(cmdArgs, "--force")
238 // Append additional args (passthrough arguments)
240 cmdArgs = append(cmdArgs, args...)
245 cmdID := "sdk-install-" + strconv.Itoa(sdkCmdID)
247 // Create new instance to execute command and sent output over WS
248 s.installCmd = eows.New(s.scripts[scriptAdd], cmdArgs, sess.IOSocket, sess.ID, cmdID)
249 s.installCmd.Log = s.Log
250 // TODO: enable Term s.installCmd.PtyMode = true
251 s.installCmd.LineTimeSpan = 500 * time.Millisecond.Nanoseconds()
253 s.installCmd.CmdExecTimeout = timeout
255 s.installCmd.CmdExecTimeout = 30 * 60 // default 30min
258 // Define callback for output (stdout+stderr)
259 s.installCmd.OutputCB = func(e *eows.ExecOverWS, bStdout, bStderr []byte) {
261 stdout := string(bStdout)
262 stderr := string(bStderr)
266 sdkID := (*data)["SDKID"].(string)
267 if sdkID != s.sdk.ID {
268 s.Log.Errorln("BUG: sdk ID differs: %v != %v", sdkID, s.sdk.ID)
271 // IO socket can be nil when disconnected
272 so := s.sessions.IOSocketGet(e.Sid)
274 s.Log.Infof("%s not emitted: WS closed (sid:%s, msgid:%s)", xsapiv1.EVTSDKManagement, e.Sid, e.CmdID)
279 s.Log.Debugf("%s emitted - WS sid[4:] %s - id:%s - SDK ID:%s:", xsapiv1.EVTSDKManagement, e.Sid[4:], e.CmdID, sdkID[:16])
281 s.Log.Debugf("STDOUT <<%v>>", strings.Replace(stdout, "\n", "\\n", -1))
284 s.Log.Debugf("STDERR <<%v>>", strings.Replace(stderr, "\n", "\\n", -1))
288 err := (*so).Emit(xsapiv1.EVTSDKManagement, xsapiv1.SDKManagementMsg{
290 Timestamp: time.Now().String(),
291 Action: xsapiv1.SdkMgtActionInstall,
293 Progress: 0, // TODO add progress
299 s.Log.Errorf("WS Emit : %v", err)
303 // Define callback for output
304 s.installCmd.ExitCB = func(e *eows.ExecOverWS, code int, exitError error) {
307 sdkID := (*data)["SDKID"].(string)
308 if sdkID != s.sdk.ID {
309 s.Log.Errorln("BUG: sdk ID differs: %v != %v", sdkID, s.sdk.ID)
312 s.Log.Infof("Command SDK ID %s [Cmd ID %s] exited: code %d, exitError: %v", sdkID[:16], e.CmdID, code, exitError)
314 // IO socket can be nil when disconnected
315 so := s.sessions.IOSocketGet(e.Sid)
317 s.Log.Infof("%s (exit) not emitted - WS closed (id:%s)", xsapiv1.EVTSDKManagement, e.CmdID)
322 if code == 0 && exitError == nil {
324 s.sdk.Status = xsapiv1.SdkStatusInstalled
326 // FIXME: better update it using monitoring install dir (inotify)
327 // (see sdks.go / monitorSDKInstallation )
328 // Update SetupFile when n
329 if s.sdk.SetupFile == "" {
330 sdkDef, err := GetSDKInfo(s.sdk.FamilyConf.ScriptsDir, s.sdk.URL, "", "", s.Log)
331 if err != nil || sdkDef.SetupFile == "" {
332 s.Log.Errorf("GetSDKInfo error: %v", err)
334 s.sdk.LastError = "Installation failed (cannot init SetupFile path)"
335 s.sdk.Status = xsapiv1.SdkStatusNotInstalled
337 s.sdk.SetupFile = sdkDef.SetupFile
342 s.sdk.LastError = "Installation failed (code " + strconv.Itoa(code) +
344 if exitError != nil {
345 s.sdk.LastError = ". Error: " + exitError.Error()
347 s.sdk.Status = xsapiv1.SdkStatusNotInstalled
351 if exitError != nil {
352 emitErr = exitError.Error()
354 if emitErr == "" && s.sdk.LastError != "" {
355 emitErr = s.sdk.LastError
359 errSoEmit := (*so).Emit(xsapiv1.EVTSDKManagement, xsapiv1.SDKManagementMsg{
361 Timestamp: time.Now().String(),
362 Action: xsapiv1.SdkMgtActionInstall,
369 if errSoEmit != nil {
370 s.Log.Errorf("WS Emit EVTSDKManagement : %v", errSoEmit)
373 errSoEmit = s.events.Emit(xsapiv1.EVTSDKStateChange, s.sdk, e.Sid)
374 if errSoEmit != nil {
375 s.Log.Errorf("WS Emit EVTSDKStateChange : %v", errSoEmit)
378 // Cleanup command for the next time
382 // User data (used within callbacks)
383 data := make(map[string]interface{})
384 data["SDKID"] = s.sdk.ID
385 s.installCmd.UserData = &data
387 // Start command execution
388 s.Log.Infof("Install SDK %s: cmdID=%v, cmd=%v, args=%v", s.sdk.Name, s.installCmd.CmdID, s.installCmd.Cmd, s.installCmd.Args)
390 s.sdk.Status = xsapiv1.SdkStatusInstalling
393 err := s.installCmd.Start()
398 // AbortInstallRemove abort an install or remove command
399 func (s *CrossSDK) AbortInstallRemove(timeout int) error {
401 if s.installCmd == nil {
402 return fmt.Errorf("no installation in progress for this sdk")
405 s.sdk.Status = xsapiv1.SdkStatusNotInstalled
406 return s.installCmd.Signal("SIGKILL")
409 // Remove Used to remove/uninstall a SDK
410 func (s *CrossSDK) Remove(timeout int, sess *ClientSession) error {
412 if s.sdk.Status != xsapiv1.SdkStatusInstalled {
413 return fmt.Errorf("this sdk is not installed")
416 // IO socket can be nil when disconnected
417 so := s.sessions.IOSocketGet(sess.ID)
419 return fmt.Errorf("Cannot retrieve socket ")
422 s.sdk.Status = xsapiv1.SdkStatusUninstalling
424 // Notify state change
425 if err := s.events.Emit(xsapiv1.EVTSDKStateChange, s.sdk, sess.ID); err != nil {
426 s.Log.Warningf("Cannot notify SDK remove: %v", err)
429 script := s.scripts[scriptRemove]
431 s.Log.Infof("Uninstall SDK %s: script=%v args=%v", s.sdk.Name, script, args)
433 // Notify start removing
434 evData := xsapiv1.SDKManagementMsg{
435 Timestamp: time.Now().String(),
436 Action: xsapiv1.SdkMgtActionRemove,
443 if errEmit := (*so).Emit(xsapiv1.EVTSDKManagement, evData); errEmit != nil {
444 s.Log.Warningf("Cannot notify EVTSDKManagement end: %v", errEmit)
447 // Run command to remove SDK
448 cmd := exec.Command(script, args)
449 stdout, err := cmd.CombinedOutput()
451 s.sdk.Status = xsapiv1.SdkStatusNotInstalled
452 s.Log.Debugf("SDK uninstall err %v, output:\n %v", err, string(stdout))
454 // Emit end of removing process
455 evData = xsapiv1.SDKManagementMsg{
456 Timestamp: time.Now().String(),
457 Action: xsapiv1.SdkMgtActionRemove,
465 // Update error code on error
468 evData.Error = err.Error()
471 if errEmit := (*so).Emit(xsapiv1.EVTSDKManagement, evData); errEmit != nil {
472 s.Log.Warningf("Cannot notify EVTSDKManagement end: %v", errEmit)
475 // Notify state change
476 if errEmit := s.events.Emit(xsapiv1.EVTSDKStateChange, s.sdk, sess.ID); errEmit != nil {
477 s.Log.Warningf("Cannot notify EVTSDKStateChange end: %v", errEmit)
481 return fmt.Errorf("Error while uninstalling sdk: %v", err)
486 // Get Return SDK definition
487 func (s *CrossSDK) Get() *xsapiv1.SDK {
491 // GetEnvCmd returns the command used to initialized the environment
492 func (s *CrossSDK) GetEnvCmd() []string {
493 if s.sdk.SetupFile == "" {
496 return []string{"source", s.sdk.SetupFile}