Add tests for annotation option parameter inspection with parent class properties

Author: xterao

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

@@ -0,0 +1,46 @@
+/*
+ * 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.inspection.dao
+
+import org.domaframework.doma.intellij.DomaSqlTest
+import org.domaframework.doma.intellij.inspection.dao.inspector.DaoAnnotationOptionParameterInspection
+
+/**
+ * Test class for annotation option parameter inspection.
+ * Tests include/exclude options with parent class properties.
+ */
+class AnnotationOptionParameterInspectionTest : DomaSqlTest() {
+    /**
+     * Since error highlight tags for annotation options cannot be set in the test data, verify manually.
+     * There are no automated test cases, so perform manual checks using the following as a reference.
+     *
+     * Here is an updated summary of the test case coverage based on the revised method documentation. This can be used as a test case overview document.
+     * Relation: [AnnotationOptionTestInValidDao]
+     * - Error check when specifying fields not defined in the parameter type with `include` option.
+     * - Error check when specifying fields not defined in the parameter type with `exclude` option.
+     * - Error check for specifying fields not defined in immutable Entity with `MultiInsert` (also for fields not defined in parameter type).
+     * - Error check for specifying fields not defined in mutable Entity with `MultiInsert`.
+     * - Error check for specifying fields not defined in parameter type with batch annotations.
+     * - Error when ending with an embedded property.
+     * - Error when specifying incorrect properties in an embedded class.
+     * - Error check for invalid field specification in `Returning` option.
+     * - Error check for invalid field specification in `Returning` option for mutable Entity.
+     * - Error check for specifying fields not defined in embedded property.
+     * - Error when specifying further properties from a primitive type.
+     * - Error check for specifying parent class properties in subclass with `@Entity`.
+     * - Error check for specifying parent class properties in subclass without `@Entity`.
+     */
+}

src/test/testData/src/main/java/doma/example/dao/inspection/option/AnnotationOptionTestDao_base.java

