feat: separate framework

Signed-off-by: ashing <[email protected]>

Author: ronething

go.mod

@@ -7,6 +7,7 @@ toolchain go1.22.5
 require (
 	github.com/Masterminds/sprig/v3 v3.2.3
 	github.com/api7/gopkg v0.2.1-0.20230601092738-0f3730f9b57a
+	github.com/bytedance/sonic/loader v0.2.4
 	github.com/gavv/httpexpect v2.0.0+incompatible
 	github.com/gavv/httpexpect/v2 v2.16.0
 	github.com/go-logr/logr v1.4.2
@@ -28,13 +29,15 @@ require (
 	go.uber.org/zap v1.27.0
 	golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56
 	golang.org/x/net v0.28.0
+	google.golang.org/appengine v1.6.7
 	gopkg.in/yaml.v2 v2.4.0
 	gorm.io/gorm v1.25.11
 	helm.sh/helm/v3 v3.15.4
 	k8s.io/api v0.31.1
 	k8s.io/apiextensions-apiserver v0.31.1
 	k8s.io/apimachinery v0.31.1
 	k8s.io/client-go v0.31.1
+	k8s.io/kubectl v0.30.3
 	k8s.io/utils v0.0.0-20240711033017-18e509b52bc8
 	sigs.k8s.io/controller-runtime v0.19.0
 	sigs.k8s.io/gateway-api v1.2.0
@@ -192,6 +195,7 @@ require (
 	go.opentelemetry.io/otel/trace v1.28.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.3.1 // indirect
 	go.starlark.net v0.0.0-20230525235612-a134d8f9ddca // indirect
+	go.uber.org/goleak v1.3.0 // indirect
 	golang.org/x/arch v0.6.0 // indirect
 	golang.org/x/crypto v0.26.0 // indirect
 	golang.org/x/mod v0.20.0 // indirect
@@ -217,7 +221,6 @@ require (
 	k8s.io/component-base v0.31.1 // indirect
 	k8s.io/klog/v2 v2.130.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20240430033511-f0e62f92d13f // indirect
-	k8s.io/kubectl v0.30.3 // indirect
 	moul.io/http2curl/v2 v2.3.0 // indirect
 	oras.land/oras-go v1.2.5 // indirect
 	sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.30.3 // indirect

go.sum

@@ -10,28 +10,26 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package framework
+package apisix
 
 import (
-	_ "embed"
-	"encoding/json"
+	"fmt"
+	"testing"
 
-	"github.com/stretchr/testify/assert"
-)
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 
-func (f *Framework) UploadLicense() {
-	payload := map[string]any{"data": API7EELicense}
-	payloadBytes, err := json.Marshal(payload)
-	assert.Nil(f.GinkgoT, err)
+	"github.com/apache/apisix-ingress-controller/test/e2e/framework"
+)
 
-	respExpect := f.DashboardHTTPClient().PUT("/api/license").
-		WithBasicAuth("admin", "admin").
-		WithHeader("Content-Type", "application/json").
-		WithBytes(payloadBytes).
-		Expect()
+// TestAPISIXE2E runs e2e tests using the APISIX standalone mode
+func TestAPISIXE2E(t *testing.T) {
+	RegisterFailHandler(Fail)
+	// init framework
+	_ = framework.NewFramework()
 
-	body := respExpect.Body().Raw()
-	f.Logf("request /api/license, response body: %s", body)
+	// TODO: init newDeployer function
 
-	respExpect.Status(200)
+	_, _ = fmt.Fprintf(GinkgoWriter, "Starting APISIX standalone e2e suite\n")
+	RunSpecs(t, "apisix standalone e2e suite")
 }

test/e2e/framework/license.go renamed to test/e2e/apisix/e2e_test.go

@@ -16,6 +16,15 @@ import (
 	_ "embed"
 )
 
+const (
+	postgres     = "postgres"
+	oceanbase    = "oceanbase"
+	mysql        = "mysql"
+	postgresDSN  = "postgres://api7ee:changeme@api7-postgresql:5432/api7ee"
+	oceanbaseDSN = "mysql://root@tcp(oceanbase:2881)/api7ee"
+	mysqlDSN     = "mysql://root:changeme@tcp(mysql:3306)/api7ee"
+)
+
 const (
 	DashboardEndpoint    = "http://api7ee3-dashboard.api7-ee-e2e:7080"
 	DashboardTLSEndpoint = "https://api7ee3-dashboard.api7-ee-e2e:7443"

test/e2e/framework/consts.go renamed to test/e2e/framework/api7_consts.go

@@ -13,46 +13,32 @@
 package framework
 
 import (
-	"bytes"
 	_ "embed"
 	"encoding/json"
 	"fmt"
+	"github.com/gavv/httpexpect/v2"
+	"net/http"
+	"net/url"
 	"os"
+	"strings"
 	"text/template"
-	"time"
 
-	"github.com/api7/gopkg/pkg/log"
 	"github.com/google/uuid"
 	. "github.com/onsi/gomega"
-	"golang.org/x/net/html"
-	"helm.sh/helm/v3/pkg/action"
-	"helm.sh/helm/v3/pkg/chart/loader"
-	"helm.sh/helm/v3/pkg/cli"
-	"helm.sh/helm/v3/pkg/kube"
-	"k8s.io/apimachinery/pkg/util/yaml"
 
 	v1 "github.com/apache/apisix-ingress-controller/api/dashboard/v1"
 )
 
 var (
-	API7EELicense string
-
 	valuesTemplate *template.Template
-
-	dashboardVersion string
+	_db            string
 )
 
 func init() {
-	API7EELicense = os.Getenv("API7_EE_LICENSE")
-	if API7EELicense == "" {
-		panic("env {API7_EE_LICENSE} is required")
+	_db = os.Getenv("DB")
+	if _db == "" {
+		_db = postgres
 	}
-
-	dashboardVersion = os.Getenv("DASHBOARD_VERSION")
-	if dashboardVersion == "" {
-		dashboardVersion = "dev"
-	}
-
 	tmpl, err := template.New("values.yaml").Parse(`
 dashboard:
   image:
@@ -258,116 +244,54 @@ api_usage:
 	valuesTemplate = tmpl
 }
 
-type responseCreateGateway struct {
-	Value    responseCreateGatewayValue `json:"value"`
-	ErrorMsg string                     `json:"error_msg"`
-}
+// DatabaseConfig is the database related configuration entrypoint.
+type DatabaseConfig struct {
+	DSN string `json:"dsn" yaml:"dsn" mapstructure:"dsn"`
 
-type responseCreateGatewayValue struct {
-	ID             string `json:"id"`
-	TokenPlainText string `json:"token_plain_text"`
-	Key            string `json:"key"`
+	MaxOpenConns int `json:"max_open_conns" yaml:"max_open_conns" mapstructure:"max_open_conns"`
+	MaxIdleConns int `json:"max_idle_conns" yaml:"max_idle_conns" mapstructure:"max_idle_conns"`
 }
 
-func (f *Framework) deploy() {
-	debug := func(format string, v ...any) {
-		log.Infof(format, v...)
-	}
-
-	kubeConfigPath := os.Getenv("KUBECONFIG")
-	actionConfig := new(action.Configuration)
-
-	err := actionConfig.Init(
-		kube.GetConfig(kubeConfigPath, "", f.kubectlOpts.Namespace),
-		f.kubectlOpts.Namespace,
-		"memory",
-		debug,
-	)
-	f.GomegaT.Expect(err).ShouldNot(HaveOccurred(), "init helm action config")
-
-	install := action.NewInstall(actionConfig)
-	install.Namespace = f.kubectlOpts.Namespace
-	install.ReleaseName = "api7ee3"
-
-	chartPath, err := install.LocateChart("api7/api7ee3", cli.New())
-	f.GomegaT.Expect(err).ShouldNot(HaveOccurred(), "locate helm chart")
-
-	chart, err := loader.Load(chartPath)
-	f.GomegaT.Expect(err).ShouldNot(HaveOccurred(), "load helm chart")
-
-	buf := bytes.NewBuffer(nil)
-	_ = valuesTemplate.Execute(buf, map[string]any{
-		"DB":  _db,
-		"DSN": getDSN(),
-		"Tag": dashboardVersion,
-	})
-
-	var v map[string]any
-	err = yaml.Unmarshal(buf.Bytes(), &v)
-	f.GomegaT.Expect(err).ShouldNot(HaveOccurred(), "unmarshal values")
-	_, err = install.Run(chart, v)
-	f.GomegaT.Expect(err).ShouldNot(HaveOccurred(), "install dashboard")
-
-	err = f.ensureService("api7ee3-dashboard", _namespace, 1)
-	f.GomegaT.Expect(err).ShouldNot(HaveOccurred(), "ensuring dashboard service")
-
-	err = f.ensureService("api7-postgresql", _namespace, 1)
-	f.GomegaT.Expect(err).ShouldNot(HaveOccurred(), "ensuring postgres service")
-
-	err = f.ensureService("api7-prometheus-server", _namespace, 1)
-	f.GomegaT.Expect(err).ShouldNot(HaveOccurred(), "ensuring prometheus-server service")
+type LogOptions struct {
+	// Level is the minimum logging level that a logging message should have
+	// to output itself.
+	Level string `json:"level" yaml:"level"`
+	// Output defines the destination file path to output logging messages.
+	// Two keywords "stderr" and "stdout" can be specified so that message will
+	// be written to stderr or stdout.
+	Output string `json:"output" yaml:"output"`
 }
 
-func (f *Framework) initDashboard() {
-	f.deletePods("app.kubernetes.io/name=api7ee3")
-	time.Sleep(5 * time.Second)
+func (conf *DatabaseConfig) GetType() string {
+	parts := strings.SplitN(conf.DSN, "://", 2)
+	if len(parts) > 1 {
+		return parts[0]
+	}
+	return ""
 }
 
-// ParseHTML will parse the doc from login page and generate a map contains id and action.
-func (f *Framework) ParseHTML(doc *html.Node) map[string]string {
-	var fu func(*html.Node)
-	htmlMap := make(map[string]string)
-	fu = func(n *html.Node) {
-		var (
-			name  string
-			value string
-		)
-		for _, attr := range n.Attr {
-			if attr.Key == "id" || attr.Key == "name" {
-				name = attr.Val
-			}
-			if attr.Key == "action" || attr.Key == "value" {
-				value = attr.Val
-			}
-
-			htmlMap[name] = value
-		}
-
-		for c := n.FirstChild; c != nil; c = c.NextSibling {
-			fu(c)
-		}
+//nolint:unused
+func getDSN() string {
+	switch _db {
+	case postgres:
+		return postgresDSN
+	case oceanbase:
+		return oceanbaseDSN
+	case mysql:
+		return mysqlDSN
 	}
-	fu(doc)
-
-	return htmlMap
+	panic("unknown database")
 }
 
-func (f *Framework) GetTokenFromDashboard(gatewayGroupID string) (string, error) {
-	respExp := f.DashboardHTTPClient().
-		POST("/api/gateway_groups/"+gatewayGroupID+"/instance_token").
-		WithHeader("Content-Type", "application/json").
-		WithBasicAuth("admin", "admin").
-		Expect()
+type responseCreateGateway struct {
+	Value    responseCreateGatewayValue `json:"value"`
+	ErrorMsg string                     `json:"error_msg"`
+}
 
-	respExp.Status(200).Body().Contains("token_plain_text")
-	body := respExp.Body().Raw()
-	// unmarshal into responseCreateGateway
-	var response responseCreateGateway
-	err := json.Unmarshal([]byte(body), &response)
-	if err != nil {
-		return "", err
-	}
-	return response.Value.TokenPlainText, nil
+type responseCreateGatewayValue struct {
+	ID             string `json:"id"`
+	TokenPlainText string `json:"token_plain_text"`
+	Key            string `json:"key"`
 }
 
 func (f *Framework) GetDataplaneCertificates(gatewayGroupID string) *v1.DataplaneCertificate {
@@ -461,3 +385,66 @@ func (f *Framework) CreateNewGatewayGroupWithIngressE() (string, error) {
 	}
 	return response.Value.ID, nil
 }
+
+func (f *Framework) setDpManagerEndpoints() {
+	payload := []byte(fmt.Sprintf(`{"control_plane_address":["%s"]}`, DPManagerTLSEndpoint))
+
+	respExp := f.DashboardHTTPClient().
+		PUT("/api/system_settings").
+		WithBasicAuth("admin", "admin").
+		WithHeader("Content-Type", "application/json").
+		WithBytes(payload).
+		Expect()
+
+	respExp.Raw()
+	f.Logf("set dp manager endpoints response: %s", respExp.Body().Raw())
+
+	respExp.Status(200).
+		Body().Contains("control_plane_address")
+}
+
+func (f *Framework) GetDashboardEndpoint() string {
+	return f.dashboardHTTPTunnel.Endpoint()
+}
+
+func (f *Framework) GetDashboardEndpointHTTPS() string {
+	return f.dashboardHTTPSTunnel.Endpoint()
+}
+
+func (f *Framework) DashboardHTTPClient() *httpexpect.Expect {
+	u := url.URL{
+		Scheme: "http",
+		Host:   f.GetDashboardEndpoint(),
+	}
+	return httpexpect.WithConfig(httpexpect.Config{
+		BaseURL: u.String(),
+		Client: &http.Client{
+			Transport: &http.Transport{},
+			CheckRedirect: func(req *http.Request, via []*http.Request) error {
+				return http.ErrUseLastResponse
+			},
+		},
+		Reporter: httpexpect.NewAssertReporter(
+			httpexpect.NewAssertReporter(f.GinkgoT),
+		),
+	})
+}
+
+func (f *Framework) DashboardHTTPSClient() *httpexpect.Expect {
+	u := url.URL{
+		Scheme: "https",
+		Host:   f.GetDashboardEndpointHTTPS(),
+	}
+	return httpexpect.WithConfig(httpexpect.Config{
+		BaseURL: u.String(),
+		Client: &http.Client{
+			Transport: &http.Transport{},
+			CheckRedirect: func(req *http.Request, via []*http.Request) error {
+				return http.ErrUseLastResponse
+			},
+		},
+		Reporter: httpexpect.NewAssertReporter(
+			httpexpect.NewAssertReporter(f.GinkgoT),
+		),
+	})
+}