Consolidate config related functionality into the config package

config/advanced.go

@@ -1,7 +0,0 @@
-package config
-
-// Advanced settings
-type Advanced struct {
-	IncludeCountry    bool `json:"include_country"`
-	UseDomainFronting bool `json:"use_domain_fronting"`
-}

config/automated_testing.go

@@ -1,8 +0,0 @@
-package config
-
-// AutomatedTesting settings
-type AutomatedTesting struct {
-	Enabled          bool     `json:"enabled"`
-	EnabledTests     []string `json:"enabled_tests"`
-	MonthlyAllowance string   `json:"monthly_allowance"`
-}

config/notifications.go

@@ -1,8 +0,0 @@
-package config
-
-// Notifications settings
-type Notifications struct {
-	Enabled                bool `json:"enabled"`
-	NotifyOnTestCompletion bool `json:"notify_on_test_completion"`
-	NotifyOnNews           bool `json:"notify_on_news"`
-}

config/parser.go

@@ -0,0 +1,119 @@
+package config
+
+import (
+	"encoding/json"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"sync"
+
+	"github.com/ooni/probe-cli/utils"
+	"github.com/pkg/errors"
+)
+
+// ReadConfig reads the configuration from the path
+func ReadConfig(path string) (*Config, error) {
+	b, err := ioutil.ReadFile(path)
+
+	if os.IsNotExist(err) {
+		c := &Config{}
+
+		if err = c.Default(); err != nil {
+			return nil, errors.Wrap(err, "defaulting")
+		}
+
+		if err = c.Validate(); err != nil {
+			return nil, errors.Wrap(err, "validating")
+		}
+
+		return c, nil
+	}
+
+	if err != nil {
+		return nil, errors.Wrap(err, "reading file")
+	}
+
+	c, err := ParseConfig(b)
+	if err != nil {
+		return nil, errors.Wrap(err, "parsing config")
+	}
+	c.path = path
+	return c, err
+}
+
+// ParseConfig returns config from JSON bytes.
+func ParseConfig(b []byte) (*Config, error) {
+	c := &Config{}
+
+	if err := json.Unmarshal(b, c); err != nil {
+		return nil, errors.Wrap(err, "parsing json")
+	}
+
+	if err := c.Default(); err != nil {
+		return nil, errors.Wrap(err, "defaulting")
+	}
+
+	if err := c.Validate(); err != nil {
+		return nil, errors.Wrap(err, "validating")
+	}
+
+	return c, nil
+}
+
+// Config for the OONI Probe installation
+type Config struct {
+	// Private settings
+	Comment         string `json:"_"`
+	Version         int64  `json:"_version"`
+	InformedConsent bool   `json:"_informed_consent"`
+
+	AutoUpdate       bool             `json:"auto_update"`
+	Sharing          Sharing          `json:"sharing"`
+	Notifications    Notifications    `json:"notifications"`
+	AutomatedTesting AutomatedTesting `json:"automated_testing"`
+	NettestGroups    NettestGroups    `json:"test_settings"`
+	Advanced         Advanced         `json:"advanced"`
+
+	mutex sync.Mutex
+	path  string
+}
+
+// Write the config file in json to the path
+func (c *Config) Write() error {
+	c.Lock()
+	configJSON, _ := json.MarshalIndent(c, "", "  ")
+	if c.path == "" {
+		return errors.New("config file path is empty")
+	}
+	if err := ioutil.WriteFile(c.path, configJSON, 0644); err != nil {
+		return errors.Wrap(err, "writing config JSON")
+	}
+	c.Unlock()
+	return nil
+}
+
+// Lock acquires the write mutex
+func (c *Config) Lock() {
+	c.mutex.Lock()
+}
+
+// Unlock releases the write mutex
+func (c *Config) Unlock() {
+	c.mutex.Unlock()
+}
+
+// Default config settings
+func (c *Config) Default() error {
+	home, err := utils.GetOONIHome()
+	if err != nil {
+		return err
+	}
+
+	c.path = filepath.Join(home, "config.json")
+	return nil
+}
+
+// Validate the config file
+func (c *Config) Validate() error {
+	return nil
+}

config/settings.go

@@ -82,11 +82,10 @@ func (s *InstantMessaging) NettestConfigs() []NettestConfig {
 
 // Performance nettest group
 type Performance struct {
-	EnabledTests   []string `json:"enabled_tests"`
-	NDTServer      string   `json:"ndt_server"`
-	NDTServerPort  string   `json:"ndt_server_port"`
-	DashServer     string   `json:"dash_server"`
-	DashServerPort string   `json:"dash_server_port"`
+	NDTServer      string `json:"ndt_server"`
+	NDTServerPort  string `json:"ndt_server_port"`
+	DashServer     string `json:"dash_server"`
+	DashServerPort string `json:"dash_server_port"`
 }
 
 // Middlebox nettest group
@@ -101,3 +100,32 @@ type NettestGroups struct {
 	Performance      Performance      `json:"performance"`
 	Middlebox        Middlebox        `json:"middlebox"`
 }
+
+// Notifications settings
+type Notifications struct {
+	Enabled                bool `json:"enabled"`
+	NotifyOnTestCompletion bool `json:"notify_on_test_completion"`
+	NotifyOnNews           bool `json:"notify_on_news"`
+}
+
+// Sharing settings
+type Sharing struct {
+	IncludeIP        bool `json:"include_ip"`
+	IncludeASN       bool `json:"include_asn"`
+	IncludeGPS       bool `json:"include_gps"`
+	UploadResults    bool `json:"upload_results"`
+	SendCrashReports bool `json:"send_crash_reports"`
+}
+
+// Advanced settings
+type Advanced struct {
+	IncludeCountry    bool `json:"include_country"`
+	UseDomainFronting bool `json:"use_domain_fronting"`
+}
+
+// AutomatedTesting settings
+type AutomatedTesting struct {
+	Enabled          bool     `json:"enabled"`
+	EnabledTests     []string `json:"enabled_tests"`
+	MonthlyAllowance string   `json:"monthly_allowance"`
+}

config/sharing.go

@@ -1,10 +0,0 @@
-package config
-
-// Sharing settings
-type Sharing struct {
-	IncludeIP        bool `json:"include_ip"`
-	IncludeASN       bool `json:"include_asn"`
-	IncludeGPS       bool `json:"include_gps"`
-	UploadResults    bool `json:"upload_results"`
-	SendCrashReports bool `json:"send_crash_reports"`
-}