github.com/keybase/client/go@v0.0.0-20240520164431-4f512a4c85a3/libkb/json_test.go

package libkb

import (
	"os"
	"path/filepath"
	"sync"
	"testing"

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

type JSONTestFile struct {
	*JSONFile
}

type JSONTestReader interface {
	JSONReader
}
type JSONTestWriter interface {
	JSONWriter
}

func TestJsonTransaction(t *testing.T) {
	tc := SetupTest(t, "json", 1)
	defer tc.Cleanup()

	var wg sync.WaitGroup
	for i := 0; i < 20; i++ {
		wg.Add(1)
		go func() {
			tx, err := tc.G.Env.GetConfigWriter().BeginTransaction()
			if err == nil {
				_ = tx.Abort()
			}
			wg.Done()
		}()
	}
	for i := 0; i < 20; i++ {
		wg.Add(1)
		go func() {
			tx, err := tc.G.Env.GetConfigWriter().BeginTransaction()
			if err == nil {
				_ = tx.Commit()
			}
			wg.Done()
		}()
	}
	wg.Wait()
}

func buildNewJSONFile(m MetaContext) (JSONTestReader, JSONTestWriter, *JSONTestFile) {
	path := filepath.Join(m.G().Env.GetConfigDir(), "test-json-file")
	jsonFile := JSONTestFile{NewJSONFile(m.G(), path, "test file from buildNewJSONFile")}
	_ = jsonFile.Load(false)
	return &jsonFile, &jsonFile, &jsonFile
}

func TestJsonSetAndGetString(t *testing.T) {
	tc := SetupTest(t, "json", 1)
	defer tc.Cleanup()
	m := NewMetaContextForTest(tc)
	reader, writer, rawFile := buildNewJSONFile(m)
	defer func() { _ = rawFile.Nuke() }()

	// verify that the path is empty first
	path := "america.montana.bozeman"
	value := "The American Computer Museum"
	firstRead, isRet := reader.GetStringAtPath(path)
	require.False(tc.T, isRet)
	require.Equal(tc.T, firstRead, "")

	// set, get, inspect
	err := writer.SetStringAtPath(path, value)
	require.NoError(tc.T, err)
	secondRead, isRet := reader.GetStringAtPath(path)
	require.True(tc.T, isRet)
	require.Equal(tc.T, secondRead, value)
}

func TestJsonSetAndGetInt(t *testing.T) {
	tc := SetupTest(t, "json", 1)
	defer tc.Cleanup()
	m := NewMetaContextForTest(tc)
	reader, writer, rawFile := buildNewJSONFile(m)
	defer func() { _ = rawFile.Nuke() }()

	// verify that the path is empty first
	path := "candy.skittles.count"
	value := 12
	firstRead, isRet := reader.GetIntAtPath(path)
	require.False(tc.T, isRet)
	require.Equal(tc.T, firstRead, 0)

	// set, get, inspect
	err := writer.SetIntAtPath(path, value)
	require.NoError(tc.T, err)
	secondRead, isRet := reader.GetIntAtPath(path)
	require.True(tc.T, isRet)
	require.Equal(tc.T, secondRead, value)
}

func TestJsonSetAndGetBool(t *testing.T) {
	tc := SetupTest(t, "json", 1)
	defer tc.Cleanup()
	m := NewMetaContextForTest(tc)
	reader, writer, rawFile := buildNewJSONFile(m)
	defer func() { _ = rawFile.Nuke() }()

	// verify that the path is empty first
	path := "colors.orange.appetizing"
	value := true
	firstRead, isRet := reader.GetBoolAtPath(path)
	require.False(tc.T, isRet)
	require.Equal(tc.T, firstRead, false)

	// set, get, inspect
	err := writer.SetBoolAtPath(path, value)
	require.NoError(tc.T, err)
	secondRead, isRet := reader.GetBoolAtPath(path)
	require.True(tc.T, isRet)
	require.True(tc.T, secondRead)
}

func TestJsonSetAndGetNull(t *testing.T) {
	tc := SetupTest(t, "json", 1)
	defer tc.Cleanup()
	m := NewMetaContextForTest(tc)
	reader, writer, rawFile := buildNewJSONFile(m)
	defer func() { _ = rawFile.Nuke() }()

	// verify that the path is empty first
	// and that GetNull knows the path wasn't set
	path := "worldcup.victories.croatia"
	value := 2018
	isRet := reader.GetNullAtPath(path)
	require.False(tc.T, isRet)

	// set, get, inspect
	_ = writer.SetIntAtPath(path, value)
	secondRead, _ := reader.GetIntAtPath(path)
	require.Equal(tc.T, secondRead, value)
	// null it out and verify
	err := writer.SetNullAtPath(path)
	require.NoError(tc.T, err)
	isRet = reader.GetNullAtPath(path)
	require.True(tc.T, isRet)
}

func TestJsonTxRollback(t *testing.T) {
	tc := SetupTest(t, "json", 1)
	defer tc.Cleanup()
	m := NewMetaContextForTest(tc)
	G := m.G()

	// Make a tx, write something, then commit. Expecting to be able
	// to read that back during the transaction and after commit.
	w := G.Env.GetConfigWriter()
	tx, err := w.BeginTransaction()
	require.NoError(t, err)
	require.NoError(t, w.SetStringAtPath("bbbbar", "world, over?"))
	i, err := G.Env.GetConfig().GetInterfaceAtPath("bbbbar")
	require.NoError(t, err)
	require.Equal(t, "world, over?", i)
	require.NoError(t, tx.Commit())
	i, err = G.Env.GetConfig().GetInterfaceAtPath("bbbbar")
	require.NoError(t, err)
	require.Equal(t, "world, over?", i)

	// Make a tx, write something, then Rollback and Abort. It should
	// be as the write never happened.
	w = G.Env.GetConfigWriter()
	tx, err = w.BeginTransaction()
	require.NoError(t, err)
	require.NoError(t, w.SetStringAtPath("fooozzzz", "hello World"))
	i, err = G.Env.GetConfig().GetInterfaceAtPath("fooozzzz")
	require.NoError(t, err)
	require.Equal(t, "hello World", i)
	require.NoError(t, tx.Rollback())
	require.NoError(t, tx.Abort())
	_, err = G.Env.GetConfig().GetInterfaceAtPath("fooozzzz")
	require.Error(t, err)
	require.Contains(t, err.Error(), "no such key")
	i, err = G.Env.GetConfig().GetInterfaceAtPath("bbbbar")
	require.NoError(t, err)
	require.Equal(t, "world, over?", i)
}

func TestJsonNonExistingFileRollback(t *testing.T) {
	tc := SetupTest(t, "json", 1)
	defer tc.Cleanup()
	m := NewMetaContextForTest(tc)
	reader, writer, rawFile := buildNewJSONFile(m)
	defer func() { _ = rawFile.Nuke() }()

	tx, err := rawFile.BeginTransaction()
	require.NoError(t, err)
	require.NoError(t, writer.SetStringAtPath("test1", "this is value 1"))
	require.NoError(t, writer.SetIntAtPath("test two", 2))

	i, err := reader.GetInterfaceAtPath("test1")
	require.NoError(t, err)
	require.Equal(t, "this is value 1", i)

	i, err = reader.GetInterfaceAtPath("test two")
	require.NoError(t, err)
	require.Equal(t, 2, i)

	require.NoError(t, tx.Rollback())
	require.NoError(t, tx.Abort())

	_, err = os.Stat(rawFile.filename)
	require.Error(t, err)
	require.True(t, os.IsNotExist(err))

	_, err = reader.GetInterfaceAtPath("test1")
	require.Error(t, err)
	require.Contains(t, err.Error(), "no such key")

	_, err = reader.GetInterfaceAtPath("test two")
	require.Error(t, err)
	require.Contains(t, err.Error(), "no such key")
}