yay/pkg/settings/migrations_test.go

//go:build !integration

package settings

import (
	"encoding/json"
	"io"
	"os"
	"strings"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	"github.com/Jguer/yay/v13/pkg/text"
)

func newTestLogger() *text.Logger {
	return text.NewLogger(io.Discard, io.Discard, strings.NewReader(""), true, "test")
}

func TestMigrationNothingToDo(t *testing.T) {
	t.Parallel()
	// Create temporary file for config
	configFile, err := os.CreateTemp("/tmp", "yay-*-config.json")
	require.NoError(t, err)

	testFilePath := configFile.Name()
	defer os.Remove(testFilePath)
	// Create config with configVersion
	config := Configuration{
		Version: "99.0.0",
		// Create runtime with runtimeVersion
	}

	// Run Migration
	err = config.RunMigrations(newTestLogger(), DefaultMigrations(), testFilePath, "20.0.0")
	require.NoError(t, err)

	// Check file contents if wantSave otherwise check file empty
	cfile, err := os.Open(testFilePath)
	require.NoError(t, err)
	defer cfile.Close()

	decoder := json.NewDecoder(cfile)
	newConfig := Configuration{}
	err = decoder.Decode(&newConfig)
	require.Error(t, err)
	assert.Empty(t, newConfig.Version)
}

func TestProvidesMigrationDo(t *testing.T) {
	migration := &configProviderMigration{}
	config := Configuration{
		Provides: true,
	}

	assert.True(t, migration.Do(&config))

	falseConfig := Configuration{Provides: false}

	assert.False(t, migration.Do(&falseConfig))
}

func TestProvidesMigration(t *testing.T) {
	t.Parallel()
	type testCase struct {
		desc       string
		testConfig *Configuration
		newVersion string
		wantSave   bool
	}

	testCases := []testCase{
		{
			desc: "to upgrade",
			testConfig: &Configuration{
				Version:  "11.0.1",
				Provides: true,
			},
			newVersion: "11.2.1",
			wantSave:   true,
		},
		{
			desc: "to upgrade-git",
			testConfig: &Configuration{
				Version:  "11.2.0.r7.g6f60892",
				Provides: true,
			},
			newVersion: "11.2.1",
			wantSave:   true,
		},
		{
			desc: "to not upgrade",
			testConfig: &Configuration{
				Version:  "11.2.0",
				Provides: false,
			},
			newVersion: "11.2.1",
			wantSave:   false,
		},
		{
			desc: "to not upgrade - target version",
			testConfig: &Configuration{
				Version:  "11.2.1",
				Provides: true,
			},
			newVersion: "11.2.1",
			wantSave:   false,
		},
		{
			desc: "to not upgrade - new version",
			testConfig: &Configuration{
				Version:  "11.3.0",
				Provides: true,
			},
			newVersion: "11.3.0",
			wantSave:   false,
		},
	}

	for _, tc := range testCases {
		t.Run(tc.desc, func(t *testing.T) {
			// Create temporary file for config
			configFile, err := os.CreateTemp("/tmp", "yay-*-config.json")
			require.NoError(t, err)

			testFilePath := configFile.Name()
			defer os.Remove(testFilePath)
			// Create config with configVersion and provides
			tcConfig := Configuration{
				Version:  tc.testConfig.Version,
				Provides: tc.testConfig.Provides,
				// Create runtime with runtimeVersion
			}

			// Run Migration
			err = tcConfig.RunMigrations(newTestLogger(),
				[]configMigration{&configProviderMigration{}},
				testFilePath, tc.newVersion)

			require.NoError(t, err)

			// Check file contents if wantSave otherwise check file empty
			cfile, err := os.Open(testFilePath)
			require.NoError(t, err)
			defer cfile.Close()

			decoder := json.NewDecoder(cfile)
			newConfig := Configuration{}
			err = decoder.Decode(&newConfig)
			if tc.wantSave {
				require.NoError(t, err)
				assert.Equal(t, tc.newVersion, newConfig.Version)
				assert.Equal(t, false, newConfig.Provides)
			} else {
				require.Error(t, err)
				assert.Empty(t, newConfig.Version)
			}
		})
	}
}

func TestSortByMigrationDo(t *testing.T) {
	migration := &configSortByMigration{}
	config := Configuration{
		SortBy: "name",
	}

	assert.True(t, migration.Do(&config))

	falseConfig := Configuration{SortBy: ""}

	assert.False(t, migration.Do(&falseConfig))
}

func TestSortByMigration(t *testing.T) {
	t.Parallel()
	type testCase struct {
		desc       string
		testConfig *Configuration
		newVersion string
		wantSave   bool
	}

	testCases := []testCase{
		{
			desc: "to upgrade",
			testConfig: &Configuration{
				Version: "12.5.7",
				SortBy:  "name",
			},
			newVersion: "12.6.0",
			wantSave:   true,
		},
		{
			desc: "to upgrade-git",
			testConfig: &Configuration{
				Version: "12.3.0.r7.g6f60892",
				SortBy:  "votes",
			},
			newVersion: "12.6.0",
			wantSave:   true,
		},
		{
			desc: "to not upgrade",
			testConfig: &Configuration{
				Version: "12.2.0",
				SortBy:  "",
			},
			newVersion: "12.6.0",
			wantSave:   false,
		},
		{
			desc: "to not upgrade - target version",
			testConfig: &Configuration{
				Version: "12.6.0",
				SortBy:  "name",
			},
			newVersion: "12.6.0",
			wantSave:   false,
		},
		{
			desc: "to not upgrade - new version",
			testConfig: &Configuration{
				Version: "13.1.0",
				SortBy:  "name",
			},
			newVersion: "13.1.0",
			wantSave:   false,
		},
	}

	for _, tc := range testCases {
		t.Run(tc.desc, func(t *testing.T) {
			// Create temporary file for config
			configFile, err := os.CreateTemp("/tmp", "yay-*-config.json")
			require.NoError(t, err)

			testFilePath := configFile.Name()
			defer os.Remove(testFilePath)
			// Create config with configVersion and sortby
			tcConfig := Configuration{
				Version: tc.testConfig.Version,
				SortBy:  tc.testConfig.SortBy,
				// Create runtime with runtimeVersion
			}

			// Run Migration
			err = tcConfig.RunMigrations(newTestLogger(),
				[]configMigration{&configSortByMigration{}},
				testFilePath, tc.newVersion)

			require.NoError(t, err)

			// Check file contents if wantSave otherwise check file empty
			cfile, err := os.Open(testFilePath)
			require.NoError(t, err)
			defer cfile.Close()

			decoder := json.NewDecoder(cfile)
			newConfig := Configuration{}
			err = decoder.Decode(&newConfig)
			if tc.wantSave {
				require.NoError(t, err)
				assert.Equal(t, tc.newVersion, newConfig.Version)
				assert.Equal(t, "", newConfig.SortBy)
			} else {
				require.Error(t, err)
				assert.Empty(t, newConfig.Version)
			}
		})
	}
}