recipe_modules/tricium/api.py

# Copyright 2018 The LUCI Authors. All rights reserved.
# Use of this source code is governed under the Apache License, Version 2.0
# that can be found in the LICENSE file.

"""API for Tricium analyzers to use."""

from collections import namedtuple

from recipe_engine import recipe_api
from recipe_engine.config_types import Path


class TriciumApi(recipe_api.RecipeApi):
  """TriciumApi provides basic support for Tricium."""

  def __init__(self, repository, ref, paths, **kwargs):
    """Sets up the API.

    This assumes that the input is a Tricium GitFileDetails
    object, and the output is a Tricium Results object (see
    https://chromium.googlesource.com/infra/infra/+/master/go/src/infra/tricium/api/v1/data.proto
    for details and definitions).
    """
    super(TriciumApi, self).__init__(**kwargs)
    self._repo = repository
    self._ref = ref
    self._paths = paths
    self._comments = []

  @property
  def paths(self):
    return self._paths

  @property
  def repository(self):
    return self._repo

  @property
  def ref(self):
    return self._ref

  def add_comment(self,
                  category,
                  message,
                  path,
                  url="",
                  start_line=0,
                  end_line=0,
                  start_char=0,
                  end_char=0,
                  suggestions=None):
    comment = {
      'category': category,
      'message': message,
      'url': url,
      'path': path,
      'start_line': start_line,
      'end_line': end_line,
      'start_char': start_char,
      'end_char': end_char,
      'suggestion': suggestions or [],
    }
    if not comment in self._comments:
      self._comments.append(comment)

  def write_comments(self, dump=False):
    result = self.m.step('write results', [])
    if dump:
      result.presentation.properties['tricium'] = self.m.json.dumps({
        'comments': self._comments,
      })
    else:
      result.presentation.properties['tricium'] = {
        'comments': self._comments,
      }