Suppress in individual files #255

aktsay6 · 2020-09-08T13:58:32Z

What has been done:

Warn method remade so it checks if there is suppress on this warning
Added test
All warn and warnAndFix calls fixed

Actions checklist

Closes #176

### What's done: * First ideas

### What's done: * Warn method remade * Added suppress check * Added test

…iles' into feature/suppress-in-individual-files # Conflicts: # diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/utils/SuppressTest.kt

# Conflicts: # diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/constants/Warnings.kt # diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/LineLength.kt # diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/comments/CommentsRule.kt # diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/files/FileSize.kt

### What's done: * Fixed bugs

codecov · 2020-09-08T14:59:15Z

Codecov Report

Merging #255 into master will increase coverage by 0.02%.
The diff coverage is 87.96%.

@@             Coverage Diff              @@
##             master     #255      +/-   ##
============================================
+ Coverage     81.23%   81.25%   +0.02%     
- Complexity      956      957       +1     
============================================
  Files            50       50              
  Lines          2510     2524      +14     
  Branches        782      788       +6     
============================================
+ Hits           2039     2051      +12     
  Misses          190      190              
- Partials        281      283       +2

Flag	Coverage Δ	Complexity Δ
#unittests	`81.25% <87.96%> (+0.02%)`	`957.00 <7.00> (+1.00)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ	Complexity Δ
...kotlin/org/cqfn/diktat/ruleset/rules/FileNaming.kt	`8.69% <0.00%> (ø)`	`2.00 <0.00> (ø)`
...tlin/org/cqfn/diktat/ruleset/constants/Warnings.kt	`96.38% <50.00%> (ø)`	`8.00 <3.00> (+1.00)`
.../cqfn/diktat/ruleset/rules/BlockStructureBraces.kt	`83.67% <50.00%> (ø)`	`53.00 <0.00> (ø)`
.../ruleset/rules/BracesInConditionalsAndLoopsRule.kt	`80.35% <50.00%> (ø)`	`26.00 <0.00> (ø)`
...kotlin/org/cqfn/diktat/ruleset/rules/EmptyBlock.kt	`66.66% <66.66%> (ø)`	`10.00 <0.00> (ø)`
...g/cqfn/diktat/ruleset/rules/kdoc/KdocFormatting.kt	`76.35% <80.95%> (ø)`	`81.00 <0.00> (ø)`
...tlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt	`83.42% <81.81%> (-0.11%)`	`0.00 <0.00> (ø)`
...cqfn/diktat/ruleset/rules/AnnotationNewLineRule.kt	`90.90% <100.00%> (ø)`	`15.00 <0.00> (ø)`
...ktat/ruleset/rules/ClassLikeStructuresOrderRule.kt	`80.30% <100.00%> (ø)`	`26.00 <0.00> (ø)`
...cqfn/diktat/ruleset/rules/ConsecutiveSpacesRule.kt	`92.00% <100.00%> (ø)`	`15.00 <0.00> (ø)`
... and 21 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b2d6ac6...0a40734. Read the comment docs.

### What's done: * Fixed bugs

kentr0w

Please add more tests

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/constants/Warnings.kt

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/BlockStructureBraces.kt

kentr0w · 2020-09-09T08:45:47Z

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/SuppressTest.kt

@@ -0,0 +1,22 @@
+package org.cqfn.diktat.ruleset.chapter3


Why you have two tests in different directories?

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt

### What's done: * Fixed bugs

…-individual-files # Conflicts: # diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/EmptyBlock.kt # diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/LongNumericalValuesSeparatedRule.kt # diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/comments/CommentsRule.kt # diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/kdoc/KdocComments.kt

### What's done: * Fixed bugs

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt

petertrr · 2020-09-10T20:06:32Z

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/utils/SuppressTest.kt

