[v4,04/10] tests/vm: add --boot-console switch

Added ability to view console during boot via
--boot-console switch to basevm.py.  This helps debug issues that occur
during the boot sequence.
Also added a new special variable to vm-build:
BOOT_CONSOLE=1 will cause this new --boot-console switch to be set.
Signed-off-by: Robert Foley <robert.foley@linaro.org>
---
 tests/vm/Makefile.include |  4 ++++
 tests/vm/basevm.py        | 11 +++++++++--
 2 files changed, 13 insertions(+), 2 deletions(-)

Robert Foley <robert.foley@linaro.org> writes:

> Added ability to view console during boot via
> --boot-console switch to basevm.py.  This helps debug issues that occur
> during the boot sequence.
> Also added a new special variable to vm-build:
> BOOT_CONSOLE=1 will cause this new --boot-console switch to be set.

Hmm why isn't this output covered by DEBUG=1? I'm wary of adding another
debug knob rather than just including the extra information under our
existing DEBUG output.

> Signed-off-by: Robert Foley <robert.foley@linaro.org>
> ---
>  tests/vm/Makefile.include |  4 ++++
>  tests/vm/basevm.py        | 11 +++++++++--
>  2 files changed, 13 insertions(+), 2 deletions(-)
>
> diff --git a/tests/vm/Makefile.include b/tests/vm/Makefile.include
> index 78a2de1f82..d921ee14cf 100644
> --- a/tests/vm/Makefile.include
> +++ b/tests/vm/Makefile.include
> @@ -40,6 +40,7 @@ endif
>  	@echo '    EXTRA_CONFIGURE_OPTS="..."'
>  	@echo "    J=[0..9]*            	 - Override the -jN parameter for make commands"
>  	@echo "    DEBUG=1              	 - Enable verbose output on host and interactive debugging"
> +	@echo "    BOOT_CONSOLE=1        	 - Show the console output at boot time. "
>  	@echo "    V=1				 - Enable verbose ouput on host and guest commands"
>  	@echo "    QEMU=/path/to/qemu		 - Change path to QEMU binary"
>  	@echo "    QEMU_IMG=/path/to/qemu-img	 - Change path to qemu-img tool"
> @@ -62,6 +63,7 @@ $(IMAGES_DIR)/%.img:	$(SRC_PATH)/tests/vm/% \
>  	$(call quiet-command, \
>  		$(PYTHON) $< \
>  		$(if $(V)$(DEBUG), --debug) \
> +		$(if $(BOOT_CONSOLE),--boot-console) \
>  		--image "$@" \
>  		--force \
>  		--build-image $@, \
> @@ -76,6 +78,7 @@ vm-build-%: $(IMAGES_DIR)/%.img
>  		$(if $(DEBUG), --interactive) \
>  		$(if $(J),--jobs $(J)) \
>  		$(if $(V),--verbose) \
> +		$(if $(BOOT_CONSOLE),--boot-console) \
>  		--image "$<" \
>  		$(if $(BUILD_TARGET),--build-target $(BUILD_TARGET)) \
>  		--snapshot \
> @@ -96,6 +99,7 @@ vm-boot-ssh-%: $(IMAGES_DIR)/%.img
>  	$(call quiet-command, \
>  		$(PYTHON) $(SRC_PATH)/tests/vm/$* \
>  		$(if $(J),--jobs $(J)) \
> +		$(if $(BOOT_CONSOLE),--boot-console) \
>  		--image "$<" \
>  		--interactive \
>  		false, \
> diff --git a/tests/vm/basevm.py b/tests/vm/basevm.py
> index dd545d3d1d..aab3d98edf 100644
> --- a/tests/vm/basevm.py
> +++ b/tests/vm/basevm.py
> @@ -85,8 +85,10 @@ class BaseVM(object):
>      # 4 is arbitrary, but greater than 2,
>      # since we found we need to wait more than twice as long.
>      tcg_ssh_timeout_multiplier = 4
> -    def __init__(self, debug=False, vcpus=None, config=None):
> +    def __init__(self, debug=False, vcpus=None, config=None,
> +                 boot_console=None):
>          self._guest = None
> +        self._boot_console = boot_console
>          # Allow input config to override defaults.
>          self._config = DEFAULT_CONFIG.copy()
>          if config != None:
> @@ -535,6 +537,8 @@ def parse_args(vmcls):
>      parser.add_option("--config", "-c", default=None,
>                        help="Provide config yaml for configuration. "\
>                             "See config_example.yaml for example.")
> +    parser.add_option("--boot-console", action="store_true",
> +                      help="Show console during boot. ")
>      parser.disable_interspersed_args()
>      return parser.parse_args()
>  
> @@ -549,7 +553,8 @@ def main(vmcls, config=None):
>          config = parse_config(config, args)
>          logging.basicConfig(level=(logging.DEBUG if args.debug
>                                     else logging.WARN))
> -        vm = vmcls(debug=args.debug, vcpus=args.jobs, config=config)
> +        vm = vmcls(debug=args.debug, vcpus=args.jobs, config=config,
> +                   boot_console=args.boot_console)
>          if args.build_image:
>              if os.path.exists(args.image) and not args.force:
>                  sys.stderr.writelines(["Image file exists: %s\n" % args.image,
> @@ -569,6 +574,8 @@ def main(vmcls, config=None):
>          if args.snapshot:
>              img += ",snapshot=on"
>          vm.boot(img)
> +        if vm._boot_console:
> +            vm.wait_boot()
>          vm.wait_ssh()
>      except Exception as e:
>          if isinstance(e, SystemExit) and e.code == 0:

On Mon, 11 May 2020 at 05:13, Alex Bennée <alex.bennee@linaro.org> wrote:
>
>
> Robert Foley <robert.foley@linaro.org> writes:
>
> > Added ability to view console during boot via
> > --boot-console switch to basevm.py.  This helps debug issues that occur
> > during the boot sequence.
> > Also added a new special variable to vm-build:
> > BOOT_CONSOLE=1 will cause this new --boot-console switch to be set.
>
> Hmm why isn't this output covered by DEBUG=1? I'm wary of adding another
> debug knob rather than just including the extra information under our
> existing DEBUG output.

This is a good point.  I will add this support under DEBUG=1.

Thanks,
-Rob