build: Automatically determine image format to flash

The default image format is bin, but targets can override it with `"OUTPUT_EXT": "hex"` in `targets.json`. This is already taken care of in the CMake configuration generated by mbed-tools, but user still need to pass `--hex-file` if they want to run `mbed-tools compile` with `--flash` to flash a hex image. This commit makes the image selection automatic based on `OUTPUT_EXT`. Note: `--hex-file` is now redundant and thus removed. It does not make sense to have it anymore without also offering `--bin-file` for completeness. The test cases for bin and hex image flashing have been updated accordingly.

Author: LDong-Arm

news/20210602164800.feature

@@ -0,0 +1 @@
+The `--flash` option of `mbed-tools compile` now automatically selects bin or hex image. The option `--hex-file` is removed.

src/mbed_tools/build/config.py

@@ -5,20 +5,20 @@
 """Parses the Mbed configuration system and generates a CMake config script."""
 import pathlib
 
-from typing import Any
+from typing import Any, Tuple
 
 from mbed_tools.lib.json_helpers import decode_json_file
 from mbed_tools.project import MbedProgram
 from mbed_tools.targets import get_target_by_name
 from mbed_tools.build._internal.cmake_file import render_mbed_config_cmake_template
-from mbed_tools.build._internal.config.assemble_build_config import assemble_config
+from mbed_tools.build._internal.config.assemble_build_config import Config, assemble_config
 from mbed_tools.build._internal.write_files import write_file
 from mbed_tools.build.exceptions import MbedBuildError
 
 CMAKE_CONFIG_FILE = "mbed_config.cmake"
 
 
-def generate_config(target_name: str, toolchain: str, program: MbedProgram) -> pathlib.Path:
+def generate_config(target_name: str, toolchain: str, program: MbedProgram) -> Tuple[Config, pathlib.Path]:
  """Generate an Mbed config file at the program root by parsing the mbed config system.
 
  Args:
@@ -27,6 +27,7 @@ def generate_config(target_name: str, toolchain: str, program: MbedProgram) -> p
  program: The MbedProgram to configure.
 
  Returns:
+ Config object (UserDict)
  Path to the generated config file.
  """
  targets_data = _load_raw_targets_data(program)
@@ -39,7 +40,7 @@ def generate_config(target_name: str, toolchain: str, program: MbedProgram) -> p
  )
  cmake_config_file_path = program.files.cmake_build_dir / CMAKE_CONFIG_FILE
  write_file(cmake_config_file_path, cmake_file_contents)
- return cmake_config_file_path
+ return config, cmake_config_file_path
 
 
 def _load_raw_targets_data(program: MbedProgram) -> Any:

src/mbed_tools/cli/build.py

@@ -42,9 +42,6 @@
 @click.option(
  "-f", "--flash", is_flag=True, default=False, help="Flash the binary onto a device",
 )
-@click.option(
- "--hex-file", is_flag=True, default=False, help="Use hex file, this option should be used with '-f/--flash' option",
-)
 @click.option(
  "-s", "--sterm", is_flag=True, default=False, help="Launch a serial terminal to the device.",
 )
