Strip prompt by default in send_expect

  From: Owen Hilyard <ohilyard@iol.unh.edu>

During investigation of timeout exceptions during performance testing, the
community lab found that trailing whitespace in run commands was the cause
of some of the timeouts. This patch makes the Crb version of send_expect
strip whitespace from the expected string by default. It is possible to
disable this behavior should it be needed, but we expect that the majority
of use-cases are matching non-whitespace characters.

Signed-off-by: Owen Hilyard <ohilyard@iol.unh.edu>
---
 framework/crb.py | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
  

Hello All,

David submitted the patch on my behalf as he was the one doing testing for
it while I was occupied with school. We considered this patch important
enough to sidestep waiting for me to come back to submit it due to the
issue's impact on ARM testing.

Owen Hilyard

On Thu, Apr 15, 2021 at 10:09 AM dliu <dliu@iol.unh.edu> wrote:

> From: Owen Hilyard <ohilyard@iol.unh.edu>
>
> During investigation of timeout exceptions during performance testing, the
> community lab found that trailing whitespace in run commands was the cause
> of some of the timeouts. This patch makes the Crb version of send_expect
> strip whitespace from the expected string by default. It is possible to
> disable this behavior should it be needed, but we expect that the majority
> of use-cases are matching non-whitespace characters.
>
> Signed-off-by: Owen Hilyard <ohilyard@iol.unh.edu>
> ---
>  framework/crb.py | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
>
> diff --git a/framework/crb.py b/framework/crb.py
> index e7c1cc1c..3964e213 100644
> --- a/framework/crb.py
> +++ b/framework/crb.py
> @@ -79,12 +79,19 @@ class Crb(object):
>              self.alt_session = None
>
>      def send_expect(self, cmds, expected, timeout=TIMEOUT,
> -                    alt_session=False, verify=False):
> +                    alt_session=False, verify=False,
> trim_whitespace=True):
>          """
>          Send commands to crb and return string before expected string. If
>          there's no expected string found before timeout, TimeoutException
> will
>          be raised.
> +
> +        By default, it will trim the whitespace from the expected string.
> This
> +        behavior can be turned off via the trim_whitespace argument.
>          """
> +
> +        if trim_whitespace:
> +            expected = expected.strip()
> +
>          # sometimes there will be no alt_session like VM dut
>          if alt_session and self.alt_session:
>              return self.alt_session.session.send_expect(cmds, expected,
> --
> 2.27.0
>
>
  

> -----Original Message-----
> From: dliu <dliu@iol.unh.edu>
> Sent: 2021年4月15日 22:10
> To: dts@dpdk.org
> Cc: Tu, Lijuan <lijuan.tu@intel.com>; Owen Hilyard <ohilyard@iol.unh.edu>
> Subject: [PATCH] Strip prompt by default in send_expect
> 
> From: Owen Hilyard <ohilyard@iol.unh.edu>
> 
> During investigation of timeout exceptions during performance testing, the
> community lab found that trailing whitespace in run commands was the cause of
> some of the timeouts. This patch makes the Crb version of send_expect strip
> whitespace from the expected string by default. It is possible to disable this
> behavior should it be needed, but we expect that the majority of use-cases are
> matching non-whitespace characters.
> 
> Signed-off-by: Owen Hilyard <ohilyard@iol.unh.edu>

Applied again.
Some impacted cases are fixed by http://patchwork.dpdk.org/project/dts/patch/20210603092151.1847-1-leweix.yang@intel.com/

> ---
>  framework/crb.py | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
> 
> diff --git a/framework/crb.py b/framework/crb.py index e7c1cc1c..3964e213
> 100644
> --- a/framework/crb.py
> +++ b/framework/crb.py
> @@ -79,12 +79,19 @@ class Crb(object):
>              self.alt_session = None
> 
>      def send_expect(self, cmds, expected, timeout=TIMEOUT,
> -                    alt_session=False, verify=False):
> +                    alt_session=False, verify=False, trim_whitespace=True):
>          """
>          Send commands to crb and return string before expected string. If
>          there's no expected string found before timeout, TimeoutException will
>          be raised.
> +
> +        By default, it will trim the whitespace from the expected string. This
> +        behavior can be turned off via the trim_whitespace argument.
>          """
> +
> +        if trim_whitespace:
> +            expected = expected.strip()
> +
>          # sometimes there will be no alt_session like VM dut
>          if alt_session and self.alt_session:
>              return self.alt_session.session.send_expect(cmds, expected,
> --
> 2.27.0