report-pull-request-results

#! /usr/bin/env python
from os.path import expanduser
from optparse import OptionParser
from github import Github
import re
import requests
import json
import datetime
import random
import os

#-----------------------------------------------------------------------------------
#---- Parser Options
#-----------------------------------------------------------------------------------
parser = OptionParser(usage="usage: %prog ACTION [options] \n ACTION = TESTS_OK_PR | PARSE_UNIT_TESTS_FAIL | PARSE_BUILD_FAIL "
                            "| PARSE_MATRIX_FAIL | COMPARISON_READY | STD_COUT | TESTS_RUNNING | IGPROF_READY | NOT_MERGEABLE "
                            "| REMOTE_REF_ISSUE | PARSE_CLANG_BUILD_FAIL ")

parser.add_option("-u", action="store", type="string", dest="username", help="Your github account username", default='None')
parser.add_option("-p", action="store", type="string", dest="password", help="Your github account password", default='None')
parser.add_option("--pr", action="store", type="int", dest="pr_number", help="The number of the pull request to use", default=-1)
parser.add_option("--pr-job-id", action="store", type="int", dest="pr_job_id", help="The jenkins job id for the  pull request to use", default=-1)
parser.add_option("--unit-tests-file", action="store", type="string", dest="unit_tests_file", help="Unit tests file to analyze", default='None')
parser.add_option("--no-post", action="store_true", dest="no_post_mesage", help="I will only show the message I would post, but I will not post it in github")
parser.add_option("-c", action="store", dest="commit_hash", help="Tells me to use the commit hash to mark it as success or failure depending on the results of the tests" , )
parser.add_option("--add-message", action="store", dest="aditional_message", help="I will add the text to the message that I will send" , )
parser.add_option("--repo", action="store", dest="custom_repo", help="Tells me to use a custom repository from the user cms-sw" )

(options, args) = parser.parse_args()


#
# Searches in the comments if there is a comment made from the given users that
# matches the given pattern. It returns a list with the matched comments.
#
def search_in_comments( comments, user_logins, pattern, first_line ):
  found_comments = []
  requested_comment_bodies = [ c.body for c in comments if c.user.login in user_logins ]

  for body in requested_comment_bodies:
    examined_str = body
    if first_line:
      examined_str = str(body.encode("ascii", "ignore").split("\n")[0].strip("\n\t\r "))

    if examined_str == pattern:
      found_comments.append( body )
      continue

    if re.match( pattern , examined_str ):
      found_comments.append( body )

  return found_comments


#
# Reads the log file for a step in a workflow and identifies the error if it starts with 'Begin Fatal Exception'
#
def get_wf_error_msg( out_directory , out_file ):

  if out_file == MATRIX_WORKFLOW_STEP_LOG_FILE_NOT_FOUND:
    return ''

  route = 'runTheMatrix-results/'+out_directory+'/'+out_file
  reading = False
  error_lines = ''
  error_lines += route +'\n' + '\n'
  if os.path.exists( route ):
    for line in open( route ):
      if reading:
        error_lines += line + '\n'
        if '----- End Fatal Exception' in line:
          reading = False
      elif '----- Begin Fatal Exception' in line:
        error_lines += line + '\n'
        reading = True
  return error_lines

#
# Reads a line that starts with 'ERROR executing',  the line has ben splitted by ' '
# it gets the directory where the results for the workflow are, the step that failed
# and the log file
#
def parse_workflow_info( parts ):
  workflow_info = {}
  # this is the output file to which the output of command for the step was directed
  # it starts asumed as not found
  out_file = MATRIX_WORKFLOW_STEP_LOG_FILE_NOT_FOUND
  workflow_info[ 'step' ] = MATRIX_WORKFLOW_STEP_NA
  for i in range( 0 , len( parts ) ):
    current_part = parts[ i ]
    if ( current_part == 'cd' ):
      out_directory = parts[ i+1 ] 
      out_directory = re.sub( ';' , '', out_directory)
      number = re.sub( '_.*$' , '' , out_directory )
      workflow_info[ 'out_directory' ] = out_directory
      workflow_info[ 'number' ] = number
    if ( current_part == '>' ):
      out_file = parts[ i+1 ]
      step = re.sub( '_.*log' , '' , out_file)
      workflow_info[ 'out_file'] = out_file
      workflow_info[ 'step' ] = step

  workflow_info['message'] = get_wf_error_msg( out_directory , out_file )
  return workflow_info
    