@@ -0,0 +1,128 @@
+package doma.example.dao.inspection.option;
+
+import doma.example.entity.Department;
+import doma.example.entity.NonSubEntity;
+import doma.example.entity.Pckt;
+import doma.example.entity.SubEntity;
+import org.seasar.doma.*;
+import org.seasar.doma.jdbc.MultiResult;
+
+import java.util.List;
+
+/**
+ * When using this test data with [LightJavaCodeInsightFixtureTestCase],
+ * the highlighted elements are not parsed correctly, resulting in errors.
+ * Compare the highlights in this test data with the actual highlights in IDEA,
+ * and visually confirm that the highlights and errors occur as expected based on the test data.
+ */
+@Dao
+public interface AnnotationOptionTestInValidDao {
+
+    /**
+     * include: Error highlight when specifying fields not defined in the parameter type
+     * Error: Field [invalidField] specified in [include] option does not exist in "Department". Available fields: [id, name, location, managerCount, subId, embeddableEntity, embeddableEntity2]
+     * @param department
+     * @return
+     */
+    @Update(include = {"name", "invalidField"})
+    int updateWithInvalidInclude(Department department);
+
+    /**
+     * exclude: Error highlight when specifying fields not defined in the parameter type
+     * Error: Field [salary] specified in [exclude] option does not exist in "Department". Available fields: [id, name, location, managerCount, subId, embeddableEntity, embeddableEntity2]
+     * @param department
+     * @return
+     */
+    @Insert(exclude = {"salary", "location"})
+    int insertWithInvalidExclude(Department department);
+
+    /**
+     * MultiInsert: Error highlight when specifying fields not defined in immutable Entity
+     * Also error highlight when specifying fields not defined in the parameter type
+     * Error: Field [salary] specified in [include] option does not exist in "Department". Available fields: [id, name, location, managerCount, subId, embeddableEntity, embeddableEntity2]
+     *        Field [bonus] specified in [exclude] option does not exist in "Department". Available fields: [id, name, location, managerCount, subId, embeddableEntity, embeddableEntity2]
+     * @param departments
+     * @return
+     */
+    @MultiInsert(include = {"salary"}, exclude = {"bonus"})
+    int multiInsert(List<Department> departments);
+
+    /**
+     * MultiInsert: Error highlight when specifying fields not defined in mutable Entity in include/exclude
+     * Error: Field [salary] specified in [include] option does not exist in "Pckt". Available fields: [id, name]
+     *        Field [bonus] specified in [exclude] option does not exist in "Pckt". Available fields: [id, name]
+     * @param pckts
+     * @return
+     */
+    @MultiInsert(include = {"salary"}, exclude = {"bonus"})
+    MultiResult<Pckt> multiInsertImpairmentEntity(List<Pckt> pckts);
+
+    /**
+     * Batch annotations: Error highlight when specifying fields not defined in the parameter type
+     * Error: Field [email] specified in [include] option does not exist in "Department". Available fields: [id, name, location, managerCount, subId, embeddableEntity, embeddableEntity2]
+     * @param departments
+     * @return
+     */
+    @BatchUpdate(include = {"email"})
+    int[] batchUpdateWithInvalidInclude(List<Department> departments);
+
+    /**
+     * Error when ending with an Embedded property
+     * Error: Field [embeddableEntity] specified in [include] option is an Embeddable type "ClientUser". Must specify its properties. Available properties: [id, name, number]
+     */
+    @Update(include = {"embeddableEntity"})
+    int updateEmbedded(Department department);
+
+    /**
+     * Error when there is a mistake in Embedded class properties
+     * Error: Field [age] specified in [include] option does not exist in "ClientUser". Available fields: [id, name, number, childEmbedded, childEmbedded2]
+     */
+    @Insert(include = {"embeddableEntity.age", "embeddableEntity.id"})
+    int insertEmbeddedWithProperties(Department department);
+
+    /**
+     * Same check applies when using Returning
+     * Error: Field [age] specified in [include] option does not exist in "ClientUser". Available fields: [id, name, number, childEmbedded, childEmbedded2]
+     */
+    @Update(returning = @Returning(include = {"embeddableEntity.age"}))
+    Department updateReturning(Department department);
+
+    /**
+     * Error highlight when specifying invalid fields in Returning option
+     * Error: Field [embeddableEntity] specified in [exclude] option is an Embeddable type "ClientUser". Must specify its properties. Available properties: [id, name, number]
+     * @param department
+     * @return
+     */
+    @Insert(returning = @Returning(exclude = {"embeddableEntity"}))
+    Department insertReturning(Department department);
+
+    /**
+     * MultiInsert Returning option: Error highlight in both include/exclude when specifying invalid fields
+     * Error: Field [email] specified in [include] option does not exist in "Department". Available fields: [id, name, location, managerCount, subId, embeddableEntity, embeddableEntity2]
+     * @param departments
+     * @return
+     */
+    @MultiInsert(returning = @Returning(include = {"email"}, exclude = {"embeddableEntity.salary"}))
+    List<Department> multiInsertReturning(List<Department> departments);
+
+    /**
+     * Error highlight when specifying fields not defined in mutable Entity within Returning option
+     * Error: Field [embeddableEntity] specified in [include] option does not exist in "Pckt". Available fields: [id, name]
+     */
+    @Update(returning = @Returning(include = {"embeddableEntity.age"}))
+    Pckt updateReturning(Pckt pckt);
+
+    /**
+     * Error highlight when specifying fields not defined in Embedded property
+     * Error: Field [age] specified in [include] option does not exist in "ClientUser". Available fields: [id, name, number, childEmbedded, childEmbedded2]
+     */
+    @Update(returning = @Returning(include = "embeddableEntity.age"))
+    Department updateSingleInclude(Department department);
+
+    /**
+     * Error highlight when specifying further properties from a Primitive type
+     * Error: Field path [subId.get] specified in [exclude] option is invalid. Field [get] is a primitive type and does not have nested properties
+     */
+    @Insert(exclude = "subId.get")
+    int insertPrimitiveProperty(Department department);
+}