test(lib): add dynamic render tests, param validation

Author: b5

lib/render.go

@@ -41,21 +41,40 @@ func (RenderRequests) CoreRequestsName() string { return "render" }
 type RenderParams struct {
 	// Ref is a string reference to the dataset to render
 	Ref string
-	// Optionally pass an entire dataset in for rendering, overrides ref param
+	// Optionally pass an entire dataset in for rendering, if providing a dataset,
+	// the Ref field must be empty
 	Dataset *dataset.Dataset
 	// Optional template override
-	Template  []byte
-	UseFSI    bool
+	Template []byte
+	// If true,
+	UseFSI bool
+	// Output format. defaults to "html"
 	OutFormat string
 }
 
+// Validate checks if render parameters are valid
+func (p *RenderParams) Validate() error {
+	if p.Ref != "" && p.Dataset != nil {
+		return fmt.Errorf("cannot provide both a reference and a dataset to render")
+	}
+	return nil
+}
+
 // RenderViz renders a viz component as html
 func (r *RenderRequests) RenderViz(p *RenderParams, res *[]byte) (err error) {
 	if r.cli != nil {
 		return r.cli.Call("RenderRequests.RenderViz", p, res)
 	}
 	ctx := context.TODO()
 
+	if err = p.Validate(); err != nil {
+		return err
+	}
+
+	if p.Dataset != nil {
+		return fmt.Errorf("rendering dynamic dataset viz component is not supported")
+	}
+
 	var ref reporef.DatasetRef
 	if ref, err = repo.ParseDatasetRef(p.Ref); err != nil {
 		return
@@ -78,6 +97,10 @@ func (r *RenderRequests) RenderReadme(p *RenderParams, res *string) (err error)
 	}
 	ctx := context.TODO()
 
+	if err = p.Validate(); err != nil {
+		return err
+	}
+
 	var ds *dataset.Dataset
 	if p.Dataset != nil {
 		ds = p.Dataset

lib/render_test.go

@@ -46,7 +46,7 @@ func TestNewRenderRequests(t *testing.T) {
 		t.Errorf("invalid requests name. expected: '%s', got: '%s'", "render", reqs.CoreRequestsName())
 	}
 
-	// this should panic:
+	// this should panic, triggering the defer statement above
 	NewRenderRequests(tr, rpc.NewClient(conn))
 }
 
@@ -176,6 +176,35 @@ func (r *renderTestRunner) Save(ref string, ds *dataset.Dataset, bodyPath string
 	}
 }
 
+func TestRenderRequestsRenderViz(t *testing.T) {
+	runner := newRenderTestRunner(t, "render_viz")
+	defer runner.Delete()
+
+	params := RenderParams{
+		Ref: "foo/bar",
+		Dataset: &dataset.Dataset{
+			Readme: &dataset.Readme{
+				ScriptBytes: []byte("# hi\n\nhello"),
+			},
+		},
+	}
+	var data []byte
+	if err := runner.RenderReqs.RenderViz(&params, &data); err == nil {
+		t.Errorf("expected RenderReadme with both ref & dataset to error")
+	}
+
+	params = RenderParams{
+		Dataset: &dataset.Dataset{
+			Readme: &dataset.Readme{
+				ScriptBytes: []byte("# hi\n\nhello"),
+			},
+		},
+	}
+	if err := runner.RenderReqs.RenderViz(&params, &data); err == nil {
+		t.Errorf("expected attempt to dynamic-render viz to fail")
+	}
+}
+
 // Test that render with a readme returns an html string
 func TestRenderReadme(t *testing.T) {
 	runner := newRenderTestRunner(t, "render_readme")
@@ -204,4 +233,31 @@ func TestRenderReadme(t *testing.T) {
 	if diff := cmp.Diff(expect, text); diff != "" {
 		t.Errorf("response mismatch (-want +got):\n%s", diff)
 	}
+
+	params = RenderParams{
+		Dataset: &dataset.Dataset{
+			Readme: &dataset.Readme{
+				ScriptBytes: []byte("# hi\n\nhello"),
+			},
+		},
+	}
+	if err = runner.RenderReqs.RenderReadme(&params, &text); err != nil {
+		t.Errorf("dynamic dataset render error: %s", err)
+	}
+
+	if diff := cmp.Diff(expect, text); diff != "" {
+		t.Errorf("dynamic dataset render response mismatch (-want +got):\n%s", diff)
+	}
+
+	params = RenderParams{
+		Ref: "foo/bar",
+		Dataset: &dataset.Dataset{
+			Readme: &dataset.Readme{
+				ScriptBytes: []byte("# hi\n\nhello"),
+			},
+		},
+	}
+	if err = runner.RenderReqs.RenderReadme(&params, &text); err == nil {
+		t.Errorf("expected RenderReadme with both ref & dataset to error")
+	}
 }