Skip to content

Commit c86e489

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request kubernetes-client#782 from johscheuer/create-from-yaml-namespaced
Add method to dynamically set namespace in yaml files
2 parents 05c1a43 + 80339ef commit c86e489

2 files changed

Lines changed: 64 additions & 5 deletions

File tree

‎kubernetes/e2e_test/test_utils.py‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,17 @@ class TestUtils(unittest.TestCase):
2424
def setUpClass(cls):
2525
cls.config = base.get_e2e_configuration()
2626
cls.path_prefix = "kubernetes/e2e_test/test_yaml/"
27+
cls.test_namespace = "e2e-test-utils"
28+
k8s_client = client.api_client.ApiClient(configuration=cls.config)
29+
core_v1 = client.CoreV1Api(api_client=k8s_client)
30+
body = client.V1Namespace(metadata=client.V1ObjectMeta(name=cls.test_namespace))
31+
core_v1.create_namespace(body=body)
2732

33+
@classmethod
34+
def tearDownClass(cls):
35+
k8s_client = client.api_client.ApiClient(configuration=cls.config)
36+
core_v1 = client.CoreV1Api(api_client=k8s_client)
37+
core_v1.delete_namespace(name=cls.test_namespace)
2838
# Tests for creating individual API objects
2939

3040
def test_create_apps_deployment_from_yaml(self):
@@ -331,3 +341,44 @@ def test_create_from_multi_resource_yaml_with_multi_conflicts(self):
331341
ext_api.delete_namespaced_deployment(
332342
name="triple-nginx", namespace="default",
333343
body={})
344+
345+
def test_create_namespaces_apps_deployment_from_yaml(self):
346+
"""
347+
Should be able to create an apps/v1beta1 deployment.
348+
"""
349+
k8s_client = client.api_client.ApiClient(configuration=self.config)
350+
utils.create_from_yaml(
351+
k8s_client, self.path_prefix + "apps-deployment.yaml", namespace=self.test_namespace)
352+
app_api = client.AppsV1beta1Api(k8s_client)
353+
dep = app_api.read_namespaced_deployment(name="nginx-app",
354+
namespace=self.test_namespace)
355+
self.assertIsNotNone(dep)
356+
app_api.delete_namespaced_deployment(
357+
name="nginx-app", namespace=self.test_namespace,
358+
body={})
359+
360+
def test_create_from_list_in_multi_resource_yaml(self):
361+
"""
362+
Should be able to create the items in the PodList and a deployment
363+
specified in the multi-resource file
364+
"""
365+
k8s_client = client.api_client.ApiClient(configuration=self.config)
366+
utils.create_from_yaml(
367+
k8s_client, self.path_prefix + "multi-resource-with-list.yaml", namespace=self.test_namespace)
368+
core_api = client.CoreV1Api(k8s_client)
369+
app_api = client.AppsV1beta1Api(k8s_client)
370+
pod_0 = core_api.read_namespaced_pod(
371+
name="mock-pod-0", namespace=self.test_namespace)
372+
self.assertIsNotNone(pod_0)
373+
pod_1 = core_api.read_namespaced_pod(
374+
name="mock-pod-1", namespace=self.test_namespace)
375+
self.assertIsNotNone(pod_1)
376+
dep = app_api.read_namespaced_deployment(
377+
name="mock", namespace=self.test_namespace)
378+
self.assertIsNotNone(dep)
379+
core_api.delete_namespaced_pod(
380+
name="mock-pod-0", namespace=self.test_namespace, body={})
381+
core_api.delete_namespaced_pod(
382+
name="mock-pod-1", namespace=self.test_namespace, body={})
383+
app_api.delete_namespaced_deployment(
384+
name="mock", namespace=self.test_namespace, body={})

‎kubernetes/utils/create_from_yaml.py‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ def create_from_yaml(
2525
k8s_client,
2626
yaml_file,
2727
verbose=False,
28+
namespace="default",
2829
**kwargs):
2930
"""
3031
Perform an action from a yaml file. Pass True for verbose to
@@ -34,6 +35,11 @@ def create_from_yaml(
3435
k8s_client: an ApiClient object, initialized with the client args.
3536
verbose: If True, print confirmation from the create action.
3637
Default is False.
38+
namespace: string. Contains the namespace to create all
39+
resources inside. The namespace must preexist otherwise
40+
the resource creation will fail. If the API object in
41+
the yaml file already contains a namespace definition
42+
this parameter has no effect.
3743
3844
Returns:
3945
An k8s api object or list of apis objects created from YAML.
@@ -73,14 +79,14 @@ def create_from_yaml(
7379
yml_object["kind"] = kind
7480
try:
7581
create_from_yaml_single_item(
76-
k8s_client, yml_object, verbose, **kwargs)
82+
k8s_client, yml_object, verbose, namespace, **kwargs)
7783
except client.rest.ApiException as api_exception:
7884
api_exceptions.append(api_exception)
7985
else:
8086
# This is a single object. Call the single item method
8187
try:
8288
create_from_yaml_single_item(
83-
k8s_client, yml_document, verbose, **kwargs)
89+
k8s_client, yml_document, verbose, namespace, **kwargs)
8490
except client.rest.ApiException as api_exception:
8591
api_exceptions.append(api_exception)
8692
# In case we have exceptions waiting for us, raise them
@@ -89,7 +95,11 @@ def create_from_yaml(
8995

9096

9197
def create_from_yaml_single_item(
92-
k8s_client, yml_object, verbose=False, **kwargs):
98+
k8s_client,
99+
yml_object,
100+
verbose=False,
101+
namespace="default",
102+
**kwargs):
93103
group, _, version = yml_object["apiVersion"].partition("/")
94104
if version == "":
95105
version = group
@@ -110,8 +120,6 @@ def create_from_yaml_single_item(
110120
# if any
111121
if "namespace" in yml_object["metadata"]:
112122
namespace = yml_object["metadata"]["namespace"]
113-
else:
114-
namespace = "default"
115123
# Expect the user to create namespaced objects more often
116124
if hasattr(k8s_api, "create_namespaced_{0}".format(kind)):
117125
resp = getattr(k8s_api, "create_namespaced_{0}".format(kind))(

0 commit comments

Comments
 (0)