apply rules to airbyte-config

Author: alovew

airbyte-config/init/src/main/java/io/airbyte/config/init/YamlSeedConfigPersistence.java

@@ -33,8 +33,9 @@
  * This config persistence contains all seed definitions according to the yaml files. It is
  * read-only.
  */
-public class YamlSeedConfigPersistence implements ConfigPersistence {
+final public class YamlSeedConfigPersistence implements ConfigPersistence {
 
+  private static final String PERSISTENCE_READ_ONLY_ERROR_MSG = "The seed config persistence is read only.";
   public static final Class<?> DEFAULT_SEED_DEFINITION_RESOURCE_CLASS = SeedType.class;
 
   private static final Map<AirbyteConfig, SeedType> CONFIG_SCHEMA_MAP = Map.of(
@@ -178,22 +179,22 @@ public <T> List<ConfigWithMetadata<T>> listConfigsWithMetadata(final AirbyteConf
 
   @Override
   public <T> void writeConfig(final AirbyteConfig configType, final String configId, final T config) {
-    throw new UnsupportedOperationException("The seed config persistence is read only.");
+    throw new UnsupportedOperationException(PERSISTENCE_READ_ONLY_ERROR_MSG);
   }
 
   @Override
   public <T> void writeConfigs(final AirbyteConfig configType, final Map<String, T> configs) {
-    throw new UnsupportedOperationException("The seed config persistence is read only.");
+    throw new UnsupportedOperationException(PERSISTENCE_READ_ONLY_ERROR_MSG);
   }
 
   @Override
   public void deleteConfig(final AirbyteConfig configType, final String configId) {
-    throw new UnsupportedOperationException("The seed config persistence is read only.");
+    throw new UnsupportedOperationException(PERSISTENCE_READ_ONLY_ERROR_MSG);
   }
 
   @Override
   public void replaceAllConfigs(final Map<AirbyteConfig, Stream<?>> configs, final boolean dryRun) {
-    throw new UnsupportedOperationException("The seed config persistence is read only.");
+    throw new UnsupportedOperationException(PERSISTENCE_READ_ONLY_ERROR_MSG);
   }
 
   @Override
@@ -205,7 +206,7 @@ public Map<String, Stream<JsonNode>> dumpConfigs() {
 
   @Override
   public void loadData(final ConfigPersistence seedPersistence) throws IOException {
-    throw new UnsupportedOperationException("The seed config persistence is read only.");
+    throw new UnsupportedOperationException(PERSISTENCE_READ_ONLY_ERROR_MSG);
   }
 
 }

airbyte-config/models/src/main/java/io/airbyte/config/ConfigSchema.java

@@ -9,6 +9,7 @@
 import java.nio.file.Path;
 import java.util.function.Function;
 
+@SuppressWarnings({"PMD.AvoidThrowingRawExceptionTypes", "PMD.NullAssignment"})
 public enum ConfigSchema implements AirbyteConfig {
 
   // workspace
@@ -108,6 +109,7 @@ public File getConfigSchemaFile() {
     return KNOWN_SCHEMAS_ROOT.resolve(schemaFilename).toFile();
   }
 
+  @Override
   public <T> Class<T> getClassName() {
     return (Class<T>) className;
   }

airbyte-config/models/src/main/java/io/airbyte/config/ConfigWithMetadata.java

@@ -7,6 +7,7 @@
 import java.time.Instant;
 import java.util.Objects;
 
+@SuppressWarnings("PMD.ShortVariable")
 public class ConfigWithMetadata<T> {
 
   private final String configId;

airbyte-config/models/src/main/java/io/airbyte/config/Configs.java

@@ -24,6 +24,8 @@
  * <p>
  * 2. 'Alpha support' if a var does not have proper support and should be used with care.
  */
+
+@SuppressWarnings("PMD.BooleanGetMethodName")
 public interface Configs {
 
   // CORE

airbyte-config/models/src/main/java/io/airbyte/config/EnvConfigs.java

@@ -32,6 +32,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+@SuppressWarnings({"PMD.LongVariable", "PMD.CyclomaticComplexity", "PMD.AvoidReassigningParameters"})
 public class EnvConfigs implements Configs {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(EnvConfigs.class);

airbyte-config/models/src/main/java/io/airbyte/config/TolerationPOJO.java

@@ -9,6 +9,7 @@
 /**
  * Represents a minimal io.fabric8.kubernetes.api.model.Toleration
  */
+@SuppressWarnings("PMD.ShortVariable")
 public class TolerationPOJO {
 
   private final String key;

airbyte-config/models/src/main/java/io/airbyte/config/helpers/CloudLogs.java

@@ -20,6 +20,7 @@
  * that path 2) log files names start with timestamps, making it possible extract the time the file
  * was written from it's name.
  */
+@SuppressWarnings("PMD.AvoidThrowingRawExceptionTypes")
 public interface CloudLogs {
 
   Logger LOGGER = LoggerFactory.getLogger(CloudLogs.class);

airbyte-config/models/src/main/java/io/airbyte/config/helpers/GcsLogs.java

@@ -22,11 +22,12 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+@SuppressWarnings({"PMD.AvoidFileStream", "PMD.ShortVariable", "PMD.CloseResource"})
 public class GcsLogs implements CloudLogs {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(GcsLogs.class);
 
-  private static Storage GCS;
+  private static Storage gcs;
   private final Supplier<Storage> gcsClientFactory;
 
   public GcsLogs(final Supplier<Storage> gcsClientFactory) {
@@ -86,9 +87,11 @@ public List<String> tailCloudLog(final LogConfigs configs, final String logPath,
     int linesRead = 0;
 
     LOGGER.debug("Start getting GCS objects.");
+    Blob poppedBlob;
+    final ByteArrayOutputStream inMemoryData = new ByteArrayOutputStream();
     while (linesRead <= numLines && !descendingTimestampBlobs.isEmpty()) {
-      final var poppedBlob = descendingTimestampBlobs.remove(0);
-      try (final var inMemoryData = new ByteArrayOutputStream()) {
+      poppedBlob = descendingTimestampBlobs.remove(0);
+      try (inMemoryData) {
         poppedBlob.downloadTo(inMemoryData);
         final var currFileLines = inMemoryData.toString(StandardCharsets.UTF_8).split("\n");
         final List<String> currFileLinesReversed = Lists.reverse(List.of(currFileLines));
@@ -120,10 +123,10 @@ public void deleteLogs(final LogConfigs configs, final String logPath) {
   }
 
   private Storage getOrCreateGcsClient() {
-    if (GCS == null) {
-      GCS = gcsClientFactory.get();
+    if (gcs == null) {
+      gcs = gcsClientFactory.get();
     }
-    return GCS;
+    return gcs;
   }
 
 }

airbyte-config/models/src/main/java/io/airbyte/config/helpers/LogClientSingleton.java

@@ -26,6 +26,7 @@
  * {@link LogConfigs} within this class. Beyond this class, all configuration consumption is via the
  * {@link LogConfigs} interface via the {@link CloudLogs} interface.
  */
+@SuppressWarnings({"PMD.AvoidThrowingRawExceptionTypes", "PMD.AvoidSynchronizedAtMethodLevel"})
 public class LogClientSingleton {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(LogClientSingleton.class);

airbyte-config/models/src/main/java/io/airbyte/config/helpers/LogConfigs.java

@@ -12,7 +12,7 @@
  */
 public class LogConfigs {
 
-  public static LogConfigs EMPTY = new LogConfigs(null);
+  public final static LogConfigs EMPTY = new LogConfigs(null);
 
   private final CloudStorageConfigs storageConfigs;
 

airbyte-config/models/src/main/java/io/airbyte/config/helpers/S3Logs.java

@@ -30,11 +30,12 @@
 import software.amazon.awssdk.services.s3.model.ListObjectsV2Request;
 import software.amazon.awssdk.services.s3.model.ObjectIdentifier;
 
+@SuppressWarnings({"PMD.ShortVariable", "PMD.CloseResource", "PMD.AvoidFileStream"})
 public class S3Logs implements CloudLogs {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(S3Logs.class);
 
-  private static S3Client S3;
+  private static S3Client s3;
 
   private final Supplier<S3Client> s3ClientFactory;
 
@@ -100,7 +101,7 @@ public List<String> tailCloudLog(final LogConfigs configs, final String logPath,
 
     final var s3Bucket = getBucketName(configs.getStorageConfigs());
     LOGGER.debug("Start making S3 list request.");
-    final ArrayList<String> ascendingTimestampKeys = getAscendingObjectKeys(s3Client, logPath, s3Bucket);
+    final List<String> ascendingTimestampKeys = getAscendingObjectKeys(s3Client, logPath, s3Bucket);
     final var descendingTimestampKeys = Lists.reverse(ascendingTimestampKeys);
 
     final var lines = new ArrayList<String>();
@@ -145,13 +146,13 @@ public void deleteLogs(final LogConfigs configs, final String logPath) {
   }
 
   private S3Client getOrCreateS3Client() {
-    if (S3 == null) {
-      S3 = s3ClientFactory.get();
+    if (s3 == null) {
+      s3 = s3ClientFactory.get();
     }
-    return S3;
+    return s3;
   }
 
-  private static ArrayList<String> getAscendingObjectKeys(final S3Client s3Client, final String logPath, final String s3Bucket) {
+  private static List<String> getAscendingObjectKeys(final S3Client s3Client, final String logPath, final String s3Bucket) {
     final var listObjReq = ListObjectsV2Request.builder().bucket(s3Bucket).prefix(logPath).build();
     final var ascendingTimestampObjs = new ArrayList<String>();
 
@@ -164,7 +165,7 @@ private static ArrayList<String> getAscendingObjectKeys(final S3Client s3Client,
     return ascendingTimestampObjs;
   }
 
-  private static ArrayList<String> getCurrFile(final S3Client s3Client, final String s3Bucket, final String poppedKey) throws IOException {
+  private static List<String> getCurrFile(final S3Client s3Client, final String s3Bucket, final String poppedKey) throws IOException {
     final var getObjReq = GetObjectRequest.builder()
         .key(poppedKey)
         .bucket(s3Bucket)

airbyte-config/models/src/main/java/io/airbyte/config/helpers/ScheduleHelpers.java

@@ -7,6 +7,7 @@
 import io.airbyte.config.Schedule;
 import java.util.concurrent.TimeUnit;
 
+@SuppressWarnings("PMD.AvoidThrowingRawExceptionTypes")
 public class ScheduleHelpers {
 
   public static Long getSecondsInUnit(final Schedule.TimeUnit timeUnitEnum) {

airbyte-config/models/src/main/java/io/airbyte/config/helpers/YamlListToStandardDefinitions.java

@@ -31,42 +31,43 @@
  *
  * Methods in these class throw Runtime exceptions upon validation failure.
  */
+@SuppressWarnings("PMD.ShortVariable")
 public class YamlListToStandardDefinitions {
 
-  private static final Map<String, String> classNameToIdName = Map.ofEntries(
+  private static final Map<String, String> CLASS_NAME_TO_ID_NAME = Map.ofEntries(
       new SimpleImmutableEntry<>(StandardDestinationDefinition.class.getCanonicalName(), "destinationDefinitionId"),
       new SimpleImmutableEntry<>(StandardSourceDefinition.class.getCanonicalName(), "sourceDefinitionId"));
 
-  public static List<StandardSourceDefinition> toStandardSourceDefinitions(final String yamlStr) throws RuntimeException {
+  public static List<StandardSourceDefinition> toStandardSourceDefinitions(final String yamlStr) {
     return verifyAndConvertToModelList(StandardSourceDefinition.class, yamlStr);
   }
 
-  public static List<StandardDestinationDefinition> toStandardDestinationDefinitions(final String yamlStr) throws RuntimeException {
+  public static List<StandardDestinationDefinition> toStandardDestinationDefinitions(final String yamlStr) {
     return verifyAndConvertToModelList(StandardDestinationDefinition.class, yamlStr);
   }
 
-  public static JsonNode verifyAndConvertToJsonNode(final String idName, final String yamlStr) throws RuntimeException {
+  public static JsonNode verifyAndConvertToJsonNode(final String idName, final String yamlStr) {
     final var jsonNode = Yamls.deserialize(yamlStr);
     checkYamlIsPresentWithNoDuplicates(jsonNode, idName);
     return jsonNode;
   }
 
   @VisibleForTesting
-  static <T> List<T> verifyAndConvertToModelList(final Class<T> klass, final String yamlStr) throws RuntimeException {
+  static <T> List<T> verifyAndConvertToModelList(final Class<T> klass, final String yamlStr) {
     final var jsonNode = Yamls.deserialize(yamlStr);
-    final var idName = classNameToIdName.get(klass.getCanonicalName());
+    final var idName = CLASS_NAME_TO_ID_NAME.get(klass.getCanonicalName());
     checkYamlIsPresentWithNoDuplicates(jsonNode, idName);
     return toStandardXDefinitions(jsonNode.elements(), klass);
   }
 
-  private static void checkYamlIsPresentWithNoDuplicates(final JsonNode deserialize, final String idName) throws RuntimeException {
+  private static void checkYamlIsPresentWithNoDuplicates(final JsonNode deserialize, final String idName) {
     final var presentDestList = !deserialize.elements().equals(ClassUtil.emptyIterator());
     Preconditions.checkState(presentDestList, "Definition list is empty");
     checkNoDuplicateNames(deserialize.elements());
     checkNoDuplicateIds(deserialize.elements(), idName);
   }
 
-  private static void checkNoDuplicateNames(final Iterator<JsonNode> iter) throws IllegalArgumentException {
+  private static void checkNoDuplicateNames(final Iterator<JsonNode> iter) {
     final var names = new HashSet<String>();
     while (iter.hasNext()) {
       final var element = Jsons.clone(iter.next());
@@ -78,7 +79,7 @@ private static void checkNoDuplicateNames(final Iterator<JsonNode> iter) throws
     }
   }
 
-  private static void checkNoDuplicateIds(final Iterator<JsonNode> fileIterator, final String idName) throws IllegalArgumentException {
+  private static void checkNoDuplicateIds(final Iterator<JsonNode> fileIterator, final String idName) {
     final var ids = new HashSet<String>();
     while (fileIterator.hasNext()) {
       final var element = Jsons.clone(fileIterator.next());
@@ -90,7 +91,7 @@ private static void checkNoDuplicateIds(final Iterator<JsonNode> fileIterator, f
     }
   }
 
-  private static <T> List<T> toStandardXDefinitions(final Iterator<JsonNode> iter, final Class<T> c) throws RuntimeException {
+  private static <T> List<T> toStandardXDefinitions(final Iterator<JsonNode> iter, final Class<T> c) {
     final Iterable<JsonNode> iterable = () -> iter;
     final var defList = new ArrayList<T>();
     for (final JsonNode n : iterable) {

airbyte-config/models/src/main/java/io/airbyte/config/storage/CloudStorageConfigs.java

@@ -12,6 +12,7 @@
  * wherever that cloud storage is used and then, based on the configuration, spin up the correct
  * client. This configuration object allows us to do that.
  */
+@SuppressWarnings("PMD.ShortMethodName")
 public class CloudStorageConfigs {
 
   public enum WorkerStorageType {

airbyte-config/models/src/main/java/io/airbyte/config/storage/DefaultGcsClientFactory.java

@@ -18,6 +18,7 @@
  * Takes in the constructor our standard format for gcs configuration and provides a factory that
  * uses that configuration to create a GCS client (Storage).
  */
+@SuppressWarnings("PMD.AvoidThrowingRawExceptionTypes")
 public class DefaultGcsClientFactory implements Supplier<Storage> {
 
   private final GcsConfig config;
@@ -38,7 +39,7 @@ public Storage get() {
       final var credentialsByteStream = new ByteArrayInputStream(Files.readAllBytes(Path.of(config.getGoogleApplicationCredentials())));
       final var credentials = ServiceAccountCredentials.fromStream(credentialsByteStream);
       return StorageOptions.newBuilder().setCredentials(credentials).build().getService();
-    } catch (Exception e) {
+    } catch (final Exception e) {
       throw new RuntimeException(e);
     }
   }

airbyte-config/models/src/main/java/io/airbyte/config/storage/MinioS3ClientFactory.java

@@ -18,6 +18,7 @@
  * pass to it. Takes in the constructor our standard format for minio configuration and provides a
  * factory that uses that configuration to create an S3Client.
  */
+@SuppressWarnings("PMD.AvoidThrowingRawExceptionTypes")
 public class MinioS3ClientFactory implements Supplier<S3Client> {
 
   private final MinioConfig minioConfig;

airbyte-config/persistence/src/main/java/io/airbyte/config/persistence/ConfigNotFoundException.java

@@ -9,6 +9,7 @@
 
 public class ConfigNotFoundException extends Exception {
 
+  private static final long serialVersionUID = 836273627;
   private final String type;
   private final String configId;
 

airbyte-config/persistence/src/main/java/io/airbyte/config/persistence/ConfigRepository.java

@@ -73,6 +73,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+@SuppressWarnings({"PMD.AvoidThrowingRawExceptionTypes", "PMD.CyclomaticComplexity", "PMD.AvoidLiteralsInIfCondition"})
 public class ConfigRepository {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(ConfigRepository.class);
@@ -82,7 +83,7 @@ public class ConfigRepository {
 
   public ConfigRepository(final ConfigPersistence persistence, final Database database) {
     this.persistence = persistence;
-    this.database = new ExceptionWrappingDatabase(database);;
+    this.database = new ExceptionWrappingDatabase(database);
   }
 
   /**
@@ -698,9 +699,9 @@ public void deleteStandardSyncOperation(final UUID standardSyncOperationId) thro
     });
   }
 
-  public SourceOAuthParameter getSourceOAuthParams(final UUID SourceOAuthParameterId)
+  public SourceOAuthParameter getSourceOAuthParams(final UUID sourceOAuthParameterId)
       throws JsonValidationException, IOException, ConfigNotFoundException {
-    return persistence.getConfig(ConfigSchema.SOURCE_OAUTH_PARAM, SourceOAuthParameterId.toString(), SourceOAuthParameter.class);
+    return persistence.getConfig(ConfigSchema.SOURCE_OAUTH_PARAM, sourceOAuthParameterId.toString(), SourceOAuthParameter.class);
   }
 
   public Optional<SourceOAuthParameter> getSourceOAuthParamByDefinitionIdOptional(final UUID workspaceId, final UUID sourceDefinitionId)
@@ -718,8 +719,8 @@ public Optional<SourceOAuthParameter> getSourceOAuthParamByDefinitionIdOptional(
     return Optional.of(DbConverter.buildSourceOAuthParameter(result.get(0)));
   }
 
-  public void writeSourceOAuthParam(final SourceOAuthParameter SourceOAuthParameter) throws JsonValidationException, IOException {
-    persistence.writeConfig(ConfigSchema.SOURCE_OAUTH_PARAM, SourceOAuthParameter.getOauthParameterId().toString(), SourceOAuthParameter);
+  public void writeSourceOAuthParam(final SourceOAuthParameter sourceOAuthParameter) throws JsonValidationException, IOException {
+    persistence.writeConfig(ConfigSchema.SOURCE_OAUTH_PARAM, sourceOAuthParameter.getOauthParameterId().toString(), sourceOAuthParameter);
   }
 
   public List<SourceOAuthParameter> listSourceOAuthParam() throws JsonValidationException, IOException {

airbyte-config/persistence/src/main/java/io/airbyte/config/persistence/ConfigWriter.java

@@ -26,6 +26,7 @@
  * Currently this class is used to move write queries out of {@link DatabaseConfigPersistence} so
  * that they can be reused/composed in {@link ConfigRepository}.
  */
+@SuppressWarnings("PMD.CognitiveComplexity")
 public class ConfigWriter {
 
   static void writeStandardSourceDefinition(final List<StandardSourceDefinition> configs, final DSLContext ctx) {