T get(String name, T defaultValue) {
- return null;
+ return defaultValue;
}
@Override
diff --git a/core/azure-core/src/main/java/com/azure/core/util/logging/ClientLogger.java b/core/azure-core/src/main/java/com/azure/core/util/logging/ClientLogger.java
index bf02a1cedeb49..c05516502f638 100644
--- a/core/azure-core/src/main/java/com/azure/core/util/logging/ClientLogger.java
+++ b/core/azure-core/src/main/java/com/azure/core/util/logging/ClientLogger.java
@@ -14,8 +14,8 @@
/**
* This is a fluent logger helper class that wraps a plug-able {@link Logger}.
*
- * This logger logs format-able messages that use {@code {}} as the placeholder. When a throwable is the last
- * argument of the format varargs and the logger is enabled for {@link ClientLogger#asVerbose() verbose} logging the
+ *
This logger logs formattable messages that use {@code {}} as the placeholder. When a throwable is the last
+ * argument of the format varargs and the logger is enabled for {@link ClientLogger#verbose(String, Object...) verbose} logging the
* stack trace for the throwable will be included in the log message.
*
* A minimum logging level threshold is determined by the {@link BaseConfigurations#AZURE_LOG_LEVEL AZURE_LOG_LEVEL}
@@ -23,10 +23,10 @@
*
*
Log level hierarchy
*
- * - {@link ClientLogger#asError() Error}
- * - {@link ClientLogger#asWarning() Warning}
- * - {@link ClientLogger#asInfo() Info}
- * - {@link ClientLogger#asVerbose() Verbose}
+ * - {@link ClientLogger#error(String, Object...) Error}
+ * - {@link ClientLogger#warning(String, Object...) Warning}
+ * - {@link ClientLogger#info(String, Object...) Info}
+ * - {@link ClientLogger#verbose(String, Object...) Verbose}
*
*
* @see Configuration
@@ -34,11 +34,6 @@
public class ClientLogger {
private final Logger logger;
- /*
- * Indicate that log level is at trace level.
- */
- private static final int TRACE_LEVEL = 0;
-
/*
* Indicate that log level is at verbose level.
*/
@@ -64,17 +59,12 @@ public class ClientLogger {
*/
private static final int DISABLED_LEVEL = 5;
- private static final int DEFAULT_LOG_LEVEL = DISABLED_LEVEL;
- private int level = DEFAULT_LOG_LEVEL;
-
- private int configurationLevel;
-
/**
* Retrieves a logger for the passed class using the {@link LoggerFactory}.
*
* @param clazz Class creating the logger.
*/
- public ClientLogger(Class clazz) {
+ public ClientLogger(Class clazz) {
this(clazz.getName());
}
@@ -88,89 +78,108 @@ public ClientLogger(String className) {
}
/**
- * Sets the logger to the verbose logging level.
+ * Logs a formattable message that uses {@code {}} as the placeholder at {@code verbose} log level
*
- * @return Updated ClientLogger if verbose is enabled.
- */
- public ClientLogger asVerbose() {
- return asLevel(VERBOSE_LEVEL);
- }
-
- /**
- * Sets the logger to the info logging level.
+ * Code Samples
+ *
+ * Logging a message at verbose log level
+ * {@codesnippet com.azure.core.implementation.util.clientlogger.verbose}
*
- * @return Updated ClientLogger if info is enabled.
+ * @param format The formattable message to log
+ * @param args Arguments for the message, if an exception is being logged last argument is the throwable.
*/
- public ClientLogger asInfo() {
- return asLevel(INFORMATIONAL_LEVEL);
+ public void verbose(String format, Object... args) {
+ log(VERBOSE_LEVEL, format, args);
}
/**
- * Sets the logger to the warning logging level.
+ * Logs a formattable message that uses {@code {}} as the placeholder at {@code informational} log level
*
- * @return Updated ClientLogger if warn is enabled.
+ *
Code Samples
+ *
+ * Logging a message at informational log level
+ * {@codesnippet com.azure.core.implementation.util.clientlogger.info}
+ *
+ * @param format The formattable message to log
+ * @param args Arguments for the message, if an exception is being logged last argument is the throwable.
*/
- public ClientLogger asWarning() {
- return asLevel(WARNING_LEVEL);
+ public void info(String format, Object... args) {
+ log(INFORMATIONAL_LEVEL, format, args);
}
/**
- * Sets the logger to the error logging level.
+ * Logs a formattable message that uses {@code {}} as the placeholder at {@code warning} log level
+ *
+ *
Code Samples
+ *
+ * Logging a message at warning log level
+ * {@codesnippet com.azure.core.implementation.util.clientlogger.warning}
*
- * @return Updated ClientLogger if error is enabled..
+ * @param format The formattable message to log
+ * @param args Arguments for the message, if an exception is being logged last argument is the throwable.
*/
- public ClientLogger asError() {
- return asLevel(ERROR_LEVEL);
+ public void warning(String format, Object... args) {
+ log(WARNING_LEVEL, format, args);
}
/**
- * Logs a format-able message that uses {@code {}} as the placeholder.
+ * Logs a formattable message that uses {@code {}} as the placeholder at {@code error} log level
*
*
Code Samples
*
- * Logging a message with the default log level
- *
- * ClientLogger logger = new ClientLogger(Example.class);
- * logger.log("A message");
- *
- *
- * Logging a format-able warning
- *
- * ClientLogger logger = new ClientLogger(Example.class);
- * logger.asWarning().log("A format-able message. Hello, {}", name);
- *
- *
* Logging an error with stack trace
- *
- * ClientLogger logger = new ClientLogger(Example.class);
- * try {
- * upload(resource);
- * } catch (Throwable ex) {
- * logger.asError().log("Failed to upload {}", resource.name(), ex);
- * }
- *
+ * {@codesnippet com.azure.core.implementation.util.clientlogger.error}
*
- * @param format Format-able message.
- * @param args Arguments for the message, if an exception is being logged last argument is the throwable.
+ * @param format The formattable message to log
+ * @param args Arguments for the message, if an exception is being logged last argument is the throwable.
*/
- public void log(String format, Object... args) {
- if (canLogAtLevel(level)) {
- performLogging(format, args);
+ public void error(String format, Object... args) {
+ log(ERROR_LEVEL, format, args);
+ }
+
+ /*
+ * This method logs the formattable message if the {@code logLevel} is enabled
+ *
+ * @param logLevel The log level at which this message should be logged
+ * @param format The formattable message to log
+ * @param args Arguments for the message, if an exception is being logged last argument is the throwable.
+ */
+ private void log(int logLevel, String format, Object... args) {
+ if (canLogAtLevel(logLevel)) {
+ performLogging(logLevel, format, args);
+ }
+ }
+
+ /**
+ * This will log {@link RuntimeException}, if logging is enabled , and throw the runtime exception.
+ * @param runtimeException to be thrown. It will do nothing if {@code null} is provided.
+ * @throws RuntimeException which is requested by this call.
+ */
+ public void logAndThrow(RuntimeException runtimeException) {
+ if (runtimeException == null) {
+ return;
+ }
+
+ // it will only log if error level is enabled in configuration
+ if (canLogAtLevel(ERROR_LEVEL)) {
+ logger.error(runtimeException.getMessage(), runtimeException);
}
+ throw runtimeException;
}
/*
* Performs the logging.
- * @param format Format-able message.
+ *
+ * @param format formattable message.
* @param args Arguments for the message, if an exception is being logged last argument is the throwable.
*/
- private void performLogging(String format, Object... args) {
+ private void performLogging(int logLevel, String format, Object... args) {
// If the logging level is less granular than verbose remove the potential throwable from the args.
- if (configurationLevel > VERBOSE_LEVEL) {
+ if (logLevel > VERBOSE_LEVEL) {
args = attemptToRemoveThrowable(args);
}
- switch (level) {
+ switch (logLevel) {
case VERBOSE_LEVEL:
logger.debug(format, args);
break;
@@ -189,19 +198,6 @@ private void performLogging(String format, Object... args) {
}
}
- /*
- * Helper method to set the logging level.
- * @param level Logging level
- * @return Updated ClientLogger if the level is enabled.
- */
- private ClientLogger asLevel(int level) {
- if (canLogAtLevel(level)) {
- this.level = level;
- }
-
- return this;
- }
-
/*
* Helper method that determines if logging is enabled at a given level.
* @param level Logging level
@@ -209,7 +205,7 @@ private ClientLogger asLevel(int level) {
*/
private boolean canLogAtLevel(int level) {
// Check the configuration level every time the logger is called in case it has changed.
- configurationLevel = ConfigurationManager.getConfiguration().get(BaseConfigurations.AZURE_LOG_LEVEL, DISABLED_LEVEL);
+ int configurationLevel = ConfigurationManager.getConfiguration().get(BaseConfigurations.AZURE_LOG_LEVEL, DISABLED_LEVEL);
if (level < configurationLevel) {
return false;
}
@@ -230,6 +226,7 @@ private boolean canLogAtLevel(int level) {
/*
* Removes the last element from the arguments if it is a throwable.
+ *
* @param args Arguments
* @return The arguments with the last element removed if it was a throwable, otherwise the unmodified arguments.
*/
@@ -242,7 +239,6 @@ private Object[] attemptToRemoveThrowable(Object... args) {
if (potentialThrowable instanceof Throwable) {
return Arrays.copyOf(args, args.length - 1);
}
-
return args;
}
}
diff --git a/core/azure-core/src/main/java/com/azure/core/util/polling/Poller.java b/core/azure-core/src/main/java/com/azure/core/util/polling/Poller.java
index 3c9da3c408202..4093c2e307b27 100644
--- a/core/azure-core/src/main/java/com/azure/core/util/polling/Poller.java
+++ b/core/azure-core/src/main/java/com/azure/core/util/polling/Poller.java
@@ -3,6 +3,7 @@
package com.azure.core.util.polling;
+import com.azure.core.util.logging.ClientLogger;
import reactor.core.Disposable;
import reactor.core.publisher.Flux;
@@ -58,6 +59,7 @@
*/
public class Poller {
+ private final ClientLogger logger = new ClientLogger(Poller.class);
/*
* poll operation is a function that takes the previous PollResponse, and
* returns a new Mono of PollResponse to represent the current state
@@ -77,7 +79,7 @@ public class Poller {
/*
* This will be called when cancel operation is triggered.
*/
- private Consumer cancelOperation;
+ private Consumer> cancelOperation;
/*
* Indicate to poll automatically or not when poller is created.
@@ -117,10 +119,10 @@ public class Poller {
*/
public Poller(Duration pollInterval, Function, Mono>> pollOperation) {
if (pollInterval == null || pollInterval.toNanos() <= 0) {
- throw new IllegalArgumentException("Null, negative or zero value for poll interval is not allowed.");
+ logger.logAndThrow(new IllegalArgumentException("Null, negative or zero value for poll interval is not allowed."));
}
if (pollOperation == null) {
- throw new IllegalArgumentException("Null value for poll operation is not allowed.");
+ logger.logAndThrow(new IllegalArgumentException("Null value for poll operation is not allowed."));
}
this.pollInterval = pollInterval;
@@ -153,7 +155,7 @@ public Poller(Duration pollInterval, Function, Mono, Mono>> pollOperation, Consumer cancelOperation) {
+ public Poller(Duration pollInterval, Function, Mono>> pollOperation, Consumer> cancelOperation) {
this(pollInterval, pollOperation);
this.cancelOperation = cancelOperation;
}
@@ -245,10 +247,10 @@ public PollResponse blockUntil(OperationStatus statusToBlockFor) {
*/
public PollResponse blockUntil(OperationStatus statusToBlockFor, Duration timeout) {
if (statusToBlockFor == null) {
- throw new IllegalArgumentException("Null value for status is not allowed.");
+ logger.logAndThrow(new IllegalArgumentException("Null value for status is not allowed."));
}
if (timeout != null && timeout.toNanos() <= 0) {
- throw new IllegalArgumentException("Negative or zero value for timeout is not allowed.");
+ logger.logAndThrow(new IllegalArgumentException("Negative or zero value for timeout is not allowed."));
}
if (!isAutoPollingEnabled()) {
setAutoPollingEnabled(true);
diff --git a/core/azure-core/src/samples/java/com/azure/core/implementation/util/ClientLoggerJavaDocCodeSnippets.java b/core/azure-core/src/samples/java/com/azure/core/implementation/util/ClientLoggerJavaDocCodeSnippets.java
new file mode 100644
index 0000000000000..c042947396688
--- /dev/null
+++ b/core/azure-core/src/samples/java/com/azure/core/implementation/util/ClientLoggerJavaDocCodeSnippets.java
@@ -0,0 +1,69 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.core.implementation.util;
+
+import com.azure.core.util.logging.ClientLogger;
+import java.io.File;
+import java.io.IOException;
+
+/**
+ * Code snippets for {@link ClientLogger} javadocs
+ */
+public class ClientLoggerJavaDocCodeSnippets {
+
+ /**
+ * Code snippets to show usage of {@link ClientLogger} at all log levels
+ */
+ public void loggingSnippets() {
+
+ ClientLogger logger = new ClientLogger(ClientLoggerJavaDocCodeSnippets.class);
+ String name = getName();
+
+ // BEGIN: com.azure.core.implementation.util.clientlogger.verbose
+ logger.verbose("A formattable message. Hello, {}", name);
+ // END: com.azure.core.implementation.util.clientlogger.verbose
+
+ // BEGIN: com.azure.core.implementation.util.clientlogger.info
+ logger.info("A formattable message. Hello, {}", name);
+ // END: com.azure.core.implementation.util.clientlogger.info
+
+ // BEGIN: com.azure.core.implementation.util.clientlogger.warning
+ logger.warning("A formattable message. Hello, {}", name);
+ // END: com.azure.core.implementation.util.clientlogger.warning
+
+ File resource = getFile();
+ // BEGIN: com.azure.core.implementation.util.clientlogger.error
+ try {
+ upload(resource);
+ } catch (IOException ex) {
+ logger.error("A formattable message. Hello, {}", name, ex);
+ }
+ // END: com.azure.core.implementation.util.clientlogger.error
+ }
+
+ /**
+ * Implementation not provided
+ * @return {@code null}
+ */
+ private File getFile() {
+ return null;
+ }
+
+ /**
+ * Implementation not provided
+ * @return {@code null}
+ */
+ private String getName() {
+ return null;
+ }
+
+ /**
+ * Implementation not provided
+ * @param resource A file resource
+ * @throws IOException if upload fails
+ */
+ private void upload(File resource) throws IOException {
+ throw new IOException();
+ }
+}
diff --git a/core/azure-core/src/test/java/com/azure/core/implementation/RestProxyTests.java b/core/azure-core/src/test/java/com/azure/core/implementation/RestProxyTests.java
index b4ab70e4984b3..2afd1cdd5768a 100644
--- a/core/azure-core/src/test/java/com/azure/core/implementation/RestProxyTests.java
+++ b/core/azure-core/src/test/java/com/azure/core/implementation/RestProxyTests.java
@@ -510,6 +510,7 @@ public void syncPutRequestWithUnexpectedResponse() {
assertNotNull(e.value());
assertTrue(e.value() instanceof LinkedHashMap);
+ @SuppressWarnings("unchecked")
final LinkedHashMap expectedBody = (LinkedHashMap) e.value();
assertEquals("I'm the body!", expectedBody.get("data"));
}
@@ -526,6 +527,7 @@ public void asyncPutRequestWithUnexpectedResponse() {
assertNotNull(e.value());
assertTrue(e.value() instanceof LinkedHashMap);
+ @SuppressWarnings("unchecked")
final LinkedHashMap expectedBody = (LinkedHashMap) e.value();
assertEquals("I'm the body!", expectedBody.get("data"));
}
@@ -628,6 +630,7 @@ public void syncPutRequestWithUnexpectedResponseAndNoFallthroughExceptionType()
assertNotNull(e.value());
assertTrue(e.value() instanceof LinkedHashMap);
+ @SuppressWarnings("unchecked")
final LinkedHashMap expectedBody = (LinkedHashMap) e.value();
assertEquals("I'm the body!", expectedBody.get("data"));
} catch (Throwable e) {
@@ -646,6 +649,7 @@ public void asyncPutRequestWithUnexpectedResponseAndNoFallthroughExceptionType()
assertNotNull(e.value());
assertTrue(e.value() instanceof LinkedHashMap);
+ @SuppressWarnings("unchecked")
final LinkedHashMap expectedBody = (LinkedHashMap) e.value();
assertEquals("I'm the body!", expectedBody.get("data"));
} catch (Throwable e) {
diff --git a/core/azure-core/src/test/java/com/azure/core/util/polling/PollerTests.java b/core/azure-core/src/test/java/com/azure/core/util/polling/PollerTests.java
index 8d2b4f65b49c4..c03e1b19ef51d 100644
--- a/core/azure-core/src/test/java/com/azure/core/util/polling/PollerTests.java
+++ b/core/azure-core/src/test/java/com/azure/core/util/polling/PollerTests.java
@@ -234,7 +234,7 @@ public void disableAutoPollAndEnableAfterCompletionSuccessfullyDone() throws Exc
Poller createCertPoller = new Poller<>(pollInterval, pollOperation);
- new Thread().sleep(6 * pollInterval.toMillis());
+ Thread.sleep(6 * pollInterval.toMillis());
debug("Try to disable autopolling..");
createCertPoller.setAutoPollingEnabled(false);
@@ -271,7 +271,7 @@ public void autoStartPollingAndSuccessfullyComplete() throws Exception {
Poller createCertPoller = new Poller<>(pollInterval, pollOperation);
while (createCertPoller.getStatus() != OperationStatus.SUCCESSFULLY_COMPLETED) {
- new Thread().sleep(pollInterval.toMillis());
+ Thread.sleep(pollInterval.toMillis());
}
Assert.assertTrue(createCertPoller.getStatus() == OperationStatus.SUCCESSFULLY_COMPLETED);
diff --git a/core/pom.xml b/core/pom.xml
index 4f6a7ce87ce25..8a99642ce90cc 100644
--- a/core/pom.xml
+++ b/core/pom.xml
@@ -2,19 +2,20 @@
~ Copyright (c) Microsoft Corporation. All rights reserved.
~ Licensed under the MIT License.
-->
-
+
4.0.0
com.azure
azure-client-sdk-parent
- 1.0.0
+ 1.1.0
../pom.client.xml
com.azure
azure-core-parent
- 1.0.0-preview.1
+ 1.0.0-preview.3
pom
Microsoft Azure Core Libraries for Java
@@ -33,12 +34,12 @@
scm:git:https://github.com/Azure/azure-sdk-for-java
scm:git:https://github.com/Azure/azure-sdk-for-java.git
scm:git:https://github.com/Azure/azure-sdk-for-java.git
- v1.0.0-preview.1
UTF-8
-
+
+
diff --git a/eng/.docsettings.yml b/eng/.docsettings.yml
index ba75290e7d9fb..d1b091127da59 100644
--- a/eng/.docsettings.yml
+++ b/eng/.docsettings.yml
@@ -3,6 +3,7 @@ omitted_paths:
- profiles/*
- loganalytics/data-plane/samples/*
- sdk/applicationinsights/microsoft-azure-applicationinsights-query/samples/*
+ - sdk/loganalytics/microsoft-azure-loganalytics/samples/*
- "*/resource-manager/*"
- eng/*
language: java
@@ -34,18 +35,19 @@ known_presence_issues:
- ['cognitiveservices/data-plane/vision/customvision/prediction', '#2847']
- ['cognitiveservices/data-plane/vision/customvision/training', '#2847']
- ['cognitiveservices/data-plane/vision/faceapi', '#2847']
- - ['keyvault/data-plane/azure-keyvault', '#2847']
- - ['keyvault/data-plane/azure-keyvault-core', '#2847']
- - ['keyvault/data-plane/azure-keyvault-cryptography', '#2847']
- - ['keyvault/data-plane/azure-keyvault-extensions', '#2847']
- - ['keyvault/data-plane/azure-keyvault-webkey', '#2847']
- - ['mediaservices/data-plane', '#2847']
+ - ['sdk/keyvault/microsoft-azure-keyvault', '#2847']
+ - ['sdk/keyvault/microsoft-azure-keyvault-core', '#2847']
+ - ['sdk/keyvault/microsoft-azure-keyvault-cryptography', '#2847']
+ - ['sdk/keyvault/microsoft-azure-keyvault-extensions', '#2847']
+ - ['sdk/keyvault/microsoft-azure-keyvault-webkey', '#2847']
+ - ['sdk/mediaservices/microsoft-azure-media', '#2847']
- ['core/build-tools', '#2847']
- ['core/azure-core', '#2847']
- ['core/azure-core-auth', '#2847']
- ['core/azure-core-management', '#2847']
- ['cosmosdb/data-plane/commons-test-utils', '#2847']
- ['cosmosdb/data-plane/sdk', '#2847']
+ - ['sdk/cosmos/sdk', '#2847']
- ['cosmosdb/data-plane/gateway', '#2847']
- ['cosmosdb/data-plane/commons', '#2847']
- ['cosmosdb/data-plane/direct-impl', '#2847']
@@ -53,13 +55,13 @@ known_content_issues:
- ['sdk/template/azure-sdk-template/README.md','has other required sections']
- ['README.md', '#3113']
- ['sdk/applicationinsights/microsoft-azure-applicationinsights-query/README.md', '#3113']
- - ['authorization/msi-auth-token-provider-jar/readme.md', '#3113']
- ['sdk/batch/microsoft-azure-batch/README.md', '#3113']
- ['eventgrid/data-plane/README.md', '#3113']
- ['eventhubs/data-plane/readme.md', '#3113']
- ['eventhubs/data-plane/azure-eventhubs-eph/Readme.md', '#3113']
- - ['keyvault/data-plane/README.md', '#3113']
- - ['loganalytics/data-plane/README.md', '#3113']
+ - ['sdk/authorization/microsoft-azure-authentication-msi-token-provider/readme.md', '#3113']
+ - ['sdk/keyvault/README.md', '#3113']
+ - ['sdk/loganalytics/microsoft-azure-loganalytics/README.md', '#3113']
- ['sdk/servicebus/README.md', '#3113']
- ['storage/data-plane/README.md', '#3113']
- ['storage/data-plane/swagger/README.md', '#3113']
@@ -68,6 +70,10 @@ known_content_issues:
- ['cosmosdb/data-plane/benchmark/README.md', '#3113']
- ['cosmosdb/data-plane/changelog/README.md', '#3113']
- ['cosmosdb/data-plane/faq/README.md', '#3113']
+ - ['sdk/cosmos/faq/README.md', '#3113']
+ - ['sdk/cosmos/changelog/README.md', '#3113']
+ - ['sdk/cosmos/benchmark/README.md', '#3113']
+ - ['sdk/cosmos/README.md', '#3113']
package_indexing_exclusion_list:
- azure-loganalytics-sample
- azure-applicationinsights-query-sample
diff --git a/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ExternalDependencyExposedCheck.java b/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ExternalDependencyExposedCheck.java
new file mode 100644
index 0000000000000..6c4a730d5a99c
--- /dev/null
+++ b/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ExternalDependencyExposedCheck.java
@@ -0,0 +1,220 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.tools.checkstyle.checks;
+
+import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
+import com.puppycrawl.tools.checkstyle.api.DetailAST;
+import com.puppycrawl.tools.checkstyle.api.FullIdent;
+import com.puppycrawl.tools.checkstyle.api.TokenTypes;
+import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifier;
+import com.puppycrawl.tools.checkstyle.utils.CheckUtil;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * No external dependency exposed in public API
+ */
+public class ExternalDependencyExposedCheck extends AbstractCheck {
+ private static final String EXTERNAL_DEPENDENCY_ERROR =
+ "Class ''%s'', is a class from external dependency. You should not use it as a return or method argument type.";
+
+ private static final Set VALID_DEPENDENCY_SET = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
+ "java", "com.azure", "reactor", "io.netty.buffer.ByteBuf"
+ )));
+
+ private final Map simpleClassNameToQualifiedNameMap = new HashMap<>();
+ private static boolean isImplPackage;
+
+ @Override
+ public void beginTree(DetailAST rootAST) {
+ simpleClassNameToQualifiedNameMap.clear();
+ isImplPackage = false;
+ }
+
+ @Override
+ public int[] getDefaultTokens() {
+ return getRequiredTokens();
+ }
+
+ @Override
+ public int[] getAcceptableTokens() {
+ return getRequiredTokens();
+ }
+
+ @Override
+ public int[] getRequiredTokens() {
+ return new int[] {
+ TokenTypes.PACKAGE_DEF,
+ TokenTypes.IMPORT,
+ TokenTypes.METHOD_DEF
+ };
+ }
+
+ @Override
+ public void visitToken(DetailAST token) {
+ if (isImplPackage) {
+ return;
+ }
+
+ switch (token.getType()) {
+ case TokenTypes.PACKAGE_DEF:
+ String packageName = FullIdent.createFullIdent(token.findFirstToken(TokenTypes.DOT)).getText();
+ isImplPackage = packageName.contains(".implementation");
+ break;
+ case TokenTypes.IMPORT:
+ // Add all imported classes into a map, key is the name of class and value is the full package path of class.
+ final String importClassPath = FullIdent.createFullIdentBelow(token).getText();
+ final String className = importClassPath.substring(importClassPath.lastIndexOf(".") + 1);
+ simpleClassNameToQualifiedNameMap.put(className, importClassPath);
+ break;
+ case TokenTypes.METHOD_DEF:
+ checkNoExternalDependencyExposed(token);
+ break;
+ default:
+ // Checkstyle complains if there's no default block in switch
+ break;
+ }
+ }
+
+ /**
+ * Checks for external dependency, log the error if it is an invalid external dependency.
+ *
+ * @param methodDefToken METHOD_DEF AST node
+ */
+ private void checkNoExternalDependencyExposed(DetailAST methodDefToken) {
+ final DetailAST modifiersToken = methodDefToken.findFirstToken(TokenTypes.MODIFIERS);
+
+ // Getting the modifier of the method to determine if it is 'public' or 'protected'.
+ // Ignore the check if it is neither of 'public' nor 'protected',
+ final AccessModifier accessModifier = CheckUtil.getAccessModifierFromModifiersToken(modifiersToken);
+ if (!accessModifier.equals(AccessModifier.PUBLIC) && !accessModifier.equals(AccessModifier.PROTECTED)) {
+ return;
+ }
+
+ // Checks for the return type of method
+ final DetailAST typeToken = methodDefToken.findFirstToken(TokenTypes.TYPE);
+ if (typeToken != null) {
+ getInvalidReturnTypes(typeToken).forEach(
+ (token, returnTypeName) -> log(token, String.format(EXTERNAL_DEPENDENCY_ERROR, returnTypeName)));
+ }
+
+ // Checks for the parameters of the method
+ final DetailAST parametersToken = methodDefToken.findFirstToken(TokenTypes.PARAMETERS);
+ if (parametersToken != null) {
+ getInvalidParameterTypes(parametersToken).forEach(
+ (token, returnTypeName) -> log(token, String.format(EXTERNAL_DEPENDENCY_ERROR, returnTypeName)));
+ }
+ }
+
+ /**
+ * Get invalid return types from a given TYPE node.
+ *
+ * @param typeToken TYPE AST node
+ * @return a map that maps the invalid TYPE node and the type name.
+ */
+ private Map getInvalidReturnTypes(DetailAST typeToken) {
+ final Map invalidReturnTypeMap = new HashMap<>();
+
+ // Add all invalid external return types to the map
+ final DetailAST identToken = typeToken.findFirstToken(TokenTypes.IDENT);
+ if (identToken == null) {
+ return invalidReturnTypeMap;
+ }
+ final String typeName = identToken.getText();
+ if (!isValidClassDependency(typeName)) {
+ invalidReturnTypeMap.put(typeToken, typeName);
+ }
+
+ // TYPE_ARGUMENTS, add all invalid external types to the map
+ final DetailAST typeArgumentsToken = typeToken.findFirstToken(TokenTypes.TYPE_ARGUMENTS);
+ if (typeArgumentsToken != null) {
+ invalidReturnTypeMap.putAll(getInvalidTypeFromTypeArguments(typeArgumentsToken));
+ }
+
+ return invalidReturnTypeMap;
+ }
+
+ /**
+ * Get invalid parameter types from a given PARAMETERS node.
+ *
+ * @param parametersTypeToken PARAMETERS AST node
+ * @return a map that maps all the invalid TYPE_ARGUMENT node and the type name
+ */
+ private Map getInvalidParameterTypes(DetailAST parametersTypeToken) {
+ final Map invalidParameterTypesMap = new HashMap<>();
+ for (DetailAST ast = parametersTypeToken.getFirstChild(); ast != null; ast = ast.getNextSibling()) {
+ if (ast.getType() == TokenTypes.PARAMETER_DEF) {
+ invalidParameterTypesMap.putAll(getInvalidTypeFromTypeArguments(ast.findFirstToken(TokenTypes.TYPE)));
+ }
+ }
+ return invalidParameterTypesMap;
+ }
+
+ /**
+ * A helper function that checks TYPE AST node. Since both return type and input parameter argument type has
+ * TYPE AST node under. This function applied to both.
+ *
+ * @param typeArgumentsToken TYPE_ARGUMENTS AST node
+ * @return a map that maps all the invalid TYPE_ARGUMENT node and the type name
+ */
+ private Map getInvalidTypeFromTypeArguments(DetailAST typeArgumentsToken) {
+ final Map invalidTypesMap = new HashMap<>();
+ if (typeArgumentsToken == null) {
+ return invalidTypesMap;
+ }
+ // Checks multiple type arguments
+ for (DetailAST ast = typeArgumentsToken.getFirstChild(); ast != null; ast = ast.getNextSibling()) {
+ if (ast.getType() != TokenTypes.TYPE_ARGUMENT) {
+ continue;
+ }
+
+ final String invalidTypeName = getInvalidTypeNameFromTypeArgument(ast);
+ if (invalidTypeName != null) {
+ invalidTypesMap.put(ast, invalidTypeName);
+ }
+ }
+ return invalidTypesMap;
+ }
+
+ /**
+ * Get invalid type name from TYPE_ARGUMENT
+ *
+ * @param typeArgumentToken TYPE_ARGUMENT AST node
+ * @return an invalid type name if it is an invalid library. Otherwise, returns null.
+ */
+ private String getInvalidTypeNameFromTypeArgument(DetailAST typeArgumentToken) {
+ final DetailAST identToken = typeArgumentToken.findFirstToken(TokenTypes.IDENT);
+ // if there is no IDENT token, implies the token is default java types.
+ if (identToken == null) {
+ return null;
+ }
+
+ final String typeName = identToken.getText();
+ // if not exist in the classPathMap, that implies the type is java default types, such as int.
+ return isValidClassDependency(typeName) ? null : typeName;
+ }
+
+ /**
+ * A helper function that checks for whether a class is from a valid internal dependency or is a suppression class
+ *
+ * @param typeName the type name of class
+ * @return true if the class is a suppression class, otherwise, return false.
+ */
+ private boolean isValidClassDependency(String typeName) {
+ // If the qualified class name does not exist in the map,
+ // it implies the type is a primitive Java type (ie. int, long, etc).
+ if (!simpleClassNameToQualifiedNameMap.containsKey(typeName)) {
+ return true;
+ }
+
+ final String qualifiedName = simpleClassNameToQualifiedNameMap.get(typeName);
+ return VALID_DEPENDENCY_SET.stream()
+ .anyMatch(validPackageName -> qualifiedName.startsWith(validPackageName));
+ }
+}
diff --git a/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/NoImplInPublicAPI.java b/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/NoImplInPublicAPI.java
index 3b4250c5aa2dc..a21ed603ab72e 100644
--- a/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/NoImplInPublicAPI.java
+++ b/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/NoImplInPublicAPI.java
@@ -109,10 +109,5 @@ public void visitToken(DetailAST ast) {
// Checkstyle complains if there's no default block in switch
break;
}
-
}
-
-
}
-
-
diff --git a/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ServiceClientInstantiationCheck.java b/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ServiceClientInstantiationCheck.java
new file mode 100644
index 0000000000000..38adfaabbade6
--- /dev/null
+++ b/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ServiceClientInstantiationCheck.java
@@ -0,0 +1,231 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.tools.checkstyle.checks;
+
+import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
+import com.puppycrawl.tools.checkstyle.api.DetailAST;
+import com.puppycrawl.tools.checkstyle.api.FullIdent;
+import com.puppycrawl.tools.checkstyle.api.TokenTypes;
+import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifier;
+import com.puppycrawl.tools.checkstyle.utils.CheckUtil;
+
+/**
+ * Verify the classes with annotation @ServiceClient should have following rules:
+ *
+ * - No public or protected constructors
+ * - No public static method named 'builder'
+ * - Since these classes are supposed to be immutable, all fields in the service client classes should be final.
+ *
+ */
+public class ServiceClientInstantiationCheck extends AbstractCheck {
+ private static final String SERVICE_CLIENT = "ServiceClient";
+ private static final String BUILDER = "builder";
+ private static final String ASYNC_CLIENT ="AsyncClient";
+ private static final String CLIENT = "Client";
+ private static final String IS_ASYNC = "isAsync";
+
+ private static boolean hasServiceClientAnnotation;
+ private static boolean isAsync;
+ private static boolean isImplPackage;
+
+ @Override
+ public int[] getDefaultTokens() {
+ return getRequiredTokens();
+ }
+
+ @Override
+ public int[] getAcceptableTokens() {
+ return getRequiredTokens();
+ }
+
+ @Override
+ public int[] getRequiredTokens() {
+ return new int[] {
+ TokenTypes.PACKAGE_DEF,
+ TokenTypes.CLASS_DEF,
+ TokenTypes.CTOR_DEF,
+ TokenTypes.METHOD_DEF,
+ TokenTypes.OBJBLOCK
+ };
+ }
+
+ @Override
+ public void beginTree(DetailAST root) {
+ hasServiceClientAnnotation = false;
+ isAsync = false;
+ isImplPackage = false;
+ }
+
+ @Override
+ public void visitToken(DetailAST token) {
+ if (isImplPackage) {
+ return;
+ }
+
+ switch (token.getType()) {
+ case TokenTypes.PACKAGE_DEF:
+ String packageName = FullIdent.createFullIdent(token.findFirstToken(TokenTypes.DOT)).getText();
+ isImplPackage = packageName.contains(".implementation");
+ break;
+ case TokenTypes.CLASS_DEF:
+ hasServiceClientAnnotation = hasServiceClientAnnotation(token);
+ if (hasServiceClientAnnotation) {
+ checkServiceClientNaming(token);
+ }
+ break;
+ case TokenTypes.CTOR_DEF:
+ if (hasServiceClientAnnotation) {
+ checkConstructor(token);
+ }
+ break;
+ case TokenTypes.METHOD_DEF:
+ if (hasServiceClientAnnotation) {
+ checkMethodName(token);
+ }
+ break;
+ case TokenTypes.OBJBLOCK:
+ if (hasServiceClientAnnotation) {
+ checkClassField(token);
+ }
+ break;
+ default:
+ // Checkstyle complains if there's no default block in switch
+ break;
+ }
+ }
+
+ /**
+ * Checks if the class is annotated with annotation @ServiceClient. A class could have multiple annotations.
+ *
+ * @param classDefToken the CLASS_DEF AST node
+ * @return true if the class is annotated with @ServiceClient, false otherwise.
+ */
+ private boolean hasServiceClientAnnotation(DetailAST classDefToken) {
+ // Always has MODIFIERS node
+ final DetailAST modifiersToken = classDefToken.findFirstToken(TokenTypes.MODIFIERS);
+
+ for (DetailAST ast = modifiersToken.getFirstChild(); ast != null; ast = ast.getNextSibling()) {
+ if (ast.getType() != TokenTypes.ANNOTATION) {
+ continue;
+ }
+ // One class could have multiple annotations, return true if found one.
+ final DetailAST annotationIdent = ast.findFirstToken(TokenTypes.IDENT);
+ if (annotationIdent != null && SERVICE_CLIENT.equals(annotationIdent.getText())) {
+ isAsync = isAsyncServiceClient(ast);
+ return true;
+ }
+ }
+ // If no @ServiceClient annotated with this class, return false
+ return false;
+ }
+
+ /**
+ * Checks for public or protected constructor for the service client class.
+ * Log error if the service client has public or protected constructor.
+ *
+ * @param ctorToken the CTOR_DEF AST node
+ */
+ private void checkConstructor(DetailAST ctorToken) {
+ final DetailAST modifiersToken = ctorToken.findFirstToken(TokenTypes.MODIFIERS);
+ // find constructor's modifier accessibility, no public or protected constructor
+ final AccessModifier accessModifier = CheckUtil.getAccessModifierFromModifiersToken(modifiersToken);
+ if (accessModifier.equals(AccessModifier.PUBLIC) || accessModifier.equals(AccessModifier.PROTECTED)) {
+ log(modifiersToken, "@ServiceClient class should not have any public or protected constructor.");
+ }
+ }
+
+ /**
+ * Checks for public static method named 'builder'. Should avoid to use method name, 'builder'.
+ *
+ * @param methodDefToken the METHOD_DEF AST node
+ */
+ private void checkMethodName(DetailAST methodDefToken) {
+ final DetailAST methodNameToken = methodDefToken.findFirstToken(TokenTypes.IDENT);
+ if (!BUILDER.equals(methodNameToken.getText())) {
+ return;
+ }
+
+ final DetailAST modifiersToken = methodDefToken.findFirstToken(TokenTypes.MODIFIERS);
+ // find method's modifier accessibility, should not have a public static method called 'builder'
+ final AccessModifier accessModifier = CheckUtil.getAccessModifierFromModifiersToken(modifiersToken);
+ if (accessModifier.equals(AccessModifier.PUBLIC) && modifiersToken.branchContains(TokenTypes.LITERAL_STATIC)) {
+ log(modifiersToken, "@ServiceClient class should not have a public static method named ''builder''.");
+ }
+ }
+
+ /**
+ * Checks that the field variables in the @ServiceClient are final. ServiceClients should be immutable.
+ *
+ * @param objBlockToken the OBJBLOCK AST node
+ */
+ private void checkClassField(DetailAST objBlockToken) {
+ for (DetailAST ast = objBlockToken.getFirstChild(); ast != null; ast = ast.getNextSibling()) {
+ if (TokenTypes.VARIABLE_DEF != ast.getType()) {
+ continue;
+ }
+ final DetailAST modifiersToken = ast.findFirstToken(TokenTypes.MODIFIERS);
+ // VARIABLE_DEF token will always MODIFIERS token. If there is no modifier at the variable, no child under
+ // MODIFIERS token. Also the previous sibling of OBJBLOCK will always be class name IDENT node.
+ if (!modifiersToken.branchContains(TokenTypes.FINAL)) {
+ log(modifiersToken, String.format("The variable field ''%s'' of class ''%s'' should be final. Classes annotated with @ServiceClient are supposed to be immutable.",
+ ast.findFirstToken(TokenTypes.IDENT).getText(), objBlockToken.getPreviousSibling().getText()));
+ }
+ }
+ }
+
+ /**
+ * Checks for the class name of Service Client. It should be named AsyncClient or Client.
+ *
+ * @param classDefToken the CLASS_DEF AST node
+ */
+ private void checkServiceClientNaming(DetailAST classDefToken) {
+ final String className = classDefToken.findFirstToken(TokenTypes.IDENT).getText();
+ // Async service client
+ if (isAsync && !className.endsWith(ASYNC_CLIENT)) {
+ log(classDefToken, String.format("Async class ''%s'' must be named AsyncClient ", className));
+ }
+ // Sync service client
+ if (!isAsync && !className.endsWith(CLIENT)) {
+ log(classDefToken, String.format("Sync class %s must be named Client.", className));
+ }
+ }
+
+ /**
+ * A function checks if the annotation node has a member key is {@code IS_ASYNC} with value equals to 'true'.
+ * If the value equals 'true', which indicates the @ServiceClient is an asynchronous client.
+ * If the member pair is missing. By default, it is a synchronous service client.
+ *
+ * @param annotationToken the ANNOTATION AST node
+ * @return true if the annotation has {@code IS_ASYNC} value 'true', otherwise, false.
+ */
+ private boolean isAsyncServiceClient(DetailAST annotationToken) {
+ for (DetailAST ast = annotationToken.getFirstChild(); ast != null; ast = ast.getNextSibling()) {
+ if (ast.getType() != TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR) {
+ continue;
+ }
+
+ // skip this annotation member value pair if no IDENT found, since we are looking for member, 'isAsync'.
+ final DetailAST identToken = ast.findFirstToken(TokenTypes.IDENT);
+ if (identToken == null) {
+ continue;
+ }
+
+ // skip this annotation member value pair if the member is not 'isAsync'.
+ if (!IS_ASYNC.equals(identToken.getText())) {
+ continue;
+ }
+
+ // skip this annotation member value pair if the member has no EXPR value
+ final DetailAST exprToken = ast.findFirstToken(TokenTypes.EXPR);
+ if (exprToken == null) {
+ continue;
+ }
+
+ // true if isAsync = true, false otherwise.
+ return exprToken.branchContains(TokenTypes.LITERAL_TRUE);
+ }
+ // By default, if the IS_ASYNC doesn't exist, the service client is a synchronous client.
+ return false;
+ }
+}
diff --git a/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml b/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml
index f8a5f76638da4..1f9752c52de54 100755
--- a/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml
+++ b/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml
@@ -6,13 +6,13 @@
-
+
+ files="keyvault[/\\]microsoft-azure-.*[/\\].*[/\\](IKey|ISignatureTransform|KeyVaultClientBase|KeyVaultClientCustom)\.java"/>
-
+
@@ -85,4 +85,8 @@
+
+
+
+
diff --git a/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle.xml b/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle.xml
index 5594540a232fe..0e37ecfac62cf 100755
--- a/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle.xml
+++ b/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle.xml
@@ -274,9 +274,21 @@ page at http://checkstyle.sourceforge.net/config.html -->
+ 1) not return classes in the implementation package
+ 2) no class of implementation package as method's parameters -->
+
+
+
+
+
+
+
diff --git a/eng/code-quality-reports/src/main/resources/spotbugs/spotbugs-exclude.xml b/eng/code-quality-reports/src/main/resources/spotbugs/spotbugs-exclude.xml
index 8e6c2c8844554..f7e3bcb5eb317 100755
--- a/eng/code-quality-reports/src/main/resources/spotbugs/spotbugs-exclude.xml
+++ b/eng/code-quality-reports/src/main/resources/spotbugs/spotbugs-exclude.xml
@@ -61,7 +61,10 @@
-
+
+
+
+
@@ -104,7 +107,10 @@
-
+
+
+
+
@@ -238,7 +244,10 @@
-
+
+
+
+
@@ -357,7 +366,10 @@
-
+
+
+
+
@@ -422,6 +434,15 @@
+
+
+
+
+
+
+
+
+
@@ -477,4 +498,14 @@
+
+
+
+
+
+
+
+
+
+
diff --git a/eng/jacoco-test-coverage/pom.xml b/eng/jacoco-test-coverage/pom.xml
index 82ed0618208a7..b6567bd45d9e5 100644
--- a/eng/jacoco-test-coverage/pom.xml
+++ b/eng/jacoco-test-coverage/pom.xml
@@ -3,14 +3,14 @@
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
4.0.0
com.azure
azure-client-sdk-parent
- 1.0.0
+ 1.1.0
../../pom.client.xml
@@ -23,8 +23,11 @@
https://github.com/Azure/azure-sdk-for-java
- 5.0.0-preview.1
+ 1.0.0-preview.3
+ 1.0.0-preview.1
+ 1.0.0-preview.1
4.0.0-preview.1
+ 5.0.0-preview.2
@@ -44,22 +47,27 @@
com.azure
azure-core
- 1.0.0-preview.1
+ ${azure-core.version}
com.azure
azure-core-amqp
- 1.0.0-preview.1
+ ${azure-core.version}
com.azure
azure-core-management
- 1.0.0-preview.1
+ ${azure-core.version}
com.azure
azure-data-appconfiguration
- ${version}
+ ${azure-data-appconfiguration.version}
+
+
+ com.azure
+ azure-identity
+ ${azure-identity.version}
com.azure
@@ -76,22 +84,21 @@
azure-messaging-eventhubs
${azure-messaging-eventhubs.version}
-
- com.azure
- tracing-opentelemetry
- ${version}
-
-
- com.azure
- azure-identity
- 1.0.0-preview.1
-
+
+
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+