50e92b65c6
Adds compliance with clues.Concealer to the paths package. Also introduces a new struct in the same space: Elements, which is a thin wrapper around a slice of strings so that subsections of a path or builder can carry the same pii behavior without additional work on the consumer's end. --- #### Does this PR need a docs update or release note? - [x] 🕐 Yes, but in a later PR #### Type of change - [x] 🌻 Feature - [x] 🤖 Supportability/Tests #### Issue(s) * #2024 #### Test Plan - [x] ⚡ Unit test - [x] 💚 E2E
101 lines
2.7 KiB
Go
101 lines
2.7 KiB
Go
package path
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/alcionai/clues"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/suite"
|
|
|
|
"github.com/alcionai/corso/src/internal/tester"
|
|
)
|
|
|
|
type ElementsUnitSuite struct {
|
|
tester.Suite
|
|
}
|
|
|
|
func TestElementsUnitSuite(t *testing.T) {
|
|
suite.Run(t, &ElementsUnitSuite{Suite: tester.NewUnitSuite(t)})
|
|
}
|
|
|
|
// set the clues hashing to mask for the span of this suite
|
|
func (suite *ElementsUnitSuite) SetupSuite() {
|
|
clues.SetHasher(clues.HashCfg{HashAlg: clues.Flatmask})
|
|
}
|
|
|
|
// revert clues hashing to plaintext for all other tests
|
|
func (suite *ElementsUnitSuite) TeardownSuite() {
|
|
clues.SetHasher(clues.NoHash())
|
|
}
|
|
|
|
func (suite *ElementsUnitSuite) TestNewElements() {
|
|
t := suite.T()
|
|
|
|
result := NewElements("")
|
|
assert.Equal(t, Elements{""}, result)
|
|
|
|
result = NewElements("fnords")
|
|
assert.Equal(t, Elements{"fnords"}, result)
|
|
|
|
result = NewElements("fnords/smarf")
|
|
assert.Equal(t, Elements{"fnords", "smarf"}, result)
|
|
}
|
|
|
|
func (suite *ElementsUnitSuite) TestElements_piiHandling() {
|
|
table := []struct {
|
|
name string
|
|
elems Elements
|
|
expect string
|
|
expectString string
|
|
expectPlain string
|
|
}{
|
|
{
|
|
name: "all concealed",
|
|
elems: Elements{"foo", "bar/", "baz"},
|
|
expect: "***/***/***",
|
|
expectString: `foo/bar\//baz`,
|
|
expectPlain: `foo/bar//baz`,
|
|
},
|
|
{
|
|
name: "all safe",
|
|
elems: Elements{UnknownService.String(), UnknownCategory.String(), ExchangeMetadataService.String()},
|
|
expect: "UnknownService/UnknownCategory/exchangeMetadata",
|
|
expectString: "UnknownService/UnknownCategory/exchangeMetadata",
|
|
expectPlain: "UnknownService/UnknownCategory/exchangeMetadata",
|
|
},
|
|
{
|
|
name: "mixed",
|
|
elems: Elements{UnknownService.String(), "smarf", ExchangeMetadataService.String()},
|
|
expect: "UnknownService/***/exchangeMetadata",
|
|
expectString: "UnknownService/smarf/exchangeMetadata",
|
|
expectPlain: "UnknownService/smarf/exchangeMetadata",
|
|
},
|
|
{
|
|
name: "empty elements",
|
|
elems: Elements{},
|
|
expect: "",
|
|
expectString: "",
|
|
expectPlain: "",
|
|
},
|
|
{
|
|
name: "empty string",
|
|
elems: Elements{""},
|
|
expect: "",
|
|
expectString: "",
|
|
expectPlain: "",
|
|
},
|
|
}
|
|
for _, test := range table {
|
|
suite.Run(test.name, func() {
|
|
t := suite.T()
|
|
|
|
assert.Equal(t, test.expect, test.elems.Conceal(), "conceal")
|
|
assert.Equal(t, test.expectString, test.elems.String(), "string")
|
|
assert.Equal(t, test.expect, fmt.Sprintf("%s", test.elems), "fmt %%s")
|
|
assert.Equal(t, test.expect, fmt.Sprintf("%+v", test.elems), "fmt %%+v")
|
|
assert.Equal(t, test.expectPlain, join(test.elems), "plain")
|
|
})
|
|
}
|
|
}
|