Migrate Metrics Advisor, Mixed Reality, Models Repository, Monitor, a…

…nd OpenAI to new Checkstyle and Spotbugs pattern (#42967) Migrate Metrics Advisor, Mixed Reality, Models Repository, Monitor, and OpenAI to new Checkstyle and Spotbugs pattern
Azure · Nov 15, 2024 · ea44eda · ea44eda
1 parent 517aaea
commit ea44eda
Show file tree

Hide file tree

Showing 67 changed files with 1,897 additions and 74 deletions.
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
@@ -75,7 +75,6 @@
   <suppress checks="LineLength" files="messages.properties"/>
 
   <!-- OpenTelemetry tracing are plugin packages and shouldn't be referenced -->
-  <suppress checks="IllegalImport" files=".*[/\\]com[/\\]azure[/\\]monitor[/\\]opentelemetry[/\\]*"/>
   <suppress checks="IllegalImport" files=".*[/\\]com[/\\]azure[/\\]spring[/\\]cloud[/\\]autoconfigure[/\\]monitor[/\\]*"/>
   <suppress checks="IllegalImport" files="com.azure.messaging.eventhubs.*Sample.*java"/>
   <suppress checks="IllegalImport" files="com.azure.messaging.eventhubs.*Test.*java"/>
@@ -123,18 +122,6 @@
   <suppress checks="com.azure.tools.checkstyle.checks.ThrowFromClientLoggerCheck"
             files="com.azure.containers.containerregistry.ContainerRegistryContentClient.java"/>
 
-  <suppress checks="com.azure.tools.checkstyle.checks.ExternalDependencyExposedCheck"
-            files="com.azure.monitor.opentelemetry.exporter.AzureMonitorExporter.java"/>
-
-  <suppress checks="com.azure.tools.checkstyle.checks.ExternalDependencyExposedCheck"
-            files="com.azure.monitor.opentelemetry.exporter.AzureMonitorExporterOptions"/>
-
-  <suppress checks="com.azure.tools.checkstyle.checks.ExternalDependencyExposedCheck"
-            files="com.azure.monitor.opentelemetry.autoconfigure.AzureMonitorAutoConfigure.java"/>
-
-  <suppress checks="com.azure.tools.checkstyle.checks.ExternalDependencyExposedCheck"
-            files="com.azure.monitor.opentelemetry.autoconfigure.AzureMonitorAutoConfigureOptions"/>
-
   <!-- JavadocInlineTagCheck Suppression for now, which need code owner's attention -->
   <suppress checks="com.azure.tools.checkstyle.checks.JavadocInlineTagCheck"
             files="com.azure.security.keyvault.keys.(KeyClient|KeyAsyncClient).java"/>
@@ -161,9 +148,6 @@
   <!-- This class overrides a method that throws, so it cannot be avoided. -->
   <suppress checks="com.azure.tools.checkstyle.checks.ThrowFromClientLoggerCheck" files="com.azure.security.keyvault.jca.KeyVaultTrustManager"/>
 
-  <suppress checks="."
-            files=".*[/\\]monitor[/\\]implementation[/\\]"/>
-
   <!-- Suppress ConfigurationCredentialsPolicy for HttpPipelinePolicyCheck.
    This suppression need to be deleted after AzConfig using AAD credential.
    Issue Link: https://github.com/Azure/azure-sdk-for-java/issues/5131 -->
@@ -175,7 +159,6 @@
 
   <!-- Suppress the check on code-gen classes -->
   <suppress checks="Indentation" files="com.azure.security.keyvault.administration.implementation.(RoleAssignmentsImpl|RoleDefinitionsImpl)"/>
-  <suppress checks="Indentation" files="com.azure.ai.metricsadvisor.implementation.AzureCognitiveServiceMetricsAdvisorRestAPIOpenAPIV2Impl"/>
   <!-- Checkstyle suppressions for the auto generated Chat Client Implementation -->
   <suppress checks="com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck" files="com.azure.communication.chat.implementation.AzureCommunicationChatServiceImpl.java"/>
   <!-- Checkstyle suppressions for the auto generated Phone Number Administration Implementation -->
@@ -225,10 +208,6 @@
   <suppress checks="com.azure.tools.checkstyle.checks.ServiceClientCheck" files="com.azure.messaging.eventhubs.(EventHubBufferedProducerClient|EventHubBufferedProducerAsyncClient).java"/>
   <suppress checks="com.azure.tools.checkstyle.checks.UseCaughtExceptionCauseCheck" files="com.azure.messaging.eventhubs.EventDataBatch.java"/>
 
-  <!-- Checkstyle suppression for OpenAI client APIs that use Flux instead of PagedFlux for methods that return a collection -->
-  <suppress checks="com.azure.tools.checkstyle.checks.ServiceClientCheck" files="com.azure.ai.openai.(OpenAIClient|OpenAIAsyncClient).java"/>
-  <!-- Checkstyle suppression for OpenAI Assistants client APIs that use Flux instead of PagedFlux for methods that return a collection -->
-  <suppress checks="com.azure.tools.checkstyle.checks.ServiceClientCheck" files="com.azure.ai.openai.assistants.(AssistantsClient|AssistantsAsyncClient).java"/>
   <!-- Checkstyle suppression for Inference client APIs that use Flux instead of PagedFlux for methods that return a collection -->
   <suppress checks="com.azure.tools.checkstyle.checks.ServiceClientCheck" files="com.azure.ai.inference.(ChatCompletionsClient|ChatCompletionsAsyncClient).java"/>
 

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
@@ -928,7 +928,7 @@
     <Field name="errorInformationList"/>
     <Bug pattern="SE_BAD_FIELD"/>
   </Match>
-  
+
   <!-- Exception is required to catch, ref: code comment in the OrderbyRowComparer::compare() method  -->
   <Match>
     <Class name="com.azure.cosmos.implementation.query.orderbyquery.OrderbyRowComparer"/>
@@ -1832,12 +1832,6 @@
     <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
   </Match>
 
-  <Match>
-    <Class name="com.azure.ai.metricsadvisor.implementation.models.InfluxDBParameter"/>
-    <Method name="getUserName"/>
-    <Bug pattern="NM_CONFUSING"/>
-  </Match>
-
   <!-- False positives -->
   <Match>
     <Class name="com.azure.security.keyvault.jca.KeyVaultKeyStore"/>
@@ -1854,14 +1848,6 @@
     <Bug pattern="SE_BAD_FIELD"/>
   </Match>
 
-  <!-- This is an internal type used to hold the request body which will not be mutated outside this class -->
-  <Match>
-    <Or>
-      <Class name="com.azure.monitor.ingestion.implementation.LogsIngestionRequest"/>
-    </Or>
-    <Bug pattern="EI_EXPOSE_REP2,EI_EXPOSE_REP"/>
-  </Match>
-
   <!-- Machine generated classes for MAA service generate spotBugs errors -->
   <Match>
     <Or>
@@ -1980,19 +1966,5 @@
     <Bug pattern="LI_LAZY_INIT_STATIC"/>
   </Match>
 
-   <!-- Returning a new copy of the object is not necessary -->
-  <Match>
-    <Class name="~com\.azure\.ai\.openai\.models\.(AudioTranscriptionOptions|AudioTranslationOptions)"/>
-    <Method name="&lt;init&gt;"/>
-    <Bug pattern="EI_EXPOSE_REP2"/>
-  </Match>
-
-  <!-- False positive, it throws an IllegalArgumentException if non-exist method parameter type passed.-->
-  <Match>
-    <Class name="com.azure.ai.openai.implementation.MultipartDataHelper"/>
-    <Method name="serializeRequest"/>
-    <Bug pattern="BC_UNCONFIRMED_CAST_OF_RETURN_VALUE"/>
-  </Match>
-
   <!-- Comment to force CI to run Spotbugs against all SDKs -->
 </FindBugsFilter>
diff --git a/sdk/metricsadvisor/azure-ai-metricsadvisor/checkstyle-suppressions.xml b/sdk/metricsadvisor/azure-ai-metricsadvisor/checkstyle-suppressions.xml
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+<!-- This file is generated by the /eng/scripts/linting_suppression_generator.py script. -->
+
+<suppressions>
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataFeedTransforms.java" checks="JavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DetectionConfigurationTransforms.java" checks="JavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.MetricsAdvisorImpl.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AlertConfigurationTransforms.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AnomalyAlertConfigurationHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AnomalyDetectionConfigurationHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AnomalyHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AnomalyTransforms.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureBlobDataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureCosmosDbDataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureDataExplorerDataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureDataLakeStorageGen2DataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureEventHubsDataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureLogAnalyticsDataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureTableDataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataFeedHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataFeedIngestionProgressHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataFeedIngestionStatusHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataFeedMetricAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataFeedTransforms.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataSourceCredentialEntityTransforms.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataSourceDataLakeGen2SharedKeyAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataSourceServicePrincipalAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataSourceServicePrincipalInKeyVaultAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataSourceSqlServerConnectionStringAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DetectionConfigurationTransforms.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.HookHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.HookTransforms.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.IncidentHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.IncidentRootCauseHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.IncidentRootCauseTransforms.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.IncidentTransforms.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.InfluxDbDataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricAnomalyFeedbackHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricBoundaryConditionHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricEnrichedSeriesDataHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricEnrichedSeriesDataTransformations.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricFeedbackHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricSeriesDataHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricSeriesDataTransforms.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricSeriesDefinitionHelper.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricSeriesDefinitionTransforms.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MongoDbDataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MySqlDataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.PostgreSqlDataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.SqlServerDataFeedSourceAccessor.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.Utility.java" checks="MissingJavadocMethodCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.package-info.java" checks="MissingJavadocPackageCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AnomalyTransforms.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureBlobDataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureCosmosDbDataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureDataExplorerDataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureDataLakeStorageGen2DataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureEventHubsDataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureLogAnalyticsDataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AzureTableDataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataFeedMetricAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataSourceDataLakeGen2SharedKeyAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataSourceServicePrincipalAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataSourceServicePrincipalInKeyVaultAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataSourceSqlServerConnectionStringAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.HookTransforms.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.IncidentRootCauseTransforms.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.IncidentTransforms.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.InfluxDbDataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricEnrichedSeriesDataTransformations.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricSeriesDataTransforms.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MetricSeriesDefinitionTransforms.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MongoDbDataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.MySqlDataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.PostgreSqlDataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.SqlServerDataFeedSourceAccessor.java" checks="MissingJavadocTypeCheck" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.AnomalyTransforms.java" checks="com.azure.tools.checkstyle.checks.JavadocThrowsChecks" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.DataSourceCredentialEntityTransforms.java" checks="com.azure.tools.checkstyle.checks.JavadocThrowsChecks" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.HookTransforms.java" checks="com.azure.tools.checkstyle.checks.JavadocThrowsChecks" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.util.Utility.java" checks="com.azure.tools.checkstyle.checks.JavadocThrowsChecks" />
+  <suppress files="com.azure.ai.metricsadvisor.implementation.MetricsAdvisorImplBuilder.java" checks="com.azure.tools.checkstyle.checks.ServiceClientBuilderCheck" />
+</suppressions>
diff --git a/sdk/metricsadvisor/azure-ai-metricsadvisor/pom.xml b/sdk/metricsadvisor/azure-ai-metricsadvisor/pom.xml
@@ -39,6 +39,10 @@
       --add-exports com.azure.core/com.azure.core.implementation.http=ALL-UNNAMED
       --add-opens com.azure.ai.metricsadvisor/com.azure.ai.metricsadvisor=ALL-UNNAMED
     </javaModulesSurefireArgLine>
+
+    <checkstyle.suppressionsLocation>checkstyle-suppressions.xml</checkstyle.suppressionsLocation>
+    <spotbugs.skip>false</spotbugs.skip>
+    <spotbugs.excludeFilterFile>spotbugs-exclude.xml</spotbugs.excludeFilterFile>
   </properties>
 
   <dependencies>