From 90c1c2de870aeb4b702dcc1c89c112364149ce42 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Arturo=20Filast=C3=B2?= <arturo@filasto.net>
Date: Mon, 19 Mar 2018 13:20:42 +0100
Subject: [PATCH] Start adding support for writing measurements to disk

---
 internal/cli/root/root.go | 16 ++++++++++------
 internal/cli/run/run.go   |  9 ++++++++-
 nettests/nettests.go      | 21 ++++++++++++++++-----
 ooni.go                   | 24 ++++++++++++++++++------
 4 files changed, 52 insertions(+), 18 deletions(-)

diff --git a/internal/cli/root/root.go b/internal/cli/root/root.go
index 8da75cc..f508e0e 100644
--- a/internal/cli/root/root.go
+++ b/internal/cli/root/root.go
@@ -37,15 +37,15 @@ func init() {
 		}
 
 		Init = func() (*ooni.Config, *ooni.Context, error) {
-			var c *ooni.Config
+			var config *ooni.Config
 			var err error
 
 			if *configPath != "" {
 				log.Debugf("Reading config file from %s", *configPath)
-				c, err = ooni.ReadConfig(*configPath)
+				config, err = ooni.ReadConfig(*configPath)
 			} else {
 				log.Debug("Reading default config file")
-				c, err = ooni.ReadDefaultConfigPaths()
+				config, err = ooni.ReadDefaultConfigPaths()
 			}
 			if err != nil {
 				return nil, nil, err
@@ -62,9 +62,13 @@ func init() {
 				return nil, nil, err
 			}
 
-			o := ooni.New(c, db)
-			o.Init()
-			return c, o, nil
+			ctx := ooni.New(config, db)
+			err = ctx.Init()
+			if err != nil {
+				return nil, nil, err
+			}
+
+			return config, ctx, nil
 		}
 
 		return nil
diff --git a/internal/cli/run/run.go b/internal/cli/run/run.go
index cafaf7b..d65e019 100644
--- a/internal/cli/run/run.go
+++ b/internal/cli/run/run.go
@@ -1,6 +1,8 @@
 package run
 
 import (
+	"fmt"
+	"path/filepath"
 	"time"
 
 	"github.com/alecthomas/kingpin"
@@ -37,7 +39,11 @@ func init() {
 
 		for _, nt := range group.Nettests {
 			log.Debugf("Running test %T", nt)
-			ctl := nettests.NewController(ctx, result)
+			msmtPath := filepath.Join(ctx.TempDir,
+				fmt.Sprintf("msmt-%s-%T.jsonl", nt,
+					time.Now().UTC().Format(time.RFC3339Nano)))
+
+			ctl := nettests.NewController(ctx, result, msmtPath)
 			if err := nt.Run(ctl); err != nil {
 				log.WithError(err).Errorf("Failed to run %s", group.Label)
 				return err
@@ -47,6 +53,7 @@ func init() {
 			// 2. Link the measurement to the Result (this should probably happen in
 			// the nettest class)
 			// 3. Update the summary of the result and the other metadata in the db
+			// 4. Move the msmtPath into the final location ~/.ooni/msmts/
 		}
 		// result.Update(ctx.DB)
 		return nil
diff --git a/nettests/nettests.go b/nettests/nettests.go
index 6d8c083..9ce9262 100644
--- a/nettests/nettests.go
+++ b/nettests/nettests.go
@@ -23,22 +23,27 @@ type NettestGroup struct {
 }
 
 // NewController creates a nettest controller
-func NewController(ctx *ooni.Context, res *database.Result) *Controller {
+func NewController(ctx *ooni.Context, res *database.Result, msmtPath string) *Controller {
 	return &Controller{
 		ctx,
 		res,
+		msmtPath,
 	}
 }
 
 // Controller is passed to the run method of every Nettest
+// each nettest instance has one controller
 type Controller struct {
-	Ctx *ooni.Context
-	res *database.Result
+	Ctx      *ooni.Context
+	res      *database.Result
+	msmtPath string
 }
 
 // Init should be called once to initialise the nettest
-func (c *Controller) Init(nt *mk.Nettest) {
+func (c *Controller) Init(nt *mk.Nettest) error {
 	log.Debugf("Init: %v", nt)
+
+	log.Debugf("OutputPath: %s", c.msmtPath)
 	nt.Options = mk.NettestOptions{
 		IncludeIP:        c.Ctx.Config.Sharing.IncludeIP,
 		IncludeASN:       c.Ctx.Config.Sharing.IncludeASN,
@@ -50,9 +55,10 @@ func (c *Controller) Init(nt *mk.Nettest) {
 		// XXX
 		GeoIPCountryPath: "",
 		GeoIPASNPath:     "",
-		OutputPath:       "/tmp/measurement.jsonl",
+		OutputPath:       c.msmtPath,
 		CaBundlePath:     "/etc/ssl/cert.pem",
 	}
+
 	nt.On("log", func(e mk.Event) {
 		level := e.Value["verbosity"].(string)
 		msg := e.Value["message"].(string)
@@ -106,6 +112,11 @@ func (c *Controller) Init(nt *mk.Nettest) {
 		c.OnEntry(e.Value["json_str"].(string))
 	})
 
+	nt.On("end", func(e mk.Event) {
+		c.OnEntry(e.Value["json_str"].(string))
+	})
+
+	return nil
 }
 
 // OnProgress should be called when a new progress event is available.
diff --git a/ooni.go b/ooni.go
index c2d352b..2b90257 100644
--- a/ooni.go
+++ b/ooni.go
@@ -34,8 +34,9 @@ func Onboarding(c *Config) error {
 
 // Context for OONI Probe
 type Context struct {
-	Config *Config
-	DB     *sqlx.DB
+	Config  *Config
+	DB      *sqlx.DB
+	TempDir string
 }
 
 // Init the OONI manager
@@ -48,6 +49,13 @@ func (c *Context) Init() error {
 			return errors.Wrap(err, "onboarding")
 		}
 	}
+
+	tempDir, err := ioutil.TempDir("", "ooni")
+	if err != nil {
+		return errors.Wrap(err, "creating TempDir")
+	}
+	c.TempDir = tempDir
+
 	return nil
 }
 
@@ -154,12 +162,16 @@ func EnsureDefaultOONIHomeDir() (string, error) {
 		return "", err
 	}
 
-	if _, e := os.Stat(filepath.Join(home, "db")); e != nil {
-		err = os.MkdirAll(filepath.Join(home, "db"), 0700)
-		if err != nil {
-			return "", err
+	requiredDirs := []string{"db", "msmts"}
+	for _, d := range requiredDirs {
+		if _, e := os.Stat(filepath.Join(home, d)); e != nil {
+			err = os.MkdirAll(filepath.Join(home, d), 0700)
+			if err != nil {
+				return "", err
+			}
 		}
 	}
+
 	return home, nil
 }