plugins/kotlin/uast/uast-kotlin-base/test/org/jetbrains/uast/test/common/kotlin/UastCommentLogTestBase.kt


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

// Copyright 2000-2021 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.

package org.jetbrains.uast.test.common.kotlin

import com.intellij.psi.PsiNamedElement
import org.jetbrains.kotlin.idea.test.KotlinTestUtils
import org.jetbrains.uast.*
import org.jetbrains.uast.test.common.kotlin.UastTestSuffix.TXT
import org.jetbrains.uast.kotlin.internal.KotlinUElementWithComments
import org.jetbrains.uast.visitor.UastVisitor
import java.io.File

interface UastCommentLogTestBase : UastPluginSelection, UastFileComparisonTestBase {
    private fun getCommentsFile(filePath: String, suffix: String): File = getTestMetadataFileFromPath(filePath, "comments$suffix")

    private fun getIdenticalCommentsFile(filePath: String): File = getCommentsFile(filePath, TXT)

    private fun getPluginCommentsFile(filePath: String): File {
        val identicalFile = getIdenticalCommentsFile(filePath)
        if (identicalFile.exists()) return identicalFile
        return getCommentsFile(filePath, "$pluginSuffix$TXT")
    }

    private fun UComment.testLog(indent: String): String {
        return "UComment(${text})".replace("\n", "\n" + indent)
    }

    fun check(filePath: String, file: UFile) {
        val comments = printComments(file)

        val commentsFile = getPluginCommentsFile(filePath)
        KotlinTestUtils.assertEqualsToFile(commentsFile, comments)

        cleanUpIdenticalFile(
            commentsFile,
            getCommentsFile(filePath, "$counterpartSuffix$TXT"),
            getIdenticalCommentsFile(filePath),
            kind = "comments"
        )
    }

    private fun printComments(file: UFile): String = buildString {
        val indent = "    "
        file.accept(object : UastVisitor {
            private var level = 0

            private fun printIndent() {
                append(indent.repeat(level))
            }

            private fun renderComments(comments: List<UComment>) {
                comments.forEach { comment ->
                    printIndent()
                    appendLine(comment.testLog(indent.repeat(level)))
                }
            }

            private val UElement.nameIfAvailable: String
                get() = (javaPsi as? PsiNamedElement)?.name?.takeIf { it.isNotBlank() } ?: "<no name provided>"

            override fun visitElement(node: UElement): Boolean {
                if (node is UDeclaration || node is UFile) {
                    printIndent()
                    appendLine("${node::class.java.simpleName}:${node.nameIfAvailable}(")
                    level++
                    if (node is KotlinUElementWithComments) renderComments(node.comments)
                }
                return false
            }

            override fun afterVisitElement(node: UElement) {
                super.afterVisitElement(node)
                if (node is UDeclaration || node is UFile) {
                    level--
                    printIndent()
                    appendLine(")")
                }
            }
        })
    }
}