/*
 * Copyright 2014 Google LLC
 *
 * 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.auto.value.processor;

import static com.google.common.truth.Truth8.assertThat;
import static com.google.testing.compile.CompilationSubject.assertThat;
import static com.google.testing.compile.Compiler.javac;

import com.google.testing.compile.Compilation;
import com.google.testing.compile.JavaFileObjects;
import javax.tools.JavaFileObject;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** @author emcmanus@google.com (Éamonn McManus) */
@RunWith(JUnit4.class)
public class AutoAnnotationCompilationTest {

  @Test
  public void testSimple() {
    JavaFileObject myAnnotationJavaFile =
        JavaFileObjects.forSourceLines(
            "com.example.annotations.MyAnnotation",
            "package com.example.annotations;",
            "",
            "import com.example.enums.MyEnum;",
            "",
            "public @interface MyAnnotation {",
            "  MyEnum value();",
            "  int defaultedValue() default 23;",
            "}");
    int invariableHash = ("defaultedValue".hashCode() * 127) ^ 23;
    JavaFileObject myEnumJavaFile =
        JavaFileObjects.forSourceLines(
            "com.example.enums.MyEnum",
            "package com.example.enums;",
            "",
            "public enum MyEnum {",
            "  ONE",
            "}");
    JavaFileObject annotationFactoryJavaFile =
        JavaFileObjects.forSourceLines(
            "com.example.factories.AnnotationFactory",
            "package com.example.factories;",
            "",
            "import com.google.auto.value.AutoAnnotation;",
            "import com.example.annotations.MyAnnotation;",
            "import com.example.enums.MyEnum;",
            "",
            "public class AnnotationFactory {",
            "  @AutoAnnotation",
            "  public static MyAnnotation newMyAnnotation(MyEnum value) {",
            "    return new AutoAnnotation_AnnotationFactory_newMyAnnotation(value);",
            "  }",
            "}");
    JavaFileObject expectedOutput =
        JavaFileObjects.forSourceLines(
            "com.example.factories.AutoAnnotation_AnnotationFactory_newMyAnnotation",
            "package com.example.factories;",
            "",
            "import com.example.annotations.MyAnnotation;",
            "import com.example.enums.MyEnum;",
            "import java.io.Serializable;",
            GeneratedImport.importGeneratedAnnotationType(),
            "",
            "@Generated(\"" + AutoAnnotationProcessor.class.getName() + "\")",
            "final class AutoAnnotation_AnnotationFactory_newMyAnnotation",
            "     implements MyAnnotation, Serializable {",
            "  private static final long serialVersionUID = -7473814294717163169L;",
            "  private final MyEnum value;",
            "  private static final int defaultedValue = 23;",
            "",
            "  AutoAnnotation_AnnotationFactory_newMyAnnotation(MyEnum value) {",
            "    if (value == null) {",
            "      throw new NullPointerException(\"Null value\");",
            "    }",
            "    this.value = value;",
            "  }",
            "",
            "  @Override public Class<? extends MyAnnotation> annotationType() {",
            "    return MyAnnotation.class;",
            "  }",
            "",
            "  @Override public MyEnum value() {",
            "    return value;",
            "  }",
            "",
            "  @Override public int defaultedValue() {",
            "    return defaultedValue;",
            "  }",
            "",
            "  @Override public String toString() {",
            "    StringBuilder sb = new StringBuilder(\"@com.example.annotations.MyAnnotation(\");",
            "    sb.append(value);",
            "    return sb.append(')').toString();",
            "  }",
            "",
            "  @Override public boolean equals(Object o) {",
            "    if (o == this) {",
            "      return true;",
            "    }",
            "    if (o instanceof MyAnnotation) {",
            "      MyAnnotation that = (MyAnnotation) o;",
            "      return value.equals(that.value())",
            "          && (defaultedValue == that.defaultedValue());",
            "    }",
            "    return false;",
            "  }",
            "",
            "  @Override public int hashCode() {",
            "    return ",
            "        " + invariableHash,
            "        + (" + 127 * "value".hashCode() + " ^ value.hashCode())",
            "    ;",
            "  }",
            "}");
    Compilation compilation =
        javac()
            .withProcessors(new AutoAnnotationProcessor())
            .compile(annotationFactoryJavaFile, myAnnotationJavaFile, myEnumJavaFile);
    assertThat(compilation).succeededWithoutWarnings();
    assertThat(compilation)
        .generatedSourceFile(
            "com.example.factories.AutoAnnotation_AnnotationFactory_newMyAnnotation")
        .hasSourceEquivalentTo(expectedOutput);
  }