@@ -61,7 +58,6 @@ def build(
  mbed_target: str = "",
  clean: bool = False,
  flash: bool = False,
- hex_file: bool = False,
  sterm: bool = False,
  baudrate: int = 9600,
  mbed_os_path: str = None,
@@ -81,7 +77,6 @@ def build(
  mbed_target: The name of the Mbed target to build for.
  clean: Perform a clean build.
  flash: Flash the binary onto a device.
- hex_file: Use hex file, this option should be used with '-f/--flash' option.
  sterm: Open a serial terminal to the connected target.
  baudrate: Change the serial baud rate (ignored unless --sterm is also given).
  """
@@ -100,7 +95,7 @@ def build(
  click.echo("Configuring project and generating build system...")
  if custom_targets_json is not None:
  program.files.custom_targets_json = pathlib.Path(custom_targets_json)
- generate_config(mbed_target.upper(), toolchain, program)
+ config, _ = generate_config(mbed_target.upper(), toolchain, program)
  generate_build_system(program.root, build_tree, profile)
 
  click.echo("Building Mbed project...")
@@ -114,10 +109,9 @@ def build(
 
  if flash:
  for dev in devices:
+ hex_file = "OUTPUT_EXT" in config and config["OUTPUT_EXT"] == "hex"
  flashed_path = flash_binary(dev.mount_points[0].resolve(), program.root, build_tree, mbed_target, hex_file)
  click.echo(f"Copied {str(flashed_path.resolve())} to {len(devices)} device(s).")
- elif hex_file:
- click.echo("'--hex-file' option should be used with '-f/--flash' option")
 
  if sterm:
  dev = devices[0]

src/mbed_tools/cli/configure.py

@@ -67,5 +67,5 @@ def configure(
  program.files.cmake_build_dir = pathlib.Path(output_dir)
 
  mbed_target = mbed_target.upper()
- output_path = generate_config(mbed_target, toolchain, program)
+ _, output_path = generate_config(mbed_target, toolchain, program)
  click.echo(f"mbed_config.cmake has been generated and written to '{str(output_path.resolve())}'")

tests/cli/test_build.py

@@ -68,6 +68,8 @@ def test_calls_generate_build_system_if_build_tree_nonexistent(
  ):
  program = mbed_program.from_existing()
  with mock_project_directory(program, mbed_config_exists=True, build_tree_exists=False):
+ generate_config.return_value = [mock.MagicMock(), mock.MagicMock()]
+
  runner = CliRunner()
  runner.invoke(build, DEFAULT_BUILD_ARGS)
 
@@ -154,6 +156,8 @@ def test_build_system_regenerated_when_mbed_os_path_passed(
  build_tree_exists=True,
  build_subdir=pathlib.Path("K64F", "develop", "GCC_ARM"),
  ):
+ generate_config.return_value = [mock.MagicMock(), mock.MagicMock()]
+
  toolchain = "gcc_arm"
  target = "k64f"
  mbed_os_path = "./extern/mbed-os"
@@ -189,6 +193,8 @@ def test_build_folder_removed_when_clean_flag_passed(
  build_tree_exists=True,
  build_subdir=pathlib.Path("K64F", "develop", "GCC_ARM"),
  ):
+ generate_config.return_value = [mock.MagicMock(), mock.MagicMock()]
+
  toolchain = "gcc_arm"
  target = "k64f"
 
@@ -201,31 +207,55 @@ def test_build_folder_removed_when_clean_flag_passed(
 
  @mock.patch("mbed_tools.cli.build.flash_binary")
  @mock.patch("mbed_tools.cli.build.find_all_connected_devices")
- def test_build_flash_option(
- self, mock_find_devices, flash_binary, generate_config, mbed_program, build_project, generate_build_system
+ def test_build_flash_options_bin_target(
+ self,
+ mock_find_devices,
+ flash_binary,
+ generate_config,
+ mbed_program,
+ build_project,
+ generate_build_system,
  ):
+ # A target with bin images does not need OUTPUT_EXT defined
+ generate_config.return_value = [mock.MagicMock(), mock.MagicMock()]
  mock_find_devices.return_value = [mock.MagicMock()]
  runner = CliRunner()
  runner.invoke(build, ["--flash", *DEFAULT_BUILD_ARGS])
- flash_binary.assert_called_once()
+ call_args = flash_binary.call_args
+ args, kwargs = call_args
+ flash_binary.assert_called_once_with(args[0], args[1], args[2], args[3], False)
 
  @mock.patch("mbed_tools.cli.build.flash_binary")
  @mock.patch("mbed_tools.cli.build.find_all_connected_devices")
- def test_build_flash_and_hex_file_options(
- self, mock_find_devices, flash_binary, generate_config, mbed_program, build_project, generate_build_system
+ def test_build_flash_options_hex_target(
+ self,
+ mock_find_devices,
+ flash_binary,
+ generate_config,
+ mbed_program,
+ build_project,
+ generate_build_system,
  ):
+ generate_config.return_value = [{"OUTPUT_EXT": "hex"}, mock.MagicMock()]
  mock_find_devices.return_value = [mock.MagicMock()]
  runner = CliRunner()
- runner.invoke(build, ["--flash", "--hex-file", *DEFAULT_BUILD_ARGS])
+ runner.invoke(build, ["--flash", *DEFAULT_BUILD_ARGS])
  call_args = flash_binary.call_args
  args, kwargs = call_args
  flash_binary.assert_called_once_with(args[0], args[1], args[2], args[3], True)
 
  @mock.patch("mbed_tools.cli.build.flash_binary")
  @mock.patch("mbed_tools.cli.build.find_all_connected_devices")
  def test_build_flash_both_two_devices(
- self, mock_find_devices, flash_binary, generate_config, mbed_program, build_project, generate_build_system
+ self,
+ mock_find_devices,
+ flash_binary,
+ generate_config,
+ mbed_program,
+ build_project,
+ generate_build_system,
  ):
+ generate_config.return_value = [mock.MagicMock(), mock.MagicMock()]
  mock_find_devices.return_value = [mock.MagicMock(), mock.MagicMock()]
  runner = CliRunner()
  runner.invoke(build, ["--flash", *DEFAULT_BUILD_ARGS])
@@ -234,19 +264,20 @@ def test_build_flash_both_two_devices(
  @mock.patch("mbed_tools.cli.build.flash_binary")
  @mock.patch("mbed_tools.cli.build.find_connected_device")
  def test_build_flash_only_identifier_device(
- self, mock_find_device, flash_binary, generate_config, mbed_program, build_project, generate_build_system
+ self,
+ mock_find_device,
+ flash_binary,
+ generate_config,
+ mbed_program,
+ build_project,
+ generate_build_system,
  ):
+ generate_config.return_value = [mock.MagicMock(), mock.MagicMock()]
  mock_find_device.return_value = mock.MagicMock()
  runner = CliRunner()
  runner.invoke(build, ["--flash", "-m", "K64F[1]", "-t", "GCC_ARM"])
  self.assertEqual(flash_binary.call_count, 1)
 
- def test_build_only_hex_file_option(self, generate_config, mbed_program, build_project, generate_build_system):
- runner = CliRunner()
- result = runner.invoke(build, ["--hex-file", *DEFAULT_BUILD_ARGS])
-
- self.assertRegex(result.output, "-f/--flash")
-
  @mock.patch("mbed_tools.cli.build.terminal")
  @mock.patch("mbed_tools.cli.build.find_connected_device")
  def test_sterm_is_started_when_flag_passed(
@@ -256,6 +287,7 @@ def test_sterm_is_started_when_flag_passed(
  serial_port = "tty.k64f"
  baud = 115200
  mock_find_device.return_value = mock.Mock(serial_port=serial_port)
+ generate_config.return_value = [mock.MagicMock(), mock.MagicMock()]
 
  CliRunner().invoke(build, ["-m", target, "-t", "gcc_arm", "--sterm", "--baudrate", baud])
 
@@ -270,6 +302,7 @@ def test_raises_if_device_does_not_have_serial_port_and_sterm_flag_given(
  target = "K64F"
  serial_port = None
  mock_find_device.return_value = mock.Mock(serial_port=serial_port)
+ generate_config.return_value = [mock.MagicMock(), mock.MagicMock()]
 
  output = CliRunner().invoke(build, ["-m", target, "-t", "gcc_arm", "--sterm"])
  self.assertEqual(type(output.exception), SystemExit)