feat: allow deriving from differently-named upstream component (#389)

Author: reubeno

internal/projectconfig/specsource.go

@@ -5,13 +5,17 @@ package projectconfig
 
 // Provides source information for locating the spec for a component.
 type SpecSource struct {
+	// SourceType indicates the type of source for the spec.
 	SourceType SpecSourceType `toml:"type" validate:"omitempty,oneof=local upstream" jsonschema:"required,enum=local,enum=,title=Source Type,description=The type of the spec source"`
 
-	// Only relevant for local specs.
+	// Path indicates the path to the spec file; only relevant for local specs.
 	Path string `toml:"path,omitempty" json:",omitempty" validate:"excluded_unless=SourceType local,required_if=SourceType local" jsonschema:"title=Path,description=Path to the spec (if available locally),example=specs/mycomponent.spec"`
 
-	// Only relevant for upstream specs.
+	// UpstreamDistro indicates the upstream distro providing the spec; only relevant for upstream specs.
 	UpstreamDistro DistroReference `toml:"upstream-distro,omitempty" json:",omitempty" jsonschema:"title=Upstream distro,description=Reference to the upstream distro providing the spec"`
+
+	// UpstreamName indicates the name of the component in the upstream distro; only relevant for upstream specs.
+	UpstreamName string `toml:"upstream-name,omitempty" json:",omitempty" validate:"excluded_unless=SourceType upstream" jsonschema:"title=Upstream component name,description=Name of the component in the upstream distro,example=different-name"`
 }
 
 // Implements the [Stringer] interface.

internal/providers/sourceproviders/fedorasourceprovider.go

@@ -8,6 +8,7 @@ import (
 	"errors"
 	"fmt"
 	"log/slog"
+	"path/filepath"
 	"strings"
 
 	"github.com/microsoft/azldev/internal/app/azldev/core/components"
@@ -75,13 +76,21 @@ func (g *FedoraSourcesProviderImpl) GetComponent(
 		return errors.New("component name cannot be empty")
 	}
 
+	upstreamNameToUse := componentName
+
+	// Figure out if there's an override for the upstream name. This can happen when the derived
+	// component name differs from the name used in the upstream distro.
+	if upstreamNameOverride := component.GetConfig().Spec.UpstreamName; upstreamNameOverride != "" {
+		upstreamNameToUse = upstreamNameOverride
+	}
+
 	if destDirPath == "" {
 		return errors.New("destination path cannot be empty")
 	}
 
-	gitRepoURL := strings.ReplaceAll(g.distroGitBaseURI, "$pkg", componentName)
+	gitRepoURL := strings.ReplaceAll(g.distroGitBaseURI, "$pkg", upstreamNameToUse)
 
-	slog.Info("Getting component from git repo", "component", componentName)
+	slog.Info("Getting component from git repo", "component", componentName, "upstreamComponent", upstreamNameToUse)
 
 	// Clone the repository directly to the destination
 	err := g.gitProvider.Clone(
@@ -93,11 +102,30 @@ func (g *FedoraSourcesProviderImpl) GetComponent(
 		return fmt.Errorf("failed to clone git repository %#q:\n%w", gitRepoURL, err)
 	}
 
+	// Delete the .git directory so it's not packaged up.
+	err = g.fs.RemoveAll(filepath.Join(destDirPath, ".git"))
+	if err != nil {
+		return fmt.Errorf("failed to remove .git directory from cloned repository at %#q:\n%w",
+			destDirPath, err)
+	}
+
 	// Extract sources from repo (downloads lookaside files into the repo)
-	err = g.downloader.ExtractSourcesFromRepo(ctx, destDirPath, componentName)
+	err = g.downloader.ExtractSourcesFromRepo(ctx, destDirPath, upstreamNameToUse)
 	if err != nil {
 		return fmt.Errorf("failed to extract sources from git repository:\n%w", err)
 	}
 
+	// If the upstream name differs from the component name, we will need to rename the spec.
+	if upstreamNameToUse != componentName {
+		downloadedSpecPath := filepath.Join(destDirPath, upstreamNameToUse+".spec")
+		desiredSpecPath := filepath.Join(destDirPath, componentName+".spec")
+
+		err := g.fs.Rename(downloadedSpecPath, desiredSpecPath)
+		if err != nil {
+			return fmt.Errorf("failed to rename fetched spec file from %#q to %#q:\n%w",
+				downloadedSpecPath, desiredSpecPath, err)
+		}
+	}
+
 	return nil
 }

internal/providers/sourceproviders/fedorasourceprovider_test.go

@@ -122,6 +122,7 @@ func TestNewGitContentsProviderImpl(t *testing.T) {
 	})
 }
 
+//nolint:maintidx // It's long because of multiple test cases.
 func TestGetComponentFromGit(t *testing.T) {
 	env := testutils.NewTestEnv(t)
 
@@ -362,4 +363,108 @@ func TestGetComponentFromGit(t *testing.T) {
 		require.Error(t, err)
 		assert.ErrorIs(t, err, extractorError)
 	})
