Adding logging to functional tests

[tataruty]

Proposed changes

Problem: As a developer of NGF
I want the NFR and functional tests to log as they execute
So I can more easily debug a failure when it occurs.

Solution: - Log statements are added to all non-functional and functional tests to include assertions, requests, responses, and anywhere there is a chance for an error to occur.

Testing: Tested with Plus and without, compared failures output with new logging and without

Closes #2449

Checklist

Before creating a PR, run through this checklist and mark each as complete.

• I have read the CONTRIBUTING doc
• I have added tests that prove my fix is effective or that my feature works
• I have checked that all unit tests pass after adding my changes
• I have updated necessary documentation
• I have rebased my branch onto main
• I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

NONE

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.99%. Comparing base (9406f12) to head (0125c08).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3781   +/-   ##
=======================================
  Coverage   86.99%   86.99%           
=======================================
  Files         128      128           
  Lines       16434    16434           
  Branches       62       62           
=======================================
  Hits        14297    14297           
  Misses       1960     1960           
  Partials      177      177           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[sjberman]

Why is this boolean needed? In general, passing booleans to a function is frowned upon because it can be ambiguous from a caller perspective. It also makes a function do multiple things if a boolean is passed, versus the ideal scenario where each function has one purpose.

[tataruty]

i didn't want it, but i cannot find other way to stop printing logs in some scenarious, in all scenarious it is very useful, but there is a case in tracing_test:

		sendRequests(helloURL, 25)
		sendRequests(worldURL, 25)
		sendRequests(helloworldURL, 25)

That looks like a noise when there is 75 times printed request and 75 times printed received body.
Do you think it is ok to leave this long log then? In all other cases it is printed only once and is informative
so. now, for exact this scenario with bool parameter i can minimize it to the next view, since i don't see any use in seeing details on those requests

[sjberman]

You could do something like the following which can enable logging in a clearer way, and only need to update the function call for the times when you want to disable logging:

package main

import (
    "fmt"
)

// Option represents a functional option
type Option func(*Options)

// Options holds configuration for the function
type Options struct {
    logEnabled bool
}

// WithLoggingDisabled is a functional option that disables logging
func WithLoggingDisabled() Option {
    return func(opts *Options) {
        opts.logEnabled = false
    }
}

// MyFunction performs some logic and optionally logs
func MyFunction(opts ...Option) {
    // Default options (logging enabled)
    options := &Options{
        logEnabled: true,
    }

    // Apply functional options to modify the default behavior
    for _, opt := range opts {
        opt(options)
    }

    // Perform the main logic
    fmt.Println("Executing function logic")

    // Perform logging if enabled
    if options.logEnabled {
        fmt.Println("Logging is enabled")
    }
}

func main() {
    // Call the function with default behavior (logging enabled)
    fmt.Println("Case 1: Default logging enabled")
    MyFunction()

    // Call the function with logging disabled
    fmt.Println("\nCase 2: Logging disabled")
    MyFunction(WithLoggingDisabled())
}

[tataruty]

Thank you, added this approach!

[tataruty]

I moved it to separate in case if it can be needed not only for requests in the future