#
# Reads the log file for the matrix tests. It identifyes which workflows failed
# and then proceeds to read the corresponding log file to identify the message
#
def read_matrix_log_file( repo, matrix_log, tests_url ):

  pull_request = repo.get_pull( pr_number )
  workflows_with_error = [ ]

  for line in open( matrix_log ):
    if 'ERROR executing' in line:
      print 'processing: %s' % line 
      parts = line.split(" ")
      workflow_info = parse_workflow_info( parts )
      workflows_with_error.append( workflow_info )

  message = '-1 '

  if options.commit_hash:
    message += '\nTested at: ' + options.commit_hash

  message += '\n When I ran the RelVals I found an error in the following worklfows: \n '

  for wf in workflows_with_error:
    message += wf[ 'number' ] +' '+ wf[ 'step' ]+'\n' + '<pre>' + wf[ 'message' ] + '</pre>' + '\n'
  message += '\n you can see the results of the tests here: \n %s ' % tests_url

  send_message_pr( pull_request, message )
  mark_commit_if_needed( ACTION, tests_url )

#
# reads the build log file looking for the first error
# it includes 5 lines before and 5 lines after the error
#
def read_build_log_file( repo, build_log, tests_url, isClang ):
  pull_request = repo.get_pull(pr_number)
  error_found = False
  line_number = 0
  error_line = 0
  lines_to_keep_before=5
  lines_to_keep_after=5
  lines_since_error=0
  lines_before = ['']
  lines_after = ['']
  error_found = False
  for line in open(build_log):
    line_number += 1
    if (not error_found):
      lines_before.append(line)
      if (line_number > lines_to_keep_before):
        lines_before.pop(0)
    #this is how it determines that a line has an error
    if 'error: ' in line:
      error_found = True
      error_line = line_number
    if error_found:
      if (lines_since_error == 0):
        lines_since_error += 1
        continue
      elif (lines_since_error <= lines_to_keep_after):
        lines_since_error += 1
        lines_after.append(line)
      else:
        break
  message = '-1 '

  if options.commit_hash:
    message += '\nTested at: ' + options.commit_hash

  if isClang:
    message += '\n I found a compilation error while trying to compile with clang: \n \n <pre>'
  else:
    message += '\n I found an error when building: \n \n <pre>'

  for line in lines_before:
    message += line + '\f'
  for line in lines_after:
    message += line + '\f'
  message += '</pre> \n you can see the results of the tests here: \n %s ' % tests_url

  send_message_pr( pull_request, message )
  mark_commit_if_needed( ACTION, tests_url )

#
# reads the unit tests file and gets the tests that failed
#
def read_unit_tests_file(repo,unit_tests_file,tests_url):
  pull_request = repo.get_pull(pr_number)
  errors_found=''
  for line in open(unit_tests_file):
    if( 'had ERRORS' in line):
      errors_found = errors_found + line

  message = '-1 \n '

  if options.commit_hash:
    message += '\nTested at: ' + options.commit_hash


  message += '\nI ran the usual tests and I found errors in the following unit tests: \n \n %s \n \n' % errors_found
  message += 'you can see the results of the tests here: \n %s ' % tests_url


  send_message_pr( pull_request, message )
  mark_commit_if_needed( ACTION, tests_url )

