1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
|
%global _empty_manifest_terminate_build 0
Name: python-robotframework-kubelibrary
Version: 0.8.5
Release: 1
Summary: Kubernetes library for Robot Framework
License: MIT
URL: https://github.com/devopsspiral/KubeLibrary
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/a4/49/e473b09b6af22e2b3be416da2c921193dd96b6ccda069f57d0e07b18a420/robotframework-kubelibrary-0.8.5.tar.gz
BuildArch: noarch
Requires: python3-google-auth
Requires: python3-kubernetes
Requires: python3-robotframework
Requires: python3-urllib3-mock
%description
# KubeLibrary
[](https://circleci.com/gh/devopsspiral/KubeLibrary)[](https://pypi.org/project/robotframework-kubelibrary/)[](https://pypi.python.org/pypi/robotframework-kubelibrary)[](https://raw.githubusercontent.com/devopsspiral/k3d-orb/master/LICENSE)[](https://robotframework.slack.com/archives/C017AKKS06R)
RobotFramework library for testing Kubernetes cluster
## Quick start
```
# install library itself
pip install robotframework-kubelibrary
# export KUBECONFIG
export KUBECONFIG=~/.kube/config
# run example tests
pip install robotframework-requests
git clone https://github.com/devopsspiral/KubeLibrary.git
cd KubeLibrary
robot -e prerelease testcases
```
## Documentation
[Library docs](http://devopsspiral.com/KubeLibrary/)
## Example testcase
```
testcases/system_smoke.robot
*** Settings ***
(1)Resource ./system_smoke_kw.robot
*** Variables ***
(2)${KUBELET_VERSION} %{KUBELET_VERSION}
${NUM_NODES} 2
${NUM_WORKERS} 1
*** Test Cases ***
(3)Pods in kube-system are ok
(4) [Documentation] Test if all pods in kube-system initiated correctly and are running or succeeded
(5) [Tags] cluster smoke
(6) Given kubernetes API responds
(7) When getting all pods names in "kube-system"
(8) Then all pods in "kube-system" are running or succeeded
```
1 - keyword definitions in separate file relative to testcase file
2 - defining local variable taking value from environment variable
3 - testcase definition
4 - Documentation/comments
5 - Tags, you can include (-i) and exclude (-e) tests by tag.
6(7,8) - Given, When, Then clause. It is only way of organizing your test steps, given, when, then are just omitted, real keywords definition needs to match 'kubernetes API responds', 'getting all pods names in ...' etc.(see testcases/system_smoke_kw.robot)
7 - kube-system in quotes is treated as parameter for 'getting all pods names in ...' keyword.
More examples in testcases/ directory.
To see all the tests passing execute below commands.
### Cluster Tests
```
# run cluster tests
robot -i cluster -e prerelease testcases/
```
### Grafana Tests
```
helm repo add grafana https://grafana.github.io/helm-charts
helm repo update
helm install grafana grafana/grafana -f testcases/grafana/values.yaml
# run grafana tests
export KLIB_POD_PATTERN='grafana.*'
export KLIB_POD_ANNOTATIONS='{"kubelibrary":"testing"}'
export KLIB_POD_NAMESPACE=default
robot -i grafana -e prerelease testcases/
```
### Other Tests
These tests require the kubelib-test helm-chart to be installed in your test cluster.
```
# run other library tests
export KLIB_POD_PATTERN='busybox.*'
export KLIB_POD_NAMESPACE=kubelib-tests
export KLIB_POD_LABELS='job-name=busybox-job'
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 -e prerelease testcases/
```
### Multi Cluster Tests
These tests require more than one cluster and utilize [KinD](https://kind.sigs.k8s.io/) as a setup.
[Download KinD and install it.](https://kind.sigs.k8s.io/docs/user/quick-start/)
```
# Create Test Cluster 1
kind create cluster --kubeconfig ./cluster1-conf --name kind-cluster-1
# Create namespace in Test Cluster 1
kubectl create namespace test-ns-1 --context kind-kind-cluster-1 --kubeconfig ./cluster1-conf
# For bearer token auth
kubectl apply -f testcases/reload-config/sa.yaml
MYSA_TOKEN_SECRET=$(kubectl get sa mysa -o jsonpath="{.secrets[0].name}")
export K8S_TOKEN=$(kubectl get secret $MYSA_TOKEN_SECRET --template={{.data.token}} | base64 -d)
kubectl get secret $MYSA_TOKEN_SECRET -o jsonpath="{.data.ca\.crt}" | base64 -d > ca.crt
export K8S_API_URL=$(kubectl config view -o jsonpath='{.clusters[0].cluster.server}')
export K8S_CA_CRT=./ca.crt
# Create Test Cluster 2
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 -e prerelease testcases/
# Clean up
kind delete cluster --name kind-cluster-1
kind delete cluster --name kind-cluster-2
```
## Keywords documentation
Keywords documentation can be found in docs/.
## Proxy configuration
To access cluster via proxy set `http_proxy` or `HTTP_PROXY` environment variable.
In similar way you can set `no_proxy` or `NO_PROXY` variable to specify hosts that should be excluded from proxying.
**IMPORTANT:** Lowercase environment variables have higher priority than uppercase
## Further reading
[DevOps spiral article on KubeLibrary](https://devopsspiral.com/articles/k8s/robotframework-kubelibrary/)
[KubeLibrary: Testing Kubernetes with RobotFramework | Humanitec](https://humanitec.com/blog/kubelibrary-testing-kubernetes-with-robotframework)
[RobotFramework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html)
## Development
```
# clone repo
git clone https://github.com/devopsspiral/KubeLibrary.git
cd KubeLibrary
# create virtualenv
virtualenv .venv
. .venv/bin/activate
pip install -r requirements-dev.txt
```
Create keyword and test file, import KubeLibrary using below to point to library under development.
```
*** Settings ***
Library ../src/KubeLibrary/KubeLibrary.py
```
For development cluster you can use k3s/k3d as described in [DevOps spiral article on K3d and skaffold](https://devopsspiral.com/articles/k8s/k3d-skaffold/).
### Generate docs
```
(
# To generate keyword documentation a connection
# to a cluster is not necessary. Skip to load a
# cluster configuration.
#
# Set the variable local for the libdoc call only
export INIT_FOR_LIBDOC_ONLY=1
python -m robot.libdoc src/KubeLibrary docs/index.html
)
```
%package -n python3-robotframework-kubelibrary
Summary: Kubernetes library for Robot Framework
Provides: python-robotframework-kubelibrary
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-robotframework-kubelibrary
# KubeLibrary
[](https://circleci.com/gh/devopsspiral/KubeLibrary)[](https://pypi.org/project/robotframework-kubelibrary/)[](https://pypi.python.org/pypi/robotframework-kubelibrary)[](https://raw.githubusercontent.com/devopsspiral/k3d-orb/master/LICENSE)[](https://robotframework.slack.com/archives/C017AKKS06R)
RobotFramework library for testing Kubernetes cluster
## Quick start
```
# install library itself
pip install robotframework-kubelibrary
# export KUBECONFIG
export KUBECONFIG=~/.kube/config
# run example tests
pip install robotframework-requests
git clone https://github.com/devopsspiral/KubeLibrary.git
cd KubeLibrary
robot -e prerelease testcases
```
## Documentation
[Library docs](http://devopsspiral.com/KubeLibrary/)
## Example testcase
```
testcases/system_smoke.robot
*** Settings ***
(1)Resource ./system_smoke_kw.robot
*** Variables ***
(2)${KUBELET_VERSION} %{KUBELET_VERSION}
${NUM_NODES} 2
${NUM_WORKERS} 1
*** Test Cases ***
(3)Pods in kube-system are ok
(4) [Documentation] Test if all pods in kube-system initiated correctly and are running or succeeded
(5) [Tags] cluster smoke
(6) Given kubernetes API responds
(7) When getting all pods names in "kube-system"
(8) Then all pods in "kube-system" are running or succeeded
```
1 - keyword definitions in separate file relative to testcase file
2 - defining local variable taking value from environment variable
3 - testcase definition
4 - Documentation/comments
5 - Tags, you can include (-i) and exclude (-e) tests by tag.
6(7,8) - Given, When, Then clause. It is only way of organizing your test steps, given, when, then are just omitted, real keywords definition needs to match 'kubernetes API responds', 'getting all pods names in ...' etc.(see testcases/system_smoke_kw.robot)
7 - kube-system in quotes is treated as parameter for 'getting all pods names in ...' keyword.
More examples in testcases/ directory.
To see all the tests passing execute below commands.
### Cluster Tests
```
# run cluster tests
robot -i cluster -e prerelease testcases/
```
### Grafana Tests
```
helm repo add grafana https://grafana.github.io/helm-charts
helm repo update
helm install grafana grafana/grafana -f testcases/grafana/values.yaml
# run grafana tests
export KLIB_POD_PATTERN='grafana.*'
export KLIB_POD_ANNOTATIONS='{"kubelibrary":"testing"}'
export KLIB_POD_NAMESPACE=default
robot -i grafana -e prerelease testcases/
```
### Other Tests
These tests require the kubelib-test helm-chart to be installed in your test cluster.
```
# run other library tests
export KLIB_POD_PATTERN='busybox.*'
export KLIB_POD_NAMESPACE=kubelib-tests
export KLIB_POD_LABELS='job-name=busybox-job'
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 -e prerelease testcases/
```
### Multi Cluster Tests
These tests require more than one cluster and utilize [KinD](https://kind.sigs.k8s.io/) as a setup.
[Download KinD and install it.](https://kind.sigs.k8s.io/docs/user/quick-start/)
```
# Create Test Cluster 1
kind create cluster --kubeconfig ./cluster1-conf --name kind-cluster-1
# Create namespace in Test Cluster 1
kubectl create namespace test-ns-1 --context kind-kind-cluster-1 --kubeconfig ./cluster1-conf
# For bearer token auth
kubectl apply -f testcases/reload-config/sa.yaml
MYSA_TOKEN_SECRET=$(kubectl get sa mysa -o jsonpath="{.secrets[0].name}")
export K8S_TOKEN=$(kubectl get secret $MYSA_TOKEN_SECRET --template={{.data.token}} | base64 -d)
kubectl get secret $MYSA_TOKEN_SECRET -o jsonpath="{.data.ca\.crt}" | base64 -d > ca.crt
export K8S_API_URL=$(kubectl config view -o jsonpath='{.clusters[0].cluster.server}')
export K8S_CA_CRT=./ca.crt
# Create Test Cluster 2
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 -e prerelease testcases/
# Clean up
kind delete cluster --name kind-cluster-1
kind delete cluster --name kind-cluster-2
```
## Keywords documentation
Keywords documentation can be found in docs/.
## Proxy configuration
To access cluster via proxy set `http_proxy` or `HTTP_PROXY` environment variable.
In similar way you can set `no_proxy` or `NO_PROXY` variable to specify hosts that should be excluded from proxying.
**IMPORTANT:** Lowercase environment variables have higher priority than uppercase
## Further reading
[DevOps spiral article on KubeLibrary](https://devopsspiral.com/articles/k8s/robotframework-kubelibrary/)
[KubeLibrary: Testing Kubernetes with RobotFramework | Humanitec](https://humanitec.com/blog/kubelibrary-testing-kubernetes-with-robotframework)
[RobotFramework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html)
## Development
```
# clone repo
git clone https://github.com/devopsspiral/KubeLibrary.git
cd KubeLibrary
# create virtualenv
virtualenv .venv
. .venv/bin/activate
pip install -r requirements-dev.txt
```
Create keyword and test file, import KubeLibrary using below to point to library under development.
```
*** Settings ***
Library ../src/KubeLibrary/KubeLibrary.py
```
For development cluster you can use k3s/k3d as described in [DevOps spiral article on K3d and skaffold](https://devopsspiral.com/articles/k8s/k3d-skaffold/).
### Generate docs
```
(
# To generate keyword documentation a connection
# to a cluster is not necessary. Skip to load a
# cluster configuration.
#
# Set the variable local for the libdoc call only
export INIT_FOR_LIBDOC_ONLY=1
python -m robot.libdoc src/KubeLibrary docs/index.html
)
```
%package help
Summary: Development documents and examples for robotframework-kubelibrary
Provides: python3-robotframework-kubelibrary-doc
%description help
# KubeLibrary
[](https://circleci.com/gh/devopsspiral/KubeLibrary)[](https://pypi.org/project/robotframework-kubelibrary/)[](https://pypi.python.org/pypi/robotframework-kubelibrary)[](https://raw.githubusercontent.com/devopsspiral/k3d-orb/master/LICENSE)[](https://robotframework.slack.com/archives/C017AKKS06R)
RobotFramework library for testing Kubernetes cluster
## Quick start
```
# install library itself
pip install robotframework-kubelibrary
# export KUBECONFIG
export KUBECONFIG=~/.kube/config
# run example tests
pip install robotframework-requests
git clone https://github.com/devopsspiral/KubeLibrary.git
cd KubeLibrary
robot -e prerelease testcases
```
## Documentation
[Library docs](http://devopsspiral.com/KubeLibrary/)
## Example testcase
```
testcases/system_smoke.robot
*** Settings ***
(1)Resource ./system_smoke_kw.robot
*** Variables ***
(2)${KUBELET_VERSION} %{KUBELET_VERSION}
${NUM_NODES} 2
${NUM_WORKERS} 1
*** Test Cases ***
(3)Pods in kube-system are ok
(4) [Documentation] Test if all pods in kube-system initiated correctly and are running or succeeded
(5) [Tags] cluster smoke
(6) Given kubernetes API responds
(7) When getting all pods names in "kube-system"
(8) Then all pods in "kube-system" are running or succeeded
```
1 - keyword definitions in separate file relative to testcase file
2 - defining local variable taking value from environment variable
3 - testcase definition
4 - Documentation/comments
5 - Tags, you can include (-i) and exclude (-e) tests by tag.
6(7,8) - Given, When, Then clause. It is only way of organizing your test steps, given, when, then are just omitted, real keywords definition needs to match 'kubernetes API responds', 'getting all pods names in ...' etc.(see testcases/system_smoke_kw.robot)
7 - kube-system in quotes is treated as parameter for 'getting all pods names in ...' keyword.
More examples in testcases/ directory.
To see all the tests passing execute below commands.
### Cluster Tests
```
# run cluster tests
robot -i cluster -e prerelease testcases/
```
### Grafana Tests
```
helm repo add grafana https://grafana.github.io/helm-charts
helm repo update
helm install grafana grafana/grafana -f testcases/grafana/values.yaml
# run grafana tests
export KLIB_POD_PATTERN='grafana.*'
export KLIB_POD_ANNOTATIONS='{"kubelibrary":"testing"}'
export KLIB_POD_NAMESPACE=default
robot -i grafana -e prerelease testcases/
```
### Other Tests
These tests require the kubelib-test helm-chart to be installed in your test cluster.
```
# run other library tests
export KLIB_POD_PATTERN='busybox.*'
export KLIB_POD_NAMESPACE=kubelib-tests
export KLIB_POD_LABELS='job-name=busybox-job'
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 -e prerelease testcases/
```
### Multi Cluster Tests
These tests require more than one cluster and utilize [KinD](https://kind.sigs.k8s.io/) as a setup.
[Download KinD and install it.](https://kind.sigs.k8s.io/docs/user/quick-start/)
```
# Create Test Cluster 1
kind create cluster --kubeconfig ./cluster1-conf --name kind-cluster-1
# Create namespace in Test Cluster 1
kubectl create namespace test-ns-1 --context kind-kind-cluster-1 --kubeconfig ./cluster1-conf
# For bearer token auth
kubectl apply -f testcases/reload-config/sa.yaml
MYSA_TOKEN_SECRET=$(kubectl get sa mysa -o jsonpath="{.secrets[0].name}")
export K8S_TOKEN=$(kubectl get secret $MYSA_TOKEN_SECRET --template={{.data.token}} | base64 -d)
kubectl get secret $MYSA_TOKEN_SECRET -o jsonpath="{.data.ca\.crt}" | base64 -d > ca.crt
export K8S_API_URL=$(kubectl config view -o jsonpath='{.clusters[0].cluster.server}')
export K8S_CA_CRT=./ca.crt
# Create Test Cluster 2
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 -e prerelease testcases/
# Clean up
kind delete cluster --name kind-cluster-1
kind delete cluster --name kind-cluster-2
```
## Keywords documentation
Keywords documentation can be found in docs/.
## Proxy configuration
To access cluster via proxy set `http_proxy` or `HTTP_PROXY` environment variable.
In similar way you can set `no_proxy` or `NO_PROXY` variable to specify hosts that should be excluded from proxying.
**IMPORTANT:** Lowercase environment variables have higher priority than uppercase
## Further reading
[DevOps spiral article on KubeLibrary](https://devopsspiral.com/articles/k8s/robotframework-kubelibrary/)
[KubeLibrary: Testing Kubernetes with RobotFramework | Humanitec](https://humanitec.com/blog/kubelibrary-testing-kubernetes-with-robotframework)
[RobotFramework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html)
## Development
```
# clone repo
git clone https://github.com/devopsspiral/KubeLibrary.git
cd KubeLibrary
# create virtualenv
virtualenv .venv
. .venv/bin/activate
pip install -r requirements-dev.txt
```
Create keyword and test file, import KubeLibrary using below to point to library under development.
```
*** Settings ***
Library ../src/KubeLibrary/KubeLibrary.py
```
For development cluster you can use k3s/k3d as described in [DevOps spiral article on K3d and skaffold](https://devopsspiral.com/articles/k8s/k3d-skaffold/).
### Generate docs
```
(
# To generate keyword documentation a connection
# to a cluster is not necessary. Skip to load a
# cluster configuration.
#
# Set the variable local for the libdoc call only
export INIT_FOR_LIBDOC_ONLY=1
python -m robot.libdoc src/KubeLibrary docs/index.html
)
```
%prep
%autosetup -n robotframework-kubelibrary-0.8.5
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-robotframework-kubelibrary -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.8.5-1
- Package Spec generated
|