+
+	t.Run("spec file renamed when upstream name differs from component name", func(t *testing.T) {
+		ctrl := gomock.NewController(t)
+		mockGitProvider := git_test.NewMockGitProvider(ctrl)
+		mockExtractor := fedorasource_test.NewMockFedoraSourceDownloader(ctrl)
+
+		provider, err := sourceproviders.NewFedoraSourcesProviderImpl(
+			env.FS(),
+			mockGitProvider,
+			mockExtractor,
+			distGitBaseURI,
+			branch,
+		)
+		require.NoError(t, err)
+
+		componentName := "my-component"
+		upstreamName := "upstream-pkg"
+
+		mockComponent := components_testutils.NewMockComponent(ctrl)
+		mockComponent.EXPECT().GetName().AnyTimes().Return(componentName)
+		mockComponent.EXPECT().GetConfig().AnyTimes().Return(&projectconfig.ComponentConfig{
+			Name: componentName,
+			Spec: projectconfig.SpecSource{
+				UpstreamName: upstreamName,
+			},
+		})
+
+		// Git clone creates spec file with upstream name
+		upstreamRepoURL := "https://example.com/" + upstreamName + ".git"
+		mockGitProvider.EXPECT().
+			Clone(gomock.Any(), upstreamRepoURL, destDir, gomock.Any()).
+			DoAndReturn(func(ctx context.Context, repoURL, cloneDir string, opts ...git.GitOptions) error {
+				// Create spec file with upstream name
+				specPath := cloneDir + "/" + upstreamName + ".spec"
+
+				return fileutils.WriteFile(
+					env.FS(), specPath,
+					[]byte("Name: "+upstreamName+"\nVersion: 1.0"),
+					fileperms.PublicFile,
+				)
+			})
+
+		// Extractor succeeds
+		mockExtractor.EXPECT().
+			ExtractSourcesFromRepo(gomock.Any(), destDir, upstreamName).
+			Return(nil)
+
+		err = provider.GetComponent(context.Background(), mockComponent, destDir)
+		require.NoError(t, err)
+
+		// Verify spec file was renamed to component name
+		renamedSpecPath := destDir + "/" + componentName + ".spec"
+		exists, err := fileutils.Exists(env.FS(), renamedSpecPath)
+		require.NoError(t, err)
+		assert.True(t, exists, "spec file should be renamed to component name")
+
+		// Verify original upstream spec file no longer exists
+		originalSpecPath := destDir + "/" + upstreamName + ".spec"
+		exists, err = fileutils.Exists(env.FS(), originalSpecPath)
+		require.NoError(t, err)
+		assert.False(t, exists, "original upstream spec file should not exist after rename")
+	})
+
+	t.Run("spec rename failure propagates when source file missing", func(t *testing.T) {
+		ctrl := gomock.NewController(t)
+		mockGitProvider := git_test.NewMockGitProvider(ctrl)
+		mockExtractor := fedorasource_test.NewMockFedoraSourceDownloader(ctrl)
+
+		provider, err := sourceproviders.NewFedoraSourcesProviderImpl(
+			env.FS(),
+			mockGitProvider,
+			mockExtractor,
+			distGitBaseURI,
+			branch,
+		)
+		require.NoError(t, err)
+
+		componentName := "my-component"
+		upstreamName := "upstream-pkg"
+
+		mockComponent := components_testutils.NewMockComponent(ctrl)
+		mockComponent.EXPECT().GetName().AnyTimes().Return(componentName)
+		mockComponent.EXPECT().GetConfig().AnyTimes().Return(&projectconfig.ComponentConfig{
+			Name: componentName,
+			Spec: projectconfig.SpecSource{
+				UpstreamName: upstreamName,
+			},
+		})
+
+		// Git clone succeeds but does NOT create the spec file (simulating missing file)
+		upstreamRepoURL := "https://example.com/" + upstreamName + ".git"
+		mockGitProvider.EXPECT().
+			Clone(gomock.Any(), upstreamRepoURL, destDir, gomock.Any()).
+			Return(nil)
+
+		// Extractor succeeds
+		mockExtractor.EXPECT().
+			ExtractSourcesFromRepo(gomock.Any(), destDir, upstreamName).
+			Return(nil)
+
+		err = provider.GetComponent(context.Background(), mockComponent, destDir)
+		require.Error(t, err)
+		assert.Contains(t, err.Error(), "failed to rename fetched spec file")
+	})
 }

scenario/__snapshots__/TestSnapshotsContainer_config_generate-schema_stdout_1.snap

@@ -419,6 +419,14 @@
           "$ref": "#/$defs/DistroReference",
           "title": "Upstream distro",
           "description": "Reference to the upstream distro providing the spec"
+        },
+        "upstream-name": {
+          "type": "string",
+          "title": "Upstream component name",
+          "description": "Name of the component in the upstream distro",
+          "examples": [
+            "different-name"
+          ]
         }
       },
       "additionalProperties": false,

scenario/__snapshots__/TestSnapshots_config_generate-schema_stdout_1.snap

@@ -419,6 +419,14 @@
           "$ref": "#/$defs/DistroReference",
           "title": "Upstream distro",
           "description": "Reference to the upstream distro providing the spec"
+        },
+        "upstream-name": {
+          "type": "string",
+          "title": "Upstream component name",
+          "description": "Name of the component in the upstream distro",
+          "examples": [
+            "different-name"
+          ]
         }
       },
       "additionalProperties": false,

schemas/azldev.schema.json

@@ -419,6 +419,14 @@
           "$ref": "#/$defs/DistroReference",
           "title": "Upstream distro",
           "description": "Reference to the upstream distro providing the spec"
+        },
+        "upstream-name": {
+          "type": "string",
+          "title": "Upstream component name",
+          "description": "Name of the component in the upstream distro",
+          "examples": [
+            "different-name"
+          ]
         }
       },
       "additionalProperties": false,