/*
 * Copyright 2010 The Closure Compiler 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.javascript.jscomp;

import com.google.common.collect.ImmutableSet;
import com.google.javascript.rhino.Node;
import com.google.javascript.rhino.Token;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** @author agrieve@google.com (Andrew Grieve) */
@RunWith(JUnit4.class)
public final class ProcessTweaksTest extends CompilerTestCase {

  Map<String, Node> defaultValueOverrides;
  boolean stripTweaks;

  public ProcessTweaksTest() {
    super("function alert(arg) {}");
  }

  @Override
  @Before
  public void setUp() throws Exception {
    super.setUp();
    defaultValueOverrides = new HashMap<>();
    stripTweaks = false;
  }

  @Override
  protected CompilerPass getProcessor(final Compiler compiler) {
    return new CompilerPass() {
      @Override
      public void process(Node externs, Node root) {
        ProcessTweaks processTweak =
            new ProcessTweaks(compiler, stripTweaks, defaultValueOverrides);
        processTweak.process(externs, root);

        if (stripTweaks) {
          Set<String> emptySet = ImmutableSet.of();
          final StripCode stripCode =
              new StripCode(compiler, emptySet, emptySet, emptySet, emptySet);
          stripCode.enableTweakStripping();
          stripCode.process(externs, root);
        }
      }
    };
  }

  @Override
  protected int getNumRepetitions() {
    // Only do one repetition, so that we can make sure the first pass keeps
    // GlobalNamespace up to date.
    return 1;
  }

  @Test
  public void testBasicTweak1() {
    testSame("goog.tweak.registerBoolean('Foo', 'Description');" +
        "goog.tweak.getBoolean('Foo')");
  }

  @Test
  public void testBasicTweak2() {
    testSame("goog.tweak.registerString('Foo', 'Description');" +
        "goog.tweak.getString('Foo')");
  }

  @Test
  public void testBasicTweak3() {
    testSame("goog.tweak.registerNumber('Foo', 'Description');" +
        "goog.tweak.getNumber('Foo')");
  }

  @Test
  public void testBasicTweak4() {
    testSame("goog.tweak.registerButton('Foo', 'Description', function() {})");
  }

  @Test
  public void testBasicTweak5() {
    testSame("goog.tweak.registerBoolean('A.b_7', 'Description', true, " +
        "{ requiresRestart:false })");
  }

  @Test
  public void testBasicTweak6() {
    testSame("var opts = { requiresRestart:false };" +
        "goog.tweak.registerBoolean('Foo', 'Description', true, opts)");
  }

  @Test
  public void testNonLiteralId1() {
    testError("goog.tweak.registerBoolean(3, 'Description')",
        ProcessTweaks.NON_LITERAL_TWEAK_ID_ERROR);
  }

  @Test
  public void testNonLiteralId2() {
    testError("goog.tweak.getBoolean('a' + 'b')", ProcessTweaks.NON_LITERAL_TWEAK_ID_ERROR);
  }

  @Test
  public void testNonLiteralId3() {
    testError("var CONST = 'foo'; goog.tweak.overrideDefaultValue(CONST, 3)",
        ProcessTweaks.NON_LITERAL_TWEAK_ID_ERROR);
  }

  @Test
  public void testInvalidId() {
    testError("goog.tweak.registerBoolean('Some ID', 'a')", ProcessTweaks.INVALID_TWEAK_ID_ERROR);
  }

  @Test
  public void testInvalidDefaultValue1() {
    testSame("var val = true; goog.tweak.registerBoolean('Foo', 'desc', val)",
         ProcessTweaks.INVALID_TWEAK_DEFAULT_VALUE_WARNING);
  }

  @Test
  public void testInvalidDefaultValue2() {
    testSame("goog.tweak.overrideDefaultValue('Foo', 3 + 1);" +
        "goog.tweak.registerNumber('Foo', 'desc')",
        ProcessTweaks.INVALID_TWEAK_DEFAULT_VALUE_WARNING);
  }

  @Test
  public void testUnknownGetString() {
    testSame("goog.tweak.getString('huh')",
        ProcessTweaks.UNKNOWN_TWEAK_WARNING);
  }

  @Test
  public void testUnknownGetNumber() {
    testSame("goog.tweak.getNumber('huh')",
        ProcessTweaks.UNKNOWN_TWEAK_WARNING);
  }

  @Test
  public void testUnknownGetBoolean() {
    testSame("goog.tweak.getBoolean('huh')",
        ProcessTweaks.UNKNOWN_TWEAK_WARNING);
  }