+import org.cqfn.diktat.util.LintTestBase
+import org.junit.jupiter.api.Test
+
+class SuppressTest : LintTestBase(::IdentifierNaming) {


Please add more tests with various locations of annotation: on file level, on some top-level declarations etc.

Please check if it is possible to suppress warnings for the entire file using @file:Suppress("...")

This is an important feature, we need more tests: that other annotations do not cause false suppressions, that @Suppress without parameters or with other parameters doesn't cause false suppressions, file-level annotations etc.

petertrr

See comments above

### What's done: * Fixed bugs

…-individual-files

### What's done: * Fixed bugs

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/constants/Warnings.kt

…-individual-files

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/constants/Warnings.kt

### What's done: * Fixed bug

### What's done: * Added to README.md

README.md

### What's done: * Fixed description

### What's done: * Fixed bugs

…-individual-files

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt

petertrr · 2020-09-15T10:47:23Z

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/utils/SuppressTest.kt

+import org.cqfn.diktat.util.LintTestBase
+import org.junit.jupiter.api.Test
+
+class SuppressTest : LintTestBase(::IdentifierNaming) {


This is an important feature, we need more tests: that other annotations do not cause false suppressions, that @Suppress without parameters or with other parameters doesn't cause false suppressions, file-level annotations etc.

### What's done: * Fixed bugs

### What's done: * Added test

petertrr · 2020-09-15T12:19:19Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt

+                            && it.valueArgumentList?.arguments?.isNotEmpty() ?: false // don't suppress anything
+                            && it.valueArgumentList?.arguments
+                            ?.firstOrNull()?.text?.contains(warningName) ?: true


Suggested change

&& it.valueArgumentList?.arguments?.isNotEmpty() ?: false // don't suppress anything

&& it.valueArgumentList?.arguments

?.firstOrNull()?.text?.contains(warningName) ?: true

&& it.valueArgumentList?.arguments

?.firstOrNull()?.text?.contains(warningName) ?: false

If list is empty, firstOrNull will return null and result will be false.

petertrr · 2020-09-15T12:20:30Z

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/utils/SuppressTest.kt

+        val code =
+                """
+                  class SomeClass() {
+                    @set:[Suppress("IDENTIFIER_LENGTH") Inject]


### What's done: * Fixed bugs

petertrr

Just a couple of minor suggestions

petertrr · 2020-09-15T13:16:53Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt

+                ?.any {
+                    it.shortName.toString() == Suppress::class.simpleName
+                            && it.valueArgumentList?.arguments
+                            ?.firstOrNull()?.text?.contains(warningName) ?: false


Suggested change

?.firstOrNull()?.text?.contains(warningName) ?: false

?.firstOrNull()?.text?.equals(warningName) ?: false

petertrr · 2020-09-15T13:17:10Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt

@@ -303,10 +307,27 @@ fun ASTNode?.isAccessibleOutside(): Boolean =
            true
        }

+fun ASTNode.hasSuppress(warningName: String): Boolean {
+    return parent({ node ->
+        val children: ASTNode? = if (node.elementType != FILE) {


Suggested change

val children: ASTNode? = if (node.elementType != FILE) {

val annotationNode = if (node.elementType != FILE) {

### What's done: * Fixed bugs

petertrr

LGTM

kentr0w

LGTM

aktsay6 added 4 commits September 8, 2020 11:35

Suppress-in-individual-files

bf4f2e5

### What's done: * First ideas

feature/suppress-in-individual-files

2412b4b

### What's done: * Warn method remade * Added suppress check * Added test

feature/suppress-in-individual-files

3051dcc

### What's done: * Warn method remade * Added suppress check * Added test

Merge remote-tracking branch 'origin/feature/suppress-in-individual-f…

7e03ce1

…iles' into feature/suppress-in-individual-files # Conflicts: # diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/utils/SuppressTest.kt

aktsay6 added the enhancement New feature or request label Sep 8, 2020

aktsay6 requested review from petertrr and kentr0w September 8, 2020 13:58

aktsay6 added 4 commits September 8, 2020 17:15

feature/suppress-in-individual-files

a896a3c

### What's done: * Fixed bugs

feature/suppress-in-individual-files

24bd86f

### What's done: * Fixed bugs

feature/suppress-in-individual-files

eb027bc

### What's done: * Fixed bugs

feature/suppress-in-individual-files

601200c

### What's done: * Fixed bugs

kentr0w requested changes Sep 9, 2020

View reviewed changes

aktsay6 and others added 9 commits September 10, 2020 15:16

Merge branch 'master' into feature/suppress-in-individual-files

ef424ad

feature/suppress-in-individual-files

2ef5b69

### What's done: * Fixed bugs

Merge branch 'master' into feature/suppress-in-individual-files

0c1e271

Merge branch 'master' into feature/suppress-in-individual-files

77673dd

feature/suppress-in-individual-files

c852840

### What's done: * Fixed bugs

feature/suppress-in-individual-files

15bb1cc

### What's done: * Fixed bugs

Merge branch 'master' into feature/suppress-in-individual-files

79c8bbc

feature/suppress-in-individual-files

325bb92

### What's done: * Fixed bugs

aktsay6 requested a review from kentr0w September 10, 2020 17:39

petertrr reviewed Sep 10, 2020

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt Outdated Show resolved Hide resolved

petertrr reviewed Sep 10, 2020

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt Outdated Show resolved Hide resolved

petertrr reviewed Sep 10, 2020

View reviewed changes

petertrr requested changes Sep 10, 2020

View reviewed changes

aktsay6 added 2 commits September 11, 2020 12:20

feature/suppress-in-individual-files

9a3f9d3

### What's done: * Fixed bugs

Merge remote-tracking branch 'origin/master' into feature/suppress-in…

7aaf105

…-individual-files

feature/suppress-in-individual-files

81f0a33

### What's done: * Fixed bugs

aktsay6 requested a review from petertrr September 11, 2020 11:44

petertrr requested changes Sep 14, 2020

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/constants/Warnings.kt Outdated Show resolved Hide resolved

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/constants/Warnings.kt Outdated Show resolved Hide resolved

Merge remote-tracking branch 'origin/master' into feature/suppress-in…

b872c88

…-individual-files

orchestr7 reviewed Sep 14, 2020

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/constants/Warnings.kt Show resolved Hide resolved

aktsay6 added 2 commits September 14, 2020 12:47

feature/suppress-in-individual-files

3d4b8f8

### What's done: * Fixed bug

feature/suppress-in-individual-files

d388db0

### What's done: * Added to README.md

aktsay6 requested review from petertrr and orchestr7 September 14, 2020 10:22

petertrr reviewed Sep 14, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

feature/suppress-in-individual-files

cd1cd81

### What's done: * Fixed description

aktsay6 requested a review from petertrr September 14, 2020 10:56

aktsay6 added 4 commits September 14, 2020 14:50

feature/suppress-in-individual-files

7b8ebe3

### What's done: * Fixed bugs

Merge remote-tracking branch 'origin/master' into feature/suppress-in…

b22c816

…-individual-files

Merge branch 'master' into feature/suppress-in-individual-files

2cc8ec3

Merge branch 'master' into feature/suppress-in-individual-files

35f1704

petertrr requested changes Sep 15, 2020

View reviewed changes

feature/suppress-in-individual-files

4e07ce2

### What's done: * Fixed bugs

aktsay6 requested a review from petertrr September 15, 2020 12:04

feature/suppress-in-individual-files

826b47f

### What's done: * Added test

petertrr reviewed Sep 15, 2020

View reviewed changes

feature/suppress-in-individual-files

6a1c119

### What's done: * Fixed bugs

petertrr reviewed Sep 15, 2020

View reviewed changes

feature/suppress-in-individual-files

0a40734

### What's done: * Fixed bugs

petertrr approved these changes Sep 15, 2020

View reviewed changes

kentr0w approved these changes Sep 15, 2020

View reviewed changes

aktsay6 merged commit e60f271 into master Sep 15, 2020

aktsay6 deleted the feature/suppress-in-individual-files branch September 15, 2020 13:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Suppress in individual files #255

Suppress in individual files #255

aktsay6 commented Sep 8, 2020

codecov bot commented Sep 8, 2020 •

edited

Loading

kentr0w left a comment

kentr0w Sep 9, 2020

petertrr Sep 10, 2020

petertrr Sep 14, 2020

petertrr Sep 15, 2020

petertrr left a comment

petertrr Sep 15, 2020

petertrr Sep 15, 2020

petertrr Sep 15, 2020

petertrr left a comment

petertrr Sep 15, 2020

petertrr Sep 15, 2020

petertrr left a comment

kentr0w left a comment

	?.firstOrNull()?.text?.contains(warningName) ?: false
	?.firstOrNull()?.text?.equals(warningName) ?: false

	val children: ASTNode? = if (node.elementType != FILE) {
	val annotationNode = if (node.elementType != FILE) {

Suppress in individual files #255

Suppress in individual files #255

Conversation

aktsay6 commented Sep 8, 2020

What has been done:

Actions checklist

codecov bot commented Sep 8, 2020 • edited Loading

Codecov Report

kentr0w left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petertrr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petertrr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petertrr left a comment

Choose a reason for hiding this comment

kentr0w left a comment

Choose a reason for hiding this comment

codecov bot commented Sep 8, 2020 •

edited

Loading