Refactor checks and messages

Signed-off-by: Ulysses Souza <[email protected]>

Author: ulyssessouza

compliance_test.go

@@ -1,10 +1,9 @@
 package main
 
 import (
+	"fmt"
 	"testing"
 	"time"
-
-	"gotest.tools/v3/assert"
 )
 
 const (
@@ -17,49 +16,78 @@ const (
 )
 
 func TestSimpleLifecycle(t *testing.T) {
-	h := TestHelper{T: t, testDir: "simple_lifecycle"}
-	h.TestUpDown(func(t *testing.T) {
+	h := TestHelper{
+		T:       t,
+		testDir: "simple_lifecycle",
+	}
+	h.TestUpDown(func() {
 		time.Sleep(time.Second)
 	})
 }
 
 func TestSimpleNetwork(t *testing.T) {
-	h := TestHelper{T: t, testDir: "simple_network"}
-	h.TestUpDown(func(t *testing.T) {
+	h := TestHelper{
+		T:       t,
+		testDir: "simple_network",
+		specRef: "Networks-top-level-element",
+	}
+	h.TestUpDown(func() {
 		actual := h.getHttpBody(pingUrl)
-		assert.Assert(t, actual == "{\"response\":\"PONG FROM TARGET\"}\n")
+		expected := jsonResponse("PONG FROM TARGET")
+		h.Check(expected, actual)
 	})
 }
 
 func TestSimpleNetworkFail(t *testing.T) {
-	h := TestHelper{T: t, testDir: "simple_network"}
-	h.TestUpDown(func(t *testing.T) {
+	h := TestHelper{
+		T:       t,
+		testDir: "simple_network",
+		specRef: "Networks-top-level-element",
+	}
+	h.TestUpDown(func() {
 		actual := h.getHttpBody("http://localhost:8080/ping?address=notatarget:8080/ping")
-		assert.Assert(t, actual == "{\"response\":\"Could not reach address: notatarget:8080/ping\"}\n")
+		expected := jsonResponse("Could not reach address: notatarget:8080/ping")
+		h.Check(expected, actual)
 	})
 }
 
 func TestDifferentNetworks(t *testing.T) {
-	h := TestHelper{T: t, testDir: "different_networks"}
-	h.TestUpDown(func(t *testing.T) {
+	h := TestHelper{
+		T:       t,
+		testDir: "different_networks",
+		specRef: "Networks-top-level-element",
+	}
+	h.TestUpDown(func() {
 		actual := h.getHttpBody(pingUrl)
-		assert.Assert(t, actual == "{\"response\":\"Could not reach address: target:8080/ping\"}\n")
+		expected := jsonResponse("Could not reach address: target:8080/ping")
+		h.Check(expected, actual)
 	})
 }
 
 func TestVolumeFile(t *testing.T) {
-	h := TestHelper{T: t, testDir: "simple_volume"}
-	h.TestUpDown(func(t *testing.T) {
+	h := TestHelper{
+		T:       t,
+		testDir: "simple_volume",
+		specRef: "volumes-top-level-element",
+	}
+	h.TestUpDown(func() {
 		actual := h.getHttpBody(volumeUrl + "test_volume.txt")
-		assert.Assert(t, actual == "{\"response\":\"MYVOLUME\"}\n")
+		expected := jsonResponse("MYVOLUME")
+		h.Check(expected, actual)
+
 	})
 }
 
 func TestSecretFile(t *testing.T) {
-	h := TestHelper{T: t, testDir: "simple_secretfile"}
-	h.TestUpDown(func(t *testing.T) {
+	h := TestHelper{
+		T:       t,
+		testDir: "simple_secretfile",
+		specRef: "secrets-top-level-element",
+	}
+	h.TestUpDown(func() {
 		actual := h.getHttpBody(volumeUrl + "test_secret.txt")
-		assert.Assert(t, actual == "{\"response\":\"MYSECRET\"}\n")
+		expected := jsonResponse("MYSECRET")
+		h.Check(expected, actual)
 	})
 }
 
@@ -68,9 +96,15 @@ func TestConfigFile(t *testing.T) {
 		T:            t,
 		testDir:      "simple_configfile",
 		skipCommands: []string{"docker-composeV1"},
+		specRef:      "configs-top-level-element",
 	}
-	h.TestUpDown(func(t *testing.T) {
+	h.TestUpDown(func() {
 		actual := h.getHttpBody(volumeUrl + "test_config.txt")
-		assert.Assert(t, actual == "{\"response\":\"MYCONFIG\"}\n")
+		expected := jsonResponse("MYCONFIG")
+		h.Check(expected, actual)
 	})
 }
+
+func jsonResponse(content string) string {
+	return fmt.Sprintf("{\"response\":\"%s\"}\n", content)
+}

tests_helper.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"context"
+	"fmt"
 	"io/ioutil"
 	"net/http"
 	"os"
@@ -17,7 +18,8 @@ import (
 )
 
 const (
-	commandsDir = "commands"
+	commandsDir       = "commands"
+	baseSpecReference = "https://github.com/compose-spec/compose-spec/blob/master/spec.md"
 )
 
 type Config struct {
@@ -42,9 +44,10 @@ type TestHelper struct {
 	*testing.T
 	testDir      string
 	skipCommands []string
+	specRef      string
 }
 
-func (h TestHelper) TestUpDown(fun func(t *testing.T)) {
+func (h TestHelper) TestUpDown(fun func()) {
 	assert.Assert(h, fun != nil, "Test function cannot be `nil`")
 	for _, f := range h.listFiles(commandsDir) {
 		h.Run(f, func(t *testing.T) {
@@ -56,13 +59,32 @@ func (h TestHelper) TestUpDown(fun func(t *testing.T)) {
 				}
 			}
 			h.executeUp(c)
-			fun(t)
+			fun()
 			h.executeDown(c)
 			h.checkDown()
 		})
 	}
 }
 
+func (h TestHelper) Check(expected, actual string) {
+	assert.Check(h.T, expected == actual, h.assertSpecReferenceMessage(expected, actual))
+}
+
+func (h TestHelper) assertSpecReferenceMessage(expected, actual string) string {
+	return fmt.Sprintf("\n- expected: %q\n+ actual: %q\n%s", expected, actual, h.specReferenceMessage())
+}
+
+func (h TestHelper) specReferenceMessage() string {
+	return "Please refer to: " + h.getSpecReference()
+}
+
+func (h TestHelper) getSpecReference() string {
+	if h.specRef != "" {
+		return baseSpecReference + "#" + h.specRef
+	}
+	return baseSpecReference
+}
+
 func (h TestHelper) readConfig(configPath string) (*Config, error) {
 	b, err := ioutil.ReadFile(configPath)
 	assert.NilError(h.T, err)