entry_test.go

package gokeepasslib

import (
	"reflect"
	"testing"

	"github.com/google/go-cmp/cmp"
	"github.com/google/go-cmp/cmp/cmpopts"
	"golang.org/x/exp/slices"
)

func TestNewEntry(t *testing.T) {
	cases := []struct {
		title         string
		options       []EntryOption
		expectedEntry Entry
	}{
		{
			title:         "without options",
			expectedEntry: Entry{},
		},
		{
			title: "with multiple options",
			options: []EntryOption{
				WithEntryFormattedTime(false),
				func(e *Entry) {
					e.Tags = "Test Tags"
				},
			},
			expectedEntry: Entry{
				Tags: "Test Tags",
			},
		},
		{
			title: "with custom icon",
			options: []EntryOption{
				WithEntryFormattedTime(false),
				func(e *Entry) {
					e.CustomIconUUID = UUID{
						0xde, 0xad, 0xbe, 0xef,
						0xc0, 0xff, 0xee, 0xde,
						0xed, 0x01, 0x23, 0x45,
						0x67, 0x89, 0xab, 0xcd,
					}
				},
			},
			expectedEntry: Entry{
				CustomIconUUID: UUID{
					0xde, 0xad, 0xbe, 0xef,
					0xc0, 0xff, 0xee, 0xde,
					0xed, 0x01, 0x23, 0x45,
					0x67, 0x89, 0xab, 0xcd,
				},
			},
		},
	}

	for _, c := range cases {
		t.Run(c.title, func(t *testing.T) {
			entry := NewEntry(c.options...)

			// times and uuids are generated at random.
			// testing them with a clear comparison does not work
			c.expectedEntry.Times = entry.Times
			c.expectedEntry.UUID = entry.UUID

			if !reflect.DeepEqual(entry, c.expectedEntry) {
				t.Errorf(
					"Did not receive expected Entry %+v, received %+v",
					c.expectedEntry,
					entry,
				)
			}
		})
	}
}

func compareEntry(a, b Entry) bool {
	if !cmp.Equal(
		a,
		b,
		cmpopts.IgnoreFields(Entry{}, "Values", "Histories", "Binaries", "CustomData"),
	) {
		return false
	}

	if !slices.EqualFunc(
		a.Values,
		b.Values,
		func(a, b ValueData) bool {
			return cmp.Equal(a, b)
		},
	) {
		return false
	}

	if !slices.EqualFunc(
		a.Histories,
		b.Histories,
		func(a, b History) bool {
			return cmp.Equal(a, b)
		},
	) {
		return false
	}

	if !slices.EqualFunc(
		a.Binaries,
		b.Binaries,
		func(a, b BinaryReference) bool {
			return cmp.Equal(a, b)
		},
	) {
		return false
	}

	if !slices.EqualFunc(
		a.CustomData,
		b.CustomData,
		func(a, b CustomData) bool {
			return cmp.Equal(a, b)
		},
	) {
		return false
	}

	return true
}

func TestEntry_Clone(t *testing.T) {
	cases := []struct {
		title string
	}{
		{
			title: "success",
		},
	}

	for _, c := range cases {
		t.Run(c.title, func(t *testing.T) {
			entry := NewEntry()

			clone := entry.Clone()

			if &clone == &entry {
				t.Errorf("clone struct has the same pointer address")
			}

			if clone.UUID == entry.UUID {
				t.Errorf("clone did not receive a new UUID")
			}

			clone.UUID = entry.UUID
			if !compareEntry(entry, clone) {
				t.Errorf(
					"Did not receive expected Entry %+v, received %+v",
					clone,
					entry,
				)
			}
		})
	}
}

func TestEntrySetKdbxFormatVersion(t *testing.T) {
	cases := []struct {
		title                  string
		formattedInitValue     bool
		version                formatVersion
		expectedFormattedValue bool
	}{
		{
			title:                  "initialized as v3, changed to v4",
			formattedInitValue:     true,
			version:                4,
			expectedFormattedValue: false,
		},
		{
			title:                  "initialized as v4, changed to v3",
			formattedInitValue:     false,
			version:                3,
			expectedFormattedValue: true,
		},
		{
			title:                  "initialized as v3, not changed",
			formattedInitValue:     true,
			version:                3,
			expectedFormattedValue: true,
		},
		{
			title:                  "initialized as v4, not changed",
			formattedInitValue:     false,
			version:                4,
			expectedFormattedValue: false,
		},
	}

	for _, c := range cases {
		t.Run(c.title, func(t *testing.T) {
			entry := NewEntry(
				WithEntryFormattedTime(c.formattedInitValue),
			)

			history := History{
				Entries: []Entry{
					NewEntry(
						WithEntryFormattedTime(c.formattedInitValue),
					),
				},
			}

			entry.Histories = append(entry.Histories, history)

			(&entry).setKdbxFormatVersion(c.version)

			// Takes a single time value as an example, as TimeData is independently tested.
			if entry.Times.CreationTime.Formatted != c.expectedFormattedValue {
				t.Errorf("Failed to set root CreationTime formatted value accordingly")
			}

			if entry.Histories[0].Entries[0].Times.CreationTime.Formatted != c.expectedFormattedValue {
				t.Errorf("Failed to set history CreationTime formatted value accordingly")
			}
		})
	}
}

func TestHistory_Clone(t *testing.T) {
	cases := []struct {
		title string
	}{
		{
			title: "success",
		},
	}

	for _, c := range cases {
		t.Run(c.title, func(t *testing.T) {
			entry := NewEntry()
			history := History{
				Entries: []Entry{entry},
			}

			clone := history.Clone()

			if &clone == &history {
				t.Errorf("clone struct has the same pointer address")
			}

			if clone.Entries[0].UUID == history.Entries[0].UUID {
				t.Errorf("cloned entry did not receive a new UUID")
			}

			clone.Entries[0].UUID = history.Entries[0].UUID
			if !slices.EqualFunc(
				history.Entries,
				clone.Entries,
				compareEntry,
			) {
				t.Errorf(
					"Did not receive expected History %+v, received %+v",
					clone,
					history,
				)
			}
		})
	}
}