go/kbfs/data/path_part_string_test.go - master - githubmirror/client

go/kbfs/data/path_part_string_test.go
154 строки5 KB
Jeremy Stribling
data: don't obfuscate over conflict suffixes
24 июн 2019, 22:38
24 июн 2019, 22:386a15171
// Copyright 2019 Keybase Inc. All rights reserved.
// Use of this source code is governed by a BSD
// license that can be found in the LICENSE file.

package data

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

	"github.com/keybase/client/go/libkb"
	"github.com/stretchr/testify/require"
)

func TestPathPartStringBasic(t *testing.T) {
	secret := NodeObfuscatorSecret([]byte{1, 2, 3, 4})
	no := NewNodeObfuscator(secret)

	t.Log("Check String() without extensions")
	pps := NewPathPartString("test", no)
	ob := pps.String()
	words := strings.Split(ob, separator)
	require.Len(t, words, 2)
	require.True(t, libkb.ValidSecWord(words[0]), words[0])
	require.True(t, libkb.ValidSecWord(words[1]), words[1])

	t.Log("Check String() with short extension")
	pps2 := NewPathPartString("test.txt", no)
	ob2 := pps2.String()
	require.True(t, strings.HasSuffix(ob2, ".txt"))
	words2 := strings.Split(strings.Replace(ob2, ".txt", "", 1), separator)
	require.Len(t, words2, 2)
	require.True(t, libkb.ValidSecWord(words2[0]), words2[0])
	require.True(t, libkb.ValidSecWord(words2[1]), words2[1])
	t.Log("Make sure that the words aren't the same")
	require.False(t, words[0] == words2[0] && words[1] == words2[1])

	t.Log("Check String() with longer, but still valid, extension")
	pps3 := NewPathPartString("test.tar.gz", no)
	ob3 := pps3.String()
	require.True(t, strings.HasSuffix(ob3, ".tar.gz"))
	words3 := strings.Split(strings.Replace(ob3, ".tar.gz", "", 1), separator)
	require.Len(t, words3, 2)
	require.True(t, libkb.ValidSecWord(words3[0]), words3[0])
	require.True(t, libkb.ValidSecWord(words3[1]), words3[1])

	t.Log("Check String() with a too-long extension")
	pps4 := NewPathPartString("test.longextension", no)
	ob4 := pps4.String()
	require.False(t, strings.HasSuffix(ob4, ".longextension"))
	words4 := strings.Split(ob4, separator)
	require.Len(t, words4, 2)
	require.True(t, libkb.ValidSecWord(words4[0]), words4[0])
	require.True(t, libkb.ValidSecWord(words4[1]), words4[1])

	t.Log("Check String() with a conflicted suffix")
	cSuffix := ".conflicted (alice's device copy 2019-06-10).txt"
	pps5 := NewPathPartString("test"+cSuffix, no)
	ob5 := pps5.String()
	require.True(t, strings.HasSuffix(ob5, cSuffix))
	words5 := strings.Split(strings.Replace(ob5, cSuffix, "", 1), separator)
	require.Len(t, words5, 2)
	require.Equal(t, words2[0], words5[0])
	require.Equal(t, words2[1], words5[1])
}

func TestPathPartStringEquality(t *testing.T) {
	secret := NodeObfuscatorSecret([]byte{1, 2, 3, 4})
	no := NewNodeObfuscator(secret)

	t.Log("Check equal PathPartStrings")
	pps1 := NewPathPartString("test", no)
	pps2 := NewPathPartString("test", no)
	require.True(t, pps1 == pps2)

	t.Log("Check as a map key")
	pps3 := NewPathPartString("test2", no)
	val1 := 50
	val3 := 100
	m := map[PathPartString]int{
		pps1: val1,
		pps3: val3,
	}
	require.Equal(t, val1, m[pps1])
	require.Equal(t, val1, m[pps2])
	require.Equal(t, val3, m[pps3])

	t.Log("Check unequal PathPartStrings with different strings")
	pps1 = NewPathPartString("test", no)
	pps2 = NewPathPartString("test2", no)
	require.False(t, pps1 == pps2)

	t.Log("Check unequal PathPartStrings with different obfuscators")
	no2 := NewNodeObfuscator(secret)
	pps1 = NewPathPartString("test", no)
	pps2 = NewPathPartString("test", no2)
	require.False(t, pps1 == pps2)
}

func TestPathPartStringPrefix(t *testing.T) {
	secret := NodeObfuscatorSecret([]byte{1, 2, 3, 4})
	no := NewNodeObfuscator(secret)

	t.Log("Check that special .kbfs_ files are ignored")
	status := ".kbfs_status"
	pps1 := NewPathPartString(status, no)
	ob1 := pps1.String()
	require.Equal(t, status, ob1)

	t.Log("Check that .kbfs_fileinfo files are still partially obfuscated")
	fileinfo := ".kbfs_fileinfo_test.txt"
	pps2 := NewPathPartString(fileinfo, no)
	ob2 := pps2.String()
	require.True(t, strings.HasPrefix(ob2, ".kbfs_fileinfo_"))
	require.True(t, strings.HasSuffix(ob2, ".txt"))
	words2 := strings.Split(
		strings.TrimSuffix(strings.TrimPrefix(ob2, ".kbfs_fileinfo_"), ".txt"),
		separator)
	require.Len(t, words2, 2)
	require.True(t, libkb.ValidSecWord(words2[0]), words2[0])
	require.True(t, libkb.ValidSecWord(words2[1]), words2[1])

	t.Log("Check file info with a conflicted suffix")
	cSuffix := ".conflicted (alice's device copy 2019-06-10).txt"
	pps3 := NewPathPartString(".kbfs_fileinfo_test"+cSuffix, no)
	ob3 := pps3.String()
	require.True(t, strings.HasPrefix(ob3, ".kbfs_fileinfo_"))
	require.True(t, strings.HasSuffix(ob3, cSuffix))
	words3 := strings.Split(
		strings.TrimSuffix(strings.TrimPrefix(ob3, ".kbfs_fileinfo_"), cSuffix),
		separator)
	require.Len(t, words3, 2)
	require.Equal(t, words2[0], words3[0])
	require.Equal(t, words2[1], words3[1])
}

func TestPathPartStringMarshal(t *testing.T) {
	secret := NodeObfuscatorSecret([]byte{1, 2, 3, 4})
	no := NewNodeObfuscator(secret)
	pps := NewPathPartString("test", no)
	require.Panics(t, func() {
		_, _ = json.Marshal(pps)
	})

	type m struct {
		PPS   PathPartString
		Other string
	}
	m1 := m{pps, "test"}
	require.Panics(t, func() {
		_, _ = json.Marshal(m1)
	})
}