[inv test] Do not run gofmt unless fail-on-fmt is set

[albertvaka]

What does this PR do?

Do not run gofmt as part of the linting stage of the test invoke task unless we want formatting errors to fail the test (ie: --fail-on-fmt is passed in).

Motivation

I don't think it's any useful.

[albertvaka]

It seems that gofmt changing the files prevented go vet from failing with package comment is detached; there should be no blank lines between it and the package statement on some files. We can't merge this as-is.

[mx-psi]

It seems that gofmt changing the files prevented go vet from failing with package comment is detached; there should be no blank lines between it and the package statement on some files. We can't merge this as-is.

So that means there are ill-formatted files and the fmt check was not working properly even on Linux then?

[albertvaka]

I think it's because go vet is confused by the CRLF line endings.

[mx-psi]

I think it's because go vet is confused by the CRLF line endings.

👍 that would make sense because e.g. this one seems correct:

datadog-agent/pkg/util/ecs/metadata/doc.go

Lines 6 to 20 in 6552cea

	/*
	Package metadata provides clients for Metadata APIs exposed by the ECS agent.
	There are three versions of these APIs:
	- V1: also called introspection endpoint.
	- V2: available since ecs-agent 1.17.0 with the EC2 launch type and since
	platform version 1.1.0 with the Fargate launch type.
	- V3: available since ecs-agent 1.21.0 with the EC2 launch type and since
	platform version 1.3.0 with the Faragate launch type.
	Each of these versions sits in its own subpackage.
	*/
	package metadata

at least when compared with the multi-line example here, but go vet revive is complaining about it.

see above

[mx-psi]

After looking into it a bit more, my guess is that this is related to golang/go#41197 because of how revive uses it and needs a fix on revive.

[mx-psi]

This is not easy to fix, I though they added a new field (EndSlash) but instead in the end they just documented the issue (golang/go@a14e7bf). I am going to file an issue on revive since I don't have a trivial fix.

[albertvaka]

Closing since we actually need gofmt to change the line endings due to a bug in revive.