boards: Get boards with J-Link slug

When using J-Link, the only available board data may be the product page URL. The URL's slug may indicate the board, but not match the Mbed database slug, so this is searched against Mbed slug, board_type and board_name in the database to try to find a match.

Author: wernerlewis

news/20210330104425.feature

@@ -0,0 +1 @@
+Add detection of devices connected with J-Link.

src/mbed_tools/devices/_internal/resolve_board.py

@@ -13,7 +13,12 @@
 
 from typing import Optional
 
-from mbed_tools.targets import Board, get_board_by_product_code, get_board_by_online_id
+from mbed_tools.targets import (
+ Board,
+ get_board_by_product_code,
+ get_board_by_online_id,
+ get_board_by_jlink_slug,
+)
 from mbed_tools.targets.exceptions import UnknownBoard, MbedTargetsError
 
 from mbed_tools.devices._internal.exceptions import NoBoardForCandidate, ResolveBoardError
@@ -36,7 +41,7 @@ def resolve_board(
  The rules are as follows:
 
  1. Use the product code from the mbed.htm file or details.txt if available
- 2. Use online ID from the htm file if available
+ 2. Use online ID from the htm file or Board.html if available
  3. Try to use the first 4 chars of the USB serial number as the product code
  """
  if product_code:
@@ -54,7 +59,10 @@ def resolve_board(
  slug = online_id.slug
  target_type = online_id.target_type
  try:
- return get_board_by_online_id(slug=slug, target_type=target_type)
+ if target_type == "jlink":
+ return get_board_by_jlink_slug(slug=slug)
+ else:
+ return get_board_by_online_id(slug=slug, target_type=target_type)
  except UnknownBoard:
  logger.error(f"Could not identify a board with the slug: '{slug}' and target type: '{target_type}'.")
  except MbedTargetsError as e:

src/mbed_tools/targets/__init__.py

@@ -28,5 +28,6 @@
 from mbed_tools.targets.get_board import (
  get_board_by_product_code,
  get_board_by_online_id,
+ get_board_by_jlink_slug,
 )
 from mbed_tools.targets.board import Board

src/mbed_tools/targets/get_board.py

@@ -45,6 +45,25 @@ def get_board_by_online_id(slug: str, target_type: str) -> Board:
  return get_board(lambda board: board.slug.casefold() == matched_slug and board.target_type == target_type)
 
 
+def get_board_by_jlink_slug(slug: str) -> Board:
+ """Returns first `mbed-tools.targets.board.Board` matching given slug.
+
+ With J-Link, the slug is extracted from a board manufacturer URL, and may not match
+ the Mbed slug. The J-Link slug is compared against the slug, board_name and
+ board_type of entries in the board database until a match is found.
+
+ Args:
+ slug: the J-Link slug to look up in the database.
+
+ Raises:
+ UnknownBoard: a board matching the slug was not found.
+ """
+ matched_slug = slug.casefold()
+ return get_board(
+ lambda board: any(matched_slug == c.casefold() for c in [board.slug, board.board_name, board.board_type])
+ )
+
+
 def get_board(matching: Callable) -> Board:
  """Returns first `mbed_tools.targets.board.Board` for which `matching` is True.
 

tests/devices/_internal/test_resolve_board.py

@@ -18,6 +18,12 @@ def get_board_by_product_code_mock():
  yield gbp
 
 
+@pytest.fixture
+def get_board_by_jlink_slug_mock():
+ with mock.patch("mbed_tools.devices._internal.resolve_board.get_board_by_jlink_slug", autospec=True) as gbp:
+ yield gbp
+
+
 @pytest.fixture
 def get_board_by_online_id_mock():
  with mock.patch("mbed_tools.devices._internal.resolve_board.get_board_by_online_id", autospec=True) as gbp:
@@ -76,6 +82,33 @@ def test_raises_when_database_lookup_fails(self, get_board_by_online_id_mock, ca
  assert caplog.records[-1].levelname == "ERROR"
 
 
+class TestResolveBoardUsingSlugFromJlink:
+ def test_returns_resolved_board(self, get_board_by_jlink_slug_mock):
+ online_id = OnlineId("jlink", "test-board")
+
+ subject = resolve_board(online_id=online_id)
+
+ assert subject == get_board_by_jlink_slug_mock.return_value
+ get_board_by_jlink_slug_mock.assert_called_once_with(online_id.slug)
+
+ def test_raises_when_board_not_found(self, get_board_by_jlink_slug_mock):
+ get_board_by_jlink_slug_mock.side_effect = UnknownBoard
+ online_id = OnlineId("jlink", "test-board")
+
+ with pytest.raises(NoBoardForCandidate):
+ resolve_board(online_id=online_id)
+
+ def test_raises_when_database_lookup_fails(self, get_board_by_jlink_slug_mock, caplog):
+ get_board_by_jlink_slug_mock.side_effect = MbedTargetsError
+ online_id = OnlineId("jlink", "test-board")
+
+ with pytest.raises(ResolveBoardError):
+ resolve_board(online_id=online_id)
+
+ assert repr(online_id) in caplog.text
+ assert caplog.records[-1].levelname == "ERROR"
+
+
 class TestResolveBoardUsingProductCodeFromSerial:
  def test_resolves_board_using_product_code_when_available(self, get_board_by_product_code_mock):
  serial_number = "0A9KJFKD0993WJKUFS0KLJ329090"

tests/targets/test_get_board.py

@@ -10,7 +10,7 @@
 from mbed_tools.targets._internal.exceptions import BoardAPIError
 
 # Import from top level as this is the expected interface for users
-from mbed_tools.targets import get_board_by_online_id, get_board_by_product_code
+from mbed_tools.targets import get_board_by_online_id, get_board_by_product_code, get_board_by_jlink_slug
 from mbed_tools.targets.get_board import (
  _DatabaseMode,
  _get_database_mode,
@@ -125,6 +125,24 @@ def test_matches_boards_by_online_id(self, mock_get_board):
  assert not fn(not_matching_board)
 
 
+class TestGetBoardByJlinkSlug:
+ def test_matches_boards_by_online_id(self, mock_get_board):
+ assert get_board_by_jlink_slug(slug="slug") == mock_get_board.return_value
+
+ # Test callable matches correct boards
+ fn = mock_get_board.call_args[0][0]
+
+ matching_board_1 = make_board(slug="slug")
+ matching_board_2 = make_board(board_type="slug")
+ matching_board_3 = make_board(board_name="slug")
+ not_matching_board = make_board()
+
+ assert fn(matching_board_1)
+ assert fn(matching_board_2)
+ assert fn(matching_board_3)
+ assert not fn(not_matching_board)
+
+
 class TestGetDatabaseMode:
  def test_returns_configured_database_mode(self, mock_env):
  mock_env.MBED_DATABASE_MODE = "OFFLINE"