Kubeconfig context support

CHANGELOG.md

@@ -4,10 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## In progress
+
+- Kubeconfig context support [#36](https://github.com/devopsspiral/KubeLibrary/pull/36) by [@m-wcislo](https://github.com/m-wcislo)
+- Keyword for getting secrets [#31](https://github.com/devopsspiral/KubeLibrary/pull/31 )by [@Nilsty](https://github.com/Nilsty)
+
 ## [0.3.0] - 2021-02-01
 
 ### Added
-- CI implementation [#14](https://github.com/devopsspiral/KubeLibrary/pull/14) by [@m-wcislo](https://github.com/m-wcislo) @m-wcislo 
+- CI implementation [#14](https://github.com/devopsspiral/KubeLibrary/pull/14) by [@m-wcislo](https://github.com/m-wcislo)
 - keywords to list deployments [#13](https://github.com/devopsspiral/KubeLibrary/pull/13) by [@Nilsty](https://github.com/Nilsty)
 - keywords for get/create/delete service accounts [#28](https://github.com/devopsspiral/KubeLibrary/pull/28) by [@kutayy](https://github.com/kutayy)   
 

README.md

@@ -17,7 +17,7 @@ export KUBECONFIG=~/.kube/config
 pip install robotframework-requests
 git clone https://github.com/devopsspiral/KubeLibrary.git
 cd KubeLibrary
-robot testcases
+robot -e prerelease testcases
 ```
 
 ## Example testcase
@@ -51,7 +51,7 @@ To see all the tests passing execute below commands.
 ### Cluster Tests
 ```
 # run cluster tests
-robot -i cluster testcases/
+robot -i cluster -e prerelease testcases/
 ```
 
 ### Grafana Tests
@@ -65,7 +65,7 @@ export KLIB_POD_PATTERN='grafana.*'
 export KLIB_POD_ANNOTATIONS='{"kubelibrary":"testing"}'
 export KLIB_POD_NAMESPACE=default
 
-robot -i grafana testcases/
+robot -i grafana -e prerelease testcases/
 ```
 
 ### Octopus Tests
@@ -83,7 +83,7 @@ export KLIB_ENV_VARS='{"SECRET_NAME":"webhook-server-secret"}'
 export KLIB_POD_NAMESPACE=default
 export KLIB_RESOURCE_REQUESTS_MEMORY=20Mi
 
-robot -i octopus testcases/
+robot -i octopus -e prerelease testcases/
 ```
 
 ### Other Tests
@@ -98,7 +98,7 @@ kubectl create namespace $KLIB_POD_NAMESPACE
 kubectl label namespaces kubelib-tests test=test
 helm install kubelib-test ./test-objects-chart -n $KLIB_POD_NAMESPACE
 
-robot -i other testcases/
+robot -i other -e prerelease testcases/
 ```
 ### Multi Cluster Tests
 These tests require more than one cluster and utilize [KinD](https://kind.sigs.k8s.io/) as a setup.
@@ -116,7 +116,7 @@ kind create cluster --kubeconfig ./cluster2-conf --name kind-cluster-2
 # Create namespace in Test Cluster 2
 kubectl create namespace test-ns-2 --context kind-kind-cluster-2 --kubeconfig ./cluster2-conf
 
-robot -i reload-config testcases/
+robot -i reload-config -e prerelease testcases/
 
 # Clean up
 kind delete cluster --name kind-cluster-1

src/KubeLibrary/KubeLibrary.py

@@ -23,6 +23,14 @@ class KubeLibrary(object):
     | ***** Settings *****
     | Library           KubeLibrary          /path/to/kubeconfig
 
+    = Context =
+
+    By default current context from kubeconfig is used. Setting multiple contexts in
+    different test suites allows working on multiple clusters.
+
+    | ***** Settings *****
+    | Library           KubeLibrary          context=k3d-k3d-cluster2
+
     = In cluster execution =
 
     If tests are supposed to be executed from within cluster, KubeLibrary can be configured to use standard
@@ -33,22 +41,26 @@ class KubeLibrary(object):
     | Library           KubeLibrary          None    True
 
     """
-    def __init__(self, kube_config=None, incluster=False, cert_validation=True):
+    def __init__(self, kube_config=None, context=None, incluster=False, cert_validation=True):
         """KubeLibrary can be configured with several optional arguments.
         - ``kube_config``:
           Path pointing to kubeconfig of target Kubernetes cluster.
+        - ``context``:
+          Active context. If None current_context from kubeconfig is used.
         - ``incuster``:
           Default False. Indicates if used from within k8s cluster. Overrides kubeconfig.
         - ``cert_validation``:
           Default True. Can be set to False for self-signed certificates.
         """
-        self.reload_config(kube_config=kube_config, incluster=incluster, cert_validation=cert_validation)
+        self.reload_config(kube_config=kube_config, context=context, incluster=incluster, cert_validation=cert_validation)
 
-    def reload_config(self, kube_config=None, incluster=False, cert_validation=True):
+    def reload_config(self, kube_config=None, context=None, incluster=False, cert_validation=True):
         """Reload the KubeLibrary to be configured with different optional arguments.
            This can be used to connect to a different cluster during the same test.
         - ``kube_config``:
           Path pointing to kubeconfig of target Kubernetes cluster.
+        - ``context``:
+          Active context. If None current_context from kubeconfig is used.
         - ``incuster``:
           Default False. Indicates if used from within k8s cluster. Overrides kubeconfig.
         - ``cert_validation``:
@@ -62,7 +74,7 @@ def reload_config(self, kube_config=None, incluster=False, cert_validation=True)
                 raise e
         else:
             try:
-                config.load_kube_config(kube_config)
+                config.load_kube_config(kube_config, context)
             except TypeError:
                 logger.error('Neither KUBECONFIG nor ~/.kube/config available.')
         self.v1 = client.CoreV1Api()

test/resources/multiple_context

@@ -0,0 +1,31 @@
+apiVersion: v1
+clusters:
+- cluster:
+    certificate-authority-data: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUJWekNCL3FBREFnRUNBZ0VBTUFvR0NDcUdTTTQ5QkFNQ01DTXhJVEFmQmdOVkJBTU1HR3N6Y3kxelpYSjIKWlhJdFkyRkFNVFl4TXpVNU1UUXhNVEFlRncweU1UQXlNVGN4T1RVd01URmFGdzB6TVRBeU1UVXhPVFV3TVRGYQpNQ014SVRBZkJnTlZCQU1NR0dzemN5MXpaWEoyWlhJdFkyRkFNVFl4TXpVNU1UUXhNVEJaTUJNR0J5cUdTTTQ5CkFnRUdDQ3FHU000OUF3RUhBMElBQkl4T0ZvVnFtdlZ3ZzlHcE1ER0ZOOUprelAzQlVMQWdwSGErYWhta0E5TVUKK1hhMFFxdnZJRUFDNmluZDh1dzdxVTlPcXVXUGZ1M3FyUFU2QitTV3F4ZWpJekFoTUE0R0ExVWREd0VCL3dRRQpBd0lDcERBUEJnTlZIUk1CQWY4RUJUQURBUUgvTUFvR0NDcUdTTTQ5QkFNQ0EwZ0FNRVVDSUd3Um81Y2crMFhOCjZ5cGQvVlhtc2tSQ1MrWjBHV2xSVU54L010S0dGc1dWQWlFQWs0UkNPOFRXVGx5eTVNcHQwcHRaNzBMVlEyWWMKZUdacjJUcFEvTU5uTFJBPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
+    server: https://0.0.0.0:38531
+  name: k3d-k3d-cluster
+- cluster:
+    certificate-authority-data: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUJWakNCL3FBREFnRUNBZ0VBTUFvR0NDcUdTTTQ5QkFNQ01DTXhJVEFmQmdOVkJBTU1HR3N6Y3kxelpYSjIKWlhJdFkyRkFNVFl4TXpVNU1UVXlOREFlRncweU1UQXlNVGN4T1RVeU1EUmFGdzB6TVRBeU1UVXhPVFV5TURSYQpNQ014SVRBZkJnTlZCQU1NR0dzemN5MXpaWEoyWlhJdFkyRkFNVFl4TXpVNU1UVXlOREJaTUJNR0J5cUdTTTQ5CkFnRUdDQ3FHU000OUF3RUhBMElBQko1bG0xelBrNXRyTUV0RHJaL2FNcEk5Rm1hYkJGTmlWbFhYeGc1N1BXWm8KWVNHNHFSbXJRV05YNzFtVG5qV20rSk1ITUhaa21NalJidzd0RmRvUVJOU2pJekFoTUE0R0ExVWREd0VCL3dRRQpBd0lDcERBUEJnTlZIUk1CQWY4RUJUQURBUUgvTUFvR0NDcUdTTTQ5QkFNQ0EwY0FNRVFDSURVWHUvRCtIdGJXClEzRTNlbEtGNHp6N3dMSjNmYXRYbGZpNmtUL0NCanlhQWlCcGo3NktMR1htZ1ZKQ0VrRVBSU3AvSjJ5NkkzMlUKN0JyOG02UG1aaHlJSWc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
+    server: https://0.0.0.0:37971
+  name: k3d-k3d-cluster2
+contexts:
+- context:
+    cluster: k3d-k3d-cluster
+    user: admin@k3d-k3d-cluster
+  name: k3d-k3d-cluster
+- context:
+    cluster: k3d-k3d-cluster2
+    user: admin@k3d-k3d-cluster2
+  name: k3d-k3d-cluster2
+current-context: k3d-k3d-cluster
+kind: Config
+preferences: {}
+users:
+- name: admin@k3d-k3d-cluster
+  user:
+    password: 7723eb490bd1900a0686c9dcc55de40e
+    username: admin
+- name: admin@k3d-k3d-cluster2
+  user:
+    password: 34e01dc12a8d5054aceead504dec1112
+    username: admin

test/test_KubeLibrary.py

@@ -4,6 +4,7 @@
 import re
 import unittest
 from KubeLibrary import KubeLibrary
+from kubernetes.config.config_exception import ConfigException
 
 
 class AttributeDict(object):
@@ -89,6 +90,13 @@ class TestKubeLibrary(unittest.TestCase):
     def test_KubeLibrary_inits_from_kubeconfig(self):
         KubeLibrary(kube_config='test/resources/k3d')
 
+    def test_KubeLibrary_inits_with_context(self):
+        KubeLibrary(kube_config='test/resources/multiple_context', context='k3d-k3d-cluster2')
+
+    def test_KubeLibrary_fails_for_wrong_context(self):
+        kl = KubeLibrary(kube_config='test/resources/multiple_context')
+        self.assertRaises(ConfigException, kl.reload_config, kube_config='test/resources/multiple_context', context='k3d-k3d-cluster2-wrong')
+
     def test_KubeLibrary_inits_without_cert_validation(self):
         KubeLibrary(kube_config='test/resources/k3d', cert_validation=False)
 

testcases/secrets/secret.robot

@@ -3,6 +3,6 @@ Resource          ./secret_kw.robot
 
 *** Test Cases ***
 Secrets test case example
-    [Tags]    grafana
+    [Tags]    grafana    prerelease
     List all secrets in namespace  default
     Read grafana secrets