autoissue.py

#!/usr/bin/python
#from os import listdir, path
import os, argparse, re, errno, globals
from util import debug_print

basePath = ""

#issue class, just has the content and lineNumber fields right now.
class Issue:
	def __init__(self, title, issueContent, lineNumber, fileName, label, inum):
		self.data = {}
		self.title = title
		self.issue = issueContent
		self.line = lineNumber
		self.fileName = fileName
		self.label = label
		self.issue_num = inum

	def __str__(self):
		return "Issue: {}\n\tIssue#: {}\n\tFile: {}\n\tLine: {}\n\tLabels: {}\n\tContent: {}\n".format(self.title, self.issue_num, self.fileName, self.line, self.label, self.issue)

	def __cmp__(self, other):
		return self.title == other.title \
		and self.issue == other.issue \
		and	self.line  == other.line \
		and	self.fileName  == other.fileName \
		and	self.label == other.label \
		and	self.issue_num == other.issue_num \

# Returns whitelist in regex form
def getWhitelistRegex():
	whitelistinfile = None
	while whitelistinfile is None:
		try:
			with open("autoissue.whitelist") as file:
				whitelistinfile = [item.strip() for item in file.readlines()]
		except IOError as (eno, strerror):
			if eno == errno.ENOENT:
				open("autoissue.whitelist", "w")

	whitelist = []

	for entry in whitelistinfile:
		e = os.path.join(basePath, entry)
		if os.path.isdir(e):
			entry += "/*"
		whitelist.append(entry.replace("*", "(.*)"))
	return whitelist

#Function that gets all of the whitelisted files (and folders) in a folder
def getFiles():
	fileList = []

	for root, dirs, files in os.walk(basePath):
		for fileName in files:
			relDir = os.path.relpath(root, basePath)
			relFile = os.path.join(relDir, fileName)
			print "RELFILE:", relFile
			if any([re.match(pattern + "$", relFile) is not None for pattern in getWhitelistRegex()]):
				fileList.append(os.path.join(basePath, relFile))
				#print "##################"
				#print "ROOT", root
				#print "FILENAME:", fileName
				#print "JOINED PATH:", os.path.join(basePath, relFile)
				#print "##################"

	return fileList

def getIssues():
	files = getFiles()
	issues = []
	for file in files:
		issues += findIssuesInFile(file)
	return issues


# returns a list of the Issues in this file
def findIssuesInFile(file):
	lineNumber = 0
	issueList = []

	with open(file, 'r') as f:
		data = f.readlines()

	debug_print("Searching for issues in:", file, "(lines: {})".format(len(data)))

	while lineNumber < len(data):
		issueString = ""
		if globals.startToken in data[lineNumber]:
			# TODO: change to check if // comes just before startToken. This will cover the case where the comment comes after code in the line. Also, handle this case.
			if data[lineNumber].strip().startswith("//"):
				startingLine = lineNumber
				issueString += data[lineNumber]
				lineNumber += 1
				while lineNumber < len(data):
					line = data[lineNumber]
					if line.strip(): # if the line is not empty
						if line.startswith("//"):
							issueString += line[2:]
						else:
							lineNumber -= 1 # since we increment outside of this loop
							break
					lineNumber += 1
			elif data[lineNumber].strip().startswith("/*"):
				startingLine = lineNumber
				issueString += data[lineNumber]
				if not issueString.strip().endswith("*/"):
					lineNumber += 1
					while lineNumber < len(data):
						line = data[lineNumber]
						if line.strip():
							issueString += line
							if line.strip().endswith("*/"):
								break
						lineNumber += 1
			else:
				lineNumber += 1
				break
			issueList.append(parseIssueFromRawComment(issueString, startingLine, file))
		lineNumber += 1
	return issueList


# returns an Issue
def parseIssueFromRawComment(comment, line, file):
	data = {}
	title = None
	labels = []
	inum = None
	tags_regex = "\[(.*?)\]"
	r = re.compile(tags_regex)
	tags = r.findall(comment)

	# If no [title:] tag is specified, then the first line is autmatically the title
	for tag in tags:
		if ":" not in tag:
			# This is the issue number tag
			inum = int(tag) # Should eventually check to be sure there are only numbers in here
		else:
			t, v = tag.split(":")
			if t.lower() == "title":
				title = v
			elif t.lower() == "label":
				labels = [x.strip() for x in v.split(",")]

	if title is None:
		title = comment.splitlines()[0] # Make the title the first line of the comment

	content = re.sub(tags_regex, "", comment)
	content = re.sub("(//(\s*)TODO)|(/\*(\s*)TODO)|(\*/)", "", content).strip()
	issue = Issue(title, content, line + 1, file, labels, inum)
	issue.data = data
	return issue

def injectNumber(issue, number):
	with open(issue.fileName, 'r') as file:
		data = file.readlines()

	print "Starttoken:", globals.startToken

	lineNumber = issue.line - 1
	line = data[lineNumber]
	startIndex = line.index(globals.startToken) + len(globals.startToken)
	data[lineNumber] = line[:startIndex] + " [" + str(number) + "] " + line[startIndex:]

	with open(issue.fileName, 'w') as file:
		file.writelines(data)

def main():
	from github import createIssues
	parser = argparse.ArgumentParser(description="Auto-Issue-Creator argument parser")
	parser.add_argument("-s", "--start", help="the token that begins the TODO: (ie. 'TODO')", default="TODO")
	parser.add_argument("-d", "--debug", action='store_true', help="enable debug mode (no POSTing to github)")
	parser.add_argument("-p", "--path", help="the base path of the project to be scanned", default=".")
	parser.add_argument("-i", "--interactive", action='store_true', help="enable interactive mode (pick and choose which issues get POSTed to github)")
	globals.init()

	args = vars(parser.parse_args())
	globals.startToken = args["start"]
	print "Using start token:", globals.startToken

	#see if we're in debug mode
	if args["debug"]:
		debug = True
		print "Debug mode enabled"
	else:
		debug = False

	global basePath
	basePath = os.path.abspath(os.path.expanduser(args['path']))
	print "Base path of project:", basePath

	issueList = getIssues()
	print "Found {} {}:".format(len(issueList), "issue" if len(issueList) is 1 else "issues")

	for issue in list(issueList):
		print issue
		if args["interactive"]:
			post = raw_input('Create this issue in github? (y/n) ')
			if post.lower() == 'n' or post.lower() == 'no':
				issueList.remove(issue)

	print "Creating {} issues".format(len(issueList))
	createIssues(issueList, debug)

if __name__ == "__main__":
    main()