22 Commits (25cebfbd8be2c43a25dfafdcf882e79b9ccc3d3d)

Author	SHA1	Message	Date
Alisdair McDiarmid	25f99857cf	cli: Fix crash with invalid JSON diagnostics ... If a JSON diagnostic value has a highlight end offset which is before the highlight start offset, this would previously panic. This commit adds a normalization step to prevent the crash.	5 years ago
James Bardin	d04999863c	"with" formatting	5 years ago
James Bardin	406ac97965	add the address field to the view diagnostics	5 years ago
Alisdair McDiarmid	d9d88b9243	cli: Add comprehensive JSON diagnostic structure ... This commit adds a comprehensive JSON format for diagnostics, which ensures that all current diagnostic output can be semantically represented in a machine-readable format. The diagnostic formatter interface remains unchanged, but it first transforms its input via the JSON format to ensure that there is only one code path for creating the diagnostic data. The JSON diagnostic renderer extracts the non-presentational logic from the format package, and returns a structure which can either be marshaled into JSON or rendered as text. The resulting text diagnostic output is unchanged for all cases covered by unit tests and my own manual testing. Included in this commit are a number of golden reference files for the marshaled JSON output of a diagnostic. This format should change rarely if at all, and these are in place to ensure that any changes to the format are intentional and considered.	5 years ago
Alex Chan	4ec80fa18d	Correct the spelling of heirarchy/hierarchy throughout	5 years ago
Katy Moe	51c687c2db	command: no visual warning hierarchy in -no-color ... Commit e865faf adds visual indentation for diagnostic messages using various vertical line characters. The present commit disables this behaviour when running with colourised output disabled. While the contents of stderr are not intended to be part of the Terraform API, this is currently how the hashicorp/terraform-exec library detects certain error types in order to present them as well-known Go errors to the user. Such detection is complicated when vertical lines are added to the CLI output at unpredictable points. I expect this change will also be helpful for screen reader users.	5 years ago
Katy Moe	bc51932e08	refactor: extract appendSourceSnippets	5 years ago
Martin Atkins	e865faf318	command: Better visual hierarchy for diagnostics ... I frequently see people attempting to ask questions about Terraform's error and warning messages but either only copying part of the message or accidentally copying a surrounding paragraph that isn't part of the message. While I'm sure some of these are just "careless" mistakes, I've also noticed that this has sometimes overlapped with someone asking a question whose answer is written directly in the part of the message they didn't include when copying, and so I have a theory that our current output doesn't create a good enough visual hierarchy for sighted users to understand where the diagnostic messages start and end when we show them in close proximity to other content, or to other diagnostic messages. As a result, some folks fail to notice the relevant message that might've answered their question. I tried a few different experiments for different approaches here, such as adding more horizontal rules to the output and coloring the detail text differently, but the approach that felt like the nicest compromise to me was what's implemented here, which is to add a vertical line along the left edge of each diagnostic message, colored to match with the typical color we use for each diagnostic severity. This means that the diagnostics end up slightly indented from what's around them, and the vertical line seems to help subtly signal how we intended the content to be grouped together.	5 years ago
Martin Atkins	1f1af87dea	command/format: Don't try to fill the last terminal column ... In some terminal emulators, writing a character into the last column on a row causes the terminal to immediately wrap to the beginning of the next line, even if the very next character in the stream is a hard newline. That can then lead to errant blank lines in the final output which make it harder to navigate the visual hierarchy. As a compromise to avoid this, we'll format our horizontal rules and paragraphs to one column less than the terminal width. That does mean that our horizontal rules won't _quite_ cover the whole terminal width, but it seems like a good compromise in order to get consistent behavior across a wider variety of terminal implementations.	5 years ago
Martin Atkins	0c84a56700	command/format: Use box drawing chars for rules in diagnostics ... We were previously using some ASCII art to create some visual divisions between parts of the diagnostic output. Now that we are requiring a UTF-8 terminal we can print out box drawing characters instead.	5 years ago
Martin Atkins	d24fdce5b8	command/format: Include unknown values in diagnostics ... Previously when printing the relevant variables involved in a failed expression evaluation we would just skip over unknown values entirely. There are some errors, though, which are _caused by_ a value being unknown, in which case it's helpful to show which of the inputs to that expression were known vs. unknown so that the user can limit their further investigation only to the unknown ones. While here I also added a special case for sensitive values that overrides all other display, because we don't know what about a value is sensitive and so better to give nothing away at the expense of a slightly less helpful error message.	6 years ago
Pam Selle	61c78fd3b9	Add case to compactValueStr not to expose sensitive vals in diagnostics	6 years ago
Alisdair McDiarmid	3547f9e368	format: Don't wrap space-prefixed diag details ... Diagnostic detail lines sometimes contain lines which include commands suggested for the user to execute. By convention, these start with leading whitespace to indicate that they are not prose. This commit changes the diagnostic formatter to wrap each line of the detail separately, and skips word wrapping for lines prefixed with space. This prevents ugly and confusing wrapping of long command lines.	6 years ago
Alisdair McDiarmid	c87c0a9d2a	command/format: Fix empty overlap diagnostics ... Diagnostics where the highlight range has an empty overlap with a line would skip lines of the output. This is because if two ranges abut each other, they can be considered to overlap, but that overlap is empty. This results in an edge case in the diagnostic printer which causes the line not to be printed.	6 years ago
Alisdair McDiarmid	a23c3e3c81	command/format: Fix multi-line diagnostic output ... Previously, if a diagnostic context spanned multiple lines, any lines which did not overlap with the highlight range would be displayed as blank. This commit fixes the bug. The problem was caused by the unconditional use of `PartitionAround` to split the line into before/highlighted/after ranges. When two ranges don't overlap, this method returns empty ranges, which results in a blank line. Instead, we first check if the ranges do overlap, and if not we print the entire line from the context.	6 years ago
Martin Atkins	c06675c616	command: New -compact-warnings option ... When warnings appear in isolation (not accompanied by an error) it's reasonable to want to defer resolving them for a while because they are not actually blocking immediate work. However, our warning messages tend to be long by default in order to include all of the necessary context to understand the implications of the warning, and that can make them overwhelming when combined with other output. As a compromise, this adds a new CLI option -compact-warnings which is supported for all the main operation commands and which uses a more compact format to print out warnings as long as they aren't also accompanied by errors. The default remains unchanged except that the threshold for consolidating warning messages is reduced to one so that we'll now only show one of each distinct warning summary. Full warning messages are always shown if there's at least one error included in the diagnostic set too, because in that case the warning message could contain additional context to help understand the error.	6 years ago
Martin Atkins	39e609d5fd	vendor: switch to HCL 2.0 in the HCL repository ... Previously we were using the experimental HCL 2 repository, but now we'll shift over to the v2 import path within the main HCL repository as part of actually releasing HCL 2.0 as stable. This is a mechanical search/replace to the new import paths. It also switches to the v2.0.0 release of HCL, which includes some new code that Terraform didn't previously have but should not change any behavior that matters for Terraform's purposes. For the moment the experimental HCL2 repository is still an indirect dependency via terraform-config-inspect, so it remains in our go.sum and vendor directories for the moment. Because terraform-config-inspect uses a much smaller subset of the HCL2 functionality, this does still manage to prune the vendor directory a little. A subsequent release of terraform-config-inspect should allow us to completely remove that old repository in a future commit.	7 years ago
Kristin Laemmert	f8a5e17d3d	command/format: improve "source" of error messages regarding missing arguments (#20907) ... * vendor: update hcl2 dependency * command/format: revert diagnostic format behavior if snippet or highlight range is empty	7 years ago
Radek Simko	4f2868a019	command/format: Fix rendering of attribute-agnostic diagnostics	8 years ago
Martin Atkins	17b883f592	command/format: Include variable values in diagnostic messages ... When HCL encounters an error during expression evaluation, it annotates its diagnostics with information about the expression that was being evaluated and the EvalContext it was evaluated in. This gives us enough information to show helpful hints to the user about the final values of any reference expressions that are present in the expression, which is very useful extra context for expressions that get evaluated multiple times, such as: - Any expression in a block with "count" or "for_each" set - The sub-expressions within a "for" expression	8 years ago
Martin Atkins	bd10b84a8e	command/format: include source snippets in diagnostics ... If we get a diagnostic message that references a source range, and if the source code for the referenced file is available, we'll show a snippet of the source code with the source range highlighted. At the moment we have no cache of source code, so in practice this codepath can never be visited. Callers to format.Diagnostic will be gradually updated in subsequent commits.	8 years ago
Martin Atkins	ea81e75a4e	command: utility for rendering tfdiag diagnostics ... This new method showDiagnostics takes any value that would be accepted by tfdiags.Append and renders it to the UI. This is intended to encourage consistent handling of the different kinds of errors and diagnostics that can be produced, and allow richer error objects like the HCL2 diagnostics to be easily unwrapped and shown in their full-fidelity.	9 years ago