Merge pull request #32 from renoki-co/feature/get-pods

rennokki · web-flow · commit ace92d88cb1a · 2020-10-30T09:25:19.000+02:00
[feature] Get pods
diff --git a/docs/kinds/Deployment.md b/docs/kinds/Deployment.md
@@ -100,3 +100,13 @@ $pod = $dep->getTemplate(false);
 
 $podName = $template['name'];
 ```
+
+### Deployment's Pods
+
+You can retrieve the pods as resources controlled by the Deployment by issuing `->getPods()`:
+
+```php
+foreach ($dep->getPods() as $pod) {
+    // $pod->logs()
+}
+```
diff --git a/docs/kinds/Job.md b/docs/kinds/Job.md
@@ -125,3 +125,13 @@ $pod = $job->getTemplate(false);
 
 $podName = $template['name'];
 ```
+
+### Job's Pods
+
+You can retrieve the pods as resources controlled by the Job by issuing `->getPods()`:
+
+```php
+foreach ($job->getPods() as $pod) {
+    // $pod->logs()
+}
+```
diff --git a/docs/kinds/StatefulSet.md b/docs/kinds/StatefulSet.md
@@ -116,3 +116,13 @@ $pod = $sts->getTemplate(false);
 
 $podName = $template['name'];
 ```
+
+### StatefulSet's Pods
+
+You can retrieve the pods as resources controlled by the Statefulset by issuing `->getPods()`:
+
+```php
+foreach ($sts->getPods() as $pod) {
+    // $pod->logs()
+}
+```
diff --git a/src/Contracts/Podable.php b/src/Contracts/Podable.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace RenokiCo\PhpK8s\Contracts;
+
+interface Podable
+{
+    /**
+     * Get the selector for the pods that are owned by this resource.
+     *
+     * @return array
+     */
+    public function podsSelector(): array;
+}
diff --git a/src/Kinds/K8sDeployment.php b/src/Kinds/K8sDeployment.php
@@ -3,16 +3,18 @@
 namespace RenokiCo\PhpK8s\Kinds;
 
 use RenokiCo\PhpK8s\Contracts\InteractsWithK8sCluster;
+use RenokiCo\PhpK8s\Contracts\Podable;
 use RenokiCo\PhpK8s\Contracts\Watchable;
 use RenokiCo\PhpK8s\Traits\HasAnnotations;
 use RenokiCo\PhpK8s\Traits\HasLabels;
+use RenokiCo\PhpK8s\Traits\HasPods;
 use RenokiCo\PhpK8s\Traits\HasSelector;
 use RenokiCo\PhpK8s\Traits\HasSpec;
 use RenokiCo\PhpK8s\Traits\HasTemplate;
 
-class K8sDeployment extends K8sResource implements InteractsWithK8sCluster, Watchable
+class K8sDeployment extends K8sResource implements InteractsWithK8sCluster, Podable, Watchable
 {
-    use HasAnnotations, HasLabels, HasSelector, HasSpec, HasTemplate;
+    use HasAnnotations, HasLabels, HasPods, HasSelector, HasSpec, HasTemplate;
 
     /**
      * The resource Kind parameter.
@@ -95,4 +97,16 @@ public function resourceWatchPath(): string
     {
         return "/apis/{$this->getApiVersion()}/watch/namespaces/{$this->getNamespace()}/deployments/{$this->getIdentifier()}";
     }
+
+    /**
+     * Get the selector for the pods that are owned by this resource.
+     *
+     * @return array
+     */
+    public function podsSelector(): array
+    {
+        return [
+            'deployment-name' => $this->getName(),
+        ];
+    }
 }
diff --git a/src/Kinds/K8sJob.php b/src/Kinds/K8sJob.php
@@ -3,16 +3,18 @@
 namespace RenokiCo\PhpK8s\Kinds;
 
 use RenokiCo\PhpK8s\Contracts\InteractsWithK8sCluster;
+use RenokiCo\PhpK8s\Contracts\Podable;
 use RenokiCo\PhpK8s\Contracts\Watchable;
 use RenokiCo\PhpK8s\Traits\HasAnnotations;
 use RenokiCo\PhpK8s\Traits\HasLabels;
+use RenokiCo\PhpK8s\Traits\HasPods;
 use RenokiCo\PhpK8s\Traits\HasSelector;
 use RenokiCo\PhpK8s\Traits\HasSpec;
 use RenokiCo\PhpK8s\Traits\HasTemplate;
 
-class K8sJob extends K8sResource implements InteractsWithK8sCluster, Watchable
+class K8sJob extends K8sResource implements InteractsWithK8sCluster, Podable, Watchable
 {
-    use HasAnnotations, HasLabels, HasSelector, HasSpec, HasTemplate;
+    use HasAnnotations, HasLabels, HasPods, HasSelector, HasSpec, HasTemplate;
 
     /**
      * The resource Kind parameter.
@@ -85,4 +87,16 @@ public function resourceWatchPath(): string
     {
         return "/apis/{$this->getApiVersion()}/watch/namespaces/{$this->getNamespace()}/jobs/{$this->getIdentifier()}";
     }
+
+    /**
+     * Get the selector for the pods that are owned by this resource.
+     *
+     * @return array
+     */
+    public function podsSelector(): array
+    {
+        return [
+            'job-name' => $this->getName(),
+        ];
+    }
 }
diff --git a/src/Kinds/K8sResource.php b/src/Kinds/K8sResource.php
@@ -270,11 +270,12 @@ public function whereName(string $name)
      * Get a resource by name.
      *
      * @param  string  $name
+     * @param  array  $query
      * @return \RenokiCo\PhpK8s\Kinds\K8sResource
      */
-    public function getByName(string $name)
+    public function getByName(string $name, array $query = ['pretty' => 1])
     {
-        return $this->whereName($name)->get();
+        return $this->whereName($name)->get($query);
     }
 
     /**
diff --git a/src/Kinds/K8sStatefulSet.php b/src/Kinds/K8sStatefulSet.php
@@ -3,16 +3,18 @@
 namespace RenokiCo\PhpK8s\Kinds;
 
 use RenokiCo\PhpK8s\Contracts\InteractsWithK8sCluster;
+use RenokiCo\PhpK8s\Contracts\Podable;
 use RenokiCo\PhpK8s\Contracts\Watchable;
 use RenokiCo\PhpK8s\Traits\HasAnnotations;
 use RenokiCo\PhpK8s\Traits\HasLabels;
+use RenokiCo\PhpK8s\Traits\HasPods;
 use RenokiCo\PhpK8s\Traits\HasSelector;
 use RenokiCo\PhpK8s\Traits\HasSpec;
 use RenokiCo\PhpK8s\Traits\HasTemplate;
 
-class K8sStatefulSet extends K8sResource implements InteractsWithK8sCluster, Watchable
+class K8sStatefulSet extends K8sResource implements InteractsWithK8sCluster, Podable, Watchable
 {
-    use HasAnnotations, HasLabels, HasSelector, HasSpec, HasTemplate;
+    use HasAnnotations, HasLabels, HasPods, HasSelector, HasSpec, HasTemplate;
 
     /**
      * The resource Kind parameter.
@@ -156,4 +158,16 @@ public function resourceWatchPath(): string
     {
         return "/apis/{$this->getApiVersion()}/watch/namespaces/{$this->getNamespace()}/statefulsets/{$this->getIdentifier()}";
     }
+
+    /**
+     * Get the selector for the pods that are owned by this resource.
+     *
+     * @return array
+     */
+    public function podsSelector(): array
+    {
+        return [
+            'statefulset-name' => $this->getName(),
+        ];
+    }
 }
diff --git a/src/KubernetesCluster.php b/src/KubernetesCluster.php
@@ -86,11 +86,11 @@ public function __call($method, $parameters)
             if (method_exists(K8s::class, $resource)) {
                 return $this->{$resource}()
                     ->whereNamespace($parameters[1] ?? K8sResource::$defaultNamespace)
-                    ->getByName($parameters[0]);
+                    ->getByName($parameters[0], $parameters[3] ?? ['pretty' => 1]);
             }
         }
 
-        // Proxy the ->getAll[Resources]($namespace = 'default')
+        // Proxy the ->getAll[Resources]($namespace = 'default', $query = [...])
         // For example, ->getAllServices('staging')
         if (preg_match('/getAll(.+)/', $method, $matches)) {
             [$method, $resourcePlural] = $matches;
@@ -100,7 +100,7 @@ public function __call($method, $parameters)
             if (method_exists(K8s::class, $resource)) {
                 return $this->{$resource}()
                     ->whereNamespace($parameters[1] ?? K8sResource::$defaultNamespace)
-                    ->all();
+                    ->all($parameters[2] ?? ['pretty' => 1]);
             }
         }
 
diff --git a/src/Traits/HasPods.php b/src/Traits/HasPods.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace RenokiCo\PhpK8s\Traits;
+
+trait HasPods
+{
+    /**
+     * Get the pods owned by this resource.
+     *
+     * @param  array  $query
+     * @return \RenokiCo\PhpK8s\ResourceList
+     */
+    public function getPods(array $query = ['pretty' => 1])
+    {
+        $labelSelector = http_build_query(
+            $this->podsSelector()
+        );
+
+        return $this->cluster
+            ->pod()
+            ->setNamespace($this->getNamespace())
+            ->all(array_merge(['labelSelector' => $labelSelector], $query));
+    }
+}
diff --git a/tests/DeploymentTest.php b/tests/DeploymentTest.php
@@ -92,7 +92,7 @@ public function runCreationTests()
 
         $pod = $this->cluster->pod()
             ->setName('mysql')
-            ->setLabels(['tier' => 'backend'])
+            ->setLabels(['tier' => 'backend', 'deployment-name' => 'mysql'])
             ->setAnnotations(['mysql/annotation' => 'yes'])
             ->setContainers([$mysql]);
 
@@ -123,6 +123,16 @@ public function runCreationTests()
 
         $this->assertInstanceOf(K8sPod::class, $dep->getTemplate());
 
+        sleep(10);
+
+        $pods = $dep->getPods();
+
+        $this->assertTrue($pods->count() > 0);
+
+        foreach ($pods as $pod) {
+            $this->assertInstanceOf(K8sPod::class, $pod);
+        }
+
         // Wait for the pod to create entirely.
         sleep(60);
     }
diff --git a/tests/JobTest.php b/tests/JobTest.php
@@ -113,6 +113,16 @@ public function runCreationTests()
 
         $this->assertInstanceOf(K8sPod::class, $job->getTemplate());
 
+        sleep(10);
+
+        $pods = $job->getPods();
+
+        $this->assertTrue($pods->count() > 0);
+
+        foreach ($pods as $pod) {
+            $this->assertInstanceOf(K8sPod::class, $pod);
+        }
+
         // Wait for the pod to create entirely.
         sleep(20);
     }
diff --git a/tests/StatefulSetTest.php b/tests/StatefulSetTest.php
@@ -125,7 +125,7 @@ public function runCreationTests()
 
         $pod = $this->cluster->pod()
             ->setName('mysql')
-            ->setLabels(['tier' => 'backend'])
+            ->setLabels(['tier' => 'backend', 'statefulset-name' => 'mysql'])
             ->setAnnotations(['mysql/annotation' => 'yes'])
             ->setContainers([$mysql]);
 
@@ -174,6 +174,16 @@ public function runCreationTests()
         $this->assertInstanceOf(K8sPod::class, $sts->getTemplate());
         $this->assertInstanceOf(K8sPersistentVolumeClaim::class, $sts->getVolumeClaims()[0]);
 
+        sleep(10);
+
+        $pods = $sts->getPods();
+
+        $this->assertTrue($pods->count() > 0);
+
+        foreach ($pods as $pod) {
+            $this->assertInstanceOf(K8sPod::class, $pod);
+        }
+
         // Wait for the pod to create entirely.
         sleep(60);
     }

Original file line number	Diff line number	Diff line change
`@@ -270,11 +270,12 @@ public function whereName(string $name)`
`270`	`270`	`* Get a resource by name.`
`271`	`271`	`*`
`272`	`272`	`* @param string $name`
	`273`	`+ * @param array $query`
`273`	`274`	`* @return \RenokiCo\PhpK8s\Kinds\K8sResource`
`274`	`275`	`*/`
`275`		`- public function getByName(string $name)`
	`276`	`+ public function getByName(string $name, array $query = ['pretty' => 1])`
`276`	`277`	`{`
`277`		`- return $this->whereName($name)->get();`
	`278`	`+ return $this->whereName($name)->get($query);`
`278`	`279`	`}`
`279`	`280`
`280`	`281`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -86,11 +86,11 @@ public function __call($method, $parameters)`
`86`	`86`	`if (method_exists(K8s::class, $resource)) {`
`87`	`87`	`return $this->{$resource}()`
`88`	`88`	`->whereNamespace($parameters[1] ?? K8sResource::$defaultNamespace)`
`89`		`- ->getByName($parameters[0]);`
	`89`	`+ ->getByName($parameters[0], $parameters[3] ?? ['pretty' => 1]);`
`90`	`90`	`}`
`91`	`91`	`}`
`92`	`92`
`93`		`- // Proxy the ->getAll[Resources]($namespace = 'default')`
	`93`	`+ // Proxy the ->getAll[Resources]($namespace = 'default', $query = [...])`
`94`	`94`	`// For example, ->getAllServices('staging')`
`95`	`95`	`if (preg_match('/getAll(.+)/', $method, $matches)) {`
`96`	`96`	`[$method, $resourcePlural] = $matches;`
`@@ -100,7 +100,7 @@ public function __call($method, $parameters)`
`100`	`100`	`if (method_exists(K8s::class, $resource)) {`
`101`	`101`	`return $this->{$resource}()`
`102`	`102`	`->whereNamespace($parameters[1] ?? K8sResource::$defaultNamespace)`
`103`		`- ->all();`
	`103`	`+ ->all($parameters[2] ?? ['pretty' => 1]);`
`104`	`104`	`}`
`105`	`105`	`}`
`106`	`106`