test, tools: update tbot documentation
update tbot documentation in U-Boot, as I just
merged the event system into tbots master
branch.
Signed-off-by: Heiko Schocher <hs@denx.de>
diff --git a/tools/tbot/README b/tools/tbot/README
index a637a63..49b9e95 100644
--- a/tools/tbot/README
+++ b/tools/tbot/README
@@ -92,6 +92,16 @@
It is possible to switch in a single TC between board states.
+- Events
+ tbot creates while executing testcases so called events.
+ After tbot ended with the testcase it can call event_backends,
+ which convert the events to different formats. more info:
+
+ https://github.com/hsdenx/tbot/blob/master/doc/README.event
+
+ demo for a event backend:
+ http://xeidos.ddns.net/tests/test_db_auslesen.php
+
- tbot cmdline parameters:
$ python2.7 src/common/tbot.py --help
diff --git a/tools/tbot/README.install b/tools/tbot/README.install
index 24c67bc..a68e705 100644
--- a/tools/tbot/README.install
+++ b/tools/tbot/README.install
@@ -93,12 +93,6 @@
cp src/tc/tc_lab_denx_connect_to_board.py src/tc/tc_lab_denx_connect_to_board_XXX.py
and adapt the commands to your needs.
- As this TC powers on the board for all your boards in your VL,
- you can differ between the boards through the tbot class
- variable "tb.boardlabname" (which is in the default case the
- same as "tb.boardname"), but you may need to name the power target
- with an other name than boardname, so you can configure this case.
-
If connect fails end this TC with "tb.end_tc(False)"
else call "tb.end_tc(True)"
@@ -150,12 +144,6 @@
if (user == 'root'):
password = ''
- In the above example passwords for logging into the Lab PC tbot finds
- through:
- if (board == 'lab'):
- user = 'name':
- password = 'gnlmpf' # password 'gnlmpf' for login of user 'name'
-
- prepare board config file
Each board which is found in the VL needs a tbot configuration file
pass the config file name with the option '-c' to tbot, tbot searches
@@ -187,13 +175,8 @@
keepalive message.
line 14: channel_timeout: passed to paramiko
line 15: loglevel: tbots loglevel for adding entries into the logfile.
- line 16: lap_api: used lap API (currently only 'ssh_std')
- Should be declared as standard -> this line would be not needed
- longer.
line 17: wdt_timeout: timeout in seconds for tbots watchdog.
Watchdog gets triggered if prompt get read.
- line 20,21: include 'ssh_std' api
- should be removed.
line 24: tc_lab_denx_connect_to_board_tc: Which TC is used for
connecting to the boards console the TC, here:
https://github.com/hsdenx/tbot/blob/master/src/tc/tc_workfd_connect_with_kermit.py
@@ -215,156 +198,113 @@
u-boot:tools/tbot/README.create_a_new_testcase
Heiko Schocher <hs@denx.de>
-v1 2016.01.22
+v2 2016.04.26
--------------
[1] tbot Dokumentation:
[2] u-boot:/tools/tbot/README
https://github.com/hsdenx/tbot/blob/master/README.md
+ tbot-devel@googlegroups.com
[3] Example for a first U-Boot TC which should always work:
(with commandline option "-v" for verbose output):
-
-hs@localhost:tbot [master] $ python2.7 src/common/tbot.py -c tbot_dxr2.cfg -t tc_ub_setenv.py -v -l log/tbot.log
+hs@localhost:tbot [event-devel] $ python2.7 src/common/tbot.py -c tbot_dxr2.cfg -t tc_ub_setenv.py -v -l log/tbot.log
**** option cfg: tbot_dxr2.cfg log: log/tbot.log tc: tc_ub_setenv.py v 1
('CUR WORK PATH: ', '/home/hs/data/Entwicklung/tbot')
('CFGFILE ', 'tbot_dxr2.cfg')
('LOGFILE ', '/home/hs/data/Entwicklung/tbot/log/tbot.log')
-(<denx.tbot_lab_api object at 0x7f53ac1808d0>, <tbotlib.tbot object at 0x7f53a45fd410>, True)
-(<denx.tbot_lab_api object at 0x7f53ac1808d0>, <tbotlib.tbot object at 0x7f53a45fd410>, True)
-read 0: Last login: Fri Jan 22 12:20:12 2016 from 87.97.28.177
-read 0:
-read 0: *************************************************************
-read 0: BDI2000 Assignment: (last updated: 2015-11-20 12:30 MET)
-read 0: bdi1 => techem bdi2 => cetec_mx25 bdi3 => lpc3250
-read 0: bdi4 => - bdi5 => --Rev.B!-- bdi6 => tqm5200s
-read 0: bdi7 => [stefano] bdi8 => smartweb bdi9 => sigmatek-nand
-read 0: bdi10 => pcm052 bdi11 => socrates bdi12 => aristainetos
-read 0: bdi13 => imx53 bdi14 => ib8315 bdi15 => cairo
-read 0: bdi16 => g2c1 bdi17 => lwe090 bdi18 => symphony
-read 0: bdi19 => dxr2 bdi20 => ima3-mx6 bdi21 => sama5d3
-read 0: bdi98 => - bdi99 => - bdi0 => -
-read 0: Please power off unused systems when you leave! Thanks, wd.
-read 0: *************************************************************
-read no ret 0:
-pollux:~ hs $
-write 0: export PS1="\u@\h [\$(date +%k:%M:%S)] ttbott >"
-read 0: export PS1="\u@\h [\$(date +%k:%M:%S)] ttbott >"
-read 0: hs@pollux [12:21:00] ttbott >
-read 1: Last login: Fri Jan 22 12:20:59 2016 from 87.97.28.177
-read 1:
-read 1: *************************************************************
-read 1: BDI2000 Assignment: (last updated: 2015-11-20 12:30 MET)
-read 1: bdi1 => techem bdi2 => cetec_mx25 bdi3 => lpc3250
-read 1: bdi4 => - bdi5 => --Rev.B!-- bdi6 => tqm5200s
-read 1: bdi7 => [stefano] bdi8 => smartweb bdi9 => sigmatek-nand
-read 1: bdi10 => pcm052 bdi11 => socrates bdi12 => aristainetos
-read 1: bdi13 => imx53 bdi14 => ib8315 bdi15 => cairo
-read 1: bdi16 => g2c1 bdi17 => lwe090 bdi18 => symphony
-read 1: bdi19 => dxr2 bdi20 => ima3-mx6 bdi21 => sama5d3
-read 1: bdi98 => - bdi99 => - bdi0 => -
-read 1: Please power off unused systems when you leave! Thanks, wd.
-read 1: *************************************************************
-read no ret 1:
-pollux:~ hs $
-write 1: export PS1="\u@\h [\$(date +%k:%M:%S)] ttbott >"
-read 1: export PS1="\u@\h [\$(date +%k:%M:%S)] ttbott >"
-read 1: hs@pollux [12:21:02] ttbott >
-write 0: remote_power dxr2 -l
-read 0: hs@pollux [12:21:00] ttbott >remote_power dxr2 -l
-read 0: dxr2 ON
-read 0: hs@pollux [12:21:02] ttbott >
-read no ret 1:
-hs@pollux [12:21:02] ttbott >
-write 1: ssh hs@lena
-read 1: ssh hs@lena
-read no ret 1:
-hs@lena's password:
-read 1:
-read 1: Last login: Fri Jan 22 12:20:17 2016 from 192.168.1.1
-read 1:
-read no ret 1:
-[hs@lena ~]$
-write 1: export PS1="\u@\h [\$(date +%k:%M:%S)] ttbott >"
-read 1: export PS1="\u@\h [\$(date +%k:%M:%S)] ttbott >"
-read 1: hs@lena [12:21:07] ttbott >
-read no ret 1:
-hs@lena [12:21:07] ttbott >
-write 1: stty cols 200
-read 1: stty cols 200
-read 1: hs@lena [12:21:08] ttbott >
-write 1: export TERM=vt200
-read 1: hs@lena [12:21:08] ttbott >export TERM=vt200
-read 1: hs@lena [12:21:08] ttbott >
-write 1: echo $COLUMNS
-read 1: hs@lena [12:21:08] ttbott >echo $COLUMNS
-read 1: 200
-read 1: hs@lena [12:21:08] ttbott >
-write 1: kermit
-read 1: hs@lena [12:21:08] ttbott >kermit
-read 1: C-Kermit 8.0.211, 10 Apr 2004, for Linux
-read 1:
-read 1: Copyright (C) 1985, 2004,
-read 1: Trustees of Columbia University in the City of New York.
-read 1: Type ? or HELP for help.
-read 1:
-read 1: (/home/hs/) C-Kermit>
-read 1:
-read no ret 1: (/home/hs/) C-Kermit>
-write 1: set line /dev/ttyUSB0
-read 1: set line /dev/ttyUSB0
-read 1:
-read 1: (/home/hs/) C-Kermit>
-write 1: set speed 115200
-read 1:
-read 1: (/home/hs/) C-Kermit>set speed 115200
-read 1: /dev/ttyUSB0, 115200 bps
-read 1:
-read 1: (/home/hs/) C-Kermit>
-write 1: set flow-control none
-read 1:
-read 1: (/home/hs/) C-Kermit>set flow-control none
-read 1:
-read 1: (/home/hs/) C-Kermit>
-write 1: set carrier-watch off
-read 1:
-read 1: (/home/hs/) C-Kermit>set carrier-watch off
-read 1:
-read 1: (/home/hs/) C-Kermit>
-write 1: connect
-read 1:
-read 1: (/home/hs/) C-Kermit>connect
-read 1: Connecting to /dev/ttyUSB0, speed 115200
-read 1:
-read 1: Escape character: Ctrl-\ (ASCII 28, FS): enabled
-read 1:
-read 1: Type the escape character followed by C to get back,
-read 1:
-read 1: or followed by ? to see other options.
-read 1:
-read 1: ----------------------------------------------------
-read no ret 1:
-
-write no ret 1:
-
-read 1:
-read 1: Heiko=Schocher
-read no ret 1:
+tb_ctrl: Last login: Mon Apr 25 14:52:42 2016 from 87.97.29.27
+*************************************************************
+BDI2000 Assignment: (last updated: 2015-11-20 12:30 MET)
+bdi1 => techem bdi2 => cetec_mx25 bdi3 => lpc3250
+bdi4 => - bdi5 => --Rev.B!-- bdi6 => tqm5200s
+bdi7 => [stefano] bdi8 => smartweb bdi9 => sigmatek-nand
+bdi10 => pcm052 bdi11 => socrates bdi12 => aristainetos
+bdi13 => imx53 bdi14 => ib8315 bdi15 => cairo
+bdi16 => g2c1 bdi17 => lwe090 bdi18 => symphony
+bdi19 => dxr2 bdi20 => ima3-mx6 bdi21 => sama5d3
+bdi98 => - bdi99 => - bdi0 => -
+Please power off unused systems when you leave! Thanks, wd.
+*************************************************************
+tb_ctrl: pollux:~ hs $
+tb_ctrl: export PS1=ttbott
+ttbott
+tb_ctrl: stty cols 200
+ttbott
+tb_ctrl: export TERM=vt200
+ttbott
+tb_ctrl: echo $COLUMNS
+200
+ttbott
+tb_con: Last login: Tue Apr 26 06:28:59 2016 from 87.97.29.27
+*************************************************************
+BDI2000 Assignment: (last updated: 2015-11-20 12:30 MET)
+bdi1 => techem bdi2 => cetec_mx25 bdi3 => lpc3250
+bdi4 => - bdi5 => --Rev.B!-- bdi6 => tqm5200s
+bdi7 => [stefano] bdi8 => smartweb bdi9 => sigmatek-nand
+bdi10 => pcm052 bdi11 => socrates bdi12 => aristainetos
+bdi13 => imx53 bdi14 => ib8315 bdi15 => cairo
+bdi16 => g2c1 bdi17 => lwe090 bdi18 => symphony
+bdi19 => dxr2 bdi20 => ima3-mx6 bdi21 => sama5d3
+bdi98 => - bdi99 => - bdi0 => -
+Please power off unused systems when you leave! Thanks, wd.
+*************************************************************
+tb_con: pollux:~ hs $
+tb_con: export PS1=ttbot
+tb_con: t
+ttbott
+tb_con: stty cols 200
+ttbott
+tb_con: export TERM=vt200
+ttbott
+tb_con: echo $COLUMNS
+200
+ttbott
+tb_con: ssh hs@lena
+tb_con: hs@lena's password:
+tb_con:
+tb_con: Last login: Mon Apr 25 07:03:29 2016 from 192.168.1.1
+tb_con: [hs@lena ~]$
+tb_con: export PS1=ttbott
+ttbott
+tb_con: stty cols 200
+ttbott
+tb_con: export TERM=vt200
+ttbott
+tb_con: echo $COLUMNS
+200
+ttbott
+tb_con: kermit
+C-Kermit 8.0.211, 10 Apr 2004, for Linux
+ Copyright (C) 1985, 2004,
+ Trustees of Columbia University in the City of New York.
+Type ? or HELP for help.
+(/home/hs/) C-Kermit>
+tb_con: set line /dev/ttyUSB0
+(/home/hs/) C-Kermit>
+tb_con: set speed 115200
+/dev/ttyUSB0, 115200 bps
+(/home/hs/) C-Kermit>
+tb_con: set flow-control none
+(/home/hs/) C-Kermit>
+tb_con: set carrier-watch off
+(/home/hs/) C-Kermit>
+tb_con: connect
+Connecting to /dev/ttyUSB0, speed 115200
+ Escape character: Ctrl-\ (ASCII 28, FS): enabled
+Type the escape character followed by C to get back,
+or followed by ? to see other options.
+----------------------------------------------------
+tb_con: <INTERRUPT>
U-Boot#
-write no ret 1:
-write no ret 1:
-
-read 1: <INTERRUPT>
-read 1: U-Boot#
-write 1: setenv Heiko Schocher
-read 1: U-Boot# setenv Heiko Schocher
-read no ret 1:
+tb_con: U-Boot#
U-Boot#
-write 1: printenv Heiko
-read 1: printenv Heiko
-read 1: Heiko=Schocher
-read no ret 1:
+tb_con: setenv Heiko Schocher
U-Boot#
+tb_con: printenv Heiko
+Heiko=Schocher
+U-Boot#
+[('tc_workfd_ssh.py', 1, 0), ('tc_workfd_connect_with_kermit.py', 1, 0), ('tc_ub_setenv.py', 1, 0)]
End of TBOT: success
-hs@localhost:tbot [master] $
+hs@localhost:tbot [event-devel] $