Batch #2 - 11. No .builder() API: No classes should have a .builder() (…

…Azure#4589) * add MethodName rule to disable builder as a method name and update issues
jianghaolu · Jul 26, 2019 · 9739dc6 · 9739dc6
1 parent ea2f43a
commit 9739dc6
Show file tree

Hide file tree

Showing 26 changed files with 84 additions and 58 deletions.
diff --git a/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle.xml b/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle.xml
@@ -60,7 +60,12 @@ page at http://checkstyle.sourceforge.net/config.html -->
     <module name="LocalFinalVariableName"/>
     <module name="LocalVariableName"/>
     <module name="MemberName"/>
-    <module name="MethodName"/>
+    <module name="MethodName">
+      <!-- Use default MethodName but block the use of 'builder' as method name -->
+      <property name="format" value="(?=^[a-z][a-zA-Z0-9]*$)(?!^(?i)builder$)"/>
+      <!-- allow the name on private methods  -->
+      <property name="applyToPrivate" value="false"/>
+    </module>
     <module name="PackageName"/>
     <module name="ParameterName"/>
     <module name="StaticVariableName"/>

diff --git a/...nfiguration/src/main/java/com/azure/data/appconfiguration/ConfigurationClientBuilder.java b/...nfiguration/src/main/java/com/azure/data/appconfiguration/ConfigurationClientBuilder.java
@@ -3,6 +3,7 @@
 
 package com.azure.data.appconfiguration;
 
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.implementation.annotation.ServiceClientBuilder;
 import com.azure.core.util.logging.ClientLogger;
 import com.azure.data.appconfiguration.credentials.ConfigurationClientCredentials;
