enhance integration tests to be able to cover all kinds of key types easily (#2)

Also refactored `KeyStoreBuilder` in order to be able to easily migrate
the other key types with the next commits.

*Note*: Due to a test first approach commits the comment out line (see
TODO) covering all key type to be supported.

Signed-off-by: Andreas Schmid <[email protected]>

Author: aaschmid

src/main/java/de/aaschmid/taskwarrior/client/KeyStoreBuilder.java

@@ -4,6 +4,7 @@
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
+import java.nio.file.Files;
 import java.security.KeyFactory;
 import java.security.KeyStore;
 import java.security.KeyStore.PasswordProtection;
@@ -16,6 +17,7 @@
 import java.security.cert.CertificateException;
 import java.security.cert.CertificateFactory;
 import java.security.spec.InvalidKeySpecException;
+import java.security.spec.KeySpec;
 import java.security.spec.PKCS8EncodedKeySpec;
 import java.util.ArrayList;
 import java.util.List;
@@ -125,21 +127,22 @@ private List<Certificate> createCertificatesFor(File certFile) {
     }
 
     private PrivateKey createPrivateKeyFor(File privateKeyFile) {
-        byte[] privateKeyBytes;
-        try (BufferedInputStream bis = new BufferedInputStream(new FileInputStream(privateKeyFile))) {
-            privateKeyBytes = new byte[(int) privateKeyFile.length()];
-            int readBytes = bis.read(privateKeyBytes);
-            if (readBytes != privateKeyFile.length()) {
-                throw new TaskwarriorKeyStoreException("Failure reading content of '%s': expected %d but received %d bytes.",
-                        privateKeyFile, privateKeyBytes.length, readBytes);
-            }
+        try {
+            byte[] bytes = Files.readAllBytes(privateKeyFile.toPath());
+            return createPrivateKeyFromPkcs8Der(bytes);
         } catch (IOException e) {
             throw new TaskwarriorKeyStoreException(e, "Could not read private key of '%s' via input stream.", privateKeyFile);
         }
+    }
+
+    private PrivateKey createPrivateKeyFromPkcs8Der(byte[] privateKeyBytes) {
+        return createPrivateKey(privateKeyFile, new PKCS8EncodedKeySpec(privateKeyBytes));
+    }
 
+    private PrivateKey createPrivateKey(File privateKeyFile, KeySpec keySpec) {
         try {
             KeyFactory keyFactory = KeyFactory.getInstance(ALGORITHM_PRIVATE_KEY);
-            return keyFactory.generatePrivate(new PKCS8EncodedKeySpec(privateKeyBytes));
+            return keyFactory.generatePrivate(keySpec);
         } catch (NoSuchAlgorithmException e) {
             throw new TaskwarriorKeyStoreException(e, "Key factory could not be initialized for algorithm '%s'.", ALGORITHM_PRIVATE_KEY);
         } catch (InvalidKeySpecException e) {

src/main/java/de/aaschmid/taskwarrior/config/TaskwarriorPropertiesConfiguration.java

@@ -18,10 +18,8 @@
 import static de.aaschmid.taskwarrior.config.TaskwarriorPropertiesConfiguration.PropertyKey.USER;
 import static java.util.Objects.requireNonNull;
 
-/**
- * {@link TaskwarriorConfiguration} based on a specified properties file
- */
-class TaskwarriorPropertiesConfiguration implements TaskwarriorConfiguration {
+/** {@link TaskwarriorConfiguration} based on a specified properties file */
+public class TaskwarriorPropertiesConfiguration implements TaskwarriorConfiguration {
 
     enum PropertyKey {
         AUTH_KEY("taskwarrior.auth.key"),

src/test/java/de/aaschmid/taskwarrior/TaskwarriorClientIntegrationTest.java

@@ -1,40 +1,47 @@
 package de.aaschmid.taskwarrior;
 
-import java.net.URL;
+import java.util.stream.Stream;
 
 import de.aaschmid.taskwarrior.client.TaskwarriorClient;
 import de.aaschmid.taskwarrior.config.TaskwarriorConfiguration;
 import de.aaschmid.taskwarrior.message.TaskwarriorMessage;
 import de.aaschmid.taskwarrior.message.TaskwarriorRequestHeader;
 import de.aaschmid.taskwarrior.test.IntegrationTest;
 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;
 
-import static de.aaschmid.taskwarrior.config.TaskwarriorConfiguration.taskwarriorPropertiesConfiguration;
 import static de.aaschmid.taskwarrior.message.TaskwarriorMessage.taskwarriorMessage;
 import static de.aaschmid.taskwarrior.message.TaskwarriorRequestHeader.taskwarriorRequestHeaderBuilder;
+import static java.lang.String.format;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.entry;
 
 @IntegrationTest
 class TaskwarriorClientIntegrationTest {
 
-    private static final URL PROPERTIES_TASKWARRIOR =
-            TaskwarriorClientIntegrationTest.class.getResource("/integTest.taskwarrior.properties");
-    private static final TaskwarriorConfiguration CONFIG = taskwarriorPropertiesConfiguration(PROPERTIES_TASKWARRIOR);
-
     private static final String SYNC_KEY = "f92d5c8d-4cf9-4cf5-b72f-1f4a70cf9b20";
 
-    private final TaskwarriorClient client = new TaskwarriorClient(CONFIG);
+    static Stream<Arguments> configs() {
+        return Stream.of("pkcs8-der")
+//        return Stream.of("pkcs1", "pkcs8", "pkcs8-der") // TODO use to test all key type to be supported
+                .map(keyType -> format("/taskwarrior.%s.properties", keyType))
+                .map(TaskwarriorClientIntegrationTest.class::getResource)
+                .map(TaskwarriorConfiguration::taskwarriorPropertiesConfiguration)
+                .map(Arguments::of);
+    }
 
-    @Test
-    void statistics() {
+    @ParameterizedTest
+    @MethodSource("configs")
+    void statistics(TaskwarriorConfiguration config) {
         TaskwarriorRequestHeader header = taskwarriorRequestHeaderBuilder()
-                .authentication(CONFIG)
+                .authentication(config)
                 .type(TaskwarriorRequestHeader.MessageType.STATISTICS)
                 .build();
         TaskwarriorMessage message = taskwarriorMessage(header.toMap());
 
-        TaskwarriorMessage response = client.sendAndReceive(message);
+        TaskwarriorMessage response = clientFor(config).sendAndReceive(message);
 
         assertThat(response.getHeaders())
                 .contains(entry("code", "200"))
@@ -45,15 +52,16 @@ void statistics() {
         assertThat(response.getPayload()).isNotPresent();
     }
 
-    @Test
-    void syncWithoutSyncKey() {
+    @ParameterizedTest
+    @MethodSource("configs")
+    void syncWithoutSyncKey(TaskwarriorConfiguration config) {
         TaskwarriorRequestHeader header = taskwarriorRequestHeaderBuilder()
-                .authentication(CONFIG)
+                .authentication(config)
                 .type(TaskwarriorRequestHeader.MessageType.SYNC)
                 .build();
         TaskwarriorMessage message = taskwarriorMessage(header.toMap());
 
-        TaskwarriorMessage response = client.sendAndReceive(message);
+        TaskwarriorMessage response = clientFor(config).sendAndReceive(message);
 
         assertThat(response.getHeaders())
                 .contains(entry("code", "200"))
@@ -63,19 +71,24 @@ void syncWithoutSyncKey() {
                 .endsWith(SYNC_KEY));
     }
 
-    @Test
-    void syncWithSyncKey() {
+    @ParameterizedTest
+    @MethodSource("configs")
+    void syncWithSyncKey(TaskwarriorConfiguration config) {
         TaskwarriorRequestHeader header = taskwarriorRequestHeaderBuilder()
-                .authentication(CONFIG)
+                .authentication(config)
                 .type(TaskwarriorRequestHeader.MessageType.SYNC)
                 .build();
         TaskwarriorMessage message = taskwarriorMessage(header.toMap(), SYNC_KEY);
 
-        TaskwarriorMessage response = client.sendAndReceive(message);
+        TaskwarriorMessage response = clientFor(config).sendAndReceive(message);
 
         assertThat(response.getHeaders())
                 .contains(entry("code", "201"))
                 .contains(entry("status", "No change"));
         assertThat(response.getPayload()).hasValue(SYNC_KEY);
     }
+
+    private TaskwarriorClient clientFor(TaskwarriorConfiguration config) {
+        return new TaskwarriorClient(config);
+    }
 }

src/test/resources/taskwarrior.pkcs1.properties

@@ -0,0 +1,8 @@
+taskwarrior.server.host=localhost
+taskwarrior.server.port=53589
+taskwarrior.ssl.cert.ca.file=docker/taskd/pki/ca.cert.pem
+taskwarrior.ssl.cert.key.file=docker/taskd/pki/client.cert.pem
+taskwarrior.ssl.private.key.file=docker/taskd/pki/client.key.pem
+taskwarrior.auth.organization=Public
+taskwarrior.auth.user=Task Warrior
+taskwarrior.auth.key=921c0dd2-728e-4a44-8605-68262754dd99

…sources/integTest.taskwarrior.properties …sources/taskwarrior.pkcs8-der.propertiessrc/test/resources/integTest.taskwarrior.properties renamed to src/test/resources/taskwarrior.pkcs8-der.properties src/test/resources/integTest.taskwarrior.properties renamed to src/test/resources/taskwarrior.pkcs8-der.properties

@@ -0,0 +1,8 @@
+taskwarrior.server.host=localhost
+taskwarrior.server.port=53589
+taskwarrior.ssl.cert.ca.file=docker/taskd/pki/ca.cert.pem
+taskwarrior.ssl.cert.key.file=docker/taskd/pki/client.cert.pem
+taskwarrior.ssl.private.key.file=docker/taskd/pki/client.pkcs8.key.pem
+taskwarrior.auth.organization=Public
+taskwarrior.auth.user=Task Warrior
+taskwarrior.auth.key=921c0dd2-728e-4a44-8605-68262754dd99