blob: 98dd9a864796ac014cf61d9098097f7e6deff6c8 [file] [log] [blame]
/*
* Copyright (C) 2018 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.tools.lint.checks
import com.android.testutils.TestUtils
import com.android.tools.lint.checks.infrastructure.TestFile
import com.android.tools.lint.checks.infrastructure.TestFiles.java
import com.android.tools.lint.checks.infrastructure.TestLintTask
import org.junit.Test
class IgnoreWithoutReasonDetectorTest {
private fun lint(): TestLintTask {
return TestLintTask().sdkHome(TestUtils.getSdk())
}
private val stubJUnitTest: TestFile = java(
"""
package org.junit;
@SuppressWarnings("ClassNameDiffersFromFileName")
public @interface Test { }"""
).indented()
private val stubJUnitIgnore: TestFile = java(
"""
package org.junit;
@SuppressWarnings("ClassNameDiffersFromFileName")
public @interface Ignore {
String value() default "";
}"""
).indented()
@Test
fun testNoAnnotations() {
lint()
.files(
stubJUnitTest, java(
"""
package foo;
import org.junit.Test;
@SuppressWarnings("ClassNameDiffersFromFileName")
class MyTest {
@Test fun something() {
}
}"""
).indented()
)
.issues(IgnoreWithoutReasonDetector.ISSUE)
.run()
.expectClean()
}
@Test
fun testAnnotationWithReasonOnFunction() {
lint()
.files(
stubJUnitTest, stubJUnitIgnore, java(
"""
package foo;
import org.junit.Ignore;
import org.junit.Test;
@SuppressWarnings("ClassNameDiffersFromFileName")
class MyTest {
@Test @Ignore("reason") fun something() {
}
}"""
).indented()
)
.issues(IgnoreWithoutReasonDetector.ISSUE)
.run()
.expectClean()
}
@Test
fun testAnnotationWithReasonOnClass() {
lint()
.files(
stubJUnitTest, stubJUnitIgnore, java(
"""
package foo;
import org.junit.Ignore;
import org.junit.Test;
@SuppressWarnings("ClassNameDiffersFromFileName")
@Ignore("reason") class MyTest {
@Test fun something() {
}
}"""
).indented()
)
.issues(IgnoreWithoutReasonDetector.ISSUE)
.run()
.expectClean()
}
@Test
fun testAnnotationWithoutReasonOnClass() {
lint()
.files(
stubJUnitTest, stubJUnitIgnore, java(
"""
package foo;
import org.junit.Ignore;
import org.junit.Test;
@SuppressWarnings("ClassNameDiffersFromFileName")
@Ignore class MyTest {
@Test fun something() {
}
}"""
).indented()
)
.issues(IgnoreWithoutReasonDetector.ISSUE)
.run()
.expect(
"""
src/foo/MyTest.java:7: Warning: Test is ignored without giving any explanation. [IgnoreWithoutReason]
@Ignore class MyTest {
~~~~~~~
0 errors, 1 warnings
"""
)
}
@Test
fun testAnnotationWithoutReasonOnFunction() {
lint()
.files(
stubJUnitTest, stubJUnitIgnore, java(
"""
package foo;
import org.junit.Ignore;
import org.junit.Test;
@SuppressWarnings({"ClassNameDiffersFromFileName", "DefaultAnnotationParam"})
class MyTest {
@Test @Ignore fun something() {
}
@Test @Ignore("") fun something() {
}
@Test @Ignore("TODO") fun something() {
}
}
"""
).indented()
)
.issues(IgnoreWithoutReasonDetector.ISSUE)
.run()
.expect(
"""
src/foo/MyTest.java:8: Warning: Test is ignored without giving any explanation. [IgnoreWithoutReason]
@Test @Ignore fun something() {
~~~~~~~
src/foo/MyTest.java:11: Warning: Test is ignored without giving any explanation. [IgnoreWithoutReason]
@Test @Ignore("") fun something() {
~~~~~~~~~~~
src/foo/MyTest.java:14: Warning: Test is ignored without giving any explanation. [IgnoreWithoutReason]
@Test @Ignore("TODO") fun something() {
~~~~~~~~~~~~~~~
0 errors, 3 warnings
"""
)
.expectFixDiffs(
"""
Fix for src/foo/MyTest.java line 8: Give reason:
@@ -8 +8
- @Test @Ignore fun something() {
+ @Test @Ignore("[TODO]") fun something() {
"""
)
}
}