Refactoring and add variable expansion for config file with text/template (#13)

Author: xor-gate

Makefile

@@ -1,9 +1,14 @@
+export CGO_ENABLED=0
 export GOPATH?=$(PWD)/../../../../
 export DESTDIR?=$(GOPATH)/bin
 export GOBIN?=$(DESTDIR)
 
 all: build
-ci: test
+ci: env test
+
+env:
+	go env
+	echo "---"
 
 dep:
 	go get -u ./

config.go

@@ -7,57 +7,26 @@ package debpkg
 import (
 	"fmt"
 	"io/ioutil"
-	"runtime"
-
-	yaml "gopkg.in/yaml.v2"
+	"github.com/xor-gate/debpkg/internal/config"
 )
 
-type debPkgSpecFileCfg struct {
-	Name            string `yaml:"name"`
-	Version         string `yaml:"version"`
-	Architecture    string `yaml:"architecture"`
-	Maintainer      string `yaml:"maintainer"`
-	MaintainerEmail string `yaml:"maintainer_email"`
-	Homepage        string `yaml:"homepage"`
-	Section         string `yaml:"section"`
-	Priority        string `yaml:"priority"`
-	BuiltUsing      string `yaml:"built_using"`
-	Description     struct {
-		Short string `yaml:"short"`
-		Long  string `yaml:"long"`
-	}
-	Files []struct {
-		Src  string `yaml:"file"`
-		Dest string `yaml:"dest"`
-	} `yaml:",flow"`
-	Directories      []string `yaml:",flow"`
-	EmptyDirectories []string `yaml:"emptydirs,flow"`
-}
-
 // Config loads settings from a depkg.yml specfile
 func (deb *DebPkg) Config(filename string) error {
-	cfg := debPkgSpecFileCfg{
-		Name:            "unknown",
-		Version:         "0.1.0+dev",
-		Architecture:    "any",
-		Maintainer:      "anonymous",
-		MaintainerEmail: "anon@foo.bar",
-		Homepage:        "https://www.google.com",
-		Section:         "misc",
-		Priority:        string(PriorityOptional),
-		BuiltUsing:      runtime.Version(),
+	data, err := ioutil.ReadFile(filename)
+	if err != nil {
+		return fmt.Errorf("problem reading config file: %v", err)
 	}
-	cfg.Description.Long = "-"
-	cfg.Description.Short = "-"
 
-	cfgFile, err := ioutil.ReadFile(filename)
+	dataExpanded, err := ExpandVar(string(data))
 	if err != nil {
-		return fmt.Errorf("problem reading config file: %v", err)
+		return err
 	}
-	err = yaml.Unmarshal(cfgFile, &cfg)
+
+	cfg, err := config.PkgSpecFileUnmarshal([]byte(dataExpanded))
 	if err != nil {
-		return fmt.Errorf("problem unmarshaling config file: %v", err)
+		return err
 	}
+
 	deb.SetSection(cfg.Section)
 	deb.SetPriority(Priority(cfg.Priority))
 	deb.SetName(cfg.Name)

config_test.go

@@ -5,27 +5,54 @@
 package debpkg
 
 import (
-	"io/ioutil"
 	"runtime"
 	"testing"
-
+	"github.com/xor-gate/debpkg/internal/test"
 	"github.com/stretchr/testify/assert"
 )
 
 // TestExampleConfig verifies if the config example in the root is correctly loaded
 func TestExampleConfig(t *testing.T) {
+	const configFile = `name: debpkg
+version: 7.6.5
+architecture: all
+maintainer: Deb Pkg
+maintainer_email: deb@pkg.com
+homepage: https://github.com/xor-gate/debpkg
+section: devel
+priority: standard
+built_using: golang
+description:
+   short: This is a short description
+   long: >
+       Bla bla
+       Bla Bla
+       .
+       Dusse
+files:
+  - file: LICENSE
+    dest: {{.DATAROOTDIR}}/foobar/LICENSE
+  - file: debpkg.go
+  - file: debpkg_test.go
+  - file: README.md
+    dest: {{.DATAROOTDIR}}/foobar/README.md
+directories:
+  - ./internal
+emptydirs:
+  - /var/cache/foobar
+`
+	filepath, err := test.WriteTempFile("debpkg.yml", configFile)
+	assert.Nil(t, err)
+
 	deb := New()
 	defer deb.Close()
 
-	err := deb.Config("debpkg.yml")
-	if err != nil {
-		t.Errorf("debpkg.yml error: %v", err)
-	}
+	assert.Nil(t, deb.Config(filepath))
 	assert.Equal(t, "7.6.5", deb.control.info.version.full,
 		"Unexpected deb.control.info.version.full")
-	assert.Equal(t, "Foo Bar", deb.control.info.maintainer,
+	assert.Equal(t, "Deb Pkg", deb.control.info.maintainer,
 		"Unexpected deb.control.info.maintainer")
-	assert.Equal(t, "foo@bar.com", deb.control.info.maintainerEmail,
+	assert.Equal(t, "deb@pkg.com", deb.control.info.maintainerEmail,
 		"Unexpected deb.control.info.maintainerEmail")
 	assert.Equal(t, "https://github.com/xor-gate/debpkg", deb.control.info.homepage,
 		"Unexpected deb.control.info.homepage")
@@ -37,20 +64,19 @@ func TestExampleConfig(t *testing.T) {
 		"unexpected section")
 	assert.Equal(t, PriorityStandard, deb.control.info.priority,
 		"unexpected priority")
+
+	assert.Nil(t, testWrite(t, deb))
 }
 
 func TestDefaultConfig(t *testing.T) {
-	f, err := ioutil.TempFile("", "config")
-	if err != nil {
-		t.Errorf("unexpected error creating tempfile: %v", err)
-	}
-	f.Close()
+	filepath, err := test.WriteTempFile("emptyfile.yml", "")
+	assert.Nil(t, err)
+
 	deb := New()
 	defer deb.Close()
 
-	if err := deb.Config(f.Name()); err != nil {
-		t.Errorf("Unexpected error during load of empty config: %v", err)
-	}
+	assert.Nil(t, deb.Config(filepath))
+
 	assert.Equal(t, "any", deb.control.info.architecture,
 		"unexpected architecture")
 	assert.Equal(t, "anonymous", deb.control.info.maintainer,
@@ -79,6 +105,5 @@ func TestNonExistingConfig(t *testing.T) {
 	deb := New()
 	defer deb.Close()
 
-	err := deb.Config("/non/existant/config/file")
-	assert.Error(t, err, "error expected")
+	assert.NotNil(t, deb.Config("/non/existant/config/file"))
 }

constants.go

@@ -31,5 +31,14 @@ const (
 	VcsTypeSubversion VcsType = "Svn"   // Subversion
 )
 
-const debianBinaryVersion = "2.0\n"
-const debianFileExtension = "deb"
+const (
+	DefaultInstallPrefix = "/usr"
+	DefaultBinDir        = "bin"
+	DefaultSbinDir       = "sbin"
+	DefaultSysConfDir    = "etc"
+	DefaultDataRootDir   = "share"
+)
+
+const debianPathSeparator  = "/"
+const debianBinaryVersion  = "2.0\n"
+const debianFileExtension  = "deb"

control_test.go

@@ -5,8 +5,6 @@
 package debpkg
 
 import (
-	"os"
-	"io/ioutil"
 	"testing"
 	"github.com/xor-gate/debpkg/internal/test"
 	"github.com/stretchr/testify/assert"
@@ -204,8 +202,9 @@ func TestControlFileExtra(t *testing.T) {
 	const script = `#!/bin/sh
 echo "hello world from debpkg"
 `
-	filename := test.TempDir() + string(os.PathSeparator) + t.Name() + ".sh"
-	assert.Nil(t, ioutil.WriteFile(filename, []byte(script), 0644))
+
+	filepath, err := test.WriteTempFile(t.Name() + ".sh", script)
+	assert.Nil(t, err)
 
 	deb.SetName("debpkg-control-file-extra")
 	deb.SetArchitecture("all")
@@ -216,9 +215,13 @@ echo "hello world from debpkg"
 	// parsing file '/var/lib/dpkg/tmp.ci/control' near line 6 package 'debpkg-control-file-extra:any':
 	// end of file during value of field 'Description' (missing final newline)
 
-	deb.AddControlExtra("preinst", filename)
-	deb.AddControlExtra("postinst", filename)
-	deb.AddControlExtraString("prerm", filename)
-	deb.AddControlExtraString("postrm", filename)
+	deb.AddControlExtra("preinst", filepath)
+	deb.AddControlExtra("postinst", filepath)
+	deb.AddControlExtra("prerm", filepath)
+	deb.AddControlExtra("postrm", filepath)
+
+	// FIXME AddControlExtra seems to add the full TMPDIR directory inside the control.tar.gz
+	// E.g on mac var/folders/s5/x8wc0jqd387_sg4py6tg6xq00000gn/T/debpkg-test921120249
+
 	assert.Nil(t, testWrite(t, deb))
 }

data.go

@@ -10,7 +10,7 @@ import (
 	"io"
 	"os"
 	"strings"
-
+	"path/filepath"
 	"github.com/xor-gate/debpkg/internal/targzip"
 )
 
@@ -21,11 +21,16 @@ type data struct {
 }
 
 func (d *data) addDirectory(dirpath string) error {
+	dirpath = filepath.Clean(dirpath)
 	for _, addedDir := range d.dirs {
 		if addedDir == dirpath {
 			return nil
 		}
 	}
+	if dirpath == "." {
+		return nil
+	}
+
 	if err := d.tgz.AddDirectory(dirpath); err != nil {
 		return err
 	}
@@ -49,7 +54,35 @@ func (d *data) addEmptyDirectory(dir string) error {
 	return nil
 }
 
+func (d *data) addDirectoriesForFile(filename string) {
+	dirname := filepath.Dir(filename)
+	if dirname != "." {
+		if os.PathSeparator != '/' {
+			dirname = strings.Replace(dirname, string(os.PathSeparator), "/", -1)
+		}
+		dirs := strings.Split(dirname, "/")
+		var current string
+		for _, dir := range dirs {
+			if len(dir) > 0 {
+				current += dir + "/"
+				d.addDirectory(current)
+			}
+		}
+	}
+}
+
 func (d *data) addFile(filename string, dest ...string) error {
+	var destfilename string
+
+	if len(dest) > 0 && len(dest[0]) > 0 {
+		destfilename = dest[0]
+	} else {
+		destfilename = filename
+	}
+
+	d.addDirectoriesForFile(destfilename)
+
+	// 
 	if err := d.tgz.AddFile(filename, dest...); err != nil {
 		return err
 	}