Fix all goreportcard warnings

Author: xor-gate

config.go

@@ -6,8 +6,8 @@ package debpkg
 
 import (
 	"fmt"
-	"io/ioutil"
 	"github.com/xor-gate/debpkg/internal/config"
+	"io/ioutil"
 )
 
 // Config loads settings from a depkg.yml specfile

config_test.go

@@ -5,10 +5,10 @@
 package debpkg
 
 import (
+	"github.com/stretchr/testify/assert"
+	"github.com/xor-gate/debpkg/internal/test"
 	"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
@@ -105,5 +105,5 @@ func TestNonExistingConfig(t *testing.T) {
 	deb := New()
 	defer deb.Close()
 
-	assert.NotNil(t, deb.Config("/non/existant/config/file"))
+	assert.NotNil(t, deb.Config("/non/existent/config/file"))
 }

constants.go

@@ -31,14 +31,15 @@ const (
 	VcsTypeSubversion VcsType = "Svn"   // Subversion
 )
 
+// Default installation variables
 const (
-	DefaultInstallPrefix = "/usr"
-	DefaultBinDir        = "bin"
-	DefaultSbinDir       = "sbin"
-	DefaultSysConfDir    = "etc"
-	DefaultDataRootDir   = "share"
+	DefaultInstallPrefix = "/usr"  // Default install Prefix
+	DefaultBinDir        = "bin"   // Default binary directory
+	DefaultSbinDir       = "sbin"  // Default sbin directory
+	DefaultSysConfDir    = "etc"   // Default configuration directory
+	DefaultDataRootDir   = "share" // Default data root directory
 )
 
-const debianPathSeparator  = "/"
-const debianBinaryVersion  = "2.0\n"
-const debianFileExtension  = "deb"
+const debianPathSeparator = "/"
+const debianBinaryVersion = "2.0\n"
+const debianFileExtension = "deb"

control.go

@@ -5,8 +5,8 @@
 package debpkg
 
 import (
-	"io"
 	"fmt"
+	"io"
 	"math"
 	"strings"
 
@@ -193,14 +193,14 @@ func (deb *DebPkg) SetBuiltUsing(info string) {
 
 // AddControlExtraString is the same as AddControlExtra except it uses a string input
 func (deb *DebPkg) AddControlExtraString(name, s string) error {
-	return deb.control.tgz.AddFileFromBuffer(name, []byte(s));
+	return deb.control.tgz.AddFileFromBuffer(name, []byte(s))
 }
 
 // AddControlExtra allows the advanced user to add custom script to the control.tar.gz Typical usage is
 //  for preinst, postinst, postrm, prerm: https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html
 // And: https://www.debian.org/doc/manuals/maint-guide/dother.en.html#maintscripts
 func (deb *DebPkg) AddControlExtra(name, filename string) error {
-	return deb.control.tgz.AddFile(filename, name);
+	return deb.control.tgz.AddFile(filename, name)
 }
 
 // AddConffile adds a file to the conffiles so it is treated as configuration files. Configuration files are not
@@ -236,9 +236,9 @@ func (c *control) version() string {
 		return c.info.version.full
 	}
 	return fmt.Sprintf("%d.%d.%d",
-			c.info.version.major,
-			c.info.version.minor,
-			c.info.version.patch)
+		c.info.version.major,
+		c.info.version.minor,
+		c.info.version.patch)
 }
 
 func (c *control) size() int64 {

control_test.go

@@ -5,9 +5,9 @@
 package debpkg
 
 import (
-	"testing"
-	"github.com/xor-gate/debpkg/internal/test"
 	"github.com/stretchr/testify/assert"
+	"github.com/xor-gate/debpkg/internal/test"
+	"testing"
 )
 
 // Test correct output of a empty control file when no DepPkg Set* functions are called
@@ -82,7 +82,6 @@ Description:
 	// Set full version string, this will overwrite the set SetVersion{Major,Minor,Patch} string
 	deb.SetVersion("7.8.9")
 
-
 	controlExpectFullVersion := `Package: foobar
 Version: 7.8.9
 Architecture: amd64
@@ -203,7 +202,7 @@ func TestControlFileExtra(t *testing.T) {
 echo "hello world from debpkg"
 `
 
-	filepath, err := test.WriteTempFile(t.Name() + ".sh", script)
+	filepath, err := test.WriteTempFile(t.Name()+".sh", script)
 	assert.Nil(t, err)
 
 	deb.SetName("debpkg-control-file-extra")

data.go

@@ -7,11 +7,11 @@ package debpkg
 import (
 	"crypto/md5"
 	"fmt"
+	"github.com/xor-gate/debpkg/internal/targzip"
 	"io"
 	"os"
-	"strings"
 	"path/filepath"
-	"github.com/xor-gate/debpkg/internal/targzip"
+	"strings"
 )
 
 type data struct {
@@ -82,7 +82,7 @@ func (d *data) addFile(filename string, dest ...string) error {
 
 	d.addDirectoriesForFile(destfilename)
 
-	// 
+	//
 	if err := d.tgz.AddFile(filename, dest...); err != nil {
 		return err
 	}

deb.go

@@ -6,9 +6,9 @@ package debpkg
 
 import (
 	"fmt"
+	"github.com/xor-gate/debpkg/internal/targzip"
 	"os"
 	"path/filepath"
-	"github.com/xor-gate/debpkg/internal/targzip"
 )
 
 // DebPkg holds data for a single debian package
@@ -41,7 +41,7 @@ func New() *DebPkg {
 	}
 
 	deb.control.tgz = control
-	deb.data.tgz    = data
+	deb.data.tgz = data
 
 	return deb
 }

debpkg_test.go

@@ -6,11 +6,11 @@ package debpkg
 
 import (
 	"fmt"
+	"github.com/stretchr/testify/assert"
+	"github.com/xor-gate/debpkg/internal/test"
 	"go/build"
 	"os/exec"
 	"testing"
-	"github.com/xor-gate/debpkg/internal/test"
-	"github.com/stretchr/testify/assert"
 )
 
 // testWrite writes the deb package to a temporary file and verifies with native dpkg tool when available
@@ -87,8 +87,8 @@ func TestWriteError(t *testing.T) {
 	assert.Equal(t, fmt.Errorf("empty package name"), deb.Write(""))
 }
 
-// ExampleWrite demonstrates generating a simple package
-func ExampleWrite() {
+// ExampleDebPkgWrite demonstrates generating a simple package
+func ExampleDebPkg_Write() {
 	tempfile := TempDir() + "/foobar.deb"
 
 	deb := New()
@@ -110,7 +110,7 @@ func ExampleWrite() {
 	// Do something with tempfile other than removing it...
 }
 
-// TestFilenameFromFullVersion verifies if the whole version string is correctly concatinated
+// TestFilenameFromFullVersion verifies if the whole version string is correctly calculated
 func TestFilenameFromFullVersion(t *testing.T) {
 	deb := New()
 	defer deb.Close()

digest.go

@@ -5,15 +5,15 @@
 package debpkg
 
 import (
-	"os"
-	"time"
 	"bytes"
 	"crypto"
 	"crypto/md5"
 	"crypto/sha1"
 	"fmt"
 	"hash"
 	"io"
+	"os"
+	"time"
 
 	"golang.org/x/crypto/openpgp"
 	"golang.org/x/crypto/openpgp/clearsign"
@@ -90,7 +90,7 @@ func digestCalcDataHash(in io.Reader, hash hash.Hash) (string, error) {
 	if _, err := io.Copy(hash, in); err != nil {
 		return "", err
 	}
-	return string(hash.Sum(result)),nil
+	return string(hash.Sum(result)), nil
 }
 
 // WriteSigned package with GPG entity
@@ -134,5 +134,3 @@ func (deb *DebPkg) WriteSigned(filename string, entity *openpgp.Entity) error {
 	}
 	return deb.createDebAr(filename)
 }
-
-

digest_test.go

@@ -5,10 +5,10 @@
 package debpkg
 
 import (
-	"testing"
-	"golang.org/x/crypto/openpgp"
-	"github.com/xor-gate/debpkg/internal/test"
 	"github.com/stretchr/testify/assert"
+	"github.com/xor-gate/debpkg/internal/test"
+	"golang.org/x/crypto/openpgp"
+	"testing"
 )
 
 var e *openpgp.Entity

installvar.go

@@ -15,10 +15,10 @@ var vars map[string]string
 func init() {
 	vars = make(map[string]string)
 	vars["INSTALLPREFIX"] = DefaultInstallPrefix
-	vars["BINDIR"]        = DefaultBinDir
-	vars["SBINDIR"]       = DefaultSbinDir
-	vars["SYSCONFDIR"]    = DefaultSysConfDir
-	vars["DATAROOTDIR"]   = DefaultDataRootDir
+	vars["BINDIR"] = DefaultBinDir
+	vars["SBINDIR"] = DefaultSbinDir
+	vars["SYSCONFDIR"] = DefaultSysConfDir
+	vars["DATAROOTDIR"] = DefaultDataRootDir
 }
 
 // SetVar sets a variable for use with config file
@@ -35,7 +35,7 @@ func GetVar(v string) string {
 }
 
 // GetVarWithPrefix gets a variable and appends INSTALLPREFIX when the value doesn't start with "/"
-func GetVarWithPrefix(v string) string{
+func GetVarWithPrefix(v string) string {
 	val := GetVar(v)
 	if val == "" {
 		return val
@@ -54,10 +54,10 @@ func ExpandVar(msg string) (string, error) {
 	}
 	env := struct {
 		INSTALLPREFIX string
-		BINDIR string
-		SBINDIR string
-		DATAROOTDIR string
-		SYSCONFDIR string
+		BINDIR        string
+		SBINDIR       string
+		DATAROOTDIR   string
+		SYSCONFDIR    string
 	}{
 		INSTALLPREFIX: vars["INSTALLPREFIX"],
 		BINDIR:        GetVarWithPrefix("BINDIR"),
@@ -67,7 +67,7 @@ func ExpandVar(msg string) (string, error) {
 	}
 	buf := bytes.NewBuffer(nil)
 	if err := tmpl.Execute(buf, env); err != nil {
-		return "",err
+		return "", err
 	}
-	return buf.String(),nil
+	return buf.String(), nil
 }

installvar_test.go

@@ -5,12 +5,12 @@
 package debpkg
 
 import (
-	"testing"
 	"github.com/stretchr/testify/assert"
+	"testing"
 )
 
 func TestVarInit(t *testing.T) {
-	tvs := map[string]string {
+	tvs := map[string]string{
 		"INSTALLPREFIX": DefaultInstallPrefix,
 		"BINDIR":        DefaultBinDir,
 		"SBINDIR":       DefaultSbinDir,
@@ -24,7 +24,7 @@ func TestVarInit(t *testing.T) {
 }
 
 func TestGetVarWithPrefix(t *testing.T) {
-	tvs := map[string]string {
+	tvs := map[string]string{
 		"BINDIR":      "/usr/bin",
 		"SBINDIR":     "/usr/sbin",
 		"SYSCONFDIR":  "/usr/etc", // FIXME should not be possible -> "/etc"
@@ -37,7 +37,7 @@ func TestGetVarWithPrefix(t *testing.T) {
 }
 
 func TestExpandVarBinDir(t *testing.T) {
-	tvs := map[string]string {
+	tvs := map[string]string{
 		"{{.BINDIR}}":      "/usr/bin",
 		"{{.SBINDIR}}":     "/usr/sbin",
 		"{{.SYSCONFDIR}}":  "/usr/etc", // FIXME should not be possible -> "/etc"

internal/config/config.go

@@ -6,10 +6,11 @@ package config
 
 import (
 	"fmt"
-	"runtime"
 	"gopkg.in/yaml.v2"
+	"runtime"
 )
 
+// PkgSpecFile represents a single debian package
 type PkgSpecFile struct {
 	Name            string `yaml:"name"`
 	Version         string `yaml:"version"`
@@ -32,7 +33,8 @@ type PkgSpecFile struct {
 	EmptyDirectories []string `yaml:"emptydirs,flow"`
 }
 
-func PkgSpecFileUnmarshal(data []byte) (*PkgSpecFile, error){
+// PkgSpecFileUnmarshal loads the configuration data into a PkgSpecFile structure
+func PkgSpecFileUnmarshal(data []byte) (*PkgSpecFile, error) {
 	cfg := &PkgSpecFile{
 		Name:            "unknown",
 		Version:         "0.1.0+dev",
@@ -49,8 +51,8 @@ func PkgSpecFileUnmarshal(data []byte) (*PkgSpecFile, error){
 
 	err := yaml.Unmarshal(data, &cfg)
 	if err != nil {
-		return nil,fmt.Errorf("problem unmarshaling config file: %v", err)
+		return nil, fmt.Errorf("problem unmarshaling config file: %v", err)
 	}
 
-	return cfg,nil
+	return cfg, nil
 }

internal/targzip/targz.go

@@ -39,12 +39,12 @@ func newWriter(wc io.WriteCloser) *TarGzip {
 func NewTempFile(dir string) (*TarGzip, error) {
 	f, err := ioutil.TempFile(dir, "debpkg")
 	if err != nil {
-		return nil,err
+		return nil, err
 	}
 
 	t := newWriter(f)
 	t.fileName = f.Name()
-	return t,nil
+	return t, nil
 }
 
 // AddFile write a file from filename into dest
@@ -80,8 +80,8 @@ func (t *TarGzip) AddFile(filename string, dest ...string) error {
 	}
 
 	hdr.Name = strings.Trim(hdr.Name, "/")
-	hdr.Uid  = 0
-	hdr.Gid  = 0
+	hdr.Uid = 0
+	hdr.Gid = 0
 
 	// write the header to the tarball archive
 	if err := t.writeHeader(hdr); err != nil {