com.palantir.baseline.errorprone.JavaTimeSystemDefaultTimeZone 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 2019 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.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker;
import com.google.errorprone.fixes.SuggestedFix;
import com.google.errorprone.fixes.SuggestedFixes;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.google.errorprone.matchers.Matchers;
import com.sun.source.tree.ExpressionTree;
import com.sun.source.tree.MethodInvocationTree;
import java.time.ZoneOffset;

@AutoService(BugChecker.class)
@BugPattern(
        link = "https://github.com/palantir/gradle-baseline#baseline-error-prone-checks",
        linkType = BugPattern.LinkType.CUSTOM,
        severity = BugPattern.SeverityLevel.ERROR,
        summary = "The system default time zone should not be used, since the behavior is system dependent. "
                + "Instead, UTC should always be used.")
public final class JavaTimeSystemDefaultTimeZone extends BugChecker implements BugChecker.MethodInvocationTreeMatcher {

    private static final Matcher CLOCK_SYSTEM_DEFAULT_ZONE_MATCHER = Matchers.staticMethod()
            .onClass("java.time.Clock")
            .named("systemDefaultZone")
            .withNoParameters();
    private static final Matcher ZONE_ID_SYSTEM_DEFAULT_MATCHER = Matchers.staticMethod()
            .onClass("java.time.ZoneId")
            .named("systemDefault")
            .withNoParameters();

    @Override
    public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState state) {
        if (CLOCK_SYSTEM_DEFAULT_ZONE_MATCHER.matches(tree, state)) {
            return buildDescription(tree)
                    .addFix(SuggestedFixes.renameMethodInvocation(tree, "systemUTC", state))
                    .build();
        }

        if (ZONE_ID_SYSTEM_DEFAULT_MATCHER.matches(tree, state)) {
            SuggestedFix.Builder fix = SuggestedFix.builder();
            return buildDescription(tree)
                    .addFix(fix.replace(
                                    tree, SuggestedFixes.qualifyType(state, fix, ZoneOffset.class.getName()) + ".UTC")
                            .build())
                    .build();
        }

        return Description.NO_MATCH;
    }
}