Issue #274 apply Generated annotation to Traits, to improve test coverage reports

Author: aulea

grails-datastore-gorm-hibernate5/src/main/groovy/grails/orm/hibernate/HibernateEntity.groovy

@@ -1,6 +1,7 @@
 package grails.gorm.hibernate
 
 import groovy.transform.CompileStatic
+import groovy.transform.Generated
 import org.grails.datastore.gorm.GormEnhancer
 import org.grails.datastore.gorm.GormEntity
 import org.grails.orm.hibernate.AbstractHibernateGormStaticApi
@@ -21,6 +22,7 @@ trait HibernateEntity<D> extends GormEntity<D> {
      *
      * @return The object
      */
+    @Generated
     static List<D> findAllWithSql(CharSequence sql) {
         currentHibernateStaticApi().findAllWithSql sql, Collections.emptyMap()
     }
@@ -31,6 +33,7 @@ trait HibernateEntity<D> extends GormEntity<D> {
      * @param sql The sql query
      * @return The entity
      */
+    @Generated
     static D findWithSql(CharSequence sql) {
         currentHibernateStaticApi().findWithSql(sql, Collections.emptyMap())
     }
@@ -42,6 +45,7 @@ trait HibernateEntity<D> extends GormEntity<D> {
      *
      * @return The object
      */
+    @Generated
     static List<D> findAllWithSql(CharSequence sql, Map args) {
         currentHibernateStaticApi().findAllWithSql sql, args
     }
@@ -52,10 +56,12 @@ trait HibernateEntity<D> extends GormEntity<D> {
      * @param sql The sql query
      * @return The entity
      */
+    @Generated
     static D findWithSql(CharSequence sql, Map args) {
         currentHibernateStaticApi().findWithSql(sql, args)
     }
 
+    @Generated
     private static AbstractHibernateGormStaticApi currentHibernateStaticApi() {
         (AbstractHibernateGormStaticApi)GormEnhancer.findStaticApi(this)
     }

grails-datastore-gorm-hibernate5/src/test/groovy/grails/gorm/tests/HibernateEntityTraitGeneratedSpec.groovy

@@ -0,0 +1,26 @@
+package grails.gorm.tests
+
+import grails.gorm.transactions.Rollback
+import groovy.transform.Generated
+import org.grails.orm.hibernate.HibernateDatastore
+import org.springframework.transaction.PlatformTransactionManager
+import spock.lang.AutoCleanup
+import spock.lang.IgnoreIf
+import spock.lang.Shared
+import spock.lang.Specification
+
+@Rollback
+class HibernateEntityTraitGeneratedSpec extends Specification {
+
+    @Shared @AutoCleanup HibernateDatastore datastore = new HibernateDatastore(Club)
+
+    void "test that all HibernateEntity trait methods are marked as Generated"() {
+        // Unfortunately static methods have to check directly one by one
+        expect:
+        Club.getMethod('findAllWithSql', CharSequence).isAnnotationPresent(Generated)
+        Club.getMethod('findWithSql', CharSequence).isAnnotationPresent(Generated)
+        Club.getMethod('findAllWithSql', CharSequence, Map).isAnnotationPresent(Generated)
+        Club.getMethod('findWithSql', CharSequence, Map).isAnnotationPresent(Generated)
+    }
+
+}