test cases

webapp/backend/pkg/web/server_test.go

@@ -2,6 +2,7 @@ package web_test
 
 import (
 	"encoding/json"
+	"fmt"
 	mock_config "github.com/analogj/scrutiny/webapp/backend/pkg/config/mock"
 	dbModels "github.com/analogj/scrutiny/webapp/backend/pkg/models/db"
 	"github.com/analogj/scrutiny/webapp/backend/pkg/web"
@@ -17,16 +18,26 @@ import (
 	"testing"
 )
 
+const (
+	emptyBasePath = ""
+	notEmptyBasePath = "/basepath"
+)
+
+var basePathTestCases = []string{
+	emptyBasePath,
+	notEmptyBasePath,
+}
+
 func TestHealthRoute(t *testing.T) {
+	for _, basePath := range basePathTestCases {
+		t.Run(fmt.Sprintf(`with basePath "%s"`, basePath), func (tt *testing.T) {
 			//setup
 			parentPath, _ := ioutil.TempDir("", "")
-	defer os.RemoveAll(parentPath)
+			mockCtrl := gomock.NewController(tt)
-	mockCtrl := gomock.NewController(t)
-	defer mockCtrl.Finish()
 			fakeConfig := mock_config.NewMockInterface(mockCtrl)
 			fakeConfig.EXPECT().GetString("web.database.location").Return(path.Join(parentPath, "scrutiny_test.db")).AnyTimes()
 			fakeConfig.EXPECT().GetString("web.src.frontend.path").Return(parentPath).AnyTimes()
-	fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return("").AnyTimes()
+			fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return(basePath).AnyTimes()
 
 			ae := web.AppEngine{
 				Config: fakeConfig,
@@ -36,136 +47,160 @@ func TestHealthRoute(t *testing.T) {
 
 			//test
 			w := httptest.NewRecorder()
-	req, _ := http.NewRequest("GET", "/api/health", nil)
+			req, _ := http.NewRequest("GET", basePath + "/api/health", nil)
 			router.ServeHTTP(w, req)
 
 			//assert
-	require.Equal(t, 200, w.Code)
+			require.Equal(tt, 200, w.Code)
-	require.Equal(t, "{\"success\":true}", w.Body.String())
+			require.Equal(tt, "{\"success\":true}", w.Body.String())
+
+			// tear down
+			mockCtrl.Finish()
+			os.RemoveAll(parentPath)
+		})
+	}
 }
 
 func TestRegisterDevicesRoute(t *testing.T) {
+	for _, basePath := range basePathTestCases {
+		t.Run(fmt.Sprintf(`with basePath "%s"`, basePath), func (tt *testing.T) {
 			//setup
 			parentPath, _ := ioutil.TempDir("", "")
-	defer os.RemoveAll(parentPath)
+			mockCtrl := gomock.NewController(tt)
-	mockCtrl := gomock.NewController(t)
-	defer mockCtrl.Finish()
 			fakeConfig := mock_config.NewMockInterface(mockCtrl)
 			fakeConfig.EXPECT().GetString("web.database.location").Return(path.Join(parentPath, "scrutiny_test.db")).AnyTimes()
 			fakeConfig.EXPECT().GetString("web.src.frontend.path").Return(parentPath).AnyTimes()
-	fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return("").AnyTimes()
+			fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return(basePath).AnyTimes()
 			ae := web.AppEngine{
 				Config: fakeConfig,
 			}
 			router := ae.Setup(logrus.New())
 			file, err := os.Open("testdata/register-devices-req.json")
-	require.NoError(t, err)
+			require.NoError(tt, err)
 
 			//test
 			w := httptest.NewRecorder()
-	req, _ := http.NewRequest("POST", "/api/devices/register", file)
+			req, _ := http.NewRequest("POST", basePath + "/api/devices/register", file)
 			router.ServeHTTP(w, req)
 
 			//assert
-	require.Equal(t, 200, w.Code)
+			require.Equal(tt, 200, w.Code)
+
+			// tear down
+			mockCtrl.Finish()
+			os.RemoveAll(parentPath)
+		})
+	}
 }
 
 func TestUploadDeviceMetricsRoute(t *testing.T) {
+	for _, basePath := range basePathTestCases {
+		t.Run(fmt.Sprintf(`with basePath "%s"`, basePath), func(tt *testing.T) {
 			//setup
 			parentPath, _ := ioutil.TempDir("", "")
-	defer os.RemoveAll(parentPath)
+			mockCtrl := gomock.NewController(tt)
-	mockCtrl := gomock.NewController(t)
-	defer mockCtrl.Finish()
 			fakeConfig := mock_config.NewMockInterface(mockCtrl)
 			fakeConfig.EXPECT().GetString("web.database.location").AnyTimes().Return(path.Join(parentPath, "scrutiny_test.db"))
 			fakeConfig.EXPECT().GetString("web.src.frontend.path").AnyTimes().Return(parentPath)
-	fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return("").AnyTimes()
+			fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return(basePath).AnyTimes()
 			ae := web.AppEngine{
 				Config: fakeConfig,
 			}
 			router := ae.Setup(logrus.New())
 			devicesfile, err := os.Open("testdata/register-devices-single-req.json")
-	require.NoError(t, err)
+			require.NoError(tt, err)
 
 			metricsfile, err := os.Open("testdata/upload-device-metrics-req.json")
-	require.NoError(t, err)
+			require.NoError(tt, err)
 
 			//test
 			wr := httptest.NewRecorder()
-	req, _ := http.NewRequest("POST", "/api/devices/register", devicesfile)
+			req, _ := http.NewRequest("POST", basePath + "/api/devices/register", devicesfile)
 			router.ServeHTTP(wr, req)
-	require.Equal(t, 200, wr.Code)
+			require.Equal(tt, 200, wr.Code)
 
 			mr := httptest.NewRecorder()
-	req, _ = http.NewRequest("POST", "/api/device/0x5000cca264eb01d7/smart", metricsfile)
+			req, _ = http.NewRequest("POST", basePath + "/api/device/0x5000cca264eb01d7/smart", metricsfile)
 			router.ServeHTTP(mr, req)
-	require.Equal(t, 200, mr.Code)
+			require.Equal(tt, 200, mr.Code)
 
 			//assert
+
+			// tear down
+			mockCtrl.Finish()
+			os.RemoveAll(parentPath)
+		})
+	}
 }
 
 func TestPopulateMultiple(t *testing.T) {
+	for _, basePath := range basePathTestCases {
+		t.Run(fmt.Sprintf(`with basePath "%s"`, basePath), func(tt *testing.T) {
 			//setup
 			parentPath, _ := ioutil.TempDir("", "")
-	defer os.RemoveAll(parentPath)
+			mockCtrl := gomock.NewController(tt)
-	mockCtrl := gomock.NewController(t)
-	defer mockCtrl.Finish()
 			fakeConfig := mock_config.NewMockInterface(mockCtrl)
 			//fakeConfig.EXPECT().GetString("web.database.location").AnyTimes().Return("testdata/scrutiny_test.db")
 			fakeConfig.EXPECT().GetStringSlice("notify.urls").Return([]string{}).AnyTimes()
 			fakeConfig.EXPECT().GetString("web.database.location").AnyTimes().Return(path.Join(parentPath, "scrutiny_test.db"))
 			fakeConfig.EXPECT().GetString("web.src.frontend.path").AnyTimes().Return(parentPath)
-	fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return("").AnyTimes()
+			fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return(basePath).AnyTimes()
 			ae := web.AppEngine{
 				Config: fakeConfig,
 			}
 			router := ae.Setup(logrus.New())
 			devicesfile, err := os.Open("testdata/register-devices-req.json")
-	require.NoError(t, err)
+			require.NoError(tt, err)
 
 			metricsfile, err := os.Open("../models/testdata/smart-ata.json")
-	require.NoError(t, err)
+			require.NoError(tt, err)
 			failfile, err := os.Open("../models/testdata/smart-fail2.json")
-	require.NoError(t, err)
+			require.NoError(tt, err)
 			nvmefile, err := os.Open("../models/testdata/smart-nvme.json")
-	require.NoError(t, err)
+			require.NoError(tt, err)
 			scsifile, err := os.Open("../models/testdata/smart-scsi.json")
-	require.NoError(t, err)
+			require.NoError(tt, err)
 			scsi2file, err := os.Open("../models/testdata/smart-scsi2.json")
-	require.NoError(t, err)
+			require.NoError(tt, err)
 
 			//test
 			wr := httptest.NewRecorder()
-	req, _ := http.NewRequest("POST", "/api/devices/register", devicesfile)
+			req, _ := http.NewRequest("POST", basePath + "/api/devices/register", devicesfile)
 			router.ServeHTTP(wr, req)
-	require.Equal(t, 200, wr.Code)
+			require.Equal(tt, 200, wr.Code)
 
 			mr := httptest.NewRecorder()
-	req, _ = http.NewRequest("POST", "/api/device/0x5000cca264eb01d7/smart", metricsfile)
+			req, _ = http.NewRequest("POST", basePath + "/api/device/0x5000cca264eb01d7/smart", metricsfile)
 			router.ServeHTTP(mr, req)
-	require.Equal(t, 200, mr.Code)
+			require.Equal(tt, 200, mr.Code)
 
 			fr := httptest.NewRecorder()
-	req, _ = http.NewRequest("POST", "/api/device/0x5000cca264ec3183/smart", failfile)
+			req, _ = http.NewRequest("POST", basePath + "/api/device/0x5000cca264ec3183/smart", failfile)
 			router.ServeHTTP(fr, req)
-	require.Equal(t, 200, fr.Code)
+			require.Equal(tt, 200, fr.Code)
 
 			nr := httptest.NewRecorder()
-	req, _ = http.NewRequest("POST", "/api/device/0x5002538e40a22954/smart", nvmefile)
+			req, _ = http.NewRequest("POST", basePath + "/api/device/0x5002538e40a22954/smart", nvmefile)
 			router.ServeHTTP(nr, req)
-	require.Equal(t, 200, nr.Code)
+			require.Equal(tt, 200, nr.Code)
 
 			sr := httptest.NewRecorder()
-	req, _ = http.NewRequest("POST", "/api/device/0x5000cca252c859cc/smart", scsifile)
+			req, _ = http.NewRequest("POST", basePath + "/api/device/0x5000cca252c859cc/smart", scsifile)
 			router.ServeHTTP(sr, req)
-	require.Equal(t, 200, sr.Code)
+			require.Equal(tt, 200, sr.Code)
 
 			s2r := httptest.NewRecorder()
-	req, _ = http.NewRequest("POST", "/api/device/0x5000cca264ebc248/smart", scsi2file)
+			req, _ = http.NewRequest("POST", basePath + "/api/device/0x5000cca264ebc248/smart", scsi2file)
 			router.ServeHTTP(s2r, req)
-	require.Equal(t, 200, s2r.Code)
+			require.Equal(tt, 200, s2r.Code)
 
 			//assert
+
+			// tear down
+			mockCtrl.Finish()
+			os.RemoveAll(parentPath)
+		})
+	}
 }
 
 //TODO: this test should use a recorded request/response playback.
@@ -194,15 +229,15 @@ func TestPopulateMultiple(t *testing.T) {
 //}
 
 func TestSendTestNotificationRoute_WebhookFailure(t *testing.T) {
+	for _, basePath := range basePathTestCases {
+		t.Run(fmt.Sprintf(`with basePath "%s"`, basePath), func(tt *testing.T) {
 			//setup
 			parentPath, _ := ioutil.TempDir("", "")
-	defer os.RemoveAll(parentPath)
+			mockCtrl := gomock.NewController(tt)
-	mockCtrl := gomock.NewController(t)
-	defer mockCtrl.Finish()
 			fakeConfig := mock_config.NewMockInterface(mockCtrl)
 			fakeConfig.EXPECT().GetString("web.database.location").AnyTimes().Return(path.Join(parentPath, "scrutiny_test.db"))
 			fakeConfig.EXPECT().GetString("web.src.frontend.path").AnyTimes().Return(parentPath)
-	fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return("").AnyTimes()
+			fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return(basePath).AnyTimes()
 			fakeConfig.EXPECT().GetStringSlice("notify.urls").AnyTimes().Return([]string{"https://unroutable.domain.example.asdfghj"})
 			ae := web.AppEngine{
 				Config: fakeConfig,
@@ -211,23 +246,29 @@ func TestSendTestNotificationRoute_WebhookFailure(t *testing.T) {
 
 			//test
 			wr := httptest.NewRecorder()
-	req, _ := http.NewRequest("POST", "/api/health/notify", strings.NewReader("{}"))
+			req, _ := http.NewRequest("POST", basePath + "/api/health/notify", strings.NewReader("{}"))
 			router.ServeHTTP(wr, req)
 
 			//assert
-	require.Equal(t, 500, wr.Code)
+			require.Equal(tt, 500, wr.Code)
+
+			// tear down
+			mockCtrl.Finish()
+			os.RemoveAll(parentPath)
+		})
+	}
 }
 
 func TestSendTestNotificationRoute_ScriptFailure(t *testing.T) {
+	for _, basePath := range basePathTestCases {
+		t.Run(fmt.Sprintf(`with basePath "%s"`, basePath), func(tt *testing.T) {
 			//setup
 			parentPath, _ := ioutil.TempDir("", "")
-	defer os.RemoveAll(parentPath)
+			mockCtrl := gomock.NewController(tt)
-	mockCtrl := gomock.NewController(t)
-	defer mockCtrl.Finish()
 			fakeConfig := mock_config.NewMockInterface(mockCtrl)
 			fakeConfig.EXPECT().GetString("web.database.location").AnyTimes().Return(path.Join(parentPath, "scrutiny_test.db"))
 			fakeConfig.EXPECT().GetString("web.src.frontend.path").AnyTimes().Return(parentPath)
-	fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return("").AnyTimes()
+			fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return(basePath).AnyTimes()
 			fakeConfig.EXPECT().GetStringSlice("notify.urls").AnyTimes().Return([]string{"script:///missing/path/on/disk"})
 			ae := web.AppEngine{
 				Config: fakeConfig,
@@ -236,11 +277,17 @@ func TestSendTestNotificationRoute_ScriptFailure(t *testing.T) {
 
 			//test
 			wr := httptest.NewRecorder()
-	req, _ := http.NewRequest("POST", "/api/health/notify", strings.NewReader("{}"))
+			req, _ := http.NewRequest("POST", basePath + "/api/health/notify", strings.NewReader("{}"))
 			router.ServeHTTP(wr, req)
 
 			//assert
-	require.Equal(t, 500, wr.Code)
+			require.Equal(tt, 500, wr.Code)
+
+			// tear down
+			mockCtrl.Finish()
+			os.RemoveAll(parentPath)
+		})
+	}
 }
 
 func TestSendTestNotificationRoute_ScriptSuccess(t *testing.T) {
@@ -268,15 +315,15 @@ func TestSendTestNotificationRoute_ScriptSuccess(t *testing.T) {
 }
 
 func TestSendTestNotificationRoute_ShoutrrrFailure(t *testing.T) {
+	for _, basePath := range basePathTestCases {
+		t.Run(fmt.Sprintf(`with basePath "%s"`, basePath), func(tt *testing.T) {
 			//setup
 			parentPath, _ := ioutil.TempDir("", "")
-	defer os.RemoveAll(parentPath)
+			mockCtrl := gomock.NewController(tt)
-	mockCtrl := gomock.NewController(t)
-	defer mockCtrl.Finish()
 			fakeConfig := mock_config.NewMockInterface(mockCtrl)
 			fakeConfig.EXPECT().GetString("web.database.location").AnyTimes().Return(path.Join(parentPath, "scrutiny_test.db"))
 			fakeConfig.EXPECT().GetString("web.src.frontend.path").AnyTimes().Return(parentPath)
-	fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return("").AnyTimes()
+			fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return(basePath).AnyTimes()
 			fakeConfig.EXPECT().GetStringSlice("notify.urls").AnyTimes().Return([]string{"discord://invalidtoken@channel"})
 			ae := web.AppEngine{
 				Config: fakeConfig,
@@ -285,52 +332,64 @@ func TestSendTestNotificationRoute_ShoutrrrFailure(t *testing.T) {
 
 			//test
 			wr := httptest.NewRecorder()
-	req, _ := http.NewRequest("POST", "/api/health/notify", strings.NewReader("{}"))
+			req, _ := http.NewRequest("POST", basePath + "/api/health/notify", strings.NewReader("{}"))
 			router.ServeHTTP(wr, req)
 
 			//assert
-	require.Equal(t, 500, wr.Code)
+			require.Equal(tt, 500, wr.Code)
+
+			// tear down
+			mockCtrl.Finish()
+			os.RemoveAll(parentPath)
+		})
+	}
 }
 
 func TestGetDevicesSummaryRoute_Nvme(t *testing.T) {
+	for _, basePath := range basePathTestCases {
+		t.Run(fmt.Sprintf(`with basePath "%s"`, basePath), func(tt *testing.T) {
 			//setup
 			parentPath, _ := ioutil.TempDir("", "")
-	defer os.RemoveAll(parentPath)
+			mockCtrl := gomock.NewController(tt)
-	mockCtrl := gomock.NewController(t)
-	defer mockCtrl.Finish()
 			fakeConfig := mock_config.NewMockInterface(mockCtrl)
 			fakeConfig.EXPECT().GetString("web.database.location").AnyTimes().Return(path.Join(parentPath, "scrutiny_test.db"))
 			fakeConfig.EXPECT().GetString("web.src.frontend.path").AnyTimes().Return(parentPath)
-	fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return("").AnyTimes()
+			fakeConfig.EXPECT().GetString("web.src.backend.basepath").Return(basePath).AnyTimes()
 			ae := web.AppEngine{
 				Config: fakeConfig,
 			}
 			router := ae.Setup(logrus.New())
 			devicesfile, err := os.Open("testdata/register-devices-req-2.json")
-	require.NoError(t, err)
+			require.NoError(tt, err)
 
 			metricsfile, err := os.Open("../models/testdata/smart-nvme2.json")
-	require.NoError(t, err)
+			require.NoError(tt, err)
 
 			//test
 			wr := httptest.NewRecorder()
-	req, _ := http.NewRequest("POST", "/api/devices/register", devicesfile)
+			req, _ := http.NewRequest("POST", basePath + "/api/devices/register", devicesfile)
 			router.ServeHTTP(wr, req)
-	require.Equal(t, 200, wr.Code)
+			require.Equal(tt, 200, wr.Code)
 
 			mr := httptest.NewRecorder()
-	req, _ = http.NewRequest("POST", "/api/device/a4c8e8ed-11a0-4c97-9bba-306440f1b944/smart", metricsfile)
+			req, _ = http.NewRequest("POST", basePath + "/api/device/a4c8e8ed-11a0-4c97-9bba-306440f1b944/smart", metricsfile)
 			router.ServeHTTP(mr, req)
-	require.Equal(t, 200, mr.Code)
+			require.Equal(tt, 200, mr.Code)
 
 			sr := httptest.NewRecorder()
-	req, _ = http.NewRequest("GET", "/api/summary", nil)
+			req, _ = http.NewRequest("GET", basePath + "/api/summary", nil)
 			router.ServeHTTP(sr, req)
 			require.Equal(t, 200, sr.Code)
 			var device dbModels.DeviceWrapper
 			json.Unmarshal(sr.Body.Bytes(), &device)
 
 			//assert
-	require.Equal(t, "a4c8e8ed-11a0-4c97-9bba-306440f1b944", device.Data[0].WWN)
+			require.Equal(tt, "a4c8e8ed-11a0-4c97-9bba-306440f1b944", device.Data[0].WWN)
-	require.Equal(t, "passed", device.Data[0].SmartResults[0].SmartStatus)
+			require.Equal(tt, "passed", device.Data[0].SmartResults[0].SmartStatus)
+
+			// tear down
+			mockCtrl.Finish()
+			os.RemoveAll(parentPath)
+		})
+	}
 }