Merge pull request #483 from benluddy/listbundles-channel-entry-replacement

Bug 1889388: Set replaces in ListBundles query result using channel entries.

Author: openshift-merge-robot

pkg/sqlite/query.go

@@ -924,19 +924,20 @@ func (s *SQLQuerier) GetCurrentCSVNameForChannel(ctx context.Context, pkgName, c
 	return "", nil
 }
 
-func (s *SQLQuerier) ListBundles(ctx context.Context) ([]*api.Bundle, error) {
-	query := `SELECT DISTINCT channel_entry.entry_id, operatorbundle.bundle, operatorbundle.bundlepath,
-	channel_entry.operatorbundle_name, channel_entry.package_name, channel_entry.channel_name, operatorbundle.replaces, operatorbundle.skips,
-	operatorbundle.version, operatorbundle.skiprange,
-	dependencies.type, dependencies.value,
-	properties.type, properties.value
-	FROM channel_entry
-	INNER JOIN operatorbundle ON operatorbundle.name = channel_entry.operatorbundle_name
-	LEFT OUTER JOIN dependencies ON dependencies.operatorbundle_name = channel_entry.operatorbundle_name
-	LEFT OUTER JOIN properties ON properties.operatorbundle_name = channel_entry.operatorbundle_name
-	INNER JOIN package ON package.name = channel_entry.package_name`
+const listBundlesQuery = `SELECT DISTINCT channel_entry.entry_id, operatorbundle.bundle, operatorbundle.bundlepath,
+channel_entry.operatorbundle_name, channel_entry.package_name, channel_entry.channel_name, replaced_entry.operatorbundle_name, operatorbundle.skips,
+operatorbundle.version, operatorbundle.skiprange,
+dependencies.type, dependencies.value,
+properties.type, properties.value
+FROM channel_entry
+LEFT OUTER JOIN channel_entry AS replaced_entry ON channel_entry.replaces = replaced_entry.entry_id
+INNER JOIN operatorbundle ON operatorbundle.name = channel_entry.operatorbundle_name
+LEFT OUTER JOIN dependencies ON dependencies.operatorbundle_name = channel_entry.operatorbundle_name
+LEFT OUTER JOIN properties ON properties.operatorbundle_name = channel_entry.operatorbundle_name
+INNER JOIN package ON package.name = channel_entry.package_name`
 
-	rows, err := s.db.QueryContext(ctx, query)
+func (s *SQLQuerier) ListBundles(ctx context.Context) ([]*api.Bundle, error) {
+	rows, err := s.db.QueryContext(ctx, listBundlesQuery)
 	if err != nil {
 		return nil, err
 	}

pkg/sqlite/query_sql_test.go

@@ -0,0 +1,91 @@
+package sqlite
+
+import (
+	"context"
+	"database/sql"
+	"testing"
+
+	_ "github.com/mattn/go-sqlite3"
+)
+
+func TestListBundlesQuery(t *testing.T) {
+	for _, tt := range []struct {
+		Name   string
+		Setup  func(t *testing.T, db *sql.DB)
+		Expect func(t *testing.T, rows *sql.Rows)
+	}{
+		{
+			Name: "replacement comes from channel entry",
+			Setup: func(t *testing.T, db *sql.DB) {
+				for _, stmt := range []string{
+					`insert into package (name, default_channel) values ("package", "channel")`,
+					`insert into channel (name, package_name, head_operatorbundle_name) values ("channel", "package", "bundle")`,
+					`insert into operatorbundle (name) values ("bundle-a"), ("bundle-b")`,
+					`insert into channel_entry (package_name, channel_name, operatorbundle_name, entry_id, replaces) values ("package", "channel", "bundle-a", 1, 2)`,
+					`insert into channel_entry (package_name, channel_name, operatorbundle_name, entry_id) values ("package", "channel", "bundle-b", 2)`,
+				} {
+					if _, err := db.Exec(stmt); err != nil {
+						t.Fatalf("unexpected error executing setup statements: %v", err)
+					}
+				}
+
+			},
+			Expect: func(t *testing.T, rows *sql.Rows) {
+				replacements := map[sql.NullString]sql.NullString{
+					sql.NullString{String: "bundle-a", Valid: true}: sql.NullString{String: "bundle-b", Valid: true},
+					sql.NullString{String: "bundle-b", Valid: true}: sql.NullString{Valid: false},
+				}
+				for rows.Next() {
+					var (
+						c            interface{}
+						name, actual sql.NullString
+					)
+					if err := rows.Scan(&c, &c, &c, &name, &c, &c, &actual, &c, &c, &c, &c, &c, &c, &c); err != nil {
+						t.Fatalf("unexpected error during row scan: %v", err)
+					}
+					expected, ok := replacements[name]
+					if !ok {
+						t.Errorf("unexpected name: %v", name)
+						continue
+					}
+					delete(replacements, name)
+					if actual != expected {
+						t.Errorf("got replacement %v for %v, expected %v", actual, name, expected)
+						continue
+					}
+				}
+				for replacer, replacee := range replacements {
+					t.Errorf("missing expected result row: %v replaces %v", replacer, replacee)
+				}
+			},
+		},
+	} {
+		t.Run(tt.Name, func(t *testing.T) {
+			ctx := context.Background()
+
+			db, err := sql.Open("sqlite3", ":memory:")
+			if err != nil {
+				t.Fatalf("unable to open in-memory sqlite database: %v", err)
+			}
+
+			m, err := NewSQLLiteMigrator(db)
+			if err != nil {
+				t.Fatalf("unable to create database migrator: %v", err)
+			}
+
+			if err := m.Migrate(ctx); err != nil {
+				t.Fatalf("failed to perform initial schema migration: %v", err)
+			}
+
+			tt.Setup(t, db)
+
+			rows, err := db.QueryContext(ctx, listBundlesQuery)
+			if err != nil {
+				t.Fatalf("unexpected error executing list bundles query: %v", err)
+			}
+			defer rows.Close()
+
+			tt.Expect(t, rows)
+		})
+	}
+}