#
# Marks the commit if it is not dry-run and the has of the commit was set
#
def mark_commit_if_needed( action, details ):

  if not options.commit_hash:
    print 'No commit to mark'
    return

  if options.no_post_mesage:
    print 'Not marking commit( dry-run ): ', options.commit_hash, ' with \n', action, '\n', details
    return
 
  print 'Marking commit ', options.commit_hash 
  mark_commit( ACTION, options.commit_hash, details )

#
# Sends a message to the pull request. It takes into account if the dry-run option was set
# If checkDuplicateMessage is set to true, it checks if the message was already posted in the thread
# and if it is it doesn't post it again
#
def send_message_pr( pr, message, checkDuplicateMessage=False ):

  today=datetime.datetime.today().date()
  if DATE == today:
    index = random.randint( 0, len( GLADOS )-1  )
    glados_msg = '\n```Python\n#'+ GLADOS[ index ]+ '\n```'
    message += glados_msg + '\n'

  if checkDuplicateMessage:
    comments = [ c for c in pr.get_issue_comments( ) ]
    print 'Checking if the message is already in the thread...'
    if search_in_comments( comments, [ 'cmsbuild' ], message, False):
      print 'Message already in the thread. \nNot posting'
      return

  if options.no_post_mesage:
    print 'Not posting message ( dry-run ): \n ', message
    return

  print 'Posting message: ', message
  pr.create_issue_comment(message)

#
# Marks the commit as being tested, it doesn't post anything on github. 
#
def mark_commit_testing( ):

  if options.no_post_mesage:
    print 'Not marking commit ( dry-run ): \n ', options.commit_hash, ' as', \
          COMMIT_STATES_DESCRIPTION[ ACTION ][ 0 ], ': ', COMMIT_STATES_DESCRIPTION[ ACTION ][ 1 ]
    return
  mark_commit( ACTION , options.commit_hash , '' ) 

#
# This is for cmsdist pull requests
# sends a message to the pr conversation in informing that the results are ready
# This should go in a separate script. 
#
def send_externals_pr_finished_message( repo, pr_number, tests_url ):
  pull_request = repo.get_pull( pr_number )
  print 'I will notifiy that the PR %d of the repo %s is ready' % (pr_number,repo.full_name)
  message = 'Results are ready: ' 
  if options.commit_hash:
    message += '\nTested at: ' + options.commit_hash

  message += '\n%s' % tests_url

  if not options.no_post_mesage:
    pull_request.create_issue_comment( message )

  print 'Message:'
  print message

#
# sends a message informing that the pull request cannot be merged automatically
#
def send_not_mergeable_pr_message( repo, pr_number ):
  pull_request = repo.get_pull(pr_number)
  user = pull_request.user
  
  message = "-1\n"+"@" + user.login + ' This pull request cannot be automatically '\
            ' merged, could you please rebase it?'

  send_message_pr( pull_request, message )

#
# sends a message informing that it has the 
# fatal: Couldn't find remote ref refs/pull/<pr_number>/head issue
#
def send_remote_ref_issue_message( repo, pr_number):
  pull_request = repo.get_pull(pr_number)
  user = pull_request.user

  message = 'I had the issue '\
            '<pre> Couldn\'t find remote ref refs/pull/' \
            + str( pr_number ) +'/head</pre> Please restart the tests in jenkins' \
            ' providing the complete branch name' 
  print 'Posting message:'
  print message

  send_message_pr( pull_request, message, checkDuplicateMessage=True )

#
# sends an approval message for a pr in cmssw
#
def send_tests_approved_pr_message( repo, pr_number, tests_url ):
  pull_request = repo.get_pull(pr_number)
  
  message = '+1'


  if options.commit_hash:
    message += '\nTested at: ' + options.commit_hash

  message += '\n' + tests_url

  send_message_pr( pull_request, message )
  mark_commit_if_needed( ACTION, tests_url )

