[PATCH v3 3/9] tests/avocado: excercise scripts/replay-dump.py in replay tests

Nicholas Piggin posted 9 patches 9 months ago
Maintainers: Richard Henderson <richard.henderson@linaro.org>, Paolo Bonzini <pbonzini@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Pavel Dovgalyuk <pavel.dovgaluk@ispras.ru>, Peter Xu <peterx@redhat.com>, Fabiano Rosas <farosas@suse.de>, John Snow <jsnow@redhat.com>, Cleber Rosa <crosa@redhat.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, Wainer dos Santos Moschetta <wainersm@redhat.com>, Beraldo Leal <bleal@redhat.com>
There is a newer version of this series
[PATCH v3 3/9] tests/avocado: excercise scripts/replay-dump.py in replay tests
Posted by Nicholas Piggin 9 months ago
This runs replay-dump.py after recording a trace, and fails the test if
the script fails.

replay-dump.py is modified to exit with non-zero if an error is
encountered while parsing, to support this.

Reviewed-by: Pavel Dovgalyuk <Pavel.Dovgalyuk@ispras.ru>
Signed-off-by: Nicholas Piggin <npiggin@gmail.com>
---
 scripts/replay-dump.py         |  6 ++++--
 tests/avocado/replay_kernel.py | 16 ++++++++++++++++
 tests/avocado/replay_linux.py  | 15 +++++++++++++++
 3 files changed, 35 insertions(+), 2 deletions(-)

diff --git a/scripts/replay-dump.py b/scripts/replay-dump.py
index b82659cfb6..4ce7ff51cc 100755
--- a/scripts/replay-dump.py
+++ b/scripts/replay-dump.py
@@ -21,6 +21,7 @@
 import argparse
 import struct
 import os
+import sys
 from collections import namedtuple
 from os import path
 
@@ -100,7 +101,7 @@ def call_decode(table, index, dumpfile):
         print("Could not decode index: %d" % (index))
         print("Entry is: %s" % (decoder))
         print("Decode Table is:\n%s" % (table))
-        return False
+        raise(Exception("unknown event"))
     else:
         return decoder.fn(decoder.eid, decoder.name, dumpfile)
 
@@ -121,7 +122,7 @@ def print_event(eid, name, string=None, event_count=None):
 def decode_unimp(eid, name, _unused_dumpfile):
     "Unimplemented decoder, will trigger exit"
     print("%s not handled - will now stop" % (name))
-    return False
+    raise(Exception("unhandled event"))
 
 def decode_plain(eid, name, _unused_dumpfile):
     "Plain events without additional data"
@@ -434,6 +435,7 @@ def decode_file(filename):
                                     dumpfile)
     except Exception as inst:
         print(f"error {inst}")
+        sys.exit(1)
 
     finally:
         print(f"Reached {dumpfile.tell()} of {dumpsize} bytes")
diff --git a/tests/avocado/replay_kernel.py b/tests/avocado/replay_kernel.py
index 10d99403a4..9b3ee6726b 100644
--- a/tests/avocado/replay_kernel.py
+++ b/tests/avocado/replay_kernel.py
@@ -13,6 +13,7 @@
 import shutil
 import logging
 import time
+import subprocess
 
 from avocado import skip
 from avocado import skipUnless
@@ -22,6 +23,11 @@
 from avocado.utils import process
 from boot_linux_console import LinuxKernelTest
 
