Merge pull request #105 from renoki-co/feature/set-or-update-metadata

[feature] setOrUpdateAnnotaitons and setOrUpdateLabels

Author: rennokki

docs/kinds/Resource.md

@@ -11,9 +11,13 @@
   - [Labels](#labels)
     - [`setLabels(array $labels)`](#setlabelsarray-labels)
     - [`getLabels()`](#getlabels)
+    - [`getLabel($name, $default = null)`](#getlabelname-default--null)
+    - [`setOrUpdateLabels(array $labels)`](#setorupdatelabelsarray-labels)
   - [Annotations](#annotations)
     - [`setAnnotations(array $annotations)`](#setannotationsarray-annotations)
     - [`getAnnotations()`](#getannotations)
+    - [`getAnnotation($name, $default = null)`](#getannotationname-default--null)
+    - [`setOrUpdateAnnotations(array $annotations)`](#setorupdateannotationsarray-annotations)
   - [API](#api)
     - [`getApiVersion()`](#getapiversion)
     - [`getKind()`](#getkind)
@@ -106,6 +110,26 @@ Get the labels of a resource.
 $service->getLabels();
 ```
 
+### `getLabel($name, $default = null)`
+
+Get the label value by key. Defaults to null.
+
+```php
+$service->getLabel('tier'); // "backend"
+$service->getLabel('not-a-label'); // null
+```
+
+### `setOrUpdateLabels(array $labels)`
+
+Set or update the labels. The method used will be merge.
+
+```php
+$service->setOrUpdateLabels([
+    'tier' => 'backend'
+    'some-other-label' => 'test',
+]);
+```
+
 ## Annotations
 
 ### `setAnnotations(array $annotations)`
@@ -124,6 +148,26 @@ Get the annotations of a resource.
 $service->getAnnotations();
 ```
 
+### `getAnnotation($name, $default = null)`
+
+Get the annotation value by key. Defaults to null.
+
+```php
+$service->getAnnotation('kubernetes.io/some-annotation'); // "yes"
+$service->getAnnotation('kubernetes.io/non-existing-annotation'); // null
+```
+
+### `setOrUpdateAnnotations(array $annotations)`
+
+Set or update the annotations. The method used will be merge.
+
+```php
+$service->setOrUpdateAnnotations([
+    'kubernetes.io/some-annotation' => 'yes'
+    'kubernetes.io/some-otherannotation' => 'yes',
+]);
+```
+
 ## API
 
 ### `getApiVersion()`

src/Traits/HasAnnotations.php

@@ -36,4 +36,17 @@ public function getAnnotation(string $name, $default = null)
     {
         return $this->getAnnotations()[$name] ?? $default;
     }
+
+    /**
+     * Set or update the given annotations.
+     *
+     * @param  array  $annotations
+     * @return $this
+     */
+    public function setOrUpdateAnnotations(array $annotations = [])
+    {
+        return $this->setAnnotations(
+            array_merge($this->getAnnotations(), $annotations)
+        );
+    }
 }

src/Traits/HasLabels.php

@@ -36,4 +36,17 @@ public function getLabel(string $name, $default = null)
     {
         return $this->getLabels()[$name] ?? $default;
     }
+
+    /**
+     * Set or update the given labels.
+     *
+     * @param  array  $labels
+     * @return $this
+     */
+    public function setOrUpdateLabels(array $labels = [])
+    {
+        return $this->setLabels(
+            array_merge($this->getLabels(), $labels)
+        );
+    }
 }

tests/PodTest.php

@@ -29,16 +29,18 @@ public function test_pod_build()
 
         $pod = $this->cluster->pod()
             ->setName('mysql')
-            ->setLabels(['tier' => 'backend'])
-            ->setAnnotations(['mysql/annotation' => 'yes'])
+            ->setOrUpdateLabels(['tier' => 'test'])
+            ->setOrUpdateLabels(['tier' => 'backend', 'type' => 'test'])
+            ->setOrUpdateAnnotations(['mysql/annotation' => 'no'])
+            ->setOrUpdateAnnotations(['mysql/annotation' => 'yes', 'mongodb/annotation' => 'no'])
             ->addPulledSecrets(['secret1', 'secret2'])
             ->setInitContainers([$busybox])
             ->setContainers([$mysql]);
 
         $this->assertEquals('v1', $pod->getApiVersion());
         $this->assertEquals('mysql', $pod->getName());
-        $this->assertEquals(['tier' => 'backend'], $pod->getLabels());
-        $this->assertEquals(['mysql/annotation' => 'yes'], $pod->getAnnotations());
+        $this->assertEquals(['tier' => 'backend', 'type' => 'test'], $pod->getLabels());
+        $this->assertEquals(['mysql/annotation' => 'yes', 'mongodb/annotation' => 'no'], $pod->getAnnotations());
         $this->assertEquals([['name' => 'secret1'], ['name' => 'secret2']], $pod->getPulledSecrets());
         $this->assertEquals([$busybox->toArray()], $pod->getInitContainers(false));
         $this->assertEquals([$mysql->toArray()], $pod->getContainers(false));
@@ -47,6 +49,7 @@ public function test_pod_build()
         $this->assertNull($pod->getLabel('inexistentLabel'));
 
         $this->assertEquals('yes', $pod->getAnnotation('mysql/annotation'));
+        $this->assertEquals('no', $pod->getAnnotation('mongodb/annotation'));
         $this->assertNull($pod->getAnnotation('inexistentAnnot'));
 
         foreach ($pod->getInitContainers() as $container) {