tools/serial.inc.mk: Support miniterm.py. #11003

jcarrano · 2019-02-12T14:40:02Z

Contribution description

miniterm.py is a simple terminal program that is included with pyserial. This means that it is available wherever pyterm can work. It allows raw access, does line translation and passes through special characters.

For test scripts, a terminal that does not modify the input and output streams, configured without local echo, is preferred as it ensures the test setup is introducing as few noise as possible.

Testing procedure

With this change, tests/shell uses miniterm.py. Just run the tests. Use a real board, native has no real TTY.

$ cd tests/shell
$ BOARD=samr21-xpro make all
$ BOARD=samr21-xpro make flash
$ BOARD=samr21-xpro make test

Issues/PRs references

This PR is part of #10994 and it's purpose is to ease shell automation.
Split from #10788 .

aabadie

It's indeed useful to provide support for miniterm even if it's not the default.
I haven't tried this PR but I think local echo should also be enabled by default. There are also a couple minor issues.

aabadie · 2019-02-14T22:01:08Z

tests/shell/Makefile

@@ -1,4 +1,5 @@
 DEVELHELP=0
+


Oops, that slipped through when I splitted the change.

aabadie · 2019-02-14T22:01:44Z

tests/shell/Makefile

@@ -12,4 +13,8 @@ BOARD_BLACKLIST += chronos

 TEST_ON_CI_WHITELIST += all

+ifneq ($(BOARD), native)
+	RIOT_TERMINAL=miniterm.py


Looks like there's tab here. The indent should be 2 spaces.

aabadie · 2019-02-14T22:04:11Z

makefiles/tools/serial.inc.mk

@@ -19,4 +19,7 @@ ifeq ($(RIOT_TERMINAL),pyterm)
 else ifeq ($(RIOT_TERMINAL),picocom)
    export TERMPROG  ?= picocom
    export TERMFLAGS ?= --nolock --imap lfcrlf --echo --baud "$(BAUD)" "$(PORT)"
+else ifeq ($(RIOT_TERMINAL),miniterm.py)
+    export TERMPROG  ?= miniterm.py
+    export TERMFLAGS ?= --eol CRLF "$(PORT)" "$(BAUD)"


Maybe also enable --echo ? It's the kind of useful things when using the shell.

With local echo you end up having double echo, as the shell echoes too, and miniterm does not do line buffering, eg.:

> hheellpp

Having local echo messes with the tests also as the sent string is matched by pexpect.

aabadie

I tested tests/shell with miniterm and confirm that it also works.

I have other comments.

aabadie · 2019-02-20T07:49:01Z

makefiles/tools/serial.inc.mk

@@ -19,4 +19,9 @@ ifeq ($(RIOT_TERMINAL),pyterm)
 else ifeq ($(RIOT_TERMINAL),picocom)
    export TERMPROG  ?= picocom
    export TERMFLAGS ?= --nolock --imap lfcrlf --echo --baud "$(BAUD)" "$(PORT)"
+else ifeq ($(RIOT_TERMINAL),miniterm.py)
+    export TERMPROG  ?= miniterm.py


Suggested change

export TERMPROG ?= miniterm.py

export TERMPROG ?= $(RIOT_TERMINAL)

Not blocking for this

aabadie · 2019-02-20T07:56:10Z

tests/shell/Makefile

+# In order to properly test and debug the shell it is better to use a terminal
+# program that does not modify the input and output streams and has no buffering.
+ifneq ($(BOARD), native)
+	RIOT_TERMINAL?=miniterm.py


The tab is still there. I would put space around ?= like it's done in other places.

aabadie · 2019-02-20T08:01:57Z

tests/shell/Makefile

@@ -12,4 +12,10 @@ BOARD_BLACKLIST += chronos

 TEST_ON_CI_WHITELIST += all

+# In order to properly test and debug the shell it is better to use a terminal


Why just set this in tests/shell only ? I would prefer to have this set globally in Makefile.tests_common.

jcarrano · 2019-02-20T10:38:45Z

@aabadie I rebased this on top of your indentation fix.

miniterm.py is a simple terminal program that is included with pyserial. This means that it is available wherever pyterm can work. It allows raw access, does line translation and passes through special characters. For test scripts, a terminal that does not modify the input and output streams, configured without local echo, is preferred as it ensures the test setup is introducing as few noise as possible.

cladmi · 2019-02-20T11:11:15Z

When testing #10952 I found that having local echo may even be hurting for testing as it introduces more text in the tested text.

cladmi · 2019-02-20T14:42:17Z

I would prefer to move changing the test configuration in a different PR as it relates to the main tracking issue and not to adding the support.

Adding support should be done alone and it does not hurt anything.
Changing the test configuration is a different thing that may have consequences.

tests/shell/Makefile

jcarrano · 2019-02-25T13:36:47Z

#11034 makes this PR irrelevant. Socat is a better tool. I'm closing this.

jcarrano added Type: new feature The issue requests / The PR implemements a new feature for RIOT Area: tools Area: Supplementary tools labels Feb 12, 2019

This was referenced Feb 12, 2019

sys/shell: cancel current line on CTRL-C. #11004

Merged

sys/shell: Exit the shell on ctrl-D #10788

Closed

jcarrano added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Feb 12, 2019

aabadie requested changes Feb 14, 2019

View reviewed changes

jcarrano force-pushed the support-miniterm.py branch from 5d1197c to 7478f60 Compare February 19, 2019 11:10

This was referenced Feb 20, 2019

tools/serial: add support for socat as riot terminal #11034

Merged

makefiles/serial: fix indent #11035

Merged

aabadie requested changes Feb 20, 2019

View reviewed changes

jcarrano force-pushed the support-miniterm.py branch from 7478f60 to 0c27453 Compare February 20, 2019 10:38

smlng reviewed Feb 25, 2019

View reviewed changes

tests/shell/Makefile Outdated Show resolved Hide resolved

fixup! add spaces

9b95699

jcarrano closed this Feb 25, 2019

This was referenced Nov 19, 2019

pkg: micropython: initial commit #2968

Merged

tools/serial.inc.mk: add support miniterm.py #12743

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tools/serial.inc.mk: Support miniterm.py. #11003

tools/serial.inc.mk: Support miniterm.py. #11003

jcarrano commented Feb 12, 2019 •

edited

Loading

aabadie left a comment

aabadie Feb 14, 2019

jcarrano Feb 19, 2019

aabadie Feb 14, 2019

aabadie Feb 14, 2019

jcarrano Feb 19, 2019

cladmi Feb 20, 2019

aabadie left a comment

aabadie Feb 20, 2019

aabadie Feb 20, 2019

aabadie Feb 20, 2019

jcarrano commented Feb 20, 2019

cladmi commented Feb 20, 2019

cladmi commented Feb 20, 2019

jcarrano commented Feb 25, 2019

	export TERMPROG ?= miniterm.py
	export TERMPROG ?= $(RIOT_TERMINAL)

		@@ -12,4 +12,10 @@ BOARD_BLACKLIST += chronos

		TEST_ON_CI_WHITELIST += all

		# In order to properly test and debug the shell it is better to use a terminal

tools/serial.inc.mk: Support miniterm.py. #11003

tools/serial.inc.mk: Support miniterm.py. #11003

Conversation

jcarrano commented Feb 12, 2019 • edited Loading

Contribution description

Testing procedure

Issues/PRs references

aabadie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aabadie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcarrano commented Feb 20, 2019

cladmi commented Feb 20, 2019

cladmi commented Feb 20, 2019

jcarrano commented Feb 25, 2019

jcarrano commented Feb 12, 2019 •

edited

Loading