-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_instance.py
More file actions
1743 lines (1378 loc) · 68.3 KB
/
test_instance.py
File metadata and controls
1743 lines (1378 loc) · 68.3 KB
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
from typer.testing import CliRunner
from remote.instance import app
from remote.utils import get_launch_template_id
runner = CliRunner()
# ============================================================================
# Instance CLI Command Tests
# ============================================================================
class TestInstanceStatusCommand:
"""Test the 'remote status' command behavior."""
def test_should_report_error_when_instance_not_found(self, mocker):
"""Should exit with error code 1 when instance doesn't exist."""
mock_ec2_client = mocker.patch("remote.utils.get_ec2_client")
mock_ec2_client.return_value.describe_instances.return_value = {"Reservations": []}
result = runner.invoke(app, ["status", "test"])
assert result.exit_code == 1
assert "Instance 'test' not found" in result.stdout
class TestInstanceListCommand:
"""Test the 'remote list' command behavior."""
def test_should_show_table_headers_when_no_instances_exist(self, mocker):
"""Should display table headers even when no instances are found."""
mock_ec2_client = mocker.patch("remote.utils.get_ec2_client")
# Mock the paginator for get_instances() which uses pagination
mock_paginator = mocker.MagicMock()
mock_paginator.paginate.return_value = [{"Reservations": []}]
mock_ec2_client.return_value.get_paginator.return_value = mock_paginator
result = runner.invoke(app, ["list"])
assert result.exit_code == 0
assert "Name" in result.stdout
assert "InstanceId" in result.stdout
assert "PublicDnsName" in result.stdout
assert "Status" in result.stdout
def test_should_display_instance_details_when_instances_exist(self, mocker, mock_ec2_instances):
"""Should show instance details in tabular format when instances are found."""
mock_ec2_client = mocker.patch("remote.utils.get_ec2_client")
# Mock the paginator
mock_paginator = mocker.MagicMock()
mock_paginator.paginate.return_value = [mock_ec2_instances]
mock_ec2_client.return_value.get_paginator.return_value = mock_paginator
result = runner.invoke(app, ["list"])
# Verify paginator was used
mock_ec2_client.return_value.get_paginator.assert_called_once_with("describe_instances")
# Verify table headers are present
assert "Name" in result.stdout
assert "InstanceId" in result.stdout
assert "PublicDnsName" in result.stdout
assert "Status" in result.stdout
assert "Type" in result.stdout
assert "Launch Time" in result.stdout
# Verify actual instance data is displayed
assert "i-0123456789abcdef0" in result.stdout
assert "running" in result.stdout
assert "t2.micro" in result.stdout
assert "2023-07-15 00:00:00 UTC" in result.stdout
def test_should_hide_cost_columns_by_default(self, mocker):
"""Should not display cost columns by default (without --cost flag)."""
mock_ec2_client = mocker.patch("remote.utils.get_ec2_client")
mock_paginator = mocker.MagicMock()
mock_paginator.paginate.return_value = [{"Reservations": []}]
mock_ec2_client.return_value.get_paginator.return_value = mock_paginator
result = runner.invoke(app, ["list"])
assert result.exit_code == 0
# Cost columns should be hidden by default
assert "$/hr" not in result.stdout
assert "Est. Cost" not in result.stdout
assert "Uptime" not in result.stdout
def test_should_not_call_pricing_api_by_default(self, mocker, mock_ec2_instances):
"""Should skip pricing API calls by default (without --cost flag)."""
mock_ec2_client = mocker.patch("remote.utils.get_ec2_client")
mock_paginator = mocker.MagicMock()
mock_paginator.paginate.return_value = [mock_ec2_instances]
mock_ec2_client.return_value.get_paginator.return_value = mock_paginator
mock_get_price = mocker.patch("remote.instance.get_instance_price_with_fallback")
result = runner.invoke(app, ["list"])
assert result.exit_code == 0
mock_get_price.assert_not_called()
class TestLaunchTemplateUtilities:
"""Test launch template utility functions."""
def test_should_return_template_id_when_template_found_by_name(self, mocker):
"""Should return the launch template ID when template is found by name tag."""
mock_ec2_client = mocker.patch("remote.utils.get_ec2_client")
mock_ec2_client.return_value.describe_launch_templates.return_value = {
"LaunchTemplates": [{"LaunchTemplateId": "lt-0123456789abcdef0"}]
}
result = get_launch_template_id("my-template-name")
mock_ec2_client.return_value.describe_launch_templates.assert_called_once_with(
Filters=[{"Name": "tag:Name", "Values": ["my-template-name"]}]
)
assert result == "lt-0123456789abcdef0"
def test_should_show_running_instance_status_details(self, mocker):
"""Should display detailed status information for a running instance."""
mock_get_instance_name = mocker.patch(
"remote.instance.get_instance_name", return_value="test-instance"
)
mock_get_instance_id = mocker.patch(
"remote.instance.get_instance_id", return_value="i-0123456789abcdef0"
)
mock_get_instance_status = mocker.patch(
"remote.instance.get_instance_status",
return_value={
"InstanceStatuses": [
{
"InstanceId": "i-0123456789abcdef0",
"InstanceState": {"Name": "running"},
"SystemStatus": {"Status": "ok"},
"InstanceStatus": {"Status": "ok", "Details": [{"Status": "passed"}]},
}
]
},
)
# Mock EC2 client for describe_instances call
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mock_ec2_client.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "running"},
"InstanceType": "t2.micro",
"PublicIpAddress": "1.2.3.4",
"PrivateIpAddress": "10.0.0.1",
"PublicDnsName": "ec2-1-2-3-4.compute-1.amazonaws.com",
"KeyName": "my-key",
"Placement": {"AvailabilityZone": "us-east-1a"},
"SecurityGroups": [{"GroupName": "default"}],
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
result = runner.invoke(app, ["status"])
# Verify command succeeds
assert result.exit_code == 0
# Verify correct call sequence
mock_get_instance_name.assert_called_once()
mock_get_instance_id.assert_called_once_with("test-instance")
mock_get_instance_status.assert_called_once_with("i-0123456789abcdef0")
# Verify status information is displayed
assert "test-instance" in result.stdout
assert "running" in result.stdout
# Verify detailed info is shown
assert "t2.micro" in result.stdout
assert "1.2.3.4" in result.stdout
def test_should_show_stopped_instance_details(self, mocker):
"""Should display details for stopped instances (without health status)."""
mock_get_instance_id = mocker.patch(
"remote.instance.get_instance_id", return_value="i-0123456789abcdef0"
)
mocker.patch("remote.instance.get_instance_status", return_value={"InstanceStatuses": []})
# Mock EC2 client for describe_instances call
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mock_ec2_client.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "stopped"},
"InstanceType": "t2.micro",
"PrivateIpAddress": "10.0.0.1",
"KeyName": "my-key",
"Placement": {"AvailabilityZone": "us-east-1a"},
"SecurityGroups": [{"GroupName": "default"}],
"Tags": [{"Key": "Name", "Value": "specific-instance"}],
}
]
}
]
}
result = runner.invoke(app, ["status", "specific-instance"])
assert result.exit_code == 0
mock_get_instance_id.assert_called_once_with("specific-instance")
# Verify basic info is displayed
assert "specific-instance" in result.stdout
assert "stopped" in result.stdout
assert "t2.micro" in result.stdout
class TestStatusWatchMode:
"""Test the watch mode functionality for the status command."""
def test_should_reject_interval_less_than_one(self, mocker):
"""Should exit with error when interval is less than 1."""
mocker.patch("remote.instance.get_instance_name", return_value="test-instance")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
result = runner.invoke(app, ["status", "--watch", "--interval", "0"])
assert result.exit_code == 1
assert "Interval must be at least 1 second" in result.stdout
def test_should_accept_watch_flag(self, mocker):
"""Should accept the --watch flag and enter watch mode."""
mocker.patch("remote.instance.get_instance_name", return_value="test-instance")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
# Mock _watch_status to avoid actually entering the infinite loop
mock_watch = mocker.patch("remote.instance._watch_status")
result = runner.invoke(app, ["status", "--watch"])
assert result.exit_code == 0
mock_watch.assert_called_once_with("test-instance", "i-0123456789abcdef0", 2)
def test_should_accept_short_watch_flag(self, mocker):
"""Should accept the -w short flag for watch mode."""
mocker.patch("remote.instance.get_instance_name", return_value="test-instance")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mock_watch = mocker.patch("remote.instance._watch_status")
result = runner.invoke(app, ["status", "-w"])
assert result.exit_code == 0
mock_watch.assert_called_once()
def test_should_accept_custom_interval(self, mocker):
"""Should accept custom interval via --interval flag."""
mocker.patch("remote.instance.get_instance_name", return_value="test-instance")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mock_watch = mocker.patch("remote.instance._watch_status")
result = runner.invoke(app, ["status", "--watch", "--interval", "5"])
assert result.exit_code == 0
mock_watch.assert_called_once_with("test-instance", "i-0123456789abcdef0", 5)
def test_should_accept_short_interval_flag(self, mocker):
"""Should accept -i short flag for interval."""
mocker.patch("remote.instance.get_instance_name", return_value="test-instance")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mock_watch = mocker.patch("remote.instance._watch_status")
result = runner.invoke(app, ["status", "-w", "-i", "10"])
assert result.exit_code == 0
mock_watch.assert_called_once_with("test-instance", "i-0123456789abcdef0", 10)
class TestBuildStatusTable:
"""Test the _build_status_table helper function."""
def test_should_return_panel_for_running_instance(self, mocker):
"""Should return a Rich Panel for a running instance."""
from rich.panel import Panel
from remote.instance import _build_status_table
mocker.patch(
"remote.instance.get_instance_status",
return_value={
"InstanceStatuses": [
{
"InstanceId": "i-0123456789abcdef0",
"InstanceState": {"Name": "running"},
"SystemStatus": {"Status": "ok"},
"InstanceStatus": {"Status": "ok", "Details": [{"Status": "passed"}]},
}
]
},
)
# Mock EC2 client for describe_instances call
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mock_ec2_client.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "running"},
"InstanceType": "t2.micro",
"PublicIpAddress": "1.2.3.4",
"PrivateIpAddress": "10.0.0.1",
"PublicDnsName": "ec2-1-2-3-4.compute-1.amazonaws.com",
"KeyName": "my-key",
"Placement": {"AvailabilityZone": "us-east-1a"},
"SecurityGroups": [{"GroupName": "default"}],
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
result = _build_status_table("test-instance", "i-0123456789abcdef0")
assert isinstance(result, Panel)
def test_should_return_panel_with_expand_false(self, mocker):
"""Panel should not expand to full terminal width."""
from rich.panel import Panel
from remote.instance import _build_status_table
mocker.patch(
"remote.instance.get_instance_status",
return_value={
"InstanceStatuses": [
{
"InstanceId": "i-0123456789abcdef0",
"InstanceState": {"Name": "running"},
"SystemStatus": {"Status": "ok"},
"InstanceStatus": {"Status": "ok", "Details": [{"Status": "passed"}]},
}
]
},
)
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mock_ec2_client.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "running"},
"InstanceType": "t2.micro",
"PublicIpAddress": "1.2.3.4",
"PrivateIpAddress": "10.0.0.1",
"PublicDnsName": "ec2-1-2-3-4.compute-1.amazonaws.com",
"KeyName": "my-key",
"Placement": {"AvailabilityZone": "us-east-1a"},
"SecurityGroups": [{"GroupName": "default"}],
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
result = _build_status_table("test-instance", "i-0123456789abcdef0")
assert isinstance(result, Panel)
assert result.expand is False
def test_should_return_panel_for_stopped_instance(self, mocker):
"""Should return a Panel for stopped instances (without health section)."""
from rich.panel import Panel
from remote.instance import _build_status_table
mocker.patch(
"remote.instance.get_instance_status",
return_value={"InstanceStatuses": []},
)
# Mock EC2 client for describe_instances call
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mock_ec2_client.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "stopped"},
"InstanceType": "t2.micro",
"PrivateIpAddress": "10.0.0.1",
"KeyName": "my-key",
"Placement": {"AvailabilityZone": "us-east-1a"},
"SecurityGroups": [{"GroupName": "default"}],
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
result = _build_status_table("test-instance", "i-0123456789abcdef0")
# Should still return a Panel with basic info (just no health section)
assert isinstance(result, Panel)
def test_should_return_error_string_for_not_found_instance(self, mocker):
"""Should return an error string when instance is not found."""
from remote.instance import _build_status_table
mocker.patch(
"remote.instance.get_instance_status",
return_value={"InstanceStatuses": []},
)
# Mock EC2 client returning empty reservations
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mock_ec2_client.return_value.describe_instances.return_value = {"Reservations": []}
result = _build_status_table("test-instance", "i-0123456789abcdef0")
assert isinstance(result, str)
assert "not found" in result
class TestWatchStatusFunction:
"""Test the _watch_status function."""
def test_should_handle_keyboard_interrupt(self, mocker):
"""Should handle Ctrl+C gracefully."""
from remote.instance import _watch_status
# Mock time.sleep to raise KeyboardInterrupt
mocker.patch("remote.instance.time.sleep", side_effect=KeyboardInterrupt)
# Mock _build_status_table to return a simple string
mocker.patch("remote.instance._build_status_table", return_value="test")
# Mock console (imported from utils) and Live
mocker.patch("remote.instance.console")
mock_live = mocker.patch("remote.instance.Live")
mock_live.return_value.__enter__ = mocker.Mock(return_value=mock_live.return_value)
mock_live.return_value.__exit__ = mocker.Mock(return_value=False)
# Should not raise, should exit gracefully
_watch_status("test-instance", "i-0123456789abcdef0", 2)
# Verify the function tried to update at least once
mock_live.return_value.update.assert_called()
def test_start_instance_already_running(mocker):
mock_get_instance_name = mocker.patch(
"remote.instance.get_instance_name", return_value="test-instance"
)
mock_get_instance_id = mocker.patch(
"remote.instance.get_instance_id", return_value="i-0123456789abcdef0"
)
mock_is_instance_running = mocker.patch(
"remote.instance.is_instance_running", return_value=True
)
result = runner.invoke(app, ["start"])
assert result.exit_code == 0
mock_get_instance_name.assert_called_once()
mock_get_instance_id.assert_called_once_with("test-instance")
mock_is_instance_running.assert_called_once_with("i-0123456789abcdef0")
assert "Instance test-instance is already running" in result.stdout
def test_start_instance_success(mocker):
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mock_get_instance_id = mocker.patch(
"remote.instance.get_instance_id", return_value="i-0123456789abcdef0"
)
mock_is_instance_running = mocker.patch(
"remote.instance.is_instance_running", return_value=False
)
result = runner.invoke(app, ["start", "test-instance"])
assert result.exit_code == 0
mock_get_instance_id.assert_called_once_with("test-instance")
mock_is_instance_running.assert_called_once_with("i-0123456789abcdef0")
mock_ec2_client.return_value.start_instances.assert_called_once_with(
InstanceIds=["i-0123456789abcdef0"]
)
assert "Instance test-instance started" in result.stdout
def test_start_instance_exception(mocker):
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mocker.patch("remote.instance.is_instance_running", return_value=False)
from botocore.exceptions import ClientError
error_response = {"Error": {"Code": "TestError", "Message": "AWS Error"}}
mock_ec2_client.return_value.start_instances.side_effect = ClientError(
error_response, "start_instances"
)
result = runner.invoke(app, ["start", "test-instance"])
assert result.exit_code == 1
assert "AWS Error starting instance test-instance: AWS Error (TestError)" in result.stdout
def test_stop_instance_already_stopped(mocker):
mock_get_instance_id = mocker.patch(
"remote.instance.get_instance_id", return_value="i-0123456789abcdef0"
)
mock_is_instance_running = mocker.patch(
"remote.instance.is_instance_running", return_value=False
)
result = runner.invoke(app, ["stop", "test-instance"])
assert result.exit_code == 0
mock_get_instance_id.assert_called_once_with("test-instance")
mock_is_instance_running.assert_called_once_with("i-0123456789abcdef0")
assert "Instance test-instance is already stopped" in result.stdout
def test_stop_instance_confirmed(mocker):
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mocker.patch("remote.instance.is_instance_running", return_value=True)
result = runner.invoke(app, ["stop", "test-instance"], input="y\n")
assert result.exit_code == 0
mock_ec2_client.return_value.stop_instances.assert_called_once_with(
InstanceIds=["i-0123456789abcdef0"]
)
assert "Instance test-instance is stopping" in result.stdout
def test_stop_instance_cancelled(mocker):
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mocker.patch("remote.instance.is_instance_running", return_value=True)
result = runner.invoke(app, ["stop", "test-instance"], input="n\n")
assert result.exit_code == 0
mock_ec2_client.return_value.stop_instances.assert_not_called()
assert "Instance test-instance is still running" in result.stdout
def test_stop_instance_exception(mocker):
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mocker.patch("remote.instance.is_instance_running", return_value=True)
from botocore.exceptions import ClientError
error_response = {"Error": {"Code": "TestError", "Message": "AWS Error"}}
mock_ec2_client.return_value.stop_instances.side_effect = ClientError(
error_response, "stop_instances"
)
result = runner.invoke(app, ["stop", "test-instance"], input="y\n")
assert result.exit_code == 1
assert "AWS Error stopping instance test-instance: AWS Error (TestError)" in result.stdout
def test_type_command_show_current_type(mocker):
mock_get_instance_name = mocker.patch(
"remote.instance.get_instance_name", return_value="test-instance"
)
mock_get_instance_id = mocker.patch(
"remote.instance.get_instance_id", return_value="i-0123456789abcdef0"
)
mock_get_instance_type = mocker.patch(
"remote.instance.get_instance_type", return_value="t2.micro"
)
result = runner.invoke(app, ["type"])
assert result.exit_code == 0
mock_get_instance_name.assert_called_once()
mock_get_instance_id.assert_called_once_with("test-instance")
# get_instance_type is called twice - once to get current, once at the end
assert mock_get_instance_type.call_count >= 1
assert "Instance test-instance is currently of type t2.micro" in result.stdout
def test_type_command_same_type(mocker):
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mocker.patch("remote.instance.get_instance_type", return_value="t2.micro")
result = runner.invoke(app, ["type", "t2.micro", "test-instance"])
assert result.exit_code == 0
assert "Instance test-instance is already of type t2.micro" in result.stdout
def test_type_command_running_instance_error(mocker):
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mocker.patch("remote.instance.get_instance_type", return_value="t2.micro")
mocker.patch("remote.instance.is_instance_running", return_value=True)
result = runner.invoke(app, ["type", "t2.small", "test-instance"])
assert result.exit_code == 1
assert "You can only change the type of a stopped instances" in result.stdout
def test_type_command_change_success(mocker):
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mocker.patch("remote.instance.get_instance_type", side_effect=["t2.micro", "t2.small"])
mocker.patch("remote.instance.is_instance_running", return_value=False)
mocker.patch("remote.instance.time.sleep")
result = runner.invoke(app, ["type", "t2.small", "test-instance"])
assert result.exit_code == 0
mock_ec2_client.return_value.modify_instance_attribute.assert_called_once_with(
InstanceId="i-0123456789abcdef0", InstanceType={"Value": "t2.small"}
)
assert "Instance test-instance is now of type t2.small" in result.stdout
def test_terminate_instance_name_mismatch(mocker):
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mock_get_instance_name = mocker.patch(
"remote.instance.get_instance_name", return_value="test-instance"
)
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
# Mock the describe_instances call that happens in terminate function
mock_ec2_client.return_value.describe_instances.return_value = {
"Reservations": [{"Instances": [{"Tags": []}]}]
}
result = runner.invoke(app, ["terminate"], input="wrong-name\n")
assert result.exit_code == 0
mock_get_instance_name.assert_called_once()
assert "Instance names did not match. Aborting termination." in result.stdout
def test_terminate_instance_cancelled(mocker):
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mock_ec2_client.return_value.describe_instances.return_value = {
"Reservations": [{"Instances": [{"Tags": []}]}]
}
result = runner.invoke(app, ["terminate", "test-instance"], input="test-instance\nn\n")
assert result.exit_code == 0
mock_ec2_client.return_value.terminate_instances.assert_not_called()
assert "Termination of instance test-instance has been cancelled" in result.stdout
def test_terminate_instance_confirmed(mocker):
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mock_ec2_client.return_value.describe_instances.return_value = {
"Reservations": [{"Instances": [{"Tags": []}]}]
}
result = runner.invoke(app, ["terminate", "test-instance"], input="test-instance\ny\n")
assert result.exit_code == 0
mock_ec2_client.return_value.terminate_instances.assert_called_once_with(
InstanceIds=["i-0123456789abcdef0"]
)
assert "Instance test-instance is being terminated" in result.stdout
def test_terminate_terraform_managed_instance(mocker):
mock_ec2_client = mocker.patch("remote.instance.get_ec2_client")
mocker.patch("remote.instance.get_instance_id", return_value="i-0123456789abcdef0")
mock_ec2_client.return_value.describe_instances.return_value = {
"Reservations": [
{"Instances": [{"Tags": [{"Key": "Environment", "Value": "terraform-managed"}]}]}
]
}
result = runner.invoke(app, ["terminate", "test-instance"], input="test-instance\ny\n")
assert result.exit_code == 0
assert "This instance appears to be managed by Terraform" in result.stdout
def test_connect_with_key_option(mocker):
"""Test that --key option adds -i flag to SSH command."""
# Mock the AWS EC2 client in utils (where get_instance_id and is_instance_running are defined)
mock_ec2 = mocker.patch("remote.utils.get_ec2_client")
# Mock subprocess.run to capture the SSH command
mock_subprocess = mocker.patch("remote.instance.subprocess.run")
# Mock describe_instances for get_instance_id
mock_ec2.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "running", "Code": 16},
"PublicDnsName": "ec2-123-45-67-89.compute-1.amazonaws.com",
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
# Mock describe_instance_status for is_instance_running
mock_ec2.return_value.describe_instance_status.return_value = {
"InstanceStatuses": [{"InstanceState": {"Name": "running"}}]
}
# Call connect with --key option
runner.invoke(app, ["connect", "test-instance", "--key", "/path/to/my-key.pem"])
# Verify subprocess.run was called
mock_subprocess.assert_called_once()
# Get the actual SSH command that was called
ssh_command = mock_subprocess.call_args[0][0]
# Verify the key option is included
assert "-i" in ssh_command
assert "/path/to/my-key.pem" in ssh_command
assert "ssh" in ssh_command
assert "ubuntu@ec2-123-45-67-89.compute-1.amazonaws.com" in ssh_command
def test_connect_uses_accept_new_by_default(mocker):
"""Test that SSH uses StrictHostKeyChecking=accept-new by default (more secure)."""
mock_ec2 = mocker.patch("remote.utils.get_ec2_client")
mock_subprocess = mocker.patch("remote.instance.subprocess.run")
mock_ec2.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "running", "Code": 16},
"PublicDnsName": "ec2-123-45-67-89.compute-1.amazonaws.com",
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
mock_ec2.return_value.describe_instance_status.return_value = {
"InstanceStatuses": [{"InstanceState": {"Name": "running"}}]
}
runner.invoke(app, ["connect", "test-instance"])
mock_subprocess.assert_called_once()
ssh_command = mock_subprocess.call_args[0][0]
# Verify the default uses accept-new (secure option)
assert "StrictHostKeyChecking=accept-new" in ssh_command
def test_connect_with_no_strict_host_key_flag(mocker):
"""Test that --no-strict-host-key disables strict host key checking."""
mock_ec2 = mocker.patch("remote.utils.get_ec2_client")
mock_subprocess = mocker.patch("remote.instance.subprocess.run")
mock_ec2.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "running", "Code": 16},
"PublicDnsName": "ec2-123-45-67-89.compute-1.amazonaws.com",
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
mock_ec2.return_value.describe_instance_status.return_value = {
"InstanceStatuses": [{"InstanceState": {"Name": "running"}}]
}
runner.invoke(app, ["connect", "test-instance", "--no-strict-host-key"])
mock_subprocess.assert_called_once()
ssh_command = mock_subprocess.call_args[0][0]
# Verify the flag uses 'no' (legacy behavior)
assert "StrictHostKeyChecking=no" in ssh_command
def test_connect_uses_ssh_key_from_config(mocker):
"""Test that connect uses ssh_key from config when --key is not provided."""
mock_ec2 = mocker.patch("remote.utils.get_ec2_client")
mock_subprocess = mocker.patch("remote.instance.subprocess.run")
mock_config = mocker.patch("remote.instance.config_manager")
mock_ec2.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "running", "Code": 16},
"PublicDnsName": "ec2-123-45-67-89.compute-1.amazonaws.com",
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
mock_ec2.return_value.describe_instance_status.return_value = {
"InstanceStatuses": [{"InstanceState": {"Name": "running"}}]
}
# Configure mock to return ssh_key from config
mock_config.get_value.return_value = "/home/user/.ssh/config-key.pem"
runner.invoke(app, ["connect", "test-instance"])
mock_subprocess.assert_called_once()
ssh_command = mock_subprocess.call_args[0][0]
# Verify the key from config is included
assert "-i" in ssh_command
assert "/home/user/.ssh/config-key.pem" in ssh_command
def test_connect_key_option_overrides_config(mocker):
"""Test that --key option takes precedence over config ssh_key."""
mock_ec2 = mocker.patch("remote.utils.get_ec2_client")
mock_subprocess = mocker.patch("remote.instance.subprocess.run")
mock_config = mocker.patch("remote.instance.config_manager")
mock_ec2.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "running", "Code": 16},
"PublicDnsName": "ec2-123-45-67-89.compute-1.amazonaws.com",
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
mock_ec2.return_value.describe_instance_status.return_value = {
"InstanceStatuses": [{"InstanceState": {"Name": "running"}}]
}
# Configure mock to return ssh_key from config
mock_config.get_value.return_value = "/home/user/.ssh/config-key.pem"
# Pass --key option explicitly
runner.invoke(app, ["connect", "test-instance", "--key", "/path/to/explicit-key.pem"])
mock_subprocess.assert_called_once()
ssh_command = mock_subprocess.call_args[0][0]
# Verify the explicit key is used, not the config key
assert "-i" in ssh_command
assert "/path/to/explicit-key.pem" in ssh_command
assert "/home/user/.ssh/config-key.pem" not in ssh_command
# Verify get_value was NOT called for ssh_key since --key was provided
# (The config is checked only when key is not provided)
mock_config.get_value.assert_not_called()
def test_connect_no_key_when_not_in_config(mocker):
"""Test that connect works without -i flag when no key is provided or configured."""
mock_ec2 = mocker.patch("remote.utils.get_ec2_client")
mock_subprocess = mocker.patch("remote.instance.subprocess.run")
mock_config = mocker.patch("remote.instance.config_manager")
mock_ec2.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "running", "Code": 16},
"PublicDnsName": "ec2-123-45-67-89.compute-1.amazonaws.com",
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
mock_ec2.return_value.describe_instance_status.return_value = {
"InstanceStatuses": [{"InstanceState": {"Name": "running"}}]
}
# Configure mock to return None (no ssh_key in config)
mock_config.get_value.return_value = None
runner.invoke(app, ["connect", "test-instance"])
mock_subprocess.assert_called_once()
ssh_command = mock_subprocess.call_args[0][0]
# Verify no -i flag is included
assert "-i" not in ssh_command
# ============================================================================
# SSH Error Handling Tests (Issue 14)
# ============================================================================
class TestSSHErrorHandling:
"""Test SSH subprocess error handling in the connect command."""
def test_connect_ssh_nonzero_exit_code(self, mocker):
"""Test that SSH connection failure with non-zero exit code is handled."""
mock_ec2 = mocker.patch("remote.utils.get_ec2_client")
mock_subprocess = mocker.patch("remote.instance.subprocess.run")
mock_ec2.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "running", "Code": 16},
"PublicDnsName": "ec2-123-45-67-89.compute-1.amazonaws.com",
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
mock_ec2.return_value.describe_instance_status.return_value = {
"InstanceStatuses": [{"InstanceState": {"Name": "running"}}]
}
# Mock subprocess.run to return non-zero exit code
mock_result = mocker.MagicMock()
mock_result.returncode = 255
mock_subprocess.return_value = mock_result
result = runner.invoke(app, ["connect", "test-instance"])
assert result.exit_code == 255
assert "SSH connection failed with exit code 255" in result.stdout
def test_connect_ssh_client_not_found(self, mocker):
"""Test that missing SSH client is handled gracefully."""
mock_ec2 = mocker.patch("remote.utils.get_ec2_client")
mock_subprocess = mocker.patch("remote.instance.subprocess.run")
mock_ec2.return_value.describe_instances.return_value = {
"Reservations": [
{
"Instances": [
{
"InstanceId": "i-0123456789abcdef0",
"State": {"Name": "running", "Code": 16},
"PublicDnsName": "ec2-123-45-67-89.compute-1.amazonaws.com",
"Tags": [{"Key": "Name", "Value": "test-instance"}],
}
]
}
]
}
mock_ec2.return_value.describe_instance_status.return_value = {
"InstanceStatuses": [{"InstanceState": {"Name": "running"}}]
}
# Mock subprocess.run to raise FileNotFoundError
mock_subprocess.side_effect = FileNotFoundError("ssh not found")
result = runner.invoke(app, ["connect", "test-instance"])
assert result.exit_code == 1
assert "SSH client not found" in result.stdout
assert "Please install OpenSSH" in result.stdout
def test_connect_ssh_os_error(self, mocker):
"""Test that OS errors during SSH connection are handled."""