Deprecate Interfacer linter

[SVilgelm]

Add Deprecated function to config that accepts a message as a deprecation reason.
Print a warning if a deprecated linter is enabled.

Deprecate the Interfacer linter due to archived repository.

Related to #541

[SVilgelm]

output is:

~/icloud/projects/golangci-lint/golangci-lint run ./...
WARN [runner] The linter 'interfacer' is deprecated due to: The repository of the linter has been archived by the owner. 

[ldez]

level=warning msg="[runner] The linter 'interfacer' is deprecated due to: The repository of the linter has been archived by the owner."

The current test system will not work with a warning log.
At least we have to disable interfacer from our .golangci.yml

[SVilgelm]

The current test system will not work with a warning log.
At least we have to disable interfacer from our .golangci.yml

Yes, I think how can we ignore only the deprecated messages in tests

[ldez]

I think we can use log.Infof instead of log.Warnf

[SVilgelm]

but then it will not be printed, because the Info level is ignored by default

[ldez]

maybe we can add an option like --fast to skip the warning. 🤔

[ldez]

Maybe we can reuse Config.InternalTest 🤔

[ldez]

I have some good results here: ldez@270a1db

[SVilgelm]

cool, please commit it here

[SVilgelm]

because I came up only with this:

diff --git a/pkg/commands/run.go b/pkg/commands/run.go
index 357e274..9c611a3 100644
--- a/pkg/commands/run.go
+++ b/pkg/commands/run.go
@@ -6,6 +6,7 @@ import (
        "io/ioutil"
        "log"
        "os"
+       "regexp"
        "runtime"
        "strings"
        "time"
@@ -483,8 +484,19 @@ func (e *Executor) setupExitCode(ctx context.Context) {
                return
        }
 
-       needFailOnWarnings := (os.Getenv("GL_TEST_RUN") == "1" || os.Getenv("FAIL_ON_WARNINGS") == "1")
-       if needFailOnWarnings && len(e.reportData.Warnings) != 0 {
+       glTestRun := os.Getenv("GL_TEST_RUN") == "1"
+       needFailOnWarnings := (glTestRun || os.Getenv("FAIL_ON_WARNINGS") == "1")
+       warnings := len(e.reportData.Warnings)
+       if glTestRun {
+               re := regexp.MustCompile("The linter '.+' is deprecated due to: .+")
+               for _, w := range e.reportData.Warnings {
+                       if re.MatchString(w.Text) {
+                               warnings--
+                       }
+               }
+       }
+
+       if needFailOnWarnings && warnings != 0 {
                e.exitCode = exitcodes.WarningInTest
                return
        }

[ldez]

Your approach seems also good maybe a bit harder to maintain 🤔

[SVilgelm]

current output:

21-02-20 16:53 % ~/icloud/projects/golangci-lint/golangci-lint run ./...                   
WARN [runner] The linter 'interfacer' is deprecated due to: The repository of the linter has been archived by the owner. 
21-02-20 16:53 % echo $?
0

21-02-20 16:53 % FAIL_ON_WARNINGS=1 ~/icloud/projects/golangci-lint/golangci-lint run ./...
WARN [runner] The linter 'interfacer' is deprecated due to: The repository of the linter has been archived by the owner. 
21-02-20 16:53 % echo $?                                                                   
2

[ldez]

with my approach:

$ ./golangci-lint run 
WARN [runner] The linter 'interfacer' is deprecated due to: The repository of the linter has been archived by the owner.
$ echo $?
2

$ ./golangci-lint run --internal-cmd-test
$ echo $?
0

[SVilgelm]

I tested also with yours approach

[SVilgelm]

with my approach we will need to maintain same string in two places

[ldez]

yes, the base message must sync between 2 places.

A variation of your approach can be to apply the filtering in the logger:

func (lw LogWrapper) Warnf(format string, args ...interface{}) {
	lw.origLog.Warnf(format, args...)
	w := Warning{
		Tag:  strings.Join(lw.tags, "/"),
		Text: fmt.Sprintf(format, args...),
	}

+	re := regexp.MustCompile("The linter '.+' is deprecated due to: .+")
+	if re.MatchString(w.Text) {
+		return
+	}

	lw.rd.Warnings = append(lw.rd.Warnings, w)
}

[ldez]

the advantages of my approach:

• it can be reuse and extend
• not specific to logs
• easy to use in all our tests

[ldez]

A variation of my approach can be to create a flag like --skip-deprecated-linter-warn but I think it's useless because users can just remove the linter instead of playing with the deprecation.

[SVilgelm]

@ldez approve it?

[ldez]

I have to remove a TODO before 😉 https://github.com/golangci/golangci-lint/pull/1755/files#diff-ea835ba5eff883f863af2b9a490f5ccebd8ce3618c8d6d73f5ca15712e4f1e49R209

[ldez]

LGTM