@@ -165,7 +166,7 @@ public ConfigurationAsyncClient buildAsyncClient() {
         HttpPolicyProviders.addAfterRetryPolicies(policies);
         policies.add(new HttpLoggingPolicy(httpLogDetailLevel));
 
-        HttpPipeline pipeline = HttpPipeline.builder()
+        HttpPipeline pipeline = new HttpPipelineBuilder()
             .policies(policies.toArray(new HttpPipelinePolicy[0]))
             .httpClient(httpClient)
             .build();

diff --git a/.../samples/java/com/azure/data/appconfiguration/ConfigurationClientJavaDocCodeSnippets.java b/.../samples/java/com/azure/data/appconfiguration/ConfigurationClientJavaDocCodeSnippets.java
@@ -4,6 +4,7 @@
 package com.azure.data.appconfiguration;
 
 import com.azure.core.http.HttpPipeline;
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.http.rest.Response;
 import com.azure.core.test.models.RecordedData;
 import com.azure.core.test.policy.RecordNetworkCallPolicy;
@@ -34,7 +35,7 @@ public ConfigurationClient createAsyncConfigurationClientWithPipeline() {
             String connectionString = getConnectionString();
             // BEGIN: com.azure.data.applicationconfig.configurationclient.pipeline.instantiation
             RecordedData networkData = new RecordedData();
-            HttpPipeline pipeline = HttpPipeline.builder().policies(new RecordNetworkCallPolicy(networkData)).build();
+            HttpPipeline pipeline = new HttpPipelineBuilder().policies(new RecordNetworkCallPolicy(networkData)).build();
 
             ConfigurationClient configurationClient = new ConfigurationClientBuilder()
                 .pipeline(pipeline)

diff --git a/...re-core-management/src/main/java/com/azure/core/management/implementation/AzureProxy.java b/...re-core-management/src/main/java/com/azure/core/management/implementation/AzureProxy.java
@@ -8,6 +8,7 @@
 import com.azure.core.http.HttpMethod;
 import com.azure.core.http.HttpPipeline;
 import com.azure.core.http.HttpRequest;
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.http.HttpResponse;
 import com.azure.core.http.policy.CookiePolicy;
 import com.azure.core.http.policy.HttpPipelinePolicy;
@@ -189,7 +190,7 @@ public static HttpPipeline createDefaultPipeline(Class<?> swaggerInterface, Http
             policies.add(credentialsPolicy);
         }
 
-        return HttpPipeline.builder()
+        return new HttpPipelineBuilder()
             .policies(policies.toArray(new HttpPipelinePolicy[0]))
             .build();
     }

diff --git a/...e-core-management/src/test/java/com/azure/core/management/AzureProxyToRestProxyTests.java b/...e-core-management/src/test/java/com/azure/core/management/AzureProxyToRestProxyTests.java
@@ -3,6 +3,7 @@
 
 package com.azure.core.management;
 
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.implementation.annotation.BodyParam;
 import com.azure.core.implementation.annotation.Delete;
 import com.azure.core.implementation.annotation.ExpectedResponses;
@@ -764,7 +765,7 @@ public void service18GetStatus500WithExpectedResponse500() {
     }
 
     private <T> T createService(Class<T> serviceClass) {
-        HttpPipeline pipeline = HttpPipeline.builder()
+        HttpPipeline pipeline = new HttpPipelineBuilder()
             .httpClient(createHttpClient())
             .build();
         //

diff --git a/...re-management/src/test/java/com/azure/core/management/implementation/AzureProxyTests.java b/...re-management/src/test/java/com/azure/core/management/implementation/AzureProxyTests.java
@@ -3,6 +3,7 @@
 
 package com.azure.core.management.implementation;
 
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.implementation.annotation.Delete;
 import com.azure.core.implementation.annotation.ExpectedResponses;
 import com.azure.core.implementation.annotation.Get;
@@ -851,7 +852,7 @@ public Mono<HttpResponse> send(HttpRequest request) {
     }
 
     private static <T> T createMockService(Class<T> serviceClass, MockAzureHttpClient httpClient) {
-        HttpPipeline pipeline = HttpPipeline.builder()
+        HttpPipeline pipeline = new HttpPipelineBuilder()
             .httpClient(httpClient)
             .build();
 

diff --git a/sdk/core/azure-core/src/main/java/com/azure/core/http/HttpPipeline.java b/sdk/core/azure-core/src/main/java/com/azure/core/http/HttpPipeline.java
@@ -18,15 +18,6 @@ public final class HttpPipeline {
     private final HttpPipelinePolicy[] pipelinePolicies;
 
 
-    /**
-     * Creates a builder that can configure options for the HttpPipeline before creating an instance of it.
-     *
-     * @return A new {@link HttpPipelineBuilder} to create a HttpPipeline from.
-     */
-    public static HttpPipelineBuilder builder() {
-        return new HttpPipelineBuilder();
-    }
-
     /**
      * Creates a HttpPipeline holding array of policies that gets applied to all request initiated through
      * {@link HttpPipeline#send(HttpPipelineCallContext)} and it's response.

diff --git a/sdk/core/azure-core/src/main/java/com/azure/core/http/HttpPipelineBuilder.java b/sdk/core/azure-core/src/main/java/com/azure/core/http/HttpPipelineBuilder.java
@@ -41,7 +41,12 @@ public class HttpPipelineBuilder {
     private List<HttpPipelinePolicy> pipelinePolicies;
 
 
-    HttpPipelineBuilder() {
+    /**
+     -     * Creates a builder that can configure options for the HttpPipeline before creating an instance of it.
+     -     *
+     -     * @return A new {@link HttpPipelineBuilder} to create a HttpPipeline from.
+     */
+    public HttpPipelineBuilder() {
     }
 
     /**

diff --git a/sdk/core/azure-core/src/main/java/com/azure/core/implementation/RestProxy.java b/sdk/core/azure-core/src/main/java/com/azure/core/implementation/RestProxy.java
@@ -11,6 +11,7 @@
 import com.azure.core.http.HttpMethod;
 import com.azure.core.http.HttpPipeline;
 import com.azure.core.http.HttpRequest;
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.http.HttpResponse;
 import com.azure.core.http.policy.CookiePolicy;
 import com.azure.core.http.policy.HttpPipelinePolicy;
@@ -624,7 +625,7 @@ public static HttpPipeline createDefaultPipeline(HttpPipelinePolicy credentialsP
             policies.add(credentialsPolicy);
         }
 
-        return HttpPipeline.builder()
+        return new HttpPipelineBuilder()
             .policies(policies.toArray(new HttpPipelinePolicy[0]))
             .build();
     }

diff --git a/sdk/core/azure-core/src/test/java/com/azure/core/UserAgentTests.java b/sdk/core/azure-core/src/test/java/com/azure/core/UserAgentTests.java
@@ -6,6 +6,7 @@
 import com.azure.core.http.HttpMethod;
 import com.azure.core.http.HttpPipeline;
 import com.azure.core.http.HttpRequest;
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.http.HttpResponse;
 import com.azure.core.http.MockHttpClient;
 import com.azure.core.http.MockHttpResponse;
@@ -19,7 +20,7 @@
 public class UserAgentTests {
     @Test
     public void defaultUserAgentTests() throws Exception {
-        final HttpPipeline pipeline = HttpPipeline.builder()
+        final HttpPipeline pipeline = new HttpPipelineBuilder()
             .httpClient(new MockHttpClient() {
                 @Override
                 public Mono<HttpResponse> send(HttpRequest request) {
@@ -40,7 +41,7 @@ public Mono<HttpResponse> send(HttpRequest request) {
 
     @Test
     public void customUserAgentTests() throws Exception {
-        final HttpPipeline pipeline = HttpPipeline.builder()
+        final HttpPipeline pipeline = new HttpPipelineBuilder()
             .httpClient(new MockHttpClient() {
                 @Override
                 public Mono<HttpResponse> send(HttpRequest request) {

diff --git a/sdk/core/azure-core/src/test/java/com/azure/core/credentials/CredentialsTests.java b/sdk/core/azure-core/src/test/java/com/azure/core/credentials/CredentialsTests.java
@@ -5,6 +5,7 @@
 
 import com.azure.core.http.HttpMethod;
 import com.azure.core.http.HttpPipeline;
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.http.HttpRequest;
 import com.azure.core.http.MockHttpClient;
 import com.azure.core.http.policy.BearerTokenAuthenticationPolicy;
@@ -28,7 +29,7 @@ public void basicCredentialsTest() throws Exception {
             return next.process();
         };
         //
-        final HttpPipeline pipeline = HttpPipeline.builder()
+        final HttpPipeline pipeline = new HttpPipelineBuilder()
             .httpClient(new MockHttpClient())
             .policies((context, next) -> credentials.getToken("scope./default")
                 .flatMap(token -> {
@@ -56,7 +57,7 @@ public Mono<AccessToken> getToken(String... scopes) {
             return next.process();
         };
 
-        final HttpPipeline pipeline = HttpPipeline.builder()
+        final HttpPipeline pipeline = new HttpPipelineBuilder()
             .httpClient(new MockHttpClient())
             .policies(new BearerTokenAuthenticationPolicy(credentials, "scope./default"), auditorPolicy)
             .build();

diff --git a/sdk/core/azure-core/src/test/java/com/azure/core/http/HttpPipelineTests.java b/sdk/core/azure-core/src/test/java/com/azure/core/http/HttpPipelineTests.java
@@ -23,15 +23,15 @@
 public class HttpPipelineTests {
     @Test
     public void constructorWithNoArguments() {
-        HttpPipeline pipeline = HttpPipeline.builder().build();
+        HttpPipeline pipeline = new HttpPipelineBuilder().build();
         assertEquals(0, pipeline.getPolicyCount());
         assertNotNull(pipeline.httpClient());
         assertTrue(pipeline.httpClient() instanceof ReactorNettyClient);
     }
 
     @Test
     public void withRequestPolicy() {
-        HttpPipeline pipeline = HttpPipeline.builder()
+        HttpPipeline pipeline = new HttpPipelineBuilder()
             .policies(new PortPolicy(80, true),
                 new ProtocolPolicy("ftp", true),
                 new RetryPolicy())
@@ -47,7 +47,7 @@ public void withRequestPolicy() {
 
     @Test
     public void withRequestOptions() throws MalformedURLException {
-        HttpPipeline pipeline = HttpPipeline.builder()
+        HttpPipeline pipeline = new HttpPipelineBuilder()
             .policies(new PortPolicy(80, true),
                 new ProtocolPolicy("ftp", true),
                 new RetryPolicy())
@@ -63,7 +63,7 @@ public void withRequestOptions() throws MalformedURLException {
     public void withNoRequestPolicies() throws MalformedURLException {
         final HttpMethod expectedHttpMethod = HttpMethod.GET;
         final URL expectedUrl = new URL("http://my.site.com");
-        final HttpPipeline httpPipeline = HttpPipeline.builder()
+        final HttpPipeline httpPipeline = new HttpPipelineBuilder()
             .httpClient(new MockHttpClient() {
                 @Override
                 public Mono<HttpResponse> send(HttpRequest request) {
@@ -96,7 +96,7 @@ public Mono<HttpResponse> send(HttpRequest request) {
             }
         };
 
-        final HttpPipeline httpPipeline = HttpPipeline.builder()
+        final HttpPipeline httpPipeline = new HttpPipelineBuilder()
             .httpClient(httpClient)
             .policies(new UserAgentPolicy(expectedUserAgent))
             .build();
@@ -110,7 +110,7 @@ public Mono<HttpResponse> send(HttpRequest request) {
     public void withRequestIdRequestPolicy() throws MalformedURLException {
         final HttpMethod expectedHttpMethod = HttpMethod.GET;
         final URL expectedUrl = new URL("http://my.site.com/1");
-        final HttpPipeline httpPipeline = HttpPipeline.builder()
+        final HttpPipeline httpPipeline = new HttpPipelineBuilder()
             .httpClient(new MockHttpClient() {
                 @Override
                 public Mono<HttpResponse> send(HttpRequest request) {

diff --git a/sdk/core/azure-core/src/test/java/com/azure/core/http/policy/HostPolicyTests.java b/sdk/core/azure-core/src/test/java/com/azure/core/http/policy/HostPolicyTests.java
@@ -7,6 +7,7 @@
 import com.azure.core.http.HttpMethod;
 import com.azure.core.http.HttpPipeline;
 import com.azure.core.http.HttpRequest;
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.http.HttpResponse;
 import com.azure.core.http.ProxyOptions;
 import org.junit.Test;
@@ -32,7 +33,7 @@ public void withPort() throws MalformedURLException {
     }
 
     private static HttpPipeline createPipeline(String host, String expectedUrl) {
-        return HttpPipeline.builder()
+        return new HttpPipelineBuilder()
             .httpClient(new MockHttpClient())
             .policies(new HostPolicy(host),
                 (context, next) -> {

diff --git a/sdk/core/azure-core/src/test/java/com/azure/core/http/policy/ProtocolPolicyTests.java b/sdk/core/azure-core/src/test/java/com/azure/core/http/policy/ProtocolPolicyTests.java
@@ -7,6 +7,7 @@
 import com.azure.core.http.HttpMethod;
 import com.azure.core.http.HttpPipeline;
 import com.azure.core.http.HttpRequest;
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.http.HttpResponse;
 import com.azure.core.http.ProxyOptions;
 import org.junit.Test;
@@ -32,7 +33,7 @@ public void withNoOverwrite() throws MalformedURLException {
         pipeline.send(createHttpRequest("https://www.bing.com"));
     }
     private static HttpPipeline createPipeline(String protocol, String expectedUrl) {
-        return HttpPipeline.builder()
+        return new HttpPipelineBuilder()
             .httpClient(new MockHttpClient())
             .policies(new ProtocolPolicy(protocol, true),
                 (context, next) -> {
@@ -43,7 +44,7 @@ private static HttpPipeline createPipeline(String protocol, String expectedUrl)
     }
 
     private static HttpPipeline createPipeline(String protocol, boolean overwrite, String expectedUrl) {
-        return HttpPipeline.builder()
+        return new HttpPipelineBuilder()
             .httpClient(new MockHttpClient())
             .policies(new ProtocolPolicy(protocol, overwrite),
                 (context, next) -> {

diff --git a/...e/azure-core/src/test/java/com/azure/core/http/policy/ProxyAuthenticationPolicyTests.java b/...e/azure-core/src/test/java/com/azure/core/http/policy/ProxyAuthenticationPolicyTests.java
@@ -5,6 +5,7 @@
 
 import com.azure.core.http.HttpMethod;
 import com.azure.core.http.HttpPipeline;
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.http.HttpRequest;
 import com.azure.core.http.MockHttpClient;
 import org.junit.Test;
@@ -23,7 +24,7 @@ public void test() throws MalformedURLException {
         final String username = "testuser";
         final String password = "testpass";
         //
-        final HttpPipeline pipeline = HttpPipeline.builder()
+        final HttpPipeline pipeline = new HttpPipelineBuilder()
             .httpClient(new MockHttpClient())
             .policies(new ProxyAuthenticationPolicy(username, password),
                 (context, next) -> {

diff --git a/sdk/core/azure-core/src/test/java/com/azure/core/http/policy/RequestIdPolicyTests.java b/sdk/core/azure-core/src/test/java/com/azure/core/http/policy/RequestIdPolicyTests.java
@@ -7,6 +7,7 @@
 import com.azure.core.http.HttpMethod;
 import com.azure.core.http.HttpPipeline;
 import com.azure.core.http.HttpRequest;
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.http.HttpResponse;
 import com.azure.core.http.MockHttpClient;
 import io.netty.buffer.ByteBuf;
@@ -62,7 +63,7 @@ public Mono<String> bodyAsString(Charset charset) {
 
     @Test
     public void newRequestIdForEachCall() throws Exception {
-        HttpPipeline pipeline = HttpPipeline.builder()
+        HttpPipeline pipeline = new HttpPipelineBuilder()
             .httpClient(new MockHttpClient() {
                 String firstRequestId = null;
                 @Override
@@ -89,7 +90,7 @@ public Mono<HttpResponse> send(HttpRequest request) {
 
     @Test
     public void sameRequestIdForRetry() throws Exception {
-        final HttpPipeline pipeline = HttpPipeline.builder()
+        final HttpPipeline pipeline = new HttpPipelineBuilder()
             .httpClient(new MockHttpClient() {
                 String firstRequestId = null;
 

diff --git a/sdk/core/azure-core/src/test/java/com/azure/core/http/policy/RetryPolicyTests.java b/sdk/core/azure-core/src/test/java/com/azure/core/http/policy/RetryPolicyTests.java
@@ -6,6 +6,7 @@
 import com.azure.core.http.HttpMethod;
 import com.azure.core.http.HttpPipeline;
 import com.azure.core.http.HttpRequest;
+import com.azure.core.http.HttpPipelineBuilder;
 import com.azure.core.http.HttpResponse;
 import com.azure.core.http.MockHttpClient;
 import com.azure.core.http.MockHttpResponse;
@@ -20,7 +21,7 @@
 public class RetryPolicyTests {
     @Test
     public void exponentialRetryEndOn501() throws Exception {
-        final HttpPipeline pipeline = HttpPipeline.builder()
+        final HttpPipeline pipeline = new HttpPipelineBuilder()
             .httpClient(new MockHttpClient() {
                 // Send 408, 500, 502, all retried, with a 501 ending
                 private final int[] codes = new int[]{408, 500, 502, 501};
@@ -43,7 +44,7 @@ public Mono<HttpResponse> send(HttpRequest request) {
     @Test
     public void exponentialRetryMax() throws Exception {
         final int maxRetries = 5;
-        final HttpPipeline pipeline = HttpPipeline.builder()
+        final HttpPipeline pipeline = new HttpPipelineBuilder()
             .httpClient(new MockHttpClient() {
                 int count = -1;
 

diff --git a/sdk/core/azure-core/src/test/java/com/azure/core/implementation/RestProxyStressTests.java b/sdk/core/azure-core/src/test/java/com/azure/core/implementation/RestProxyStressTests.java
@@ -14,7 +14,7 @@
 import com.azure.core.implementation.annotation.PathParam;
 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.HttpPipelineCallContext;
 import com.azure.core.http.HttpPipelineNextPolicy;
 import com.azure.core.http.HttpResponse;
@@ -108,7 +108,7 @@ public static void beforeClass() throws IOException {
         polices.add(new HttpLoggingPolicy(HttpLogDetailLevel.BASIC, false));
         //
         service = RestProxy.create(IOService.class,
-            HttpPipeline.builder()
+            new HttpPipelineBuilder()
                 .policies(polices.toArray(new HttpPipelinePolicy[0]))
                 .build());
 
@@ -506,7 +506,7 @@ public void testHighParallelism() {
         }
 
         final IOService innerService = RestProxy.create(IOService.class,
-            HttpPipeline.builder()
+            new HttpPipelineBuilder()
                 .policies(policies.toArray(new HttpPipelinePolicy[0]))
                 .build());