2015-06-26 04:56:48 +02:00
|
|
|
/*
|
|
|
|
* Quick - Quick key value store for config files and persistent state files
|
|
|
|
*
|
2017-03-03 19:22:09 +01:00
|
|
|
* Quick (C) 2015 Minio, Inc.
|
2015-06-26 04:56:48 +02:00
|
|
|
*
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
*/
|
|
|
|
|
2017-03-22 18:23:25 +01:00
|
|
|
package quick
|
2015-06-26 04:56:48 +02:00
|
|
|
|
|
|
|
import (
|
2016-08-09 05:56:29 +02:00
|
|
|
"encoding/json"
|
2017-03-03 19:22:09 +01:00
|
|
|
"io/ioutil"
|
2015-06-26 04:56:48 +02:00
|
|
|
"os"
|
2017-03-03 19:22:09 +01:00
|
|
|
"reflect"
|
|
|
|
"runtime"
|
|
|
|
"strings"
|
2015-06-26 04:56:48 +02:00
|
|
|
"testing"
|
|
|
|
|
2015-08-23 03:34:00 +02:00
|
|
|
. "gopkg.in/check.v1"
|
2015-06-26 04:56:48 +02:00
|
|
|
)
|
|
|
|
|
|
|
|
func Test(t *testing.T) { TestingT(t) }
|
|
|
|
|
|
|
|
type MySuite struct{}
|
|
|
|
|
|
|
|
var _ = Suite(&MySuite{})
|
|
|
|
|
2017-05-06 19:16:59 +02:00
|
|
|
func (s *MySuite) TestReadVersion(c *C) {
|
|
|
|
type myStruct struct {
|
|
|
|
Version string
|
|
|
|
}
|
|
|
|
saveMe := myStruct{"1"}
|
|
|
|
config, err := New(&saveMe)
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
err = config.Save("test.json")
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
|
|
|
|
version, err := GetVersion("test.json")
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(version, Equals, "1")
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *MySuite) TestReadVersionErr(c *C) {
|
|
|
|
type myStruct struct {
|
|
|
|
Version int
|
|
|
|
}
|
|
|
|
saveMe := myStruct{1}
|
|
|
|
_, err := New(&saveMe)
|
|
|
|
c.Assert(err, Not(IsNil))
|
|
|
|
|
|
|
|
err = ioutil.WriteFile("test.json", []byte("{ \"version\":2,"), 0644)
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
|
|
|
|
_, err = GetVersion("test.json")
|
|
|
|
c.Assert(err, Not(IsNil))
|
|
|
|
|
|
|
|
err = ioutil.WriteFile("test.json", []byte("{ \"version\":2 }"), 0644)
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
|
|
|
|
_, err = GetVersion("test.json")
|
|
|
|
c.Assert(err, Not(IsNil))
|
|
|
|
}
|
|
|
|
|
2016-01-15 03:17:24 +01:00
|
|
|
func (s *MySuite) TestSaveFailOnDir(c *C) {
|
|
|
|
defer os.RemoveAll("test.json")
|
|
|
|
e := os.MkdirAll("test.json", 0644)
|
|
|
|
c.Assert(e, IsNil)
|
|
|
|
type myStruct struct {
|
|
|
|
Version string
|
|
|
|
}
|
|
|
|
saveMe := myStruct{"1"}
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err := New(&saveMe)
|
2016-01-15 03:17:24 +01:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(config, Not(IsNil))
|
|
|
|
err = config.Save("test.json")
|
|
|
|
c.Assert(err, Not(IsNil))
|
|
|
|
}
|
|
|
|
|
2015-06-26 04:56:48 +02:00
|
|
|
func (s *MySuite) TestCheckData(c *C) {
|
2017-03-22 18:23:25 +01:00
|
|
|
err := checkData(nil)
|
2015-06-26 04:56:48 +02:00
|
|
|
c.Assert(err, Not(IsNil))
|
|
|
|
|
2016-08-06 19:22:14 +02:00
|
|
|
type myStructBadNoVersion struct {
|
2016-11-10 08:37:12 +01:00
|
|
|
User string
|
|
|
|
Password string
|
|
|
|
Directories []string
|
2015-06-26 04:56:48 +02:00
|
|
|
}
|
2016-08-06 19:22:14 +02:00
|
|
|
saveMeBadNoVersion := myStructBadNoVersion{"guest", "nopassword", []string{"Work", "Documents", "Music"}}
|
2017-03-22 18:23:25 +01:00
|
|
|
err = checkData(&saveMeBadNoVersion)
|
2016-08-06 19:22:14 +02:00
|
|
|
c.Assert(err, Not(IsNil))
|
|
|
|
|
|
|
|
type myStructBadVersionInt struct {
|
|
|
|
Version int
|
|
|
|
User string
|
|
|
|
Password string
|
|
|
|
}
|
|
|
|
saveMeBadVersionInt := myStructBadVersionInt{1, "guest", "nopassword"}
|
2017-03-22 18:23:25 +01:00
|
|
|
err = checkData(&saveMeBadVersionInt)
|
2015-06-26 04:56:48 +02:00
|
|
|
c.Assert(err, Not(IsNil))
|
|
|
|
|
|
|
|
type myStructGood struct {
|
2016-11-10 08:37:12 +01:00
|
|
|
Version string
|
|
|
|
User string
|
|
|
|
Password string
|
|
|
|
Directories []string
|
2015-06-26 04:56:48 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
saveMeGood := myStructGood{"1", "guest", "nopassword", []string{"Work", "Documents", "Music"}}
|
2017-03-22 18:23:25 +01:00
|
|
|
err = checkData(&saveMeGood)
|
2015-06-26 04:56:48 +02:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
}
|
|
|
|
|
2016-08-09 05:56:29 +02:00
|
|
|
func (s *MySuite) TestLoadFile(c *C) {
|
|
|
|
type myStruct struct {
|
2016-11-10 08:37:12 +01:00
|
|
|
Version string
|
|
|
|
User string
|
|
|
|
Password string
|
|
|
|
Directories []string
|
2016-08-09 05:56:29 +02:00
|
|
|
}
|
|
|
|
saveMe := myStruct{}
|
2017-03-22 18:23:25 +01:00
|
|
|
_, err := Load("test.json", &saveMe)
|
2016-08-09 05:56:29 +02:00
|
|
|
c.Assert(err, Not(IsNil))
|
|
|
|
|
|
|
|
file, err := os.Create("test.json")
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(file.Close(), IsNil)
|
2017-03-22 18:23:25 +01:00
|
|
|
_, err = Load("test.json", &saveMe)
|
2016-08-09 05:56:29 +02:00
|
|
|
c.Assert(err, Not(IsNil))
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err := New(&saveMe)
|
2016-08-09 05:56:29 +02:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
err = config.Load("test-non-exist.json")
|
|
|
|
c.Assert(err, Not(IsNil))
|
|
|
|
err = config.Load("test.json")
|
|
|
|
c.Assert(err, Not(IsNil))
|
|
|
|
|
|
|
|
saveMe = myStruct{"1", "guest", "nopassword", []string{"Work", "Documents", "Music"}}
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err = New(&saveMe)
|
2016-08-09 05:56:29 +02:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(config, Not(IsNil))
|
|
|
|
err = config.Save("test.json")
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
saveMe1 := myStruct{}
|
2017-03-22 18:23:25 +01:00
|
|
|
_, err = Load("test.json", &saveMe1)
|
2016-08-09 05:56:29 +02:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(saveMe1, DeepEquals, saveMe)
|
|
|
|
|
|
|
|
saveMe2 := myStruct{}
|
|
|
|
err = json.Unmarshal([]byte(config.String()), &saveMe2)
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(saveMe2, DeepEquals, saveMe1)
|
|
|
|
}
|
|
|
|
|
2017-03-03 19:22:09 +01:00
|
|
|
func (s *MySuite) TestYAMLFormat(c *C) {
|
|
|
|
testYAML := "test.yaml"
|
|
|
|
defer os.RemoveAll(testYAML)
|
|
|
|
|
|
|
|
type myStruct struct {
|
|
|
|
Version string
|
|
|
|
User string
|
|
|
|
Password string
|
|
|
|
Directories []string
|
|
|
|
}
|
|
|
|
|
|
|
|
plainYAML := `version: "1"
|
|
|
|
user: guest
|
|
|
|
password: nopassword
|
|
|
|
directories:
|
|
|
|
- Work
|
|
|
|
- Documents
|
|
|
|
- Music
|
|
|
|
`
|
|
|
|
|
|
|
|
if runtime.GOOS == "windows" {
|
|
|
|
plainYAML = strings.Replace(plainYAML, "\n", "\r\n", -1)
|
|
|
|
}
|
|
|
|
|
|
|
|
saveMe := myStruct{"1", "guest", "nopassword", []string{"Work", "Documents", "Music"}}
|
|
|
|
|
|
|
|
// Save format using
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err := New(&saveMe)
|
2017-03-03 19:22:09 +01:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(config, Not(IsNil))
|
|
|
|
|
|
|
|
err = config.Save(testYAML)
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
|
|
|
|
// Check if the saved structure in actually an YAML format
|
|
|
|
bytes, err := ioutil.ReadFile(testYAML)
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
|
|
|
|
c.Assert(plainYAML, Equals, string(bytes))
|
|
|
|
|
|
|
|
// Check if the loaded data is the same as the saved one
|
|
|
|
loadMe := myStruct{}
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err = New(&loadMe)
|
2017-03-03 19:22:09 +01:00
|
|
|
err = config.Load(testYAML)
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
|
|
|
|
c.Assert(reflect.DeepEqual(saveMe, loadMe), Equals, true)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *MySuite) TestJSONFormat(c *C) {
|
|
|
|
testJSON := "test.json"
|
|
|
|
defer os.RemoveAll(testJSON)
|
|
|
|
|
|
|
|
type myStruct struct {
|
|
|
|
Version string
|
|
|
|
User string
|
|
|
|
Password string
|
|
|
|
Directories []string
|
|
|
|
}
|
|
|
|
|
|
|
|
plainJSON := `{
|
|
|
|
"Version": "1",
|
|
|
|
"User": "guest",
|
|
|
|
"Password": "nopassword",
|
|
|
|
"Directories": [
|
|
|
|
"Work",
|
|
|
|
"Documents",
|
|
|
|
"Music"
|
|
|
|
]
|
|
|
|
}`
|
|
|
|
|
|
|
|
if runtime.GOOS == "windows" {
|
|
|
|
plainJSON = strings.Replace(plainJSON, "\n", "\r\n", -1)
|
|
|
|
}
|
|
|
|
|
|
|
|
saveMe := myStruct{"1", "guest", "nopassword", []string{"Work", "Documents", "Music"}}
|
|
|
|
|
|
|
|
// Save format using
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err := New(&saveMe)
|
2017-03-03 19:22:09 +01:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(config, Not(IsNil))
|
|
|
|
|
|
|
|
err = config.Save(testJSON)
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
|
|
|
|
// Check if the saved structure in actually an JSON format
|
|
|
|
bytes, err := ioutil.ReadFile(testJSON)
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
|
|
|
|
c.Assert(plainJSON, Equals, string(bytes))
|
|
|
|
|
|
|
|
// Check if the loaded data is the same as the saved one
|
|
|
|
loadMe := myStruct{}
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err = New(&loadMe)
|
2017-03-03 19:22:09 +01:00
|
|
|
err = config.Load(testJSON)
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
|
|
|
|
c.Assert(reflect.DeepEqual(saveMe, loadMe), Equals, true)
|
|
|
|
}
|
|
|
|
|
2015-06-26 04:56:48 +02:00
|
|
|
func (s *MySuite) TestSaveLoad(c *C) {
|
|
|
|
defer os.RemoveAll("test.json")
|
|
|
|
type myStruct struct {
|
2016-11-10 08:37:12 +01:00
|
|
|
Version string
|
|
|
|
User string
|
|
|
|
Password string
|
|
|
|
Directories []string
|
2015-06-26 04:56:48 +02:00
|
|
|
}
|
|
|
|
saveMe := myStruct{"1", "guest", "nopassword", []string{"Work", "Documents", "Music"}}
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err := New(&saveMe)
|
2015-06-26 04:56:48 +02:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(config, Not(IsNil))
|
2016-01-15 03:17:24 +01:00
|
|
|
err = config.Save("test.json")
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
|
|
|
|
loadMe := myStruct{Version: "1"}
|
2017-03-22 18:23:25 +01:00
|
|
|
newConfig, err := New(&loadMe)
|
2016-01-15 03:17:24 +01:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(newConfig, Not(IsNil))
|
|
|
|
err = newConfig.Load("test.json")
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
|
|
|
|
c.Assert(config.Data(), DeepEquals, newConfig.Data())
|
|
|
|
c.Assert(config.Data(), DeepEquals, &loadMe)
|
|
|
|
|
|
|
|
mismatch := myStruct{"1.1", "guest", "nopassword", []string{"Work", "Documents", "Music"}}
|
|
|
|
c.Assert(newConfig.Data(), Not(DeepEquals), &mismatch)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *MySuite) TestSaveBackup(c *C) {
|
|
|
|
defer os.RemoveAll("test.json")
|
|
|
|
defer os.RemoveAll("test.json.old")
|
|
|
|
type myStruct struct {
|
2016-11-10 08:37:12 +01:00
|
|
|
Version string
|
|
|
|
User string
|
|
|
|
Password string
|
|
|
|
Directories []string
|
2016-01-15 03:17:24 +01:00
|
|
|
}
|
|
|
|
saveMe := myStruct{"1", "guest", "nopassword", []string{"Work", "Documents", "Music"}}
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err := New(&saveMe)
|
2016-01-15 03:17:24 +01:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(config, Not(IsNil))
|
|
|
|
err = config.Save("test.json")
|
|
|
|
c.Assert(err, IsNil)
|
2015-06-26 04:56:48 +02:00
|
|
|
|
|
|
|
loadMe := myStruct{Version: "1"}
|
2017-03-22 18:23:25 +01:00
|
|
|
newConfig, err := New(&loadMe)
|
2015-06-26 04:56:48 +02:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(newConfig, Not(IsNil))
|
2016-01-15 03:17:24 +01:00
|
|
|
err = newConfig.Load("test.json")
|
|
|
|
c.Assert(err, IsNil)
|
2015-06-26 04:56:48 +02:00
|
|
|
|
|
|
|
c.Assert(config.Data(), DeepEquals, newConfig.Data())
|
|
|
|
c.Assert(config.Data(), DeepEquals, &loadMe)
|
|
|
|
|
|
|
|
mismatch := myStruct{"1.1", "guest", "nopassword", []string{"Work", "Documents", "Music"}}
|
|
|
|
c.Assert(newConfig.Data(), Not(DeepEquals), &mismatch)
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err = New(&mismatch)
|
2016-01-15 03:17:24 +01:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(config, Not(IsNil))
|
|
|
|
err = config.Save("test.json")
|
|
|
|
c.Assert(err, IsNil)
|
2015-06-26 04:56:48 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
func (s *MySuite) TestDiff(c *C) {
|
|
|
|
type myStruct struct {
|
2016-11-10 08:37:12 +01:00
|
|
|
Version string
|
|
|
|
User string
|
|
|
|
Password string
|
|
|
|
Directories []string
|
2015-06-26 04:56:48 +02:00
|
|
|
}
|
|
|
|
saveMe := myStruct{"1", "guest", "nopassword", []string{"Work", "Documents", "Music"}}
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err := New(&saveMe)
|
2015-06-26 04:56:48 +02:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(config, Not(IsNil))
|
|
|
|
|
|
|
|
type myNewStruct struct {
|
|
|
|
Version string
|
|
|
|
// User string
|
2016-11-10 08:37:12 +01:00
|
|
|
Password string
|
|
|
|
Directories []string
|
2015-06-26 04:56:48 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
mismatch := myNewStruct{"1", "nopassword", []string{"Work", "documents", "Music"}}
|
2017-03-22 18:23:25 +01:00
|
|
|
newConfig, err := New(&mismatch)
|
2015-06-26 04:56:48 +02:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(newConfig, Not(IsNil))
|
|
|
|
|
|
|
|
fields, ok := config.Diff(newConfig)
|
|
|
|
c.Assert(ok, IsNil)
|
|
|
|
c.Assert(len(fields), Equals, 1)
|
|
|
|
|
|
|
|
// Uncomment for debugging
|
|
|
|
// for i, field := range fields {
|
|
|
|
// fmt.Printf("Diff[%d]: %s=%v\n", i, field.Name(), field.Value())
|
|
|
|
// }
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *MySuite) TestDeepDiff(c *C) {
|
|
|
|
type myStruct struct {
|
2016-11-10 08:37:12 +01:00
|
|
|
Version string
|
|
|
|
User string
|
|
|
|
Password string
|
|
|
|
Directories []string
|
2015-06-26 04:56:48 +02:00
|
|
|
}
|
|
|
|
saveMe := myStruct{"1", "guest", "nopassword", []string{"Work", "Documents", "Music"}}
|
2017-03-22 18:23:25 +01:00
|
|
|
config, err := New(&saveMe)
|
2015-06-26 04:56:48 +02:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(config, Not(IsNil))
|
|
|
|
|
|
|
|
mismatch := myStruct{"1", "Guest", "nopassword", []string{"Work", "documents", "Music"}}
|
2017-03-22 18:23:25 +01:00
|
|
|
newConfig, err := New(&mismatch)
|
2015-06-26 04:56:48 +02:00
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(newConfig, Not(IsNil))
|
|
|
|
|
|
|
|
fields, err := config.DeepDiff(newConfig)
|
|
|
|
c.Assert(err, IsNil)
|
|
|
|
c.Assert(len(fields), Equals, 2)
|
|
|
|
|
|
|
|
// Uncomment for debugging
|
|
|
|
// for i, field := range fields {
|
|
|
|
// fmt.Printf("DeepDiff[%d]: %s=%v\n", i, field.Name(), field.Value())
|
|
|
|
// }
|
|
|
|
}
|