+from pathlib import Path
+
+self_dir = Path(__file__).parent
+src_dir = self_dir.parent.parent
+
 class ReplayKernelBase(LinuxKernelTest):
     """
     Boots a Linux kernel in record mode and checks that the console
@@ -63,6 +69,8 @@ def run_vm(self, kernel_path, kernel_command_line, console_pattern,
             vm.shutdown()
             logger.info('finished the recording with log size %s bytes'
                         % os.path.getsize(replay_path))
+            self.run_replay_dump(replay_path)
+            logger.info('successfully tested replay-dump.py')
         else:
             vm.wait()
             logger.info('successfully finished the replay')
@@ -70,6 +78,14 @@ def run_vm(self, kernel_path, kernel_command_line, console_pattern,
         logger.info('elapsed time %.2f sec' % elapsed)
         return elapsed
 
+    def run_replay_dump(self, replay_path):
+        try:
+            subprocess.check_call(["./scripts/replay-dump.py",
+                                   "-f", replay_path],
+                                  cwd=src_dir, stdout=subprocess.DEVNULL)
+        except subprocess.CalledProcessError:
+            self.fail('replay-dump.py failed')
+
     def run_rr(self, kernel_path, kernel_command_line, console_pattern,
                shift=7, args=None):
         replay_path = os.path.join(self.workdir, 'replay.bin')
diff --git a/tests/avocado/replay_linux.py b/tests/avocado/replay_linux.py
index f3a43dc98c..e4539c5551 100644
--- a/tests/avocado/replay_linux.py
+++ b/tests/avocado/replay_linux.py
@@ -21,6 +21,11 @@
 from avocado.utils.path import find_command
 from avocado_qemu import LinuxTest
 
+from pathlib import Path
+
+self_dir = Path(__file__).parent
+src_dir = self_dir.parent.parent
+
 class ReplayLinux(LinuxTest):
     """
     Boots a Linux system, checking for a successful initialization
@@ -94,6 +99,8 @@ def launch_and_wait(self, record, args, shift):
             vm.shutdown()
             logger.info('finished the recording with log size %s bytes'
                 % os.path.getsize(replay_path))
+            self.run_replay_dump(replay_path)
+            logger.info('successfully tested replay-dump.py')
         else:
             vm.event_wait('SHUTDOWN', self.timeout)
             vm.wait()
@@ -108,6 +115,14 @@ def run_rr(self, args=None, shift=7):
         logger = logging.getLogger('replay')
         logger.info('replay overhead {:.2%}'.format(t2 / t1 - 1))
 
