Merge pull request #63 from tmckayus/replacecircuit

Bug 1783030: Detect replacement cycles while adding package channels

Author: openshift-merge-robot

pkg/sqlite/configmap_test.go

@@ -1,11 +1,14 @@
 package sqlite
 
 import (
+	"bytes"
 	"context"
 	"database/sql"
 	"fmt"
+	"io/ioutil"
 	"math/rand"
 	"os"
+	"strings"
 	"testing"
 
 	"github.com/sirupsen/logrus"
@@ -58,6 +61,34 @@ func TestConfigMapLoader(t *testing.T) {
 	require.NoError(t, loader.Populate())
 }
 
+func TestReplaceCycle(t *testing.T) {
+	logrus.SetLevel(logrus.DebugLevel)
+
+	db, cleanup := CreateTestDb(t)
+	defer cleanup()
+	store, err := NewSQLLiteLoader(db)
+	require.NoError(t, err)
+
+	path := "../../configmap.example.yaml"
+	cmap, err := ioutil.ReadFile(path)
+
+	require.NoError(t, err, "unable to load configmap from file %s", path)
+
+	// Make etcdoperator.v0.9.0 in the example replace 0.9.2 to create a loop
+	sReader := strings.NewReader(string(bytes.Replace(cmap,
+			[]byte("replaces: etcdoperator.v0.6.1"),
+			[]byte("replaces: etcdoperator.v0.9.2"), 1)))
+
+	decoder := yaml.NewYAMLOrJSONDecoder(sReader, 30)
+	manifest := v1.ConfigMap{}
+	err = decoder.Decode(&manifest)
+	require.NoError(t, err, "could not decode contents of file %s into configmap", path)
+
+	loader := NewSQLLoaderForConfigMap(store, manifest)
+	err = loader.Populate()
+	require.Error(t, err, "Cycle detected, etcdoperator.v0.9.0 replaces etcdoperator.v0.9.2")
+}
+
 func TestQuerierForConfigmap(t *testing.T) {
 	db, cleanup := CreateTestDb(t)
 	defer cleanup()

pkg/sqlite/load.go

@@ -190,8 +190,10 @@ func (s *SQLLoader) AddPackageChannels(manifest registry.PackageManifest) error
 
 		channelEntryCSVName := c.CurrentCSVName
 		depth := 1
-		for {
 
+		// Since this loop depends on following 'replaces', keep track of where it's been
+		replaceCycle := map[string]bool{channelEntryCSVName: true}
+		for {
 			// Get CSV for current entry
 			channelEntryCSV, err := s.getCSV(tx, channelEntryCSVName)
 			if err != nil {
@@ -265,6 +267,14 @@ func (s *SQLLoader) AddPackageChannels(manifest registry.PackageManifest) error
 				errs = append(errs, err)
 				break
 			}
+
+			// If we find 'replaces' in the circuit list then we've seen it already, break out
+			if _, ok := replaceCycle[replaces]; ok {
+			        errs = append(errs, fmt.Errorf("Cycle detected, %s replaces %s", channelEntryCSVName, replaces))
+				break
+			}
+			replaceCycle[replaces] = true
+
 			replacedID, err := replacedChannelEntry.LastInsertId()
 			if err != nil {
 				errs = append(errs, err)