plugins/groovy/test/org/jetbrains/plugins/groovy/inspections/GrFinalVariableAccessTest.groovy

/*
 * Copyright 2000-2013 JetBrains s.r.o.
 *
 * 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 org.jetbrains.plugins.groovy.inspections

import com.intellij.codeInspection.InspectionProfileEntry
import org.jetbrains.plugins.groovy.codeInspection.control.finalVar.GrFinalVariableAccessInspection
import org.jetbrains.plugins.groovy.lang.highlighting.GrHighlightingTestBase

/**
 * @author Max Medvedev
 */
class GrFinalVariableAccessTest extends GrHighlightingTestBase {
  @Override
  InspectionProfileEntry[] getCustomInspections() { [new GrFinalVariableAccessInspection()] }

  void testSimpleVar() {
    testHighlighting('''
      final foo = 5
      <warning>foo</warning> = 7
      print foo
    ''')
  }

  void testSplitInit() {
    testHighlighting('''
      final foo
      foo = 7
      <warning>foo</warning> = 8
      print foo
    ''')
  }

  void testIf1() {
    testHighlighting('''
      final foo = 5
      if (cond) {
        <warning>foo</warning> = 7
      }
      print foo
    ''')
  }

  void testIf2() {
    testHighlighting('''
      final foo
      if (cond) {
        foo = 7
      }
      else {
        foo = 2
      }
      <warning>foo</warning> = 1
      print foo
    ''')
  }

  void testIf3() {
    testHighlighting('''
      final foo
      if (cond) {
        foo = 7
      }
      <warning>foo</warning> = 1
      print foo
    ''')
  }

  void testFor() {
    testHighlighting('''
      for (a in b) {
        final x = 5  //all correct
        print x
      }
    ''')
  }

  void testFor2() {
    testHighlighting('''
      final foo = 5
      for (a in b) {
        <warning>foo</warning> = 5
        print foo
      }
    ''')
  }

  void testFor3() {
    testHighlighting('''
      for (a in b)
        final foo = 5  //correct code
    ''')
  }

  void testForParam() {
    testHighlighting('''
      for (final i : [1, 2]) {
        <warning>i</warning> = 5
        print i
      }
    ''')
  }

  void testDuplicatedVar() {
    testHighlighting('''
      if (cond) {
        final foo = 5
        print foo
      }

      if (otherCond) {
        final foo = 2  //correct
        <warning>foo</warning> = 4
        print foo
      }

      if (anotherCond)
        final foo = 3 //correct
''')
  }

  void testDuplicatedVar2() {
    testHighlighting('''
      if (cond) {
        final foo = 5
        <warning>foo</warning> = 4
        print foo
      }

      if (otherCond) {
        foo = 4
        print foo
      }

      if (anotherCond)
        final foo = 3 //correct
''')
  }

  void testDuplicatedVar3() {
    testHighlighting('''
      class X {
        def bar() {
          if (cond) {
            final foo = 5
            <warning>foo</warning> = 4
            print foo
          }

          if (otherCond) {
            foo = 4
            print foo
          }

          if (anotherCond)
            final foo = 3 //correct
        }
      }
''')
  }

  void testFinalField0() {
    testHighlighting('''
      class Foo {
        final <warning>foo</warning>
      }
    ''')
  }

  void testFinalField1() {
    testHighlighting('''
      class Foo {
        final foo //correct

        def Foo() {
          foo = 2
        }
      }
    ''')
  }

  void testFinalField2() {
    testHighlighting('''
      class Foo {
        final <warning>foo</warning>

        def Foo() {
          foo = 2
        }

        def Foo(x) {
        }
      }
    ''')
  }

  void testFinalField3() {
    testHighlighting('''
      class Foo {
        final foo;

        {
          foo = 3
        }

        def Foo() {
          <warning>foo</warning> = 2
        }

        def Foo(x) {
        }
      }
    ''')
  }

  void testFinalField4() {
    testHighlighting('''
      class Foo {
        final foo //correct

        def Foo() {
          foo = 2
        }

        def Foo(x) {
          this()
        }
      }
    ''')
  }

  void testFinalField5() {
    testHighlighting('''
      class Foo {
        final <warning>foo</warning> //correct

        def Foo() {

        }

        def Foo(x) {
          this()
        }
      }
    ''')
  }

