forked from getsentry/sentry-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsystem-test-runner.py
More file actions
1151 lines (968 loc) · 47.9 KB
/
system-test-runner.py
File metadata and controls
1151 lines (968 loc) · 47.9 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
#!/usr/bin/env python3
"""
System Test Runner for Sentry Java
Usage examples:
# Run all tests
python3 test/system-test-runner.py test --all
# Run specific module test
python3 test/system-test-runner.py test --module sentry-samples-console
# Set up infrastructure for manual testing from IDE
python3 test/system-test-runner.py test --module sentry-samples-console --manual-test
# Start Sentry mock server
python3 test/system-test-runner.py sentry start
# Start Spring app served by Tomcat
python3 test/system-test-runner.py tomcat start sentry-samples-spring
# Start Spring Boot app
python3 test/system-test-runner.py spring start sentry-samples-spring-boot
# Start Spring Boot app with build
python3 test/system-test-runner.py spring start sentry-samples-spring-boot --build
# Check status of all services
python3 test/system-test-runner.py status
# Stop services
python3 test/system-test-runner.py sentry stop
python3 test/system-test-runner.py spring stop
"""
import subprocess
import sys
import time
import signal
import os
from enum import Enum
import argparse
import requests
import threading
from pathlib import Path
from typing import Optional, List, Tuple
from dataclasses import dataclass
TERMINAL_COLUMNS: int = 60
try:
TERMINAL_COLUMNS: int = os.get_terminal_size().columns
except:
pass
SENTRY_ENVIRONMENT_VARIABLES = {
"SENTRY_DSN": "http://502f25099c204a2fbf4cb16edc5975d1@localhost:8000/0",
"SENTRY_TRACES_SAMPLE_RATE": "1.0",
"OTEL_TRACES_EXPORTER": "none",
"OTEL_METRICS_EXPORTER": "none",
"OTEL_LOGS_EXPORTER": "none",
"SENTRY_LOGS_ENABLED": "true"
}
class ServerType(Enum):
TOMCAT = 0
SPRING = 1
def get_server_type_for_module(sample_module: str) -> Optional[ServerType]:
if "spring" in sample_module and "spring-boot" not in sample_module:
return ServerType.TOMCAT
elif "spring" in sample_module:
return ServerType.SPRING
return None
def str_to_bool(value: str) -> str:
"""Convert true/false string to 1/0 string for internal compatibility."""
if value.lower() in ('true', '1'):
return "1"
elif value.lower() in ('false', '0'):
return "0"
else:
raise ValueError(f"Invalid boolean value: {value}. Use 'true' or 'false'")
@dataclass
class Server:
name: str
pid_filepath: str
process: Optional[subprocess.Popen] = None
pid: Optional[int] = None
def store_pid(server: Server):
# Store PID in instance variable and write to file
server.pid = server.process.pid
with open(server.pid_filepath, "w") as pid_file:
pid_file.write(str(server.pid))
def cleanup_pid(server: Server):
# Clean up PID file and instance variable
if os.path.exists(server.pid_filepath):
os.remove(server.pid_filepath)
server.pid = None
@dataclass
class ModuleConfig:
"""Configuration for a test module."""
name: str
java_agent: str
java_agent_auto_init: str
build_before_run: str
def uses_agent(self) -> bool:
"""Check if this module uses the Java agent."""
return str_to_bool(self.java_agent) == "1"
def needs_build(self) -> bool:
"""Check if this module needs to be built before running."""
return str_to_bool(self.build_before_run) == "1"
def is_spring_module(self) -> bool:
"""Check if this is a Spring Boot module."""
return "spring" in self.name
@dataclass
class InteractiveSelection:
"""Result of interactive module selection."""
modules: List[ModuleConfig]
manual_test_mode: bool
build_agent: bool
def is_empty(self) -> bool:
"""Check if no modules were selected."""
return len(self.modules) == 0
def is_single_module(self) -> bool:
"""Check if exactly one module was selected."""
return len(self.modules) == 1
def get_first_module(self) -> ModuleConfig:
"""Get the first selected module (for manual test mode)."""
if self.is_empty():
raise ValueError("No modules selected")
return self.modules[0]
def has_agent_modules(self) -> bool:
"""Check if any selected modules use the Java agent."""
return any(module_config.uses_agent() for module_config in self.modules)
class SystemTestRunner:
def __init__(self):
self.mock_server = Server(name="Mock", pid_filepath="sentry-mock-server.pid")
self.tomcat_server = Server(name="Tomcat", pid_filepath="tomcat-server.pid")
self.spring_server = Server(name="Spring", pid_filepath="spring-server.pid")
# Load existing PIDs if available
for server in (self.mock_server, self.tomcat_server, self.spring_server):
server.pid = self.read_pid_file(server.pid_filepath)
if server.pid:
print(f"Found existing {server.name} server PID: {server.pid}")
def read_pid_file(self, pid_file: str) -> Optional[int]:
"""Read PID from file if it exists."""
try:
if os.path.exists(pid_file):
with open(pid_file, 'r') as f:
return int(f.read().strip())
except (ValueError, IOError) as e:
print(f"Error reading PID file {pid_file}: {e}")
return None
def is_process_running(self, pid: int) -> bool:
"""Check if a process with given PID is still running."""
try:
# Send signal 0 to check if process exists
os.kill(pid, 0)
return True
except (OSError, ProcessLookupError):
return False
def kill_process(self, pid: int, name: str) -> None:
"""Kill a process by PID."""
try:
print(f"Killing existing {name} process with PID {pid}")
os.kill(pid, signal.SIGTERM)
time.sleep(2) # Give it time to terminate gracefully
# Check if it's still running and force kill if necessary
if self.is_process_running(pid):
print(f"Process {pid} didn't terminate gracefully, force killing...")
os.kill(pid, signal.SIGKILL)
time.sleep(1)
except (OSError, ProcessLookupError):
print(f"Process {pid} was already dead")
def start_sentry_mock_server(self) -> None:
"""Start the Sentry mock server."""
print("Starting Sentry mock server...")
try:
# Start the mock server in the background
with open("sentry-mock-server.txt", "w") as log_file:
self.mock_server.process = subprocess.Popen(
["python3", "test/system-test-sentry-server.py"],
stdout=log_file,
stderr=subprocess.STDOUT
)
# Store PID in instance variable and write to file
store_pid(self.mock_server)
print(f"Started mock server with PID {self.mock_server.pid}")
# Wait a moment for the server to start
time.sleep(2)
except Exception as e:
print(f"Failed to start mock server: {e}")
raise
def stop_sentry_mock_server(self) -> None:
"""Stop the Sentry mock server."""
try:
# Try graceful shutdown first
try:
response = requests.get("http://127.0.0.1:8000/STOP", timeout=5)
print("Sent stop signal to mock server")
except:
print("Could not send graceful stop signal")
# Kill the process - try process object first, then PID from file
if self.mock_server.process and self.mock_server.process.poll() is None:
print(f"Killing mock server process object with PID {self.mock_server.process.pid}")
self.mock_server.process.kill()
self.mock_server.process.wait(timeout=5)
elif self.mock_server.pid and self.is_process_running(self.mock_server.pid):
print(f"Killing mock server from PID file with PID {self.mock_server.pid}")
self.kill_process(self.mock_server.pid, "mock server")
except Exception as e:
print(f"Error stopping mock server: {e}")
finally:
# Clean up PID file and instance variable
cleanup_pid(self.mock_server)
def read_version_from_gradle_properties(self) -> Optional[str]:
"""Read the versionName from gradle.properties."""
try:
with open("gradle.properties", "r") as f:
for line in f:
line = line.strip()
if line.startswith("versionName="):
return line.split("=", 1)[1]
except (IOError, IndexError) as e:
print(f"Error reading version from gradle.properties: {e}")
return None
def find_agent_jar(self) -> Optional[str]:
"""Find the OpenTelemetry agent JAR file with the specific version from gradle.properties."""
agent_dir = Path("sentry-opentelemetry/sentry-opentelemetry-agent/build/libs/")
if not agent_dir.exists():
return None
# Get the version from gradle.properties
version = self.read_version_from_gradle_properties()
if not version:
print("Error: Could not read version from gradle.properties")
return None
# Look for the specific versioned JAR
versioned_jar_pattern = f"*agent*{version}*.jar"
for jar_file in agent_dir.glob(versioned_jar_pattern):
name = jar_file.name
if ("javadoc" not in name and
"sources" not in name and
"dontuse" not in name):
print(f"Found versioned agent JAR: {jar_file}")
return str(jar_file)
# If versioned JAR not found, print helpful message
print(f"Error: Could not find agent JAR with version {version} in {agent_dir}")
print("Available JAR files:")
for jar_file in agent_dir.glob("*.jar"):
print(f" {jar_file.name}")
return None
def build_agent_jar(self) -> int:
"""Build the OpenTelemetry agent JAR file."""
print("Building OpenTelemetry agent JAR...")
return self.run_gradle_task(":sentry-opentelemetry:sentry-opentelemetry-agent:assemble")
def ensure_agent_jar(self, skip_build: bool = False) -> Optional[str]:
"""Ensure the OpenTelemetry agent JAR exists, building it if necessary."""
agent_jar = self.find_agent_jar()
if agent_jar:
return agent_jar
if skip_build:
print("OpenTelemetry agent JAR not found and build was skipped")
return None
# Agent JAR doesn't exist, try to build it
print("OpenTelemetry agent JAR not found, building it...")
build_result = self.build_agent_jar()
if build_result != 0:
print("Failed to build OpenTelemetry agent JAR")
return None
# Try to find it again after building
agent_jar = self.find_agent_jar()
if not agent_jar:
print("OpenTelemetry agent JAR still not found after building")
return None
return agent_jar
def start_tomcat_server(self, sample_module: str) -> None:
# Build environment variables
env = os.environ.copy()
env.update(SENTRY_ENVIRONMENT_VARIABLES)
try:
# Start the Tomcat server
with open("tomcat-server.txt", "w") as log_file:
self.tomcat_server.process = subprocess.Popen(
["./gradlew", f"sentry-samples:{sample_module}:run"],
env=env,
stdout=log_file,
stderr=subprocess.STDOUT
)
store_pid(self.tomcat_server)
print(f"Started Tomcat server with PID {self.tomcat_server.pid}")
except Exception as e:
print(f"Failed to start Tomcat server: {e}")
raise
def start_spring_server(self, sample_module: str, java_agent: str, java_agent_auto_init: str) -> None:
"""Start a Spring Boot server for testing."""
print(f"Starting Spring server for {sample_module}...")
# Build environment variables
env = os.environ.copy()
env.update(SENTRY_ENVIRONMENT_VARIABLES)
env["SENTRY_AUTO_INIT"] = java_agent_auto_init
# Build command
jar_path = f"sentry-samples/{sample_module}/build/libs/{sample_module}-0.0.1-SNAPSHOT.jar"
cmd = ["java"]
if java_agent == "1":
agent_jar = self.ensure_agent_jar()
if agent_jar:
cmd.append(f"-javaagent:{agent_jar}")
print(f"Using Java Agent: {agent_jar}")
else:
print("Warning: Java agent was requested but could not be found or built")
cmd.extend(["-jar", jar_path])
try:
# Start the Spring server
with open("spring-server.txt", "w") as log_file:
self.spring_server.process = subprocess.Popen(
cmd,
env=env,
stdout=log_file,
stderr=subprocess.STDOUT
)
# Store PID in instance variable and write to file
store_pid(self.spring_server)
print(f"Started Spring server with PID {self.spring_server.pid}")
except Exception as e:
print(f"Failed to start Spring server: {e}")
raise
def wait_for_tomcat(self, module_name: str, max_attempts: int = 20) -> bool:
"""Wait for Tomcat to be ready."""
print("Waiting for Tomcat to be ready...")
for attempt in range(1, max_attempts + 1):
try:
response = requests.head(
f"http://localhost:8080/{module_name}-0.0.1-SNAPSHOT/person/1",
timeout=5
)
if response.status_code != 404:
print("Tomcat is ready!")
return True
except:
pass
print(f"Waiting... (attempt {attempt}/{max_attempts})")
time.sleep(1)
print("Tomcat failed to become ready")
return False
def wait_for_spring(self, max_attempts: int = 20) -> bool:
"""Wait for Spring Boot application to be ready."""
print("Waiting for Spring application to be ready...")
for attempt in range(1, max_attempts + 1):
try:
response = requests.head(
"http://localhost:8080/actuator/health",
auth=("user", "password"),
timeout=5
)
if response.status_code == 200:
print("Spring application is ready!")
return True
except:
pass
print(f"Waiting... (attempt {attempt}/{max_attempts})")
time.sleep(1)
print("Spring application failed to become ready")
return False
def get_spring_status(self) -> dict:
"""Get status of Spring Boot application."""
status = {
"process_running": False,
"pid": self.spring_server.pid,
"http_ready": False
}
if self.spring_server.pid and self.is_process_running(self.spring_server.pid):
status["process_running"] = True
# Check HTTP endpoint
try:
response = requests.head(
"http://localhost:8080/actuator/health",
auth=("user", "password"),
timeout=2
)
if response.status_code == 200:
status["http_ready"] = True
except:
pass
return status
def get_sentry_status(self) -> dict:
"""Get status of Sentry mock server."""
status = {
"process_running": False,
"pid": self.mock_server.pid,
"http_ready": False
}
if self.mock_server.pid and self.is_process_running(self.mock_server.pid):
status["process_running"] = True
# Check HTTP endpoint
try:
response = requests.get("http://127.0.0.1:8000/envelope-count", timeout=2)
if response.status_code == 200:
status["http_ready"] = True
except:
pass
return status
def print_status_summary(self) -> None:
"""Print status summary of all services."""
print("=== Service Status ===")
sentry_status = self.get_sentry_status()
print(f"Sentry Mock Server:")
print(f" PID: {sentry_status['pid'] or 'None'}")
print(f" Process Running: {'✅' if sentry_status['process_running'] else '❌'}")
print(f" HTTP Ready: {'✅' if sentry_status['http_ready'] else '❌'}")
spring_status = self.get_spring_status()
print(f"Spring Boot App:")
print(f" PID: {spring_status['pid'] or 'None'}")
print(f" Process Running: {'✅' if spring_status['process_running'] else '❌'}")
print(f" HTTP Ready: {'✅' if spring_status['http_ready'] else '❌'}")
def stop_tomcat_server(self) -> None:
"""Stop the Tomcat server."""
try:
# Kill the process - try process object first, then PID from file
if self.tomcat_server.process and self.tomcat_server.process.poll() is None:
print(f"Killing Tomcat server process object with PID {self.tomcat_server.process.pid}")
self.tomcat_server.process.kill()
try:
self.tomcat_server.process.wait(timeout=10)
except subprocess.TimeoutExpired:
print("Tomcat server did not terminate gracefully")
elif self.tomcat_server.pid and self.is_process_running(self.tomcat_server.pid):
print(f"Killing Tomcat server from PID file with PID {self.tomcat_server.pid}")
self.kill_process(self.tomcat_server.pid, "Tomcat server")
except Exception as e:
print(f"Error stopping Tomcat server: {e}")
finally:
# Clean up PID file and instance variable
cleanup_pid(self.tomcat_server)
def stop_spring_server(self) -> None:
"""Stop the Spring Boot server."""
try:
# Kill the process - try process object first, then PID from file
if self.spring_server.process and self.spring_server.process.poll() is None:
print(f"Killing Spring server process object with PID {self.spring_server.process.pid}")
self.spring_server.process.kill()
try:
self.spring_server.process.wait(timeout=10)
except subprocess.TimeoutExpired:
print("Spring server did not terminate gracefully")
elif self.spring_server.pid and self.is_process_running(self.spring_server.pid):
print(f"Killing Spring server from PID file with PID {self.spring_server.pid}")
self.kill_process(self.spring_server.pid, "Spring server")
except Exception as e:
print(f"Error stopping Spring server: {e}")
finally:
# Clean up PID file and instance variable
cleanup_pid(self.spring_server)
def get_build_task(self, server_type: Optional[ServerType]) -> str:
"""Get the appropriate build task for a module."""
if server_type == ServerType.TOMCAT:
return "war"
elif server_type == ServerType.SPRING:
return "bootJar"
return "assemble"
def build_module(self, sample_module: str, server_type: Optional[ServerType]) -> int:
"""Build a sample module using the appropriate task."""
build_task = self.get_build_task(server_type)
print(f"Building {sample_module} using {build_task} task")
return self.run_gradle_task(f":sentry-samples:{sample_module}:{build_task}")
def run_gradle_task(self, task: str) -> int:
"""Run a Gradle task and return the exit code."""
print(f"Running: ./gradlew {task}")
try:
result = subprocess.run(["./gradlew", task], check=False)
return result.returncode
except Exception as e:
print(f"Failed to run Gradle task: {e}")
return 1
def setup_test_infrastructure(self, sample_module: str, java_agent: str,
java_agent_auto_init: str, build_before_run: str,
server_type: Optional[ServerType]) -> int:
"""Set up test infrastructure. Returns 0 on success, error code on failure."""
# Build if requested
if build_before_run == "1":
print("Building before test run")
build_result = self.build_module(sample_module, server_type)
if build_result != 0:
print("Build failed")
return build_result
# Ensure agent JAR is available if needed
if java_agent == "1":
agent_jar = self.ensure_agent_jar()
if not agent_jar:
print("Error: Java agent was requested but could not be found or built")
return 1
# Start mock server
print("Starting Sentry mock server...")
self.start_sentry_mock_server()
# Start Tomcat server given a Spring module
if server_type == ServerType.TOMCAT:
print(f"Starting Tomcat server for {sample_module}...")
self.start_tomcat_server(sample_module)
if not self.wait_for_tomcat(sample_module):
print("Tomcat application failed to start!")
return 1
print("Tomcat application is ready!")
# Start Spring server if it's a Spring boot module
elif server_type == ServerType.SPRING:
print(f"Starting Spring server for {sample_module}...")
self.start_spring_server(sample_module, java_agent, java_agent_auto_init)
if not self.wait_for_spring():
print("Spring application failed to start!")
return 1
print("Spring application is ready!")
return 0
def run_single_test(self, sample_module: str, java_agent: str,
java_agent_auto_init: str, build_before_run: str) -> int:
"""Run a single system test."""
print(f"Running system test for {sample_module}")
server_type = get_server_type_for_module(sample_module)
try:
# Set up infrastructure
setup_result = self.setup_test_infrastructure(sample_module,
java_agent,
java_agent_auto_init,
build_before_run,
server_type)
if setup_result != 0:
return setup_result
# Run the system test
test_result = self.run_gradle_task(f":sentry-samples:{sample_module}:systemTest")
return test_result
finally:
# Cleanup
if server_type == ServerType.TOMCAT:
self.stop_tomcat_server()
elif server_type == ServerType.SPRING:
self.stop_spring_server()
self.stop_sentry_mock_server()
def run_all_tests(self) -> int:
"""Run all system tests."""
test_configs = self.get_available_modules()
failed_tests = []
for i, module_config in enumerate(test_configs):
# Convert true/false to internal 1/0 format
agent = str_to_bool(module_config.java_agent)
auto_init = module_config.java_agent_auto_init # already in correct format
build = str_to_bool(module_config.build_before_run)
print(f"\n{'='*TERMINAL_COLUMNS}")
print(f"Running test {i + 1}/{len(test_configs)}: {module_config.name} (agent={module_config.java_agent}, auto_init={module_config.java_agent_auto_init})")
print(f"{'='*TERMINAL_COLUMNS}")
result = self.run_single_test(module_config.name, agent, auto_init, build)
if result != 0:
# Find the module number in the full list for interactive reference
module_number = self._find_module_number(module_config.name, module_config.java_agent, module_config.java_agent_auto_init)
failed_tests.append((module_number, module_config.name, module_config.java_agent, module_config.java_agent_auto_init))
print(f"❌ Test failed: {module_config.name}")
else:
print(f"✅ Test passed: {module_config.name}")
# Summary
print(f"\n{'='*TERMINAL_COLUMNS}")
print("TEST SUMMARY")
print(f"{'='*TERMINAL_COLUMNS}")
print(f"Total tests: {len(test_configs)}")
print(f"Passed: {len(test_configs) - len(failed_tests)}")
print(f"Failed: {len(failed_tests)}")
if failed_tests:
print("\nFailed tests (for interactive mode, use these numbers):")
for module_number, sample_module, java_agent, java_agent_auto_init in failed_tests:
print(f" {module_number}. {sample_module} (agent={java_agent}, auto_init={java_agent_auto_init})")
return 1
else:
print("\n🎉 All tests passed!")
return 0
def run_manual_test_mode(self, sample_module: str, java_agent: str,
java_agent_auto_init: str, build_before_run: str) -> int:
"""Set up infrastructure for manual testing from IDE."""
print(f"Setting up manual test environment for {sample_module}")
server_type = get_server_type_for_module(sample_module)
try:
# Set up infrastructure
setup_result = self.setup_test_infrastructure(sample_module, java_agent, java_agent_auto_init, build_before_run, server_type)
if setup_result != 0:
return setup_result
# Show status and wait for user
print("\n" + "="*TERMINAL_COLUMNS)
print("🚀 Manual test environment ready 🚀")
print("="*TERMINAL_COLUMNS)
self.print_status_summary()
print(f"\nInfrastructure is ready for manual testing of: {sample_module}")
print("You can now run your system tests from your IDE.")
print("\nTest configuration:")
print(f" - Module: {sample_module}")
print(f" - Java Agent: {'Yes' if java_agent == '1' else 'No'}")
print(f" - Agent Auto-init: {java_agent_auto_init}")
print(f" - Mock DSN: http://502f25099c204a2fbf4cb16edc5975d1@localhost:8000/0")
if server_type == ServerType.TOMCAT:
print(f"\nTomcat app is running on: http://localhost:8080/{sample_module}-0.0.1-SNAPSHOT")
elif server_type == ServerType.SPRING:
print("\nSpring Boot app is running on: http://localhost:8080")
print("\nPress Enter to stop the infrastructure and exit...")
# Wait for user input
try:
input()
except KeyboardInterrupt:
print("\nReceived interrupt signal")
print("\nStopping infrastructure...")
return 0
finally:
# Cleanup will happen in the finally block of main()
pass
def get_available_modules(self) -> List[ModuleConfig]:
"""Get list of all available test modules."""
return [
ModuleConfig("sentry-samples-spring", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-7", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-jakarta", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-boot", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-opentelemetry-noagent", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-opentelemetry", "true", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-opentelemetry", "true", "false", "false"),
ModuleConfig("sentry-samples-spring-boot-webflux-jakarta", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-webflux", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-jakarta", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-jakarta-opentelemetry-noagent", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-jakarta-opentelemetry", "true", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-jakarta-opentelemetry", "true", "false", "false"),
ModuleConfig("sentry-samples-spring-boot-4-webflux", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-4", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-4-opentelemetry-noagent", "false", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-4-opentelemetry", "true", "true", "false"),
ModuleConfig("sentry-samples-spring-boot-4-opentelemetry", "true", "false", "false"),
ModuleConfig("sentry-samples-console", "false", "true", "false"),
ModuleConfig("sentry-samples-console-opentelemetry-noagent", "false", "true", "false"),
ModuleConfig("sentry-samples-logback", "false", "true", "false"),
ModuleConfig("sentry-samples-log4j2", "false", "true", "false"),
ModuleConfig("sentry-samples-jul", "false", "true", "false"),
]
def _find_module_number(self, module_name: str, agent: str, auto_init: str) -> int:
"""Find the module number in the interactive list (1-based)."""
modules = self.get_available_modules()
for i, module_config in enumerate(modules, 1):
if (module_config.name == module_name and
module_config.java_agent == agent and
module_config.java_agent_auto_init == auto_init):
return i
return 0 # Should not happen, but return 0 if not found
def parse_selection(self, user_input: str, max_index: int) -> List[int]:
"""Parse user selection string into list of indices."""
if user_input.strip() == "*":
return list(range(max_index))
indices = []
parts = user_input.split(",")
for part in parts:
part = part.strip()
if "-" in part:
# Handle range like "1-4"
try:
start, end = map(int, part.split("-"))
# Convert from 1-based to 0-based indexing
indices.extend(range(start - 1, end))
except ValueError:
raise ValueError(f"Invalid range format: {part}")
else:
# Handle single number
try:
# Convert from 1-based to 0-based indexing
indices.append(int(part) - 1)
except ValueError:
raise ValueError(f"Invalid number: {part}")
# Remove duplicates and sort
indices = sorted(set(indices))
# Validate indices
for idx in indices:
if idx < 0 or idx >= max_index:
raise ValueError(f"Index {idx + 1} is out of range (1-{max_index})")
return indices
def interactive_module_selection(self) -> InteractiveSelection:
"""Display modules and get user selection."""
modules = self.get_available_modules()
print("\nAvailable test modules:")
print("=" * 80)
for i, module_config in enumerate(modules, 1):
agent_text = "with agent" if module_config.uses_agent() else "no agent"
auto_init_text = f"auto-init: {module_config.java_agent_auto_init}"
print(f"{i:2d}. {module_config.name:<50} ({agent_text}, {auto_init_text})")
print("\nSelection options:")
print(" * = all modules")
print(" Single: 1, 5, 8")
print(" Range: 1-4, 6-8")
print(" Combined: 1,2,4-5,8")
selected_modules = []
while True:
try:
user_input = input("\nEnter your selection: ").strip()
if not user_input:
print("Please enter a selection.")
continue
selected_indices = self.parse_selection(user_input, len(modules))
selected_modules = [modules[i] for i in selected_indices]
# Show confirmation
print(f"\nSelected {len(selected_modules)} module(s):")
for i, module_config in enumerate(selected_modules, 1):
agent_text = "with agent" if module_config.uses_agent() else "no agent"
print(f" {i}. {module_config.name} ({agent_text}, auto-init: {module_config.java_agent_auto_init})")
confirm = input("\nProceed with these selections? [Y/n]: ").strip().lower()
if confirm in ('', 'y', 'yes'):
break
else:
print("Please make a new selection.")
except ValueError as e:
print(f"Error: {e}")
print("Please try again.")
except KeyboardInterrupt:
print("\nOperation cancelled.")
return InteractiveSelection(modules=[], manual_test_mode=False, build_agent=False)
# Ask about test mode
manual_test_mode = False
while True:
try:
mode_input = input("\nRun tests automatically (n = only set up infrastucture for testing in IDE)? [Y/n]: ").strip().lower()
if not mode_input or mode_input in ('y', 'yes'):
manual_test_mode = False
break
elif mode_input in ('n', 'no'):
manual_test_mode = True
break
else:
print("Please enter 'y' or 'n'.")
except KeyboardInterrupt:
print("\nOperation cancelled.")
return InteractiveSelection(modules=[], manual_test_mode=False, build_agent=False)
# Ask about building agent if any modules use it
build_agent = False
has_agent_modules = any(module_config.uses_agent() for module_config in selected_modules)
if has_agent_modules:
while True:
try:
agent_input = input("\nBuild OpenTelemetry agent JAR (recommended to ensure latest version)? [Y/n]: ").strip().lower()
if not agent_input or agent_input in ('y', 'yes'):
build_agent = True
break
elif agent_input in ('n', 'no'):
build_agent = False
break
else:
print("Please enter 'y' or 'n'.")
except KeyboardInterrupt:
print("\nOperation cancelled.")
return InteractiveSelection(modules=[], manual_test_mode=False, build_agent=False)
return InteractiveSelection(modules=selected_modules, manual_test_mode=manual_test_mode, build_agent=build_agent)
def run_interactive_tests(self, agent: str, auto_init: str, build: str) -> int:
"""Run tests with interactive module selection."""
selection = self.interactive_module_selection()
if selection.is_empty():
print("No modules selected. Exiting.")
return 0
# Build agent JAR if requested and modules use agent
if selection.build_agent and selection.has_agent_modules():
print("\nBuilding OpenTelemetry agent JAR...")
build_result = self.build_agent_jar()
if build_result != 0:
print("Failed to build OpenTelemetry agent JAR")
return build_result
print("✅ OpenTelemetry agent JAR built successfully")
# Handle manual test mode
if selection.manual_test_mode:
if not selection.is_single_module():
print("Error: Manual test mode can only be used with a single module.")
print("Please select only one module for manual testing.")
return 1
module_config = selection.get_first_module()
# Convert true/false to internal 1/0 format
agent = str_to_bool(module_config.java_agent)
auto_init = module_config.java_agent_auto_init # already in correct format
build = str_to_bool(module_config.build_before_run)
print(f"\nSetting up manual test environment for: {module_config.name}")
return self.run_manual_test_mode(module_config.name, agent, auto_init, build)
# Handle automatic test running
failed_tests = []
for i, module_config in enumerate(selection.modules, 1):
# Convert true/false to internal 1/0 format
agent = str_to_bool(module_config.java_agent)
auto_init = module_config.java_agent_auto_init # already in correct format
build = str_to_bool(module_config.build_before_run)
print(f"\n{'='*TERMINAL_COLUMNS}")
print(f"Running test {i}/{len(selection.modules)}: {module_config.name}")
print(f"Agent: {module_config.java_agent}, Auto-init: {module_config.java_agent_auto_init}")
print(f"{'='*TERMINAL_COLUMNS}")
result = self.run_single_test(module_config.name, agent, auto_init, build)
if result != 0:
# Find the module number in the full list for interactive reference
module_number = self._find_module_number(module_config.name, module_config.java_agent, module_config.java_agent_auto_init)
failed_tests.append((module_number, module_config.name, module_config.java_agent, module_config.java_agent_auto_init))
print(f"❌ Test failed: {module_config.name}")
else:
print(f"✅ Test passed: {module_config.name}")
# Summary
print(f"\n{'='*TERMINAL_COLUMNS}")
print("TEST SUMMARY")
print(f"{'='*TERMINAL_COLUMNS}")
print(f"Total tests: {len(selection.modules)}")
print(f"Passed: {len(selection.modules) - len(failed_tests)}")
print(f"Failed: {len(failed_tests)}")
if failed_tests:
print("\nFailed tests (for interactive mode, use these numbers):")
for module_number, sample_module, test_agent, test_auto_init in failed_tests:
print(f" {module_number}. {sample_module} (agent={test_agent}, auto_init={test_auto_init})")
return 1
else:
print("\n🎉 All tests passed!")
return 0
def cleanup_on_exit(self, signum, frame):
"""Cleanup handler for signals."""
print(f"\nReceived signal {signum}, cleaning up...")
self.stop_spring_server()
self.stop_sentry_mock_server()
self.stop_tomcat_server()
sys.exit(1)
def main():
parser = argparse.ArgumentParser(description="System Test Runner for Sentry Java")
subparsers = parser.add_subparsers(dest="command", help="Available commands")
# Test subcommand
test_parser = subparsers.add_parser("test", help="Run system tests")
test_group = test_parser.add_mutually_exclusive_group(required=True)
test_group.add_argument("--all", action="store_true", help="Run all system tests")
test_group.add_argument("--module", help="Sample module to test")
test_group.add_argument("--interactive", "-i", action="store_true", help="Interactive module selection")
test_parser.add_argument("--agent", default="false", help="Use Java agent (true or false)")
test_parser.add_argument("--auto-init", default="true", help="Auto-init agent (true or false)")
test_parser.add_argument("--build", default="false", help="Build before running (true or false)")
test_parser.add_argument("--manual-test", action="store_true", help="Set up infrastructure but pause for manual testing from IDE")
# Tomcat subcommand
tomcat_parser = subparsers.add_parser("tomcat", help="Manage Servlet applications deployed on Tomcat")
tomcat_subparsers = tomcat_parser.add_subparsers(dest="tomcat_action", help="Tomcat actions")
tomcat_start_parser = tomcat_subparsers.add_parser("start", help="Start tomcat application")
tomcat_start_parser.add_argument("module", help="Sample module to start")
tomcat_start_parser.add_argument("--build", default="false", help="Build before starting (true or false)")
tomcat_subparsers.add_parser("stop", help="Stop Spring Boot application")
# Spring subcommand
spring_parser = subparsers.add_parser("spring", help="Manage Spring Boot applications")
spring_subparsers = spring_parser.add_subparsers(dest="spring_action", help="Spring actions")
spring_start_parser = spring_subparsers.add_parser("start", help="Start Spring Boot application")
spring_start_parser.add_argument("module", help="Sample module to start")
spring_start_parser.add_argument("--agent", default="false", help="Use Java agent (true or false)")
spring_start_parser.add_argument("--auto-init", default="true", help="Auto-init agent (true or false)")
spring_start_parser.add_argument("--build", default="false", help="Build before starting (true or false)")
spring_stop_parser = spring_subparsers.add_parser("stop", help="Stop Spring Boot application")
spring_wait_parser = spring_subparsers.add_parser("wait", help="Wait for Spring Boot application to be ready")
spring_wait_parser.add_argument("--timeout", type=int, default=20, help="Max attempts to wait (default: 20)")
spring_status_parser = spring_subparsers.add_parser("status", help="Check Spring Boot application status")
# Sentry subcommand
sentry_parser = subparsers.add_parser("sentry", help="Manage Sentry mock server")
sentry_subparsers = sentry_parser.add_subparsers(dest="sentry_action", help="Sentry actions")
sentry_start_parser = sentry_subparsers.add_parser("start", help="Start Sentry mock server")
sentry_stop_parser = sentry_subparsers.add_parser("stop", help="Stop Sentry mock server")