+    def run_replay_dump(self, replay_path):
+        try:
+            subprocess.check_call(["./scripts/replay-dump.py",
+                                   "-f", replay_path],
+                                  cwd=src_dir, stdout=subprocess.DEVNULL)
+        except subprocess.CalledProcessError:
+            self.fail('replay-dump.py failed')
+
 @skipUnless(os.getenv('AVOCADO_TIMEOUT_EXPECTED'), 'Test might timeout')
 class ReplayLinuxX8664(ReplayLinux):
     """
-- 
2.42.0
Re: [PATCH v3 3/9] tests/avocado: excercise scripts/replay-dump.py in replay tests
Posted by Alex Bennée 9 months ago
Nicholas Piggin <npiggin@gmail.com> writes:

> This runs replay-dump.py after recording a trace, and fails the test if
> the script fails.
>
> replay-dump.py is modified to exit with non-zero if an error is
> encountered while parsing, to support this.
>
> Reviewed-by: Pavel Dovgalyuk <Pavel.Dovgalyuk@ispras.ru>
> Signed-off-by: Nicholas Piggin <npiggin@gmail.com>
> ---
>  scripts/replay-dump.py         |  6 ++++--
>  tests/avocado/replay_kernel.py | 16 ++++++++++++++++
>  tests/avocado/replay_linux.py  | 15 +++++++++++++++
>  3 files changed, 35 insertions(+), 2 deletions(-)
>
> diff --git a/scripts/replay-dump.py b/scripts/replay-dump.py
> index b82659cfb6..4ce7ff51cc 100755
> --- a/scripts/replay-dump.py
> +++ b/scripts/replay-dump.py
> @@ -21,6 +21,7 @@
>  import argparse
>  import struct
>  import os
> +import sys
>  from collections import namedtuple
>  from os import path
>  
> @@ -100,7 +101,7 @@ def call_decode(table, index, dumpfile):
>          print("Could not decode index: %d" % (index))
>          print("Entry is: %s" % (decoder))
>          print("Decode Table is:\n%s" % (table))
> -        return False
> +        raise(Exception("unknown event"))
>      else:
>          return decoder.fn(decoder.eid, decoder.name, dumpfile)
>  
> @@ -121,7 +122,7 @@ def print_event(eid, name, string=None, event_count=None):
>  def decode_unimp(eid, name, _unused_dumpfile):
>      "Unimplemented decoder, will trigger exit"
>      print("%s not handled - will now stop" % (name))
> -    return False
> +    raise(Exception("unhandled event"))
>  
>  def decode_plain(eid, name, _unused_dumpfile):
>      "Plain events without additional data"
> @@ -434,6 +435,7 @@ def decode_file(filename):
>                                      dumpfile)
>      except Exception as inst:
>          print(f"error {inst}")
> +        sys.exit(1)
>  
>      finally:
>          print(f"Reached {dumpfile.tell()} of {dumpsize} bytes")
> diff --git a/tests/avocado/replay_kernel.py b/tests/avocado/replay_kernel.py
> index 10d99403a4..9b3ee6726b 100644
> --- a/tests/avocado/replay_kernel.py
> +++ b/tests/avocado/replay_kernel.py
> @@ -13,6 +13,7 @@
>  import shutil
>  import logging
>  import time
> +import subprocess
>  
>  from avocado import skip
>  from avocado import skipUnless
> @@ -22,6 +23,11 @@
>  from avocado.utils import process
>  from boot_linux_console import LinuxKernelTest
>  
> +from pathlib import Path
> +
> +self_dir = Path(__file__).parent
> +src_dir = self_dir.parent.parent
> +

Whats this for? It doesn't seem to be used.

>  class ReplayKernelBase(LinuxKernelTest):
>      """
>      Boots a Linux kernel in record mode and checks that the console
> @@ -63,6 +69,8 @@ def run_vm(self, kernel_path, kernel_command_line, console_pattern,
>              vm.shutdown()
>              logger.info('finished the recording with log size %s bytes'
>                          % os.path.getsize(replay_path))
> +            self.run_replay_dump(replay_path)
> +            logger.info('successfully tested replay-dump.py')
>          else:
>              vm.wait()
>              logger.info('successfully finished the replay')
> @@ -70,6 +78,14 @@ def run_vm(self, kernel_path, kernel_command_line, console_pattern,
>          logger.info('elapsed time %.2f sec' % elapsed)
>          return elapsed
>  
> +    def run_replay_dump(self, replay_path):
> +        try:
> +            subprocess.check_call(["./scripts/replay-dump.py",
> +                                   "-f", replay_path],
> +                                  cwd=src_dir, stdout=subprocess.DEVNULL)
> +        except subprocess.CalledProcessError:
> +            self.fail('replay-dump.py failed')
> +
>      def run_rr(self, kernel_path, kernel_command_line, console_pattern,
>                 shift=7, args=None):
>          replay_path = os.path.join(self.workdir, 'replay.bin')
> diff --git a/tests/avocado/replay_linux.py b/tests/avocado/replay_linux.py
> index f3a43dc98c..e4539c5551 100644
> --- a/tests/avocado/replay_linux.py
> +++ b/tests/avocado/replay_linux.py
> @@ -21,6 +21,11 @@
>  from avocado.utils.path import find_command
>  from avocado_qemu import LinuxTest
>  
> +from pathlib import Path
> +
> +self_dir = Path(__file__).parent
> +src_dir = self_dir.parent.parent
> +

And here to.

>  class ReplayLinux(LinuxTest):
>      """
>      Boots a Linux system, checking for a successful initialization
> @@ -94,6 +99,8 @@ def launch_and_wait(self, record, args, shift):
>              vm.shutdown()
>              logger.info('finished the recording with log size %s bytes'
>                  % os.path.getsize(replay_path))
> +            self.run_replay_dump(replay_path)
> +            logger.info('successfully tested replay-dump.py')
>          else:
>              vm.event_wait('SHUTDOWN', self.timeout)
>              vm.wait()
> @@ -108,6 +115,14 @@ def run_rr(self, args=None, shift=7):
>          logger = logging.getLogger('replay')
>          logger.info('replay overhead {:.2%}'.format(t2 / t1 - 1))
>  
> +    def run_replay_dump(self, replay_path):
> +        try:
> +            subprocess.check_call(["./scripts/replay-dump.py",
> +                                   "-f", replay_path],
> +                                  cwd=src_dir, stdout=subprocess.DEVNULL)
> +        except subprocess.CalledProcessError:
> +            self.fail('replay-dump.py failed')
> +
>  @skipUnless(os.getenv('AVOCADO_TIMEOUT_EXPECTED'), 'Test might timeout')
>  class ReplayLinuxX8664(ReplayLinux):
>      """

-- 
Alex Bennée
Virtualisation Tech Lead @ Linaro
Re: [PATCH v3 3/9] tests/avocado: excercise scripts/replay-dump.py in replay tests
Posted by Nicholas Piggin 9 months ago
On Wed Feb 28, 2024 at 5:21 AM AEST, Alex Bennée wrote:
> Nicholas Piggin <npiggin@gmail.com> writes:
>
> > This runs replay-dump.py after recording a trace, and fails the test if
> > the script fails.
> >
> > replay-dump.py is modified to exit with non-zero if an error is
> > encountered while parsing, to support this.
> >
> > Reviewed-by: Pavel Dovgalyuk <Pavel.Dovgalyuk@ispras.ru>
> > Signed-off-by: Nicholas Piggin <npiggin@gmail.com>
> > ---
> >  scripts/replay-dump.py         |  6 ++++--
> >  tests/avocado/replay_kernel.py | 16 ++++++++++++++++
> >  tests/avocado/replay_linux.py  | 15 +++++++++++++++
> >  3 files changed, 35 insertions(+), 2 deletions(-)
> >
> > diff --git a/scripts/replay-dump.py b/scripts/replay-dump.py
> > index b82659cfb6..4ce7ff51cc 100755
> > --- a/scripts/replay-dump.py
> > +++ b/scripts/replay-dump.py
> > @@ -21,6 +21,7 @@
> >  import argparse
> >  import struct
> >  import os
> > +import sys
> >  from collections import namedtuple
> >  from os import path
> >  
> > @@ -100,7 +101,7 @@ def call_decode(table, index, dumpfile):
> >          print("Could not decode index: %d" % (index))
> >          print("Entry is: %s" % (decoder))
> >          print("Decode Table is:\n%s" % (table))
> > -        return False
> > +        raise(Exception("unknown event"))
> >      else:
> >          return decoder.fn(decoder.eid, decoder.name, dumpfile)
> >  
> > @@ -121,7 +122,7 @@ def print_event(eid, name, string=None, event_count=None):
> >  def decode_unimp(eid, name, _unused_dumpfile):
> >      "Unimplemented decoder, will trigger exit"
> >      print("%s not handled - will now stop" % (name))
> > -    return False
> > +    raise(Exception("unhandled event"))
> >  
> >  def decode_plain(eid, name, _unused_dumpfile):
> >      "Plain events without additional data"
> > @@ -434,6 +435,7 @@ def decode_file(filename):
> >                                      dumpfile)
> >      except Exception as inst:
> >          print(f"error {inst}")
> > +        sys.exit(1)
> >  
> >      finally:
> >          print(f"Reached {dumpfile.tell()} of {dumpsize} bytes")
> > diff --git a/tests/avocado/replay_kernel.py b/tests/avocado/replay_kernel.py
> > index 10d99403a4..9b3ee6726b 100644
> > --- a/tests/avocado/replay_kernel.py
> > +++ b/tests/avocado/replay_kernel.py
> > @@ -13,6 +13,7 @@
> >  import shutil
> >  import logging
> >  import time
> > +import subprocess
> >  
> >  from avocado import skip
> >  from avocado import skipUnless
> > @@ -22,6 +23,11 @@
> >  from avocado.utils import process
> >  from boot_linux_console import LinuxKernelTest
> >  
> > +from pathlib import Path
> > +
> > +self_dir = Path(__file__).parent
> > +src_dir = self_dir.parent.parent
> > +
>
> Whats this for? It doesn't seem to be used.

Thanks for finding it, must be just a leftover from some earlier hack.
I'll take it out.

Thanks,
Nick