Merge pull request #141 from renoki-co/fix/encoding-in-exec-2.x

[fix/2.x] Typos & urlencode the command in exec

src/Instances/Probe.php

@@ -44,7 +44,7 @@ public function getCommand()
      *
      * @param  string  $path
      * @param  int  $port
-     * @param  array   $headers
+     * @param  array  $headers
      * @param  string  $scheme
      * @return $this
      */

src/Kinds/K8sEvent.php

@@ -48,6 +48,7 @@ public function setResource(K8sResource $resource)
      *
      * @param  array  $query
      * @return \RenokiCo\PhpK8s\Kinds\K8sResource
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     public function emitOrUpdate(array $query = ['pretty' => 1])

src/Kinds/K8sHorizontalPodAutoscaler.php

@@ -66,7 +66,7 @@ public function addMetric(ResourceMetric $metric)
     /**
      * Add multiple metrics in one batch.
      *
-     * @param  array $metrics
+     * @param  array  $metrics
      * @return $this
      */
     public function addMetrics(array $metrics)

src/Kinds/K8sResource.php

@@ -153,6 +153,7 @@ public function toJsonPayload(string $kind = null)
      * @param  Closure  $callback
      * @param  array  $query
      * @return mixed
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesWatchException
      */
     public function watchByName(string $name, Closure $callback, array $query = ['pretty' => 1])
