v2.0.1-alpha merge (#40)

* refactor to 7.2, typed params * fix phpdoc * add feature completeness for ansible 2 * remove travis support for older versions * remove hhvm completely
maschmann · Dec 17, 2018 · 386909e · 386909e
1 parent ce8f56e
commit 386909e
Show file tree

Hide file tree

Showing 10 changed files with 89 additions and 53 deletions.
diff --git a/Ansible/Command/AbstractAnsibleCommand.php b/Ansible/Command/AbstractAnsibleCommand.php
@@ -162,10 +162,10 @@ protected function checkParam($param, string $glue = ' '): string
     /**
      * Creates process with processBuilder builder and executes it.
      *
-     * @param null $callback
+     * @param callable|null $callback
      * @return int|string
      */
-    protected function runProcess($callback)
+    protected function runProcess($callback = null)
     {
         $process = $this->processBuilder
             ->setArguments(

diff --git a/Ansible/Command/AnsibleCommandInterface.php b/Ansible/Command/AnsibleCommandInterface.php
@@ -22,7 +22,7 @@ interface AnsibleCommandInterface
      * Executes a command process.
      * Returns either exitcode or string output if no callback is given.
      *
-     * @param null $callback
+     * @param callable|null $callback
      * @return integer|string
      */
     public function execute($callback = null);

diff --git a/Ansible/Command/AnsibleGalaxy.php b/Ansible/Command/AnsibleGalaxy.php
@@ -23,7 +23,7 @@ final class AnsibleGalaxy extends AbstractAnsibleCommand implements AnsibleGalax
      * Executes a command process.
      * Returns either exitcode or string output if no callback is given.
      *
-     * @param null $callback
+     * @param callable|null $callback
      * @return integer|string
      */
     public function execute($callback = null)

diff --git a/Ansible/Command/AnsiblePlaybook.php b/Ansible/Command/AnsiblePlaybook.php
@@ -27,7 +27,7 @@ final class AnsiblePlaybook extends AbstractAnsibleCommand implements AnsiblePla
      * Executes a command process.
      * Returns either exitcode or string output if no callback is given.
      *
-     * @param null $callback
+     * @param callable|null $callback
      * @return integer|string
      */
     public function execute($callback = null)
@@ -98,6 +98,32 @@ public function askVaultPass(): AnsiblePlaybookInterface
         return $this;
     }
 
+    /**
+     * Enable privilege escalation
+     *
+     * @return AnsiblePlaybookInterface
+     * @see http://docs.ansible.com/ansible/become.html
+     */
+    public function become(): AnsiblePlaybookInterface
+    {
+        $this->addParameter('--become');
+
+        return $this;
+    }
+
+    /**
+     * Desired sudo user (default=root).
+     *
+     * @param string $user
+     * @return AnsiblePlaybookInterface
+     */
+    public function becomeUser(string $user = 'root'): AnsiblePlaybookInterface
+    {
+        $this->addOption('--become-user', $user);
+
+        return $this;
+    }
+
     /**
      * Don't make any changes; instead, try to predict some of the changes that may occur.
      *
@@ -274,7 +300,7 @@ public function noCows(): AnsiblePlaybookInterface
      */
     public function colors(bool $colors = true): AnsiblePlaybookInterface
     {
-        $this->processBuilder->setEnv('ANSIBLE_FORCE_COLOR', $colors);
+        $this->processBuilder->setEnv('ANSIBLE_FORCE_COLOR', intval($colors));
     }
 
     /**
@@ -299,7 +325,6 @@ public function privateKey(string $file): AnsiblePlaybookInterface
     public function skipTags($tags = ''): AnsiblePlaybookInterface
     {
         $tags = $this->checkParam($tags, ',');
-
         $this->addOption('--skip-tags', $tags);
 
         return $this;
@@ -355,32 +380,6 @@ public function suUser(string $user = 'root'): AnsiblePlaybookInterface
         return $this;
     }
 
-    /**
-     * Enable privilege escalation
-     *
-     * @return AnsiblePlaybookInterface
-     * @see http://docs.ansible.com/ansible/become.html
-     */
-    public function become(): AnsiblePlaybookInterface
-    {
-        $this->addParameter('--become');
-
-        return $this;
-    }
-
-    /**
-     * Desired sudo user (default=root).
-     *
-     * @param string $user
-     * @return AnsiblePlaybookInterface
-     */
-    public function becomeUser(string $user = 'root'): AnsiblePlaybookInterface
-    {
-        $this->addOption('--become-user', $user);
-
-        return $this;
-    }
-
     /**
      * Perform a syntax check on the playbook, but do not execute it.
      *
@@ -402,7 +401,6 @@ public function syntaxCheck(): AnsiblePlaybookInterface
     public function tags($tags): AnsiblePlaybookInterface
     {
         $tags = $this->checkParam($tags, ',');
-
         $this->addOption('--tags', $tags);
 
         return $this;
@@ -513,11 +511,12 @@ public function newVaultPasswordFile(string $passwordFile): AnsiblePlaybookInter
     /**
      * specify extra arguments to pass to scp only (e.g. -l)
      *
-     * @param string $scpExtraArgs
+     * @param string|array $scpExtraArgs
      * @return AnsiblePlaybookInterface
      */
-    public function scpExtraArgs(string $scpExtraArgs): AnsiblePlaybookInterface
+    public function scpExtraArgs($scpExtraArgs): AnsiblePlaybookInterface
     {
+        $scpExtraArgs = $this->checkParam($scpExtraArgs, ',');
         $this->addOption('--scp-extra-args', $scpExtraArgs);
 
         return $this;
@@ -526,11 +525,12 @@ public function scpExtraArgs(string $scpExtraArgs): AnsiblePlaybookInterface
     /**
      * specify extra arguments to pass to sftp only (e.g. -f, -l)
      *
-     * @param string $sftpExtraArgs
+     * @param string|array $sftpExtraArgs
      * @return AnsiblePlaybookInterface
      */
-    public function sftpExtraArgs(string $sftpExtraArgs): AnsiblePlaybookInterface
+    public function sftpExtraArgs($sftpExtraArgs): AnsiblePlaybookInterface
     {
+        $sftpExtraArgs = $this->checkParam($sftpExtraArgs, ',');
         $this->addOption('--sftp-extra-args', $sftpExtraArgs);
 
         return $this;
@@ -539,11 +539,12 @@ public function sftpExtraArgs(string $sftpExtraArgs): AnsiblePlaybookInterface
     /**
      * specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)
      *
-     * @param string $sshArgs
+     * @param string|array $sshArgs
      * @return AnsiblePlaybookInterface
      */
-    public function sshCommonArgs(string $sshArgs): AnsiblePlaybookInterface
+    public function sshCommonArgs($sshArgs): AnsiblePlaybookInterface
     {
+        $sshArgs = $this->checkParam($sshArgs, ',');
         $this->addOption('--ssh-common-args', $sshArgs);
 
         return $this;
@@ -552,11 +553,12 @@ public function sshCommonArgs(string $sshArgs): AnsiblePlaybookInterface
     /**
      * specify extra arguments to pass to ssh only (e.g. -R)
      *
-     * @param string $extraArgs
+     * @param string|array $extraArgs
      * @return AnsiblePlaybookInterface
      */
-    public function sshExtraArgs(string $extraArgs): AnsiblePlaybookInterface
+    public function sshExtraArgs($extraArgs): AnsiblePlaybookInterface
     {
+        $extraArgs = $this->checkParam($extraArgs, ',');
         $this->addOption('--ssh-extra-args', $extraArgs);
 
         return $this;

diff --git a/Ansible/Command/AnsiblePlaybookInterface.php b/Ansible/Command/AnsiblePlaybookInterface.php
@@ -248,34 +248,34 @@ public function suUser(string $user = 'root'): AnsiblePlaybookInterface;
     /**
      * specify extra arguments to pass to scp only (e.g. -l)
      *
-     * @param string $scpExtraArgs
+     * @param string|array $scpExtraArgs
      * @return AnsiblePlaybookInterface
      */
-    public function scpExtraArgs(string $scpExtraArgs): AnsiblePlaybookInterface;
+    public function scpExtraArgs($scpExtraArgs): AnsiblePlaybookInterface;
 
     /**
      * specify extra arguments to pass to sftp only (e.g. -f, -l)
      *
-     * @param string $sftpExtraArgs
+     * @param string|array $sftpExtraArgs
      * @return AnsiblePlaybookInterface
      */
-    public function sftpExtraArgs(string $sftpExtraArgs): AnsiblePlaybookInterface;
+    public function sftpExtraArgs($sftpExtraArgs): AnsiblePlaybookInterface;
 
     /**
      * specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)
      *
-     * @param string $sshArgs
+     * @param string|array $sshArgs
      * @return AnsiblePlaybookInterface
      */
-    public function sshCommonArgs(string $sshArgs): AnsiblePlaybookInterface;
+    public function sshCommonArgs($sshArgs): AnsiblePlaybookInterface;
 
     /**
      * specify extra arguments to pass to ssh only (e.g. -R)
      *
-     * @param string $extraArgs
+     * @param string|array $extraArgs
      * @return AnsiblePlaybookInterface
      */
-    public function sshExtraArgs(string $extraArgs): AnsiblePlaybookInterface;
+    public function sshExtraArgs($extraArgs): AnsiblePlaybookInterface;
 
     /**
      * Perform a syntax check on the playbook, but do not execute it.

diff --git a/Ansible/Process/ProcessBuilder.php b/Ansible/Process/ProcessBuilder.php
@@ -37,6 +37,13 @@ class ProcessBuilder implements ProcessBuilderInterface
     private $path;
 
     /**
+
+     * @var array
+     */
+    private $envVars;
+
+    /**
+
      * ProcessBuilder constructor.
      *
      * @param string $prefix
@@ -47,6 +54,7 @@ public function __construct(string $prefix, string $path)
         $this->arguments = [$prefix];
         $this->path = $path;
         $this->timeout = 900;
+        $this->envVars = [];
     }
 
     /**
@@ -72,6 +80,19 @@ public function setTimeout(int $timeout): ProcessBuilderInterface
     }
 
     /**
+     * @param string $name name of ENV VAR
+     * @param string $value
+     * @return ProcessBuilderInterface
+     */
+    public function setEnv(string $name, string $value): ProcessBuilderInterface
+    {
+        $this->envVars[$name] = $value;
+
+        return $this;
+    }
+
+    /**
+
      * @return Process
      */
     public function getProcess(): Process
@@ -81,6 +102,8 @@ public function getProcess(): Process
                 $this->arguments,
                 $this->path
             )
-        )->setTimeout($this->timeout);
+        )
+        ->setTimeout($this->timeout)
+        ->setEnv($this->envVars);
     }
 }
diff --git a/Ansible/Process/ProcessBuilderInterface.php b/Ansible/Process/ProcessBuilderInterface.php
@@ -31,6 +31,13 @@ public function setArguments(array $arguments): ProcessBuilderInterface;
      */
     public function setTimeout(int $timeout): ProcessBuilderInterface;
 
+    /**
+     * @param string $name name of ENV VAR
+     * @param string $value
+     * @return ProcessBuilderInterface
+     */
+    public function setEnv(string $name, string $value): ProcessBuilderInterface;
+
     /**
      * @return Process
      */

diff --git a/Tests/Ansible/Command/AnsibleGalaxyTest.php b/Tests/Ansible/Command/AnsibleGalaxyTest.php
@@ -37,6 +37,9 @@ public function testCreateInstance()
     public function testExecute(AnsibleGalaxyInterface $command)
     {
         $command->execute();
+
+        // if command executes without exception
+        $this->assertTrue(true);
     }
 
     public function testInit()

diff --git a/Tests/Ansible/Command/AnsiblePlaybookTest.php b/Tests/Ansible/Command/AnsiblePlaybookTest.php
@@ -770,9 +770,9 @@ public function testExecuteWithCallback(AnsiblePlaybookInterface $command)
         $exitcode = $command
             ->execute(function ($type, $buffer) {
                 if (Process::ERR === $type) {
-                    echo 'ERR > '.$buffer;
+                    $out = 'ERR > '.$buffer;
                 } else {
-                    echo 'OUT > '.$buffer;
+                    $out = 'OUT > '.$buffer;
                 }
             });
 

diff --git a/Tests/Ansible/Process/ProcessBuilderTest.php b/Tests/Ansible/Process/ProcessBuilderTest.php
@@ -38,6 +38,7 @@ public function testGetProcess(ProcessBuilderInterface $processBuilder)
     {
         $process = $processBuilder
             ->setArguments([])
+            ->setEnv('SOME', 'value')
             ->setTimeout(5)
             ->getProcess();