Merge pull request #1 from codenamephp/initialImplementation

Initial release

.gitattributes

@@ -9,6 +9,7 @@
 /.gitignore export-ignore
 /.gitattributes export-ignore
 /.env.dist
+/deployer.phar export-ignore
 /docker-compose.yml export-ignore
 /infection.json.dist export-ignore
 /phive.xml export-ignore

.github/workflows/ci.yml

@@ -19,4 +19,4 @@ jobs:
   ci:
     uses: codenamephp/workflows.php/.github/workflows/ci.yml@1
     with:
-      php-versions: '["8.1","8.2]'
+      php-versions: '["8.1","8.2"]'

composer.json

@@ -10,7 +10,10 @@
     }
   ],
   "require": {
-    "php": "^8.1"
+    "php": "^8.1",
+    "codenamephp/deployer.base": "^3.0",
+    "codenamephp/platform.secretsmanager.base": "^1.0.1",
+    "deployer/deployer": "^7.2"
   },
   "autoload": {
     "psr-4": {
@@ -34,12 +37,11 @@
     "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 --threads=4 --no-progress --show-mutations",
     "ci-all": [
       "@phpunit",
       "@psalm",
       "@composer-unused",
-      "@composer-require-checker",
       "@infection"
     ]
   },
@@ -50,5 +52,8 @@
     "composer-require-checker": "Checks for missing required composer packages",
     "infection": "Creates mutation tests to discover missing test coverage",
     "ci-all": "Runs all ci tools in sequence"
+  },
+  "require-dev": {
+    "mockery/mockery": "^1.5"
   }
 }

deployer.phar

@@ -0,0 +1 @@
+vendor/deployer/deployer/dep

infection.json5.dist

@@ -14,5 +14,6 @@
     },
     "mutators": {
         "@default": true
-    }
+    },
+    "bootstrap":"./test/bootstrap.php"
 }

psalm.xml

@@ -24,6 +24,7 @@
   cacheDirectory=".cache/psalm"
   findUnusedBaselineEntry="true"
   findUnusedCode="true"
+  autoloader="./test/bootstrap.php"
 >
     <projectFiles>
         <directory name="src"/>

src/Settings/SettingsInterface.php

@@ -0,0 +1,72 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2023 Bastian Schwarz <[email protected]>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\secrets\Settings;
+
+use de\codenamephp\platform\secretsManager\base\Secret\SecretInterface;
+use Deployer\Host\Host;
+
+/**
+ * Interface to set settings either globally or on hosts
+ *
+ * @psalm-api
+ */
+interface SettingsInterface {
+
+  /**
+   * Resolves the given secret and sets it either on all hosts or if no hosts are given as a global setting
+   *
+   * Implementations should make use of the \de\codenamephp\platform\secretsManager\base\Client\ClientInterface to resolve the secret
+   *
+   * @param string $settingsKey The key to set the payload of the secret to
+   * @param SecretInterface $secret The secret to get the payload for
+   * @param Host ...$hosts Hosts to set the secret on. If no hosts are given the secret will be set globally
+   * @return void
+   */
+  public function set(string $settingsKey, SecretInterface $secret, Host ...$hosts) : void;
+
+  /**
+   * An array of settings keys and secrets to set. The array key is used as settings key.
+   *
+   * Resolves the given secrets and sets them either on all hosts or if no hosts are given as global settings
+   *
+   * Implementations should make use of the \de\codenamephp\platform\secretsManager\base\Client\ClientInterface to resolve the secrets
+   *
+   * @param array<string, SecretInterface> $secretsToSet The key/secrets mapping
+   * @param Host ...$hosts Hosts to set the secrets on. If no hosts are given the secrets will be set globally
+   * @return void
+   */
+  public function setMultiple(array $secretsToSet, Host ...$hosts) : void;
+
+  /**
+   * Fetches the payload content of the given secret. Implementations should use the \de\codenamephp\platform\secretsManager\base\Client\ClientInterface to
+   * resolve the secret
+   *
+   * @param SecretInterface $secret The secret to fetch the payload for
+   * @return string The payload content
+   */
+  public function fetch(SecretInterface $secret) : string;
+
+  /**
+   * Fetches the payload content of the given secrets. Implementations should use the \de\codenamephp\platform\secretsManager\base\Client\ClientInterface to
+   * resolve the secrets. Implementations MUST preserve the order and array keys of the given array as they may be used to identify the secrets
+   *
+   * @param array<SecretInterface> $secretsToResolve The secrets to fetch the payload for
+   * @return array<string> The payload content of the secrets with the keys preserved
+   */
+  public function fetchMultiple(array $secretsToResolve) : array;
+}