forked from project-codeflare/codeflare-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathunit_test.py
3214 lines (2924 loc) · 139 KB
/
unit_test.py
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
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2022 IBM, Red Hat
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from pathlib import Path
import sys
import filecmp
import os
import re
import uuid
from codeflare_sdk.cluster import cluster
parent = Path(__file__).resolve().parents[1]
aw_dir = os.path.expanduser("~/.codeflare/resources/")
sys.path.append(str(parent) + "/src")
from kubernetes import client, config, dynamic
from codeflare_sdk.cluster.awload import AWManager
from codeflare_sdk.cluster.cluster import (
Cluster,
ClusterConfiguration,
_map_to_ray_cluster,
list_all_clusters,
list_all_queued,
_copy_to_ray,
get_cluster,
_app_wrapper_status,
_ray_cluster_status,
)
from codeflare_sdk.common.kubernetes_cluster import (
TokenAuthentication,
Authentication,
KubeConfigFileAuthentication,
config_check,
)
from codeflare_sdk.utils.pretty_print import (
print_no_resources_found,
print_app_wrappers_status,
print_cluster_status,
print_clusters,
)
from codeflare_sdk.cluster.model import (
AppWrapper,
RayCluster,
AppWrapperStatus,
RayClusterStatus,
CodeFlareClusterStatus,
)
from codeflare_sdk.utils.generate_cert import (
generate_ca_cert,
generate_tls_cert,
export_env,
)
from tests.unit_test_support import (
createClusterWithConfig,
createClusterConfig,
createClusterWrongType,
get_package_and_version,
)
import codeflare_sdk.common.kubernetes_cluster.kube_api_helpers
from codeflare_sdk.utils.generate_yaml import (
gen_names,
is_openshift_cluster,
)
import codeflare_sdk.cluster.widgets as cf_widgets
import pandas as pd
import openshift
from openshift.selector import Selector
import ray
import pytest
import yaml
from unittest.mock import MagicMock, patch
from pytest_mock import MockerFixture
from ray.job_submission import JobSubmissionClient
from codeflare_sdk.job.ray_jobs import RayJobClient
# For mocking openshift client results
fake_res = openshift.Result("fake")
def mock_routes_api(mocker):
mocker.patch.object(
"_route_api_getter",
return_value=MagicMock(
resources=MagicMock(
get=MagicMock(
return_value=MagicMock(
create=MagicMock(),
replace=MagicMock(),
delete=MagicMock(),
)
)
)
),
)
def arg_side_effect(*args):
fake_res.high_level_operation = args
return fake_res
def att_side_effect(self):
return self.high_level_operation
def test_token_auth_creation():
try:
token_auth = TokenAuthentication(token="token", server="server")
assert token_auth.token == "token"
assert token_auth.server == "server"
assert token_auth.skip_tls == False
assert token_auth.ca_cert_path == None
token_auth = TokenAuthentication(token="token", server="server", skip_tls=True)
assert token_auth.token == "token"
assert token_auth.server == "server"
assert token_auth.skip_tls == True
assert token_auth.ca_cert_path == None
os.environ["CF_SDK_CA_CERT_PATH"] = "/etc/pki/tls/custom-certs/ca-bundle.crt"
token_auth = TokenAuthentication(token="token", server="server", skip_tls=False)
assert token_auth.token == "token"
assert token_auth.server == "server"
assert token_auth.skip_tls == False
assert token_auth.ca_cert_path == "/etc/pki/tls/custom-certs/ca-bundle.crt"
os.environ.pop("CF_SDK_CA_CERT_PATH")
token_auth = TokenAuthentication(
token="token",
server="server",
skip_tls=False,
ca_cert_path=f"{parent}/tests/auth-test.crt",
)
assert token_auth.token == "token"
assert token_auth.server == "server"
assert token_auth.skip_tls == False
assert token_auth.ca_cert_path == f"{parent}/tests/auth-test.crt"
except Exception as e:
assert 0 == 1
def test_token_auth_login_logout(mocker):
mocker.patch.object(client, "ApiClient")
token_auth = TokenAuthentication(
token="testtoken", server="testserver:6443", skip_tls=False, ca_cert_path=None
)
assert token_auth.login() == ("Logged into testserver:6443")
assert token_auth.logout() == ("Successfully logged out of testserver:6443")
def test_token_auth_login_tls(mocker):
mocker.patch.object(client, "ApiClient")
token_auth = TokenAuthentication(
token="testtoken", server="testserver:6443", skip_tls=True, ca_cert_path=None
)
assert token_auth.login() == ("Logged into testserver:6443")
token_auth = TokenAuthentication(
token="testtoken", server="testserver:6443", skip_tls=False, ca_cert_path=None
)
assert token_auth.login() == ("Logged into testserver:6443")
token_auth = TokenAuthentication(
token="testtoken",
server="testserver:6443",
skip_tls=False,
ca_cert_path=f"{parent}/tests/auth-test.crt",
)
assert token_auth.login() == ("Logged into testserver:6443")
os.environ["CF_SDK_CA_CERT_PATH"] = f"{parent}/tests/auth-test.crt"
token_auth = TokenAuthentication(
token="testtoken",
server="testserver:6443",
skip_tls=False,
)
assert token_auth.login() == ("Logged into testserver:6443")
def test_config_check_no_config_file(mocker):
mocker.patch("os.path.expanduser", return_value="/mock/home/directory")
mocker.patch("os.path.isfile", return_value=False)
mocker.patch("codeflare_sdk.common.kubernetes_cluster.auth.config_path", None)
mocker.patch("codeflare_sdk.common.kubernetes_cluster.auth.api_client", None)
with pytest.raises(PermissionError) as e:
config_check()
def test_config_check_with_incluster_config(mocker):
mocker.patch("os.path.expanduser", return_value="/mock/home/directory")
mocker.patch("os.path.isfile", return_value=False)
mocker.patch.dict(os.environ, {"KUBERNETES_PORT": "number"})
mocker.patch("kubernetes.config.load_incluster_config", side_effect=None)
mocker.patch("codeflare_sdk.common.kubernetes_cluster.auth.config_path", None)
mocker.patch("codeflare_sdk.common.kubernetes_cluster.auth.api_client", None)
result = config_check()
assert result == None
def test_config_check_with_existing_config_file(mocker):
mocker.patch("os.path.expanduser", return_value="/mock/home/directory")
mocker.patch("os.path.isfile", return_value=True)
mocker.patch("kubernetes.config.load_kube_config", side_effect=None)
mocker.patch("codeflare_sdk.common.kubernetes_cluster.auth.config_path", None)
mocker.patch("codeflare_sdk.common.kubernetes_cluster.auth.api_client", None)
result = config_check()
assert result == None
def test_config_check_with_config_path_and_no_api_client(mocker):
mocker.patch(
"codeflare_sdk.common.kubernetes_cluster.auth.config_path", "/mock/config/path"
)
mocker.patch("codeflare_sdk.common.kubernetes_cluster.auth.api_client", None)
result = config_check()
assert result == "/mock/config/path"
def test_load_kube_config(mocker):
mocker.patch.object(config, "load_kube_config")
kube_config_auth = KubeConfigFileAuthentication(
kube_config_path="/path/to/your/config"
)
response = kube_config_auth.load_kube_config()
assert (
response
== "Loaded user config file at path %s" % kube_config_auth.kube_config_path
)
kube_config_auth = KubeConfigFileAuthentication(kube_config_path=None)
response = kube_config_auth.load_kube_config()
assert response == "Please specify a config file path"
def test_auth_coverage():
abstract = Authentication()
abstract.login()
abstract.logout()
def test_config_creation():
config = createClusterConfig()
assert config.name == "unit-test-cluster" and config.namespace == "ns"
assert config.num_workers == 2
assert config.worker_cpu_requests == 3 and config.worker_cpu_limits == 4
assert config.worker_memory_requests == "5G" and config.worker_memory_limits == "6G"
assert config.worker_extended_resource_requests == {"nvidia.com/gpu": 7}
assert config.template == f"{parent}/src/codeflare_sdk/templates/base-template.yaml"
assert config.machine_types == ["cpu.small", "gpu.large"]
assert config.image_pull_secrets == ["unit-test-pull-secret"]
assert config.appwrapper == True
def test_config_creation_wrong_type():
with pytest.raises(TypeError):
config = createClusterWrongType()
def test_cluster_creation(mocker):
# Create AppWrapper containing a Ray Cluster with no local queue specified
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
return_value=get_local_queue("kueue.x-k8s.io", "v1beta1", "ns", "localqueues"),
)
cluster = createClusterWithConfig(mocker)
assert cluster.app_wrapper_yaml == f"{aw_dir}unit-test-cluster.yaml"
assert cluster.app_wrapper_name == "unit-test-cluster"
assert filecmp.cmp(
f"{aw_dir}unit-test-cluster.yaml",
f"{parent}/tests/test-case.yaml",
shallow=True,
)
@patch.dict("os.environ", {"NB_PREFIX": "test-prefix"})
def test_cluster_no_kueue_no_aw(mocker):
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
mocker.patch(
"kubernetes.client.CustomObjectsApi.get_cluster_custom_object",
return_value={"spec": {"domain": "apps.cluster.awsroute.org"}},
)
mocker.patch("kubernetes.client.CustomObjectsApi.list_namespaced_custom_object")
config = createClusterConfig()
config.appwrapper = False
config.name = "unit-test-no-kueue"
config.write_to_file = True
cluster = Cluster(config)
assert cluster.app_wrapper_yaml == f"{aw_dir}unit-test-no-kueue.yaml"
assert cluster.config.local_queue == None
assert filecmp.cmp(
f"{aw_dir}unit-test-no-kueue.yaml",
f"{parent}/tests/test-case-no-kueue-no-aw.yaml",
shallow=True,
)
def get_local_queue(group, version, namespace, plural):
assert group == "kueue.x-k8s.io"
assert version == "v1beta1"
assert namespace == "ns"
assert plural == "localqueues"
local_queues = {
"apiVersion": "kueue.x-k8s.io/v1beta1",
"items": [
{
"apiVersion": "kueue.x-k8s.io/v1beta1",
"kind": "LocalQueue",
"metadata": {
"annotations": {"kueue.x-k8s.io/default-queue": "true"},
"name": "local-queue-default",
"namespace": "ns",
},
"spec": {"clusterQueue": "cluster-queue"},
},
{
"apiVersion": "kueue.x-k8s.io/v1beta1",
"kind": "LocalQueue",
"metadata": {
"name": "team-a-queue",
"namespace": "ns",
},
"spec": {"clusterQueue": "team-a-queue"},
},
],
"kind": "LocalQueueList",
"metadata": {"continue": "", "resourceVersion": "2266811"},
}
return local_queues
@patch.dict("os.environ", {"NB_PREFIX": "test-prefix"})
def test_cluster_creation_no_mcad(mocker):
# Create Ray Cluster with no local queue specified
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
mocker.patch(
"kubernetes.client.CustomObjectsApi.get_cluster_custom_object",
return_value={"spec": {"domain": "apps.cluster.awsroute.org"}},
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
return_value=get_local_queue("kueue.x-k8s.io", "v1beta1", "ns", "localqueues"),
)
config = createClusterConfig()
config.name = "unit-test-cluster-ray"
config.write_to_file = True
config.labels = {"testlabel": "test", "testlabel2": "test"}
config.appwrapper = False
cluster = Cluster(config)
assert cluster.app_wrapper_yaml == f"{aw_dir}unit-test-cluster-ray.yaml"
assert cluster.app_wrapper_name == "unit-test-cluster-ray"
assert filecmp.cmp(
f"{aw_dir}unit-test-cluster-ray.yaml",
f"{parent}/tests/test-case-no-mcad.yamls",
shallow=True,
)
@patch.dict("os.environ", {"NB_PREFIX": "test-prefix"})
def test_cluster_creation_no_mcad_local_queue(mocker):
# With written resources
# Create Ray Cluster with local queue specified
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
mocker.patch(
"kubernetes.client.CustomObjectsApi.get_cluster_custom_object",
return_value={"spec": {"domain": "apps.cluster.awsroute.org"}},
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
return_value=get_local_queue("kueue.x-k8s.io", "v1beta1", "ns", "localqueues"),
)
config = createClusterConfig()
config.name = "unit-test-cluster-ray"
config.appwrapper = False
config.write_to_file = True
config.local_queue = "local-queue-default"
config.labels = {"testlabel": "test", "testlabel2": "test"}
cluster = Cluster(config)
assert cluster.app_wrapper_yaml == f"{aw_dir}unit-test-cluster-ray.yaml"
assert cluster.app_wrapper_name == "unit-test-cluster-ray"
assert filecmp.cmp(
f"{aw_dir}unit-test-cluster-ray.yaml",
f"{parent}/tests/test-case-no-mcad.yamls",
shallow=True,
)
# With resources loaded in memory
config = ClusterConfiguration(
name="unit-test-cluster-ray",
namespace="ns",
num_workers=2,
worker_cpu_requests=3,
worker_cpu_limits=4,
worker_memory_requests=5,
worker_memory_limits=6,
worker_extended_resource_requests={"nvidia.com/gpu": 7},
machine_types=["cpu.small", "gpu.large"],
image_pull_secrets=["unit-test-pull-secret"],
write_to_file=True,
appwrapper=False,
local_queue="local-queue-default",
labels={"testlabel": "test", "testlabel2": "test"},
)
cluster = Cluster(config)
assert cluster.app_wrapper_yaml == f"{aw_dir}unit-test-cluster-ray.yaml"
assert cluster.app_wrapper_name == "unit-test-cluster-ray"
assert filecmp.cmp(
f"{aw_dir}unit-test-cluster-ray.yaml",
f"{parent}/tests/test-case-no-mcad.yamls",
shallow=True,
)
def test_default_cluster_creation(mocker):
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
mocker.patch(
"codeflare_sdk.cluster.cluster.get_current_namespace",
return_value="opendatahub",
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
return_value=get_local_queue("kueue.x-k8s.io", "v1beta1", "ns", "localqueues"),
)
default_config = ClusterConfiguration(
name="unit-test-default-cluster",
appwrapper=True,
)
cluster = Cluster(default_config)
test_aw = yaml.load(cluster.app_wrapper_yaml, Loader=yaml.FullLoader)
with open(
f"{parent}/tests/test-default-appwrapper.yaml",
) as f:
default_aw = yaml.load(f, Loader=yaml.FullLoader)
assert test_aw == default_aw
assert cluster.app_wrapper_name == "unit-test-default-cluster"
assert cluster.config.namespace == "opendatahub"
@patch.dict("os.environ", {"NB_PREFIX": "test-prefix"})
def test_cluster_creation_with_custom_image(mocker):
# With written resources
# Create Ray Cluster with local queue specified
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
mocker.patch(
"kubernetes.client.CustomObjectsApi.get_cluster_custom_object",
return_value={"spec": {"domain": "apps.cluster.awsroute.org"}},
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
return_value=get_local_queue("kueue.x-k8s.io", "v1beta1", "ns", "localqueues"),
)
config = createClusterConfig()
config.name = "unit-test-cluster-custom-image"
config.appwrapper = False
config.image = "quay.io/project-codeflare/ray:2.20.0-py39-cu118"
config.local_queue = "local-queue-default"
config.labels = {"testlabel": "test", "testlabel2": "test"}
cluster = Cluster(config)
assert cluster.app_wrapper_yaml == f"{aw_dir}unit-test-cluster-custom-image.yaml"
assert cluster.app_wrapper_name == "unit-test-cluster-custom-image"
assert filecmp.cmp(
f"{aw_dir}unit-test-cluster-custom-image.yaml",
f"{parent}/tests/test-case-custom-image.yaml",
shallow=True,
)
# With resources loaded in memory
config = ClusterConfiguration(
name="unit-test-cluster-custom-image",
namespace="ns",
num_workers=2,
worker_cpu_requests=3,
worker_cpu_limits=4,
worker_memory_requests=5,
worker_memory_limits=6,
worker_extended_resource_requests={"nvidia.com/gpu": 7},
machine_types=["cpu.small", "gpu.large"],
image_pull_secrets=["unit-test-pull-secret"],
image="quay.io/project-codeflare/ray:2.20.0-py39-cu118",
write_to_file=True,
appwrapper=False,
local_queue="local-queue-default",
labels={"testlabel": "test", "testlabel2": "test"},
)
cluster = Cluster(config)
assert cluster.app_wrapper_yaml == f"{aw_dir}unit-test-cluster-custom-image.yaml"
assert cluster.app_wrapper_name == "unit-test-cluster-custom-image"
assert filecmp.cmp(
f"{aw_dir}unit-test-cluster-custom-image.yaml",
f"{parent}/tests/test-case-custom-image.yaml",
shallow=True,
)
def test_gen_names_with_name(mocker):
mocker.patch.object(
uuid, "uuid4", return_value=uuid.UUID("00000000-0000-0000-0000-000000000001")
)
name = "myname"
appwrapper_name, cluster_name = gen_names(name)
assert appwrapper_name == name
assert cluster_name == name
def test_gen_names_without_name(mocker):
mocker.patch.object(
uuid, "uuid4", return_value=uuid.UUID("00000000-0000-0000-0000-000000000001")
)
appwrapper_name, cluster_name = gen_names(None)
assert appwrapper_name.startswith("appwrapper-")
assert cluster_name.startswith("cluster-")
def arg_check_apply_effect(group, version, namespace, plural, body, *args):
assert namespace == "ns"
assert args == tuple()
if plural == "appwrappers":
assert group == "workload.codeflare.dev"
assert version == "v1beta2"
with open(f"{aw_dir}unit-test-cluster.yaml") as f:
aw = yaml.load(f, Loader=yaml.FullLoader)
assert body == aw
elif plural == "rayclusters":
assert group == "ray.io"
assert version == "v1"
with open(f"{aw_dir}unit-test-cluster-ray.yaml") as f:
yamls = yaml.load_all(f, Loader=yaml.FullLoader)
for resource in yamls:
if resource["kind"] == "RayCluster":
assert body == resource
elif plural == "ingresses":
assert group == "networking.k8s.io"
assert version == "v1"
with open(f"{aw_dir}unit-test-cluster-ray.yaml") as f:
yamls = yaml.load_all(f, Loader=yaml.FullLoader)
for resource in yamls:
if resource["kind"] == "Ingress":
assert body == resource
elif plural == "routes":
assert group == "route.openshift.io"
assert version == "v1"
with open(f"{aw_dir}unit-test-cluster-ray.yaml") as f:
yamls = yaml.load_all(f, Loader=yaml.FullLoader)
for resource in yamls:
if resource["kind"] == "Ingress":
assert body == resource
else:
assert 1 == 0
def arg_check_del_effect(group, version, namespace, plural, name, *args):
assert namespace == "ns"
assert args == tuple()
if plural == "appwrappers":
assert group == "workload.codeflare.dev"
assert version == "v1beta2"
assert name == "unit-test-cluster"
elif plural == "rayclusters":
assert group == "ray.io"
assert version == "v1"
assert name == "unit-test-cluster-ray"
elif plural == "ingresses":
assert group == "networking.k8s.io"
assert version == "v1"
assert name == "ray-dashboard-unit-test-cluster-ray"
def test_cluster_up_down(mocker):
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
mocker.patch("kubernetes.config.load_kube_config", return_value="ignore")
mocker.patch("codeflare_sdk.cluster.cluster.Cluster._throw_for_no_raycluster")
mocker.patch(
"kubernetes.client.CustomObjectsApi.get_cluster_custom_object",
return_value={"spec": {"domain": ""}},
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.create_namespaced_custom_object",
side_effect=arg_check_apply_effect,
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.delete_namespaced_custom_object",
side_effect=arg_check_del_effect,
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_cluster_custom_object",
return_value={"items": []},
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
return_value=get_local_queue("kueue.x-k8s.io", "v1beta1", "ns", "localqueues"),
)
cluster = cluster = createClusterWithConfig(mocker)
cluster.up()
cluster.down()
def test_cluster_up_down_no_mcad(mocker):
mocker.patch("codeflare_sdk.cluster.cluster.Cluster._throw_for_no_raycluster")
mocker.patch("kubernetes.config.load_kube_config", return_value="ignore")
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
return_value=get_local_queue("kueue.x-k8s.io", "v1beta1", "ns", "localqueues"),
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.create_namespaced_custom_object",
side_effect=arg_check_apply_effect,
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.delete_namespaced_custom_object",
side_effect=arg_check_del_effect,
)
mocker.patch(
"kubernetes.client.CoreV1Api.create_namespaced_secret",
)
mocker.patch(
"kubernetes.client.CoreV1Api.delete_namespaced_secret",
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_cluster_custom_object",
return_value={"items": []},
)
config = createClusterConfig()
config.name = "unit-test-cluster-ray"
config.appwrapper = False
cluster = Cluster(config)
cluster.up()
cluster.down()
def arg_check_list_effect(group, version, plural, name, *args):
assert group == "config.openshift.io"
assert version == "v1"
assert plural == "ingresses"
assert name == "cluster"
assert args == tuple()
return {"spec": {"domain": "test"}}
""" We need to fix get_current_namespace in order to reuse this test.
def test_get_ingress_domain(mocker):
mocker.patch("kubernetes.config.load_kube_config", return_value="ignore")
mocker.patch(
"kubernetes.client.CustomObjectsApi.get_cluster_custom_object",
side_effect=arg_check_list_effect,
)
domain = _get_ingress_domain()
assert domain == "test"
"""
def aw_status_fields(group, version, namespace, plural, *args):
assert group == "workload.codeflare.dev"
assert version == "v1beta2"
assert namespace == "test-ns"
assert plural == "appwrappers"
assert args == tuple()
return {"items": []}
def test_aw_status(mocker):
mocker.patch("kubernetes.config.load_kube_config", return_value="ignore")
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
side_effect=aw_status_fields,
)
aw = _app_wrapper_status("test-aw", "test-ns")
assert aw == None
def rc_status_fields(group, version, namespace, plural, *args):
assert group == "ray.io"
assert version == "v1"
assert namespace == "test-ns"
assert plural == "rayclusters"
assert args == tuple()
return {"items": []}
def test_rc_status(mocker):
mocker.patch("kubernetes.config.load_kube_config", return_value="ignore")
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
side_effect=rc_status_fields,
)
rc = _ray_cluster_status("test-rc", "test-ns")
assert rc == None
def test_cluster_uris(mocker):
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
mocker.patch("kubernetes.config.load_kube_config", return_value="ignore")
mocker.patch(
"codeflare_sdk.cluster.cluster._get_ingress_domain",
return_value="apps.cluster.awsroute.org",
)
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
return_value=get_local_queue("kueue.x-k8s.io", "v1beta1", "ns", "localqueues"),
)
cluster = cluster = createClusterWithConfig(mocker)
mocker.patch(
"kubernetes.client.NetworkingV1Api.list_namespaced_ingress",
return_value=ingress_retrieval(
cluster_name="unit-test-cluster",
annotations={"route.openshift.io/termination": "passthrough"},
),
)
assert (
cluster.cluster_dashboard_uri()
== "https://ray-dashboard-unit-test-cluster-ns.apps.cluster.awsroute.org"
)
mocker.patch(
"kubernetes.client.NetworkingV1Api.list_namespaced_ingress",
return_value=ingress_retrieval(),
)
assert cluster.cluster_uri() == "ray://unit-test-cluster-head-svc.ns.svc:10001"
assert (
cluster.cluster_dashboard_uri()
== "http://ray-dashboard-unit-test-cluster-ns.apps.cluster.awsroute.org"
)
cluster.config.name = "fake"
mocker.patch(
"kubernetes.client.NetworkingV1Api.list_namespaced_ingress",
)
assert (
cluster.cluster_dashboard_uri()
== "Dashboard not available yet, have you run cluster.up()?"
)
def test_local_client_url(mocker):
mocker.patch(
"kubernetes.client.CustomObjectsApi.get_cluster_custom_object",
return_value={"spec": {"domain": ""}},
)
mocker.patch(
"codeflare_sdk.cluster.cluster._get_ingress_domain",
return_value="rayclient-unit-test-cluster-localinter-ns.apps.cluster.awsroute.org",
)
mocker.patch(
"codeflare_sdk.cluster.cluster.Cluster.create_app_wrapper",
return_value="unit-test-cluster-localinter.yaml",
)
cluster_config = ClusterConfiguration(
name="unit-test-cluster-localinter",
namespace="ns",
write_to_file=True,
)
cluster = Cluster(cluster_config)
assert (
cluster.local_client_url()
== "ray://rayclient-unit-test-cluster-localinter-ns.apps.cluster.awsroute.org"
)
def ray_addr(self, *args):
return self._address
def mocked_ingress(port, cluster_name="unit-test-cluster", annotations: dict = None):
labels = {"ingress-owner": cluster_name}
if port == 10001:
name = f"rayclient-{cluster_name}"
else:
name = f"ray-dashboard-{cluster_name}"
mock_ingress = client.V1Ingress(
metadata=client.V1ObjectMeta(
name=name,
annotations=annotations,
labels=labels,
owner_references=[
client.V1OwnerReference(
api_version="v1", kind="Ingress", name=cluster_name, uid="unique-id"
)
],
),
spec=client.V1IngressSpec(
rules=[
client.V1IngressRule(
host=f"{name}-ns.apps.cluster.awsroute.org",
http=client.V1HTTPIngressRuleValue(
paths=[
client.V1HTTPIngressPath(
path_type="Prefix",
path="/",
backend=client.V1IngressBackend(
service=client.V1IngressServiceBackend(
name="head-svc-test",
port=client.V1ServiceBackendPort(number=port),
)
),
)
]
),
)
],
),
)
return mock_ingress
def ingress_retrieval(
cluster_name="unit-test-cluster", client_ing: bool = False, annotations: dict = None
):
dashboard_ingress = mocked_ingress(8265, cluster_name, annotations)
if client_ing:
client_ingress = mocked_ingress(
10001, cluster_name=cluster_name, annotations=annotations
)
mock_ingress_list = client.V1IngressList(
items=[client_ingress, dashboard_ingress]
)
else:
mock_ingress_list = client.V1IngressList(items=[dashboard_ingress])
return mock_ingress_list
def test_ray_job_wrapping(mocker):
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
mocker.patch(
"kubernetes.client.CustomObjectsApi.list_namespaced_custom_object",
return_value=get_local_queue("kueue.x-k8s.io", "v1beta1", "ns", "localqueues"),
)
cluster = cluster = createClusterWithConfig(mocker)
mocker.patch(
"ray.job_submission.JobSubmissionClient._check_connection_and_version_with_url",
return_value="None",
)
mock_res = mocker.patch.object(
ray.job_submission.JobSubmissionClient, "list_jobs", autospec=True
)
mock_res.side_effect = ray_addr
mocker.patch(
"kubernetes.client.CustomObjectsApi.get_cluster_custom_object",
return_value={"spec": {"domain": ""}},
)
mocker.patch(
"kubernetes.client.NetworkingV1Api.list_namespaced_ingress",
return_value=ingress_retrieval(),
)
assert cluster.list_jobs() == cluster.cluster_dashboard_uri()
mock_res = mocker.patch.object(
ray.job_submission.JobSubmissionClient, "get_job_status", autospec=True
)
mock_res.side_effect = ray_addr
assert cluster.job_status("fake_id") == cluster.cluster_dashboard_uri()
mock_res = mocker.patch.object(
ray.job_submission.JobSubmissionClient, "get_job_logs", autospec=True
)
mock_res.side_effect = ray_addr
assert cluster.job_logs("fake_id") == cluster.cluster_dashboard_uri()
def test_print_no_resources(capsys):
try:
print_no_resources_found()
except:
assert 1 == 0
captured = capsys.readouterr()
assert captured.out == (
"╭──────────────────────────────────────────────────────────────────────────────╮\n"
"│ No resources found, have you run cluster.up() yet? │\n"
"╰──────────────────────────────────────────────────────────────────────────────╯\n"
)
def test_print_no_cluster(capsys):
try:
print_cluster_status(None)
except:
assert 1 == 0
captured = capsys.readouterr()
assert captured.out == (
"╭──────────────────────────────────────────────────────────────────────────────╮\n"
"│ No resources found, have you run cluster.up() yet? │\n"
"╰──────────────────────────────────────────────────────────────────────────────╯\n"
)
def test_print_appwrappers(capsys):
aw1 = AppWrapper(
name="awtest1",
status=AppWrapperStatus.SUSPENDED,
)
aw2 = AppWrapper(
name="awtest2",
status=AppWrapperStatus.RUNNING,
)
try:
print_app_wrappers_status([aw1, aw2])
except:
assert 1 == 0
captured = capsys.readouterr()
assert captured.out == (
"╭─────────────────────────╮\n"
"│ 🚀 Cluster Queue │\n"
"│ Status 🚀 │\n"
"│ +---------+-----------+ │\n"
"│ | Name | Status | │\n"
"│ +=========+===========+ │\n"
"│ | awtest1 | suspended | │\n"
"│ | | | │\n"
"│ | awtest2 | running | │\n"
"│ | | | │\n"
"│ +---------+-----------+ │\n"
"╰─────────────────────────╯\n"
)
def test_ray_details(mocker, capsys):
mocker.patch("kubernetes.client.ApisApi.get_api_versions")
ray1 = RayCluster(
name="raytest1",
status=RayClusterStatus.READY,
num_workers=1,
worker_mem_requests="2G",
worker_mem_limits="2G",
worker_cpu_requests=1,
worker_cpu_limits=1,
namespace="ns",
dashboard="fake-uri",
head_cpu_requests=2,
head_cpu_limits=2,
head_mem_requests=8,
head_mem_limits=8,
)
mocker.patch(
"codeflare_sdk.cluster.cluster.Cluster.status",
return_value=(False, CodeFlareClusterStatus.UNKNOWN),
)
mocker.patch(
"codeflare_sdk.cluster.cluster.Cluster.cluster_dashboard_uri",
return_value="",
)
mocker.patch(
"codeflare_sdk.utils.generate_yaml.local_queue_exists",
return_value="true",
)
cf = Cluster(
ClusterConfiguration(
name="raytest2",
namespace="ns",
write_to_file=True,
appwrapper=True,
local_queue="local_default_queue",
)
)
captured = capsys.readouterr()
ray2 = _copy_to_ray(cf)
details = cf.details()
assert details == ray2
assert ray2.name == "raytest2"
assert ray1.namespace == ray2.namespace
assert ray1.num_workers == ray2.num_workers
assert ray1.worker_mem_requests == ray2.worker_mem_requests
assert ray1.worker_mem_limits == ray2.worker_mem_limits
assert ray1.worker_cpu_requests == ray2.worker_cpu_requests
assert ray1.worker_cpu_limits == ray2.worker_cpu_limits
assert ray1.worker_extended_resources == ray2.worker_extended_resources
try:
print_clusters([ray1, ray2])
print_cluster_status(ray1)
print_cluster_status(ray2)
except:
assert 0 == 1
captured = capsys.readouterr()
assert captured.out == (
" 🚀 CodeFlare Cluster Details 🚀 \n"
" \n"
" ╭───────────────────────────────────────────────────────────────╮ \n"