/*
 * Copyright 2017 The Error Prone Authors.
 *
 * 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.google.errorprone.bugpatterns;

import static org.junit.Assert.assertThrows;

import com.google.errorprone.CompilationTestHelper;
import com.google.errorprone.annotations.DoNotCall;
import java.sql.Date;
import java.sql.Time;
import java.util.concurrent.ThreadLocalRandom;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** {@link DoNotCallChecker}Test */
@SuppressWarnings("DoNotCall")
@RunWith(JUnit4.class)
public class DoNotCallCheckerTest {

  private final CompilationTestHelper testHelper =
      CompilationTestHelper.newInstance(DoNotCallChecker.class, getClass());

  @Test
  public void positive() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import com.google.errorprone.annotations.DoNotCall;

            class Test {
              @DoNotCall("satisfying explanation")
              final void f() {}

              @DoNotCall
              final void g() {}

              void m() {
                // BUG: Diagnostic contains:
                // Test.f() should not be called: satisfying explanation
                f();
                // BUG: Diagnostic contains:
                // Test.g() should not be called, see its documentation for details.
                g();
                // BUG: Diagnostic contains:
                // Test.g() should not be called, see its documentation for details.
                Runnable r = this::g;
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positiveWhereDeclaredTypeIsSuper() {
    testHelperWithImmutableList()
        .addSourceLines(
            "Test.java",
            """
            import java.util.List;

            class Test {
              void foo() {
                List<Integer> xs = ImmutableList.of();
                // BUG: Diagnostic contains:
                xs.add(1);
                xs.get(1);
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positiveWhereDeclaredTypeIsSuper_butAssignedMultipleTimes() {
    testHelperWithImmutableList()
        .addSourceLines(
            "Test.java",
            """
            import java.util.List;

            class Test {
              void foo() {
                List<Integer> xs;
                if (hashCode() == 0) {
                  xs = ImmutableList.of();
                } else {
                  xs = ImmutableList.of();
                }
                // BUG: Diagnostic contains:
                xs.add(1);
                xs.get(1);
              }
            }
            """)
        .doTest();
  }

  private CompilationTestHelper testHelperWithImmutableList() {
    // Stub out an ImmutableList with the annotations we need for testing.
    return testHelper
        .addSourceLines(
            "ImmutableCollection.java",
            """
            import com.google.errorprone.annotations.DoNotCall;
            import java.util.List;

            abstract class ImmutableCollection<T> implements java.util.Collection<T> {
              @DoNotCall
              @Override
              public final boolean add(T t) {
                throw new UnsupportedOperationException();
              }
            }
            """)
        .addSourceLines(
            "ImmutableList.java",
            """
            import com.google.errorprone.annotations.DoNotCall;
            import java.util.List;

            abstract class ImmutableList<T> extends ImmutableCollection<T> implements List<T> {
              public static <T> ImmutableList<T> of() {
                return null;
              }
            }
            """);
  }

  @Test
  public void positiveWhereDeclaredTypeIsSuper_butNotAssignedOnce() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import com.google.common.collect.ImmutableList;
            import java.util.ArrayList;
            import java.util.List;

            class Test {
              void foo() {
                List<Integer> xs;
                if (true) {
                  xs = ImmutableList.of();
                } else {
                  xs = new ArrayList<>();
                  xs.add(2);
                }
              }
            }
            """)
        .doTest();
  }

  @Test
  public void concreteFinal() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import com.google.errorprone.annotations.DoNotCall;

            public class Test {
              @DoNotCall
              // BUG: Diagnostic contains: should be final
              public void f() {}

              @DoNotCall
              public final void g() {}
            }
            """)
        .doTest();
  }

  @Test
  public void requiredOverride() {
    testHelper
        .addSourceLines(
            "A.java",
            """
            import com.google.errorprone.annotations.DoNotCall;

            public interface A {
              @DoNotCall
              public void f();
            }
            """)
        .addSourceLines(
            "B.java",
            """
            public class B implements A {
              @Override
              // BUG: Diagnostic contains: overrides f in A which is annotated
              public void f() {}
            }
            """)
        .doTest();
  }

  @Test
  public void annotatedOverride() {
    testHelper
        .addSourceLines(
            "A.java",
            """
            import com.google.errorprone.annotations.DoNotCall;

            public interface A {
              @DoNotCall
              public void f();
            }
            """)
        .addSourceLines(
            "B.java",
            """
            import com.google.errorprone.annotations.DoNotCall;

            public class B implements A {
              @DoNotCall
              @Override
              public final void f() {}
            }
            """)
        .doTest();
  }

  // The interface tries to make Object#toString @DoNotCall, and because
  // the declaration in B is implicit it doesn't get checked.
  // In practice, making default Object methods @DoNotCall isn't super
  // useful - typically users interface with the interface directly
  // (e.g. Hasher) or there's an override that has unwanted behaviour (Localizable).
  // TODO(cushon): check class declarations for super-interfaces that do this?
  @Test
  public void interfaceRedeclaresObjectMethod() {
    testHelper
        .addSourceLines(
            "I.java",
            """
            import com.google.errorprone.annotations.DoNotCall;

            public interface I {
              @DoNotCall
              public String toString();
            }
            """)
        .addSourceLines(
            "B.java",
            """
            public class B implements I {}
            """)
        .addSourceLines(
            "Test.java",
            """
            public class Test {
              void f(B b) {
                b.toString();
                I i = b;
                // BUG: Diagnostic contains:
                i.toString();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void finalClass() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import com.google.errorprone.annotations.DoNotCall;

            public final class Test {
              @DoNotCall
              public void f() {}
            }
            """)
        .doTest();
  }

  @Test
  public void privateMethod() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import com.google.errorprone.annotations.DoNotCall;

            public final class Test {
              @DoNotCall
              // BUG: Diagnostic contains: private method
              private void f() {}
            }
            """)
        .doTest();
  }

  /** Test class containing a method annotated with @DNC. */
  public static final class DNCTest {
    @DoNotCall
    public static void f() {}

    private DNCTest() {}
  }

  @Test
  public void noDNConClasspath() {
    testHelper
        .addSourceLines(
            "Test.java",
"""
class Test {
  void m() {
    // BUG: Diagnostic contains: com.google.errorprone.bugpatterns.DoNotCallCheckerTest.DNCTest.f()
    // should not be called, see its documentation for details.
    com.google.errorprone.bugpatterns.DoNotCallCheckerTest.DNCTest.f();
  }
}
""")
        .withClasspath(DNCTest.class, DoNotCallCheckerTest.class)
        .doTest();
  }

  @Test
  public void thirdParty() {
    testHelper
        .addSourceLines(
            "Test.java",
            "import org.junit.Assert;",
            "public class Test {",
            "  public void foo() {",
            "    // BUG: Diagnostic contains: DoNotCall",
            "    Assert.assertEquals(2.0, 2.0);",
            "    // BUG: Diagnostic contains: DoNotCall",
            "    Assert.assertEquals(\"msg\", 2.0, 2.0);",
            // These are OK since they pass a tolerance
            "    Assert.assertEquals(2.0, 2.0, 0.01);",
            "    Assert.assertEquals(\"msg\", 2.0, 2.0, 0.01);",
            "  }",
            "}")
        .doTest();
  }

  @Test
  public void javaSqlDate_toInstant() {
    assertThrows(UnsupportedOperationException.class, () -> new Date(1234567890L).toInstant());
    testHelper
        .addSourceLines(
            "TestClass.java",
            """
            import java.sql.Date;
            import java.time.Instant;

            public class TestClass {
              public void badApis(Date date) {
                // BUG: Diagnostic contains: toLocalDate()
                Instant instant = date.toInstant();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void javaSqlDate_timeGetters() {
    Date date = new Date(1234567890L);
    assertThrows(IllegalArgumentException.class, () -> date.getHours());
    assertThrows(IllegalArgumentException.class, () -> date.getMinutes());
    assertThrows(IllegalArgumentException.class, () -> date.getSeconds());
    testHelper
        .addSourceLines(
            "TestClass.java",
            """
            import java.sql.Date;

            public class TestClass {
              public void badApis(Date date) {
                // BUG: Diagnostic contains: DoNotCall
                int hour = date.getHours();
                // BUG: Diagnostic contains: DoNotCall
                int mins = date.getMinutes();
                // BUG: Diagnostic contains: DoNotCall
                int secs = date.getSeconds();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void javaSqlDate_timeSetters() {
    Date date = new Date(1234567890L);
    assertThrows(IllegalArgumentException.class, () -> date.setHours(1));
    assertThrows(IllegalArgumentException.class, () -> date.setMinutes(1));
    assertThrows(IllegalArgumentException.class, () -> date.setSeconds(1));
    testHelper
        .addSourceLines(
            "TestClass.java",
            """
            import java.sql.Date;

            public class TestClass {
              public void badApis(Date date) {
                // BUG: Diagnostic contains: DoNotCall
                date.setHours(1);
                // BUG: Diagnostic contains: DoNotCall
                date.setMinutes(1);
                // BUG: Diagnostic contains: DoNotCall
                date.setSeconds(1);
              }
            }
            """)
        .doTest();
  }

  @Test
  public void javaSqlDate_staticallyTypedAsJavaUtilDate() {
    testHelper
        .addSourceLines(
            "TestClass.java",
            """
            import java.time.Instant;
            import java.util.Date;

            public class TestClass {
              public void badApis() {
                Date date = new java.sql.Date(1234567890L);
                Instant instant = date.toInstant();
                int hour = date.getHours();
                int mins = date.getMinutes();
                int secs = date.getSeconds();
                date.setHours(1);
                date.setMinutes(1);
                date.setSeconds(1);
              }
            }
            """)
        .doTest();
  }

  @Test
  public void javaSqlTime_toInstant() {
    assertThrows(UnsupportedOperationException.class, () -> new Time(1234567890L).toInstant());
    testHelper
        .addSourceLines(
            "TestClass.java",
            """
            import java.sql.Time;
            import java.time.Instant;

            public class TestClass {
              public void badApis(Time time) {
                // BUG: Diagnostic contains: toLocalTime()
                Instant instant = time.toInstant();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void javaSqlTime_dateGetters() {
    Time time = new Time(1234567890L);
    assertThrows(IllegalArgumentException.class, () -> time.getYear());
    assertThrows(IllegalArgumentException.class, () -> time.getMonth());
    assertThrows(IllegalArgumentException.class, () -> time.getDay());
    assertThrows(IllegalArgumentException.class, () -> time.getDate());
    testHelper
        .addSourceLines(
            "TestClass.java",
            """
            import java.sql.Time;

            public class TestClass {
              public void badApis(Time time) {
                // BUG: Diagnostic contains: DoNotCall
                int year = time.getYear();
                // BUG: Diagnostic contains: DoNotCall
                int month = time.getMonth();
                // BUG: Diagnostic contains: DoNotCall
                int day = time.getDay();
                // BUG: Diagnostic contains: DoNotCall
                int date = time.getDate();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void javaSqlTime_dateSetters() {
    Time time = new Time(1234567890L);
    assertThrows(IllegalArgumentException.class, () -> time.setYear(1));
    assertThrows(IllegalArgumentException.class, () -> time.setMonth(1));
    assertThrows(IllegalArgumentException.class, () -> time.setDate(1));
    testHelper
        .addSourceLines(
            "TestClass.java",
            """
            import java.sql.Time;

            public class TestClass {
              public void badApis(Time time) {
                // BUG: Diagnostic contains: DoNotCall
                time.setYear(1);
                // BUG: Diagnostic contains: DoNotCall
                time.setMonth(1);
                // BUG: Diagnostic contains: DoNotCall
                time.setDate(1);
              }
            }
            """)
        .doTest();
  }

  @Test
  public void javaSqlTime_staticallyTypedAsJavaUtilDate() {
    testHelper
        .addSourceLines(
            "TestClass.java",
            """
            import java.time.Instant;
            import java.util.Date;

            public class TestClass {
              public void badApis() {
                Date time = new java.sql.Time(1234567890L);
                Instant instant = time.toInstant();
                int year = time.getYear();
                int month = time.getMonth();
                int date = time.getDate();
                int day = time.getDay();
                time.setYear(1);
                time.setMonth(1);
                time.setDate(1);
              }
            }
            """)
        .doTest();
  }

  @Test
  public void sortedCollectionSequencedCollectionMethods() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.util.TreeMap;
            import java.util.TreeSet;

            public class Test {
              public void foo(TreeMap<String, String> map, TreeSet<String> set) {
                // BUG: Diagnostic contains: DoNotCall
                map.putFirst("foo", "bar");
                // BUG: Diagnostic contains: DoNotCall
                map.putLast("foo", "bar");
                // BUG: Diagnostic contains: DoNotCall
                set.addFirst("foo");
                // BUG: Diagnostic contains: DoNotCall
                set.addLast("foo");
              }
            }
            """)
        .doTest();
  }

  @Test
  public void readLock_newCondition() {
    assertThrows(
        UnsupportedOperationException.class,
        () -> new ReentrantReadWriteLock().readLock().newCondition());
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.util.concurrent.locks.ReentrantReadWriteLock;

            public class Test {
              public void foo() {
                ReentrantReadWriteLock.ReadLock lock = new ReentrantReadWriteLock().readLock();
                // BUG: Diagnostic contains: DoNotCall
                lock.newCondition();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void threadLocalRandom_setSeed() {
    assertThrows(
        UnsupportedOperationException.class, () -> ThreadLocalRandom.current().setSeed(42));
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.util.concurrent.ThreadLocalRandom;

            public class Test {
              public void foo() {
                ThreadLocalRandom random = ThreadLocalRandom.current();
                // BUG: Diagnostic contains: DoNotCall
                random.setSeed(42L);
              }
            }
            """)
        .doTest();
  }

  @Test
  public void memberReferencesOnThirdPartyMethods() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.util.concurrent.ThreadLocalRandom;
            import java.util.Optional;

            public class Test {
              public void foo(Optional<Long> x) {
                ThreadLocalRandom random = ThreadLocalRandom.current();
                // BUG: Diagnostic contains: DoNotCall
                x.ifPresent(random::setSeed);
              }
            }
            """)
        .doTest();
  }

  @Test
  public void typeArgs_dontCrash() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.util.List;

            class Test<T extends java.util.Collection<Object>> {
              @Override
              public boolean equals(Object o) {
                T foo = (T) o;
                return foo.equals(1);
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_getSimpleName_refactoredToGetClassName() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            class Test {
              void f() {
                try {
                  throw new Exception();
                } catch (Exception ex) {
                  // BUG: Diagnostic contains: getClassName
                  ex.getStackTrace()[0].getClass().getSimpleName();
                }
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_stackWalkerGetClass() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            class Test {
              void f(StackWalker w) {
                // BUG: Diagnostic contains: getCallerClass
                w.getClass();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_stackFrameGetClass() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.lang.StackWalker.StackFrame;

            class Test {
              void f(StackFrame f) {
                // BUG: Diagnostic contains: getClassName
                f.getClass();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_constructorGetClass() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.lang.reflect.Constructor;

            class Test {
              void f(Constructor<?> c) {
                // BUG: Diagnostic contains: getDeclaringClass
                c.getClass();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_fieldGetClass() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.lang.reflect.Field;

            class Test {
              void f(Field f) {
                // BUG: Diagnostic contains: getDeclaringClass
                f.getClass();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_methodGetClass() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.lang.reflect.Method;

            class Test {
              void f(Method m) {
                // BUG: Diagnostic contains: getDeclaringClass
                m.getClass();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_beanDescriptorGetClass() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.beans.BeanDescriptor;

            class Test {
              void f(BeanDescriptor b) {
                // BUG: Diagnostic contains: getBeanClass
                b.getClass();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_lockInfoGetClass() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.lang.management.LockInfo;
            import java.lang.management.MonitorInfo;

            class Test {
              void f(LockInfo l, MonitorInfo m) {
                // BUG: Diagnostic contains: getClassName
                l.getClass();
                // BUG: Diagnostic contains: getClassName
                m.getClass();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_parameterizedTypeGetClass() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import java.lang.reflect.ParameterizedType;

            class Test {
              void f(ParameterizedType t) {
                // BUG: Diagnostic contains: getRawType
                t.getClass();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_classInfoGetClass() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import com.google.common.reflect.ClassPath.ClassInfo;

            class Test {
              void f(ClassInfo i) {
                // BUG: Diagnostic contains: getName
                i.getClass();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_typeTokenGetClass() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            import com.google.common.reflect.TypeToken;

            class Test {
              void f(TypeToken<?> t) {
                // BUG: Diagnostic contains: getRawType
                t.getClass();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void positive_threadRun() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            class Test {
              void f(Thread t) {
                // BUG: Diagnostic contains: start
                t.run();
              }
            }
            """)
        .doTest();
  }

  @Test
  public void negative_threadSuperRun() {
    testHelper
        .addSourceLines(
            "Test.java",
            """
            class Test extends Thread {
              @Override
              public void run() {
                super.run();
              }
            }
            """)
        .doTest();
  }
}
