fix(Save): add tests to cmd that test you can save a transform and viz (

#649)

Tests ensure you can savec a Viz or Transform to a dataset without having to add other dataset components as well.

Also, fixes to `prepareViz()` to ensure that we have a `Viz.Script` before creating the datasets

base/viz.go

@@ -1,6 +1,7 @@
 package base
 
 import (
+	"bytes"
 	"os"
 	"strings"
 
@@ -18,21 +19,30 @@ func prepareViz(r repo.Repo, ds *dataset.Dataset) (err error) {
 		return nil
 	}
 
-	if ds.Viz != nil && ds.Viz.ScriptPath != "" {
-		if strings.HasPrefix(ds.Viz.ScriptPath, "/ipfs") || strings.HasPrefix(ds.Viz.ScriptPath, "/map") || strings.HasPrefix(ds.Viz.ScriptPath, "/cafs") {
-			var f cafs.File
-			f, err = r.Store().Get(datastore.NewKey(ds.Viz.ScriptPath))
-			if err != nil {
-				return
-			}
-			ds.Viz.Script = f
-		} else {
-			var f *os.File
-			f, err = os.Open(ds.Viz.ScriptPath)
-			if err != nil {
-				return
+	if ds.Viz != nil {
+		if ds.Viz.Script != nil {
+			return
+		}
+		if ds.Viz.ScriptBytes != nil {
+			ds.Viz.Script = bytes.NewReader(ds.Viz.ScriptBytes)
+			return
+		}
+		if ds.Viz.ScriptPath != "" {
+			if strings.HasPrefix(ds.Viz.ScriptPath, "/ipfs") || strings.HasPrefix(ds.Viz.ScriptPath, "/map") || strings.HasPrefix(ds.Viz.ScriptPath, "/cafs") {
+				var f cafs.File
+				f, err = r.Store().Get(datastore.NewKey(ds.Viz.ScriptPath))
+				if err != nil {
+					return
+				}
+				ds.Viz.Script = f
+			} else {
+				var f *os.File
+				f, err = os.Open(ds.Viz.ScriptPath)
+				if err != nil {
+					return
+				}
+				ds.Viz.Script = f
 			}
-			ds.Viz.Script = f
 		}
 	}
 	return nil

cmd/save_test.go

@@ -137,12 +137,22 @@ func TestSaveRun(t *testing.T) {
 		err      string
 		msg      string
 	}{
+		// no data
 		{"me/bad_dataset", "", "", "", "", false, "", "no changes to save", ""},
+		// bad dataset file
 		{"me/cities", "bad/filpath.json", "", "", "", false, "", "open bad/filpath.json: no such file or directory", ""},
+		// bad body file
 		{"me/cities", "", "bad/bodypath.csv", "", "", false, "", "body file: open bad/bodypath.csv: no such file or directory", ""},
+		// good inputs
 		{"me/movies", "testdata/movies/dataset.json", "testdata/movies/body_ten.csv", "", "", true, "dataset saved: peer/movies@QmZePf5LeXow3RW5U1AgEiNbW46YnRGhZ7HPvm1UmPFPwt/map/QmQK6mkfu9hvDXrFP7uKkx737DHzASZffyAKnuDaTx8Vqy\nthis dataset has 1 validation errors\n", "", ""},
-		{"me/movies", "", "testdata/movies/body_twenty.csv", "Added 10 more rows", "Adding to the number of rows in dataset", true, "dataset saved: peer/movies@QmZePf5LeXow3RW5U1AgEiNbW46YnRGhZ7HPvm1UmPFPwt/map/QmaKAexWMNGWSHet7yW2rCRx6qvESd7mPUqM1v2eRHXz3r\nthis dataset has 1 validation errors\n", "", ""},
-		{"me/movies", "", "testdata/movies/body_twenty.csv", "trying to add again", "hopefully this errors", false, "", "error saving: no changes detected", ""},
+		// add rows, save
+		{"me/movies", "testdata/movies/dataset.json", "testdata/movies/body_twenty.csv", "Added 10 more rows", "Adding to the number of rows in dataset", true, "dataset saved: peer/movies@QmZePf5LeXow3RW5U1AgEiNbW46YnRGhZ7HPvm1UmPFPwt/map/QmPwBVhCaKH5sBc8amByRcyGHeT4JMWWnpcfawxUx36T7d\nthis dataset has 1 validation errors\n", "", ""},
+		// no changes detected
+		{"me/movies", "testdata/movies/dataset.json", "testdata/movies/body_twenty.csv", "trying to add again", "hopefully this errors", false, "", "error saving: no changes detected", ""},
+		// add viz
+		{"me/movies", "testdata/movies/dataset_with_viz.json", "", "", "", false, "dataset saved: peer/movies@QmZePf5LeXow3RW5U1AgEiNbW46YnRGhZ7HPvm1UmPFPwt/map/QmVrSNgJqJNof7qeZVsdZp9FpnmKPRVg4VY7AmY5iFvgPy\nthis dataset has 1 validation errors\n", "", ""},
+		// add transform
+		{"me/movies", "testdata/movies/dataset_with_tf.json", "", "", "", false, "dataset saved: peer/movies@QmZePf5LeXow3RW5U1AgEiNbW46YnRGhZ7HPvm1UmPFPwt/map/QmRSTsTSGirzxzWpKgbku66WSVFV3qNn3EZE3zSkZeh59u\nthis dataset has 1 validation errors\n", "", ""},
 	}
 
 	for i, c := range cases {

cmd/testdata/movies/dataset_with_tf.json

@@ -0,0 +1,33 @@
+{
+  "qri": "ds:0",
+  "meta": {
+    "qri": "md:0",
+    "title": "example movie data"
+  },
+  "structure": {
+    "qri": "st:0",
+    "format": "csv",
+    "formatConfig": {
+      "headerRow": true
+    },
+    "schema": {
+      "type": "array",
+      "items": {
+        "type": "array",
+        "items": [
+          {
+            "title": "title",
+            "type": "string"
+          },
+          {
+            "title": "duration",
+            "type": "integer"
+          }
+        ]
+      }
+    }
+  },
+  "transform": {
+    "scriptPath": "tf.star"
+  }
+}

cmd/testdata/movies/dataset_with_viz.json

@@ -0,0 +1,33 @@
+{
+  "qri": "ds:0",
+  "meta": {
+    "qri": "md:0",
+    "title": "example movie data"
+  },
+  "structure": {
+    "qri": "st:0",
+    "format": "csv",
+    "formatConfig": {
+      "headerRow": true
+    },
+    "schema": {
+      "type": "array",
+      "items": {
+        "type": "array",
+        "items": [
+          {
+            "title": "title",
+            "type": "string"
+          },
+          {
+            "title": "duration",
+            "type": "integer"
+          }
+        ]
+      }
+    }
+  },
+  "viz": {
+    "scriptPath": "viz.html"
+  }
+}

cmd/testdata/movies/tf.star

@@ -0,0 +1,3 @@
+# transform that doesn't change anything.
+def transform(ds, ctx):
+  print("hello Qri! \n")

cmd/testdata/movies/viz.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <title>My Viz Template</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <style>
+    body { margin: 0; padding: 0; font-family: helvetica, sans-serif; }
+  </style>
+</head>
+<body>
+  <div style="width: 100%; margin: 50px auto">
+    <h1>{{ .Meta.Title }}</h1>
+    <p>{{ .Meta.Description }}</p>
+    <small>Data Format: <b>{{ .Structure.Format }}</b></small>
+  </div>
+</body>
+</html>