Initial zephyr/west integration support

Author: brondani

cmd/cbuild2cmake/commands/root_test.go

@@ -338,4 +338,18 @@ set(OUTPUTS_1
 		assert.Nil(err)
 		assert.False(mismatch)
 	})
+
+	t.Run("test west solution", func(t *testing.T) {
+		cmd := commands.NewRootCmd()
+		testCaseRoot := testRoot + "/run/solutions/west"
+		cbuildIdxFile := testCaseRoot + "/solution.cbuild-idx.yml"
+		cmd.SetArgs([]string{cbuildIdxFile, "--debug"})
+		err := cmd.Execute()
+		assert.Nil(err)
+
+		// check golden references
+		err, mismatch := inittest.CompareFiles(testCaseRoot+"/ref", testCaseRoot+"/tmp")
+		assert.Nil(err)
+		assert.False(mismatch)
+	})
 }

pkg/maker/contextlists.go

@@ -40,7 +40,7 @@ func (m *Maker) CreateContextCMakeLists(index int) error {
 	}
 
 	// Create toolchain.cmake
-	err := m.CMakeCreateToolchain(index, contextDir)
+	err := m.CMakeCreateToolchain(index, contextDir, true)
 	if err != nil {
 		return err
 	}
@@ -161,14 +161,18 @@ include("components.cmake")
 	return err
 }
 
