Merge pull request #21 from pantheon-systems/CMS-1115

[CMS-1115] Warn users if an environment is passed in site_id.
pantheon-systems · Nov 22, 2022 · 4223377 · 4223377
2 parents c1a6dfd + 7acc008
commit 4223377
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/src/Commands/DeleteCommand.php b/src/Commands/DeleteCommand.php
@@ -39,6 +39,7 @@ class DeleteCommand extends SecretBaseCommand implements SiteAwareInterface
     public function deleteSecret($site_id, string $name, array $options = ['debug' => false])
     {
         $site = $this->getSite($site_id);
+        $this->warnIfEnvironmentPresent($site_id);
         $this->setupRequest();
         if ($this->secretsApi->deleteSecret($site->id, $name, $options['debug'])) {
             $this->log()->notice('Success');

diff --git a/src/Commands/ListCommand.php b/src/Commands/ListCommand.php
@@ -51,6 +51,7 @@ class ListCommand extends SecretBaseCommand implements SiteAwareInterface
     public function listSecrets($site_id, array $options = ['debug' => false,])
     {
         $site = $this->getSite($site_id);
+        $this->warnIfEnvironmentPresent($site_id);
         $this->setupRequest();
         $secrets = $this->secretsApi->listSecrets($site->id, $options['debug']);
         $print_options = [

diff --git a/src/Commands/SecretBaseCommand.php b/src/Commands/SecretBaseCommand.php
@@ -38,4 +38,17 @@ protected function setupRequest()
     {
         $this->secretsApi()->setRequest($this->request());
     }
+
+    /**
+     * Warn use if environment is present in site_id.
+     *
+     * @param string $site_id
+     *   Site ID.
+     */
+    protected function warnIfEnvironmentPresent(string $site_id)
+    {
+        if (preg_match('/.*\..*/', $site_id)) {
+            $this->log()->warning('Note: Secrets are available for all environments of a site. If you wish to specify secrets for different environments, we recommend using prefixes.');
+        }
+    }
 }
diff --git a/src/Commands/SetCommand.php b/src/Commands/SetCommand.php
@@ -47,6 +47,7 @@ public function setSecret($site_id, string $name, string $value, array $options
     ])
     {
         $site = $this->getSite($site_id);
+        $this->warnIfEnvironmentPresent($site_id);
         $this->setupRequest();
         if ($this->secretsApi->setSecret(
             $site->id,