From a6b52562a8332621971b43e9dbb98b7b34364a5a Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Sat, 19 Mar 2022 14:08:35 +0100 Subject: [PATCH] Improve readability of wkd tests --- .../cli/test_suite/TestSuiteTestRunner.java | 3 +- .../main/java/pgp/wkd/test_suite/Main.java | 3 +- .../wkd/test_suite/TestSuiteGenerator.java | 99 +++++++++++-------- 3 files changed, 61 insertions(+), 44 deletions(-) diff --git a/wkd-java-cli/src/test/java/pgp/wkd/cli/test_suite/TestSuiteTestRunner.java b/wkd-java-cli/src/test/java/pgp/wkd/cli/test_suite/TestSuiteTestRunner.java index bc99b46..3074d6a 100644 --- a/wkd-java-cli/src/test/java/pgp/wkd/cli/test_suite/TestSuiteTestRunner.java +++ b/wkd-java-cli/src/test/java/pgp/wkd/cli/test_suite/TestSuiteTestRunner.java @@ -9,6 +9,7 @@ import org.junit.jupiter.api.DynamicTest; import org.junit.jupiter.api.TestFactory; import pgp.wkd.cli.WKDCLI; import pgp.wkd.cli.command.Fetch; +import pgp.wkd.discovery.DiscoveryMethod; import pgp.wkd.test_suite.TestCase; import pgp.wkd.test_suite.TestSuite; import pgp.wkd.test_suite.TestSuiteGenerator; @@ -35,7 +36,7 @@ public class TestSuiteTestRunner { // Generate test certificates inside the temp wkd String domain = "example.com"; TestSuiteGenerator generator = new TestSuiteGenerator(domain); - suite = generator.generateTestSuiteInDirectory(tempFile, TestSuiteGenerator.Method.direct); + suite = generator.generateTestSuiteInDirectory(tempFile, DiscoveryMethod.direct); // Fetch certificates from a local directory instead of the internetzzz. Fetch.fetcher = new DirectoryBasedCertificateFetcher(tempPath); diff --git a/wkd-test-suite/src/main/java/pgp/wkd/test_suite/Main.java b/wkd-test-suite/src/main/java/pgp/wkd/test_suite/Main.java index deee0de..efbc1fd 100644 --- a/wkd-test-suite/src/main/java/pgp/wkd/test_suite/Main.java +++ b/wkd-test-suite/src/main/java/pgp/wkd/test_suite/Main.java @@ -10,6 +10,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.ObjectWriter; import com.fasterxml.jackson.databind.json.JsonMapper; import com.fasterxml.jackson.dataformat.xml.XmlMapper; +import pgp.wkd.discovery.DiscoveryMethod; import picocli.CommandLine; import java.io.File; @@ -49,7 +50,7 @@ public class Main implements Runnable { @CommandLine.Option(names = {"--method", "-m"}, paramLabel = "{direct|advanced}", description = "Method for key discovery. If absent, assume direct.") - private TestSuiteGenerator.Method method = TestSuiteGenerator.Method.direct; + private DiscoveryMethod method = DiscoveryMethod.direct; @CommandLine.Spec // injected by picocli CommandLine.Model.CommandSpec spec; diff --git a/wkd-test-suite/src/main/java/pgp/wkd/test_suite/TestSuiteGenerator.java b/wkd-test-suite/src/main/java/pgp/wkd/test_suite/TestSuiteGenerator.java index 1b0dc93..446af48 100644 --- a/wkd-test-suite/src/main/java/pgp/wkd/test_suite/TestSuiteGenerator.java +++ b/wkd-test-suite/src/main/java/pgp/wkd/test_suite/TestSuiteGenerator.java @@ -25,13 +25,10 @@ import org.bouncycastle.openpgp.PGPSecretKeyRing; import org.bouncycastle.openpgp.PGPSignature; import org.pgpainless.PGPainless; import org.pgpainless.key.protection.SecretKeyRingProtector; +import pgp.wkd.discovery.DiscoveryMethod; public class TestSuiteGenerator { - public enum Method { - direct, - advanced - } private final String domain; @@ -39,42 +36,26 @@ public class TestSuiteGenerator { this.domain = domain; } - public TestSuite generateTestSuiteInDirectory(File directory, Method method) throws Exception { - WkdDirectoryStructure structure = directoryStructureForMethod(directory, method); - structure.mkdirs(); + public TestSuite generateTestSuiteInDirectory(File directory, DiscoveryMethod method) throws Exception { + WkdDirectoryStructure dirs = directoryStructureForMethod(directory, method); + dirs.mkdirs(); List tests = new ArrayList<>(); - tests.add(baseCase(structure)); - tests.add(baseCaseMultipleCertificates(structure)); - tests.add(wrongUserId(structure)); - tests.add(noUserId(structure)); - tests.add(unboundUserId(structure)); - tests.addAll(baseCaseMultiUserIds(structure)); - tests.add(secretKeyMaterial(structure)); - tests.add(randomBytes(structure)); + tests.add(test_baseCase(dirs)); + tests.add(test_baseCaseMultipleCertificates(dirs)); + tests.add(test_wrongUserId(dirs)); + tests.add(test_noUserId(dirs)); + tests.add(test_unboundUserId(dirs)); + tests.addAll(test_baseCaseMultiUserIds(dirs)); + tests.add(test_secretKeyMaterial(dirs)); + tests.add(test_randomBytes(dirs)); return new TestSuite("0.1", tests); } - private WkdDirectoryStructure directoryStructureForMethod(File directory, Method method) { - WkdDirectoryStructure structure; - if (method == Method.direct) { - structure = new WkdDirectoryStructure.DirectMethod(directory, domain); - } else if (method == Method.advanced) { - structure = new WkdDirectoryStructure.AdvancedMethod(directory, domain); - } else { - throw new IllegalArgumentException("Invalid value for parameter 'method'."); - } - return structure; - } + // TEST CASES - private PGPPublicKeyRing certificate(String userId) throws PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException { - PGPSecretKeyRing secretKeys = PGPainless.generateKeyRing().modernKeyRing(userId, null); - PGPPublicKeyRing publicKeys = PGPainless.extractCertificate(secretKeys); - return publicKeys; - } - - private TestCase baseCase(WkdDirectoryStructure directoryStructure) throws Exception { + private TestCase test_baseCase(WkdDirectoryStructure directoryStructure) throws Exception { String lookupMail = "base-case@" + domain; String userId = "WKD-Test Base Case "; String description = "Certificate has a single, valid user-id '" + userId + "'"; @@ -88,10 +69,10 @@ public class TestSuiteGenerator { } }); - return TestCase.ok("Base Csae", description, lookupMail, directoryStructure); + return TestCase.ok("Base Case", description, lookupMail, directoryStructure); } - private List baseCaseMultiUserIds(WkdDirectoryStructure directoryStructure) throws Exception { + private List test_baseCaseMultiUserIds(WkdDirectoryStructure directoryStructure) throws Exception { String primaryLookupMail = "primary-uid@" + domain; String secondaryLookupMail = "secondary-uid@" + domain; String primaryUserId = "WKD-Test Primary User-ID <" + primaryLookupMail + ">"; @@ -123,7 +104,7 @@ public class TestSuiteGenerator { ); } - private TestCase baseCaseMultipleCertificates(WkdDirectoryStructure directoryStructure) throws Exception { + private TestCase test_baseCaseMultipleCertificates(WkdDirectoryStructure directoryStructure) throws Exception { String title = "Multiple Certificates"; String description = "The result contains multiple certificates."; String lookupMail = "multiple-certificates@" + domain; @@ -144,7 +125,7 @@ public class TestSuiteGenerator { return TestCase.ok(title, description, lookupMail, directoryStructure); } - private TestCase wrongUserId(WkdDirectoryStructure directoryStructure) throws Exception { + private TestCase test_wrongUserId(WkdDirectoryStructure directoryStructure) throws Exception { String lookupMail = "wrong-userid@" + domain; String userId = "WKD-Test Different User-ID "; String description = "Certificate has a single, valid user-id '" + userId + "', but is deposited for mail address '" + lookupMail + "'."; @@ -160,7 +141,7 @@ public class TestSuiteGenerator { return TestCase.fail("Wrong User-ID", description, lookupMail, directoryStructure); } - private TestCase unboundUserId(WkdDirectoryStructure directoryStructure) throws Exception { + private TestCase test_unboundUserId(WkdDirectoryStructure directoryStructure) throws Exception { String lookupMail = "unbound-userid@" + domain; String userId = "WKD-Test Unbound User-ID <" + lookupMail + ">"; String description = "Certificate has a single User-ID '" + userId + "' without binding signature."; @@ -190,7 +171,7 @@ public class TestSuiteGenerator { return TestCase.fail("Unbound UserId", description, lookupMail, directoryStructure); } - private TestCase noUserId(WkdDirectoryStructure directoryStructure) throws Exception { + private TestCase test_noUserId(WkdDirectoryStructure directoryStructure) throws Exception { String lookupMail = "absent-userid@" + domain; String description = "Certificate has no user-id, but is deposited for mail address '" + lookupMail + "'."; // Generate certificate with temp user-id @@ -218,10 +199,10 @@ public class TestSuiteGenerator { return TestCase.fail("No User-ID", description, lookupMail, directoryStructure); } - private TestCase secretKeyMaterial(WkdDirectoryStructure directoryStructure) throws Exception { + private TestCase test_secretKeyMaterial(WkdDirectoryStructure directoryStructure) throws Exception { String lookupMail = "test-secret-key@" + domain; String description = "Certificate file contains secret key material."; - PGPSecretKeyRing secretKeys = PGPainless.generateKeyRing().modernKeyRing("WKD-Test Secret Key <" + lookupMail + ">", null); + PGPSecretKeyRing secretKeys = secretKey("WKD-Test Secret Key <" + lookupMail + ">"); writeDataFor(lookupMail, directoryStructure, new DataSink() { @Override @@ -233,7 +214,8 @@ public class TestSuiteGenerator { return TestCase.fail("Secret Key Material", description, lookupMail, directoryStructure); } - private TestCase randomBytes(WkdDirectoryStructure directoryStructure) throws IOException { + private TestCase test_randomBytes(WkdDirectoryStructure directoryStructure) + throws IOException { String lookupMail = "random-bytes@" + domain; String description = "Certificate file contains random bytes."; @@ -248,6 +230,31 @@ public class TestSuiteGenerator { return TestCase.fail("Random Bytes", description, lookupMail, directoryStructure); } + // INTERNAL METHODS + + private WkdDirectoryStructure directoryStructureForMethod(File directory, DiscoveryMethod method) { + WkdDirectoryStructure structure; + if (method == DiscoveryMethod.direct) { + structure = new WkdDirectoryStructure.DirectMethod(directory, domain); + } else if (method == DiscoveryMethod.advanced) { + structure = new WkdDirectoryStructure.AdvancedMethod(directory, domain); + } else { + throw new IllegalArgumentException("Invalid value for parameter 'method'."); + } + return structure; + } + + private PGPSecretKeyRing secretKey(String userId) throws PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException { + PGPSecretKeyRing secretKeys = PGPainless.generateKeyRing().modernKeyRing(userId, null); + return secretKeys; + } + + private PGPPublicKeyRing certificate(String userId) throws PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException { + PGPSecretKeyRing secretKeys = secretKey(userId); + PGPPublicKeyRing publicKeys = PGPainless.extractCertificate(secretKeys); + return publicKeys; + } + private void writeDataFor(String mailAddress, WkdDirectoryStructure directory, DataSink sink) throws IOException { Path path = directory.getRelativeCertificatePath(mailAddress); @@ -263,7 +270,15 @@ public class TestSuiteGenerator { } private interface DataSink { + + /** + * Write data into the {@link OutputStream}. + * + * @param outputStream output stream + * @throws IOException in case of an IO error + */ void write(OutputStream outputStream) throws IOException; + } }