com.palantir.baseline.errorprone.LogSafePreconditionsMessageFormat Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of baseline-error-prone Show documentation

A Gradle plugin for applying Baseline-recommended build and IDE settings

There is a newer version: 6.11.0

/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.palantir.baseline.errorprone;

import com.google.auto.service.AutoService;
import com.google.errorprone.BugPattern;
import com.google.errorprone.BugPattern.LinkType;
import com.google.errorprone.BugPattern.SeverityLevel;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.google.errorprone.matchers.method.MethodMatchers;
import com.sun.source.tree.ExpressionTree;
import com.sun.source.tree.MethodInvocationTree;
import java.util.regex.Pattern;

@AutoService(BugChecker.class)
@BugPattern(
        link = "https://github.com/palantir/gradle-baseline#baseline-error-prone-checks",
        linkType = LinkType.CUSTOM,
        severity = SeverityLevel.ERROR,
        summary = "logsafe Preconditions.checkX() methods should not have print-f or slf4j style formatting.")
public final class LogSafePreconditionsMessageFormat extends PreconditionsMessageFormat {

    private static final long serialVersionUID = 1L;

    private static final Matcher LOGSAFE_PRECONDITIONS_METHOD = MethodMatchers.staticMethod()
            .onClassAny("com.palantir.logsafe.Preconditions")
            .withNameMatching(Pattern.compile("checkArgument|checkState|checkNotNull"));

    public LogSafePreconditionsMessageFormat() {
        super(LOGSAFE_PRECONDITIONS_METHOD);
    }

    @Override
    protected Description matchMessageFormat(MethodInvocationTree tree, String message, VisitorState state) {
        if (message.contains("%s")) {
            return buildDescription(tree)
                    .setMessage("Do not use printf-style formatting in logsafe Preconditions. "
                            + "Logsafe exceptions provide a simple message and key-value pairs of arguments, "
                            + "no interpolation is performed.")
                    .build();
        }
        if (message.contains("{}")) {
            return buildDescription(tree)
                    .setMessage("Do not use slf4j-style formatting in logsafe Preconditions. "
                            + "Logsafe exceptions provide a simple message and key-value pairs of arguments, "
                            + "no interpolation is performed.")
                    .build();
        }
        return Description.NO_MATCH;
    }
}