  @Test
  public void testEmptyPackage() {
    JavaFileObject myAnnotationJavaFile =
        JavaFileObjects.forSourceLines(
            "MyAnnotation", //
            "public @interface MyAnnotation {}");
    JavaFileObject annotationFactoryJavaFile =
        JavaFileObjects.forSourceLines(
            "AnnotationFactory",
            "import com.google.auto.value.AutoAnnotation;",
            "",
            "public class AnnotationFactory {",
            "  @AutoAnnotation",
            "  public static MyAnnotation newMyAnnotation() {",
            "    return new AutoAnnotation_AnnotationFactory_newMyAnnotation();",
            "  }",
            "}");
    JavaFileObject expectedOutput =
        JavaFileObjects.forSourceLines(
            "AutoAnnotation_AnnotationFactory_newMyAnnotation",
            "import java.io.Serializable;",
            GeneratedImport.importGeneratedAnnotationType(),
            "",
            "@Generated(\"" + AutoAnnotationProcessor.class.getName() + "\")",
            "final class AutoAnnotation_AnnotationFactory_newMyAnnotation",
            "    implements MyAnnotation, Serializable {",
            "  private static final long serialVersionUID = 0L;",
            "  AutoAnnotation_AnnotationFactory_newMyAnnotation() {",
            "  }",
            "",
            "  @Override public Class<? extends MyAnnotation> annotationType() {",
            "    return MyAnnotation.class;",
            "  }",
            "",
            "  @Override public String toString() {",
            "    StringBuilder sb = new StringBuilder(\"@MyAnnotation(\");",
            "    return sb.append(')').toString();",
            "  }",
            "",
            "  @Override public boolean equals(Object o) {",
            "    if (o == this) {",
            "      return true;",
            "    }",
            "    if (o instanceof MyAnnotation) {",
            "      return true;",
            "    }",
            "    return false;",
            "  }",
            "",
            "  @Override public int hashCode() {",
            "    return 0;",
            "  }",
            "}");
    Compilation compilation =
        javac()
            .withProcessors(new AutoAnnotationProcessor())
            .compile(annotationFactoryJavaFile, myAnnotationJavaFile);
    assertThat(compilation).succeededWithoutWarnings();
    assertThat(compilation)
        .generatedSourceFile("AutoAnnotation_AnnotationFactory_newMyAnnotation")
        .hasSourceEquivalentTo(expectedOutput);
  }

  @Test
  public void testGwtSimple() {
    JavaFileObject myAnnotationJavaFile =
        JavaFileObjects.forSourceLines(
            "com.example.annotations.MyAnnotation",
            "package com.example.annotations;",
            "",
            "import com.google.common.annotations.GwtCompatible;",
            "",
            "@GwtCompatible",
            "public @interface MyAnnotation {",
            "  int[] value();",
            "}");
    JavaFileObject gwtCompatibleJavaFile =
        JavaFileObjects.forSourceLines(
            "com.google.common.annotations.GwtCompatible",
            "package com.google.common.annotations;",
            "",
            "public @interface GwtCompatible {}");
    JavaFileObject annotationFactoryJavaFile =
        JavaFileObjects.forSourceLines(
            "com.example.factories.AnnotationFactory",
            "package com.example.factories;",
            "",
            "import com.google.auto.value.AutoAnnotation;",
            "import com.example.annotations.MyAnnotation;",
            "",
            "public class AnnotationFactory {",
            "  @AutoAnnotation",
            "  public static MyAnnotation newMyAnnotation(int[] value) {",
            "    return new AutoAnnotation_AnnotationFactory_newMyAnnotation(value);",
            "  }",
            "}");
    JavaFileObject expectedOutput =
        JavaFileObjects.forSourceLines(
            "com.example.factories.AutoAnnotation_AnnotationFactory_newMyAnnotation",
            "package com.example.factories;",
            "",
            "import com.example.annotations.MyAnnotation;",
            "import java.io.Serializable",
            "import java.util.Arrays;",
            GeneratedImport.importGeneratedAnnotationType(),
            "",
            "@Generated(\"" + AutoAnnotationProcessor.class.getName() + "\")",
            "final class AutoAnnotation_AnnotationFactory_newMyAnnotation implements MyAnnotation,"
                + " Serializable {",
            "  private static final long serialVersionUID = -8116050813861599066L;",
            "  private final int[] value;",
            "",
            "  AutoAnnotation_AnnotationFactory_newMyAnnotation(int[] value) {",
            "    if (value == null) {",
            "      throw new NullPointerException(\"Null value\");",
            "    }",
            "    this.value = Arrays.copyOf(value, value.length);",
            "  }",
            "",
            "  @Override public Class<? extends MyAnnotation> annotationType() {",
            "    return MyAnnotation.class;",
            "  }",
            "",
            "  @Override public int[] value() {",
            "    return Arrays.copyOf(value, value.length);",
            "  }",
            "",
            "  @Override public String toString() {",
            "    StringBuilder sb = new StringBuilder(\"@com.example.annotations.MyAnnotation(\");",
            "    sb.append(Arrays.toString(value));",
            "    return sb.append(')').toString();",
            "  }",
            "",
            "  @Override public boolean equals(Object o) {",
            "    if (o == this) {",
            "      return true;",
            "    }",
            "    if (o instanceof MyAnnotation) {",
            "      MyAnnotation that = (MyAnnotation) o;",
            "      return Arrays.equals(value,",
            "          (that instanceof AutoAnnotation_AnnotationFactory_newMyAnnotation)",
            "              ? ((AutoAnnotation_AnnotationFactory_newMyAnnotation) that).value",
            "              : that.value());",
            "    }",
            "    return false;",
            "  }",
            "",
            "  @Override public int hashCode() {",
            "    return ",
            "        + (" + 127 * "value".hashCode() + " ^ Arrays.hashCode(value));",
            "  }",
            "}");
    Compilation compilation =
        javac()
            .withProcessors(new AutoAnnotationProcessor())
            .compile(annotationFactoryJavaFile, myAnnotationJavaFile, gwtCompatibleJavaFile);
    assertThat(compilation).succeededWithoutWarnings();
    assertThat(compilation)
        .generatedSourceFile(
            "com.example.factories.AutoAnnotation_AnnotationFactory_newMyAnnotation")
        .hasSourceEquivalentTo(expectedOutput);
  }

