Testing: move tests into black box scope

gateway/analytics_go_plugin_test.go

@@ -1,4 +1,4 @@
-package gateway
+package gateway_test
 
 import (
 	"net/http"

gateway/api_definition_test.go

@@ -871,7 +871,7 @@ func TestSyncAPISpecsDashboardSuccess(t *testing.T) {
 			t.Fatalf("want %q, got %q", want, got)
 		}
 	}
-	ts.Gw.handleRedisEvent(&msg, handled, wg.Done)
+	ts.Gw.HandleRedisEvent(&msg, handled, wg.Done)
 
 	ts.Gw.ReloadTestCase.TickOk(t)
 	// Wait for the reload to finish, then check it worked
@@ -1222,7 +1222,7 @@ func TestSyncAPISpecsDashboardJSONFailure(t *testing.T) {
 			t.Fatalf("want %q, got %q", want, got)
 		}
 	}
-	ts.Gw.handleRedisEvent(&msg, handled, wg.Done)
+	ts.Gw.HandleRedisEvent(&msg, handled, wg.Done)
 
 	ts.Gw.ReloadTestCase.TickOk(t)
 
@@ -1239,7 +1239,7 @@ func TestSyncAPISpecsDashboardJSONFailure(t *testing.T) {
 	var wg2 sync.WaitGroup
 	wg2.Add(1)
 	ts.Gw.ReloadTestCase.Reset()
-	ts.Gw.handleRedisEvent(&msg, handled, wg2.Done)
+	ts.Gw.HandleRedisEvent(&msg, handled, wg2.Done)
 
 	ts.Gw.ReloadTestCase.TickOk(t)
 	// Wait for the reload to finish, then check it worked

gateway/api_test.go

@@ -30,6 +30,7 @@ import (
 	"github.com/TykTechnologies/tyk/apidef/oas"
 	"github.com/TykTechnologies/tyk/certs"
 	"github.com/TykTechnologies/tyk/config"
+	"github.com/TykTechnologies/tyk/ctx"
 	"github.com/TykTechnologies/tyk/internal/uuid"
 	"github.com/TykTechnologies/tyk/storage"
 	"github.com/TykTechnologies/tyk/test"
@@ -963,7 +964,7 @@ func TestDisableKeyActionsByUserName(t *testing.T) {
 	ts := StartTest(conf)
 	defer ts.Close()
 
-	session := ts.testPrepareBasicAuth(false)
+	session := ts.TestPrepareBasicAuth(false)
 	userName := "defaultuser1"
 	res, _ := ts.Run(t, []test.TestCase{
 		{
@@ -1042,7 +1043,7 @@ func TestHashKeyHandlerLegacyWithHashFunc(t *testing.T) {
 	ts.Gw.SetConfig(globalConf)
 
 	// create session with legacy key format
-	session := ts.testPrepareBasicAuth(false)
+	session := ts.TestPrepareBasicAuth(false)
 
 	_, _ = ts.Run(t, []test.TestCase{
 		{
@@ -1207,7 +1208,7 @@ func (ts *Test) testHashKeyHandlerHelper(t *testing.T, expectedHashSize int) {
 
 func (ts *Test) testHashFuncAndBAHelper(t *testing.T) {
 	t.Helper()
-	session := ts.testPrepareBasicAuth(false)
+	session := ts.TestPrepareBasicAuth(false)
 
 	_, _ = ts.Run(t, []test.TestCase{
 		{
@@ -1953,7 +1954,7 @@ func TestContextSession(t *testing.T) {
 		t.Fatal("expected ctxGetSession to return nil")
 	}
 
-	ctxSetSession(r,
+	ctx.SetSession(r,
 		&user.SessionState{},
 		false,
 		false)
@@ -1963,10 +1964,10 @@ func TestContextSession(t *testing.T) {
 	}
 	defer func() {
 		if r := recover(); r == nil {
-			t.Fatal("expected ctxSetSession of zero val to panic")
+			t.Fatal("expected ctx.SetSession of zero val to panic")
 		}
 	}()
-	ctxSetSession(r, nil, false, false)
+	ctx.SetSession(r, nil, false, false)
 }
 
 func TestRotateClientSecretHandler(t *testing.T) {

gateway/auth_manager_test.go

@@ -13,6 +13,7 @@ import (
 
 	"github.com/TykTechnologies/tyk/certs"
 	"github.com/TykTechnologies/tyk/config"
+	"github.com/TykTechnologies/tyk/internal/httputil"
 
 	"github.com/TykTechnologies/tyk/header"
 
@@ -221,7 +222,7 @@ func TestHashKeyFunctionChanged(t *testing.T) {
 			Code:      http.StatusOK,
 		})
 
-		authHeader := map[string]string{"Authorization": genAuthHeader("user", "password")}
+		authHeader := map[string]string{"Authorization": httputil.AuthHeader("user", "password")}
 
 		testChangeHashFunc(t, authHeader, client, http.StatusUnauthorized)
 

gateway/batch_requests_test.go

@@ -13,11 +13,10 @@ import (
 	"sync/atomic"
 	"testing"
 
-	"github.com/TykTechnologies/tyk/certs"
-
 	"github.com/valyala/fasthttp"
 
 	"github.com/TykTechnologies/tyk/apidef"
+	"github.com/TykTechnologies/tyk/certs"
 	"github.com/TykTechnologies/tyk/test"
 )
 

gateway/blackbox_test.go

@@ -0,0 +1,101 @@
+package gateway_test
+
+import (
+	"net/http"
+
+	"github.com/TykTechnologies/tyk/ctx"
+	"github.com/TykTechnologies/tyk/gateway"
+)
+
+// These are symbol shims from the gateway package to make life easier.
+// It's all test symbols that have leaked into the package API.
+type (
+	// Gateway is the service object.
+	Gateway             = gateway.Gateway
+	ReverseProxy        = gateway.ReverseProxy
+	APIDefinitionLoader = gateway.APIDefinitionLoader
+
+	// Middlewares used by tests explicitly
+	BaseMiddleware              = gateway.BaseMiddleware
+	TransformMiddleware         = gateway.TransformMiddleware
+	ResponseTransformMiddleware = gateway.ResponseTransformMiddleware
+	ResponseCacheMiddleware     = gateway.ResponseCacheMiddleware
+	ResponseGoPluginMiddleware  = gateway.ResponseGoPluginMiddleware
+	IPWhiteListMiddleware       = gateway.IPWhiteListMiddleware
+	IPBlackListMiddleware       = gateway.IPBlackListMiddleware
+	// Slight naming violation
+	MiddlewareContextVars = gateway.MiddlewareContextVars
+
+	// Tests leakage.
+	Test             = gateway.Test
+	TestConfig       = gateway.TestConfig
+	TestHttpResponse = gateway.TestHttpResponse
+	TraceHttpRequest = gateway.TraceHttpRequest
+
+	// Data model.
+	APISpec                = gateway.APISpec
+	TransformSpec          = gateway.TransformSpec
+	HostHealthReport       = gateway.HostHealthReport
+	HostCheckCallBacks     = gateway.HostCheckCallBacks
+	NotificationCommand    = gateway.NotificationCommand
+	Notification           = gateway.Notification
+	GraphQLRequest         = gateway.GraphQLRequest
+	OASSchemaResponse      = gateway.OASSchemaResponse
+	HeaderTransform        = gateway.HeaderTransform
+	HeaderTransformOptions = gateway.HeaderTransformOptions
+	VersionMetas           = gateway.VersionMetas
+	HeaderInjector         = gateway.HeaderInjector
+	TransformHeaders       = gateway.TransformHeaders
+
+	// Interfaces (data model).
+	IdExtractor            = gateway.IdExtractor
+	WebHookHandler         = gateway.WebHookHandler
+	HTTPDashboardHandler   = gateway.HTTPDashboardHandler
+	BaseTykResponseHandler = gateway.BaseTykResponseHandler
+)
+
+// Constants are a coupling (data model).
+const (
+	TestHttpAny   = gateway.TestHttpAny
+	EH_LogHandler = gateway.EH_LogHandler
+	EH_WebHook    = gateway.EH_WebHook
+
+	NoticeGroupReload    = gateway.NoticeGroupReload
+	CachedResponseHeader = gateway.CachedResponseHeader
+)
+
+// Global functions are a coupling.
+var (
+	BuildAPI    = gateway.BuildAPI
+	BuildOASAPI = gateway.BuildOASAPI
+
+	StartTest    = gateway.StartTest
+	InitTestMain = gateway.InitTestMain
+
+	CreateSession         = gateway.CreateSession
+	CreateStandardSession = gateway.CreateStandardSession
+
+	GetTLSClient     = gateway.GetTLSClient
+	MockOrgID        = gateway.MockOrgID
+	UpdateAPIVersion = gateway.UpdateAPIVersion
+	TransformBody    = gateway.TransformBody
+	TestReq          = gateway.TestReq
+)
+
+// Alas, we have some internals.
+var (
+	proxyOnErrorEnabled = true
+	keylessAuthEnabled  = true
+	cacheEnabled        = true
+
+	proxyOnErrorDisabled = false
+	keylessAuthDisabled  = false
+	cacheDisabled        = false
+)
+
+func ctxGetData(r *http.Request) map[string]interface{} {
+	if v := r.Context().Value(ctx.ContextData); v != nil {
+		return v.(map[string]interface{})
+	}
+	return nil
+}

gateway/cert_test.go

@@ -22,19 +22,16 @@
 	"github.com/stretchr/testify/assert"
 	"go.uber.org/mock/gomock"
 
-	"github.com/TykTechnologies/tyk/certs/mock"
-
-	"github.com/TykTechnologies/tyk/internal/crypto"
-
-	"github.com/TykTechnologies/tyk/header"
-	"github.com/TykTechnologies/tyk/storage"
-
-	"github.com/TykTechnologies/tyk/user"
-
 	"github.com/TykTechnologies/tyk/apidef"
 	"github.com/TykTechnologies/tyk/certs"
+	"github.com/TykTechnologies/tyk/certs/mock"
 	"github.com/TykTechnologies/tyk/config"
+	"github.com/TykTechnologies/tyk/header"
+	"github.com/TykTechnologies/tyk/internal/crypto"
+	"github.com/TykTechnologies/tyk/internal/httputil"
+	"github.com/TykTechnologies/tyk/storage"
 	"github.com/TykTechnologies/tyk/test"
+	"github.com/TykTechnologies/tyk/user"
 )
 
 const (
@@ -1585,7 +1582,7 @@
 	assert.NoError(t, err)
 	defer ls.Close()
 
-	go listenProxyProto(ls)
+	go httputil.TestListenProxyProto(ls)
 
 	certID, err := ts.Gw.CertificateManager.Add(combinedUpstreamCertPEM, "")
 	defer ts.Gw.CertificateManager.Delete(certID, "")
@@ -1641,7 +1638,7 @@
 	assert.NoError(t, err)
 	defer upstream.Close()
 
-	go listenProxyProto(upstream)
+	go httputil.TestListenProxyProto(upstream)
 
 	// tyk
 	_, _, tykServerCombinedPEM, _ := crypto.GenServerCertificate()

gateway/coprocess_bundle_test.go

@@ -22,10 +22,6 @@ import (
 	"github.com/TykTechnologies/tyk/test"
 )
 
-var (
-	testBundlesPath = filepath.Join(testMiddlewarePath, "bundles")
-)
-
 func pkgPath() string {
 	_, filename, _, _ := runtime.Caller(0)
 	return filepath.Dir(filename) + "./.."
@@ -81,6 +77,8 @@ func TestBundleLoader(t *testing.T) {
 	})
 
 	t.Run("Existing bundle with auth check", func(t *testing.T) {
+		testBundlesPath := filepath.Join(ts.Gw.GetConfig().MiddlewarePath, "bundles")
+
 		spec := &APISpec{
 			APIDefinition: &apidef.APIDefinition{
 				CustomMiddlewareBundle: bundleID,

gateway/dashboard_register.go

@@ -117,10 +117,10 @@ func (gw *Gateway) reLogin() {
 }
 
 func (h *HTTPDashboardHandler) Init() error {
-	h.RegistrationEndpoint = h.Gw.buildDashboardConnStr("/register/node")
-	h.DeRegistrationEndpoint = h.Gw.buildDashboardConnStr("/system/node")
-	h.HeartBeatEndpoint = h.Gw.buildDashboardConnStr("/register/ping")
-	h.KeyQuotaTriggerEndpoint = h.Gw.buildDashboardConnStr("/system/key/quota_trigger")
+	h.RegistrationEndpoint = h.Gw.BuildDashboardConnStr("/register/node")
+	h.DeRegistrationEndpoint = h.Gw.BuildDashboardConnStr("/system/node")
+	h.HeartBeatEndpoint = h.Gw.BuildDashboardConnStr("/register/ping")
+	h.KeyQuotaTriggerEndpoint = h.Gw.BuildDashboardConnStr("/system/key/quota_trigger")
 
 	if h.Secret = h.Gw.GetConfig().NodeSecret; h.Secret == "" {
 		dashLog.Fatal("Node secret is not set, required for dashboard connection")

gateway/dashboard_register_test.go

@@ -1,4 +1,4 @@
-package gateway
+package gateway_test
 
 import (
 	"testing"
@@ -24,29 +24,7 @@ func Test_BuildDashboardConnStr(t *testing.T) {
 		ts.Gw.SetConfig(cfg)
 	}()
 
-	connStr := ts.Gw.buildDashboardConnStr("/test")
+	connStr := ts.Gw.BuildDashboardConnStr("/test")
 
 	assert.Equal(t, connStr, "http://localhost/test")
 }
-
-func Test_DashboardLifecycle(t *testing.T) {
-	var handler HTTPDashboardHandler
-
-	handler = HTTPDashboardHandler{
-		heartBeatStopSentinel: HeartBeatStarted,
-	}
-	assert.False(t, handler.isHeartBeatStopped())
-
-	handler = HTTPDashboardHandler{
-		heartBeatStopSentinel: HeartBeatStopped,
-	}
-
-	assert.True(t, handler.isHeartBeatStopped())
-
-	handler = HTTPDashboardHandler{
-		heartBeatStopSentinel: HeartBeatStarted,
-	}
-
-	handler.StopBeating()
-	assert.True(t, handler.isHeartBeatStopped())
-}