Split into multiple files and create targzip writer

.travis.yml

@@ -18,5 +18,4 @@ before_install:
 
 script:
   - make test
-  - make test-dpkg
   - $GOPATH/bin/goveralls -service=travis-ci

Makefile

@@ -12,14 +12,6 @@ build:
 test:
 	go test -v -race
 
-test-dpkg:
-	dpkg --info debpkg-test.deb
-	dpkg --contents debpkg-test.deb
-	dpkg --info debpkg-test-add-directory.deb
-	dpkg --contents debpkg-test-add-directory.deb
-	dpkg --info debpkg-test-signed.deb
-	dpkg --contents debpkg-test-signed.deb
-
 lint:
 	go tool vet .
 

constants.go

@@ -0,0 +1,30 @@
+package debpkg
+
+// Priority for Debian package
+type Priority string
+
+// Package Priority
+const (
+	PriorityUnset     Priority = ""          // Priority field is skipped
+	PriorityRequired  Priority = "required"  // Packages which are necessary for the proper functioning of the system
+	PriorityImportant Priority = "important" // Important programs, including those which one would expect to find on any Unix-like system
+	PriorityStandard  Priority = "standard"  // These packages provide a reasonably small but not too limited character-mode system
+	PriorityOptional  Priority = "optional"  // This is all the software that you might reasonably want to install if you didn't know what it was and don't have specialized requirements
+)
+
+// VcsType for Debian package supported version control system (Vcs) types
+type VcsType string
+
+// Package VcsType
+const (
+	VcsTypeUnset      VcsType = ""      // VcsType field is skipped
+	VcsTypeArch       VcsType = "Arch"  // Arch
+	VcsTypeBazaar     VcsType = "Bzr"   // Bazaar
+	VcsTypeDarcs      VcsType = "Darcs" // Darcs
+	VcsTypeGit        VcsType = "Git"   // Git
+	VcsTypeMercurial  VcsType = "Hg"    // Mercurial
+	VcsTypeMonotone   VcsType = "Mtn"   // Monotone
+	VcsTypeSubversion VcsType = "Svn"   // Subversion
+)
+
+const debPkgDebianBinary = "2.0\n"

control.go

