Add Reference Testcase

Author: xterao

src/test/kotlin/org/domaframework/doma/intellij/DomaSqlTest.kt

@@ -148,7 +148,7 @@ open class DomaSqlTest : LightJavaCodeInsightFixtureTestCase() {
         )
     }
 
-    fun addResourceFile(vararg sqlFileNames: String) {
+    fun addResourceEmptyFile(vararg sqlFileNames: String) {
         for (sqlFileName in sqlFileNames) {
             myFixture.addFileToProject(
                 "$resourceRoot/META-INF/$packagePath/dao/$sqlFileName",

src/test/kotlin/org/domaframework/doma/intellij/gutteraction/dao/DaoGenerateSqlActionTest.kt

@@ -60,7 +60,7 @@ class DaoGenerateSqlActionTest : DomaSqlTest() {
             "gutteraction/SqlProcessorGutterTestDao.java",
         )
 
-        addResourceFile(
+        addResourceEmptyFile(
             "quickfix/SelectQuickFixTestDao/existsSQLFile.sql",
             "quickfix/InsertQuickFixTestDao/existsSQLFile.sql",
             "quickfix/UpdateQuickFixTestDao/existsSQLFile.sql",
@@ -71,7 +71,7 @@ class DaoGenerateSqlActionTest : DomaSqlTest() {
             "quickfix/ScriptQuickFixTestDao/existsSQLFile.script",
             "quickfix/SqlProcessorQuickFixTestDao/existsSQLFile.sql",
         )
-        addResourceFile(
+        addResourceEmptyFile(
             "gutteraction/SelectGutterTestDao/existsSQLFile1.sql",
             "gutteraction/InsertGutterTestDao/existsSQLFile2.sql",
             "gutteraction/UpdateGutterTestDao/existsSQLFile1.sql",

src/test/kotlin/org/domaframework/doma/intellij/gutteraction/dao/DaoGutterActionTest.kt

@@ -45,7 +45,7 @@ class DaoGutterActionTest : DomaSqlTest() {
             "$packageName/ScriptGutterTestDao.java",
             "$packageName/SqlProcessorGutterTestDao.java",
         )
-        addResourceFile(
+        addResourceEmptyFile(
             "$packageName/SelectGutterTestDao/existsSQLFile1.sql",
             "$packageName/InsertGutterTestDao/existsSQLFile1.sql",
             "$packageName/UpdateGutterTestDao/existsSQLFile1.sql",
@@ -56,7 +56,7 @@ class DaoGutterActionTest : DomaSqlTest() {
             "$packageName/ScriptGutterTestDao/existsSQLFile1.script",
             "$packageName/SqlProcessorGutterTestDao/existsSQLFile1.sql",
         )
-        addResourceFile(
+        addResourceEmptyFile(
             "$packageName/SelectGutterTestDao/existsSQLFile2.sql",
             "$packageName/InsertGutterTestDao/existsSQLFile2.sql",
             "$packageName/UpdateGutterTestDao/existsSQLFile2.sql",
@@ -67,7 +67,7 @@ class DaoGutterActionTest : DomaSqlTest() {
             "$packageName/ScriptGutterTestDao/existsSQLFile2.script",
             "$packageName/SqlProcessorGutterTestDao/existsSQLFile2.sql",
         )
-        addResourceFile(
+        addResourceEmptyFile(
             "$packageName/BatchInsertGutterTestDao/existsSQLFile3.sql",
             "$packageName/BatchUpdateGutterTestDao/existsSQLFile3.sql",
             "$packageName/BatchDeleteGutterTestDao/existsSQLFile3.sql",

src/test/kotlin/org/domaframework/doma/intellij/gutteraction/dao/DaoJumpActionTest.kt

@@ -61,7 +61,7 @@ class DaoJumpActionTest : DomaSqlTest() {
             "$packageName/$notDisplayedPackage/SqlProcessorInvalidCaretTestDao.java",
             "$packageName/$notDisplayedPackage/InvalidCaretTestDao.java",
         )
-        addResourceFile(
+        addResourceEmptyFile(
             "$packageName/SelectGutterTestDao/existsSQLFile1.sql",
             "$packageName/InsertGutterTestDao/existsSQLFile1.sql",
             "$packageName/UpdateGutterTestDao/existsSQLFile1.sql",
@@ -72,7 +72,7 @@ class DaoJumpActionTest : DomaSqlTest() {
             "$packageName/ScriptGutterTestDao/existsSQLFile1.script",
             "$packageName/SqlProcessorGutterTestDao/existsSQLFile1.sql",
         )
-        addResourceFile(
+        addResourceEmptyFile(
             "$packageName/SelectGutterTestDao/existsSQLFile2.sql",
             "$packageName/InsertGutterTestDao/existsSQLFile2.sql",
             "$packageName/UpdateGutterTestDao/existsSQLFile2.sql",

src/test/kotlin/org/domaframework/doma/intellij/inspection/dao/DomaSqlExistTest.kt

@@ -32,7 +32,7 @@ class DomaSqlExistTest : DomaSqlTest() {
             "ScriptTestDao.java",
             "SqlProcessorTestDao.java",
         )
-        addResourceFile(
+        addResourceEmptyFile(
             "SelectTestDao/existsSQLFile.sql",
             "InsertTestDao/existsSQLFile.sql",
             "UpdateTestDao/existsSQLFile.sql",

src/test/kotlin/org/domaframework/doma/intellij/inspection/dao/DomaSqlQuickFixTest.kt

@@ -37,7 +37,7 @@ class DomaSqlQuickFixTest : DomaSqlTest() {
             "quickfix/SqlProcessorQuickFixTestDao.java",
         )
 
-        addResourceFile(
+        addResourceEmptyFile(
             "quickfix/SelectQuickFixTestDao/existsSQLFile.sql",
             "quickfix/InsertQuickFixTestDao/existsSQLFile.sql",
             "quickfix/UpdateQuickFixTestDao/existsSQLFile.sql",

src/test/kotlin/org/domaframework/doma/intellij/refactor/DaoMethodRenameTestCase.kt

@@ -29,7 +29,7 @@ class DaoMethodRenameTestCase : DomaSqlTest() {
             "RenameDaoMethodWithoutSql.java",
             "RenameDaoMethodNotExistSql.java",
         )
-        addResourceFile(
+        addResourceEmptyFile(
             "RenameDaoMethod/renameDaoMethodName.sql",
             "RenameDao/renameDaoClassName.sql",
         )

src/test/kotlin/org/domaframework/doma/intellij/reference/SqlReferenceTestCase.kt

@@ -0,0 +1,114 @@
+/*
+ * Copyright Doma Tools Authors
+ *
+ * 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
+ *
+ *     https://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.domaframework.doma.intellij.reference
+
+import com.intellij.psi.PsiFile
+import com.intellij.psi.util.PsiTreeUtil
+import org.domaframework.doma.intellij.DomaSqlTest
+import org.domaframework.doma.intellij.psi.SqlCustomElExpr
+import org.jetbrains.kotlin.idea.core.util.toPsiFile
+
+class SqlReferenceTestCase : DomaSqlTest() {
+    val testPackage = "reference"
+    val testDaoName = "ReferenceTestDao"
+
+    val forItemResolve = "SqlElIdExprImpl(EL_ID_EXPR)"
+    val daoParameterResolve = "PsiParameter"
+    val fieldResolve = "PsiField"
+    val methodResolve = "PsiMethod"
+    val classResolve = "PsiClass"
+
+    override fun setUp() {
+        super.setUp()
+        addDaoJavaFile("$testPackage/$testDaoName.java")
+        addSqlFile("$testPackage/$testDaoName/referenceDaoParameter.sql")
+        addSqlFile("$testPackage/$testDaoName/referenceEntityProperty.sql")
+        addSqlFile("$testPackage/$testDaoName/referenceStaticField.sql")
+    }
+
+    fun testReferenceDaoMethodParameter() {
+        referenceTest(
+            "referenceDaoParameter",
+            mapOf(
+                "reportId" to "$daoParameterResolve:reportId",
+                "tableName" to "$daoParameterResolve:tableName",
+                "columns" to "$daoParameterResolve:columns",
+                "column" to forItemResolve,
+                "notExistParam" to null,
+            ),
+        )
+    }
+
+    fun testReferenceEntityProperty() {
+        referenceTest(
+            "referenceEntityProperty",
+            mapOf(
+                "detail" to "$daoParameterResolve:detail",
+                "getFirstEmployee" to "$methodResolve:getFirstEmployee",
+                "projectNumber" to "$fieldResolve:projectNumber",
+                "projects" to "$daoParameterResolve:projects",
+                "project" to forItemResolve,
+                "id" to forItemResolve,
+                "employeeId" to "$fieldResolve:employeeId",
+            ),
+        )
+    }
+
+    fun testReferenceStaticField() {
+        referenceTest(
+            "referenceStaticField",
+            mapOf(
+                "doma.example.entity.ProjectDetail" to "$classResolve:ProjectDetail",
+                "projectCategory" to "$fieldResolve:projectCategory",
+                "getTermNumber" to "$methodResolve:getTermNumber",
+            ),
+        )
+    }
+
+    private fun referenceTest(
+        sqlFileName: String,
+        resolveExpects: Map<String, String?>,
+    ) {
+        val sqlFile = findSqlFile("$testPackage/$testDaoName/$sqlFileName.sql")
+        assertNotNull("Not Found SQL File", sqlFile)
+        if (sqlFile == null) return
+
+        myFixture.configureFromExistingVirtualFile(sqlFile)
+        sqlFile.toPsiFile(project)?.let {
+            resolveReferencesInTestFile(
+                it,
+                resolveExpects,
+            )
+        }
+    }
+
+    /**
+     * Resolve references in the test file.
+     * sqlFile: The SQL file to resolve references in.
+     * resolveExpects: A map of expected results for each reference. Type:resolveName
+     */
+    private fun resolveReferencesInTestFile(
+        sqlFile: PsiFile,
+        resolveExpects: Map<String, String?>,
+    ) {
+        val references = PsiTreeUtil.collectElementsOfType(sqlFile, SqlCustomElExpr::class.java)
+        for (reference in references) {
+            val resolveResult = reference.references.firstOrNull()?.resolve()
+            val result = resolveExpects[reference.text]
+            assertEquals(result, resolveResult?.toString())
+        }
+    }
+}

src/test/testData/src/main/java/doma/example/dao/reference/ReferenceTestDao.java

@@ -0,0 +1,19 @@
+package doma.example.dao.reference;
+
+import java.util.List;
+import doma.example.entity.*;
+import org.seasar.doma.*;
+
+@Dao
+public interface ReferenceTestDao {
+
+  @Select
+  Map<String, Object> referenceDaoParameter(Long reportId, String tableName, Set<String> columns);
+
+  @Select
+  Project referenceEntityProperty(List<Project> projects, ProjectDetail detail);
+
+  @Select
+  ProjectDetail referenceStaticField();
+
+}

src/test/testData/src/main/resources/META-INF/doma/example/dao/reference/ReferenceTestDao/referenceDaoParameter.sql

@@ -0,0 +1,9 @@
+INSERT INTO /*# tableName */
+            (
+             /*%for column : columns */
+             , /*# column */
+             /*%end */)
+     VALUES ( /* reportId */0
+             , /* notExistParam */false
+             , 'div'
+             , 100)