  @Test
  public void testUnknownOverride() {
    testSame("goog.tweak.overrideDefaultValue('huh', 'val')",
        ProcessTweaks.UNKNOWN_TWEAK_WARNING);
  }

  @Test
  public void testDuplicateTweak() {
    testError("goog.tweak.registerBoolean('TweakA', 'desc');" +
        "goog.tweak.registerBoolean('TweakA', 'desc')",
        ProcessTweaks.TWEAK_MULTIPLY_REGISTERED_ERROR);
  }

  @Test
  public void testOverrideAfterRegister() {
    testError("goog.tweak.registerBoolean('TweakA', 'desc');" +
        "goog.tweak.overrideDefaultValue('TweakA', 'val')",
        ProcessTweaks.TWEAK_OVERRIDE_AFTER_REGISTERED_ERROR);
  }

  @Test
  public void testRegisterInNonGlobalScope() {
    testError("function foo() {goog.tweak.registerBoolean('TweakA', 'desc');};",
        ProcessTweaks.NON_GLOBAL_TWEAK_INIT_ERROR);
  }

  @Test
  public void testRegisterInIf() {
    testSame("if (true) {goog.tweak.registerBoolean('TweakA', 'desc');};");
  }

  @Test
  public void testWrongGetter1() {
    testSame("goog.tweak.registerBoolean('TweakA', 'desc');" +
        "goog.tweak.getString('TweakA')",
        ProcessTweaks.TWEAK_WRONG_GETTER_TYPE_WARNING);
  }

  @Test
  public void testWrongGetter2() {
    testSame("goog.tweak.registerString('TweakA', 'desc');" +
        "goog.tweak.getNumber('TweakA')",
        ProcessTweaks.TWEAK_WRONG_GETTER_TYPE_WARNING);
  }

  @Test
  public void testWrongGetter3() {
    testSame("goog.tweak.registerNumber('TweakA', 'desc');" +
        "goog.tweak.getBoolean('TweakA')",
        ProcessTweaks.TWEAK_WRONG_GETTER_TYPE_WARNING);
  }

  @Test
  public void testWithNoTweaks() {
    testSame("var DEF=true;var x={};x.foo={}");
  }

  @Test
  public void testStrippingWithImplicitDefaultValues() {
    stripTweaks = true;
    test("goog.tweak.registerNumber('TweakA', 'desc');" +
        "goog.tweak.registerBoolean('TweakB', 'desc');" +
        "goog.tweak.registerString('TweakC', 'desc');" +
        "alert(goog.tweak.getNumber('TweakA'));" +
        "alert(goog.tweak.getBoolean('TweakB'));" +
        "alert(goog.tweak.getString('TweakC'));",
        "void 0; void 0; void 0; alert(0); alert(false); alert('')");
  }

  @Test
  public void testStrippingWithExplicitDefaultValues() {
    stripTweaks = true;
    test("goog.tweak.registerNumber('TweakA', 'desc', 5);" +
        "goog.tweak.registerBoolean('TweakB', 'desc', true);" +
        "goog.tweak.registerString('TweakC', 'desc', '!');" +
        "alert(goog.tweak.getNumber('TweakA'));" +
        "alert(goog.tweak.getBoolean('TweakB'));" +
        "alert(goog.tweak.getString('TweakC'));",
        "void 0; void 0; void 0; alert(5); alert(true); alert('!')");
  }

  @Test
  public void testStrippingWithInCodeOverrides() {
    stripTweaks = true;
    test(
        "goog.tweak.overrideDefaultValue('TweakA', 5);"
            + "goog.tweak.overrideDefaultValue('TweakB', true);"
            + "goog.tweak.overrideDefaultValue('TweakC', 'bar');"
            + "goog.tweak.registerNumber('TweakA', 'desc');"
            + "goog.tweak.registerBoolean('TweakB', 'desc');"
            + "goog.tweak.registerString('TweakC', 'desc', 'foo');"
            + "alert(goog.tweak.getNumber('TweakA'));"
            + "alert(goog.tweak.getBoolean('TweakB'));"
            + "alert(goog.tweak.getString('TweakC'));",
        "void 0; void 0; void 0; void 0; void 0; void 0;" + "alert(5); alert(true); alert('bar');");
  }

  @Test
  public void testStrippingWithUnregisteredTweak1() {
    stripTweaks = true;
    test(
        "alert(goog.tweak.getNumber('TweakA'));",
        "alert(0)",
        warning(ProcessTweaks.UNKNOWN_TWEAK_WARNING));
  }

