[Bot] Add automatically generated go documentation (#1666)

Co-authored-by: Tofel <[email protected]>

Author: app-token-issuer-test-toolings[bot]

framework/clclient/client.go

@@ -1240,6 +1240,8 @@ func (c *ChainlinkClient) GetForwarders() (*Forwarders, *http.Response, error) {
 	return response, resp.RawResponse, err
 }
 
+// NewETHKey generates a new Ethereum key pair and encrypts the private key using the provided password.
+// It returns the encrypted key in JSON format and the corresponding Ethereum address, or an error if the process fails.
 func NewETHKey(password string) ([]byte, common.Address, error) {
 	privateKey, err := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
 	var address common.Address

framework/config.go

@@ -236,6 +236,8 @@ func (d *JSONStrDuration) UnmarshalJSON(b []byte) error {
 	}
 }
 
+// MustParseDuration parses a duration string in Go's format and returns the corresponding time.Duration.
+// It panics if the string cannot be parsed, ensuring that the caller receives a valid duration.
 func MustParseDuration(s string) time.Duration {
 	d, err := time.ParseDuration(s)
 	if err != nil {

havoc/chaos.go

@@ -53,6 +53,9 @@ type ChaosOpts struct {
 	Remove      bool
 }
 
+// NewChaos creates a new Chaos instance based on the provided options.
+// It requires a client, a chaos object, and a logger to function properly.
+// This function is essential for initializing chaos experiments in a Kubernetes environment.
 func NewChaos(opts ChaosOpts) (*Chaos, error) {
 	if opts.Client == nil {
 		return nil, errors.New("client is required")
@@ -161,6 +164,8 @@ func (c *Chaos) Resume(ctx context.Context) error {
 	return nil
 }
 
+// Delete stops the chaos operation, updates its status, and removes the chaos object if specified. 
+// It notifies listeners of the operation's completion and handles any errors encountered during the process.
 func (c *Chaos) Delete(ctx context.Context) error {
 	defer func() {
 		// Cancel the monitoring goroutine

havoc/range_grafana_annotator.go

@@ -150,4 +150,6 @@ func (l RangeGrafanaAnnotator) OnChaosEnded(chaos Chaos) {
 	l.chaosMap[chaos.GetChaosName()] = res.ID
 }
 
+// OnChaosStatusUnknown handles the event when the status of a chaos experiment is unknown.
+// It allows listeners to respond appropriately to this specific status change in the chaos lifecycle.
 func (l RangeGrafanaAnnotator) OnChaosStatusUnknown(chaos Chaos) {}

havoc/single_line_grafana_annotator.go

@@ -134,4 +134,6 @@ func (l SingleLineGrafanaAnnotator) OnChaosEnded(chaos Chaos) {
 	l.logger.Debug().Any("GrafanaResponse", resp.String()).Msg("Annotated chaos experiment end")
 }
 
+// OnChaosStatusUnknown handles the event when the status of a chaos experiment is unknown.
+// It allows listeners to respond appropriately to this specific status change in the chaos lifecycle.
 func (l SingleLineGrafanaAnnotator) OnChaosStatusUnknown(chaos Chaos) {}

havoc/template.go

@@ -45,6 +45,9 @@ type PodPartitionCfg struct {
 	ExperimentCreateDelay time.Duration
 }
 
+// RunPodPartition initiates a network partition chaos experiment on specified pods.
+// It configures the experiment based on the provided PodPartitionCfg and executes it.
+// This function is useful for testing the resilience of applications under network partition scenarios.
 func (cr *NamespaceScopedChaosRunner) RunPodPartition(ctx context.Context, cfg PodPartitionCfg) (*Chaos, error) {
 	experiment, err := NewChaos(ChaosOpts{
 		Object: &v1alpha1.NetworkChaos{
@@ -115,6 +118,9 @@ type PodDelayCfg struct {
 	ExperimentCreateDelay time.Duration
 }
 
+// RunPodDelay initiates a network delay chaos experiment on specified pods.
+// It configures the delay parameters and applies them to the targeted namespace.
+// This function is useful for testing the resilience of applications under network latency conditions.
 func (cr *NamespaceScopedChaosRunner) RunPodDelay(ctx context.Context, cfg PodDelayCfg) (*Chaos, error) {
 	experiment, err := NewChaos(ChaosOpts{
 		Object: &v1alpha1.NetworkChaos{
@@ -174,6 +180,9 @@ type PodFailCfg struct {
 	ExperimentCreateDelay time.Duration
 }
 
+// RunPodFail initiates a pod failure experiment based on the provided configuration.
+// It creates a Chaos object that simulates pod failures for a specified duration,
+// allowing users to test the resilience of their applications under failure conditions.
 func (cr *NamespaceScopedChaosRunner) RunPodFail(ctx context.Context, cfg PodFailCfg) (*Chaos, error) {
 	experiment, err := NewChaos(ChaosOpts{
 		Description: cfg.Description,
@@ -233,6 +242,9 @@ type NodeCPUStressConfig struct {
 	ExperimentCreateDelay   time.Duration
 }
 
+// RunPodStressCPU initiates a CPU stress test on specified pods within a namespace.
+// It creates a scheduled chaos experiment that applies CPU load based on the provided configuration.
+// This function is useful for testing the resilience of applications under CPU stress conditions.
 func (cr *NamespaceScopedChaosRunner) RunPodStressCPU(ctx context.Context, cfg NodeCPUStressConfig) (*Chaos, error) {
 	experiment, err := NewChaos(ChaosOpts{
 		Description: cfg.Description,

seth/client_builder.go

@@ -366,6 +366,9 @@ func (c *ClientBuilder) WithEthClient(ethclient simulated.Client) *ClientBuilder
 	return c
 }
 
+// WithHooks sets the hooks for the ClientBuilder configuration.
+// It allows users to customize behavior during client operations 
+// by providing a set of hooks to be executed at specific events.
 func (c *ClientBuilder) WithHooks(hooks Hooks) *ClientBuilder {
 	c.config.Hooks = &hooks
 	return c