scripts: west_commands: extend build.dir-fmt format args

build.dir-fmt format string arguments are extended. New format args are
'west_ws' (absolute path to the west workspace directory) and
'source_dir_ws' (relative path of the source directory to the west
workspace).

Signed-off-by: Thorsten Klein <[email protected]>

Author: thorsten-klein

doc/develop/west/build-flash-debug.rst

@@ -395,11 +395,14 @@ You can :ref:`configure <west-config-cmd>` ``west build`` using these options.
        west whenever it needs to create or locate a build folder. The currently
        available arguments are:
 
+         - ``west_ws``: The absolute path from the west workspace.
          - ``board``: The board name
          - ``source_dir``: The relative path from the current working directory
            to the source directory. If the current working directory is inside
            the source directory this will be set to an empty string.
          - ``app``: The name of the source directory.
+         - ``source_dir_ws``: The relative path from the source directory
+           to the west topdir.
    * - ``build.generator``
      - String, default ``Ninja``. The `CMake Generator`_ to use to create a
        build system. (To set a generator for a single build, see the

scripts/west_commands/build.py

@@ -456,16 +456,28 @@ def _update_cache(self):
         with contextlib.suppress(FileNotFoundError):
             self.cmake_cache = CMakeCache.from_build_dir(self.build_dir)
 
+    def _get_dir_fmt_context(self):
+        board, _ = self._find_board()
+        source_dir = self._find_source_dir()
+        app = os.path.split(source_dir)[1]
+        west_ws = west_topdir(source_dir)
+        source_dir_ws = os.path.relpath(source_dir, west_ws)
+        return {
+            "west_ws" : west_ws,
+            "board" : board,
+            "app" : app,
+            "source_dir" : source_dir,
+            "source_dir_ws" : source_dir_ws
+        }
+
     def _setup_build_dir(self):
         # Initialize build_dir and created_build_dir attributes.
         # If we created the build directory, we must run CMake.
         self.dbg('setting up build directory', level=Verbosity.DBG_EXTREME)
         # The CMake Cache has not been loaded yet, so this is safe
-        board, _ = self._find_board()
-        source_dir = self._find_source_dir()
-        app = os.path.split(source_dir)[1]
-        build_dir = find_build_dir(self.args.build_dir, board=board,
-                                   source_dir=source_dir, app=app)
+
+        context = self._get_dir_fmt_context()
+        build_dir = find_build_dir(self.args.build_dir, **context)
         if not build_dir:
             self.die('Unable to determine a default build folder. Check '
                     'your build.dir-fmt configuration option')

scripts/west_commands/build_helpers.py

@@ -17,7 +17,7 @@
 import zcmake
 from west import log
 from west.configuration import config
-from west.util import escapes_directory
+from west.util import escapes_directory, west_topdir
 
 # Domains.py must be imported from the pylib directory, since
 # twister also uses the implementation
@@ -40,9 +40,14 @@
 def _resolve_build_dir(fmt, guess, cwd, **kwargs):
     # Remove any None values, we do not want 'None' as a string
     kwargs = {k: v for k, v in kwargs.items() if v is not None}
+    cwd = os.getcwd()
+    west_workspace = west_topdir(cwd)
+    kwargs['west_ws'] = west_workspace
     # Check if source_dir is below cwd first
     source_dir = kwargs.get('source_dir')
     if source_dir:
+        source_dir_ws = os.path.relpath(source_dir, west_workspace)
+        kwargs['source_dir_ws'] = source_dir_ws
         if escapes_directory(cwd, source_dir):
             kwargs['source_dir'] = os.path.relpath(source_dir, cwd)
         else:

scripts/west_commands/tests/test_build.py

@@ -5,6 +5,10 @@
 from argparse import Namespace
 
 from build import Build
+from pathlib import Path
+from west.configuration import config
+import configparser
+import os
 import pytest
 
 TEST_CASES = [
@@ -55,3 +59,59 @@ def test_parse_remainder(test_case):
     b._parse_remainder(test_case['r'])
     assert b.args.source_dir == test_case['s']
     assert b.args.cmake_opts == test_case['c']
+
+
+cwd = Path(os.getcwd())
+west_ws_dir = cwd.parent
+
+DIR_FMT_ARGS = Namespace(board='native_sim', source_dir=os.path.join("any", "project", "app"))
+
+TEST_CASES_DIR_FMT = [
+    # Test Case data:
+    # (test_config, build_dir,
+    #    expected)
+    ({}, None,
+        cwd / "build"),
+    ({}, "specified",
+        cwd / "specified"),
+    ({'dir-fmt': 'specified'}, None,
+        cwd / "specified"),
+    ({'dir-fmt': '{west_ws}/build'}, None,
+        west_ws_dir / "build"),
+    ({'dir-fmt': 'build/{board}'}, None,
+        cwd / "build" / "native_sim"),
+    ({'dir-fmt': 'build/{app}'}, None,
+        cwd / "build" / "app"),
+    ({'dir-fmt': 'build/{source_dir}'}, None,
+        os.path.abspath(cwd / "build" / os.path.relpath(DIR_FMT_ARGS.source_dir, cwd))),
+    ({'dir-fmt': 'build/{source_dir_ws}'}, None,
+        os.path.abspath(cwd / "build" / os.path.relpath(DIR_FMT_ARGS.source_dir, west_ws_dir)))
+]
+
+@pytest.mark.parametrize('test_case', TEST_CASES_DIR_FMT)
+def test_dir_fmt(monkeypatch, test_case):
+    # mock some default functions
+    monkeypatch.setattr(configparser.ConfigParser, "read", lambda self, filenames: None)
+    monkeypatch.setattr("os.makedirs", lambda *a, **kw: None)
+    monkeypatch.setattr("build_helpers.west_topdir", lambda *a, **kw: str(west_ws_dir))
+    monkeypatch.setattr("build.west_topdir", lambda *a, **kw: str(west_ws_dir))
+
+    # extract data from the test case
+    test_config, build_dir, expected = test_case
+
+    # set up Build
+    b = Build()
+    b.args = DIR_FMT_ARGS
+    b.args.build_dir = build_dir
+
+    # apply given test_config
+    if not config.has_section('build'):
+        config.add_section('build')
+    for k, v in test_config.items():
+        config.set('build', k, v)
+
+    # run the build-dir setup
+    b._setup_build_dir()
+
+    # check for expected build-dir
+    assert Path(expected) == Path(b.build_dir)