Merge pull request #16 from netlify/add-netlify-toml

create a toml package

Author: rybit

glide.lock

@@ -21,6 +21,8 @@ import:
   version: v1.0.0
 - package: github.com/streadway/amqp
 - package: gopkg.in/mgo.v2
+- package: github.com/BurntSushi/toml
+  version: v0.3.0
 testImport:
 - package: github.com/nats-io/gnatsd
   version: v0.9.6

glide.yaml

@@ -0,0 +1,110 @@
+package ntoml
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path"
+	"strings"
+
+	"github.com/BurntSushi/toml"
+	"github.com/pkg/errors"
+)
+
+const DefaultFilename = "netlify.toml"
+
+type NetlifyToml struct {
+	Settings Settings `toml:"settings"`
+
+	Redirects []Redirect `toml:"redirects, omitempty"`
+
+	// this is the default context
+	Build   *BuildConfig             `toml:"build"`
+	Context map[string]DeployContext `toml:"context, omitempty"`
+}
+
+type Settings struct {
+	ID   string `toml:"id"`
+	Path string `toml:"path"`
+}
+
+type BuildConfig struct {
+	Command     string            `toml:"command"`
+	Base        string            `toml:"base"`
+	Publish     string            `toml:"publish"`
+	Environment map[string]string `toml:"environment"`
+}
+
+type DeployContext struct {
+	BuildConfig
+}
+
+type Redirect struct {
+	Origin      string             `toml:"origin"`
+	Destination string             `toml:"destination"`
+	Parmeters   map[string]string  `toml:"parameters"`
+	Status      int                `toml:"status"`
+	Force       bool               `toml:"force"`
+	Conditions  *RedirectCondition `toml:"conditions"`
+	Headers     map[string]string  `toml:"headers"`
+}
+
+type RedirectCondition struct {
+	Language []string `toml:"language"`
+	Country  []string `toml:"country"`
+	Role     []string `toml:"role"`
+}
+
+func Load() (*NetlifyToml, error) {
+	wd, err := os.Getwd()
+	if err != nil {
+		return nil, err
+	}
+	return LoadFrom(path.Join(wd, DefaultFilename))
+}
+
+func LoadFrom(paths ...string) (*NetlifyToml, error) {
+	if len(paths) == 0 {
+		return nil, errors.New("No paths specified")
+	}
+
+	out := new(NetlifyToml)
+
+	for _, p := range paths {
+		if data, ferr := ioutil.ReadFile(p); !os.IsNotExist(ferr) {
+			if ferr != nil {
+				return nil, errors.Wrapf(ferr, "Error while reading in file %s.", p)
+			}
+
+			if _, derr := toml.Decode(string(data), out); derr != nil {
+				return nil, errors.Wrapf(derr, "Error while decoding file %s", p)
+			}
+
+			return out, nil
+		}
+	}
+	return nil, fmt.Errorf("Failed to find toml file in %s", strings.Join(paths, ","))
+}
+
+func Save(conf *NetlifyToml) error {
+	wd, err := os.Getwd()
+	if err != nil {
+		return err
+	}
+	return SaveTo(conf, path.Join(wd, DefaultFilename))
+}
+
+func SaveTo(conf *NetlifyToml, path string) error {
+	f, err := os.OpenFile(path, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0644)
+	if err != nil {
+		return errors.Wrapf(err, "Failed to open file %s", path)
+	}
+
+	defer f.Close()
+
+	if err := toml.NewEncoder(f).Encode(conf); err != nil {
+		return errors.Wrap(err, "Failed to encode the toml file")
+	}
+
+	return nil
+}

ntoml/netlify_toml.go

@@ -0,0 +1,94 @@
+package ntoml
+
+import (
+	"io/ioutil"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestLoadingExample(t *testing.T) {
+	tmp := testToml(t)
+	defer os.Remove(t.Name())
+
+	conf, err := LoadFrom(tmp.Name())
+	require.NoError(t, err)
+
+	expected := &NetlifyToml{
+		Settings: Settings{
+			ID:   "this-is-a-site",
+			Path: ".",
+		},
+		Redirects: []Redirect{
+			{Origin: "/other", Destination: "/otherpage.html", Force: true},
+		},
+		Build: &BuildConfig{
+			Command: "echo 'not a thing'",
+		},
+		Context: map[string]DeployContext{
+			"deploy-preview": {BuildConfig{
+				Command: "hugo version && npm run build-preview",
+			}},
+			"branch-deploy": {BuildConfig{
+				Command:     "hugo version && npm run build-branch",
+				Environment: map[string]string{"HUGO_VERSION": "0.20.5"},
+			}},
+		},
+	}
+
+	assert.Equal(t, expected, conf)
+}
+
+func TestSaveTomlFile(t *testing.T) {
+	conf := &NetlifyToml{
+		Settings: Settings{ID: "This is something", Path: "/dist"},
+	}
+
+	tmp, err := ioutil.TempFile("", "netlify-ctl")
+	require.NoError(t, err)
+
+	require.NoError(t, SaveTo(conf, tmp.Name()))
+
+	data, err := ioutil.ReadFile(tmp.Name())
+	require.NoError(t, err)
+
+	expected := "[settings]\n" +
+		"  id = \"This is something\"\n" +
+		"  path = \"/dist\"\n"
+
+	assert.Equal(t, expected, string(data))
+}
+
+func testToml(t *testing.T) *os.File {
+	tmp, err := ioutil.TempFile("", "netlify-ctl")
+	require.NoError(t, err)
+
+	data := `
+[Settings]
+  id = "this-is-a-site"
+  path = "."
+
+[build]
+	command = "echo 'not a thing'"
+
+[[redirects]]
+  origin = "/other"
+	force = true
+  destination = "/otherpage.html"
+
+  [context.deploy-preview]
+  command = "hugo version && npm run build-preview"
+
+
+[context.branch-deploy]
+  command = "hugo version && npm run build-branch"
+
+  [context.branch-deploy.environment]
+    HUGO_VERSION = "0.20.5"
+`
+	require.NoError(t, ioutil.WriteFile(tmp.Name(), []byte(data), 0664))
+
+	return tmp
+}