Add tests for PGPKeyManager

composer.json

@@ -30,7 +30,8 @@
     "require-dev": {
         "squizlabs/php_codesniffer": "^3.7.2",
         "dealerdirect/phpcodesniffer-composer-installer": "^1.0",
-        "phpcompatibility/php-compatibility": "^9.3.5"
+        "phpcompatibility/php-compatibility": "^9.3.5",
+        "psr/log": "^1.0 || ^2.0 || ^3.0"
     },
     "suggest": {
         "ext-gnupg": "is technically required, but not compatible with Windows",

psalm.baseline.xml

@@ -32,4 +32,14 @@
       <code><![CDATA[PHPMailerPGP]]></code>
     </PropertyNotSetInConstructor>
   </file>
+  <file src="tests/PGPKeyManagerTest.php">
+    <MissingDependency>
+      <code><![CDATA[PGPTestCase]]></code>
+    </MissingDependency>
+  </file>
+  <file src="tests/PHPMailerPGPTest.php">
+    <MissingDependency>
+      <code><![CDATA[PGPTestCase]]></code>
+    </MissingDependency>
+  </file>
 </files>

psalm.xml

@@ -20,6 +20,7 @@
             <errorLevel type="suppress">
                 <referencedClass name="gnupg" />
                 <referencedClass name="PHPUnit\Framework\TestCase"></referencedClass>
+                <referencedClass name="Psr\Log\LoggerInterface"></referencedClass>
             </errorLevel>
         </UndefinedClass>
         <UndefinedDocblockClass errorLevel="suppress" />

tests/PGPKeyManagerTest.php

@@ -0,0 +1,115 @@
+<?php
+declare(strict_types=1);
+
+namespace PHPMailerPGP\Test;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPMailer\PHPMailerPGP\PGPKeyManager;
+use PHPMailer\PHPMailerPGP\PGPHelper;
+
+/**
+ * @author Andreas Wahlen
+ * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
+ */
+#[CoversClass(PGPHelper::class)]
+#[CoversClass(PGPKeyManager::class)]
+class PGPKeyManagerTest extends PGPTestCase
+{
+    private PGPKeyManager $keyManager;
+
+    public static function setUpBeforeClass(): void
+    {
+        parent::setUpBeforeClass();
+
+        $gnupg = new \gnupg();
+        $gnupg->seterrormode(GNUPG_ERROR_EXCEPTION);
+        if ($gnupg->import(file_get_contents(__DIR__.'/public.asc')) === false) {
+            echo 'failed to import example key'.PHP_EOL;
+        }
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->keyManager = new PGPKeyManager(new class() implements \Psr\Log\LoggerInterface {
+            /**
+             * @param string|\Stringable $message
+             */
+            public function emergency($message, array $context = []): void {
+                $this->log(\Psr\Log\LogLevel::EMERGENCY, $message, $context);
+            }
+
+            /**
+             * @param string|\Stringable $message
+             */
+            public function alert($message, array $context = []): void {
+                $this->log(\Psr\Log\LogLevel::ALERT, $message, $context);
+            }
+
+            /**
+             * @param string|\Stringable $message
+             */
+            public function critical($message, array $context = []): void {
+                $this->log(\Psr\Log\LogLevel::CRITICAL, $message, $context);
+            }
+
+            /**
+             * @param string|\Stringable $message
+             */
+            public function error($message, array $context = []): void {
+                $this->log(\Psr\Log\LogLevel::ERROR, $message, $context);
+            }
+
+            /**
+             * @param string|\Stringable $message
+             */
+            public function warning($message, array $context = []): void {
+                $this->log(\Psr\Log\LogLevel::WARNING, $message, $context);
+            }
+
+            /**
+             * @param string|\Stringable $message
+             */
+            public function notice($message, array $context = []): void {
+                $this->log(\Psr\Log\LogLevel::NOTICE, $message, $context);
+            }
+
+            /**
+             * @param string|\Stringable $message
+             */
+            public function info($message, array $context = []): void {
+                $this->log(\Psr\Log\LogLevel::INFO, $message, $context);
+            }
+
+            /**
+             * @param string|\Stringable $message
+             */
+            public function debug($message, array $context = []): void {
+                $this->log(\Psr\Log\LogLevel::DEBUG, $message, $context);
+            }
+
+            /**
+             * @param string|\Stringable $message
+             */
+            public function log($level, $message, array $context = []): void {
+                foreach($context as $key => $value){
+                    $message = str_replace('{'.$key.'}', var_export($value, true), $message);
+                }
+                //echo strtoupper($level)."\t".$message.PHP_EOL;
+            }
+        });
+        $this->keyManager->setGPGHome(self::$gnupgHome);
+    }
+
+    public function testDeleteAndImport(): void
+    {
+        $this->keyManager->deleteKey('user@example.com', true);
+        $this->assertEmpty($this->keyManager->getKeys('user@example.com', 'sign'), 'private key still there');
+        $this->assertEmpty($this->keyManager->getKeys('user@example.com', 'encrypt'), 'public key still there');
+
+        $this->keyManager->importKeyFile(__DIR__.'/public.asc');
+        $this->assertCount(1, $this->keyManager->getKeys('user@example.com', 'sign'), 'private key not found');
+        $this->assertCount(1, $this->keyManager->getKeys('user@example.com', 'encrypt'), 'public key not found');
+    }
+}

tests/PGPTestCase.php

@@ -0,0 +1,34 @@
+<?php
+declare(strict_types=1);
+
+namespace PHPMailerPGP\Test;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @author Andreas Wahlen
+ * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
+ */
+class PGPTestCase extends TestCase
+{
+    protected static string $gnupgHome;
+
+    public static function setUpBeforeClass(): void
+    {
+        parent::setUpBeforeClass();
+
+        self::$gnupgHome = __DIR__ . '/.gnupg';
+        if (!file_exists(self::$gnupgHome)) {
+            if (!mkdir(self::$gnupgHome) || !chmod(self::$gnupgHome, 0700)) {
+                echo 'unable to create GnuPG home'.PHP_EOL;
+            }
+        }
+        putenv('GNUPGHOME=' . escapeshellcmd(self::$gnupgHome));
+    }
+
+    public static function tearDownAfterClass(): void
+    {
+        parent::tearDownAfterClass();
+        exec('rm -rf '.escapeshellcmd(self::$gnupgHome));
+    }
+}

tests/PHPMailerPGPTest.php

@@ -6,7 +6,6 @@
 use PHPMailer\PHPMailerPGP\PHPMailerPGP;
 use PHPMailer\PHPMailerPGP\PGPHelper;
 use PHPMailer\PHPMailerPGP\PGPKeyManager;
-use PHPUnit\Framework\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 
 /**
@@ -16,25 +15,14 @@
 #[CoversClass(PHPMailerPGP::class)]
 #[CoversClass(PGPHelper::class)]
 #[CoversClass(PGPKeyManager::class)]
-class PHPMailerPGPTest extends TestCase
+class PHPMailerPGPTest extends PGPTestCase
 {
-    private static string $gnupgHome;
-
     private PHPMailerPGP $mailer;
 
     public static function setUpBeforeClass(): void
     {
         parent::setUpBeforeClass();
 
-        self::$gnupgHome = __DIR__ . '/.gnupg';
-        if (!file_exists(self::$gnupgHome)) {
-            echo 'GnuPG home did not exist'.PHP_EOL;
-            if (!mkdir(self::$gnupgHome)) {
-                echo 'unable to create GnuPG home'.PHP_EOL;
-            }
-        }
-        putenv('GNUPGHOME=' . escapeshellcmd(self::$gnupgHome));
-
         $gnupg = new \gnupg();
         if ($gnupg->import(file_get_contents(__DIR__.'/private.key')) === false) {
             echo 'failed to import example key'.PHP_EOL;

tests/public.asc

@@ -0,0 +1,41 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQGNBGX0uLYBDAChB+OMEWb7uk3xwmiWmU3CQR+UT6b/k8L55fAfGJxVwA8UlFa8
+7TnhpYG4hb6vgYUiOvU57r46VGpahwCO48ZX0nN0qZQSFHJQYYUmWNCTpwNuyO8Y
+Kbnjc6EhlhZquABRXeJrvraOGPLRuU6KEtkAdVLnAylObmelrWjmZm+om/H+GtRB
+ketDoR1tSt7egfxpZNA0a/zf0hKH1JOskru7lG4rjCpbaF8xynmjZtXIYjFAgDCo
+DRTZSYvmo55ESoKvbd77ukXjHandpZQEnILiozY43xOJDsNASTqCi5PqUqW7OASL
+aANxarC76KYGYw7yp3W+OduQcL+aZ/7OrJ6G6zcERijWWeXndVlLH427uRRDNzFQ
+/MjgzGzt0JMkNeC/KqHsnYv8ScIBQzhCNJznIjRndbnh0SMWKV/tizcrFE0xXtf9
+2CxNRGwOZOKsVhDFVNn9ptWleW9fQhqPf5OwEJjD8568RTRRxQAPYEC/s2m6X4hh
+zDrP6DM8Fhm4D+EAEQEAAbQdVW5pdFRlc3RlciA8dXNlckBleGFtcGxlLmNvbT6J
+AdQEEwEKAD4WIQSXPGhtwOMQXlAc8j7Ycttxrux93AUCZfS4tgIbAwUJA8JnAAUL
+CQgHAgYVCgkICwIEFgIDAQIeAQIXgAAKCRDYcttxrux93DCKC/9ECuOz/nGNBzgV
+XWtoB8MB3bZlJaIDGFlfkY49AebNFnkcGZoXH9v8QNPZdqVmnU7VPE+S1QgXPdQb
++Rsq7qkF0IXMMDHVE3PxONewaCP2087DRSz2o/jnx/O6zZDGdCX0us9L4lUPhGm1
+uVHDUMz4yZ1Ne/raepsaEE+RxqCp4XSfxTPG+DlV3xXxwMMcvUll/1u3TZvCEAOd
+1/DQOwV0dLICBIqATH7QXCED2551WOUzg8m126ALEoxZkdzqM4GczNRB+dPRr2tF
+yqeLld2JIStuA2E556VHEhunnl3UVBaKn8wzBB+k1l4pMYwhbtCacftMnX7T2bAC
+xWOk7Qbt9ah+nfnRrCk5g+wG4CX9cJeijjNRIyoYEylPNVLKoAZsfVZzQpKCSqoS
+dd1gQ625p5cqcoP/b2wTb+YvpfubUyy00PeT3O0dbw+pt5BqF9UGOUUzPuBZs1WY
+CSB7vG1moPKOd1lt57P34DnMog++cuJhRvqCIyp2YBrwTeRlK0i5AY0EZfS4tgEM
+APdUOiGHZs/kUjaCE4Cu/ZpdE2fOffTYdN6QmWkPCVL/UeUZgo0Ll060GrxcGp9B
+gkFTi7xnR5KwqiZmc4d0frTQzpHFPzcB4C0tcF7Kx3YI4uH/9F99VP8nCrqcQEsT
+UZ4wPI40zzQdY6zX9bHnI50cty50pIr/WIsmN5Goku3DfeF7Xpak8I8SQELws0T4
+90Z+bqIf8yfRpxrmaAa4zhBQL4a1kWaZuFnx/8Qg9idbqE/Mw4QSwcMLyPv1GscQ
+4eMcLdNqwIE0JqolamOgawsdTbVPyAwt+jB01eCi+tlgOP+vYkoBlv3/YyCkYWwo
+saJHnn361zpclxi1Iljrp25oF/l3CIdRO3ikYkaShS6AtRJ6oGkJ55whdljvj9Ou
+Ai1tIQudakRL83teGLBjUWd1Qx3zAQgpAWCgaNwfK4bhucIna87EMqklCpjB/1AW
+1oIKgtYXI06udLlrjcbYQ+RPYPY8W8TSaf+GjYjFT30UGd4canR9o2FzuGo5BTC7
+lwARAQABiQG8BBgBCgAmFiEElzxobcDjEF5QHPI+2HLbca7sfdwFAmX0uLYCGwwF
+CQPCZwAACgkQ2HLbca7sfdxZ4Qv+OF2EGWTN5a9K1CoV3bhiY5v5I+TLBJNRychO
+A7A2WXk+6RZ5NnZwXm1skrS7ltjdqS8cIEUGl6UJGAYiynIznnA2GDrym5wgXV70
+3KtlTXGKYq7KsOTNmlWhbjCUYnQNT+mLqb7feBTZds2pK0UFJ6md2BVi0yEKnKmP
+0K1V/a06nDJgzusHrGzA5Zw/rn+EjB5shfH8VJeHm/h3iZgzBxgRhtu4zwghMOZC
+85SaoWLQeNM4OzoGupU/qO6KdF/H5mEvjAImLBdi/9tXd2/11z+6t7M+JslllESP
+QDx9LhywDKRHp1Dg2aE6xdY31OXdNodJWsms3/G2ktuSy7mGLUcHODdBBq6+1mZD
+lJ/6u+hwd4sVfbVrAFnXlaGRv5l3dY6qfeWt6JJAzYFiTjc62zUPCZqu9j/rCWKW
+vVboErjTKjlwIoRefcT0gXazGlhVz5W6Zmt0VfnDK7vs7CJqfvdtEsBwo7oM7mUW
+YyUHYw5Ev2zWMJyqITaogk47v3sv
+=/Wfp
+-----END PGP PUBLIC KEY BLOCK-----