Implement upload_logs() in recipe_modules/goma

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.
 
 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 = {}
+
+    # options for upload_goma_logs.py
+    # TODO(tikuta) set these variables

[Paweł Hajdan Jr., 2016/08/09 07:04:36]

Why is this a TODO? If we're not setting/using some of these variables, why not
remove them from CL?

[tikuta, 2016/08/09 07:58:09]

Done.

+    self._ninja_log_outdir = None
+    self._ninja_log_compiler = None
+    self._ninja_log_command = None
+    self._ninja_log_exit_status = None
+
+    self._build_data_dir = None
+
+
   @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:
           self.m.cipd.set_service_account_credentials(
               self.service_account_json_path)
 
           self.m.cipd.install_client()
           goma_package = ('infra_internal/goma/client/%s' %
               self.m.cipd.platform_suffix())
           # For Windows there's only 64-bit goma client.
           if self.m.platform.is_win:
             goma_package = goma_package.replace('386', 'amd64')
           ref='release'
           if canary:
             ref='candidate'
           self._goma_dir = self.m.path['cache'].join('cipd', 'goma')
           self.m.cipd.ensure(self._goma_dir, {goma_package: ref})
           return self._goma_dir
         except self.m.step.StepFailure:
           # TODO(phajdan.jr): make failures fatal after experiment.
           return None
 
+  @property
+  def goma_ctl(self):
+    return self.m.path.join(self._goma_dir, 'goma_ctl.py')
+
   def start(self, env=None, **kwargs):
     """Start goma compiler_proxy.
 
     A user MUST execute ensure_goma beforehand.
     It is user's responsibility to handle failure of starting compiler_proxy.
     """
     assert self._goma_dir
     assert not self._goma_started
-    if not env:
-      env = {}
-    env.update({'GOMA_SERVICE_ACCOUNT_JSON_FILE': self.service_account_json_path})
-    self.m.python(
-        name='start_goma',
-        script=self.m.path.join(self._goma_dir, 'goma_ctl.py'),
-        args=['restart'], env=env, **kwargs)
-    self._goma_started = True
 
-  def stop(self, goma_dir=None, **kwargs):
+    if self.m.properties.get('build_data_dir'):

[Paweł Hajdan Jr., 2016/08/09 07:04:36]

Would it fit better in the ctor, or a dedicated method this one could call?

[tikuta, 2016/08/09 07:58:09]

Done.

+      self._build_data_dir = self.m.properties.get('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)
+
+    if env:
+      self._goma_ctl_env.update(env)

[Paweł Hajdan Jr., 2016/08/09 07:04:36]

This introduces state that survives this one method call. I suggest making a
copy of goma_ctl_env and only updating the local copy with this call specific
env.

[tikuta, 2016/08/09 07:58:09]

Done.

+
+    try:
+      self.m.python(
+          name='start_goma',
+          script=self.goma_ctl,
+          args=['restart'], env=self._goma_ctl_env, **kwargs)

[Paweł Hajdan Jr., 2016/08/09 07:04:36]

Set infra_step=True here.

[tikuta, 2016/08/09 07:58:09]

Done.

+      self._goma_started = True
+    except self.m.step.StepFailure as e:
+      upload_logs_name = 'upload_goma_start_failed_logs'
+
+      try:
+        self.m.python(
+            name='stop_goma (start failure)',
+            script=self.goma_ctl,
+            args=['stop'], env=self._goma_ctl_env, **kwargs)
+      except self.m.step.StepFailure:
+        upload_logs_name = 'upload_goma_start_and_stop_failed_logs'
+
+      self.upload_logs(upload_logs_name)
+      raise self.m.step.InfraFailure('Infra goma start failure: %s' % e)

[Paweł Hajdan Jr., 2016/08/09 07:04:36]

This way you'd be able to just re-raise the _same_ exception here.

[tikuta, 2016/08/09 07:58:10]

Done.

+
+  def stop(self, **kwargs):
     """Stop goma compiler_proxy.
 
     A user MUST execute start beforehand.
     It is user's responsibility to handle failure of stopping compiler_proxy.
     """
     assert self._goma_dir
     assert self._goma_started
     self.m.python(
         name='stop_goma',
-        script=self.m.path.join(self._goma_dir, 'goma_ctl.py'),
-        args=['stop'], **kwargs)
+        script=self.goma_ctl,
+        args=['stop'], env=self._goma_ctl_env, **kwargs)
+
+    self.upload_logs()
+
     self._goma_started = False
+    self._goma_ctl_env = {}
+
+
+  def upload_logs(self, name=None):
+    args = [
+        '--upload-compiler-proxy-info'
+    ]
+
+    if self._ninja_log_outdir:
+      args.extend([
+        '--ninja-log-outdir', self._ninja_log_outdir,
+        '--ninja-log-compiler', self._ninja_log_compiler,
+        '--ninja-log-command', self._ninja_log_command,
+        '--ninja-log-exit-status', self._ninja_log_exit_status,
+      ])
+
+    if self._build_data_dir:
+      args.extend([
+          '--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
+    )