# 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.

from recipe_engine import post_process
from recipe_engine.recipe_api import Property

PYTHON_VERSION_COMPATIBILITY = 'PY2+3'

DEPS = ['tricium', 'properties']

PROPERTIES = {
    'trigger_type_error': Property(kind=bool, default=False),
}


def RunSteps(api, trigger_type_error):
  filename = 'path/to/file'
  api.tricium.add_comment('test', 'test message', filename)
  # Duplicate comments aren't entered.
  api.tricium.add_comment('test', 'test message', filename)

  # Suggestions are given as JSON.
  suggestions = [{'description': 'please fix this'}]

  api.tricium.add_comment(
      'another',
      'another test message',
      'path/to/file/2',
      start_line=1,
      end_line=1,
      start_char='10' if trigger_type_error else 10,
      end_char=20,
      suggestions=suggestions,
  )

  api.tricium.write_comments()


def GenTests(api):
  yield api.test('basic')
  yield (api.test('type_error') + api.properties(trigger_type_error=True) +
         api.expect_exception('TypeError') +
         api.post_process(post_process.DropExpectation))