Remove deprecated FilePasswordFilePath class

With the inclusion of FasterXML/jackson-databind#4327
in the new Jackson release, the deprecated class can be replaced with a JsonAlias annotation.

Signed-off-by: kwall <[email protected]>

Author: k-wall

kroxylicious-api/src/main/java/io/kroxylicious/proxy/config/secret/FilePassword.java

@@ -13,6 +13,7 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Objects;
 
+import com.fasterxml.jackson.annotation.JsonAlias;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
@@ -21,10 +22,12 @@
  * A reference to the file containing a plain text password in UTF-8 encoding.  If the password file
  * contains more than one line, only the characters of the first line are taken to be the password,
  * excluding the line ending.  Subsequent lines are ignored.
+ * <br>
+ * Note that the {@code filePath} alias was deprecated at 0.5.0.
  *
- * @param passwordFile file containing the password,
+ * @param passwordFile file containing the password.
  */
-public record FilePassword(@JsonProperty(required = true) String passwordFile) implements PasswordProvider {
+public record FilePassword(@JsonProperty(required = true) @JsonAlias("filePath") String passwordFile) implements PasswordProvider {
 
     public FilePassword {
         Objects.requireNonNull(passwordFile);

kroxylicious-api/src/main/java/io/kroxylicious/proxy/config/secret/FilePasswordFilePath.java

@@ -13,7 +13,7 @@
  * A PasswordProvider is an abstract source of a password.
  */
 @JsonTypeInfo(use = JsonTypeInfo.Id.DEDUCTION)
-@JsonSubTypes({ @JsonSubTypes.Type(InlinePassword.class), @JsonSubTypes.Type(FilePassword.class), @JsonSubTypes.Type(FilePasswordFilePath.class) })
+@JsonSubTypes({ @JsonSubTypes.Type(InlinePassword.class), @JsonSubTypes.Type(FilePassword.class) })
 @SuppressWarnings("java:S5738") // java:S5738 warns of the use of the deprecated class.
 public interface PasswordProvider {
     String getProvidedPassword();

kroxylicious-api/src/main/java/io/kroxylicious/proxy/config/secret/PasswordProvider.java

@@ -9,13 +9,13 @@
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.nio.file.Files;
-import java.util.List;
 import java.util.function.Function;
 import java.util.stream.Stream;
 
 import org.assertj.core.api.Condition;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
@@ -42,14 +42,10 @@ void afterEach() {
 
     static Stream<Arguments> readPassword() {
         Function<String, PasswordProvider> filePassword = FilePassword::new;
-        Function<String, PasswordProvider> filePasswordPath = FilePasswordFilePath::new;
         return Stream.of(
                 Arguments.of(filePassword, "mypassword", "mypassword"),
                 Arguments.of(filePassword, "mypassword\n", "mypassword"),
-                Arguments.of(filePassword, "mypassword\nignores\nadditional lines", "mypassword"),
-                Arguments.of(filePasswordPath, "mypassword", "mypassword"),
-                Arguments.of(filePasswordPath, "mypassword\n", "mypassword"),
-                Arguments.of(filePasswordPath, "mypassword\nignores\nadditional lines", "mypassword"));
+                Arguments.of(filePassword, "mypassword\nignores\nadditional lines", "mypassword"));
     }
 
     @ParameterizedTest
@@ -62,28 +58,22 @@ void readPassword(Function<String, PasswordProvider> providerFunc, String input,
                 .isEqualTo(expected);
     }
 
-    static List<Function<String, PasswordProvider>> providers() {
-        return List.of(FilePassword::new, FilePasswordFilePath::new);
-    }
-
-    @ParameterizedTest
-    @MethodSource("providers")
-    void toStringDoesNotLeakPassword(Function<String, PasswordProvider> providerFunc) throws Exception {
+    @Test
+    void toStringDoesNotLeakPassword() throws Exception {
         var password = "mypassword";
         Files.writeString(file.toPath(), password);
-        var provider = providerFunc.apply(file.getAbsolutePath());
+        var provider = new FilePassword(file.getAbsolutePath());
         assertThat(provider)
                 .extracting(Object::toString)
                 .doesNotHave(new Condition<>(s -> s.contains(password), "contains password"));
     }
 
-    @ParameterizedTest
-    @MethodSource("providers")
-    void passwordFileNotFound(Function<String, PasswordProvider> providerFunc) {
+    @Test
+    void passwordFileNotFound() {
         assertThat(file.delete()).isTrue();
 
         String path = file.getAbsolutePath();
-        var provider = providerFunc.apply(path);
+        var provider = new FilePassword(file.getAbsolutePath());
         assertThatThrownBy(provider::getProvidedPassword)
                 .hasMessageContaining(path)
                 .hasRootCauseInstanceOf(FileNotFoundException.class);

kroxylicious-api/src/test/java/io/kroxylicious/proxy/config/secret/FilePasswordTest.java

@@ -16,7 +16,6 @@
 import com.fasterxml.jackson.databind.exc.ValueInstantiationException;
 
 import io.kroxylicious.proxy.config.secret.FilePassword;
-import io.kroxylicious.proxy.config.secret.FilePasswordFilePath;
 import io.kroxylicious.proxy.config.secret.InlinePassword;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -203,7 +202,7 @@ void testTrustStoreStoreFilePathPassword() throws IOException {
                 }
                 """;
         Tls tls = readTls(json);
-        assertThat(tls).isEqualTo(new Tls(null, new TrustStore("/tmp/file", new FilePasswordFilePath("/tmp/pass"), null)));
+        assertThat(tls).isEqualTo(new Tls(null, new TrustStore("/tmp/file", new FilePassword("/tmp/pass"), null)));
     }
 
     @Test

kroxylicious-api/src/test/java/io/kroxylicious/proxy/config/tls/TlsParseTest.java

@@ -28,9 +28,7 @@
 import static io.kroxylicious.proxy.config.tls.TlsTestConstants.JKS;
 import static io.kroxylicious.proxy.config.tls.TlsTestConstants.KEYPASS;
 import static io.kroxylicious.proxy.config.tls.TlsTestConstants.KEYPASS_FILE_PASSWORD;
-import static io.kroxylicious.proxy.config.tls.TlsTestConstants.KEYPASS_FILE_PASSWORD_FILE_PATH;
 import static io.kroxylicious.proxy.config.tls.TlsTestConstants.KEYSTORE_FILE_PASSWORD;
-import static io.kroxylicious.proxy.config.tls.TlsTestConstants.KEYSTORE_FILE_PASSWORD_FILE_PATH;
 import static io.kroxylicious.proxy.config.tls.TlsTestConstants.NOT_EXIST;
 import static io.kroxylicious.proxy.config.tls.TlsTestConstants.PEM;
 import static io.kroxylicious.proxy.config.tls.TlsTestConstants.PKCS_12;
@@ -50,9 +48,7 @@ private static Stream<Arguments> withKeyStore() {
                 Arguments.of("PKCS12", PKCS_12, "server.p12", STOREPASS, null),
                 Arguments.of("Combined key/crt PEM passed as keyStore (KIP-651)", PEM, "server_key_crt.pem", null, null),
                 Arguments.of("Combined key/crt PEM passed as keyStore (KIP-651) with encrypted key", PEM, "server_crt_encrypted_key.pem", null, KEYPASS),
-                Arguments.of("JKS keystore from file", JKS, "server_diff_keypass.jks", KEYSTORE_FILE_PASSWORD, KEYPASS_FILE_PASSWORD),
-                Arguments.of("JKS keystore from file (deprecated provider)", JKS, "server_diff_keypass.jks", KEYSTORE_FILE_PASSWORD_FILE_PATH,
-                        KEYPASS_FILE_PASSWORD_FILE_PATH));
+                Arguments.of("JKS keystore from file", JKS, "server_diff_keypass.jks", KEYSTORE_FILE_PASSWORD, KEYPASS_FILE_PASSWORD));
     }
 
     public static Stream<Arguments> serverWithKeyStore() {

kroxylicious-runtime/src/test/java/io/kroxylicious/proxy/config/tls/NettyKeyProviderTest.java

@@ -7,7 +7,6 @@
 package io.kroxylicious.proxy.config.tls;
 
 import io.kroxylicious.proxy.config.secret.FilePassword;
-import io.kroxylicious.proxy.config.secret.FilePasswordFilePath;
 import io.kroxylicious.proxy.config.secret.InlinePassword;
 import io.kroxylicious.proxy.config.secret.PasswordProvider;
 
@@ -23,10 +22,6 @@ public class TlsTestConstants {
     static final PasswordProvider BADPASS = new InlinePassword("badpass");
     static final PasswordProvider KEYSTORE_FILE_PASSWORD = new FilePassword(getResourceLocationOnFilesystem("storepass.password"));
     static final PasswordProvider KEYPASS_FILE_PASSWORD = new FilePassword(getResourceLocationOnFilesystem("keypass.password"));
-    @SuppressWarnings("java:S5738") // java:S5738 warns of the use of the deprecated class.
-    static final PasswordProvider KEYSTORE_FILE_PASSWORD_FILE_PATH = new FilePasswordFilePath(getResourceLocationOnFilesystem("storepass.password"));
-    @SuppressWarnings("java:S5738") // java:S5738 warns of the use of the deprecated class.
-    static final PasswordProvider KEYPASS_FILE_PASSWORD_FILE_PATH = new FilePasswordFilePath(getResourceLocationOnFilesystem("keypass.password"));
 
     public static final String NOT_EXIST = "/does/not/exist";