fix(overlays): allocate macro source tag to avoid collisions

The macro-load overlay hard-coded its source as Source9999, which collided with specs that already define that tag (e.g. texlive, which uses sources up to Source10133), failing with "source 9999 defined multiple times".

Replace the fixed tag with a new internal source-add overlay that allocates the next number after the highest existing source tag at apply time, after user overlays have run. Add Spec.AddSourceEntry and ParseSourceTagNumber mirroring the existing patch-entry logic, and return the load directive and source registration as separate overlays so the registration is ordered last.

Fixes #235

Author: liunan-ms

internal/app/azldev/core/sources/overlays.go

@@ -30,6 +30,8 @@ import (
 // overlay that found no matches).
 var ErrOverlayDidNotApply = errors.New("overlay did not apply to target")
 
+const componentOverlayAddSource projectconfig.ComponentOverlayType = "internal-source-add"
+
 // isSpecFile returns true if the given file path refers to a spec file.
 func isSpecFile(filePath string) bool {
 	return strings.HasSuffix(filePath, ".spec")
@@ -46,7 +48,7 @@ func ApplyOverlayToSources(
 	sourcesDirPath, specPath string,
 ) error {
 	// Apply the spec component, if any.
-	if overlay.ModifiesSpec() {
+	if overlay.ModifiesSpec() || overlay.Type == componentOverlayAddSource {
 		err := ApplySpecOverlayToFileInPlace(fs, overlay, specPath)
 		if err != nil {
 			return err
@@ -130,6 +132,11 @@ func ApplySpecOverlay(overlay projectconfig.ComponentOverlay, openedSpec *spec.S
 		if err != nil {
 			return fmt.Errorf("failed to insert tag %#q into spec:\n%w", overlay.Tag, err)
 		}
+	case componentOverlayAddSource:
+		err := openedSpec.AddSourceEntry(overlay.Value)
+		if err != nil {
+			return fmt.Errorf("failed to add source entry to spec:\n%w", err)
+		}
 	case projectconfig.ComponentOverlayUpdateSpecTag:
 		err := openedSpec.UpdateExistingTag(overlay.PackageName, overlay.Tag, overlay.Value)
 		if err != nil {

internal/app/azldev/core/sources/overlays_test.go

@@ -136,6 +136,22 @@ BuildRequires: gcc
 Source0: test.tar.gz
 Source9999: macros.azl.macros
 BuildRequires: gcc
+`,
+		},
+		{
+			name: "add source avoids occupied preferred number",
+			overlay: projectconfig.ComponentOverlay{
+				Type:  projectconfig.ComponentOverlayType("internal-source-add"),
+				Value: "macros.azl.macros",
+			},
+			spec: `Name: name
+Source9999: upstream.file
+BuildRequires: gcc
+`,
+			result: `Name: name
+Source9999: upstream.file
+Source10000: macros.azl.macros
+BuildRequires: gcc
 `,
 		},
 		{

internal/app/azldev/core/sources/sourceprep.go

@@ -426,26 +426,34 @@ func (p *sourcePreparerImpl) applyArchiveOverlayGroup(
 	return repackedArchives, nil
 }
 
-// collectOverlays gathers all overlays for a component into a single ordered slice:
-// macros-load first, then user overlays, followed by check-skip and file-header overlays.
+// collectOverlays gathers all overlays for a component into a single ordered slice: the
+// macros-load directive first, then user overlays, then check-skip overlays, then the
+// macros source registration, and finally the file-header overlay. The macros source
+// registration is deliberately ordered after user overlays so it claims the next free
+// source number without colliding with any sources the user added.
 func (p *sourcePreparerImpl) collectOverlays(
 	component components.Component, macrosFileName string,
 ) ([]projectconfig.ComponentOverlay, error) {
 	config := component.GetConfig()
 
-	var allOverlays []projectconfig.ComponentOverlay
+	var (
+		allOverlays         []projectconfig.ComponentOverlay
+		macroSourceOverlays []projectconfig.ComponentOverlay
+	)
 
 	if macrosFileName != "" {
-		macroOverlays, err := synthesizeMacroLoadOverlays(macrosFileName)
+		loadDirective, sourceRegistration, err := synthesizeMacroLoadOverlays(macrosFileName)
 		if err != nil {
 			return nil, fmt.Errorf("failed to compute macros load overlays:\n%w", err)
 		}
 
-		allOverlays = append(allOverlays, macroOverlays...)
+		allOverlays = append(allOverlays, loadDirective...)
+		macroSourceOverlays = sourceRegistration
 	}
 
 	allOverlays = append(allOverlays, config.Overlays...)
 	allOverlays = append(allOverlays, synthesizeCheckSkipOverlays(config.Build.Check)...)
+	allOverlays = append(allOverlays, macroSourceOverlays...)
 	allOverlays = append(allOverlays, generateFileHeaderOverlay()...)
 
 	return allOverlays, nil
@@ -1288,19 +1296,25 @@ func renderMacrosFile(macros map[string]string) string {
 	return strings.Join(lines, "\n") + "\n"
 }
 
-func synthesizeMacroLoadOverlays(macrosFileName string) ([]projectconfig.ComponentOverlay, error) {
+// synthesizeMacroLoadOverlays returns the overlays that wire a component's generated
+// macros file into its spec. The load-directive overlay prepends the %{load:...} line; the
+// source-registration overlay adds the macros file as a numbered Source. They are returned
+// separately so the caller can apply the source registration after user overlays, letting
+// it claim the next free source number without colliding with sources the user added.
+func synthesizeMacroLoadOverlays(
+	macrosFileName string,
+) (loadDirective, sourceRegistration []projectconfig.ComponentOverlay, err error) {
 	// Basic check that the macros file name is valid and doesn't require escaping.
 	if strings.ContainsFunc(macrosFileName, func(r rune) bool {
 		return !unicode.IsLetter(r) && !unicode.IsDigit(r) && r != '.' && r != '-' && r != '_' && r != '+'
 	}) {
-		return nil, fmt.Errorf(
+		return nil, nil, fmt.Errorf(
 			"macros file name %#q contains invalid characters; does the component name contain invalid characters?",
 			macrosFileName,
 		)
 	}
 
-	// We inject an overlay to prepend a line to the spec to load the macros file.
-	return []projectconfig.ComponentOverlay{
+	loadDirective = []projectconfig.ComponentOverlay{
 		{
 			// Prepend the %{load:...} directive to the spec.
 			Type: projectconfig.ComponentOverlayPrependSpecLines,
@@ -1311,16 +1325,18 @@ func synthesizeMacroLoadOverlays(macrosFileName string) ([]projectconfig.Compone
 				"",
 			},
 		},
+	}
+
+	sourceRegistration = []projectconfig.ComponentOverlay{
 		{
 			// Ensure that the macros file is manifested as a source in the spec so that
 			// mock and other tools know it needs to be present in the build root.
-			// Use InsertSpecTag to place it after the last existing Source* tag, avoiding
-			// misplacement after macros like %fontpkg or inside %if conditionals.
-			Type:  projectconfig.ComponentOverlayInsertSpecTag,
-			Tag:   "Source9999", // Use a high number to avoid conflicts with existing sources.
+			Type:  componentOverlayAddSource,
 			Value: macrosFileName,
 		},
-	}, nil
+	}
+
+	return loadDirective, sourceRegistration, nil
 }
 
 // generateFileHeaderOverlay generates an overlay that prepends a header to the spec.

internal/app/azldev/core/sources/sourceprep_test.go

@@ -7,6 +7,7 @@ import (
 	"errors"
 	"os"
 	"path/filepath"
+	"regexp"
 	"strings"
 	"testing"
 
@@ -94,11 +95,11 @@ func TestPrepareSources_Success(t *testing.T) {
 	require.NoError(t, err)
 	assert.False(t, exists, "macros file should not be created when there are no macros")
 
-	// Verify spec does NOT contain macro load or Source9999.
+	// Verify spec does not contain a macro load or source entry.
 	specContents, err := fileutils.ReadFile(ctx.FS(), outputSpecPath)
 	require.NoError(t, err)
 	assert.NotContains(t, string(specContents), "%{load:%{_sourcedir}/"+macrosFileName+"}")
-	assert.NotContains(t, string(specContents), "Source9999")
+	assert.NotContains(t, string(specContents), "Source0")
 }
 
 // TestPrepareSources_ArchiveOverlayRehashesSourcesEntry is an end-to-end check
@@ -423,14 +424,51 @@ func TestPrepareSources_WritesMacrosFile(t *testing.T) {
 	require.NoError(t, err)
 	assert.Contains(t, string(contents), "%_with_feature 1")
 
-	// Verify spec has macro load directive and Source9999 tag.
+	// Verify spec has macro load directive and a collision-free source tag.
 	specPath := filepath.Join(testOutputDir, "my-package.spec")
 	specContents, err := fileutils.ReadFile(ctx.FS(), specPath)
 	require.NoError(t, err)
 
 	specStr := string(specContents)
 	assert.Contains(t, specStr, "%{load:%{_sourcedir}/my-package"+sources.MacrosFileExtension+"}")
-	assert.Contains(t, specStr, "Source9999")
+	// Assert the macros file is registered under some SourceN tag, without pinning the number
+	// (the allocator picks the next free source number based on the spec's existing sources).
+	macrosSourcePattern := regexp.MustCompile(
+		`(?m)^Source[0-9]+: my-package` + regexp.QuoteMeta(sources.MacrosFileExtension) + `$`,
+	)
+	assert.Regexp(t, macrosSourcePattern, specStr)
+}
+
+func TestPrepareSources_MacroSourceTagCollision(t *testing.T) {
+	const testOutputDir = "/output"
+
+	ctrl := gomock.NewController(t)
+	component := components_testutils.NewMockComponent(ctrl)
+	sourceManager := sourceproviders_test.NewMockSourceManager(ctrl)
+	ctx := testctx.NewCtx()
+
+	component.EXPECT().GetName().AnyTimes().Return("my-package")
+	component.EXPECT().GetConfig().AnyTimes().Return(&projectconfig.ComponentConfig{
+		Build: projectconfig.ComponentBuildConfig{With: []string{"feature"}},
+	})
+	sourceManager.EXPECT().FetchFiles(gomock.Any(), component, testOutputDir).Return(nil)
+	sourceManager.EXPECT().FetchComponent(gomock.Any(), component, testOutputDir, gomock.Any()).DoAndReturn(
+		func(_ interface{}, _ interface{}, outputDir string, _ ...sourceproviders.FetchComponentOption) error {
+			return fileutils.WriteFile(
+				ctx.FS(), filepath.Join(outputDir, "my-package.spec"),
+				[]byte("Name: my-package\nSource9999: upstream.file\n"), fileperms.PublicFile,
+			)
+		},
+	)
+
+	preparer, err := sources.NewPreparer(sourceManager, ctx.FS(), ctx, ctx)
+	require.NoError(t, err)
+	require.NoError(t, preparer.PrepareSources(ctx, component, testOutputDir, true))
+
+	specContents, err := fileutils.ReadFile(ctx.FS(), filepath.Join(testOutputDir, "my-package.spec"))
+	require.NoError(t, err)
+	assert.Contains(t, string(specContents), "Source9999: upstream.file")
+	assert.Contains(t, string(specContents), "Source10000: my-package"+sources.MacrosFileExtension)
 }
 
 // Tests for GenerateMacrosFileContents - these test content generation in isolation.

internal/rpm/spec/edit.go

@@ -7,6 +7,7 @@ import (
 	"errors"
 	"fmt"
 	"log/slog"
+	"math"
 	"regexp"
 	"strconv"
 	"strings"
@@ -631,6 +632,55 @@ func ParsePatchTagNumber(tag string) (int, bool) {
 	return num, true
 }
 
+// ParseSourceTagNumber checks if the given tag name is a SourceN tag (case-insensitive)
+// and returns the numeric suffix N. Returns -1, false if the tag is not a SourceN tag
+// or the suffix is not a valid integer.
+func ParseSourceTagNumber(tag string) (int, bool) {
+	suffix, found := strings.CutPrefix(strings.ToLower(tag), "source")
+	if !found || suffix == "" {
+		return -1, false
+	}
+
+	num, err := strconv.Atoi(suffix)
+	if err != nil {
+		return -1, false
+	}
+
+	return num, true
+}
+
+// AddSourceEntry registers a source in the spec using the next number after the highest
+// existing source tag. Automatically numbered bare Source tags are included when
+// determining the highest occupied number.
+func (s *Spec) AddSourceEntry(filename string) error {
+	highest := -1
+	unnumberedCount := 0
+
+	err := s.VisitTags(func(tagLine *TagLine, _ *Context) error {
+		num, isSourceTag := ParseSourceTagNumber(tagLine.Tag)
+		if isSourceTag && num > highest {
+			highest = num
+		} else if strings.EqualFold(tagLine.Tag, "source") {
+			unnumberedCount++
+		}
+
+		return nil
+	})
+	if err != nil {
+		return fmt.Errorf("failed to scan for existing source tags:\n%w", err)
+	}
+
+	if unnumberedCount-1 > highest {
+		highest = unnumberedCount - 1
+	}
+
+	if highest == math.MaxInt {
+		return errors.New("cannot allocate SourceN tag after maximum integer tag number")
+	}
+
+	return s.InsertTag("", fmt.Sprintf("Source%d", highest+1), filename)
+}
+
 // HasSection returns true if the spec contains a section with the given name.
 // The comparison is exact (case-sensitive), consistent with [AppendLinesToSection].
 func (s *Spec) HasSection(sectionName string) (bool, error) {