Added basic classes and interface

Bastian Schwarz · Bastian Schwarz · commit 1f79570e004b · 2023-03-08T10:16:53.000+01:00
diff --git a/.idea/php-test-framework.xml b/.idea/php-test-framework.xml
diff --git a/.idea/php.xml b/.idea/php.xml
diff --git a/.idea/runConfigurations/All.xml b/.idea/runConfigurations/All.xml
diff --git a/composer.json b/composer.json
@@ -34,7 +34,7 @@
     "psalm": "tools/psalm --threads=10 --long-progress",
     "composer-unused": "tools/composer-unused --no-progress --no-interaction",
     "composer-require-checker": "tools/composer-require-checker --no-interaction",
-    "infection": "XDEBUG_MODE=coverage tools/infection --min-msi=95 --min-covered-msi=95 --threads=4 --no-progress --show-mutations",
+    "infection": "XDEBUG_MODE=coverage tools/infection --min-msi=100 --min-covered-msi=100 --no-progress --show-mutations",
     "ci-all": [
       "@phpunit",
       "@psalm",
diff --git a/psalm.xml b/psalm.xml
@@ -23,7 +23,7 @@
   xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
   cacheDirectory=".cache/psalm"
   findUnusedBaselineEntry="true"
-  findUnusedCode="true"
+  findUnusedCode="false"
 >
     <projectFiles>
         <directory name="src"/>
diff --git a/src/Client/ClientInterface.php b/src/Client/ClientInterface.php
@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\secrets\base\Client;
+
+use de\codenamephp\deployer\secrets\base\Secret\Payload\PayloadInterface;
+use de\codenamephp\deployer\secrets\base\Secret\SecretInterface;
+
+/**
+ * Interface for a common client that fetches payloads (since the payload is what we care about here)
+ */
+interface ClientInterface {
+
+  /**
+   * Sends a request to the Secret Manager to fetch the payload of a secret
+   *
+   * @param SecretInterface $secret The secret of the payload
+   * @return PayloadInterface
+   */
+  public function fetchPayload(SecretInterface $secret) : PayloadInterface;
+}
diff --git a/src/Secret/Payload/Factory/FactoryInterface.php b/src/Secret/Payload/Factory/FactoryInterface.php
@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\secrets\base\Secret\Payload\Factory;
+
+use de\codenamephp\deployer\secrets\base\Secret\Payload\PayloadInterface;
+
+interface FactoryInterface {
+
+  public function build(string $content): PayloadInterface;
+}
diff --git a/src/Secret/Payload/Factory/Sealed.php b/src/Secret/Payload/Factory/Sealed.php
@@ -0,0 +1,12 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\secrets\base\Secret\Payload\Factory;
+
+use de\codenamephp\deployer\secrets\base\Secret\Payload\PayloadInterface;
+
+final class Sealed implements FactoryInterface {
+
+  public function build(string $content) : PayloadInterface {
+    return new \de\codenamephp\deployer\secrets\base\Secret\Payload\Sealed($content);
+  }
+}
diff --git a/src/Secret/Payload/PayloadInterface.php b/src/Secret/Payload/PayloadInterface.php
@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\secrets\base\Secret\Payload;
+
+/**
+ * Interface for a payload of a secret. Contains the content as string and checksums
+ */
+interface PayloadInterface {
+
+  /**
+   * Gets the secret payload as string (so the thing you actually want to use)
+   *
+   * @return string
+   */
+  public function getContent() : string;
+}
diff --git a/src/Secret/Payload/Sealed.php b/src/Secret/Payload/Sealed.php
@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\secrets\base\Secret\Payload;
+
+/**
+ * Read-only class for a sealed secret payload
+ */
+final class Sealed implements PayloadInterface {
+
+  public function __construct(public readonly string $content) {}
+
+  public function getContent() : string {
+    return $this->content;
+  }
+}
diff --git a/src/Secret/Sealed.php b/src/Secret/Sealed.php
@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\secrets\base\Secret;
+
+use InvalidArgumentException;
+
+final class Sealed implements SecretInterface {
+
+  public function __construct(public readonly string $name,
+                              public readonly string $project,
+                              public readonly string $version = 'latest') {
+    match (true) {
+      $name === '' => throw new InvalidArgumentException('Name must not be empty'),
+      $project === '' => throw new InvalidArgumentException('Project must not be empty'),
+      $this->version === '' => throw new InvalidArgumentException('Version must not be empty'),
+      default => null
+    };
+  }
+
+  public function getName() : string {
+    return $this->name;
+  }
+
+  public function getProject() : string {
+    return $this->project;
+  }
+
+  public function getVersion() : string {
+    return $this->version;
+  }
+}
diff --git a/src/Secret/SecretInterface.php b/src/Secret/SecretInterface.php
@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\secrets\base\Secret;
+
+
+/**
+ * Simple interface for a secret. Most secrets managers need a name, a project the secret is in a version to get for the secret.
+ */
+interface SecretInterface {
+
+  /**
+   * @return string The name of the secret in the Secrets Manager
+   */
+  public function getName() : string;
+
+  /**
+   * @return string The project the secret is in the Secrets Manager
+   */
+  public function getProject() : string;
+
+  /**
+   * @return string The version of the secret te get, should default to latest
+   */
+  public function getVersion() : string;
+}
diff --git a/src/Secret/WithPayloadInterface.php b/src/Secret/WithPayloadInterface.php
@@ -0,0 +1,18 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\secrets\base\Secret;
+
+use de\codenamephp\deployer\secrets\base\Secret\Payload\PayloadInterface;
+
+/**
+ * Interface for a secret that has a payload
+ */
+interface WithPayloadInterface extends SecretInterface {
+
+  /**
+   * Gets the payload that belongs to the secret
+   *
+   * @return PayloadInterface
+   */
+  public function getPayload(): PayloadInterface;
+}
diff --git a/test/Secret/Payload/SealedTest.php b/test/Secret/Payload/SealedTest.php
@@ -0,0 +1,21 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\secrets\base\test\Secret\Payload;
+
+use de\codenamephp\deployer\secrets\base\Secret\Payload\Sealed;
+use PHPUnit\Framework\TestCase;
+
+final class SealedTest extends TestCase {
+
+  public function test__construct() : void {
+    $sut = new Sealed('some content');
+
+    self::assertSame('some content', $sut->content);
+  }
+
+  public function testGetContent() : void {
+    $sut = new Sealed('some content');
+
+    self::assertSame('some content', $sut->getContent());
+  }
+}
diff --git a/test/Secret/SealedTest.php b/test/Secret/SealedTest.php
@@ -0,0 +1,65 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\secrets\base\test\Secret;
+
+use de\codenamephp\deployer\secrets\base\Secret\Sealed;
+use InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
+
+final class SealedTest extends TestCase {
+
+  public function testGetName() : void {
+    $sut = new Sealed('name', 'project', 'version');
+
+    self::assertSame('name', $sut->getName());
+  }
+
+  public function test__construct() : void {
+    $sut = new Sealed('name', 'project');
+
+    self::assertSame('name', $sut->name);
+    self::assertSame('project', $sut->project);
+    self::assertSame('latest', $sut->version);
+  }
+
+  public function test__construct_withVersion() : void {
+    $sut = new Sealed('name', 'project', 'version');
+
+    self::assertSame('name', $sut->name);
+    self::assertSame('project', $sut->project);
+    self::assertSame('version', $sut->version);
+  }
+
+  public function test__construct_withEmptyName() : void {
+    $this->expectException(InvalidArgumentException::class);
+    $this->expectExceptionMessage('Name must not be empty');
+
+    new Sealed('', 'project', 'version');
+  }
+
+  public function test__construct_withEmptyProject() : void {
+    $this->expectException(InvalidArgumentException::class);
+    $this->expectExceptionMessage('Project must not be empty');
+
+    new Sealed('name', '', 'version');
+  }
+
+  public function test__construct_withEmptyVersion() : void {
+    $this->expectException(InvalidArgumentException::class);
+    $this->expectExceptionMessage('Version must not be empty');
+
+    new Sealed('name', 'project', '');
+  }
+
+  public function testGetProject() : void {
+    $sut = new Sealed('name', 'project', 'version');
+
+    self::assertSame('project', $sut->getProject());
+  }
+
+  public function testGetVersion() : void {
+    $sut = new Sealed('name', 'project', 'version');
+
+    self::assertSame('version', $sut->getVersion());
+  }
+}
diff --git a/test/phpunit.dist.xml b/test/phpunit.dist.xml
@@ -15,8 +15,12 @@
   ~ limitations under the License.
   ~
   -->
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" bootstrap="./../vendor/autoload.php"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         colors="true"
+         bootstrap="./../vendor/autoload.php"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
+         cacheDirectory="../.cache/phpunit"
+>
   <coverage>
     <include>
       <directory suffix=".php">./../src</directory>

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"`
`24`	`24`	`cacheDirectory=".cache/psalm"`
`25`	`25`	`findUnusedBaselineEntry="true"`
`26`		`- findUnusedCode="true"`
	`26`	`+ findUnusedCode="false"`
`27`	`27`	`>`
`28`	`28`	`<projectFiles>`
`29`	`29`	`<directory name="src"/>`