  @Test
  public void testCollectionsForArrays() {
    JavaFileObject myAnnotationJavaFile =
        JavaFileObjects.forSourceLines(
            "com.example.annotations.MyAnnotation",
            "package com.example.annotations;",
            "",
            "import com.example.enums.MyEnum;",
            "",
            "public @interface MyAnnotation {",
            "  int[] value();",
            "  MyEnum[] enums() default {};",
            "}");
    JavaFileObject myEnumJavaFile =
        JavaFileObjects.forSourceLines(
            "com.example.enums.MyEnum",
            "package com.example.enums;",
            "",
            "public enum MyEnum {",
            "  ONE",
            "}");
    JavaFileObject annotationFactoryJavaFile =
        JavaFileObjects.forSourceLines(
            "com.example.factories.AnnotationFactory",
            "package com.example.factories;",
            "",
            "import com.google.auto.value.AutoAnnotation;",
            "import com.example.annotations.MyAnnotation;",
            "import com.example.enums.MyEnum;",
            "",
            "import java.util.List;",
            "import java.util.Set;",
            "",
            "public class AnnotationFactory {",
            "  @AutoAnnotation",
            "  public static MyAnnotation newMyAnnotation(",
            "      List<Integer> value, Set<MyEnum> enums) {",
            "    return new AutoAnnotation_AnnotationFactory_newMyAnnotation(value, enums);",
            "  }",
            "}");
    JavaFileObject expectedOutput =
        JavaFileObjects.forSourceLines(
            "com.example.factories.AutoAnnotation_AnnotationFactory_newMyAnnotation",
            "package com.example.factories;",
            "",
            "import com.example.annotations.MyAnnotation;",
            "import com.example.enums.MyEnum;",
            "import java.io.Serializable;",
            "import java.util.Arrays;",
            "import java.util.Collection;",
            "import java.util.List;",
            "import java.util.Set;",
            GeneratedImport.importGeneratedAnnotationType(),
            "",
            "@Generated(\"" + AutoAnnotationProcessor.class.getName() + "\")",
            "final class AutoAnnotation_AnnotationFactory_newMyAnnotation implements MyAnnotation,"
                + " Serializable {",
            "  private static final long serialVersionUID = -2102364343628921304L;",
            "  private final int[] value;",
            "  private final MyEnum[] enums;",
            "",
            "  AutoAnnotation_AnnotationFactory_newMyAnnotation(",
            "      List<Integer> value,",
            "      Set<MyEnum> enums) {",
            "    if (value == null) {",
            "      throw new NullPointerException(\"Null value\");",
            "    }",
            "    this.value = intArrayFromCollection(value);",
            "    if (enums == null) {",
            "      throw new NullPointerException(\"Null enums\");",
            "    }",
            "    this.enums = enums.toArray(new MyEnum[0];",
            "  }",
            "",
            "  @Override public Class<? extends MyAnnotation> annotationType() {",
            "    return MyAnnotation.class;",
            "  }",
            "",
            "  @Override public int[] value() {",
            "    return value.clone();",
            "  }",
            "",
            "  @Override public MyEnum[] enums() {",
            "    return enums.clone();",
            "  }",
            "",
            "  @Override public String toString() {",
            "    StringBuilder sb = new StringBuilder(\"@com.example.annotations.MyAnnotation(\");",
            "    sb.append(\"value=\");",
            "    sb.append(Arrays.toString(value));",
            "    sb.append(\", \");",
            "    sb.append(\"enums=\");",
            "    sb.append(Arrays.toString(enums));",
            "    return sb.append(')').toString();",
            "  }",
            "",
            "  @Override public boolean equals(Object o) {",
            "    if (o == this) {",
            "      return true;",
            "    }",
            "    if (o instanceof MyAnnotation) {",
            "      MyAnnotation that = (MyAnnotation) o;",
            "      return Arrays.equals(value,",
            "          (that instanceof AutoAnnotation_AnnotationFactory_newMyAnnotation)",
            "              ? ((AutoAnnotation_AnnotationFactory_newMyAnnotation) that).value",
            "              : that.value())",
            "          && Arrays.equals(enums,",
            "          (that instanceof AutoAnnotation_AnnotationFactory_newMyAnnotation)",
            "              ? ((AutoAnnotation_AnnotationFactory_newMyAnnotation) that).enums",
            "              : that.enums())",
            "    }",
            "    return false;",
            "  }",
            "",
            "  @Override public int hashCode() {",
            "    return ",
            "        + (" + 127 * "value".hashCode() + " ^ Arrays.hashCode(value))",
            "        + (" + 127 * "enums".hashCode() + " ^ Arrays.hashCode(enums));",
            "  }",
            "",
            "  private static int[] intArrayFromCollection(Collection<Integer> c) {",
            "    int[] a = new int[c.size()];",
            "    int i = 0;",
            "    for (int x : c) {",
            "      a[i++] = x;",
            "    }",
            "    return a;",
            "  }",
            "}");
    Compilation compilation =
        javac()
            .withProcessors(new AutoAnnotationProcessor())
            .compile(annotationFactoryJavaFile, myEnumJavaFile, myAnnotationJavaFile);
    assertThat(compilation).succeededWithoutWarnings();
    assertThat(compilation)
        .generatedSourceFile(
            "com.example.factories.AutoAnnotation_AnnotationFactory_newMyAnnotation")
        .hasSourceEquivalentTo(expectedOutput);
  }

