feat: Snapshots for Static source preparation (#407)

* Use distro ref snapshot to checkout sources at a point in time

* Schema update for snapshot

* Refactored distro resolutions and feedback

* Fixed lint error

* Fixed formatting mistakes

* Updated scenario schema for snapshot

Author: Antonio Salinas

internal/projectconfig/distro.go

@@ -15,6 +15,8 @@ type DistroReference struct {
 	Name string `toml:"name" json:"name,omitempty" jsonschema:"required,title=Name,description=Name of the referenced distro"`
 	// Version of the referenced distro.
 	Version string `toml:"version,omitempty" json:"version,omitempty" jsonschema:"title=Version,description=Version of the referenced distro"`
+	// Snapshot date/time for source code if specified components will use source as it existed at this time.
+	Snapshot string `toml:"snapshot,omitempty" json:"snapshot,omitempty" jsonschema:"format=date-time,title=Snapshot,description=If specified use source code as it existed at this date/time"`
 }
 
 // Implements the [Stringer] interface for [DistroReference].

internal/providers/sourceproviders/fedorasource/fedorasource.go

@@ -23,15 +23,14 @@ import (
 type FedoraSourceDownloader interface {
 	// ExtractSourcesFromRepo processes a git repository by downloading any required
 	// lookaside cache files into the repository directory.
-	ExtractSourcesFromRepo(ctx context.Context, repoDir string, packageName string) error
+	ExtractSourcesFromRepo(ctx context.Context, repoDir string, packageName string, lookasideBaseURI string) error
 }
 
 // FedoraSourceDownloaderImpl is an implementation of GitRepoExtractor.
 type FedoraSourceDownloaderImpl struct {
-	dryRunnable      opctx.DryRunnable
-	fileSystem       opctx.FS
-	downloader       downloader.Downloader
-	lookasideBaseURI string
+	dryRunnable opctx.DryRunnable
+	fileSystem  opctx.FS
+	downloader  downloader.Downloader
 }
 
 // Ensure [FedoraSourceDownloaderImpl] implements [FedoraSourceDownloader].
@@ -62,12 +61,11 @@ type sourceFileInfo struct {
 }
 
 // NewFedoraRepoExtractorImpl creates a new instance of FedoraRepoExtractorImpl
-// with the provided downloader and lookaside base URI.
+// with the provided downloader.
 func NewFedoraRepoExtractorImpl(
 	dryRunnable opctx.DryRunnable,
 	fileSystem opctx.FS,
 	downloader downloader.Downloader,
-	lookasideBaseURI string,
 ) (*FedoraSourceDownloaderImpl, error) {
 	if fileSystem == nil {
 		return nil, errors.New("filesystem cannot be nil")
@@ -81,31 +79,30 @@ func NewFedoraRepoExtractorImpl(
 		return nil, errors.New("dry runnable cannot be nil")
 	}
 
-	if lookasideBaseURI == "" {
-		return nil, errors.New("lookaside base URI cannot be empty")
-	}
-
-	if err := verifyFedoraLookasideBaseURI(lookasideBaseURI); err != nil {
-		return nil, err
-	}
-
 	return &FedoraSourceDownloaderImpl{
-		dryRunnable:      dryRunnable,
-		fileSystem:       fileSystem,
-		downloader:       downloader,
-		lookasideBaseURI: lookasideBaseURI,
+		dryRunnable: dryRunnable,
+		fileSystem:  fileSystem,
+		downloader:  downloader,
 	}, nil
 }
 
 // ExtractSourcesFromRepo processes the git repository by downloading any required
 // lookaside cache files into the repository directory.
 func (g *FedoraSourceDownloaderImpl) ExtractSourcesFromRepo(
-	ctx context.Context, repoDir string, packageName string,
+	ctx context.Context, repoDir string, packageName string, lookasideBaseURI string,
 ) error {
 	if repoDir == "" {
 		return errors.New("repository directory cannot be empty")
 	}
 
+	if lookasideBaseURI == "" {
+		return errors.New("lookaside base URI cannot be empty")
+	}
+
+	if err := verifyFedoraLookasideBaseURI(lookasideBaseURI); err != nil {
+		return err
+	}
+
 	repoDirExists, err := fileutils.Exists(g.fileSystem, repoDir)
 	if err != nil {
 		return fmt.Errorf("failed to check if repository directory exists at %#q:\n%w", repoDir, err)
@@ -117,7 +114,7 @@ func (g *FedoraSourceDownloaderImpl) ExtractSourcesFromRepo(
 
 	sourcesFilePath := filepath.Join(repoDir, "sources")
 
-	sourceFiles, err := g.extractSourcesInfo(sourcesFilePath, packageName)
+	sourceFiles, err := g.extractSourcesInfo(sourcesFilePath, packageName, lookasideBaseURI)
 	if err != nil {
 		return fmt.Errorf("failed to extract sources info from sources file at %#q:\n%w", sourcesFilePath, err)
 	}
@@ -174,6 +171,7 @@ func (g *FedoraSourceDownloaderImpl) validateDownloadedFile(
 func (g *FedoraSourceDownloaderImpl) extractSourcesInfo(
 	sourcesFilePath string,
 	packageName string,
+	lookasideBaseURI string,
 ) ([]sourceFileInfo, error) {
 	sourcesContent, err := afero.ReadFile(g.fileSystem, sourcesFilePath)
 	if err != nil {
@@ -200,7 +198,7 @@ func (g *FedoraSourceDownloaderImpl) extractSourcesInfo(
 		fileName := matches[sourcesPatternFilenameIndex]
 		hash := matches[sourcesPatternHashValueIndex]
 
-		sourceURI := g.lookasideBaseURI
+		sourceURI := lookasideBaseURI
 		sourceURI = strings.ReplaceAll(sourceURI, "$pkg", packageName)
 		sourceURI = strings.ReplaceAll(sourceURI, "$filename", fileName)
 		sourceURI = strings.ReplaceAll(sourceURI, "$hashtype", strings.ToLower(hashType))

internal/providers/sourceproviders/fedorasource/fedorasource_test.go

@@ -55,7 +55,7 @@ func TestNewFedoraRepoExtractorImpl(t *testing.T) {
 	ctx := testctx.NewCtx()
 	mockDownloader := downloader_test.NewMockDownloader(ctrl)
 
-	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader, testLookasideURI)
+	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader)
 
 	require.NoError(t, err)
 	require.NotNil(t, extractor)
@@ -67,27 +67,17 @@ func TestNewFedoraRepoExtractorImplValidation(t *testing.T) {
 	mockDownloader := downloader_test.NewMockDownloader(ctrl)
 
 	t.Run("nil dryRunnable should fail", func(t *testing.T) {
-		extractor, err := fedorasource.NewFedoraRepoExtractorImpl(nil, ctx.FS(), mockDownloader, testLookasideURI)
+		extractor, err := fedorasource.NewFedoraRepoExtractorImpl(nil, ctx.FS(), mockDownloader)
 		require.Error(t, err)
 		require.Nil(t, extractor)
 	})
 	t.Run("nil filesystem should fail", func(t *testing.T) {
-		extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, nil, mockDownloader, testLookasideURI)
+		extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, nil, mockDownloader)
 		require.Error(t, err)
 		require.Nil(t, extractor)
 	})
 	t.Run("nil downloader should fail", func(t *testing.T) {
-		extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), nil, testLookasideURI)
-		require.Error(t, err)
-		require.Nil(t, extractor)
-	})
-	t.Run("empty lookaside URI should fail", func(t *testing.T) {
-		extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader, "")
-		require.Error(t, err)
-		require.Nil(t, extractor)
-	})
-	t.Run("lookaside URI missing placeholders should fail", func(t *testing.T) {
-		extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader, "missing-placeholders")
+		extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), nil)
 		require.Error(t, err)
 		require.Nil(t, extractor)
 	})
@@ -98,7 +88,7 @@ func TestExtractSourcesFromRepo(t *testing.T) {
 	ctx := testctx.NewCtx()
 	mockDownloader := downloader_test.NewMockDownloader(ctrl)
 
-	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader, testLookasideURI)
+	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader)
 	require.NoError(t, err)
 
 	require.NoError(t, ctx.FS().MkdirAll(testRepoDir, testDirPerms))
@@ -123,7 +113,7 @@ func TestExtractSourcesFromRepo(t *testing.T) {
 		return afero.WriteFile(ctx.FS(), destPath, []byte("test patch content"), testFilePerms)
 	})
 
