Merge pull request #1659 from weaveworks/demo

Adding a static report file mode.

Author: paulbellamy

Makefile

@@ -41,7 +41,7 @@ docker/weave:
 	curl -L git.io/weave -o docker/weave
 	chmod u+x docker/weave
 
-$(SCOPE_EXPORT): $(SCOPE_EXE) $(DOCKER_DISTRIB) docker/weave $(RUNSVINIT) docker/Dockerfile docker/run-app docker/run-probe docker/entrypoint.sh
+$(SCOPE_EXPORT): $(SCOPE_EXE) $(DOCKER_DISTRIB) docker/weave $(RUNSVINIT) docker/Dockerfile docker/demo.json docker/run-app docker/run-probe docker/entrypoint.sh
 	cp $(SCOPE_EXE) $(RUNSVINIT) docker/
 	cp $(DOCKER_DISTRIB) docker/docker.tgz
 	$(SUDO) docker build -t $(SCOPE_IMAGE) docker/

app/api_report_test.go

@@ -9,11 +9,12 @@ import (
 
 	"github.com/weaveworks/scope/app"
 	"github.com/weaveworks/scope/report"
+	"github.com/weaveworks/scope/test/fixture"
 )
 
 func topologyServer() *httptest.Server {
 	router := mux.NewRouter().SkipClean(true)
-	app.RegisterTopologyRoutes(router, StaticReport{})
+	app.RegisterTopologyRoutes(router, app.StaticCollector(fixture.Report))
 	return httptest.NewServer(router)
 }
 

app/benchmark_internal_test.go

@@ -2,25 +2,17 @@ package app
 
 import (
 	"flag"
-	"io/ioutil"
 	"net/http"
 	"net/url"
 	"testing"
 
-	"github.com/ugorji/go/codec"
+	"golang.org/x/net/context"
 
 	"github.com/weaveworks/scope/render"
 	"github.com/weaveworks/scope/report"
 	"github.com/weaveworks/scope/test/fixture"
 )
 
-// StaticReport is used as a fixture in tests. It emulates an xfer.Collector.
-type StaticReporter struct{ r report.Report }
-
-func (s StaticReporter) Report() report.Report { return s.r }
-func (s StaticReporter) WaitOn(chan struct{})  {}
-func (s StaticReporter) UnWait(chan struct{})  {}
-
 var (
 	benchReportFile = flag.String("bench-report-file", "", "json report file to use for benchmarking (relative to this package)")
 )
@@ -30,14 +22,12 @@ func loadReport() (report.Report, error) {
 		return fixture.Report, nil
 	}
 
-	b, err := ioutil.ReadFile(*benchReportFile)
+	c, err := NewFileCollector(*benchReportFile)
 	if err != nil {
 		return fixture.Report, err
 	}
-	rpt := report.MakeReport()
-	decoder := codec.NewDecoderBytes(b, &codec.JsonHandle{})
-	err = decoder.Decode(&rpt)
-	return rpt, err
+
+	return c.Report(context.Background())
 }
 
 func BenchmarkTopologyList(b *testing.B) {

app/collector.go

@@ -1,9 +1,14 @@
 package app
 
 import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
 	"sync"
 	"time"
 
+	"github.com/ugorji/go/codec"
 	"golang.org/x/net/context"
 
 	"github.com/weaveworks/scope/common/mtime"
@@ -131,3 +136,56 @@ func (c *collector) clean() {
 	c.reports = cleanedReports
 	c.timestamps = cleanedTimestamps
 }
+
+// StaticCollector always returns the given report.
+type StaticCollector report.Report
+
+// Report returns a merged report over all added reports. It implements
+// Reporter.
+func (c StaticCollector) Report(context.Context) (report.Report, error) { return report.Report(c), nil }
+
+// Add adds a report to the collector's internal state. It implements Adder.
+func (c StaticCollector) Add(context.Context, report.Report) error { return nil }
+
+// WaitOn lets other components wait on a new report being received. It
+// implements Reporter.
+func (c StaticCollector) WaitOn(context.Context, chan struct{}) {}
+
+// UnWait lets other components stop waiting on a new report being received. It
+// implements Reporter.
+func (c StaticCollector) UnWait(context.Context, chan struct{}) {}
+
+// NewFileCollector reads and parses the given path, returning a collector
+// which always returns that report.
+func NewFileCollector(path string) (Collector, error) {
+	f, err := os.Open(path)
+	if err != nil {
+		return nil, err
+	}
+	defer f.Close()
+
+	var (
+		rpt     report.Report
+		handle  codec.Handle
+		gzipped bool
+	)
+	fileType := filepath.Ext(path)
+	if fileType == ".gz" {
+		gzipped = true
+		fileType = filepath.Ext(strings.TrimSuffix(path, fileType))
+	}
+	switch fileType {
+	case ".json":
+		handle = &codec.JsonHandle{}
+	case ".msgpack":
+		handle = &codec.MsgpackHandle{}
+	default:
+		return nil, fmt.Errorf("Unsupported file extension: %v", fileType)
+	}
+
+	if err := rpt.ReadBinary(f, gzipped, handle); err != nil {
+		return nil, err
+	}
+
+	return StaticCollector(rpt), nil
+}

app/mock_reporter_test.go

@@ -6,6 +6,7 @@ RUN echo "http://dl-3.alpinelinux.org/alpine/edge/testing" >>/etc/apk/repositori
 	apk add --update bash runit conntrack-tools iproute2 util-linux curl && \
 	rm -rf /var/cache/apk/*
 ADD ./docker.tgz /
+ADD ./demo.json /
 ADD ./weave /usr/bin/
 COPY ./scope ./runsvinit ./entrypoint.sh /home/weave/
 COPY ./run-app /etc/service/app/run

docker/Dockerfile

@@ -90,7 +90,10 @@ func collectorFactory(userIDer multitenant.UserIDer, collectorURL, s3URL, natsHo
 		return nil, err
 	}
 
-	if parsed.Scheme == "dynamodb" {
+	switch parsed.Scheme {
+	case "file":
+		return app.NewFileCollector(parsed.Path)
+	case "dynamodb":
 		s3, err := url.Parse(s3URL)
 		if err != nil {
 			return nil, fmt.Errorf("Valid URL for s3 required: %v", err)

docker/demo.json

@@ -186,7 +186,7 @@ func main() {
 	flag.StringVar(&flags.app.containerName, "app.container.name", app.DefaultContainerName, "Name of this container (to lookup container ID)")
 	flag.StringVar(&flags.app.dockerEndpoint, "app.docker", app.DefaultDockerEndpoint, "Location of docker endpoint (to lookup container ID)")
 
-	flag.StringVar(&flags.app.collectorURL, "app.collector", "local", "Collector to use (local of dynamodb)")
+	flag.StringVar(&flags.app.collectorURL, "app.collector", "local", "Collector to use (local, dynamodb, or file)")
 	flag.StringVar(&flags.app.s3URL, "app.collector.s3", "local", "S3 URL to use (when collector is dynamodb)")
 	flag.StringVar(&flags.app.controlRouterURL, "app.control.router", "local", "Control router to use (local or sqs)")
 	flag.StringVar(&flags.app.pipeRouterURL, "app.pipe.router", "local", "Pipe router to use (local)")