Add a Warnings() method to tfdiags.Diagnostics

[SarahFrench]

Terraform Version

N/A

Use Cases

Diagnostics type variables are collections of diagnostics returned from code. They can include a mixture of Error or Warning diagnostics. Calling code can receive a diagnostics list and use HasErrors or HasWarnings to check if the diagnostics includes at least one diagnostic with that severity level.

It'd be useful to add a Warnings() method to Diagnostics that returns all the contained warning diagnostics within a new Diagnostics collection.

Attempted Solutions

N/A

Proposal

I imagine the method would look very similar to:

terraform/internal/command/junit/junit.go

Lines 358 to 369 in 0bbcfdd

	func getWarnings(diags tfdiags.Diagnostics) tfdiags.Diagnostics {
	// Collect warnings
	warnDiags := tfdiags.Diagnostics{}
	if diags.HasWarnings() {
	for _, d := range diags {
	if d.Severity() == tfdiags.Warning {
	warnDiags = warnDiags.Append(d)
	}
	}
	}
	return warnDiags
	}

References

• Change JUnit terraform test output to include test failure details inside <failure> elements, use the error message as the message attribute #36316 (comment)

[SarahFrench]

This task came up during a PR I was working on, and I figured it'd be a useful good first issue for anyone wanting an easy start to begin contributing.

[momowind-su]

I would like to work on this issue

[crw]

Hi @momowind-su, if you’re interested in contributing to Terraform, please begin by reviewing the contributing guide and following the process outlined there. Thanks for your interest!