@@ -61,6 +61,12 @@ def from_service_account_file(path):
6161
6262BUILD_TIME_FORMAT = re .compile (r"^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$" )
6363
64+ REQUESTER_ENV = ("UPLOAD_BUILD_USER_EMAIL" , "UPLOAD_CHANGE_AUTHOR_EMAIL" )
65+
66+ # Large enough to push the pipeline payload over the 8 MB cap, so the script
67+ # falls back to one v1 message per design.
68+ OVERSIZED_METRICS = {"blob" : "x" * (9 * 1024 * 1024 )}
69+
6470
6571class TestUploadMetadata (unittest .TestCase ):
6672 def setUp (self ):
@@ -96,8 +102,11 @@ def add_design(self, platform, design, variant="base", metrics=None):
96102 with open (os .path .join (report_dir , "metadata.json" ), "w" ) as f :
97103 json .dump (metrics or {"finish:area" : 1.0 }, f )
98104
99- def run_script (self , * extra , fail = False , tz = None ):
105+ def run_script (self , * extra , fail = False , tz = None , extra_env = None ):
100106 env = dict (os .environ )
107+ for name in REQUESTER_ENV :
108+ env .pop (name , None )
109+ env .update (extra_env or {})
101110 if tz :
102111 env ["TZ" ] = tz
103112 env ["PYTHONPATH" ] = self .stubs
@@ -343,6 +352,178 @@ def test_empty_designs_valid_provenance_is_v4(self):
343352 self .assertEqual (payload ["designs" ], [])
344353 self .assertEqual (payload ["jenkins_library" ], {"ref" : "v1.0.0" })
345354
355+ def test_pipeline_payload_without_requester_is_unchanged (self ):
356+ self .add_design ("nangate45" , "gcd" , metrics = {"finish:area" : 5.0 })
357+ result , messages = self .run_script ("--jobName" , "ORFS" )
358+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
359+ payload = messages [0 ]["data" ]
360+ self .assertRegex (payload .pop ("build_time" ), BUILD_TIME_FORMAT )
361+ self .assertEqual (
362+ payload ,
363+ {
364+ "payload_schema_version" : 3 ,
365+ "jenkins_env" : "public" ,
366+ "build_id" : "42" ,
367+ "branch_name" : "master" ,
368+ "pipeline_id" : "jenkins-ORFS-master-42" ,
369+ "change_branch" : None ,
370+ "commit_sha" : "abc123" ,
371+ "jenkins_url" : "http://jenkins/job/ORFS/42/" ,
372+ "job_name" : "ORFS" ,
373+ "designs" : [
374+ {
375+ "platform" : "nangate45" ,
376+ "design" : "gcd" ,
377+ "variant" : "base" ,
378+ "metrics" : {"finish__area" : 5.0 },
379+ }
380+ ],
381+ },
382+ )
383+
384+ def test_v1_message_without_requester_is_unchanged (self ):
385+ self .add_design ("nangate45" , "gcd" , metrics = OVERSIZED_METRICS )
386+ result , messages = self .run_script ()
387+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
388+ self .assertEqual (len (messages ), 1 )
389+ payload = messages [0 ]["data" ]
390+ self .assertEqual (payload .pop ("blob" ), OVERSIZED_METRICS ["blob" ])
391+ self .assertEqual (
392+ payload ,
393+ {
394+ "build_id" : "42" ,
395+ "branch_name" : "master" ,
396+ "pipeline_id" : "jenkins-ORFS-master-42" ,
397+ "change_branch" : None ,
398+ "commit_sha" : "abc123" ,
399+ "jenkins_url" : "http://jenkins/job/ORFS/42/" ,
400+ "jenkins_env" : "public" ,
401+ },
402+ )
403+
404+ def test_both_requester_flags_reach_pipeline_payload (self ):
405+ self .add_design ("nangate45" , "gcd" )
406+ result , messages = self .run_script (
407+ "--buildUserEmail" ,
408+ " ada@example.com " ,
409+ "--changeAuthorEmail" ,
410+ "bob@example.com" ,
411+ )
412+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
413+ payload = messages [0 ]["data" ]
414+ self .assertEqual (payload ["build_user_email" ], "ada@example.com" )
415+ self .assertEqual (payload ["change_author_email" ], "bob@example.com" )
416+ self .assertEqual (payload ["payload_schema_version" ], 2 )
417+
418+ def test_both_requester_flags_reach_v1_messages (self ):
419+ self .add_design ("nangate45" , "gcd" , metrics = OVERSIZED_METRICS )
420+ result , messages = self .run_script (
421+ "--buildUserEmail" ,
422+ "ada@example.com" ,
423+ "--changeAuthorEmail" ,
424+ "bob@example.com" ,
425+ )
426+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
427+ payload = messages [0 ]["data" ]
428+ self .assertEqual (payload ["build_user_email" ], "ada@example.com" )
429+ self .assertEqual (payload ["change_author_email" ], "bob@example.com" )
430+
431+ def test_blank_requester_flag_is_omitted (self ):
432+ self .add_design ("nangate45" , "gcd" )
433+ result , messages = self .run_script (
434+ "--buildUserEmail" , " " , "--changeAuthorEmail" , "bob@example.com"
435+ )
436+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
437+ payload = messages [0 ]["data" ]
438+ self .assertNotIn ("build_user_email" , payload )
439+ self .assertEqual (payload ["change_author_email" ], "bob@example.com" )
440+
441+ def test_blank_requester_flag_is_omitted_from_v1_messages (self ):
442+ self .add_design ("nangate45" , "gcd" , metrics = OVERSIZED_METRICS )
443+ result , messages = self .run_script (
444+ "--buildUserEmail" , "ada@example.com" , "--changeAuthorEmail" , ""
445+ )
446+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
447+ payload = messages [0 ]["data" ]
448+ self .assertEqual (payload ["build_user_email" ], "ada@example.com" )
449+ self .assertNotIn ("change_author_email" , payload )
450+
451+ def test_requester_without_at_sign_is_dropped (self ):
452+ self .add_design ("nangate45" , "gcd" )
453+ result , messages = self .run_script (
454+ "--buildUserEmail" , "null" , "--changeAuthorEmail" , "None"
455+ )
456+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
457+ payload = messages [0 ]["data" ]
458+ self .assertNotIn ("build_user_email" , payload )
459+ self .assertNotIn ("change_author_email" , payload )
460+ self .assertIn ("[WARN] Not sending --buildUserEmail: 'null'" , result .stdout )
461+ self .assertIn ("[WARN] Not sending --changeAuthorEmail: 'None'" , result .stdout )
462+
463+ def test_v1_fallback_warns_about_requester_once (self ):
464+ self .add_design ("nangate45" , "gcd" , metrics = OVERSIZED_METRICS )
465+ result , messages = self .run_script ("--buildUserEmail" , "null" )
466+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
467+ self .assertNotIn ("build_user_email" , messages [0 ]["data" ])
468+ self .assertEqual (result .stdout .count ("Not sending --buildUserEmail" ), 1 )
469+
470+ def test_requester_is_read_from_environment (self ):
471+ self .add_design ("nangate45" , "gcd" )
472+ result , messages = self .run_script (
473+ extra_env = {
474+ "UPLOAD_BUILD_USER_EMAIL" : "ada@example.com" ,
475+ "UPLOAD_CHANGE_AUTHOR_EMAIL" : " bob@example.com " ,
476+ }
477+ )
478+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
479+ payload = messages [0 ]["data" ]
480+ self .assertEqual (payload ["build_user_email" ], "ada@example.com" )
481+ self .assertEqual (payload ["change_author_email" ], "bob@example.com" )
482+
483+ def test_requester_flag_overrides_environment (self ):
484+ self .add_design ("nangate45" , "gcd" )
485+ result , messages = self .run_script (
486+ "--buildUserEmail" ,
487+ "ada@example.com" ,
488+ extra_env = {"UPLOAD_BUILD_USER_EMAIL" : "other@example.com" },
489+ )
490+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
491+ self .assertEqual (messages [0 ]["data" ]["build_user_email" ], "ada@example.com" )
492+
493+ def test_empty_requester_flag_suppresses_environment (self ):
494+ self .add_design ("nangate45" , "gcd" )
495+ result , messages = self .run_script (
496+ "--buildUserEmail" ,
497+ "" ,
498+ extra_env = {"UPLOAD_BUILD_USER_EMAIL" : "ada@example.com" },
499+ )
500+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
501+ self .assertNotIn ("build_user_email" , messages [0 ]["data" ])
502+
503+ def test_environment_requester_is_validated (self ):
504+ self .add_design ("nangate45" , "gcd" )
505+ result , messages = self .run_script (
506+ extra_env = {"UPLOAD_BUILD_USER_EMAIL" : "null" }
507+ )
508+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
509+ self .assertNotIn ("build_user_email" , messages [0 ]["data" ])
510+ self .assertIn ("[WARN] Not sending --buildUserEmail: 'null'" , result .stdout )
511+
512+ def test_environment_requester_reaches_v1_messages (self ):
513+ self .add_design ("nangate45" , "gcd" , metrics = OVERSIZED_METRICS )
514+ result , messages = self .run_script (
515+ extra_env = {"UPLOAD_CHANGE_AUTHOR_EMAIL" : "bob@example.com" }
516+ )
517+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
518+ self .assertEqual (messages [0 ]["data" ]["change_author_email" ], "bob@example.com" )
519+
520+ def test_requester_keys_win_over_same_named_v1_metric (self ):
521+ metrics = dict (OVERSIZED_METRICS , build_user_email = "metric" )
522+ self .add_design ("nangate45" , "gcd" , metrics = metrics )
523+ result , messages = self .run_script ("--buildUserEmail" , "ada@example.com" )
524+ self .assertEqual (result .returncode , 0 , result .stdout + result .stderr )
525+ self .assertEqual (messages [0 ]["data" ]["build_user_email" ], "ada@example.com" )
526+
346527 def test_no_publisher_publishes_nothing (self ):
347528 env = dict (os .environ )
348529 env ["PYTHONPATH" ] = self .stubs
0 commit comments