group_test.go

package gokeepasslib

import (
	"bytes"
	"encoding/xml"
	"errors"
	"testing"
	"time"

	w "github.com/tobischo/gokeepasslib/v3/wrappers"

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

func TestNewGroup(t *testing.T) {
	cases := []struct {
		title         string
		options       []GroupOption
		expectedGroup Group
	}{
		{
			title: "without options",
			expectedGroup: Group{
				Name: "",
			},
		},
		{
			title: "with multiple options",
			options: []GroupOption{
				WithGroupFormattedTime(false),
				func(rd *Group) {
					rd.Name = "other name"
				},
			},
			expectedGroup: Group{
				Name: "other name",
			},
		},
		{
			title: "with custom icon",
			options: []GroupOption{
				WithGroupFormattedTime(false),
				func(rd *Group) {
					rd.CustomIconUUID = UUID{
						0xde, 0xad, 0xbe, 0xef,
						0xc0, 0xff, 0xee, 0xde,
						0xed, 0x01, 0x23, 0x45,
						0x67, 0x89, 0xab, 0xcd,
					}
				},
			},
			expectedGroup: Group{
				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) {
			group := NewGroup(c.options...)

			if group.Name != c.expectedGroup.Name {
				t.Errorf(
					"Did not receive expected name %+v, received %+v",
					group.Name,
					c.expectedGroup.Name,
				)
			}
		})
	}
}

func compareGroup(a, b Group) bool {
	if !cmp.Equal(
		a,
		b,
		cmp.AllowUnexported(Group{}),
		cmpopts.IgnoreFields(Group{}, "Entries", "Groups"),
	) {
		return false
	}

	if !slices.EqualFunc(
		a.Groups,
		b.Groups,
		compareGroup,
	) {
		return false
	}

	if !slices.EqualFunc(
		a.Entries,
		b.Entries,
		compareEntry,
	) {
		return false
	}

	return true
}

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

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

			clone := group.Clone()

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

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

			clone.UUID = group.UUID
			if !compareGroup(clone, group) {
				t.Errorf(
					"Did not receive expected Group %+v, received %+v",
					clone,
					group,
				)
			}
		})
	}
}

func TestGroupSetKdbxFormatVersion(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) {
			group := NewGroup(
				WithGroupFormattedTime(c.formattedInitValue),
			)

			entry := NewEntry(
				WithEntryFormattedTime(c.formattedInitValue),
			)
			group.Entries = append(group.Entries, entry)

			subGroup := NewGroup(
				WithGroupFormattedTime(c.formattedInitValue),
			)
			group.Groups = append(group.Groups, subGroup)

			(&group).setKdbxFormatVersion(c.version)

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

			if group.Groups[0].Times.CreationTime.Formatted != c.expectedFormattedValue {
				t.Errorf("Failed to set sub group CreationTime formatted value accordingly")
			}

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

func prepareTimeWrapper(time time.Time) (*w.TimeWrapper, string) {
	wrapper := &w.TimeWrapper{Time: time}
	data, _ := wrapper.MarshalText()
	text := string(data)
	wrapper.UnmarshalText(data)

	return wrapper, text
}

func TestGroupUnmarshalXML(t *testing.T) {
	now := time.Now()

	creationTime := now
	lastModificationTime := now.AddDate(0, 0, 1)
	lastAccessTime := now.AddDate(0, 0, 2)
	expiryTime := now.AddDate(0, 0, 3)
	locationChanged := now.AddDate(0, 0, 4)

	creationTimeWrapper, creationTimeText := prepareTimeWrapper(creationTime)
	lastModificationTimeWrapper, lastModificationTimeText := prepareTimeWrapper(lastModificationTime)
	lastAccessTimeWrapper, lastAccessTimeText := prepareTimeWrapper(lastAccessTime)
	expiryTimeWrapper, expiryTimeText := prepareTimeWrapper(expiryTime)
	locationChangedWrapper, locationChangedText := prepareTimeWrapper(locationChanged)

	cases := []struct {
		title         string
		xmlData       string
		expectedGroup Group
		expectedErr   error
	}{
		{
			title:   "empty group",
			xmlData: "<Group></Group>",
		},
		{
			title:   "child group first",
			xmlData: "<Group><Group></Group><Entry></Entry></Group>",
			expectedGroup: Group{
				Entries:         []Entry{{}},
				Groups:          []Group{{}},
				groupChildOrder: groupChildOrderGroupFirst,
			},
		},
		{
			title:   "child entry first",
			xmlData: "<Group><Entry></Entry><Group></Group></Group>",
			expectedGroup: Group{
				Entries:         []Entry{{}},
				Groups:          []Group{{}},
				groupChildOrder: groupChildOrderEntryFirst,
			},
		},
		{
			title: "with the other fields",
			xmlData: `
      <Group>
        <UUID>uJSFMJ8KrUSO0Qiivnk2Eg==</UUID>
        <Name>kdbx4key</Name>
        <Notes>notes</Notes>
        <IconID>49</IconID>
        <Times>
          <CreationTime>` + creationTimeText + `</CreationTime>
          <LastModificationTime>` + lastModificationTimeText + `</LastModificationTime>
          <LastAccessTime>` + lastAccessTimeText + `</LastAccessTime>
          <ExpiryTime>` + expiryTimeText + `</ExpiryTime>
          <Expires>False</Expires>
          <UsageCount>1</UsageCount>
          <LocationChanged>` + locationChangedText + `</LocationChanged>
        </Times>
        <IsExpanded>True</IsExpanded>
        <DefaultAutoTypeSequence>abc</DefaultAutoTypeSequence>
        <EnableAutoType>True</EnableAutoType>
        <EnableSearching>False</EnableSearching>
        <LastTopVisibleEntry>SnB29sd3a06jo6GR1BkGBQ==</LastTopVisibleEntry>
       </Group>`,
			expectedGroup: Group{
				UUID: UUID{
					0xb8, 0x94, 0x85, 0x30,
					0x9f, 0xa, 0xad, 0x44,
					0x8e, 0xd1, 0x8, 0xa2,
					0xbe, 0x79, 0x36, 0x12,
				},
				Name:   "kdbx4key",
				Notes:  "notes",
				IconID: 49,
				Times: TimeData{
					CreationTime:         creationTimeWrapper,
					LastModificationTime: lastModificationTimeWrapper,
					LastAccessTime:       lastAccessTimeWrapper,
					ExpiryTime:           expiryTimeWrapper,
					Expires:              w.NewBoolWrapper(false),
					UsageCount:           1,
					LocationChanged:      locationChangedWrapper,
				},
				IsExpanded:              w.NewBoolWrapper(true),
				DefaultAutoTypeSequence: "abc",
				EnableAutoType:          w.NewNullableBoolWrapper(true),
				EnableSearching:         w.NewNullableBoolWrapper(false),
				LastTopVisibleEntry:     "SnB29sd3a06jo6GR1BkGBQ==",
			},
		},
	}

	for _, c := range cases {
		t.Run(c.title, func(t *testing.T) {
			decoder := xml.NewDecoder(bytes.NewBufferString(c.xmlData))

			var group Group

			err := decoder.Decode(&group)

			if !errors.Is(c.expectedErr, err) {
				t.Errorf("Expected %#v, received %#v", c.expectedErr, err)
			}

			assert.Equal(t, c.expectedGroup, group, "The groups should be identical")
		})
	}
}