  void testFinalField6() {
    testHighlighting('''
      class Foo {
        final <warning>foo</warning> //correct

        <error>def Foo()</error> {
          this(2)
        }

        <error>def Foo(x)</error> {
          this()
        }
      }
    ''')
  }

  void testStaticFinalField0() {
    testHighlighting('''
      class Foo {
        static final foo = 5 //correct
      }
    ''')
  }

  void testStaticFinalField1() {
    testHighlighting('''
      class Foo {
        static final <warning>foo</warning>
      }
    ''')
  }

  void testStaticFinalField2() {
    testHighlighting('''
      class Foo {
        static final <warning>foo</warning>

        static {
          if (1) {
            foo = 1
          }
        }
      }
    ''')
  }

  void testStaticFinalField3() {
    testHighlighting('''
      class Foo {
        static final foo //correct

        static {
          if (1) {
            foo = 1
          }
          else {
            foo = -1
          }
        }
      }
    ''')
  }

  void testStaticFinalField4() {
    testHighlighting('''
      class Foo {
        static final foo //correct

        static {
          print 1
        }

        static {
          if (1) {
            foo = 1
          }
          else {
            foo = -1
          }
        }
      }
    ''')
  }

  void testFinalFieldInit0() {
    testHighlighting('''
      class Foo {
        final foo = 0;

        {
          <warning>foo</warning> = 1
        }
      }
    ''')
  }

  void testFinalFieldInit1() {
    testHighlighting('''
      class Foo {
        final foo;

        {
          foo = 0
        }

        {
          <warning>foo</warning> = 1
        }
      }
    ''')
  }

  void testFinalFieldInit2() {
    testHighlighting('''
      class Foo {
        final foo;

        {
          foo = 0
        }

        Foo(){
          <warning>foo</warning> = 1
        }
      }
    ''')
  }

  void testFinalFieldInit3() {
    testHighlighting('''
      class Foo {
        final foo;

        Foo(x){
          foo = 0
        }

        Foo(){
          this(1)
          <warning>foo</warning> = 1
        }
      }
    ''')
  }

  void testFinalFieldInit4() {
    testHighlighting('''
      class Foo {
        final foo;

        {
          foo = 0
          <warning>foo</warning> = 2
        }

      }
    ''')
  }

  void testFinalFieldInit5() {
    testHighlighting('''
      class Foo {
        final foo;

        {
          if (1) {
            foo = 0
          }
          <warning>foo</warning> = 2
        }

      }
    ''')
  }

  void testFinalFieldAccess() {
    testHighlighting('''
      class Foo {
        public final foo = 5
      }

      <warning>new Foo().foo</warning> = 3
    ''')
  }

  void testImmutable() {
    testHighlighting('''
import groovy.transform.Immutable

@Immutable
class Money {
    String currency
    int amount
    private final <warning>privateField</warning>

    void doubleYourMoney() {
        <error>amount</error> *= 2
    }
}

def a = new Money('USA', 100)
<warning>a.amount</warning> = 1000
''')
  }

  void testNonFinalField1() {
    testHighlighting('''
class A {
  int foo

  def A() {
    foo = 5
    foo = 5 //correct
  }
}''')
  }

  void testNonFinalField2() {
    testHighlighting('''
class A {
  int foo = 5

  def A() {
    foo = 5 //correct
    foo = 5 //correct
  }
}''')
  }

  void 'test Field And Parameter With The Same Name'() {
    testHighlighting('''\
class Aaa {
    final int foo
    final int bar

    Aaa(int foo, int p) {
        this.foo = foo      // this assignment is erroneously reported as invalid
        this.bar = p        // this one is not reported
    }
}
''')
  }

  void testEnumConstants() {
    testHighlighting('''\
enum E {
  abc, cde

  final int <warning descr="Variable 'x' might not have been initialized">x</warning>
}
''')
  }

  void testInc() {
    testHighlighting('''\
class Aaa {
    final int foo = 0

    def test(final String p) {
        ++<warning>foo</warning>
        ++<warning>p</warning>

        final int i = 0
        ++<warning>i</warning>
    }
}
''')
  }
}