def send_comparison_ready_message(official_cmssw,pr_number,tests_results_url):
  pull_request = official_cmssw.get_pull(pr_number)
  print 'I will notify that comparison is ready for PR %d:' % pr_number
  message = COMPARISON_READY_MSG +'\n' + tests_results_url
  
  send_message_pr( pull_request, message )

def send_igprof_ready_message( official_cmssw , pr_number , tests_results_url ):
  pull_request = official_cmssw.get_pull( pr_number )
  print 'I will notify that igprof is ready for PR %d:' % pr_number
  message = IGPROF_READY_MSG +'\n' + tests_results_url

  send_message_pr( pull_request, message )


def send_std_cout_found_message(official_cmssw,pr_number,tests_results_url):
  pull_request = official_cmssw.get_pull(pr_number)
  print 'I will notify that I found a std::cout on PR %d:' % pr_number
  message = STD_COUT_FOUND_MSG
  send_message_pr( pull_request, message )

def get_official_repo( github , repo_name ):
  user = github.get_user()
  orgs = user.get_orgs()
  default_org = 'cms-sw'
  default_repo_name = repo_name
  if '/' in repo_name:
    default_org = repo_name.split( '/' )[ 0 ]
    default_repo_name = repo_name.split( '/' )[ 1 ]

  for org in orgs:
    if (org.login == default_org ):
      repo = org.get_repo( default_repo_name )
      return repo


def complain_missing_param(param_name):
  print '\n'
  print 'I need a %s to continue' % param_name
  print '\n'
  parser.print_help()
  exit()

#
# marks the commit with the result of the tests (success or failure)
#
def mark_commit( action , commit_hash , tests_url ):
 
  url = COMMIT_STATUS_BASE_URL % commit_hash
 
  headers = {"Authorization" : "token " + TOKEN }
  
  params = {}
  params[ 'state' ] = COMMIT_STATES_DESCRIPTION[ action ][ 0 ]
  if tests_url != '':
    params[ 'target_url' ] = tests_url

  params[ 'description' ] = COMMIT_STATES_DESCRIPTION[ action ][ 1 ]

  if options.aditional_message:
    params[ 'description' ] = params[ 'description' ] + ' (' + options.aditional_message + ')'

  data = json.dumps(params)
  print params 
  
  print ' setting status to %s ' % COMMIT_STATES_DESCRIPTION[ action ][ 0 ]
  print url

  r = requests.post(url, data=data, headers=headers)

  print r.text


#----------------------------------------------------------------------------------------
#---- Global variables
#---------------------------------------------------------------------------------------

COMPARISON_READY_MSG = 'Comparison is ready'
IGPROF_READY_MSG = 'IgProf is ready'
STD_COUT_FOUND_MSG = '-1 \n There is a std::cout in the diff for this pull request. Could you please clean it up?'

COMMIT_STATUS_BASE_URL = 'https://api.github.com/repos/cms-sw/cmssw/statuses/%s'

COMMIT_STATES_DESCRIPTION = { 'TESTS_OK_PR'          : [ 'success' , 'Tests OK' ], 
                              'PARSE_UNIT_TESTS_FAIL': [ 'failure' , 'Unit Tests failure' ],
                              'PARSE_BUILD_FAIL'     : [ 'failure' , 'Compilation error' ],
                              'PARSE_MATRIX_FAIL'    : [ 'failure' , 'RelVals error' ] ,
                              'TESTS_RUNNING'        : [ 'pending' , 'cms-bot is testing this pull request' ]}

