/*
 * Copyright (C) 2014 The Android Open Source Project
 *
 * 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.android.jack.error;

import com.android.jack.frontend.FrontendCompilationException;
import com.android.jack.test.helper.ErrorTestHelper;
import com.android.jack.test.toolchain.AbstractTestTools;
import com.android.jack.test.toolchain.IToolchain;
import com.android.jack.test.toolchain.JackApiToolchainBase;

import org.junit.Assert;
import org.junit.Test;

import java.io.ByteArrayOutputStream;

import javax.annotation.Nonnull;

/**
 * JUnit test checking Jack behavior with source errors.
 */
public class SourceErrorTest {

  /**
   * Checks that compilation fails because of invalid "class" keyword.
   */
  @Test
  public void testInvalidSource001() throws Exception {
    ErrorTestHelper helper = new ErrorTestHelper();

    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "A.java", "package jack.invalidsource;\n"
        + "public clas A {}\n");

    JackApiToolchainBase toolchain =
        AbstractTestTools.getCandidateToolchain(JackApiToolchainBase.class);

    ByteArrayOutputStream errOut = new ByteArrayOutputStream();
    toolchain.setErrorStream(errOut);

    try {
      compile(toolchain, helper);
      Assert.fail();
    } catch (FrontendCompilationException ex) {
      // Failure is ok since source does not compile.
    } finally {
      Assert.assertTrue(
          errOut.toString().contains("Syntax error on token \"clas\", class expected"));
    }
  }

  /**
   * Checks that compilation fails because of invalid "public" keyword.
   */
  @Test
  public void testInvalidSource002() throws Exception {
    ErrorTestHelper helper = new ErrorTestHelper();

    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "A.java", "package jack.invalidsource;\n"
        + "publi class A {}\n");

    JackApiToolchainBase toolchain =
        AbstractTestTools.getCandidateToolchain(JackApiToolchainBase.class);

    ByteArrayOutputStream errOut = new ByteArrayOutputStream();
    toolchain.setErrorStream(errOut);

    try {
      compile(toolchain, helper);
      Assert.fail();
    } catch (FrontendCompilationException ex) {
      // Failure is ok since source does not compile.
    } finally {
      Assert.assertTrue(
          errOut.toString().contains("Syntax error on token \"publi\", public expected"));
    }
  }

  /**
   * Checks that compilation fails because of a class name that does not match the file name.
   */
  @Test
  public void testInvalidSource003() throws Exception {
    ErrorTestHelper helper = new ErrorTestHelper();

    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "A.java", "package jack.invalidsource;\n"
        + "public class B {}\n");

    JackApiToolchainBase toolchain =
        AbstractTestTools.getCandidateToolchain(JackApiToolchainBase.class);

    ByteArrayOutputStream errOut = new ByteArrayOutputStream();
    toolchain.setErrorStream(errOut);

    try {
      compile(toolchain, helper);
      Assert.fail();
    } catch (FrontendCompilationException ex) {
      // Failure is ok since source does not compile.
    } finally {
      Assert.assertTrue(
          errOut.toString().contains("The public type B must be defined in its own file"));
    }
  }

  /**
   * Checks that compilation fails because of an import of a class that is not on classpath.
   */
  @Test
  public void testInvalidSource004() throws Exception {
    ErrorTestHelper helper = new ErrorTestHelper();

    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "A.java", "package jack.invalidsource;\n"
        + "import jack.invalidsource.B;\n"
        + "public class A {}\n");

    JackApiToolchainBase toolchain =
        AbstractTestTools.getCandidateToolchain(JackApiToolchainBase.class);

    ByteArrayOutputStream errOut = new ByteArrayOutputStream();
    toolchain.setErrorStream(errOut);

    try {
      compile(toolchain, helper);
      Assert.fail();
    } catch (FrontendCompilationException ex) {
      // Failure is ok since source does not compile.
    } finally {
      Assert.assertTrue(
          errOut.toString().contains("The import jack.invalidsource.B cannot be resolved"));
    }
  }

  /**
   * Checks that compilation fails because there are too many methods in a single class.
   */
  @Test
  public void testInvalidSource005() throws Exception {
    ErrorTestHelper helper = new ErrorTestHelper();

    int methodCount = 65536;
    StringBuilder content =
        new StringBuilder("public class A {");
    // -1 due to implicit init method
    for (int mthIdx = 0; mthIdx < methodCount - 1; mthIdx++) {
      content.append("public void m" + mthIdx + "() {} \n");
    }
    content.append("} \n");

    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.overflow", "A.java",
        "package jack.overflow; \n" + content.toString());

    JackApiToolchainBase toolchain =
        AbstractTestTools.getCandidateToolchain(JackApiToolchainBase.class);

    ByteArrayOutputStream out = new ByteArrayOutputStream();
    ByteArrayOutputStream errOut = new ByteArrayOutputStream();
    toolchain.setOutputStream(out);
    toolchain.setErrorStream(errOut);

    try {
      compile(toolchain, helper);
      Assert.fail();
    } catch (FrontendCompilationException e) {
      // Failure is ok, since there are too many methods.
    } finally {
      Assert.assertEquals("", out.toString());
      Assert.assertTrue(
          errOut.toString().contains("Too many methods for type A. Maximum is 65535"));
    }
  }

  /**
   * Checks that compilation fails because of several source errors.
   */
  @Test
  public void testInvalidSource006() throws Exception {
    ErrorTestHelper helper = new ErrorTestHelper();

    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "A.java", "package jack.invalidsource;\n"
        + "public class A { private voi m() {} } \n");
    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "B.java", "package jack.invalidsource;\n"
        + "public class B { private void m(in a) {}; \n private void n(int a) {re}; } \n");

    JackApiToolchainBase toolchain =
        AbstractTestTools.getCandidateToolchain(JackApiToolchainBase.class);

    ByteArrayOutputStream out = new ByteArrayOutputStream();
    ByteArrayOutputStream errOut = new ByteArrayOutputStream();
    toolchain.setOutputStream(out);
    toolchain.setErrorStream(errOut);

    try {
      compile(toolchain, helper);
      Assert.fail();
    }  catch (FrontendCompilationException ex) {
      // Failure is ok since source does not compile.
    } finally {
      Assert.assertEquals("", out.toString());
      String errorString = errOut.toString();
      Assert.assertTrue(errorString.contains("in cannot be resolved to a type"));
      Assert.assertTrue(errorString.contains(
          "Syntax error, insert \"VariableDeclarators\" to complete LocalVariableDeclaration"));
      Assert.assertTrue(
          errorString.contains("Syntax error, insert \";\" to complete BlockStatements"));
      Assert.assertTrue(errorString.contains("voi cannot be resolved to a type"));
    }
  }

  /**
   * Checks that compilation fails because of a source error, with also some warnings.
   */
  @Test
  public void testInvalidSource007() throws Exception {
    ErrorTestHelper helper = new ErrorTestHelper();

    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "A.java", "package jack.invalidsource;\n"
        + "public class A { private void m() {} } \n");
    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "B.java", "package jack.invalidsource;\n"
        + "public class B { private void m(in a) {}; \n private void n(int a) {}; } \n");

    JackApiToolchainBase toolchain =
        AbstractTestTools.getCandidateToolchain(JackApiToolchainBase.class);

    ByteArrayOutputStream out = new ByteArrayOutputStream();
    ByteArrayOutputStream errOut = new ByteArrayOutputStream();
    toolchain.setOutputStream(out);
    toolchain.setErrorStream(errOut);

    try {
      compile(toolchain, helper);
      Assert.fail();
    } catch (FrontendCompilationException ex) {
      // Failure is ok since source does not compile.
    } finally {
      Assert.assertEquals("", out.toString());
      Assert.assertTrue(errOut.toString().contains("in cannot be resolved to a type"));
      Assert.assertTrue(errOut.toString().contains(
          "The method n(int) from the type B is never used locally"));
      Assert.assertTrue(
          errOut.toString().contains("The method m() from the type A is never used locally"));
    }
  }

  /**
   * Checks that compilation succeeds but prints several warnings.
   */
  @Test
  public void testInvalidSource008() throws Exception {
    ErrorTestHelper helper = new ErrorTestHelper();

    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "A.java", "package jack.invalidsource;\n"
        + "public class A { private void m() {} } \n");
    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "B.java", "package jack.invalidsource;\n"
        + "public class B { private void m(int a) {}; \n private void n(int a) {}; } \n");

    JackApiToolchainBase toolchain =
        AbstractTestTools.getCandidateToolchain(JackApiToolchainBase.class);

    ByteArrayOutputStream out = new ByteArrayOutputStream();
    ByteArrayOutputStream errOut = new ByteArrayOutputStream();
    toolchain.setOutputStream(out);
    toolchain.setErrorStream(errOut);

    try {
      compile(toolchain, helper);
    }  finally {
      Assert.assertEquals("", out.toString());
      Assert.assertTrue(errOut.toString().contains(
          "The method m(int) from the type B is never used locally"));
      Assert.assertTrue(errOut.toString().contains(
          "The method n(int) from the type B is never used locally"));
      Assert.assertTrue(
          errOut.toString().contains("The method m() from the type A is never used locally"));
    }
  }

  /**
   * Checks that compilation fails because of an invalid type.
   * undefinedTypeId = typeRelatedCategory + 2
   */
  @Test
  public void testInvalidSource009() throws Exception {
    ErrorTestHelper helper = new ErrorTestHelper();

    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "A.java", "package jack.invalidsource;\n"
        + "public class A { private void m(in a) {}; } \n");

    JackApiToolchainBase toolchain =
        AbstractTestTools.getCandidateToolchain(JackApiToolchainBase.class);

    ByteArrayOutputStream out = new ByteArrayOutputStream();
    ByteArrayOutputStream errOut = new ByteArrayOutputStream();
    toolchain.setOutputStream(out);
    toolchain.setErrorStream(errOut);

    try {
      compile(toolchain, helper);
      Assert.fail();
    } catch (FrontendCompilationException ex) {
      // Failure is ok since source does not compile.
    } finally {
      Assert.assertEquals("", out.toString());
      Assert.assertTrue(errOut.toString().contains("in cannot be resolved to a type"));
    }
  }

  /**
   * Checks that compilation fails because of a parsing error.
   * parsingErrorInsertToCompleteId = syntaxCategory + internalCategory + 240
   */
  @Test
  public void testInvalidSource010() throws Exception {
    ErrorTestHelper helper = new ErrorTestHelper();

    AbstractTestTools.createFile(helper.getSourceFolder(), "jack.invalidsource", "A.java", "package jack.invalidsource;\n"
        + "public class A { private void n(int a) {re;} } \n");

    JackApiToolchainBase toolchain =
        AbstractTestTools.getCandidateToolchain(JackApiToolchainBase.class);

    ByteArrayOutputStream out = new ByteArrayOutputStream();
    ByteArrayOutputStream errOut = new ByteArrayOutputStream();
    toolchain.setOutputStream(out);
    toolchain.setErrorStream(errOut);

    try {
      compile(toolchain, helper);
      Assert.fail();
    } catch (FrontendCompilationException ex) {
      // Failure is ok since source does not compile.
    } finally {
      Assert.assertEquals("", out.toString());
      Assert.assertTrue(errOut.toString().contains(
          "Syntax error, insert \"VariableDeclarators\" to complete LocalVariableDeclaration"));
    }
  }

  private void compile(@Nonnull IToolchain toolchain, @Nonnull ErrorTestHelper helper)
      throws Exception {
    toolchain.addToClasspath(toolchain.getDefaultBootClasspath())
    .srcToExe(
        helper.getOutputDexFolder(),
        /* zipFile = */ false, helper.getSourceFolder());
  }

}