-	err = extractor.ExtractSourcesFromRepo(context.Background(), testRepoDir, testPackageName)
+	err = extractor.ExtractSourcesFromRepo(context.Background(), testRepoDir, testPackageName, testLookasideURI)
 	require.NoError(t, err)
 }
 
@@ -132,19 +122,31 @@ func TestExtractSourcesFromRepoValidation(t *testing.T) {
 	ctx := testctx.NewCtx()
 	mockDownloader := downloader_test.NewMockDownloader(ctrl)
 
-	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader, testLookasideURI)
+	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader)
 	require.NoError(t, err)
 
 	t.Run("empty repo dir", func(t *testing.T) {
-		err := extractor.ExtractSourcesFromRepo(context.Background(), "", testPackageName)
+		err := extractor.ExtractSourcesFromRepo(context.Background(), "", testPackageName, testLookasideURI)
 		require.Error(t, err)
 		assert.Contains(t, err.Error(), "repository directory cannot be empty")
 	})
 
+	t.Run("empty lookaside URI", func(t *testing.T) {
+		err := extractor.ExtractSourcesFromRepo(context.Background(), testRepoDir, testPackageName, "")
+		require.Error(t, err)
+		assert.Contains(t, err.Error(), "lookaside base URI cannot be empty")
+	})
+
+	t.Run("lookaside URI missing placeholders", func(t *testing.T) {
+		err := extractor.ExtractSourcesFromRepo(context.Background(), testRepoDir, testPackageName, "missing-placeholders")
+		require.Error(t, err)
+		assert.Contains(t, err.Error(), "lookaside base URI is missing required placeholder")
+	})
+
 	t.Run("missing sources file", func(t *testing.T) {
 		require.NoError(t, ctx.FS().MkdirAll(testEmptyRepoDir, 0o755))
 
-		err := extractor.ExtractSourcesFromRepo(context.Background(), testEmptyRepoDir, testPackageName)
+		err := extractor.ExtractSourcesFromRepo(context.Background(), testEmptyRepoDir, testPackageName, testLookasideURI)
 		require.Error(t, err)
 		assert.Contains(t, err.Error(), "failed to read sources file")
 	})
