[cbuild2cmake] Avoid run-always executes cyclic dependencies

Author: brondani

pkg/maker/buildcontent.go

@@ -159,7 +159,7 @@ func (m *Maker) AddStepSuffix(name string) string {
 
 func (m *Maker) CMakeTargetAddDependencies(name string, dependencies []string) string {
 	var content string
-	dependencies = utils.AppendUniquely(dependencies, m.GetAllRunAlways(name)...)
+	dependencies = utils.AppendUniquely(dependencies, m.GetIndependentRunAlways(name)...)
 	if len(dependencies) > 0 {
 		content += "\nadd_dependencies(" + m.AddStepSuffix(name)
 		for _, dependency := range dependencies {
@@ -194,32 +194,35 @@ func (m *Maker) BuildDependencies() string {
 }
 
 func (m *Maker) GetContextDependencies(execute string, dependsOn []string, deps DependenciesMap) DependenciesMap {
-	for _, item := range dependsOn {
-		if slices.Contains(m.Contexts, item) {
-			// collect dependency on context (post build step)
-			deps[item] = utils.AppendUniquely(deps[item], execute)
-		} else {
-			// check recursively further dependencies
-			deps = m.GetContextDependencies(execute, m.GetDependsOn(item), deps)
+	if m.GetExecute(execute).Always == nil {
+		for _, item := range dependsOn {
+			if slices.Contains(m.Contexts, item) {
+				// collect dependency on context (post build step)
+				deps[item] = utils.AppendUniquely(deps[item], execute)
+			} else {
+				// check recursively further dependencies
+				deps = m.GetContextDependencies(execute, m.GetExecute(item).DependsOn, deps)
+			}
 		}
 	}
 	return deps
 }
 
-func (m *Maker) GetDependsOn(execute string) (dependsOn []string) {
+func (m *Maker) GetExecute(execute string) Executes {
 	for _, item := range m.CbuildIndex.BuildIdx.Executes {
 		if item.Execute == execute {
-			dependsOn = item.DependsOn
-			break
+			return item
 		}
 	}
-	return dependsOn
+	return Executes{}
 }
 
-func (m *Maker) GetAllRunAlways(execute string) (elements []string) {
-	for _, item := range m.CbuildIndex.BuildIdx.Executes {
-		if item.Execute != execute && item.Always != nil {
-			elements = utils.AppendUniquely(elements, item.Execute)
+func (m *Maker) GetIndependentRunAlways(execute string) (elements []string) {
+	if m.GetExecute(execute).Always == nil {
+		for _, item := range m.CbuildIndex.BuildIdx.Executes {
+			if item.Always != nil && len(item.DependsOn) == 0 {
+				elements = utils.AppendUniquely(elements, item.Execute)
+			}
 		}
 	}
 	return elements

pkg/maker/buildcontent_test.go

@@ -359,9 +359,20 @@ func TestBuildContent(t *testing.T) {
 		}
 		m.CbuildIndex.BuildIdx.Executes = []maker.Executes{
 			{
-				Execute: "RunAlways",
+				Execute: "RunAlways1",
 				Always:  make(map[string]interface{}),
 			},
+			{
+				Execute: "RunAlways2",
+				Always:  make(map[string]interface{}),
+			},
+			{
+				// Test safety net to ensure cyclic dependencies are avoided
+				// RunAlways 'executes' usually do not have input dependencies
+				Execute:   "RunAlways_Dependent",
+				Always:    make(map[string]interface{}),
+				DependsOn: []string{"SecondLevel_PostBuild"},
+			},
 			{
 				Execute:   "PostBuild",
 				DependsOn: []string{"project.debug+target"},
@@ -376,20 +387,27 @@ func TestBuildContent(t *testing.T) {
 # Build dependencies
 add_dependencies(project.debug+target-build
   dependentContext
-  RunAlways
+  RunAlways1
+  RunAlways2
+)
+add_dependencies(RunAlways_Dependent
+  SecondLevel_PostBuild
 )
 add_dependencies(PostBuild
   project.debug+target-build
-  RunAlways
+  RunAlways1
+  RunAlways2
 )
 add_dependencies(SecondLevel_PostBuild
   PostBuild
-  RunAlways
+  RunAlways1
+  RunAlways2
 )
 add_dependencies(project.debug+target-executes
   PostBuild
   SecondLevel_PostBuild
-  RunAlways
+  RunAlways1
+  RunAlways2
 )`)
 	})
 

test/data/solutions/executes/ref/CMakeLists.txt

@@ -123,10 +123,16 @@ add_custom_command(OUTPUT ${OUTPUT} DEPENDS ${INPUT}
   COMMENT Run_After_Archiving
 )
 
-# Execute: Run_Always
-add_custom_target(Run_Always ALL
-  COMMAND ${CMAKE_COMMAND} -E echo "Execute Run Always"
-  COMMENT Run_Always
+# Execute: Run_Always1
+add_custom_target(Run_Always1 ALL
+  COMMAND ${CMAKE_COMMAND} -E echo "Execute Run Always1"
+  COMMENT Run_Always1
+)
+
+# Execute: Run_Always2
+add_custom_target(Run_Always2 ALL
+  COMMAND ${CMAKE_COMMAND} -E echo "Execute Run Always2"
+  COMMENT Run_Always2
 )
 
 # Execute: project.Release+ARMCM0-Sign_Artifact
@@ -147,27 +153,33 @@ add_custom_command(OUTPUT ${OUTPUT} DEPENDS ${INPUT}
 # Build dependencies
 add_dependencies(project.Release+ARMCM0-build
   Generate_Project_Sources
-  Run_Always
+  Run_Always1
+  Run_Always2
 )
 add_dependencies(Archive_Artifacts
   project.Release+ARMCM0-build
   project.Release+ARMCM0-Sign_Artifact
-  Run_Always
+  Run_Always1
+  Run_Always2
 )
 add_dependencies(Generate_Project_Sources
-  Run_Always
+  Run_Always1
+  Run_Always2
 )
 add_dependencies(Run_After_Archiving
   Archive_Artifacts
-  Run_Always
+  Run_Always1
+  Run_Always2
 )
 add_dependencies(project.Release+ARMCM0-Sign_Artifact
   project.Release+ARMCM0-build
-  Run_Always
+  Run_Always1
+  Run_Always2
 )
 add_dependencies(project.Release+ARMCM0-executes
   Archive_Artifacts
   Run_After_Archiving
   project.Release+ARMCM0-Sign_Artifact
-  Run_Always
+  Run_Always1
+  Run_Always2
 )

test/data/solutions/executes/solution.cbuild-idx.yml

@@ -41,8 +41,11 @@ build-idx:
         - artifacts.zip
       depends-on:
         - Archive_Artifacts
-    - execute: Run_Always
-      run: ${CMAKE_COMMAND} -E echo "Execute Run Always"
+    - execute: Run_Always1
+      run: ${CMAKE_COMMAND} -E echo "Execute Run Always1"
+      always: 
+    - execute: Run_Always2
+      run: ${CMAKE_COMMAND} -E echo "Execute Run Always2"
       always: 
     - execute: project.Release+ARMCM0-Sign_Artifact
       run: ${CMAKE_COMMAND} -DINPUT=${INPUT} -DOUTPUT=${OUTPUT} -P ${INPUT_0}

test/data/solutions/executes/solution.csolution.yml

@@ -37,8 +37,11 @@ solution:
         - $elf()$.signed
       output:
         - $SolutionDir()$/artifacts.zip
-    - execute: Run_Always
-      run: ${CMAKE_COMMAND} -E echo "Execute Run Always"
+    - execute: Run_Always1
+      run: ${CMAKE_COMMAND} -E echo "Execute Run Always1"
+      always:
+    - execute: Run_Always2
+      run: ${CMAKE_COMMAND} -E echo "Execute Run Always2"
       always:
     - execute: Run_After_Archiving 
       run: ${CMAKE_COMMAND} -E echo "Archive has been updated"