feat(pkg): add pkg time

This package is used to control how we utilize the time package across
the Deis Platform, including application logs, component logs, API
datetime structures, etc.

Author: Matthew Fisher

.gitignore

@@ -41,6 +41,7 @@ deisctl/makeself/
 docs/_build/
 docs/docs.zip
 logspout/build/
+logspout/image/logspout
 logspout/Godeps/
 publisher/Godeps/
 router/Godeps/

builder/Dockerfile

@@ -4,31 +4,19 @@ COMPONENT = builder
 IMAGE = $(IMAGE_PREFIX)$(COMPONENT):$(BUILD_TAG)
 DEV_IMAGE = $(DEV_REGISTRY)/$(IMAGE)
 BUILD_IMAGE := $(COMPONENT)-build
+BINARIES := extract-domain extract-types extract-version generate-buildhook get-app-config get-app-values publish-release-controller yaml2json-procfile
 BINARY_DEST_DIR := image/bin
 
 build: check-docker
-	cp -pR ../Godeps .
-	docker build -t $(BUILD_IMAGE) .
-	docker cp `docker create $(BUILD_IMAGE)`:/go/bin/extract-domain $(BINARY_DEST_DIR)/
-	docker cp `docker create $(BUILD_IMAGE)`:/go/bin/extract-types $(BINARY_DEST_DIR)/
-	docker cp `docker create $(BUILD_IMAGE)`:/go/bin/extract-version $(BINARY_DEST_DIR)/
-	docker cp `docker create $(BUILD_IMAGE)`:/go/bin/generate-buildhook $(BINARY_DEST_DIR)/
-	docker cp `docker create $(BUILD_IMAGE)`:/go/bin/get-app-config $(BINARY_DEST_DIR)/
-	docker cp `docker create $(BUILD_IMAGE)`:/go/bin/get-app-values $(BINARY_DEST_DIR)/
-	docker cp `docker create $(BUILD_IMAGE)`:/go/bin/publish-release-controller $(BINARY_DEST_DIR)/
-	docker cp `docker create $(BUILD_IMAGE)`:/go/bin/yaml2json-procfile $(BINARY_DEST_DIR)/
+	for i in $(BINARIES); do \
+		GOOS=linux GOARCH=amd64 CGO_ENABLED=0 godep go build -a -v -ldflags '-s' -o $(BINARY_DEST_DIR)/$$i bin/$$i.go ; \
+	done
 	docker build -t $(IMAGE) image
 
 clean: check-docker check-registry
-	rm -rf Godeps
-	rm -f $(BINARY_DEST_DIR)/extract-domain
-	rm -f $(BINARY_DEST_DIR)/extract-types
-	rm -f $(BINARY_DEST_DIR)/extract-version
-	rm -f $(BINARY_DEST_DIR)/generate-buildhook
-	rm -f $(BINARY_DEST_DIR)/get-app-config
-	rm -f $(BINARY_DEST_DIR)/get-app-values
-	rm -f $(BINARY_DEST_DIR)/publish-release-controller
-	rm -f $(BINARY_DEST_DIR)/yaml2json-procfile
+	for i in $(BINARIES); do \
+		rm -rf $(BINARY_DEST_DIR)/$$i ; \
+	done
 	docker rmi $(IMAGE)
 
 full-clean: check-docker check-registry clean

builder/Makefile

@@ -1,11 +1,7 @@
 package builder
 
 import (
-	"time"
-)
-
-const (
-	DEIS_DATETIME string = "2006-01-02T15:04:05MST"
+	"github.com/deis/deis/pkg/time"
 )
 
 // ProcessType represents the key/value mappings of a process type to a process inside
@@ -45,38 +41,6 @@ type Config struct {
 	CPU     map[string]int         `json:"cpu"`
 	Tags    map[string]string      `json:"tags"`
 	UUID    string                 `json:"uuid"`
-	Created DeisTime               `json:"created"`
-	Updated DeisTime               `json:"updated"`
-}
-
-// DeisTime represents the standard datetime format used across the platform.
-type DeisTime struct {
-	time.Time
-}
-
-func (t *DeisTime) format() string {
-	return t.Time.Format(DEIS_DATETIME)
-}
-
-// MarshalJSON implements the json.Marshaler interface.
-// The time is a quoted string in Deis' datetime format.
-func (t *DeisTime) MarshalJSON() ([]byte, error) {
-	return []byte(t.Time.Format(`"` + DEIS_DATETIME + `"`)), nil
-}
-
-// UnmarshalText implements the encoding.TextUnmarshaler interface.
-// The time is expected to be in Deis' datetime format.
-func (t *DeisTime) UnmarshalText(data []byte) (err error) {
-	tt, err := time.Parse(DEIS_DATETIME, string(data))
-	*t = DeisTime{tt}
-	return
-}
-
-// UnmarshalJSON implements the json.Unmarshaler interface.
-// The time is expected to be a quoted string in Deis' datetime format.
-func (t *DeisTime) UnmarshalJSON(data []byte) (err error) {
-	// Fractional seconds are handled implicitly by Parse.
-	tt, err := time.Parse(`"`+DEIS_DATETIME+`"`, string(data))
-	*t = DeisTime{tt}
-	return
+	Created time.Time              `json:"created"`
+	Updated time.Time              `json:"updated"`
 }

