client, add validateClient to ClientBuilder (#2783)

Author: weidongxu-microsoft

azure-dataplane-tests/src/main/java/com/azure/ai/formrecognizer/documentanalysis/dpg/DocumentModelsClientBuilder.java

@@ -253,6 +253,7 @@ public DocumentModelsClientBuilder retryPolicy(RetryPolicy retryPolicy) {
      */
     @Generated
     private FormRecognizerClientImpl buildInnerClient() {
+        this.validateClient();
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
         FormRecognizerServiceVersion localServiceVersion
             = (serviceVersion != null) ? serviceVersion : FormRecognizerServiceVersion.getLatest();
@@ -261,6 +262,13 @@ private FormRecognizerClientImpl buildInnerClient() {
         return client;
     }
 
+    @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+        Objects.requireNonNull(endpoint, "'endpoint' cannot be null.");
+    }
+
     @Generated
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration

azure-dataplane-tests/src/main/java/com/azure/ai/formrecognizer/documentanalysis/dpg/MiscellaneousClientBuilder.java

@@ -253,6 +253,7 @@ public MiscellaneousClientBuilder retryPolicy(RetryPolicy retryPolicy) {
      */
     @Generated
     private FormRecognizerClientImpl buildInnerClient() {
+        this.validateClient();
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
         FormRecognizerServiceVersion localServiceVersion
             = (serviceVersion != null) ? serviceVersion : FormRecognizerServiceVersion.getLatest();
@@ -261,6 +262,13 @@ private FormRecognizerClientImpl buildInnerClient() {
         return client;
     }
 
+    @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+        Objects.requireNonNull(endpoint, "'endpoint' cannot be null.");
+    }
+
     @Generated
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration

azure-dataplane-tests/src/main/java/com/azure/ai/formrecognizer/documentanalysis/implementation/FormRecognizerClientImplBuilder.java

@@ -267,6 +267,7 @@ public FormRecognizerClientImplBuilder retryPolicy(RetryPolicy retryPolicy) {
      */
     @Generated
     public FormRecognizerClientImpl buildClient() {
+        this.validateClient();
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
         String localApiVersion = (apiVersion != null) ? apiVersion : "2022-08-31";
         SerializerAdapter localSerializerAdapter
@@ -276,6 +277,13 @@ public FormRecognizerClientImpl buildClient() {
         return client;
     }
 
+    @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+        Objects.requireNonNull(endpoint, "'endpoint' cannot be null.");
+    }
+
     @Generated
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration

azure-tests/src/main/java/fixtures/azureparametergrouping/AutoRestParameterGroupingTestServiceBuilder.java

@@ -231,6 +231,7 @@ public AutoRestParameterGroupingTestServiceBuilder retryPolicy(RetryPolicy retry
      */
     @Generated
     public AutoRestParameterGroupingTestService buildClient() {
+        this.validateClient();
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
         String localHost = (host != null) ? host : "http://localhost:3000";
         SerializerAdapter localSerializerAdapter
@@ -240,6 +241,12 @@ public AutoRestParameterGroupingTestService buildClient() {
         return client;
     }
 
+    @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+    }
+
     @Generated
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration

azure-tests/src/main/java/fixtures/azurereport/AutoRestReportServiceForAzureBuilder.java

@@ -230,6 +230,7 @@ public AutoRestReportServiceForAzureBuilder retryPolicy(RetryPolicy retryPolicy)
      */
     @Generated
     public AutoRestReportServiceForAzure buildClient() {
+        this.validateClient();
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
         String localHost = (host != null) ? host : "http://localhost:3000";
         SerializerAdapter localSerializerAdapter
@@ -239,6 +240,12 @@ public AutoRestReportServiceForAzure buildClient() {
         return client;
     }
 
+    @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+    }
+
     @Generated
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration

azure-tests/src/main/java/fixtures/azurespecials/AutoRestAzureSpecialParametersTestClientBuilder.java

@@ -269,6 +269,7 @@ public AutoRestAzureSpecialParametersTestClientBuilder retryPolicy(RetryPolicy r
      */
     @Generated
     public AutoRestAzureSpecialParametersTestClient buildClient() {
+        this.validateClient();
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
         String localHost = (host != null) ? host : "http://localhost:3000";
         String localApiVersion = (apiVersion != null) ? apiVersion : "2015-07-01-preview";
@@ -279,6 +280,13 @@ public AutoRestAzureSpecialParametersTestClient buildClient() {
         return client;
     }
 
+    @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+        Objects.requireNonNull(subscriptionId, "'subscriptionId' cannot be null.");
+    }
+
     @Generated
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration

azure-tests/src/main/java/fixtures/custombaseuri/paging/AutoRestParameterizedHostTestPagingClientBuilder.java

@@ -231,6 +231,7 @@ public AutoRestParameterizedHostTestPagingClientBuilder retryPolicy(RetryPolicy
      */
     @Generated
     public AutoRestParameterizedHostTestPagingClient buildClient() {
+        this.validateClient();
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
         String localHost = (host != null) ? host : "host";
         SerializerAdapter localSerializerAdapter
@@ -240,6 +241,12 @@ public AutoRestParameterizedHostTestPagingClient buildClient() {
         return client;
     }
 
+    @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+    }
+
     @Generated
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration

azure-tests/src/main/java/fixtures/paging/AutoRestPagingTestServiceBuilder.java

@@ -250,6 +250,7 @@ public AutoRestPagingTestServiceBuilder retryPolicy(RetryPolicy retryPolicy) {
      */
     @Generated
     private AutoRestPagingTestServiceImpl buildInnerClient() {
+        this.validateClient();
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
         String localHost = (host != null) ? host : "http://localhost:3000";
         String localApiVersion = (apiVersion != null) ? apiVersion : "1.0.0";
@@ -260,6 +261,12 @@ private AutoRestPagingTestServiceImpl buildInnerClient() {
         return client;
     }
 
+    @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+    }
+
     @Generated
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration

azure-tests/src/main/java/fixtures/subscriptionidapiversion/MicrosoftAzureTestUrlBuilder.java

@@ -266,6 +266,7 @@ public MicrosoftAzureTestUrlBuilder retryPolicy(RetryPolicy retryPolicy) {
      */
     @Generated
     public MicrosoftAzureTestUrl buildClient() {
+        this.validateClient();
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
         String localHost = (host != null) ? host : "http://localhost:3000";
         String localApiVersion = (apiVersion != null) ? apiVersion : "2014-04-01-preview";
@@ -276,6 +277,13 @@ public MicrosoftAzureTestUrl buildClient() {
         return client;
     }
 
+    @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+        Objects.requireNonNull(subscriptionId, "'subscriptionId' cannot be null.");
+    }
+
     @Generated
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration

azure-tests/src/test/java/fixtures/azurespecials/AzureSpecialParametersTests.java

@@ -7,12 +7,7 @@
 
 import com.azure.core.exception.HttpResponseException;
 import com.azure.core.http.HttpHeaders;
-import com.azure.core.http.HttpPipeline;
-import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.http.policy.AddHeadersFromContextPolicy;
-import com.azure.core.http.policy.CookiePolicy;
-import com.azure.core.http.policy.RetryPolicy;
-import com.azure.core.http.policy.UserAgentPolicy;
 import com.azure.core.util.Context;
 import fixtures.azurespecials.models.HeaderCustomNamedRequestIdParamGroupingParameters;
 import fixtures.azurespecials.models.HeadersCustomNamedRequestIdHeadResponse;
@@ -35,20 +30,14 @@ public class AzureSpecialParametersTests {
 
     @BeforeAll
     public static void setup() {
-        HttpPipeline pipeline = new HttpPipelineBuilder().policies(new UserAgentPolicy(),
-                new AddHeadersFromContextPolicy(),
-                new RetryPolicy(),
-                new CookiePolicy()
-                //, new HttpLoggingPolicy(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
-        ).build();
-
         client = new AutoRestAzureSpecialParametersTestClientBuilder()
-                .pipeline(pipeline)
+                .addPolicy(new AddHeadersFromContextPolicy())
                 .subscriptionId("1234-5678-9012-3456")
                 .buildClient();
 
         clientNoSubscription = new AutoRestAzureSpecialParametersTestClientBuilder()
-                .pipeline(pipeline)
+                .addPolicy(new AddHeadersFromContextPolicy())
+                .subscriptionId("")
                 .buildClient();
     }
 
@@ -59,7 +48,7 @@ public void get() {
 
     @Test
     public void getOverwriteNull() {
-        client.getXMsClientRequestIds().getWithResponse(new Context("azure-http-headers-key", new HttpHeaders(Collections.singletonMap("x-ms-client-request-id", null))));
+        Assertions.assertThrows(HttpResponseException.class, () -> client.getXMsClientRequestIds().getWithResponse(new Context("azure-http-headers-key", new HttpHeaders(Collections.singletonMap("x-ms-client-request-id", null)))));
     }
 
     @Test
@@ -79,7 +68,10 @@ public void postMethodGlobalValid() {
 
     @Test
     public void postMethodGlobalNull() {
-        Assertions.assertThrows(IllegalArgumentException.class, () -> clientNoSubscription.getSubscriptionInCredentials().postMethodGlobalNull());
+        Assertions.assertThrows(RuntimeException.class, () -> new AutoRestAzureSpecialParametersTestClientBuilder()
+                .addPolicy(new AddHeadersFromContextPolicy())
+                .buildClient()
+                .getSubscriptionInCredentials().postMethodGlobalNull());
     }
 
     @Test

customization-tests/src/main/java/fixtures/bodycomplex/AutoRestComplexTestServiceBuilder.java

@@ -268,6 +268,7 @@ public AutoRestComplexTestServiceBuilder retryPolicy(RetryPolicy retryPolicy) {
      */
     @Generated
     private AutoRestComplexTestServiceImpl buildInnerClient() {
+        this.validateClient();
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
         String localHost = (host != null) ? host : "http://localhost:3000";
         String localApiVersion = (apiVersion != null) ? apiVersion : "2016-02-29";
@@ -278,6 +279,12 @@ private AutoRestComplexTestServiceImpl buildInnerClient() {
         return client;
     }
 
+    @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+    }
+
     @Generated
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration

javagen/src/main/java/com/azure/autorest/template/ServiceClientBuilderTemplate.java

@@ -10,6 +10,7 @@
 import com.azure.autorest.model.clientmodel.AsyncSyncClient;
 import com.azure.autorest.model.clientmodel.ClassType;
 import com.azure.autorest.model.clientmodel.ClientBuilder;
+import com.azure.autorest.model.clientmodel.ClientBuilderTrait;
 import com.azure.autorest.model.clientmodel.ClientBuilderTraitMethod;
 import com.azure.autorest.model.clientmodel.PipelinePolicyDetails;
 import com.azure.autorest.model.clientmodel.PrimitiveType;
@@ -249,24 +250,19 @@ public final void write(ClientBuilder clientBuilder, JavaFile javaFile) {
             JavaVisibility visibility = settings.isGenerateSyncAsyncClients() ? JavaVisibility.Private : JavaVisibility.Public;
 
             // build method
-            classBlock.javadocComment(comment ->
-            {
+            classBlock.javadocComment(comment -> {
                 comment.description(String.format("Builds an instance of %1$s with the provided parameters", buildReturnType));
                 comment.methodReturns(String.format("an instance of %1$s", buildReturnType));
             });
             addGeneratedAnnotation(classBlock);
-            classBlock.method(visibility, null, String.format("%1$s %2$s()", buildReturnType, buildMethodName), function ->
-            {
-                List<ServiceClientProperty> allProperties = new ArrayList<>();
+            classBlock.method(visibility, null, String.format("%1$s %2$s()", buildReturnType, buildMethodName), function -> {
                 if (!settings.isAzureOrFluent()) {
-                    allProperties.addAll(clientBuilder.getBuilderTraits()
-                            .stream()
-                            .flatMap(trait -> trait.getTraitMethods().stream())
-                            .map(ClientBuilderTraitMethod::getProperty)
-                            .filter(Objects::nonNull)
-                            .collect(Collectors.toList()));
+                    function.line("this.validateClient();");
                 }
-                allProperties.addAll(clientProperties);
+
+                List<ServiceClientProperty> allProperties = mergeClientPropertiesWithTraits(
+                    clientProperties,
+                    settings.isAzureOrFluent() ? null : clientBuilder.getBuilderTraits());
 
                 for (ServiceClientProperty serviceClientProperty : allProperties) {
                     if (serviceClientProperty.getDefaultValueExpression() != null
@@ -277,7 +273,6 @@ public final void write(ClientBuilder clientBuilder, JavaFile javaFile) {
                                 serviceClientProperty.getName(),
                                 serviceClientProperty.getName(),
                                 serviceClientProperty.getDefaultValueExpression()));
-
                     }
                 }
 
@@ -323,6 +318,9 @@ public final void write(ClientBuilder clientBuilder, JavaFile javaFile) {
             });
 
             if (!settings.isAzureOrFluent()) {
+                List<ServiceClientProperty> allProperties = mergeClientPropertiesWithTraits(clientProperties, clientBuilder.getBuilderTraits());
+                addValidateClientMethod(classBlock, allProperties);
+
                 addCreateHttpPipelineMethod(settings, classBlock, serviceClient.getDefaultCredentialScopes(), serviceClient.getSecurityInfo(), serviceClient.getPipelinePolicyDetails());
             }
 
@@ -336,6 +334,22 @@ public final void write(ClientBuilder clientBuilder, JavaFile javaFile) {
         });
     }
 
+    private static List<ServiceClientProperty> mergeClientPropertiesWithTraits(
+        List<ServiceClientProperty> clientProperties, List<ClientBuilderTrait> builderTraits) {
+
+        List<com.azure.autorest.model.clientmodel.ServiceClientProperty> allProperties = new ArrayList<>();
+        if (builderTraits != null) {
+            allProperties.addAll(builderTraits
+                    .stream()
+                    .flatMap(trait -> trait.getTraitMethods().stream())
+                    .map(ClientBuilderTraitMethod::getProperty)
+                    .filter(Objects::nonNull)
+                    .collect(Collectors.toList()));
+        }
+        allProperties.addAll(clientProperties);
+        return allProperties;
+    }
+
     private void addBuildAsyncClientMethods(ClientBuilder clientBuilder, List<AsyncSyncClient> asyncClients, JavaClass classBlock, String buildMethodName) {
         for (AsyncSyncClient asyncClient : asyncClients) {
             final boolean wrapServiceClient = asyncClient.getMethodGroupClient() == null;
@@ -516,6 +530,20 @@ protected void addCreateHttpPipelineMethod(JavaSettings settings, JavaClass clas
         });
     }
 
+    private void addValidateClientMethod(JavaClass classBlock, List<ServiceClientProperty> properties) {
+        addGeneratedAnnotation(classBlock);
+        classBlock.privateMethod("void validateClient()", methodBlock -> {
+            methodBlock.line("// This method is invoked from 'buildInnerClient'/'buildClient' method.");
+            methodBlock.line("// Developer can customize this method, to validate that the necessary conditions are met for the new client.");
+            for (ServiceClientProperty property : properties) {
+                // property have a default value would have a "local<PropertyName>" for the initialization of client
+                if (property.isRequired() && property.getDefaultValueExpression() == null) {
+                    methodBlock.line("Objects.requireNonNull(" + property.getName() + ", \"'" + property.getName() + "' cannot be null.\");");
+                }
+            }
+        });
+    }
+
     protected ArrayList<ServiceClientProperty> addCommonClientProperties(JavaSettings settings, SecurityInfo securityInfo) {
         ArrayList<ServiceClientProperty> commonProperties = new ArrayList<ServiceClientProperty>();
         if (settings.isAzureOrFluent()) {

partial-update-tests/generated/src/main/java/fixtures/bodystring/AutoRestSwaggerBatServiceClientBuilder.java

@@ -220,6 +220,7 @@ public AutoRestSwaggerBatServiceClientBuilder retryPolicy(RetryPolicy retryPolic
      */
     @Generated
     private AutoRestSwaggerBatServiceClientImpl buildInnerClient() {
+        this.validateClient();
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
         String localHost = (host != null) ? host : "http://localhost:3000";
         AutoRestSwaggerBatServiceVersion localServiceVersion
@@ -322,5 +323,11 @@ public AutoRestSwaggerBatServiceClientBuilder serviceVersion(AutoRestSwaggerBatS
         return this;
     }
 
+    @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+    }
+
     private static final ClientLogger LOGGER = new ClientLogger(AutoRestSwaggerBatServiceClientBuilder.class);
 }