Bugfix. Broken autofix for top-level block comment with multiline text (

#661)

* bugfix/top-level-block-comment(#651)

### What's done:
  * Fixed bug

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

@@ -151,7 +151,7 @@ class HeaderCommentRule(private val configRules: List<RulesConfig>) : Rule("head
         val copyrightText = configuration.getCopyrightText()
 
         val headerComment = node.findChildBefore(PACKAGE_DIRECTIVE, BLOCK_COMMENT)
-        val isWrongCopyright = headerComment != null && !headerComment.text.contains(copyrightText)
+        val isWrongCopyright = headerComment != null && !headerComment.text.flatten().contains(copyrightText.flatten())
         val isMissingCopyright = headerComment == null && configuration.isCopyrightMandatory()
         val isCopyrightInsideKdoc = (node.getAllChildrenWithType(KDOC) + node.getAllChildrenWithType(ElementType.EOL_COMMENT))
             .any { commentNode ->
@@ -172,10 +172,10 @@ class HeaderCommentRule(private val configRules: List<RulesConfig>) : Rule("head
                 node.addChild(PsiWhiteSpaceImpl(newLines), node.firstChildNode)
                 node.addChild(LeafPsiElement(BLOCK_COMMENT,
                     """
-                            /*
-                             * $copyrightText
-                             */
-                        """.trimIndent()),
+                        |/*
+                        |${handleMultilineCopyright(copyrightText)}
+                        |*/
+                    """.trimMargin()),
                     node.firstChildNode
                 )
             }
@@ -190,6 +190,34 @@ class HeaderCommentRule(private val configRules: List<RulesConfig>) : Rule("head
         }
     }
 
+    /**
+     * Deletes all spaces and newlines
+     * Used to compare copyrights in yaml and file
+     */
+    private fun String.flatten(): String =
+            replace("\n", "")
+                .replace(" ", "")
+
+    /**
+     * If it is multiline copyright, this method deletes spaces in empty lines.
+     * Otherwise, if it is one line copyright, it returns it with 4 spaces at the beginning.
+     */
+    private fun handleMultilineCopyright(copyrightText: String): String {
+        if (copyrightText.startsWith(" ")) {
+            return copyrightText
+                .lines()
+                .dropWhile { it.isBlank() }
+                .reduce { acc, nextLine ->
+                    when {
+                        nextLine.isBlank() -> "$acc\n"
+                        else -> "$acc\n$nextLine"
+                    }
+                }
+        }
+
+        return "    $copyrightText"
+    }
+
     /**
      * Configuration for copyright
      */

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/HeaderCommentRuleFixTest.kt

@@ -66,4 +66,46 @@ class HeaderCommentRuleFixTest : FixTestBase(
             )))
         )
     }
+
+    @Test
+    @Tag(WarningNames.HEADER_MISSING_OR_WRONG_COPYRIGHT)
+    fun `copyright multiline`() {
+        fixAndCompare("MultilineCopyrightExample.kt", "MultilineCopyrightTest.kt",
+            listOf(RulesConfig(HEADER_MISSING_OR_WRONG_COPYRIGHT.name, true, mapOf(
+                "isCopyrightMandatory" to "true",
+                "copyrightText" to """
+                |    Copyright 2018-2020 John Doe.
+                |
+                |    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.
+                """.trimMargin()
+            )))
+        )
+    }
+
+    @Test
+    @Tag(WarningNames.HEADER_MISSING_OR_WRONG_COPYRIGHT)
+    fun `should not trigger if copyright text have different indents`() {
+        fixAndCompare("MultilineCopyrightNotTriggerExample.kt", "MultilineCopyrightNotTriggerTest.kt",
+            listOf(RulesConfig(HEADER_MISSING_OR_WRONG_COPYRIGHT.name, true, mapOf(
+                "isCopyrightMandatory" to "true",
+                "copyrightText" to """
+                    |   Copyright 2018-2020 John Doe.
+                    |
+                    |   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
+            """.trimMargin()
+            )))
+        )
+    }
 }

diktat-rules/src/test/resources/test/paragraph2/header/AutoCopyrightExpected.kt

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
- */
+    Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
+*/
 
 package test.paragraph2.header
 

diktat-rules/src/test/resources/test/paragraph2/header/MisplacedHeaderKdocAppendedCopyrightExpected.kt

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
- */
+    Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
+*/
 /**
  * Lorem ipsum
  * dolor sit amet

diktat-rules/src/test/resources/test/paragraph2/header/MisplacedHeaderKdocExpected.kt

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
- */
+    Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
+*/
 /**
  * Lorem ipsum
  * dolor sit amet

diktat-rules/src/test/resources/test/paragraph2/header/MisplacedHeaderKdocTest.kt

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
- */
+    Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
+*/
 
 package test.paragraph2.header
 

diktat-rules/src/test/resources/test/paragraph2/header/MultilineCopyrightExample.kt

@@ -0,0 +1,21 @@
+/*
+    Copyright 2018-2020 John Doe.
+
+    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.
+*/
+
+class SomeClass {
+    fun coolFun() {
+        val a = 5
+    }
+}

diktat-rules/src/test/resources/test/paragraph2/header/MultilineCopyrightNotTriggerExample.kt

@@ -0,0 +1,15 @@
+/*
+    Copyright 2018-2020 John Doe.
+
+    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
+*/
+
+package test.paragraph2.header
+
+class SomeClass {
+    fun function() {
+
+    }
+}

diktat-rules/src/test/resources/test/paragraph2/header/MultilineCopyrightNotTriggerTest.kt

@@ -0,0 +1,15 @@
+/*
+    Copyright 2018-2020 John Doe.
+
+    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
+*/
+
+package test.paragraph2.header
+
+class SomeClass {
+    fun function() {
+
+    }
+}

diktat-rules/src/test/resources/test/paragraph2/header/MultilineCopyrightTest.kt

@@ -0,0 +1,5 @@
+class SomeClass {
+    fun coolFun() {
+        val a = 5
+    }
+}

diktat-rules/src/test/resources/test/paragraph2/header/NewlineAfterHeaderKdocExpected.kt

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
- */
+    Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
+*/
 /**
  * This is a file used in unit test
  */

diktat-rules/src/test/resources/test/paragraph2/header/NewlineAfterHeaderKdocTest.kt

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
- */
+    Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
+*/
 /**
  * This is a file used in unit test
  */