builder/types.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 	"testing"
 	"time"
+	dtime "github.com/deis/deis/pkg/time"
 )
 
 type ClosingBuffer struct {
@@ -167,7 +168,7 @@ func TestParseControllerConfigGood(t *testing.T) {
 }
 
 func TestTimeSerialize(t *testing.T) {
-	time, err := json.Marshal(&DeisTime{time.Now().UTC()})
+	time, err := json.Marshal(&dtime.Time{time.Now().UTC()})
 
 	if err != nil {
 		t.Errorf("expected to be able to serialize time as json, got '%v'", err)

builder/utils_test.go

@@ -19,6 +19,25 @@ Prerequisites
 You can develop on any supported platform including your laptop, cloud providers or
 on bare metal.  We strongly recommend a minimum 3-node cluster.
 
+Deis is written in both python and Go, so you will need to install both Python 2.7 and
+the latest version of Go.
+
+If your local workstation does not support the linux/amd64 target environment, you will
+have to install Go from source with cross-compile support for that environment. This is
+because some of the components are built on your local machine and then injected into a
+docker container. To do that, run
+
+.. code-block:: console
+
+    $ sudo su
+    $ curl -sSL https://golang.org/dl/go1.4.src.tar.gz | tar -v -C /usr/local -xz
+    $ cd /usr/local/go/src
+    $ # compile Go for our default platform first, then add cross-compile support
+    $ ./make.bash --no-clean
+    $ GOOS=linux GOARCH=amd64 ./make.bash --no-clean
+
+After that, you should be able to compile Deis' components as normal.
+
 The development workflow requires a Docker Registry that is accessible to you
 (the developer) and to all of the hosts in your cluster.
 

docs/contributing/hacking.rst

@@ -7,14 +7,11 @@ RELEASE_IMAGE := $(DOCKER_IMAGE):$(BUILD_TAG)
 DEV_DOCKER_IMAGE := $(DEV_REGISTRY)/$(RELEASE_IMAGE)
 
 build: check-docker
-	cp -pR ../Godeps .
-	docker build -t $(BUILD_IMAGE) .
-	docker cp `docker run -d $(BUILD_IMAGE)`:/go/bin/logspout image/
+	GOOS=linux GOARCH=amd64 CGO_ENABLED=0 godep go build -a -v -ldflags '-s' -o image/logspout
 	docker build -t $(RELEASE_IMAGE) image
-	rm -rf image/logspout
 
 clean: check-docker check-registry
-	rm -rf Godeps
+	rm -rf image/logspout
 	docker rmi $(RELEASE_IMAGE) $(BUILD_IMAGE)
 
 full-clean: check-docker check-registry

logspout/Makefile

@@ -11,6 +11,7 @@ import (
 	"strconv"
 	"strings"
 	"time"
+	dtime "github.com/deis/deis/pkg/time"
 
 	"code.google.com/p/go.net/websocket"
 	"github.com/coreos/go-etcd/etcd"
@@ -72,7 +73,7 @@ func syslogStreamer(target Target, types []string, logstream chan *Log) {
 		// HACK: Go's syslog package hardcodes the log format, so let's send our own message
 		_, err = fmt.Fprintf(conn,
 			"%s %s[%s]: %s",
-			time.Now().Format("2006-01-02T15:04:05MST"),
+			time.Now().Format(dtime.DEIS_DATETIME_FORMAT),
 			tag,
 			pid,
 			logline.Data)

logspout/logspout.go

@@ -0,0 +1,37 @@
+package time
+
+import "time"
+
+const DEIS_DATETIME_FORMAT string = "2006-01-02T15:04:05MST"
+
+// Time represents the standard datetime format used across the Deis Platform.
+type Time struct {
+	time.Time
+}
+
+func (t *Time) format() string {
+	return t.Time.Format(DEIS_DATETIME_FORMAT)
+}
+
+// MarshalJSON implements the json.Marshaler interface.
+// The time is a quoted string in Deis' datetime format.
+func (t *Time) MarshalJSON() ([]byte, error) {
+	return []byte(t.Time.Format(`"` + DEIS_DATETIME_FORMAT + `"`)), nil
+}
+
+// UnmarshalText implements the encoding.TextUnmarshaler interface.
+// The time is expected to be in Deis' datetime format.
+func (t *Time) UnmarshalText(data []byte) (err error) {
+	tt, err := time.Parse(DEIS_DATETIME_FORMAT, string(data))
+	*t = Time{tt}
+	return
+}
+
+// UnmarshalJSON implements the json.Unmarshaler interface.
+// The time is expected to be a quoted string in Deis' datetime format.
+func (t *Time) UnmarshalJSON(data []byte) (err error) {
+	// Fractional seconds are handled implicitly by Parse.
+	tt, err := time.Parse(`"`+DEIS_DATETIME_FORMAT+`"`, string(data))
+	*t = Time{tt}
+	return
+}