2 * Copyright (C) 2017-2018 "IoT.bzh"
3 * Author Clément Bénier <clement.benier@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.
27 "gerrit.automotivelinux.org/gerrit/src/xds/xds-server/lib/xsapiv1"
28 "github.com/stretchr/testify/assert"
31 /*flush channel with timeout*/
32 func flushChannelTerm(channel chan xsapiv1.TerminalOutMsg, ms time.Duration) {
37 case <-time.After(ms * time.Millisecond):
43 func ConnectTargetEvents(t *testing.T, channel chan xsapiv1.TargetConfig) {
44 sCli.Conn.On(xsapiv1.EVTTargetAdd, func(e xsapiv1.EventMsg) {
45 target, _ := e.DecodeTargetEvent()
49 args := xsapiv1.EventRegisterArgs{Name: xsapiv1.EVTTargetAdd}
50 assert.Nil(t, HTTPCli.Post("/events/register", args, nil))
52 sCli.Conn.On(xsapiv1.EVTTargetRemove, func(e xsapiv1.EventMsg) {
53 target, _ := e.DecodeTargetEvent()
57 args = xsapiv1.EventRegisterArgs{Name: xsapiv1.EVTTargetRemove}
58 assert.Nil(t, HTTPCli.Post("/events/register", args, nil))
61 func DisconnectTargetEvents(t *testing.T) {
62 args := xsapiv1.EventRegisterArgs{Name: xsapiv1.EVTTargetAdd}
63 assert.Nil(t, HTTPCli.Post("/events/unregister", args, nil))
64 args = xsapiv1.EventRegisterArgs{Name: xsapiv1.EVTTargetRemove}
65 assert.Nil(t, HTTPCli.Post("/events/unregister", args, nil))
68 func ConnectTermEvents(t *testing.T, channel chan xsapiv1.TerminalConfig) {
69 sCli.Conn.On(xsapiv1.EVTTargetTerminalAdd, func(e xsapiv1.EventMsg) {
70 termEvt, _ := e.DecodeTerminalEvent()
74 args := xsapiv1.EventRegisterArgs{Name: xsapiv1.EVTTargetTerminalAdd}
75 assert.Nil(t, HTTPCli.Post("/events/register", args, nil))
77 sCli.Conn.On(xsapiv1.EVTTargetTerminalStateChange, func(e xsapiv1.EventMsg) {
78 termEvt, _ := e.DecodeTerminalEvent()
82 args = xsapiv1.EventRegisterArgs{Name: xsapiv1.EVTTargetTerminalStateChange}
83 assert.Nil(t, HTTPCli.Post("/events/register", args, nil))
85 sCli.Conn.On(xsapiv1.EVTTargetTerminalRemove, func(e xsapiv1.EventMsg) {
86 termEvt, _ := e.DecodeTerminalEvent()
90 args = xsapiv1.EventRegisterArgs{Name: xsapiv1.EVTTargetTerminalRemove}
91 assert.Nil(t, HTTPCli.Post("/events/register", args, nil))
94 func DisconnectTermEvents(t *testing.T) {
95 args := xsapiv1.EventRegisterArgs{Name: xsapiv1.EVTTargetTerminalAdd}
96 assert.Nil(t, HTTPCli.Post("/events/unregister", args, nil))
97 args = xsapiv1.EventRegisterArgs{Name: xsapiv1.EVTTargetTerminalStateChange}
98 assert.Nil(t, HTTPCli.Post("/events/unregister", args, nil))
99 args = xsapiv1.EventRegisterArgs{Name: xsapiv1.EVTTargetTerminalRemove}
100 assert.Nil(t, HTTPCli.Post("/events/unregister", args, nil))
103 func AddTargets(t *testing.T, nbTargets int, chTarget chan xsapiv1.TargetConfig) []string {
104 listID := make([]string, nbTargets)
105 for i := 0; i < nbTargets; i++ {
107 target := xsapiv1.TargetConfig{
108 Name: "fakeTarget" + strconv.Itoa(i),
109 Type: xsapiv1.TypeTgtStandard,
113 assert.Nil(t, HTTPCli.Post("/targets", target, &target))
114 Debugf(t, "add target %v", target.Name)
115 targetEvt := <-chTarget //waiting for event targetAdd
116 assert.Equal(t, target.ID, targetEvt.ID)
117 listID[i] = target.ID
119 for i := 0; i < nbTargets; i++ {
120 var target xsapiv1.TargetConfig
121 assert.Nil(t, HTTPCli.Get("/targets/"+listID[i], &target))
122 assert.Equal(t, target.Status, "Enable")
127 func AddTerms(t *testing.T, nbTerms int, listID []string, chTermEvt chan xsapiv1.TerminalConfig) {
128 for j := 0; j < len(listID); j++ {
129 listTermsID := make([]string, nbTerms)
130 for i := 0; i < nbTerms; i++ {
131 term := xsapiv1.TerminalConfig{
132 Name: "terminal" + strconv.Itoa(i),
133 Type: xsapiv1.TypeTermSSH,
135 /*add terminal on target*/
136 assert.Nil(t, HTTPCli.Post("/targets/"+listID[j]+"/terminals", term, &term))
137 Debugf(t, "add terminal %v", term.Name)
138 termEvt := <-chTermEvt //waiting for event terminalAdd*/
139 assert.Equal(t, term.ID, termEvt.ID)
140 listTermsID[i] = term.ID
142 assert.Equal(t, len(listTermsID), nbTerms)
143 for i := 0; i < nbTerms; i++ {
144 var term xsapiv1.TerminalConfig
145 assert.Nil(t, HTTPCli.Get("/targets/"+listID[j]+"/terminals/"+listTermsID[i], &term))
146 assert.Equal(t, term.Status, "Close")
151 func PostTerms(t *testing.T, post string, chTermEvt chan xsapiv1.TerminalConfig) {
159 var targets []xsapiv1.TargetConfig
160 assert.Nil(t, HTTPCli.Get("/targets", &targets))
161 for i := 0; i < len(targets); i++ {
162 var terms []xsapiv1.TerminalConfig
163 assert.Nil(t, HTTPCli.Get("/targets/"+targets[i].ID+"/terminals", &terms))
164 listTermsID := make([]string, len(terms))
165 for j := 0; j < len(terms); j++ {
166 var term xsapiv1.TerminalConfig
167 /*post action on term*/
168 assert.Nil(t, HTTPCli.Post("/targets/"+targets[i].ID+"/terminals/"+terms[j].ID+"/"+post, terms[j], &term))
169 Debugf(t, "%v terminal %v", post, term.Name)
170 termEvt := <-chTermEvt //waiting for event terminalStateChange
171 assert.Equal(t, term.ID, termEvt.ID)
172 assert.Equal(t, term.Status, status)
173 assert.Equal(t, termEvt.Status, status)
174 listTermsID[i] = term.ID
176 time.Sleep(10 * time.Millisecond)
177 for j := 0; j < len(listTermsID); j++ {
178 var term xsapiv1.TerminalConfig
179 assert.Nil(t, HTTPCli.Get("/targets/"+targets[i].ID+"/terminals/"+listTermsID[i], &term))
180 assert.True(t, strings.EqualFold(term.Status, post))
181 Debugf(t, "check that term status %v is %v", term.Name, post)
186 func RemoveTermsTargets(t *testing.T, chTarget chan xsapiv1.TargetConfig, chTermEvt chan xsapiv1.TerminalConfig) {
187 var targets []xsapiv1.TargetConfig
188 assert.Nil(t, HTTPCli.Get("/targets", &targets))
189 for i := 0; i < len(targets); i++ {
190 var terms []xsapiv1.TerminalConfig
191 assert.Nil(t, HTTPCli.Get("/targets/"+targets[i].ID+"/terminals", &terms))
192 for j := 0; j < len(terms); j++ {
193 var term xsapiv1.TerminalConfig
194 assert.Nil(t, HTTPCli.Delete("/targets/"+targets[i].ID+"/terminals/"+terms[j].ID, &term))
195 termEvt := <-chTermEvt
196 assert.Equal(t, term.ID, termEvt.ID)
197 assert.NotNil(t, HTTPCli.Delete("/targets/"+targets[i].ID+"/terminals/"+terms[j].ID, &term))
198 Debugf(t, "remove terminal %v", term.Name)
200 var tgtRes xsapiv1.TargetConfig
201 assert.Nil(t, HTTPCli.Delete("/targets/"+targets[i].ID, &tgtRes))
202 targetEvt := <-chTarget //waiting for remove terminal event
203 assert.Equal(t, tgtRes.ID, targetEvt.ID)
204 assert.Equal(t, targets[i].ID, tgtRes.ID)
207 func TestTarget(t *testing.T) {
210 /*channel for target events*/
211 chTarget := make(chan xsapiv1.TargetConfig)
212 defer close(chTarget)
213 ConnectTargetEvents(t, chTarget)
215 /*channel for terminal events*/
216 chTermEvt := make(chan xsapiv1.TerminalConfig)
217 defer close(chTermEvt)
218 ConnectTermEvents(t, chTermEvt)
220 /*check that targetArray is empty at startup*/
221 var targetArray []xsapiv1.TargetConfig
222 assert.Nil(t, HTTPCli.Get("/targets", &targetArray))
223 assert.Equal(t, len(targetArray), 0)
225 listID := AddTargets(t, nbTargets, chTarget)
226 AddTerms(t, nbTermsByTarget, listID, chTermEvt)
228 /*channel for TerminalOutMsg*/
229 chTerm := make(chan xsapiv1.TerminalOutMsg)
232 /*connect on terminalOutMsg event*/
233 sCli.Conn.On(xsapiv1.TerminalOutEvent, func(ev xsapiv1.TerminalOutMsg) {
237 /*just for the first term*/
238 var terms []xsapiv1.TerminalConfig
239 var term xsapiv1.TerminalConfig
240 assert.Nil(t, HTTPCli.Get("/targets/"+listID[0]+"/terminals", &terms))
241 assert.Nil(t, HTTPCli.Post("/targets/"+listID[0]+"/terminals/"+terms[0].ID+"/open", terms[0], &term))
242 <-chTermEvt //waiting for event terminalStateChange
243 termOut := <-chTerm //waiting for terminalOutMsg
244 flushChannelTerm(chTerm, 50) //flushing all terminalOutMsg
245 stdoutMsg := string(termOut.Stdout)
246 if strings.Contains(stdoutMsg, "Connection refused") {
247 t.Fatalf("%vYou may have to launch ssh server", stdoutMsg)
248 } else if strings.Contains(stdoutMsg, "password") {
249 t.Fatalf("%vcopy your pub key in authorized_keys\ncat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys", stdoutMsg)
251 assert.True(t, strings.Contains(stdoutMsg, "Last login")) //first terminal msg should be Last Login
252 assert.Nil(t, HTTPCli.Post("/targets/"+listID[0]+"/terminals/"+terms[0].ID+"/close", terms[0], &term))
253 <-chTermEvt //waiting for event terminalStateChange
256 PostTerms(t, "open", chTermEvt)
257 termOut = <-chTerm //waiting for terminalOutMsg
258 flushChannelTerm(chTerm, 50) //flushing all terminalOutMsg
259 stdoutMsg = string(termOut.Stdout)
260 if strings.Contains(stdoutMsg, "Connection refused") {
261 t.Fatalf("%vYou may have to launch ssh server", stdoutMsg)
262 } else if strings.Contains(stdoutMsg, "password") {
263 t.Fatalf("%vcopy your pub key in authorized_keys\ncat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys", stdoutMsg)
265 assert.True(t, strings.Contains(stdoutMsg, "Last login")) //first terminal msg should be Last Login
267 /*create toto file through terminals*/
268 rootCfgDir := os.Getenv(envRootCfgDir)
269 totoFile := path.Join(rootCfgDir, "toto")
271 /*test with 2 terminals*/
272 for i := 0; i < 2; i++ {
273 totoFileCurrent := totoFile + strconv.Itoa(i)
274 /*send cmd though term*/
275 data := []byte("echo helloWorld" + strconv.Itoa(i) + " >> " + totoFileCurrent + "\n")
276 Debugf(t, "send following command through terminal: %v", string(data))
277 assert.Nil(t, sCli.Conn.Emit(xsapiv1.TerminalInEvent, data))
278 flushChannelTerm(chTerm, 50) //waiting for terminal msg
280 /*check that toto file is created*/
281 _, err := os.Stat(totoFileCurrent)
284 /*send cmd though term*/
285 data = []byte("cat " + totoFileCurrent + "\n")
286 Debugf(t, "send following command through terminal: %v", string(data))
287 assert.Nil(t, sCli.Conn.Emit(xsapiv1.TerminalInEvent, data))
290 termOut = <-chTerm //result of cat cmd
291 flushChannelTerm(chTerm, 50) //flushing what remains
292 /*check that terminal msg is what was written before*/
293 assert.Equal(t, string(termOut.Stdout), "helloWorld"+strconv.Itoa(i)+"\r\n")
294 Debugf(t, "check terminal output msg: %v", string(termOut.Stdout))
297 PostTerms(t, "close", chTermEvt)
299 /*remove targets and terms*/
300 RemoveTermsTargets(t, chTarget, chTermEvt)
301 DisconnectTargetEvents(t)
302 DisconnectTermEvents(t)
305 func TestTargetErrors(t *testing.T) {
306 /*cannot create empty target*/
307 target := xsapiv1.TargetConfig{}
308 var targetRes xsapiv1.TargetConfig
309 assert.NotNil(t, HTTPCli.Post("/targets", target, &targetRes))
310 Debugf(t, "error while creating empty target")
311 /*check cannot create target with no IP*/
312 target.Type = xsapiv1.TypeTgtStandard
313 assert.NotNil(t, HTTPCli.Post("/targets", target, &targetRes))
314 Debugf(t, "error while creating target without IP")
315 target.IP = "127.0.0.1"
316 assert.Nil(t, HTTPCli.Post("/targets", target, &targetRes))
317 Debugf(t, "create target %v", targetRes.Name)
319 /*cannot create empty terminal*/
320 term := xsapiv1.TerminalConfig{}
321 var termRes xsapiv1.TerminalConfig
322 assert.NotNil(t, HTTPCli.Post("/targets/"+targetRes.ID+"/terminals", term, &termRes))
323 Debugf(t, "error while creating empty terminal")
324 term.Type = xsapiv1.TypeTermSSH
325 assert.NotNil(t, HTTPCli.Post("/targets/"+"1010"+"/terminals", term, &termRes))
326 Debugf(t, "error while creating terminal on an non existing target")
327 assert.Nil(t, HTTPCli.Post("/targets/"+targetRes.ID+"/terminals", term, &termRes))
328 assert.Nil(t, HTTPCli.Post("/targets/"+targetRes.ID+"/terminals", term, &termRes))
329 assert.Nil(t, HTTPCli.Post("/targets/"+targetRes.ID+"/terminals", term, &termRes))
330 assert.Nil(t, HTTPCli.Post("/targets/"+targetRes.ID+"/terminals", term, &termRes))
331 Debugf(t, "create several terminals")
333 /*remove targets and terms*/
334 var targetArray []xsapiv1.TargetConfig
335 assert.Nil(t, HTTPCli.Get("/targets", &targetArray))
336 for i := 0; i < len(targetArray); i++ {
337 var termArray []xsapiv1.TerminalConfig
338 assert.Nil(t, HTTPCli.Get("/targets/"+targetArray[i].ID+"/terminals", &termArray))
339 for j := 0; j < len(termArray); j++ {
340 assert.Nil(t, HTTPCli.Delete("/targets/"+targetArray[i].ID+"/terminals/"+termArray[j].ID, &termRes))
341 Debugf(t, "delete terminal %v", termRes.Name)
342 assert.NotNil(t, HTTPCli.Delete("/targets/"+targetArray[i].ID+"/terminals/"+termArray[j].ID, &termRes))
343 Debugf(t, "error while deleting an already deleted terminal %v", termRes.Name)
345 var tgtRes xsapiv1.TargetConfig
346 assert.Nil(t, HTTPCli.Delete("/targets/"+targetArray[i].ID, &tgtRes))
347 Debugf(t, "delete target %v", tgtRes.Name)
348 assert.Equal(t, targetArray[i].ID, tgtRes.ID)
349 assert.NotNil(t, HTTPCli.Delete("/targets/"+targetArray[i].ID, &tgtRes))
350 Debugf(t, "error while deleting an already deleted target %v", tgtRes.Name)