Merge pull request #6804 from murdos/ExcludeFromGeneratedCodeCoverage…

…-generated

Rename @generated to @ExcludeFromGeneratedCodeCoverage

src/main/java/tech/jhipster/lite/generator/server/javatool/base/domain/JavaBaseModuleFactory.java

@@ -1,6 +1,10 @@
 package tech.jhipster.lite.generator.server.javatool.base.domain;
 
-import static tech.jhipster.lite.module.domain.JHipsterModule.*;
+import static tech.jhipster.lite.module.domain.JHipsterModule.documentationTitle;
+import static tech.jhipster.lite.module.domain.JHipsterModule.from;
+import static tech.jhipster.lite.module.domain.JHipsterModule.moduleBuilder;
+import static tech.jhipster.lite.module.domain.JHipsterModule.toSrcMainJava;
+import static tech.jhipster.lite.module.domain.JHipsterModule.toSrcTestJava;
 
 import tech.jhipster.lite.error.domain.Assert;
 import tech.jhipster.lite.module.domain.JHipsterModule;
@@ -87,7 +91,7 @@ public JHipsterModule buildModule(JHipsterModuleProperties properties) {
           .and()
         .add(MAIN_SOURCE.template("package-info-error.java"), packageInfoDestination(mainDestination, Destination.ERROR))
         .add(MAIN_SOURCE.template("package-info-common.java"), packageInfoDestination(mainDestination,  Destination.COMMON))
-        .add(MAIN_SOURCE.template("Generated.java"), mainDestination.append(Destination.COMMON_DOMAIN.path).append("Generated.java"))
+        .add(MAIN_SOURCE.template("ExcludeFromGeneratedCodeCoverage.java"), mainDestination.append(Destination.COMMON_DOMAIN.path).append("ExcludeFromGeneratedCodeCoverage.java"))
         .add(MAIN_SOURCE.template("ProjectCollections.java"), collectionsDestination(baseName, mainDestination))
         .add(TEST_SOURCE.template("ProjectCollectionsTest.java"), collectionsTestDestination(baseName, testDestination))
         .and()

src/main/resources/generator/server/javatool/base/main/Generated.java.mustache → src/main/resources/generator/server/javatool/base/main/ExcludeFromGeneratedCodeCoverage.java.mustache

@@ -7,6 +7,6 @@ import java.lang.annotation.Target;
 
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ ElementType.METHOD, ElementType.TYPE, ElementType.CONSTRUCTOR })
-public @interface Generated {
+public @interface ExcludeFromGeneratedCodeCoverage {
   String reason() default "";
 }

src/main/resources/generator/server/pagination/domain/main/AppPageable.java.mustache

@@ -3,7 +3,7 @@ package {{packageName}}.pagination.domain;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 import {{packageName}}.error.domain.Assert;
 
 public class {{baseName}}Pageable {
@@ -34,13 +34,13 @@ public class {{baseName}}Pageable {
   }
 
   @Override
-  @Generated
+  @ExcludeFromGeneratedCodeCoverage
   public int hashCode() {
     return new HashCodeBuilder().append(page).append(pageSize).build();
   }
 
   @Override
-  @Generated
+  @ExcludeFromGeneratedCodeCoverage
   public boolean equals(Object obj) {
     if (this == obj) {
       return true;

src/main/resources/generator/server/pagination/rest/main/RestAppPageable.java.mustache

@@ -4,7 +4,7 @@ import jakarta.validation.constraints.Max;
 import jakarta.validation.constraints.Min;
 
 import io.swagger.v3.oas.annotations.media.Schema;
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 import {{packageName}}.pagination.domain.{{baseName}}Pageable;
 
 @Schema(name = "{{baseName}}Pageable", description = "Pagination information")
@@ -13,7 +13,7 @@ public class Rest{{baseName}}Pageable {
   private int page;
   private int pageSize = 10;
 
-  @Generated
+  @ExcludeFromGeneratedCodeCoverage
   public Rest{{baseName}}Pageable() {}
 
   public Rest{{baseName}}Pageable(int page, int pageSize) {

src/main/resources/generator/server/springboot/apidocumentation/springdoccore/SpringdocConfiguration.java.mustache

@@ -9,10 +9,10 @@ import io.swagger.v3.oas.models.ExternalDocumentation;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Info;
 import io.swagger.v3.oas.models.info.License;
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 
 @Configuration
-@Generated(reason = "Not testing technical configuration")
+@ExcludeFromGeneratedCodeCoverage(reason = "Not testing technical configuration")
 class SpringdocConfiguration {
 
   @Value("${application.version:undefined}")

src/main/resources/generator/server/springboot/apidocumentation/springdocjwt/SpringdocJWTConfiguration.java.mustache

@@ -8,11 +8,11 @@ import org.springframework.boot.autoconfigure.AutoConfigureBefore;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 
 @Configuration
 @AutoConfigureBefore(SpringdocConfiguration.class)
-@Generated(reason = "Not called by integration tests")
+@ExcludeFromGeneratedCodeCoverage(reason = "Not called by integration tests")
 class SpringdocJWTConfiguration {
 
   private static final String SECURITY_SCHEME_NAME = "bearer-jwt";

src/main/resources/generator/server/springboot/apidocumentation/springdocoauth/SpringdocOAuth2Configuration.java.mustache

@@ -12,11 +12,11 @@ import org.springframework.boot.autoconfigure.AutoConfigureBefore;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 
 @Configuration
 @AutoConfigureBefore(SpringdocConfiguration.class)
-@Generated(reason = "Not called by integration tests")
+@ExcludeFromGeneratedCodeCoverage(reason = "Not called by integration tests")
 class SpringdocOAuth2Configuration {
 
   @Value("${springdoc.oauth2.authorization-url}")

src/main/resources/generator/server/springboot/core/main/ApplicationStartupTraces.java.mustache

@@ -9,7 +9,7 @@ import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.core.env.Environment;
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 import {{packageName}}.error.domain.Assert;
 
 final class ApplicationStartupTraces {
@@ -101,7 +101,7 @@ final class ApplicationStartupTraces {
     return new StringBuilder().append("Profile(s): \t").append(Stream.of(profiles).collect(Collectors.joining(", "))).toString();
   }
 
-  @Generated(reason = "Hard to test implement detail error management")
+  @ExcludeFromGeneratedCodeCoverage(reason = "Hard to test implement detail error management")
   private static String hostAddress() {
     try {
       return InetAddress.getLocalHost().getHostAddress();

src/main/resources/generator/server/springboot/core/main/MainApp.java.mustache

@@ -6,10 +6,10 @@ import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.core.env.Environment;
 
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 
 @SpringBootApplication
-@Generated(reason = "Not testing logs")
+@ExcludeFromGeneratedCodeCoverage(reason = "Not testing logs")
 public class {{ baseName }}App {
 
   private static final Logger log = LoggerFactory.getLogger({{ baseName }}App.class);

src/main/resources/generator/server/springboot/mvc/dummy/cassandrapersistence/main/infrastructure/secondary/BeerCatalogTable.java.mustache

@@ -59,13 +59,13 @@ class BeerCatalogTable {
   }
 
   @Override
-  @Generated
+  @ExcludeFromGeneratedCodeCoverage
   public int hashCode() {
     return new HashCodeBuilder().append(id).hashCode();
   }
 
   @Override
-  @Generated
+  @ExcludeFromGeneratedCodeCoverage
   public boolean equals(Object obj) {
     if (this == obj) {
       return true;

src/main/resources/generator/server/springboot/mvc/dummy/cassandrapersistence/main/infrastructure/secondary/BeerTable.java.mustache

@@ -68,13 +68,13 @@ class BeerTable {
   }
 
   @Override
-  @Generated
+  @ExcludeFromGeneratedCodeCoverage
   public int hashCode() {
     return new HashCodeBuilder().append(id).hashCode();
   }
 
   @Override
-  @Generated
+  @ExcludeFromGeneratedCodeCoverage
   public boolean equals(Object o) {
     if (this == o) {
       return true;

src/main/resources/generator/server/springboot/mvc/dummy/jpapersistence/main/infrastructure/secondary/BeerEntity.java.mustache

@@ -12,7 +12,7 @@ import jakarta.persistence.EnumType;
 import jakarta.persistence.Enumerated;
 import jakarta.persistence.Id;
 import jakarta.persistence.Table;
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 import {{packageName}}.dummy.domain.BeerId;
 import {{packageName}}.dummy.domain.beer.Beer;
 import {{packageName}}.dummy.domain.beer.BeerSellingState;
@@ -71,13 +71,13 @@ class BeerEntity {
   }
 
   @Override
-  @Generated
+  @ExcludeFromGeneratedCodeCoverage
   public int hashCode() {
     return new HashCodeBuilder().append(id).hashCode();
   }
 
   @Override
-  @Generated
+  @ExcludeFromGeneratedCodeCoverage
   public boolean equals(Object obj) {
     if (this == obj) {
       return true;

src/main/resources/generator/server/springboot/mvc/dummy/mongodbpersistence/main/infrastructure/secondary/BeerDocument.java.mustache

@@ -1,6 +1,6 @@
 package {{packageName}}.dummy.infrastructure.secondary;
 
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 import {{packageName}}.dummy.domain.BeerId;
 import {{packageName}}.dummy.domain.beer.Beer;
 import {{packageName}}.dummy.domain.beer.BeerSellingState;
@@ -68,13 +68,13 @@ class BeerDocument {
   }
 
   @Override
-  @Generated
+  @ExcludeFromGeneratedCodeCoverage
   public int hashCode() {
     return new HashCodeBuilder().append(id).hashCode();
   }
 
   @Override
-  @Generated
+  @ExcludeFromGeneratedCodeCoverage
   public boolean equals(Object obj) {
     if (this == obj) {
       return true;

src/main/resources/generator/server/springboot/mvc/dummy/mongodbpersistence/main/infrastructure/secondary/BeersCollectionChangeUnit.java.mustache

@@ -7,10 +7,10 @@ import org.springframework.data.mongodb.core.MongoTemplate;
 import org.springframework.data.mongodb.core.index.TextIndexDefinition;
 import org.springframework.data.mongodb.core.index.TextIndexDefinition.TextIndexDefinitionBuilder;
 
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 
 @ChangeUnit(id = "create-beers-collection", order = "002", author = "jhipster")
-@Generated(reason = "Rollback not called in a normal lifecycle and an implementation detail")
+@ExcludeFromGeneratedCodeCoverage(reason = "Rollback not called in a normal lifecycle and an implementation detail")
 public class BeersCollectionChangeUnit {
 
   @Execution

src/main/resources/generator/server/springboot/mvc/frontend/RedirectionResource.java.mustache

@@ -3,9 +3,9 @@ package {{packageName}}.technical.infrastructure.primary.redirection;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 
-@Generated
+@ExcludeFromGeneratedCodeCoverage
 @Controller
 class RedirectionResource {
 

src/main/resources/generator/server/springboot/mvc/security/kipe/expression/main/AccessEvaluator.java.mustache

@@ -10,7 +10,7 @@ import java.util.function.Function;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 import {{packageName}}.error.domain.Assert;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -25,14 +25,14 @@ class AccessEvaluator {
   private final AccessChecker<?> defaultEvaluator;
   private final Map<Class<?>, AccessChecker<?>> evaluators;
 
-  @Generated(reason = "Ignored log conditional")
+  @ExcludeFromGeneratedCodeCoverage(reason = "Ignored log conditional")
   public AccessEvaluator(List<AccessChecker<?>> checkers) {
     evaluators = new ConcurrentHashMap<>(checkers.stream().collect(Collectors.toMap(this::getCheckerResourceClass, Function.identity())));
 
     if(logger.isInfoEnabled()) {
       logger.info("Authorized types: {}", evaluators.keySet().stream().map(Class::getName).collect(Collectors.joining(", ")));
     }
-    
+
     defaultEvaluator = evaluators.get(Object.class);
     Assert.notNull("defaultEvaluator", defaultEvaluator);
   }

src/main/resources/generator/server/springboot/mvc/security/kipe/expression/main/KipeMethodSecurityExpressionRoot.java.mustache

@@ -1,12 +1,12 @@
 package {{packageName}}.kipe.application;
 
 import java.util.function.Supplier;
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 import org.springframework.security.access.expression.SecurityExpressionRoot;
 import org.springframework.security.access.expression.method.MethodSecurityExpressionOperations;
 import org.springframework.security.core.Authentication;
 
-@Generated(reason = "Spring glue bean")
+@ExcludeFromGeneratedCodeCoverage(reason = "Spring glue bean")
 class KipeMethodSecurityExpressionRoot extends SecurityExpressionRoot implements MethodSecurityExpressionOperations {
 
   private final AccessEvaluator evaluator;

src/main/resources/generator/server/springboot/mvc/security/kipe/expression/main/NullElementAccessContext.java.mustache

@@ -1,10 +1,10 @@
 package {{packageName}}.kipe.application;
 
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 import {{packageName}}.error.domain.Assert;
 import org.springframework.security.core.Authentication;
 
-@Generated(reason = "Untested null object structure")
+@ExcludeFromGeneratedCodeCoverage(reason = "Untested null object structure")
 record NullElementAccessContext<T>(Authentication authentication, String action) implements AccessContext<T> {
   public NullElementAccessContext {
     Assert.notNull("authentication", authentication);

src/main/resources/generator/server/springboot/mvc/security/kipe/expression/main/ObjectAccessChecker.java.mustache

@@ -1,6 +1,6 @@
 package {{packageName}}.kipe.application;
 
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Component;
@@ -11,8 +11,8 @@ class ObjectAccessChecker implements AccessChecker<Object> {
   private static final Logger logger = LoggerFactory.getLogger(ObjectAccessChecker.class);
 
   @Override
-  @Generated(reason = "Ignored log conditional")
-  public boolean can(AccessContext<Object> access) {    
+  @ExcludeFromGeneratedCodeCoverage(reason = "Ignored log conditional")
+  public boolean can(AccessContext<Object> access) {
     if (logger.isWarnEnabled()) {
       logger.warn("No access checker found for {}, using default for action {}", getElementClass(access.element()), access.action());
     }

src/main/resources/generator/server/springboot/mvc/security/oauth2/core/main/infrastructure/primary/SecurityConfiguration.java.mustache

@@ -34,7 +34,7 @@ import org.springframework.security.web.header.writers.ReferrerPolicyHeaderWrite
 import org.springframework.web.filter.CorsFilter;
 
 import {{packageName}}.authentication.domain.Role;
-import {{packageName}}.common.domain.Generated;
+import {{packageName}}.common.domain.ExcludeFromGeneratedCodeCoverage;
 
 import static org.springframework.security.config.Customizer.withDefaults;
 
@@ -137,7 +137,7 @@ public class SecurityConfiguration {
   }
 
   @Bean
-  @Generated(reason = "Only called with a valid client registration repository")
+  @ExcludeFromGeneratedCodeCoverage(reason = "Only called with a valid client registration repository")
   public JwtDecoder jwtDecoder(ClientRegistrationRepository clientRegistrationRepository, RestTemplateBuilder restTemplateBuilder) {
     NimbusJwtDecoder jwtDecoder = JwtDecoders.fromOidcIssuerLocation(issuerUri);
 

src/test/java/tech/jhipster/lite/generator/server/javatool/base/domain/JavaBaseModuleFactoryTest.java

@@ -1,6 +1,7 @@
 package tech.jhipster.lite.generator.server.javatool.base.domain;
 
-import static tech.jhipster.lite.module.infrastructure.secondary.JHipsterModulesAssertions.*;
+import static tech.jhipster.lite.module.infrastructure.secondary.JHipsterModulesAssertions.assertThatModuleWithFiles;
+import static tech.jhipster.lite.module.infrastructure.secondary.JHipsterModulesAssertions.readmeFile;
 
 import org.junit.jupiter.api.Test;
 import tech.jhipster.lite.TestFileUtils;
@@ -63,7 +64,7 @@ void shouldCreateModule() {
       .hasFiles(
         "src/main/java/com/jhipster/test/error/package-info.java",
         "src/main/java/com/jhipster/test/common/package-info.java",
-        "src/main/java/com/jhipster/test/common/domain/Generated.java"
+        "src/main/java/com/jhipster/test/common/domain/ExcludeFromGeneratedCodeCoverage.java"
       )
       .hasFile("src/main/java/com/jhipster/test/common/domain/MyappCollections.java")
       .containing("class MyappCollections")