Merge pull request #4 from luizvnasc/enhancement/xml

Enhancement/xml

README.md

@@ -13,7 +13,7 @@ A simple module to load configurations file to a struct.
 | Extension | is supported?     |
 |:---------:|:-----------------:|
 | .json     |:heavy_check_mark: |
-| .xml      |:x:                |
+| .xml      |:heavy_check_mark: |
 | .yaml     |:x:                |
 | .toml     |:x:                |
 

error.go

@@ -1,8 +1,10 @@
 package gonfig
 
 const (
-	//LoadError = "Error loading the configuration"
+	// LoadError = "Error loading the configuration"
 	LoadError = GonfigError("Error loading the configuration")
+	// UnsupportedFileError = "Unsupported file extension"
+	UnsupportedFileError = GonfigError("Unsupported file extension")
 )
 
 // GonfigError is an error in the module.

examples/xml/config.xml

@@ -0,0 +1,5 @@
+<config>
+    <version>1.0.0</version>
+    <description>A xml exemple</description>
+    <redis host="127.0.0.1" port="6379"/>
+</config>

examples/xml/main.go

@@ -0,0 +1,23 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/luizvnasc/gonfig"
+)
+
+//Config struct to store the app configuration
+type Config struct {
+	Version     string `xml:"version"`
+	Description string `xml:"description"`
+	Redis       struct {
+		Host string `xml:"host,attr"`
+		Port uint   `xml:"port,attr"`
+	} `xml:"redis"`
+}
+
+func main() {
+	var config Config
+	gonfig.Load("config.xml", &config)
+	fmt.Printf("%v", config)
+}

gonfig.go

@@ -2,27 +2,41 @@ package gonfig
 
 import (
 	"encoding/json"
+	"encoding/xml"
 	"io/ioutil"
 	"os"
+	"path/filepath"
 )
 
-const (
-	typeJSON = "json"
-)
+type unmarshalerFunc func(data []byte, v interface{}) error
 
+// Load a struct with the configuration from a config file.
 func Load(path string, config interface{}) error {
 	configFile, err := os.Open(path)
 	if err != nil {
 		config = nil
 		return LoadError
 	}
+	defer configFile.Close()
 
 	b, err := ioutil.ReadAll(configFile)
 	if err != nil {
 		config = nil
 		return LoadError
 	}
-	err = json.Unmarshal(b, &config)
+
+	ext := filepath.Ext(path)
+
+	var unmarshaler unmarshalerFunc
+	switch ext {
+	case ".json":
+		unmarshaler = json.Unmarshal
+	case ".xml":
+		unmarshaler = xml.Unmarshal
+	default:
+		return UnsupportedFileError
+	}
+	err = unmarshaler(b, &config)
 	if err != nil {
 		config = nil
 		return LoadError

gonfig_test.go

@@ -11,17 +11,20 @@ import (
 )
 
 const (
-	validJsonFile       = "config.json"
-	invalidJsonFile     = "invalid.json"
-	invalidJsonBodyFile = "invalid_config.json"
+	validJsonFile       = "./test/config.json"
+	invalidJsonFile     = "./test/invalid.json"
+	invalidJsonBodyFile = "./test/invalid_config.json"
+	validXMLFile        = "./test/config.xml"
+	invalidXMLFile      = "./test/invalid.xml"
+	invalidXMLBodyFile  = "./test/invalid_config.xml"
 )
 
 type SomeConfiguration struct {
 	Version     string `json:"version" xml:"version"`
-	ProjectName string `json:"project_name" xml:"project_name"`
+	ProjectName string `json:"project_name" xml:"project-name"`
 }
 
-var configJSON SomeConfiguration
+var configValid SomeConfiguration
 
 func init() {
 	file, err := os.Open(validJsonFile)
@@ -32,7 +35,7 @@ func init() {
 	if err != nil {
 		panic("Error Loading teste sample")
 	}
-	json.Unmarshal(b, &configJSON)
+	json.Unmarshal(b, &configValid)
 }
 func TestLoadJSON(t *testing.T) {
 	config := SomeConfiguration{}
@@ -42,12 +45,12 @@ func TestLoadJSON(t *testing.T) {
 		if err != nil {
 			t.Errorf("Error loading the configuration: %v", err)
 		}
-		if !reflect.DeepEqual(config, configJSON) {
-			t.Errorf("Error loading the configuration: expected %v, got %v", configJSON, config)
+		if !reflect.DeepEqual(config, configValid) {
+			t.Errorf("Error loading the configuration: expected %v, got %v", configValid, config)
 		}
 	})
 
-	t.Run("Load a configuration from a invalid json file", func(t *testing.T) {
+	t.Run("Load a configuration from an invalid json file", func(t *testing.T) {
 		err := gonfig.Load(invalidJsonFile, &config)
 		if err == nil {
 			t.Errorf("It was expected to get an error. Got nil")
@@ -57,8 +60,31 @@ func TestLoadJSON(t *testing.T) {
 		}
 	})
 
-	t.Run("Load a configuration from a invalid json body", func(t *testing.T) {
-		err := gonfig.Load(invalidJsonFile, &config)
+	t.Run("Load a configuration from an invalid json body", func(t *testing.T) {
+		err := gonfig.Load(invalidJsonBodyFile, &config)
+		if err == nil {
+			t.Errorf("It was expected to get an error. Got nil")
+		}
+		if err != gonfig.LoadError {
+			t.Errorf("Expected the error %v, got %v", gonfig.LoadError, err)
+		}
+	})
+}
+
+func TestLoadXML(t *testing.T) {
+	config := SomeConfiguration{}
+
+	t.Run("Load a configuration from a valid xml file", func(t *testing.T) {
+		err := gonfig.Load(validXMLFile, &config)
+		if err != nil {
+			t.Errorf("Error loading the configuration: %v", err)
+		}
+		if !reflect.DeepEqual(config, configValid) {
+			t.Errorf("Error loading the configuration: expected %v, got %v", configValid, config)
+		}
+	})
+	t.Run("Load a configuration from an invalid json file", func(t *testing.T) {
+		err := gonfig.Load(invalidXMLFile, &config)
 		if err == nil {
 			t.Errorf("It was expected to get an error. Got nil")
 		}
@@ -67,4 +93,13 @@ func TestLoadJSON(t *testing.T) {
 		}
 	})
 
+	t.Run("Load a configuration from an invalid json body", func(t *testing.T) {
+		err := gonfig.Load(invalidXMLBodyFile, &config)
+		if err == nil {
+			t.Errorf("It was expected to get an error. Got nil")
+		}
+		if err != gonfig.LoadError {
+			t.Errorf("Expected the error %v, got %v", gonfig.LoadError, err)
+		}
+	})
 }

test/config.xml

@@ -0,0 +1,4 @@
+<config>
+    <version>1.0.0</version>
+    <project-name>gonfig</project-name>
+</config>

test/invalid_config.xml

@@ -0,0 +1,4 @@
+<config>
+    <version>1.0.0</version>
+    <project-name>gonfig</project-name>
+</config2>