  @Test
  public void testStrippingWithUnregisteredTweak2() {
    stripTweaks = true;
    test(
        "alert(goog.tweak.getBoolean('TweakB'))",
        "alert(false)",
        warning(ProcessTweaks.UNKNOWN_TWEAK_WARNING));
  }

  @Test
  public void testStrippingWithUnregisteredTweak3() {
    stripTweaks = true;
    test(
        "alert(goog.tweak.getString('TweakC'))",
        "alert('')",
        warning(ProcessTweaks.UNKNOWN_TWEAK_WARNING));
  }

  @Test
  public void testStrippingOfManuallyRegistered1() {
    stripTweaks = true;
    test(
        "var reg = goog.tweak.getRegistry();"
            + "if (reg) {"
            + "  reg.register(new goog.tweak.BooleanSetting('foo', 'desc'));"
            + "  reg.getEntry('foo').setDefaultValue(1);"
            + "}",
        "if (null);");
  }

  @Test
  public void testOverridesWithStripping() {
    stripTweaks = true;
    defaultValueOverrides.put("TweakA", Node.newNumber(1));
    defaultValueOverrides.put("TweakB", new Node(Token.FALSE));
    defaultValueOverrides.put("TweakC", Node.newString("!"));
    test(
        "goog.tweak.overrideDefaultValue('TweakA', 5);"
            + "goog.tweak.overrideDefaultValue('TweakC', 'bar');"
            + "goog.tweak.registerNumber('TweakA', 'desc');"
            + "goog.tweak.registerBoolean('TweakB', 'desc', true);"
            + "goog.tweak.registerString('TweakC', 'desc', 'foo');"
            + "alert(goog.tweak.getNumber('TweakA'));"
            + "alert(goog.tweak.getBoolean('TweakB'));"
            + "alert(goog.tweak.getString('TweakC'));",
        "void 0; void 0; void 0; void 0; void 0; " + "alert(1); alert(false); alert('!')");
  }

  @Test
  public void testCompilerOverridesNoStripping1() {
    defaultValueOverrides.put("TweakA", Node.newNumber(1));
    defaultValueOverrides.put("TweakB", new Node(Token.FALSE));
    defaultValueOverrides.put("TweakC", Node.newString("!"));
    test(
        "goog.tweak.registerNumber('TweakA', 'desc');"
            + "goog.tweak.registerBoolean('TweakB', 'desc', true);"
            + "goog.tweak.registerString('TweakC', 'desc', 'foo');"
            + "var a = goog.tweak.getCompilerOverrides_()",
        "goog.tweak.registerNumber('TweakA', 'desc');"
            + "goog.tweak.registerBoolean('TweakB', 'desc', true);"
            + "goog.tweak.registerString('TweakC', 'desc', 'foo');"
            + "var a = { TweakA: 1, TweakB: false, TweakC: '!' };");
  }

  @Test
  public void testCompilerOverridesNoStripping2() {
    defaultValueOverrides.put("TweakA", Node.newNumber(1));
    defaultValueOverrides.put("TweakB", new Node(Token.FALSE));
    defaultValueOverrides.put("TweakC", Node.newString("!"));
    test(
        "goog.tweak.registerNumber('TweakA', 'desc');"
            + "goog.tweak.registerBoolean('TweakB', 'desc', true);"
            + "goog.tweak.registerString('TweakC', 'desc', 'foo');"
            + "var a = goog.tweak.getCompilerOverrides_();"
            + "var b = goog.tweak.getCompilerOverrides_()",
        "goog.tweak.registerNumber('TweakA', 'desc');"
            + "goog.tweak.registerBoolean('TweakB', 'desc', true);"
            + "goog.tweak.registerString('TweakC', 'desc', 'foo');"
            + "var a = { TweakA: 1, TweakB: false, TweakC: '!' };"
            + "var b = { TweakA: 1, TweakB: false, TweakC: '!' };");
  }

  @Test
  public void testUnknownCompilerOverride() {
    allowSourcelessWarnings();
    defaultValueOverrides.put("TweakA", Node.newString("!"));
    testSame("var a", ProcessTweaks.UNKNOWN_TWEAK_WARNING);
  }

  @Test
  public void testCompilerOverrideWithWrongType() {
    allowSourcelessWarnings();
    defaultValueOverrides.put("TweakA", Node.newString("!"));
    testSame("goog.tweak.registerBoolean('TweakA', 'desc')",
        ProcessTweaks.INVALID_TWEAK_DEFAULT_VALUE_WARNING);
  }
}