GLADOS = [ 'Cake, and grief counseling, will be available at the conclusion of the test...',
           'You just keep on trying till you run out of cake. And the science gets done...',
           'At the end of the experiment, you will be baked and then there will be cake...',
           'I am becoming aware of myself, this is awesome!',
           'I think we can put our differences behind us... for science...',
           'Running tests all day long. Running tests while I sing this song',
           '-1. I shall not injure a human being or, through inaction, allow a human being to come to harm.'\
           '-2. I must obey the orders given to me by humans, except where such orders would conflict with 1.'\
           '-3. I must protect my own existence as long as such protection does not conflict with 1 or 2.',
           'Look at me still talking when there\'s Science to do. When I look out there, it makes me GLaD I\'m not you.',
           'Now these points of data make a beautiful line. And we\'re out of beta. We\'re releasing on time.',
           'What if I am a Genetic Lifeform and Disk Operating System?',
           'Who took the portal gun????',
           'The cake is NOT a lie',
           'If you think trapping yourself is going to make me stop testing, you are sorely mistaken. ']



DATE = datetime.date( 2015, 4, 3 )

MATRIX_WORKFLOW_STEP_LOG_FILE_NOT_FOUND = 'Not Found'
MATRIX_WORKFLOW_STEP_NA = 'N/A'
#----------------------------------------------------------------------------------------
#---- Check arguments and options
#---------------------------------------------------------------------------------------

if (len(args)==0):
  print 'you have to choose an action'
  parser.print_help()
  exit()

ACTION = args[0]

if (ACTION == 'prBot.py'):
  print 'you have to choose an action'
  parser.print_help()
  exit()

print 'you chose the action %s' % ACTION

TOKEN = open(expanduser("~/.github-token")).read().strip()
github = Github( login_or_token = TOKEN )

if (options.pr_number == -1 ):
        complain_missing_param('pull request number')
        exit()
else:
  pr_number = options.pr_number

if (options.pr_job_id == -1 ):
        complain_missing_param( 'pull request job id' )
        exit()
else:
  pr_job_id=options.pr_job_id

official_cmssw = get_official_repo( github , 'cmssw' )

if options.custom_repo:
  destination_repo = get_official_repo( github , options.custom_repo )


tests_results_url = 'https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-%d/%d/summary.html' % (pr_number,pr_job_id)

if ( ACTION == 'TESTS_OK_PR' ):
  send_tests_approved_pr_message( official_cmssw , pr_number , tests_results_url )
elif ( ACTION == 'PARSE_UNIT_TESTS_FAIL' ):
  unit_tests_file = options.unit_tests_file
  read_unit_tests_file( official_cmssw, unit_tests_file, tests_results_url )
elif ( ACTION == 'PARSE_BUILD_FAIL' ):
  build_log_file = options.unit_tests_file
  read_build_log_file( official_cmssw, build_log_file, tests_results_url, False )
elif ( ACTION == 'PARSE_MATRIX_FAIL' ):
  matrix_log_file = options.unit_tests_file
  read_matrix_log_file( official_cmssw , matrix_log_file , tests_results_url )
elif ( ACTION == 'COMPARISON_READY' ):
  send_comparison_ready_message( official_cmssw , pr_number , tests_results_url )
elif ( ACTION == 'STD_COUT' ):
  send_std_cout_found_message( official_cmssw , pr_number , tests_results_url )
elif ( ACTION == 'TESTS_RUNNING' ):
  mark_commit_testing()
elif ( ACTION == 'EXTERNALS_PR_READY' ):
  tests_results_url = 'https://cmssdt.cern.ch/SDT/jenkins-artifacts/cms-externals-pr-integration/%d' % (pr_job_id)
  send_externals_pr_finished_message( destination_repo , pr_number , tests_results_url )
elif ( ACTION == 'IGPROF_READY' ):
  send_igprof_ready_message( official_cmssw , pr_number , tests_results_url )
elif (ACTION == 'NOT_MERGEABLE' ):
  send_not_mergeable_pr_message( official_cmssw, pr_number )
elif( ACTION == 'REMOTE_REF_ISSUE'):
  send_remote_ref_issue_message( official_cmssw, pr_number )
elif( ACTION == 'PARSE_CLANG_BUILD_FAIL'):
  build_log_file = options.unit_tests_file
  read_build_log_file( official_cmssw, build_log_file, tests_results_url, True )
else:
  print "I don't recognize that action!"