@@ -155,13 +157,13 @@ func TestExtractSourcesFromRepoInvalidFormats(t *testing.T) {
 	ctx := testctx.NewCtx()
 	mockDownloader := downloader_test.NewMockDownloader(ctrl)
 
-	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader, testLookasideURI)
+	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader)
 	require.NoError(t, err)
 
 	require.NoError(t, ctx.FS().MkdirAll(testInvalidDir, testDirPerms))
 	setupSourcesFile(t, ctx.FS(), testInvalidDir, testInvalidSourcesContent)
 
-	err = extractor.ExtractSourcesFromRepo(context.Background(), testInvalidDir, testPackageName)
+	err = extractor.ExtractSourcesFromRepo(context.Background(), testInvalidDir, testPackageName, testLookasideURI)
 	require.Error(t, err)
 	assert.Contains(t, err.Error(), "invalid format in sources file at line")
 }
@@ -171,7 +173,7 @@ func TestExtractSourcesFromRepoDownloadFailure(t *testing.T) {
 	ctx := testctx.NewCtx()
 	mockDownloader := downloader_test.NewMockDownloader(ctrl)
 
-	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader, testLookasideURI)
+	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader)
 	require.NoError(t, err)
 
 	require.NoError(t, ctx.FS().MkdirAll(testRepoDir, testDirPerms))
@@ -181,7 +183,7 @@ func TestExtractSourcesFromRepoDownloadFailure(t *testing.T) {
 	mockDownloader.EXPECT().Download(gomock.Any(), gomock.Any(), gomock.Any()).
 		Return(downloadErr)
 
-	err = extractor.ExtractSourcesFromRepo(context.Background(), testRepoDir, testPackageName)
+	err = extractor.ExtractSourcesFromRepo(context.Background(), testRepoDir, testPackageName, testLookasideURI)
 	require.Error(t, err)
 	require.ErrorIs(t, err, downloadErr)
 	assert.Contains(t, err.Error(), "failed to download sources")
@@ -192,7 +194,7 @@ func TestExtractSourcesFromRepoHashMismatch(t *testing.T) {
 	ctx := testctx.NewCtx()
 	mockDownloader := downloader_test.NewMockDownloader(ctrl)
 
-	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader, testLookasideURI)
+	extractor, err := fedorasource.NewFedoraRepoExtractorImpl(ctx, ctx.FS(), mockDownloader)
 	require.NoError(t, err)
 
 	require.NoError(t, ctx.FS().MkdirAll(testRepoDir, testDirPerms))
@@ -205,7 +207,7 @@ func TestExtractSourcesFromRepoHashMismatch(t *testing.T) {
 			return afero.WriteFile(ctx.FS(), destPath, []byte("wrong content"), testFilePerms)
 		})
 
-	err = extractor.ExtractSourcesFromRepo(context.Background(), testRepoDir, testPackageName)
+	err = extractor.ExtractSourcesFromRepo(context.Background(), testRepoDir, testPackageName, testLookasideURI)
 	require.Error(t, err)
 	assert.Contains(t, err.Error(), "hash mismatch")
 }