-func (m *Maker) CMakeCreateToolchain(index int, contextDir string) error {
+func (m *Maker) CMakeCreateToolchain(index int, contextDir string, inc bool) error {
 	toolchainConfig, _ := filepath.Rel(m.EnvVars.CompilerRoot, m.SelectedToolchainConfig[index])
 	toolchainConfig = "${CMSIS_COMPILER_ROOT}/" + filepath.ToSlash(toolchainConfig)
+	var include string
+	if inc {
+		include = "include(\"" + toolchainConfig + "\")\n"
+	}
 	content := `# toolchain.cmake
 
 set(REGISTERED_TOOLCHAIN_ROOT "` + m.RegisteredToolchains[m.SelectedToolchainVersion[index]].Path + `")
 set(REGISTERED_TOOLCHAIN_VERSION "` + m.SelectedToolchainVersion[index].String() + `")
-include("` + toolchainConfig + `")
+` + include + `
 `
 	filename := path.Join(contextDir, "toolchain.cmake")
 	err := utils.UpdateFile(filename, content)

pkg/maker/contextlists_test.go

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2025 Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package maker_test
+
+import (
+	"testing"
+
+	"github.com/Open-CMSIS-Pack/cbuild2cmake/pkg/maker"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestContextLists(t *testing.T) {
+	assert := assert.New(t)
+
+	t.Run("test context cmakelists creation", func(t *testing.T) {
+		var m maker.Maker
+		m.Params.InputFile = testRoot + "/run/solutions/build-cpp/solution.cbuild-idx.yml"
+		err := m.GenerateCMakeLists()
+		assert.Nil(err)
+		for index := range m.Cbuilds {
+			err = m.CreateContextCMakeLists(index)
+			assert.Nil(err)
+		}
+	})
+}

pkg/maker/maker.go

@@ -94,7 +94,11 @@ func (m *Maker) GenerateCMakeLists() error {
 
 	// Create context specific CMake files
 	for index := range m.Cbuilds {
-		err = m.CreateContextCMakeLists(index)
+		if m.CbuildIndex.BuildIdx.Cbuilds[index].West {
+			err = m.CreateWestCMakeLists(index)
+		} else {
+			err = m.CreateContextCMakeLists(index)
+		}
 		if err != nil {
 			return err
 		}

pkg/maker/maker_test.go

@@ -51,4 +51,11 @@ func TestMaker(t *testing.T) {
 		err := m.GenerateCMakeLists()
 		assert.Nil(err)
 	})
+
+	t.Run("test maker with west solution", func(t *testing.T) {
+		var m maker.Maker
+		m.Params.InputFile = testRoot + "/run/solutions/west/solution.cbuild-idx.yml"
+		err := m.GenerateCMakeLists()
+		assert.Nil(err)
+	})
 }

pkg/maker/parser.go

@@ -74,6 +74,7 @@ type Cbuild struct {
 		Generators       []struct{}    `yaml:"generators"`
 		ConstructedFiles []Files       `yaml:"constructed-files"`
 		Licenses         []struct{}    `yaml:"licenses"`
+		West             West          `yaml:"west"`
 	} `yaml:"build"`
 	BaseDir          string
 	ContextRoot      string
@@ -94,6 +95,7 @@ type Cbuilds struct {
 	Project       string   `yaml:"project"`
 	Configuration string   `yaml:"configuration"`
 	DependsOn     []string `yaml:"depends-on"`
+	West          bool     `yaml:"west"`
 }
 
 type Clayers struct {
@@ -241,6 +243,15 @@ type Packs struct {
 	Path string `yaml:"path"`
 }
 
+type West struct {
+	ProjectId string        `yaml:"project-id"`
+	AppPath   string        `yaml:"app-path"`
+	Board     string        `yaml:"board"`
+	Device    string        `yaml:"device"`
+	WestDefs  []interface{} `yaml:"west-defs"`
+	WestOpt   []string      `yaml:"west-opt"`
+}
+
 func (m *Maker) ParseCbuildIndexFile(cbuildIndexFile string) (data CbuildIndex, err error) {
 	yfile, err := os.ReadFile(cbuildIndexFile)
 	if err != nil {

pkg/maker/superlists.go

@@ -20,10 +20,13 @@ const CMAKE_MIN_REQUIRED = "3.27"
 
 func (m *Maker) CreateSuperCMakeLists() error {
 	// Iterate over cbuilds
-	var contexts, dirs, contextOutputs string
+	var contexts, dirs, westContextFlags, contextOutputs string
+	west := false
 	for i, cbuild := range m.Cbuilds {
 		contexts = contexts + "  \"" + strings.ReplaceAll(cbuild.BuildDescType.Context, " ", "_") + "\"\n"
 		dirs = dirs + "  \"${CMAKE_CURRENT_SOURCE_DIR}/" + cbuild.BuildDescType.Context + "\"\n"
+		west = west || (cbuild.BuildDescType.West.AppPath != "")
+		westContextFlags = westContextFlags + "  \"" + strconv.FormatBool(west) + "\"\n"
 
 		var contextOutputsName = "OUTPUTS_" + strconv.Itoa(i+1)
 		contextOutputs += "\nset(" + contextOutputsName + "\n"
@@ -41,6 +44,13 @@ func (m *Maker) CreateSuperCMakeLists() error {
 		contextOutputs += ")"
 	}
 
+	var westContexts, westContextCheck, westTarget string
+	if west {
+		westContexts = "\nset(WEST_CONTEXTS\n" + westContextFlags + ")\n"
+		westContextCheck = "\n  list(GET WEST_CONTEXTS ${INDEX} WEST_CONTEXT)\n  if(WEST_CONTEXT)\n    set(WEST_TARGET \"--target west\")\n  endif()"
+		westTarget = " ${WEST_TARGET}"
+	}
+
 	var verbosity, logConfigure, stepLog string
 	if m.Options.Debug || m.Options.Verbose {
 		verbosity = " --verbose"
@@ -68,7 +78,7 @@ math(EXPR CONTEXTS_LENGTH "${CONTEXTS_LENGTH}-1")
 
 set(DIRS
 ` + dirs + `)
-` + contextOutputs + `
+` + westContexts + contextOutputs + `
 
 set(ARGS
   "-DSOLUTION_ROOT=${SOLUTION_ROOT}"
@@ -84,7 +94,7 @@ foreach(INDEX RANGE ${CONTEXTS_LENGTH})
 
   math(EXPR N "${INDEX}+1")
   list(GET CONTEXTS ${INDEX} CONTEXT)
-  list(GET DIRS ${INDEX} DIR)
+  list(GET DIRS ${INDEX} DIR)` + westContextCheck + `
 
   # Create external project, set configure and build steps
   ExternalProject_Add(${CONTEXT}
@@ -95,7 +105,7 @@ foreach(INDEX RANGE ${CONTEXTS_LENGTH})
     TEST_COMMAND          ""
     CONFIGURE_COMMAND     ${CMAKE_COMMAND} -G Ninja -S <SOURCE_DIR> -B <BINARY_DIR> ${ARGS} 
     BUILD_COMMAND         ${CMAKE_COMMAND} -E echo "Building CMake target '${CONTEXT}'"
-    COMMAND               ${CMAKE_COMMAND} --build <BINARY_DIR>` + verbosity + `
+    COMMAND               ${CMAKE_COMMAND} --build <BINARY_DIR>` + westTarget + verbosity + `
     BUILD_ALWAYS          TRUE
     BUILD_BYPRODUCTS      ${OUTPUTS_${N}}` + logConfigure + `
     USES_TERMINAL_BUILD   ON

pkg/maker/west.go

@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2025 Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package maker
+
+import (
+	"path"
+	"path/filepath"
+	"strings"
+
+	"github.com/Open-CMSIS-Pack/cbuild2cmake/pkg/utils"
+)
+
+var WestToolchainMap = map[string]string{
+	"AC6":   "armclang",
+	"GCC":   "gnuarmemb",
+	"IAR":   "iar",
+	"CLANG": "llvm",
+}
+
+func (m *Maker) CreateWestCMakeLists(index int) error {
+	cbuild := &m.Cbuilds[index]
+	cbuild.ContextRoot, _ = filepath.Rel(m.SolutionRoot, cbuild.BaseDir)
+	cbuild.ContextRoot = filepath.ToSlash(cbuild.ContextRoot)
+	cbuild.Toolchain = m.RegisteredToolchains[m.SelectedToolchainVersion[index]].Name
+	outDir := cbuild.AddRootPrefix(cbuild.ContextRoot, cbuild.BuildDescType.OutputDirs.Outdir)
+	contextDir := path.Join(m.SolutionTmpDir, cbuild.BuildDescType.Context)
+	westApp := cbuild.AddRootPrefix(cbuild.ContextRoot, cbuild.BuildDescType.West.AppPath)
+	westToolchain := WestToolchainMap[cbuild.BuildDescType.Compiler]
+
+	var westOptions, westDefs string
+	var westOptionsRef, westDefsRef string
+	for _, opt := range cbuild.BuildDescType.West.WestOpt {
+		westOptions += "\n  " + opt
+	}
+	if len(westOptions) > 0 {
+		westOptions = "\nset(WEST_OPTIONS" + westOptions + "\n)"
+		westOptionsRef = " ${WEST_OPTIONS}"
+	}
+
+	for _, define := range cbuild.BuildDescType.West.WestDefs {
+		key, value := utils.GetDefine(define)
+		def := key
+		if len(value) > 0 {
+			def += "=" + value
+		}
+		westDefs += "\n  -D" + def
+	}
+	if len(westDefs) > 0 {
+		westDefs = "\nset(WEST_DEFS" + westDefs + "\n)"
+		westDefsRef = " -- ${WEST_DEFS}"
+	}
+
+	// Create toolchain.cmake
+	err := m.CMakeCreateToolchain(index, contextDir, false)
+	if err != nil {
+		return err
+	}
+
+	// Create CMakeLists content
+	content := `cmake_minimum_required(VERSION 3.27)
+
+# Roots
+include("../roots.cmake")
+
+set(CONTEXT ` + strings.ReplaceAll(cbuild.BuildDescType.Context, " ", "_") + `)
+set(TARGET ${CONTEXT})
+set(OUT_DIR "` + outDir + `")
+set(WEST_BOARD "` + cbuild.BuildDescType.West.Board + `")
+set(WEST_APP "` + westApp + `")
+
+# Toolchain config map
+include("toolchain.cmake")
+
+# Setup project
+project(${CONTEXT} LANGUAGES NONE)
+` + westOptions + westDefs + `
+
+# Environment variables
+set(ZEPHYR_TOOLCHAIN_PATH "${REGISTERED_TOOLCHAIN_ROOT}/..")
+cmake_path(ABSOLUTE_PATH ZEPHYR_TOOLCHAIN_PATH NORMALIZE OUTPUT_VARIABLE ZEPHYR_TOOLCHAIN_PATH)
+set(ENV_VARS
+  ` + strings.ToUpper(westToolchain) + `_TOOLCHAIN_PATH="${ZEPHYR_TOOLCHAIN_PATH}"
+  ZEPHYR_TOOLCHAIN_VARIANT="` + westToolchain + `"
+)
+
+# Compilation database
+add_custom_target(database
+  COMMAND cmake -E env ${ENV_VARS} west build -b ${WEST_BOARD} -d "${OUT_DIR}" -p auto --cmake-only` + westOptionsRef + ` "${WEST_APP}"` + westDefsRef + `
+  USES_TERMINAL
+)
+
+# West build
+add_custom_target(west
+  COMMAND cmake -E env ${ENV_VARS} west build -b ${WEST_BOARD} -d "${OUT_DIR}" -p auto` + westOptionsRef + ` "${WEST_APP}"` + westDefsRef + `
+  USES_TERMINAL
+)
+`
+	// Update CMakeLists.txt
+	contextCMakeLists := path.Join(contextDir, "CMakeLists.txt")
+	err = utils.UpdateFile(contextCMakeLists, content)
+	if err != nil {
+		return err
+	}
+	return err
+}

pkg/maker/west_test.go

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2025 Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package maker_test
+
+import (
+	"testing"
+
+	"github.com/Open-CMSIS-Pack/cbuild2cmake/pkg/maker"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestWest(t *testing.T) {
+	assert := assert.New(t)
+
+	t.Run("test west cmakelists creation", func(t *testing.T) {
+		var m maker.Maker
+		m.Params.InputFile = testRoot + "/run/solutions/west/solution.cbuild-idx.yml"
+		err := m.GenerateCMakeLists()
+		assert.Nil(err)
+		for index := range m.Cbuilds {
+			err = m.CreateWestCMakeLists(index)
+			assert.Nil(err)
+		}
+	})
+}