@@ -0,0 +1,265 @@
+// Copyright 2017 Jerry Jacobs. All rights reserved.
+// Use of this source code is governed by the MIT
+// license that can be found in the LICENSE file.
+
+package debpkg
+
+import (
+	"strings"
+	"bytes"
+	"fmt"
+	"github.com/xor-gate/debpkg/lib/targzip"
+)
+
+type debPkgControl struct {
+	buf   *bytes.Buffer
+	tgz   *targzip.TarGzip
+	info  debPkgControlInfo
+	extra []string // Extra files added to the control.tar.gz. Typical usage is for conffiles, postinst, postrm, prerm.
+	conffiles []string // Conffiles which must be treated as configuration files
+}
+
+type debPkgControlInfoVersion struct {
+	full  string // Full version string. E.g "0.1.2"
+	major uint   // Major version number
+	minor uint   // Minor version number
+	patch uint   // Patch version number
+}
+
+type debPkgControlInfo struct {
+	name            string
+	version         debPkgControlInfoVersion
+	architecture    string
+	maintainer      string
+	maintainerEmail string
+	homepage        string
+	suggests        string
+	conflicts       string
+	replaces        string
+	provides        string
+	section         string
+	priority        Priority
+	descrShort      string  // Short package description
+	descr           string  // Long package description
+	vcsType         VcsType // E.g: "Svn", "Git" etcetera
+	vcsURL          string  // E.g: git@github.com:xor-gate/debpkg.git
+	vcsBrowser      string  // E.g: https://github.com/xor-gate/debpkg
+	builtUsing      string  // E.g: gcc-4.6 (= 4.6.0-11)
+}
+
+// SetName sets the name of the binary package (mandatory)
+// See: https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Package
+func (deb *DebPkg) SetName(name string) {
+	deb.control.info.name = name
+}
+
+// SetVersion sets the full version string (mandatory), or user SetVersion* functions for "major.minor.patch"
+// The upstream_version may contain only alphanumerics ( A-Za-z0-9 ) and the characters . + - : ~
+//  (full stop, plus, hyphen, colon, tilde) and should start with a digit.
+// NOTE: When the full string is set the SetVersion* function calls are ignored
+// See: https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Version
+func (deb *DebPkg) SetVersion(version string) {
+	// TODO add check for correct version string
+	deb.control.info.version.full = version
+}
+
+// SetVersionMajor sets the version major number
+// See: https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Version
+func (deb *DebPkg) SetVersionMajor(major uint) {
+	deb.control.info.version.major = major
+}
+
+// SetVersionMinor sets the version minor number
+// See: https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Version
+func (deb *DebPkg) SetVersionMinor(minor uint) {
+	deb.control.info.version.minor = minor
+}
+
+// SetVersionPatch sets the version patch level
+// See: https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Version
+func (deb *DebPkg) SetVersionPatch(patch uint) {
+	deb.control.info.version.patch = patch
+}
+
+// SetArchitecture sets the architecture of the package where it can be installed.
+//  E.g "i386, amd64, arm, any, all". See `dpkg-architecture -L` for all supported.
+// Architecture: any
+//    The generated binary package is an architecture dependent one usually in a compiled language.
+// Architecture: all
+//    The generated binary package is an architecture independent one usually consisting of text,
+//    images, or scripts in an interpreted language.
+// See: https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Architecture
+// And: http://man7.org/linux/man-pages/man1/dpkg-architecture.1.html
+func (deb *DebPkg) SetArchitecture(arch string) {
+	deb.control.info.architecture = arch
+}
+
+// SetMaintainer (mandatory), sets the package maintainers name and surname. E.g: "Foo Bar"
+// See: https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Maintainer
+func (deb *DebPkg) SetMaintainer(maintainer string) {
+	deb.control.info.maintainer = maintainer
+}
+
+// SetMaintainerEmail sets the package maintainers email address. E.g: "foo@bar.com"
+// See: https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Maintainer
+func (deb *DebPkg) SetMaintainerEmail(email string) {
+	// TODO check email
+	deb.control.info.maintainerEmail = email
+}
+
+// SetSuggests sets the package suggestions. E.g: "aptitude"
+// See: https://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
+func (deb *DebPkg) SetSuggests(suggests string) {
+	deb.control.info.suggests = suggests
+}
+
+// SetConflicts sets one or more conflicting packages. E.g: "nano"
+// See: https://www.debian.org/doc/debian-policy/ch-relationships.html#s-conflicts
+func (deb *DebPkg) SetConflicts(conflicts string) {
+	deb.control.info.conflicts = conflicts
+}
+
+// SetProvides sets the type which the package provides. E.g: "editor"
+// See: https://www.debian.org/doc/debian-policy/ch-relationships.html#s-virtual
+func (deb *DebPkg) SetProvides(provides string) {
+	deb.control.info.provides = provides
+}
+
+// SetPriority (recommended). Default set to debpkg.PriorityUnset
+// See: https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Priority
+// And: https://www.debian.org/doc/debian-policy/ch-archive.html#s-priorities
+func (deb *DebPkg) SetPriority(priority Priority) {
+	deb.control.info.priority = priority
+}
+
+// SetSection (recommended). E.g: editors
+// See: https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section
+// And: https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections
+func (deb *DebPkg) SetSection(section string) {
+	deb.control.info.section = section
+}
+
+// SetReplaces sets the names of packages which will be replaced. E.g: "pico"
+// See:
+func (deb *DebPkg) SetReplaces(replaces string) {
+	deb.control.info.replaces = replaces
+}
+
+// SetHomepage sets the homepage URL of the package. E.g: "https://github.com/foo/bar"
+func (deb *DebPkg) SetHomepage(url string) {
+	// TODO check url
+	deb.control.info.homepage = url
+}
+
+// SetShortDescription sets the single line synopsis. E.g: "My awesome foo bar baz tool"
+func (deb *DebPkg) SetShortDescription(descr string) {
+	deb.control.info.descrShort = descr
+}
+
+// SetDescription sets the extended description over several lines. E.g:
+// "This tool will calculation the most efficient way to world domination"
+// NOTE: The debian control file has a special formatting of the long description
+//        this function replaces newlines with a newline and a space.
+func (deb *DebPkg) SetDescription(descr string) {
+	deb.control.info.descr = " " + strings.Replace(descr, "\n", "\n ", -1)
+}
+
+// SetVcsType sets the version control system (Vcs) type for the source package.
+// See: https://www.debian.org/doc/manuals/developers-reference/best-pkging-practices.html#s6.2.5.2
+func (deb *DebPkg) SetVcsType(vcs VcsType) {
+	deb.control.info.vcsType = vcs
+}
+
+// SetVcsURL sets the version control system (Vcs) URL for the source package.
+// See: https://www.debian.org/doc/manuals/developers-reference/best-pkging-practices.html#s6.2.5.2
+func (deb *DebPkg) SetVcsURL(url string) {
+	deb.control.info.vcsURL = url
+}
+
+// SetVcsBrowser sets the version control system (Vcs) browsable source-tree URL for the source package.
+// See: https://www.debian.org/doc/manuals/developers-reference/best-pkging-practices.html#s6.2.5.2
+func (deb *DebPkg) SetVcsBrowser(url string) {
+	deb.control.info.vcsBrowser = url
+}
+
+// SetBuiltUsing incorporate parts of other packages when built but do not have to depend on those packages.
+// A package using the source code from the gcc-4.6-source binary package built from the gcc-4.6 source package
+// would have this field in its control file:
+//  Built-Using: gcc-4.6 (= 4.6.0-11)
+// A package including binaries from grub2 and loadlin would have this field in its control file:
+//  Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1)
+// See: https://www.debian.org/doc/debian-policy/ch-relationships.html#s-built-using
+func (deb *DebPkg) SetBuiltUsing(info string) {
+	deb.control.info.builtUsing = info
+}
+
+// AddControlExtra allows the advanced user to add custom script to the control.tar.gz Typical usage is
+//  for conffiles, 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(filename string) {
+	deb.control.extra = append(deb.control.extra, filename)
+}
+
+// AddConffile adds a file to the conffiles so it is treated as configuration files. Configuration files are not overwritten during an update unless specified.
+func (deb *DebPkg) AddConffile(filename string) {
+	deb.control.conffiles = append(deb.control.conffiles, filename)
+}
+
+func createControlTarGz(deb *DebPkg) error {
+	controlFile := []byte(deb.control.String(deb.data.size))
+	if err := deb.control.tgz.AddFileFromBuffer("control", controlFile); err != nil {
+		return err
+	}
+	if err := deb.control.tgz.AddFileFromBuffer("md5sums", []byte(deb.data.md5sums)); err != nil {
+		return err
+	}
+	if err := deb.control.tgz.Close(); err != nil {
+		return err
+	}
+	return nil
+}
+
+// Create control file for control.tar.gz
+func (c *debPkgControl) String(installedSize int64) string {
+	var o string
+
+	// Autogenerate version string (e.g "1.2.3") when unset
+	if c.info.version.full == "" {
+		c.info.version.full = fmt.Sprintf("%d.%d.%d",
+			c.info.version.major,
+			c.info.version.minor,
+			c.info.version.patch)
+	}
+
+	o += fmt.Sprintf("Package: %s\n", c.info.name)
+	o += fmt.Sprintf("Version: %s\n", c.info.version.full)
+	o += fmt.Sprintf("Architecture: %s\n", c.info.architecture)
+	o += fmt.Sprintf("Maintainer: %s <%s>\n",
+		c.info.maintainer,
+		c.info.maintainerEmail)
+	o += fmt.Sprintf("Installed-Size: %d\n", installedSize)
+
+	if c.info.section != "" {
+		o += fmt.Sprintf("Section: %s\n", c.info.section)
+	}
+	if c.info.priority != PriorityUnset {
+		o += fmt.Sprintf("Priority: %s\n", c.info.priority)
+	}
+	if c.info.homepage != "" {
+		o += fmt.Sprintf("Homepage: %s\n", c.info.homepage)
+	}
+	if c.info.vcsType != VcsTypeUnset && c.info.vcsURL != "" {
+		o += fmt.Sprintf("Vcs-%s: %s\n", c.info.vcsType, c.info.vcsURL)
+	}
+	if c.info.vcsBrowser != "" {
+		o += fmt.Sprintf("Vcs-Browser: %s\n", c.info.vcsBrowser)
+	}
+	if c.info.builtUsing != "" {
+		o += fmt.Sprintf("Built-Using: %s\n", c.info.builtUsing)
+	}
+
+	o += fmt.Sprintf("Description: %s\n", c.info.descrShort)
+	o += fmt.Sprintf("%s", c.info.descr)
+
+	return o
+}