Merge pull request #86 from RoussKS/main

Allow JSON Format Ansible --extra-vars

Author: maschmann

Asm/Ansible/Ansible.php

@@ -12,7 +12,6 @@
 use Asm\Ansible\Process\ProcessBuilder;
 use Asm\Ansible\Process\ProcessBuilderInterface;
 use Asm\Ansible\Utils\Env;
-use JetBrains\PhpStorm\Pure;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\NullLogger;

Asm/Ansible/Command/AnsiblePlaybook.php

@@ -4,7 +4,9 @@
 
 namespace Asm\Ansible\Command;
 
+use Asm\Ansible\Utils\Str;
 use InvalidArgumentException;
+use JsonException;
 
 /**
  * Class AnsiblePlaybook
@@ -210,6 +212,21 @@ public function extraVars(string|array $extraVars = ''): AnsiblePlaybookInterfac
             throw new InvalidArgumentException(sprintf('Expected string|array, got "%s"', gettype($extraVars)));
         }
 
+        // Trim the string & check if empty before moving on.
+        $extraVars = trim($extraVars);
+
+        if ($extraVars === '') {
+            return $this;
+        }
+
+        // JSON formatted string can be used for extra vars as is.
+        // The value is automatically escaped & wrapped around single quotes from the Library's process.
+        if (Str::isJsonFormatted($extraVars)) {
+            $this->addOption('--extra-vars', $extraVars);
+
+            return $this;
+        }
+
         if (!str_contains($extraVars, '=')) {
             throw new InvalidArgumentException('The extra vars raw string should be in the "key=value" form.');
         }

Asm/Ansible/Utils/Str.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Asm\Ansible\Utils;
+
+use JsonException;
+
+class Str
+{
+    /**
+     * Validate the provided string is JSON formatted.
+     *
+     * Not JSON if result is not an object (stdClass).
+     * Silent return false on exceptions e.g. Invalid/Incorrect encoding, Array depth more than 512 etc.
+     *
+     * @param string $value
+     * @return bool
+     */
+    public static function isJsonFormatted(string $value): bool
+    {
+        try {
+            return is_object(json_decode($value, false, 512, JSON_THROW_ON_ERROR));
+        } catch (JsonException) {
+            return false;
+        }
+    }
+}

Tests/Asm/Ansible/Command/AnsiblePlaybookTest.php

@@ -801,14 +801,21 @@ public function testExtraVars(): void
         //$playbookFile = $this->getSamplesPathFor(AnsiblePlaybook::class) . '/playbook1.yml';
 
         $tests = [
+            // Test empty strings (with & without spaces).
             [
                 'input' => '',
                 'expect' => false,
             ],
+            [
+                'input' => '   ',
+                'expect' => false,
+            ],
+            // Test empty array.
             [
                 'input' => [],
                 'expect' => false,
             ],
+            // Test Arrays
             [
                 'input' => ['key' => 'value'],
                 'expect' => '--extra-vars=key=value',
@@ -817,6 +824,12 @@ public function testExtraVars(): void
                 'input' => ['key1' => 'value1', 'key2' => 'value2'],
                 'expect' => '--extra-vars=key1=value1 key2=value2',
             ],
+            // Test valid JSON.
+            [
+                'input' => '{ "key1": "value1", "key2": "value2" }',
+                'expect' => '--extra-vars={ "key1": "value1", "key2": "value2" }',
+            ],
+            // Test key value string.
             [
                 'input' => 'key=value',
                 'expect' => '--extra-vars=key=value',
@@ -854,7 +867,8 @@ public function testExtraVars(): void
 
         $tests = [
             'string without equals',
-            new DateTime()
+            '{ key1: "value1" }', // Invalid JSON syntax (missing " from key1) which would trigger string without `=`.
+            new DateTime() // Invalid type
         ];
 
         foreach ($tests as $input) {

Tests/Asm/Ansible/Utils/StrTest.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Asm\Ansible\Utils;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @group utils
+ */
+class StrTest extends TestCase
+{
+    /**
+     * Assert valid JSON string is correctly checked.
+     *
+     * @return void
+     */
+    public function testJsonWithValidFormat(): void
+    {
+        $value = '{ "key1": "value1" }';
+
+        $this->assertTrue(Str::isJsonFormatted($value));
+    }
+
+    /**
+     * Assert string is not valid JSON.
+     *
+     * @return void
+     */
+    public function testStringIsNotJson(): void
+    {
+        $value = 'something';
+
+        $this->assertFalse(Str::isJsonFormatted($value));
+    }
+}