psiphon-tunnel-core/psiphon/config_test.go

/*
 * Copyright (c) 2014, Psiphon Inc.
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package psiphon

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

	"github.com/stretchr/testify/suite"
)

const (
	_README              = "../README.md"
	_README_CONFIG_BEGIN = "<!--BEGIN-SAMPLE-CONFIG-->"
	_README_CONFIG_END   = "<!--END-SAMPLE-CONFIG-->"
)

type ConfigTestSuite struct {
	suite.Suite
	confStubBlob      []byte
	requiredFields    []string
	nonRequiredFields []string
}

func (suite *ConfigTestSuite) SetupSuite() {
	readmeBlob, _ := ioutil.ReadFile(_README)
	readmeString := string(readmeBlob)
	readmeString = readmeString[strings.Index(readmeString, _README_CONFIG_BEGIN)+len(_README_CONFIG_BEGIN) : strings.Index(readmeString, _README_CONFIG_END)]
	readmeString = strings.TrimSpace(readmeString)
	readmeString = strings.Trim(readmeString, "`")

	suite.confStubBlob = []byte(readmeString)

	var obj map[string]interface{}
	json.Unmarshal(suite.confStubBlob, &obj)
	for k, v := range obj {
		if v == "<placeholder>" {
			suite.requiredFields = append(suite.requiredFields, k)
		} else {
			suite.nonRequiredFields = append(suite.nonRequiredFields, k)
		}
	}
}

func TestConfigTestSuite(t *testing.T) {
	suite.Run(t, new(ConfigTestSuite))
}

// Tests good config
func (suite *ConfigTestSuite) Test_LoadConfig_BasicGood() {
	_, err := LoadConfig(suite.confStubBlob)
	suite.Nil(err, "a basic config should succeed")
}

// Tests non-JSON file contents
func (suite *ConfigTestSuite) Test_LoadConfig_BadFileContents() {
	_, err := LoadConfig([]byte(`this is not JSON`))
	suite.NotNil(err, "bytes that are not JSON at all should give an error")
}

// Tests config file with JSON contents that don't match our structure
func (suite *ConfigTestSuite) Test_LoadConfig_BadJson() {
	var testObj map[string]interface{}
	var testObjJSON []byte

	// JSON with none of our fields
	_, err := LoadConfig([]byte(`{"f1": 11, "f2": "two"}`))
	suite.NotNil(err, "JSON with none of our fields should fail")

	// Missing a required field
	json.Unmarshal(suite.confStubBlob, &testObj)
	delete(testObj, suite.requiredFields[0])
	testObjJSON, _ = json.Marshal(testObj)
	_, err = LoadConfig(testObjJSON)
	suite.NotNil(err, "JSON with one of our required fields missing should fail")

	// Bad type for required field
	json.Unmarshal(suite.confStubBlob, &testObj)
	testObj[suite.requiredFields[0]] = false // basically guessing a wrong type
	testObjJSON, _ = json.Marshal(testObj)
	_, err = LoadConfig(testObjJSON)
	suite.NotNil(err, "JSON with one of our required fields with the wrong type should fail")

	// One of our required fields is null
	json.Unmarshal(suite.confStubBlob, &testObj)
	testObj[suite.requiredFields[0]] = nil
	testObjJSON, _ = json.Marshal(testObj)
	_, err = LoadConfig(testObjJSON)
	suite.NotNil(err, "JSON with one of our required fields set to null should fail")

	// One of our required fields is an empty string
	json.Unmarshal(suite.confStubBlob, &testObj)
	testObj[suite.requiredFields[0]] = ""
	testObjJSON, _ = json.Marshal(testObj)
	_, err = LoadConfig(testObjJSON)
	suite.NotNil(err, "JSON with one of our required fields set to an empty string should fail")

	// Has incorrect type for optional field
	json.Unmarshal(suite.confStubBlob, &testObj)
	testObj[suite.nonRequiredFields[0]] = false // basically guessing a wrong type
	testObjJSON, _ = json.Marshal(testObj)
	_, err = LoadConfig(testObjJSON)
	suite.NotNil(err, "JSON with one of our optional fields with the wrong type should fail")
}

// Tests config file with JSON contents that don't match our structure
func (suite *ConfigTestSuite) Test_LoadConfig_GoodJson() {
	var testObj map[string]interface{}
	var testObjJSON []byte

	// TODO: Test that the config actually gets the values we expect?

	// Has all of our required fields, but no optional fields
	json.Unmarshal(suite.confStubBlob, &testObj)
	for i := range suite.nonRequiredFields {
		delete(testObj, suite.nonRequiredFields[i])
	}
	testObjJSON, _ = json.Marshal(testObj)
	_, err := LoadConfig(testObjJSON)
	suite.Nil(err, "JSON with good values for our required fields but no optional fields should succeed")

	// Has all of our required fields, and all optional fields
	_, err = LoadConfig(suite.confStubBlob)
	suite.Nil(err, "JSON with all good values for required and optional fields should succeed")

	// Has null for optional fields
	json.Unmarshal(suite.confStubBlob, &testObj)
	for i := range suite.nonRequiredFields {
		testObj[suite.nonRequiredFields[i]] = nil
	}
	testObjJSON, _ = json.Marshal(testObj)
	_, err = LoadConfig(testObjJSON)
	suite.Nil(err, "JSON with null for optional values should succeed")
}