@@ -166,6 +167,7 @@ public function watchByName(string $name, Closure $callback, array $query = ['pr
      * @param  string  $container
      * @param  array  $query
      * @return string
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesLogsException
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
@@ -181,6 +183,7 @@ public function containerLogs(string $container, array $query = ['pretty' => 1])
      * @param  Closure  $callback
      * @param  array  $query
      * @return string
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesLogsException
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
@@ -197,6 +200,7 @@ public function logsByName(string $name, array $query = ['pretty' => 1])
      * @param  Closure  $callback
      * @param  array  $query
      * @return string
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesLogsException
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
@@ -212,6 +216,7 @@ public function containerLogsByName(string $name, string $container, array $quer
      * @param  Closure  $callback
      * @param  array  $query
      * @return mixed
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesWatchException
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesLogsException
      */
@@ -226,6 +231,7 @@ public function watchContainerLogs(string $container, Closure $callback, array $
      * @param  Closure  $callback
      * @param  array  $query
      * @return mixed
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesWatchException
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesLogsException
      */
@@ -242,6 +248,7 @@ public function watchLogsByName(string $name, Closure $callback, array $query =
      * @param  Closure  $callback
      * @param  array  $query
      * @return mixed
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesWatchException
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesLogsException
      */

src/Kinds/K8sScale.php

@@ -76,7 +76,7 @@ public function refresh(array $query = ['pretty' => 1])
     }
 
     /**
-     * Make a call to teh cluster to get fresh original values.
+     * Make a call to the cluster to get fresh original values.
      *
      * @param  array  $query
      * @return $this

src/KubernetesCluster.php

@@ -270,6 +270,7 @@ protected function buildStreamContextOptions(): array
      * @param  string  $payload
      * @param  array  $query
      * @return \Psr\Http\Message\ResponseInterface
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     public function call(string $method, string $path, string $payload = '', array $query = ['pretty' => 1])
@@ -299,6 +300,7 @@ public function call(string $method, string $path, string $payload = '', array $
      * @param  string  $payload
      * @param  array  $query
      * @return mixed
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     protected function makeRequest(string $method, string $path, string $payload = '', array $query = ['pretty' => 1])
@@ -414,6 +416,7 @@ protected function makeWsRequest(string $path, Closure $callback = null, array $
      * @param  string|Closure  $payload
      * @param  array  $query
      * @return mixed
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     public function runOperation(string $operation, string $path, $payload = '', array $query = ['pretty' => 1])
@@ -434,7 +437,7 @@ public function runOperation(string $operation, string $path, $payload = '', arr
     /**
      * Watch for the current resource or a resource list.
      *
-     * @param  string   $path
+     * @param  string  $path
      * @param  Closure  $callback
      * @param  array  $query
      * @return bool
@@ -467,7 +470,7 @@ protected function watchPath(string $path, Closure $callback, array $query = ['p
     /**
      * Watch for the logs for the resource.
      *
-     * @param  string   $path
+     * @param  string  $path
      * @param  Closure  $callback
      * @param  array  $query
      * @return bool
@@ -497,6 +500,7 @@ protected function watchLogsPath(string $path, Closure $callback, array $query =
      * @param  string  $path
      * @param  array  $query
      * @return mixed
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     protected function execPath(
@@ -528,6 +532,7 @@ protected function execPath(
      * @param  Closure  $callback
      * @param  array  $query
      * @return mixed
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     protected function attachPath(

src/Traits/Cluster/ChecksClusterVersion.php

@@ -19,6 +19,7 @@ trait ChecksClusterVersion
      * Load the cluster version.
      *
      * @return void
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     protected function loadClusterVersion(): void

src/Traits/Cluster/LoadsFromKubeConfig.php

@@ -37,6 +37,7 @@ public static function setTempFolder(string $tempFolder)
      *
      * @param  string|null  $context
      * @return $this
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubeConfigClusterNotFound
      * @throws \RenokiCo\PhpK8s\Exceptions\KubeConfigContextNotFound
      * @throws \RenokiCo\PhpK8s\Exceptions\KubeConfigUserNotFound
@@ -104,6 +105,7 @@ public function fromKubeConfigYamlFile(string $path = '/.kube/config', string $c
      * @param  array  $kubeconfig
      * @param  string  $context
      * @return void
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubeConfigClusterNotFound
      * @throws \RenokiCo\PhpK8s\Exceptions\KubeConfigContextNotFound
      * @throws \RenokiCo\PhpK8s\Exceptions\KubeConfigUserNotFound
@@ -175,6 +177,7 @@ protected function loadKubeConfigFromArray(array $kubeconfig, string $context):
      * @param  string  $fileName
      * @param  string  $contents
      * @return string
+     *
      * @throws \Exception
      */
     protected function writeTempFileForContext(string $context, string $fileName, string $contents)

src/Traits/HasRules.php

@@ -41,7 +41,7 @@ public function addRules(array $rules)
      * Set the rules for the resource.
      *
      * @param  array  $rules
-     * @return  $this
+     * @return $this
      */
     public function setRules(array $rules)
     {

src/Traits/HasSubjects.php

@@ -41,7 +41,7 @@ public function addSubjects(array $subjects)
      * Set the subjects for the resource.
      *
      * @param  array  $subjects
-     * @return  $this
+     * @return $this
      */
     public function setSubjects(array $subjects)
     {

src/Traits/RunsClusterOperations.php

@@ -85,7 +85,7 @@ public function refresh(array $query = ['pretty' => 1])
     }
 
     /**
-     * Make a call to teh cluster to get fresh original values.
+     * Make a call to the cluster to get fresh original values.
      *
      * @param  array  $query
      * @return $this
@@ -96,8 +96,8 @@ public function refreshOriginal(array $query = ['pretty' => 1])
     }
 
     /**
-     * Create or update the resource according
-     * to the cluster availability.
+     * Create or update the resource, wether the resource exists
+     * or not within the cluster.
      *
      * @param  array  $query
      * @return $this
@@ -133,6 +133,7 @@ public function createOrUpdate(array $query = ['pretty' => 1])
      *
      * @param  array  $query
      * @return \RenokiCo\PhpK8s\ResourcesList
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     public function all(array $query = ['pretty' => 1])
@@ -152,6 +153,7 @@ public function all(array $query = ['pretty' => 1])
      *
      * @param  array  $query
      * @return \RenokiCo\PhpK8s\ResourcesList
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     public function allNamespaces(array $query = ['pretty' => 1])
@@ -167,10 +169,11 @@ public function allNamespaces(array $query = ['pretty' => 1])
     }
 
     /**
-     * Get a specific resource.
+     * Get a fresh instance from the cluster.
      *
      * @param  array  $query
      * @return \RenokiCo\PhpK8s\Kinds\K8sResource
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     public function get(array $query = ['pretty' => 1])
@@ -190,6 +193,7 @@ public function get(array $query = ['pretty' => 1])
      *
      * @param  array  $query
      * @return \RenokiCo\PhpK8s\Kinds\K8sResource
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     public function create(array $query = ['pretty' => 1])
@@ -209,6 +213,7 @@ public function create(array $query = ['pretty' => 1])
      *
      * @param  array  $query
      * @return bool
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     public function update(array $query = ['pretty' => 1]): bool
@@ -241,6 +246,7 @@ public function update(array $query = ['pretty' => 1]): bool
      * @param  null|int  $gracePeriod
      * @param  string  $propagationPolicy
      * @return bool
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
     public function delete(array $query = ['pretty' => 1], $gracePeriod = null, string $propagationPolicy = 'Foreground'): bool
@@ -278,6 +284,7 @@ public function delete(array $query = ['pretty' => 1], $gracePeriod = null, stri
      * @param  Closure  $callback
      * @param  array  $query
      * @return mixed
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesWatchException
      */
     public function watchAll(Closure $callback, array $query = ['pretty' => 1])
@@ -304,6 +311,7 @@ public function watchAll(Closure $callback, array $query = ['pretty' => 1])
      * @param  Closure  $callback
      * @param  array  $query
      * @return mixed
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesWatchException
      */
     public function watch(Closure $callback, array $query = ['pretty' => 1])
@@ -329,6 +337,7 @@ public function watch(Closure $callback, array $query = ['pretty' => 1])
      *
      * @param  array  $query
      * @return string
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesLogsException
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
@@ -356,6 +365,7 @@ public function logs(array $query = ['pretty' => 1])
      * @param  Closure  $callback
      * @param  array  $query
      * @return mixed
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesWatchException
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesLogsException
      */
@@ -390,6 +400,7 @@ public function watchLogs(Closure $callback, array $query = ['pretty' => 1])
      * Get a specific resource scaling data.
      *
      * @return \RenokiCo\PhpK8s\Kinds\K8sScale
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesScalingException
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
@@ -422,6 +433,7 @@ public function scaler(): K8sScale
      * @param  string|null  $container
      * @param  array  $query
      * @return string
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesExecException
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */
@@ -442,7 +454,7 @@ public function exec(
                 KubernetesCluster::EXEC_OP,
                 $this->resourceExecPath(),
                 '',
-                ['command' => $command, 'container' => $container] + $query
+                ['command' => array_map('urlencode', $command), 'container' => $container] + $query
             );
     }
 
@@ -453,6 +465,7 @@ public function exec(
      * @param  string|null  $container
      * @param  array  $query
      * @return string
+     *
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAttachException
      * @throws \RenokiCo\PhpK8s\Exceptions\KubernetesAPIException
      */

tests/PodTest.php

@@ -126,10 +126,12 @@ public function test_pod_exec()
             $pod->refresh();
         }
 
-        $messages = $pod->exec(['/bin/sh', '-c', 'ls -al'], 'busybox');
+        $messages = $pod->exec(['/bin/sh', '-c', 'echo 1 && echo 2 && echo 3'], 'busybox');
 
         $hasDesiredOutput = collect($messages)->where('channel', 'stdout')->filter(function ($message) {
-            return Str::contains($message['output'], '.dockerenv');
+            return Str::contains($message['output'], '1')
+                && Str::contains($message['output'], '2')
+                && Str::contains($message['output'], '3');
         })->isNotEmpty();
 
         $this->assertTrue($hasDesiredOutput);