Inherit appropiate environment variables in goma module for goma_utils.py

scripts/slave/recipe_modules/goma/api.py

 # Copyright 2015 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
+import os
+
 from recipe_engine import recipe_api
 
 class GomaApi(recipe_api.RecipeApi):
   """GomaApi contains helper functions for using goma."""
 
   def __init__(self, **kwargs):
     super(GomaApi, self).__init__(**kwargs)
     self._goma_dir = None
     self._goma_started = False
 
+    self.goma_ctl_env_init()
+
+
+  def goma_ctl_env_init(self):
     self._goma_ctl_env = {}
 
+    # inherit some env vars used in goma_utils.SendGomaTsMon
+    for key in ['BUILDBOD_BUILDERNAME',
+                'BUILDBOT_MASTERNAME',
+                'BUILDBOT_SLAVENAME',
+                'BUILDBOT_CLOBBER',

[Yoshisato Yanagisawa, 2016/08/16 03:54:23]

I doubt you need to remember above four because these envs are automatically set
when recipe runs and might not be modified during recipe run, but maybe ok.

[tikuta, 2016/08/16 04:09:04]

I set these variables because these variables will be used in
upload_goma_logs.py by setting self._goma_ctl_env as env.
Is it better to keep these variables to send as a part of log?

+                'GOMA_TMP_DIR',

[Yoshisato Yanagisawa, 2016/08/16 03:54:23]

you might not need to remember GOMA_TMP_DIR because, if my memory is correct,
the reason you need to remember following args is for glog.  GOMA_TMP_DIR is not
used for the logging.

[tikuta, 2016/08/16 04:09:04]

Done.

+                'TEST_TMPDIR',
+                'TMPDIR',
+                'TMP',
+    ]:
+      if key in os.environ: # pragma: no cover
+        self._goma_ctl_env[key] = os.environ[key]
+
   @property
   def service_account_json_path(self):
     if self.m.platform.is_win:
       return 'C:\\creds\\service_accounts\\service-account-goma-client.json'
     return '/creds/service_accounts/service-account-goma-client.json'
 
   def ensure_goma(self, canary=False):
     with self.m.step.nest('ensure_goma'):
       with self.m.step.context({'infra_step': True}):
         try:
@@ skipping 35 matching lines @@
 
     if self.build_data_dir:
       self._goma_ctl_env['GOMA_DUMP_STATS_FILE'] = (
           self.m.path.join(self.build_data_dir, 'goma_stats_proto'))
       self._goma_ctl_env['GOMACTL_CRASH_REPORT_ID_FILE'] = (
           self.m.path.join(self.build_data_dir, 'crash_report_id_file'))
 
     self._goma_ctl_env['GOMA_SERVICE_ACCOUNT_JSON_FILE'] = (
         self.service_account_json_path)
 
+    # GLOG_log_dir should not be set.
+    assert env is None or 'GLOG_log_dir' not in env
+
     goma_ctl_start_env = self._goma_ctl_env.copy()
 
     if env is not None:
       goma_ctl_start_env.update(env)
 
     try:
       self.m.python(
           name='start_goma',
           script=self.goma_ctl,
           args=['restart'], env=goma_ctl_start_env, infra_step=True, **kwargs)
@@ skipping 23 matching lines @@
     assert self._goma_started
     self.m.python(
         name='stop_goma',
         script=self.goma_ctl,
         args=['stop'], env=self._goma_ctl_env, **kwargs)
 
     self.upload_logs(ninja_log_outdir, ninja_log_compiler, ninja_log_command,
                      ninja_log_exit_status)
 
     self._goma_started = False
-    self._goma_ctl_env = {}
+    self.goma_ctl_env_init()
+
 
   def upload_logs(self, ninja_log_outdir=None, ninja_log_compiler=None,
                   ninja_log_command=None, ninja_log_exit_status=None,
                   name=None):
     args = [
         '--upload-compiler-proxy-info'
     ]
 
     if ninja_log_outdir:
       assert ninja_log_compiler is not None
@@ skipping 12 matching lines @@
           '--goma-stats-file', self._goma_ctl_env['GOMA_DUMP_STATS_FILE'],
           '--goma-crash-report-id-file',
           self._goma_ctl_env['GOMACTL_CRASH_REPORT_ID_FILE'],
           '--build-data-dir', self.build_data_dir,
       ])
 
     self.m.python(
       name=name or 'upload_log',
       script=self.package_repo_resource(
           'scripts', 'slave', 'upload_goma_logs.py'),
-      args=args
+      args=args,
+      env=self._goma_ctl_env
     )