  @Test
  public void testMissingClass() {
    // Test that referring to an undefined annotation does not trigger @AutoAnnotation processing.
    // The class Erroneous references an undefined annotation @NotAutoAnnotation. If we didn't have
    // any special treatment of undefined types then we could run into a compiler bug where
    // AutoAnnotationProcessor would think that a method annotated with @NotAutoAnnotation was in
    // fact annotated with @AutoAnnotation. As it is, we do get an error about @NotAutoAnnotation
    // being undefined, and we do not get an error complaining that this supposed @AutoAnnotation
    // method is not static. We do need to have @AutoAnnotation appear somewhere so that the
    // processor will run.
    JavaFileObject erroneousJavaFileObject =
        JavaFileObjects.forSourceLines(
            "com.example.annotations.Erroneous",
            "package com.example.annotations;",
            "",
            "import com.google.auto.value.AutoAnnotation;",
            "",
            "public class Erroneous {",
            "  @interface Empty {}",
            "  @AutoAnnotation static Empty newEmpty() {}",
            "  @NotAutoAnnotation Empty notNewEmpty() {}",
            "}");
    Compilation compilation =
        javac()
            .withProcessors(new AutoAnnotationProcessor())
            .compile(erroneousJavaFileObject);
    assertThat(compilation)
        .hadErrorContaining("NotAutoAnnotation")
        .inFile(erroneousJavaFileObject)
        .onLineContaining("@NotAutoAnnotation");
    assertThat(
            compilation.errors().stream()
                .map(diag -> diag.getMessage(null))
                .filter(m -> m.contains("static")))
        .isEmpty();
  }
}
