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, log *logrus.Logger) ([]xsapiv1.SDK, error) {
68 sdksList := []xsapiv1.SDK{}
70 // Retrieve SDKs list and info
71 cmd := exec.Command(path.Join(scriptDir, scriptDbDump))
72 stdout, err := cmd.CombinedOutput()
74 return sdksList, fmt.Errorf("Cannot get sdks list: %v", err)
77 if err = json.Unmarshal(stdout, &sdksList); err != nil {
78 log.Errorf("SDK %s script output:\n%v\n", scriptDbDump, string(stdout))
79 return sdksList, fmt.Errorf("Cannot decode sdk list %v", err)
85 // GetSDKInfo Used get-sdk-info script to extract SDK get info from a SDK file/tarball
86 func GetSDKInfo(scriptDir, url, filename, md5sum string, log *logrus.Logger) (xsapiv1.SDK, error) {
91 args = append(args, "--url", url)
92 } else if filename != "" {
93 args = append(args, "--file", filename)
95 args = append(args, "--md5", md5sum)
98 return sdk, fmt.Errorf("url of filename must be set")
101 cmd := exec.Command(path.Join(scriptDir, scriptGetSdkInfo), args...)
102 stdout, err := cmd.CombinedOutput()
104 return sdk, fmt.Errorf("%v %v", string(stdout), err)
107 if err = json.Unmarshal(stdout, &sdk); err != nil {
108 log.Errorf("SDK %s script output:\n%v\n", scriptGetSdkInfo, string(stdout))
109 return sdk, fmt.Errorf("Cannot decode sdk info %v", err)
114 // NewCrossSDK creates a new instance of CrossSDK
115 func NewCrossSDK(ctx *Context, sdk xsapiv1.SDK, scriptDir string) (*CrossSDK, error) {
119 scripts: make(map[string]string),
122 // Execute get-config script to retrieve SDK configuration
123 getConfFile := path.Join(scriptDir, scriptGetFamConfig)
124 if !common.Exists(getConfFile) {
125 return &s, fmt.Errorf("'%s' script file not found in %s", scriptGetFamConfig, scriptDir)
128 cmd := exec.Command(getConfFile)
129 stdout, err := cmd.CombinedOutput()
131 return &s, fmt.Errorf("Cannot get sdk config using %s: %v", getConfFile, err)
134 err = json.Unmarshal(stdout, &s.sdk.FamilyConf)
136 s.Log.Errorf("SDK config script output:\n%v\n", string(stdout))
137 return &s, fmt.Errorf("Cannot decode sdk config %v", err)
139 famName := s.sdk.FamilyConf.FamilyName
142 if s.sdk.FamilyConf.RootDir == "" {
143 return &s, fmt.Errorf("SDK config not valid (rootDir not set)")
145 if s.sdk.FamilyConf.EnvSetupFile == "" {
146 return &s, fmt.Errorf("SDK config not valid (envSetupFile not set)")
149 // Check that other mandatory scripts are present
150 for _, scr := range scriptsAll {
151 s.scripts[scr] = path.Join(scriptDir, scr)
152 if !common.Exists(s.scripts[scr]) {
153 return &s, fmt.Errorf("Script named '%s' missing in SDK family '%s'", scr, famName)
157 // Fixed default fields value
159 if sdk.Status == "" {
160 sdk.Status = xsapiv1.SdkStatusNotInstalled
164 errMsg := "Invalid SDK definition "
166 return &s, fmt.Errorf(errMsg + "(name not set)")
167 } else if sdk.Profile == "" {
168 return &s, fmt.Errorf(errMsg + "(profile not set)")
169 } else if sdk.Version == "" {
170 return &s, fmt.Errorf(errMsg + "(version not set)")
171 } else if sdk.Arch == "" {
172 return &s, fmt.Errorf(errMsg + "(arch not set)")
174 if sdk.Status == xsapiv1.SdkStatusInstalled {
175 if sdk.SetupFile == "" {
176 return &s, fmt.Errorf(errMsg + "(setupFile not set)")
177 } else if !common.Exists(sdk.SetupFile) {
178 return &s, fmt.Errorf(errMsg + "(setupFile not accessible)")
181 return &s, fmt.Errorf(errMsg + "(path not set)")
182 } else if !common.Exists(sdk.Path) {
183 return &s, fmt.Errorf(errMsg + "(path not accessible)")
187 // Use V3 to ensure that we get same uuid on restart
190 nm = s.sdk.Profile + "_" + s.sdk.Arch + "_" + s.sdk.Version
192 s.sdk.ID = uuid.NewV3(uuid.FromStringOrNil("sdks"), nm).String()
194 s.LogSillyf("New SDK: ID=%v, Family=%s, Name=%v", s.sdk.ID[:8], s.sdk.FamilyConf.FamilyName, s.sdk.Name)
199 // Install a SDK (non blocking command, IOW run in background)
200 func (s *CrossSDK) Install(file string, force bool, timeout int, args []string, sess *ClientSession) error {
202 if s.sdk.Status == xsapiv1.SdkStatusInstalled {
203 return fmt.Errorf("already installed")
205 if s.sdk.Status == xsapiv1.SdkStatusInstalling {
206 return fmt.Errorf("installation in progress")
209 // Compute command args
210 cmdArgs := []string{}
212 cmdArgs = append(cmdArgs, "--file", file)
214 cmdArgs = append(cmdArgs, "--url", s.sdk.URL)
217 cmdArgs = append(cmdArgs, "--force")
220 // Append additional args (passthrough arguments)
222 cmdArgs = append(cmdArgs, args...)
227 cmdID := "sdk-install-" + strconv.Itoa(sdkCmdID)
229 // Create new instance to execute command and sent output over WS
230 s.installCmd = eows.New(s.scripts[scriptAdd], cmdArgs, sess.IOSocket, sess.ID, cmdID)
231 s.installCmd.Log = s.Log
232 s.installCmd.LineTimeSpan = 500 * time.Millisecond.Nanoseconds()
234 s.installCmd.CmdExecTimeout = timeout
236 s.installCmd.CmdExecTimeout = 30 * 60 // default 30min
239 // Define callback for output (stdout+stderr)
240 s.installCmd.OutputCB = func(e *eows.ExecOverWS, stdout, stderr string) {
243 sdkID := (*data)["SDKID"].(string)
244 if sdkID != s.sdk.ID {
245 s.Log.Errorln("BUG: sdk ID differs: %v != %v", sdkID, s.sdk.ID)
248 // IO socket can be nil when disconnected
249 so := s.sessions.IOSocketGet(e.Sid)
251 s.Log.Infof("%s not emitted: WS closed (sid:%s, msgid:%s)", xsapiv1.EVTSDKManagement, e.Sid, e.CmdID)
256 s.Log.Debugf("%s emitted - WS sid[4:] %s - id:%s - SDK ID:%s:", xsapiv1.EVTSDKManagement, e.Sid[4:], e.CmdID, sdkID[:16])
258 s.Log.Debugf("STDOUT <<%v>>", strings.Replace(stdout, "\n", "\\n", -1))
261 s.Log.Debugf("STDERR <<%v>>", strings.Replace(stderr, "\n", "\\n", -1))
265 err := (*so).Emit(xsapiv1.EVTSDKManagement, xsapiv1.SDKManagementMsg{
267 Timestamp: time.Now().String(),
268 Action: xsapiv1.SdkMgtActionInstall,
270 Progress: 0, // TODO add progress
276 s.Log.Errorf("WS Emit : %v", err)
280 // Define callback for output
281 s.installCmd.ExitCB = func(e *eows.ExecOverWS, code int, exitError error) {
284 sdkID := (*data)["SDKID"].(string)
285 if sdkID != s.sdk.ID {
286 s.Log.Errorln("BUG: sdk ID differs: %v != %v", sdkID, s.sdk.ID)
289 s.Log.Infof("Command SDK ID %s [Cmd ID %s] exited: code %d, exitError: %v", sdkID[:16], e.CmdID, code, exitError)
291 // IO socket can be nil when disconnected
292 so := s.sessions.IOSocketGet(e.Sid)
294 s.Log.Infof("%s (exit) not emitted - WS closed (id:%s)", xsapiv1.EVTSDKManagement, e.CmdID)
299 if code == 0 && exitError == nil {
301 s.sdk.Status = xsapiv1.SdkStatusInstalled
303 // FIXME: better update it using monitoring install dir (inotify)
304 // (see sdks.go / monitorSDKInstallation )
305 // Update SetupFile when n
306 if s.sdk.SetupFile == "" {
307 sdkDef, err := GetSDKInfo(s.sdk.FamilyConf.ScriptsDir, s.sdk.URL, "", "", s.Log)
308 if err != nil || sdkDef.SetupFile == "" {
310 s.sdk.LastError = "Installation failed (cannot init SetupFile path)"
311 s.sdk.Status = xsapiv1.SdkStatusNotInstalled
313 s.sdk.SetupFile = sdkDef.SetupFile
318 s.sdk.LastError = "Installation failed (code " + strconv.Itoa(code) +
320 if exitError != nil {
321 s.sdk.LastError = ". Error: " + exitError.Error()
323 s.sdk.Status = xsapiv1.SdkStatusNotInstalled
327 if exitError != nil {
328 emitErr = exitError.Error()
330 if emitErr == "" && s.sdk.LastError != "" {
331 emitErr = s.sdk.LastError
335 errSoEmit := (*so).Emit(xsapiv1.EVTSDKManagement, xsapiv1.SDKManagementMsg{
337 Timestamp: time.Now().String(),
338 Action: xsapiv1.SdkMgtActionInstall,
345 if errSoEmit != nil {
346 s.Log.Errorf("WS Emit EVTSDKManagement : %v", errSoEmit)
349 errSoEmit = s.events.Emit(xsapiv1.EVTSDKStateChange, s.sdk, e.Sid)
350 if errSoEmit != nil {
351 s.Log.Errorf("WS Emit EVTSDKStateChange : %v", errSoEmit)
354 // Cleanup command for the next time
358 // User data (used within callbacks)
359 data := make(map[string]interface{})
360 data["SDKID"] = s.sdk.ID
361 s.installCmd.UserData = &data
363 // Start command execution
364 s.Log.Infof("Install SDK %s: cmdID=%v, cmd=%v, args=%v", s.sdk.Name, s.installCmd.CmdID, s.installCmd.Cmd, s.installCmd.Args)
366 s.sdk.Status = xsapiv1.SdkStatusInstalling
369 err := s.installCmd.Start()
374 // AbortInstallRemove abort an install or remove command
375 func (s *CrossSDK) AbortInstallRemove(timeout int) error {
377 if s.installCmd == nil {
378 return fmt.Errorf("no installation in progress for this sdk")
381 s.sdk.Status = xsapiv1.SdkStatusNotInstalled
382 return s.installCmd.Signal("SIGKILL")
385 // Remove Used to remove/uninstall a SDK
386 func (s *CrossSDK) Remove(timeout int, sess *ClientSession) error {
388 if s.sdk.Status != xsapiv1.SdkStatusInstalled {
389 return fmt.Errorf("this sdk is not installed")
392 // IO socket can be nil when disconnected
393 so := s.sessions.IOSocketGet(sess.ID)
395 return fmt.Errorf("Cannot retrieve socket ")
398 s.sdk.Status = xsapiv1.SdkStatusUninstalling
400 // Notify state change
401 if err := s.events.Emit(xsapiv1.EVTSDKStateChange, s.sdk, sess.ID); err != nil {
402 s.Log.Warningf("Cannot notify SDK remove: %v", err)
405 script := s.scripts[scriptRemove]
407 s.Log.Infof("Uninstall SDK %s: script=%v args=%v", s.sdk.Name, script, args)
409 // Notify start removing
410 evData := xsapiv1.SDKManagementMsg{
411 Timestamp: time.Now().String(),
412 Action: xsapiv1.SdkMgtActionRemove,
419 if errEmit := (*so).Emit(xsapiv1.EVTSDKManagement, evData); errEmit != nil {
420 s.Log.Warningf("Cannot notify EVTSDKManagement end: %v", errEmit)
423 // Run command to remove SDK
424 cmd := exec.Command(script, args)
425 stdout, err := cmd.CombinedOutput()
427 s.sdk.Status = xsapiv1.SdkStatusNotInstalled
428 s.Log.Debugf("SDK uninstall err %v, output:\n %v", err, string(stdout))
430 // Emit end of removing process
431 evData = xsapiv1.SDKManagementMsg{
432 Timestamp: time.Now().String(),
433 Action: xsapiv1.SdkMgtActionRemove,
441 // Update error code on error
444 evData.Error = err.Error()
447 if errEmit := (*so).Emit(xsapiv1.EVTSDKManagement, evData); errEmit != nil {
448 s.Log.Warningf("Cannot notify EVTSDKManagement end: %v", errEmit)
451 // Notify state change
452 if errEmit := s.events.Emit(xsapiv1.EVTSDKStateChange, s.sdk, sess.ID); errEmit != nil {
453 s.Log.Warningf("Cannot notify EVTSDKStateChange end: %v", errEmit)
457 return fmt.Errorf("Error while uninstalling sdk: %v", err)
462 // Get Return SDK definition
463 func (s *CrossSDK) Get() *xsapiv1.SDK {
467 // GetEnvCmd returns the command used to initialized the environment
468 func (s *CrossSDK) GetEnvCmd() []string {
469 if s.sdk.SetupFile == "" {
472 return []string{"source", s.sdk.SetupFile}