Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

go/analysis/analysistest: Ignore error if edited file can't be formatted #232

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sourya
Copy link

@sourya sourya commented Jun 3, 2020

There are instances when the diagnostics are reported correctly by the
analyzer, but the suggested fixes are wrong, and result in code that
cannot be formatted by format.Source (due to errors in the edited code).
Right now, in those cases, the tests pass despite the format errors.
This commit fixes that.

Signed-off-by: Sourya Vatsyayan [email protected]

@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@gopherbot
Copy link
Contributor

This PR (HEAD: 814f4d8) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/tools/+/236144 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

@gopherbot
Copy link
Contributor

Message from Gobot Gobot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps:
Within the next week or so, a maintainer will review your change and provide
feedback. See https://golang.org/doc/contribute.html#review for more info and
tips to get your patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be
surprising to people new to the project. The careful, iterative review process
is our way of helping mentor contributors and ensuring that their contributions
have a lasting impact.

During May-July and Nov-Jan the Go project is in a code freeze, during which
little code gets reviewed or merged. If a reviewer responds with a comment like
R=go1.11, it means that this CL will be reviewed as part of the next development
cycle. See https://golang.org/s/release for more details.


Please don’t reply on this GitHub thread. Visit golang.org/cl/236144.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Michael Matloob:

Patch Set 1:

I think it's definitely a problem that we don't even check suggested fixes if the file can't be formatted, so I think that instead of just continuing we should check against the unformatted code.

It's tricky to just outright fail if the file can't be formatted. Consider a file that has a syntax error, and someone makes a resilient analyzer that can make suggested fixes even in the presence of syntax errors. This change could make it difficult to test an analyzer like that.


Please don’t reply on this GitHub thread. Visit golang.org/cl/236144.
After addressing review feedback, remember to publish your drafts!

...changed file cannot be formatted

There are instances when the diagnostics are reported correctly by the
analyzer, but the suggested fixes are wrong, and result in code that
cannot be formatted by `format.Source` (maybe due to syntax errors in
the edited code).  Right now, in those cases, the test runner ignores
the failed tests and moves on to the next test, giving an impression
that the tests have passed. This commit fixes that.

Signed-off-by: Sourya Vatsyayan <[email protected]>
@gopherbot
Copy link
Contributor

This PR (HEAD: 4f09fe5) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/tools/+/236144 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

@sourya sourya changed the title go/analysis/analysistest: Raise error if edited file can't be formatted go/analysis/analysistest: Ignore error if edited file can't be formatted Jun 24, 2020
@gopherbot
Copy link
Contributor

Message from Michael Matloob:

Patch Set 3:

Hm, I'm not sure if this is right either. Most likely the message will be ignored.

I'm wondering if we can do the following: if the file fails to format, we check if the original file was able to be formatted: a suggested fix shouldn't break previously working code.


Please don’t reply on this GitHub thread. Visit golang.org/cl/236144.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Go Bot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps:
Within the next week or so, a maintainer will review your change and provide
feedback. See https://golang.org/doc/contribute.html#review for more info and
tips to get your patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be
surprising to people new to the project. The careful, iterative review process
is our way of helping mentor contributors and ensuring that their contributions
have a lasting impact.

During May-July and Nov-Jan the Go project is in a code freeze, during which
little code gets reviewed or merged. If a reviewer responds with a comment like
R=go1.11, it means that this CL will be reviewed as part of the next development
cycle. See https://golang.org/s/release for more details.


Please don’t reply on this GitHub thread. Visit golang.org/cl/236144.
After addressing review feedback, remember to publish your drafts!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants