Remove boolean from parameters

Author: tataruty

tests/framework/logging.go

@@ -0,0 +1,13 @@
+package framework
+
+type Option func(*Options)
+
+type Options struct {
+	logEnabled bool
+}
+
+func WithLoggingDisabled() Option {
+	return func(opts *Options) {
+		opts.logEnabled = false
+	}
+}

tests/framework/prometheus.go

@@ -458,7 +458,7 @@ func CreateEndTimeFinder(
 // CreateResponseChecker returns a function that checks if there is a successful response from a url.
 func CreateResponseChecker(url, address string, requestTimeout time.Duration) func() error {
 	return func() error {
-		status, _, err := Get(url, address, requestTimeout, nil, nil, true)
+		status, _, err := Get(url, address, requestTimeout, nil, nil)
 		if err != nil {
 			return fmt.Errorf("bad response: %w", err)
 		}

tests/framework/request.go

@@ -22,11 +22,16 @@ func Get(
 	url, address string,
 	timeout time.Duration,
 	headers, queryParams map[string]string,
-	logging bool,
+	opts ...Option,
 ) (int, string, error) {
-	resp, err := makeRequest(http.MethodGet, url, address, nil, timeout, headers, queryParams, logging)
+	options := &Options{logEnabled: true}
+	for _, opt := range opts {
+		opt(options)
+	}
+
+	resp, err := makeRequest(http.MethodGet, url, address, nil, timeout, headers, queryParams, opts...)
 	if err != nil {
-		if logging {
+		if options.logEnabled {
 			GinkgoWriter.Printf(
 				"ERROR occurred during getting response, error: %s\nReturning status: 0, body: ''\n",
 				err,
@@ -43,7 +48,7 @@ func Get(
 		GinkgoWriter.Printf("ERROR in Body content: %v returning body: ''\n", err)
 		return resp.StatusCode, "", err
 	}
-	if logging {
+	if options.logEnabled {
 		GinkgoWriter.Printf("Successfully received response and parsed body: %s\n", body.String())
 	}
 
@@ -58,7 +63,7 @@ func Post(
 	timeout time.Duration,
 	headers, queryParams map[string]string,
 ) (*http.Response, error) {
-	response, err := makeRequest(http.MethodPost, url, address, body, timeout, headers, queryParams, true)
+	response, err := makeRequest(http.MethodPost, url, address, body, timeout, headers, queryParams)
 	if err != nil {
 		GinkgoWriter.Printf("ERROR occurred during getting response, error: %s\n", err)
 	}
@@ -71,7 +76,7 @@ func makeRequest(
 	body io.Reader,
 	timeout time.Duration,
 	headers, queryParams map[string]string,
-	logging bool,
+	opts ...Option,
 ) (*http.Response, error) {
 	dialer := &net.Dialer{}
 
@@ -94,7 +99,12 @@ func makeRequest(
 	ctx, cancel := context.WithTimeout(context.Background(), timeout)
 	defer cancel()
 
-	if logging {
+	options := &Options{logEnabled: true}
+
+	for _, opt := range opts {
+		opt(options)
+	}
+	if options.logEnabled {
 		requestDetails := fmt.Sprintf(
 			"Method: %s, URL: %s, Address: %s, Headers: %v, QueryParams: %v\n",
 			strings.ToUpper(method),

tests/suite/advanced_routing_test.go

@@ -117,10 +117,8 @@ func expectRequestToRespondFromExpectedServer(
 	headers, queryParams map[string]string,
 ) error {
 	GinkgoWriter.Printf("Expecting request to respond from the server %q\n", expServerName)
-	status, body, err := framework.Get(appURL, address, timeoutConfig.RequestTimeout, headers, queryParams, true)
+	status, body, err := framework.Get(appURL, address, timeoutConfig.RequestTimeout, headers, queryParams)
 	if err != nil {
-		GinkgoWriter.Printf("ERROR making GET request to %q: %v\n", appURL, err)
-
 		return err
 	}
 

tests/suite/graceful_recovery_test.go

@@ -518,7 +518,7 @@ var _ = Describe("Graceful Recovery test", Ordered, FlakeAttempts(2), Label("gra
 })
 
 func expectRequestToSucceed(appURL, address string, responseBodyMessage string) error {
-	status, body, err := framework.Get(appURL, address, timeoutConfig.RequestTimeout, nil, nil, true)
+	status, body, err := framework.Get(appURL, address, timeoutConfig.RequestTimeout, nil, nil)
 
 	if status != http.StatusOK {
 		return fmt.Errorf("http status was not 200, got %d: %w", status, err)
@@ -540,7 +540,7 @@ func expectRequestToSucceed(appURL, address string, responseBodyMessage string)
 // We only want an error returned from this particular function if it does not appear that NGINX has
 // stopped serving traffic.
 func expectRequestToFail(appURL, address string) error {
-	status, body, err := framework.Get(appURL, address, timeoutConfig.RequestTimeout, nil, nil, true)
+	status, body, err := framework.Get(appURL, address, timeoutConfig.RequestTimeout, nil, nil)
 	if status != 0 {
 		return errors.New("expected http status to be 0")
 	}

tests/suite/sample_test.go

@@ -61,7 +61,7 @@ var _ = Describe("Basic test example", Label("functional"), func() {
 
 		Eventually(
 			func() error {
-				status, body, err := framework.Get(url, address, timeoutConfig.RequestTimeout, nil, nil, true)
+				status, body, err := framework.Get(url, address, timeoutConfig.RequestTimeout, nil, nil)
 				if err != nil {
 					return err
 				}

tests/suite/tracing_test.go

@@ -131,7 +131,14 @@ var _ = Describe("Tracing", FlakeAttempts(2), Ordered, Label("functional", "trac
 		for range count {
 			Eventually(
 				func() error {
-					status, _, err := framework.Get(url, address, timeoutConfig.RequestTimeout, nil, nil, false)
+					status, _, err := framework.Get(
+						url,
+						address,
+						timeoutConfig.RequestTimeout,
+						nil,
+						nil,
+						framework.WithLoggingDisabled(),
+					)
 					if err != nil {
 						return err
 					}