query_test.go

package sqlite_test

import (
	"context"
	"database/sql"
	"fmt"
	"reflect"
	"testing"

	"github.com/operator-framework/operator-registry/pkg/api"
	"github.com/operator-framework/operator-registry/pkg/sqlite"
	"github.com/operator-framework/operator-registry/pkg/sqlite/sqlitefakes"
	"github.com/stretchr/testify/assert"
)

func TestListBundles(t *testing.T) {
	type Columns struct {
		EntryID      sql.NullInt64
		Bundle       sql.NullString
		BundlePath   sql.NullString
		BundleName   sql.NullString
		PackageName  sql.NullString
		ChannelName  sql.NullString
		Replaces     sql.NullString
		Skips        sql.NullString
		Version      sql.NullString
		SkipRange    sql.NullString
		Dependencies sql.NullString
		Properties   sql.NullString
	}

	var NoRows sqlitefakes.FakeRowScanner
	NoRows.NextReturns(false)

	ScanFromColumns := func(t *testing.T, dsts []interface{}, cols Columns) {
		ct := reflect.TypeOf(cols)
		if len(dsts) != ct.NumField() {
			t.Fatalf("expected %d columns, got %d", ct.NumField(), len(dsts))
		}
		for i, dst := range dsts {
			f := ct.Field(i)
			dv := reflect.ValueOf(dst)
			if dv.Kind() != reflect.Ptr {
				t.Fatalf("scan argument at index %d is not a pointer", i)
			}
			if !f.Type.AssignableTo(dv.Elem().Type()) {
				t.Fatalf("%s is not assignable to argument %s at index %d", f.Type, dv.Elem().Type(), i)
			}
			dv.Elem().Set(reflect.ValueOf(cols).Field(i))
		}
	}

	for _, tc := range []struct {
		Name         string
		Querier      func(t *testing.T) sqlite.Querier
		Bundles      []*api.Bundle
		ErrorMessage string
	}{
		{
			Name: "returns error when query returns error",
			Querier: func(t *testing.T) sqlite.Querier {
				var q sqlitefakes.FakeQuerier
				q.QueryContextReturns(nil, fmt.Errorf("test"))
				return &q
			},
			ErrorMessage: "test",
		},
		{
			Name: "returns error when scan returns error",
			Querier: func(t *testing.T) sqlite.Querier {
				var (
					q sqlitefakes.FakeQuerier
					r sqlitefakes.FakeRowScanner
				)
				q.QueryContextReturns(&r, nil)
				r.NextReturnsOnCall(0, true)
				r.ScanReturns(fmt.Errorf("test"))
				return &q
			},
			ErrorMessage: "test",
		},
		{
			Name: "skips row without valid bundle name",
			Querier: func(t *testing.T) sqlite.Querier {
				var (
					q sqlitefakes.FakeQuerier
					r sqlitefakes.FakeRowScanner
				)
				q.QueryContextReturns(&r, nil)
				r.NextReturnsOnCall(0, true)
				r.ScanCalls(func(args ...interface{}) error {
					ScanFromColumns(t, args, Columns{
						Version:     sql.NullString{Valid: true},
						BundlePath:  sql.NullString{Valid: true},
						ChannelName: sql.NullString{Valid: true},
					})
					return nil
				})
				return &q
			},
		},
		{
			Name: "skips row without valid version",
			Querier: func(t *testing.T) sqlite.Querier {
				var (
					q sqlitefakes.FakeQuerier
					r sqlitefakes.FakeRowScanner
				)
				q.QueryContextReturns(&r, nil)
				r.NextReturnsOnCall(0, true)
				r.ScanCalls(func(args ...interface{}) error {
					ScanFromColumns(t, args, Columns{
						BundleName:  sql.NullString{Valid: true},
						BundlePath:  sql.NullString{Valid: true},
						ChannelName: sql.NullString{Valid: true},
					})
					return nil
				})
				return &q
			},
		},
		{
			Name: "skips row without valid bundle path",
			Querier: func(t *testing.T) sqlite.Querier {
				var (
					q sqlitefakes.FakeQuerier
					r sqlitefakes.FakeRowScanner
				)
				q.QueryContextReturns(&r, nil)
				r.NextReturnsOnCall(0, true)
				r.ScanCalls(func(args ...interface{}) error {
					ScanFromColumns(t, args, Columns{
						BundleName:  sql.NullString{Valid: true},
						Version:     sql.NullString{Valid: true},
						ChannelName: sql.NullString{Valid: true},
					})
					return nil
				})
				return &q
			},
		},
		{
			Name: "skips row without valid channel name",
			Querier: func(t *testing.T) sqlite.Querier {
				var (
					q sqlitefakes.FakeQuerier
					r sqlitefakes.FakeRowScanner
				)
				q.QueryContextReturns(&r, nil)
				r.NextReturnsOnCall(0, true)
				r.ScanCalls(func(args ...interface{}) error {
					ScanFromColumns(t, args, Columns{
						BundleName: sql.NullString{Valid: true},
						Version:    sql.NullString{Valid: true},
						BundlePath: sql.NullString{Valid: true},
					})
					return nil
				})
				return &q
			},
		},
		{
			Name: "bundle dependencies are null when dependency type or value is null",
			Querier: func(t *testing.T) sqlite.Querier {
				var (
					q sqlitefakes.FakeQuerier
					r sqlitefakes.FakeRowScanner
				)
				q.QueryContextReturns(&r, nil)
				r.NextReturnsOnCall(0, true)
				r.ScanCalls(func(args ...interface{}) error {
					ScanFromColumns(t, args, Columns{
						BundleName:  sql.NullString{Valid: true},
						Version:     sql.NullString{Valid: true},
						ChannelName: sql.NullString{Valid: true},
						BundlePath:  sql.NullString{Valid: true},
					})
					return nil
				})
				return &q
			},
			Bundles: []*api.Bundle{
				{},
			},
		},
		{
			Name: "all dependencies and properties are returned",
			Querier: func(t *testing.T) sqlite.Querier {
				var (
					q sqlitefakes.FakeQuerier
					r sqlitefakes.FakeRowScanner
				)
				q.QueryContextReturns(&NoRows, nil)
				q.QueryContextReturnsOnCall(0, &r, nil)
				r.NextReturnsOnCall(0, true)
				cols := []Columns{
					{
						BundleName:   sql.NullString{Valid: true, String: "BundleName"},
						Version:      sql.NullString{Valid: true, String: "Version"},
						ChannelName:  sql.NullString{Valid: true, String: "ChannelName"},
						BundlePath:   sql.NullString{Valid: true, String: "BundlePath"},
						Dependencies: sql.NullString{Valid: true, String: `[{"type":"Dependency1Type","value":"Dependency1Value"},{"type":"Dependency2Type","value":"Dependency2Value"}]`},
						Properties:   sql.NullString{Valid: true, String: `[{"type":"Property1Type","value":"Property1Value"},{"type":"Property2Type","value":"Property2Value"}]`},
					},
				}
				var i int
				r.ScanCalls(func(args ...interface{}) error {
					if i < len(cols) {
						ScanFromColumns(t, args, cols[i])
						i++
					}
					return nil
				})
				return &q
			},
			Bundles: []*api.Bundle{
				{
					CsvName:     "BundleName",
					ChannelName: "ChannelName",
					BundlePath:  "BundlePath",
					Version:     "Version",
					Dependencies: []*api.Dependency{
						{
							Type:  "Dependency1Type",
							Value: "Dependency1Value",
						},
						{
							Type:  "Dependency2Type",
							Value: "Dependency2Value",
						},
					},
					Properties: []*api.Property{
						{
							Type:  "Property1Type",
							Value: "Property1Value",
						},
						{
							Type:  "Property2Type",
							Value: "Property2Value",
						},
					},
				},
			},
		},
	} {
		t.Run(tc.Name, func(t *testing.T) {
			var q sqlite.Querier
			if tc.Querier != nil {
				q = tc.Querier(t)
			}
			sq := sqlite.NewSQLLiteQuerierFromDBQuerier(q)
			bundles, err := sq.ListBundles(context.Background())

			assert := assert.New(t)
			assert.Equal(tc.Bundles, bundles)
			if tc.ErrorMessage == "" {
				assert.NoError(err)
			} else {
				assert.EqualError(err, tc.ErrorMessage)
			}
		})
	}
}