bug(opm): use db dir when modifying existing index

This makes it possible to modify an index using `--from-index`.

Author: djzager

pkg/lib/indexer/indexer.go

@@ -26,6 +26,7 @@ const (
 	defaultImageTag       = "operator-registry-index:latest"
 	defaultDatabaseFolder = "database"
 	defaultDatabaseFile   = "index.db"
+	tmpDirPrefix          = "index_tmp"
 )
 
 // ImageIndexer is a struct implementation of the Indexer interface
@@ -53,36 +54,18 @@ type AddToIndexRequest struct {
 
 // AddToIndex is an aggregate API used to generate a registry index image with additional bundles
 func (i ImageIndexer) AddToIndex(request AddToIndexRequest) error {
-	databaseFile := defaultDatabaseFile
-
 	// set a temp directory
-	workingDir, err := ioutil.TempDir("./", "index_tmp")
+	tmpDir, err := ioutil.TempDir("./", tmpDirPrefix)
 	if err != nil {
 		return err
 	}
-	defer os.RemoveAll(workingDir)
-
-	// Pull the fromIndex
-	if request.FromIndex != "" {
-		i.Logger.Infof("Pulling previous image %s to get metadata", request.FromIndex)
-
-		// Get the old index image's dbLocationLabel to find this path
-		labels, err := i.LabelReader.GetLabelsFromImage(request.FromIndex)
-		if err != nil {
-			return err
-		}
-		if dbLocation, ok := labels[containertools.DbLocationLabel]; ok {
-			// extract the database to the file
-			err = i.ImageReader.GetImageData(request.FromIndex, workingDir)
-			if err != nil {
-				return err
-			}
+	defer os.RemoveAll(tmpDir)
 
-			databaseFile = path.Join(workingDir, dbLocation)
-		}
-	} else {
-		databaseFile = path.Join(workingDir, databaseFile)
+	databaseFile, err := i.getDatabaseFile(tmpDir, request.FromIndex)
+	if err != nil {
+		return err
 	}
+	workingDir := path.Dir(databaseFile)
 
 	// Run opm registry add on the database
 	addToRegistryReq := registry.AddToRegistryRequest{
@@ -127,38 +110,18 @@ type DeleteFromIndexRequest struct {
 // DeleteFromIndex is an aggregate API used to generate a registry index image
 // without specific operators
 func (i ImageIndexer) DeleteFromIndex(request DeleteFromIndexRequest) error {
-	databaseFile := defaultDatabaseFile
-
 	// set a temp directory
-	workingDir, err := ioutil.TempDir("./", "index_tmp")
+	tmpDir, err := ioutil.TempDir("./", tmpDirPrefix)
 	if err != nil {
 		return err
 	}
-	defer os.RemoveAll(workingDir)
+	defer os.RemoveAll(tmpDir)
 
-	// Pull the fromIndex
-	if request.FromIndex != "" {
-		i.Logger.Infof("Pulling previous image %s to get metadata", request.FromIndex)
-
-		// Get the old index image's dbLocationLabel to find this path
-		labels, err := i.LabelReader.GetLabelsFromImage(request.FromIndex)
-		if err != nil {
-			return err
-		}
-		if dbLocation, ok := labels[containertools.DbLocationLabel]; ok {
-			i.Logger.Infof("Previous db location %s", dbLocation)
-
-			// extract the database to the file
-			err = i.ImageReader.GetImageData(request.FromIndex, workingDir)
-			if err != nil {
-				return err
-			}
-
-			databaseFile = path.Join(workingDir, dbLocation)
-		}
-	} else {
-		databaseFile = path.Join(workingDir, databaseFile)
+	databaseFile, err := i.getDatabaseFile(tmpDir, request.FromIndex)
+	if err != nil {
+		return err
 	}
+	workingDir := path.Dir(databaseFile)
 
 	// Run opm registry add on the database
 	deleteFromRegistryReq := registry.DeleteFromRegistryRequest{
@@ -257,6 +220,33 @@ func (i ImageIndexer) buildDockerfile(binarySourceImage, workingDir, tag string)
 	return nil
 }
 
+func (i ImageIndexer) getDatabaseFile(workingDir, fromIndex string) (string, error) {
+	if fromIndex == "" {
+		return path.Join(workingDir, defaultDatabaseFile), nil
+	}
+
+	// Pull the fromIndex
+	i.Logger.Infof("Pulling previous image %s to get metadata", fromIndex)
+
+	// Get the old index image's dbLocationLabel to find this path
+	labels, err := i.LabelReader.GetLabelsFromImage(fromIndex)
+	if err != nil {
+		return "", err
+	}
+	dbLocation, ok := labels[containertools.DbLocationLabel]
+	if !ok {
+		return "", fmt.Errorf("Index image %s missing label %s", fromIndex, containertools.DbLocationLabel)
+	}
+
+	// extract the database to the working directory
+	err = i.ImageReader.GetImageData(fromIndex, workingDir)
+	if err != nil {
+		return "", err
+	}
+
+	return path.Join(workingDir, dbLocation), nil
+}
+
 func build(dockerfileText, imageTag string, commandRunner containertools.CommandRunner, logger *logrus.Entry) error {
 	if imageTag == "" {
 		imageTag = defaultImageTag
@@ -304,7 +294,7 @@ type ExportFromIndexRequest struct {
 // an index image
 func (i ImageIndexer) ExportFromIndex(request ExportFromIndexRequest) error {
 	// set a temp directory
-	workingDir, err := ioutil.TempDir("./", "index_tmp")
+	workingDir, err := ioutil.TempDir("./", tmpDirPrefix)
 	if err != nil {
 		return err
 	}

test/e2e/opm_test.go

@@ -31,10 +31,12 @@ var (
 	bundleTag1 = rand.String(6)
 	bundleTag2 = rand.String(6)
 	bundleTag3 = rand.String(6)
-	indexTag   = rand.String(6)
+	indexTag1  = rand.String(6)
+	indexTag2  = rand.String(6)
 
 	bundleImage = "quay.io/olmtest/e2e-bundle"
-	indexImage  = "quay.io/olmtest/e2e-index:" + indexTag
+	indexImage1 = "quay.io/olmtest/e2e-index:" + indexTag1
+	indexImage2 = "quay.io/olmtest/e2e-index:" + indexTag2
 )
 
 func inTemporaryBuildContext(f func() error) (rerr error) {
@@ -82,7 +84,6 @@ func buildIndexWith(containerTool string) error {
 	bundles := []string{
 		bundleImage + ":" + bundleTag1,
 		bundleImage + ":" + bundleTag2,
-		bundleImage + ":" + bundleTag3,
 	}
 	logger := logrus.WithFields(logrus.Fields{"bundles": bundles})
 	indexAdder := indexer.NewIndexAdder(containerTool, logger)
@@ -92,7 +93,27 @@ func buildIndexWith(containerTool string) error {
 		FromIndex:         "",
 		BinarySourceImage: "",
 		OutDockerfile:     "",
-		Tag:               indexImage,
+		Tag:               indexImage1,
+		Bundles:           bundles,
+		Permissive:        false,
+	}
+
+	return indexAdder.AddToIndex(request)
+}
+
+func buildFromIndexWith(containerTool string) error {
+	bundles := []string{
+		bundleImage + ":" + bundleTag3,
+	}
+	logger := logrus.WithFields(logrus.Fields{"bundles": bundles})
+	indexAdder := indexer.NewIndexAdder(containerTool, logger)
+
+	request := indexer.AddToIndexRequest{
+		Generate:          false,
+		FromIndex:         indexImage1,
+		BinarySourceImage: "",
+		OutDockerfile:     "",
+		Tag:               indexImage2,
 		Bundles:           bundles,
 		Permissive:        false,
 	}
@@ -123,7 +144,7 @@ func exportWith(containerTool string) error {
 	indexExporter := indexer.NewIndexExporter(containerTool, logger)
 
 	request := indexer.ExportFromIndexRequest{
-		Index:         indexImage,
+		Index:         indexImage2,
 		Package:       packageName,
 		DownloadPath:  "downloaded",
 		ContainerTool: containerTool,
@@ -186,7 +207,15 @@ var _ = Describe("opm", func() {
 			Expect(err).NotTo(HaveOccurred())
 
 			By("pushing an index")
-			err = pushWith(containerTool, indexImage)
+			err = pushWith(containerTool, indexImage1)
+			Expect(err).NotTo(HaveOccurred())
+
+			By("building from an index")
+			err = buildFromIndexWith(containerTool)
+			Expect(err).NotTo(HaveOccurred())
+
+			By("pushing an index")
+			err = pushWith(containerTool, indexImage2)
 			Expect(err).NotTo(HaveOccurred())
 
 			By("exporting an index to disk")