feat: --local-repo switch for building with private RPM repo (#394)

Unblocks local dev experiences where a package build may need to use RPMs from a local (private) path.

Author: reubeno

internal/app/azldev/cmds/component/build.go

@@ -26,6 +26,8 @@ type ComponentBuildOptions struct {
 	RunChecks         bool
 	SourcePackageOnly bool
 	BuildEnvPolicy    BuildEnvPreservePolicy
+
+	LocalRepoPaths []string
 }
 
 // ComponentBuildResults summarizes the results of building a single component.
@@ -72,6 +74,8 @@ func NewBuildCmd() *cobra.Command {
 			BuildEnvPreserveAlways,
 			BuildEnvPreserveNever,
 		))
+	cmd.Flags().StringArrayVar(&options.LocalRepoPaths, "local-repo", []string{},
+		"Paths to local repositories to include during build (can be specified multiple times)")
 
 	return cmd
 }
@@ -169,13 +173,16 @@ func BuildComponent(
 
 	builder := componentbuilder.New(env, env.FS(), env, sourcePreparer, buildEnv, workDirFactory)
 
-	return buildComponentUsingBuilder(env, component, builder,
+	return buildComponentUsingBuilder(env, component, builder, options.LocalRepoPaths,
 		options.SourcePackageOnly, options.RunChecks,
 	)
 }
 
 func buildComponentUsingBuilder(
-	env *azldev.Env, component components.Component, builder *componentbuilder.Builder,
+	env *azldev.Env,
+	component components.Component,
+	builder *componentbuilder.Builder,
+	localRepoPaths []string,
 	sourcePackageOnly, runChecks bool,
 ) (results ComponentBuildResults, err error) {
 	// Compose the path to the output dir.
@@ -195,9 +202,7 @@ func buildComponentUsingBuilder(
 	// Build the SRPM.
 	//
 
-	var outputSourcePackagePath string
-
-	outputSourcePackagePath, err = builder.BuildSourcePackage(env, component, outputDir)
+	outputSourcePackagePath, err := builder.BuildSourcePackage(env, component, localRepoPaths, outputDir)
 	if err != nil {
 		return results, fmt.Errorf("failed to build SRPM for %q:\n%w", component.GetName(), err)
 	}
@@ -215,7 +220,9 @@ func buildComponentUsingBuilder(
 	// Build the RPM.
 	//
 
-	results.RPMPaths, err = builder.BuildBinaryPackage(env, component, outputSourcePackagePath, outputDir, runChecks)
+	results.RPMPaths, err = builder.BuildBinaryPackage(
+		env, component, outputSourcePackagePath, localRepoPaths, outputDir, runChecks,
+	)
 	if err != nil {
 		return results, fmt.Errorf("failed to build RPM for %q: %w", component.GetName(), err)
 	}

internal/app/azldev/core/componentbuilder/componentbuilder.go

@@ -26,12 +26,14 @@ type ComponentBuilder interface {
 	// BuildBinaryPackage builds a binary package for the given component from the provided source package
 	// and returns the paths to the built binary packages.
 	BuildBinaryPackage(
-		ctx context.Context, component components.Component, sourcePackagePath string, outputDir string, runChecks bool,
+		ctx context.Context,
+		component components.Component, sourcePackagePath string, localRepoPaths []string,
+		outputDir string, runChecks bool,
 	) (packagePaths []string, err error)
 
 	// BuildSourcePackage builds a source package for the given component and returns the path to the
 	// built source package.
-	BuildSourcePackage(ctx context.Context, component components.Component, outputDir string,
+	BuildSourcePackage(ctx context.Context, component components.Component, localRepoPaths []string, outputDir string,
 	) (packagePath string, err error)
 }
 
@@ -66,9 +68,9 @@ func New(
 }
 
 func (b *Builder) BuildSourcePackage(
-	ctx context.Context, component components.Component, outputDir string,
+	ctx context.Context, component components.Component, localRepoPaths []string, outputDir string,
 ) (packagePath string, err error) { // NOTE: We intentionally name the returns for better self-documentation.
-	packagePath, err = b.buildSRPM(ctx, component, b.buildEnv, outputDir)
+	packagePath, err = b.buildSRPM(ctx, component, b.buildEnv, localRepoPaths, outputDir)
 	if err != nil {
 		return packagePath, fmt.Errorf("failed to build source package for component %#q:\n%w", component.GetName(), err)
 	}
@@ -78,9 +80,10 @@ func (b *Builder) BuildSourcePackage(
 
 func (b *Builder) BuildBinaryPackage(
 	ctx context.Context,
-	component components.Component, sourcePackagePath, outputDir string, runChecks bool,
+	component components.Component, sourcePackagePath string, localRepoPaths []string,
+	outputDir string, runChecks bool,
 ) (packagePaths []string, err error) { // NOTE: We intentionally name the returns for better self-documentation.
-	packagePaths, err = b.buildRPM(ctx, component, sourcePackagePath, b.buildEnv, outputDir, runChecks)
+	packagePaths, err = b.buildRPM(ctx, component, sourcePackagePath, b.buildEnv, localRepoPaths, outputDir, runChecks)
 	if err != nil {
 		return packagePaths, fmt.Errorf("failed to build binary package for component %#q:\n%w", component.GetName(), err)
 	}
@@ -89,14 +92,16 @@ func (b *Builder) BuildBinaryPackage(
 }
 
 func (b *Builder) buildSRPM(
-	ctx context.Context, component components.Component, buildEnv buildenv.RPMAwareBuildEnv, outputDir string,
+	ctx context.Context, component components.Component, buildEnv buildenv.RPMAwareBuildEnv,
+	localRepoPaths []string,
+	outputDir string,
 ) (outputSRPMPath string, err error) { // NOTE: We intentionally name the returns for better self-documentation.
 	preparedSourcesDir, err := b.prepSourcesForSRPM(ctx, component)
 	if err != nil {
 		return "", fmt.Errorf("failed to prepare sources for SRPM:\n%w", err)
 	}
 
-	tempSRPMOutputDir, err := b.buildSRPMFromPreparedSources(ctx, component, preparedSourcesDir, buildEnv)
+	tempSRPMOutputDir, err := b.buildSRPMFromPreparedSources(ctx, component, preparedSourcesDir, buildEnv, localRepoPaths)
 	if err != nil {
 		return "", fmt.Errorf("failed to build SRPM from prepared sources:\n%w", err)
 	}
@@ -129,7 +134,7 @@ func (b *Builder) prepSourcesForSRPM(
 func (b *Builder) buildSRPMFromPreparedSources(
 	ctx context.Context,
 	component components.Component, preparedSourcesDir string,
-	buildEnv buildenv.RPMAwareBuildEnv,
+	buildEnv buildenv.RPMAwareBuildEnv, localRepoPaths []string,
 ) (srpmOutputDir string, err error) {
 	preparedSpecPath := path.Join(preparedSourcesDir, component.GetName()+".spec")
 
@@ -145,14 +150,14 @@ func (b *Builder) buildSRPMFromPreparedSources(
 
 	defer srpmEvent.End()
 
-	componentConfig := component.GetConfig()
-
+	// Since we've already applied the macros, with, and without values, we don't need the builder
+	// to apply them; we leave them blank.
 	srpmOptions := buildenv.SRPMBuildOptions{
 		CommonBuildOptions: mock.CommonBuildOptions{
-			With:           componentConfig.Build.With,
-			Without:        componentConfig.Build.Without,
-			Defines:        componentConfig.Build.Defines,
-			LocalRepoPaths: []string{},
+			With:           []string{},
+			Without:        []string{},
+			Defines:        map[string]string{},
+			LocalRepoPaths: localRepoPaths,
 		},
 	}
 
@@ -195,7 +200,7 @@ func (b *Builder) copySRPMToOutputDir(inputSRPMDir, outputSRPMDir string) (strin
 func (b *Builder) buildRPM(
 	ctx context.Context,
 	component components.Component,
-	srpmPath string, buildEnv buildenv.RPMAwareBuildEnv,
+	srpmPath string, buildEnv buildenv.RPMAwareBuildEnv, localRepoPaths []string,
 	outputDir string, runChecks bool,
 ) (outputRPMPaths []string, err error) { // NOTE: We intentionally name the returns for better self-documentation.
 	var tempRPMDir string
@@ -211,15 +216,15 @@ func (b *Builder) buildRPM(
 
 	defer rpmEvent.End()
 
-	componentConfig := component.GetConfig()
-
 	// Compose RPM build options, based on our parameters and the component's default configuration.
+	// Since we've already applied the macros, with, and without values, we don't need the builder
+	// to apply them; we leave them blank.
 	rpmOptions := buildenv.RPMBuildOptions{
 		CommonBuildOptions: mock.CommonBuildOptions{
-			With:           componentConfig.Build.With,
-			Without:        componentConfig.Build.Without,
-			Defines:        componentConfig.Build.Defines,
-			LocalRepoPaths: []string{},
+			With:           []string{},
+			Without:        []string{},
+			Defines:        map[string]string{},
+			LocalRepoPaths: localRepoPaths,
 		},
 		RunChecks:    runChecks,
 		ForceRebuild: false, // Could be added to config if needed

internal/app/azldev/core/componentbuilder/componentbuilder_test.go

@@ -151,7 +151,7 @@ func TestBuildSourcePackage(t *testing.T) {
 
 	params.setupToBuildSRPM(t, testComponent)
 
-	path, err := params.builder.BuildSourcePackage(params.testEnv.Env, testComponent, testOutputDir)
+	path, err := params.builder.BuildSourcePackage(params.testEnv.Env, testComponent, []string{}, testOutputDir)
 	require.NoError(t, err)
 	require.Equal(t, filepath.Join(testOutputDir, testComponent.GetName()+".src.rpm"), path)
 	require.True(t, strings.HasPrefix(path, testOutputDir))
@@ -172,6 +172,7 @@ func TestBuildBinaryPackage(t *testing.T) {
 		params.testEnv.Env,
 		testComponent,
 		testSRPMPath,
+		[]string{},
 		testOutputDir,
 		false, /*runChecks?*/
 	)

internal/app/azldev/core/componentbuilder/componentbuilder_test/componentbuilder_mocks.go

@@ -291,7 +291,12 @@ func (r *Runner) BuildSRPM(
 
 	// If provided, pass along extra local repo dirs.
 	for _, localRepoPath := range options.LocalRepoPaths {
-		args = append(args, "--addrepo", localRepoPath)
+		absLocalRepoPath, err := filepath.Abs(localRepoPath)
+		if err != nil {
+			return fmt.Errorf("failed to get absolute path for local repo %#q:\n%w", localRepoPath, err)
+		}
+
+		args = append(args, "--addrepo", absLocalRepoPath)
 	}
 
 	cmd := exec.CommandContext(ctx, MockBinary, args...)
@@ -337,7 +342,12 @@ func (r *Runner) BuildRPM(ctx context.Context, srpmPath, outputDirPath string, o
 
 	// If provided, pass along extra local repo dirs.
 	for _, localRepoPath := range options.LocalRepoPaths {
-		args = append(args, "--addrepo", localRepoPath)
+		absLocalRepoPath, err := filepath.Abs(localRepoPath)
+		if err != nil {
+			return fmt.Errorf("failed to get absolute path for local repo %#q:\n%w", localRepoPath, err)
+		}
+
+		args = append(args, "--addrepo", absLocalRepoPath)
 	}
 
 	// If the output dir already contains a "relevant" binary RPM, mock