''' showreleasedifferences -- shortdesc showreleasedifferences generates a version folder with a common set of version information files in it @author: dan @copyright: 2017 Global Inkjet Systems Ltd. All rights reserved. ''' import subprocess import os import sys import re from argparse import ArgumentParser from argparse import RawDescriptionHelpFormatter __all__ = [] __version__ = 0.1 __date__ = '2017-11-29' __updated__ = '2017-11-29' gitExecutable = os.getenv("GIT_EXECUTABLE", default="git") class GitException(Exception): def __init__(self, message): self.message = message def __repr__(self): return self.message def makeFolder(versionfolder): print("Creating folder (if not already there): {0}".format(versionfolder)) os.makedirs(versionfolder, exist_ok = True) def printDivider(outfh, times = 1, length = 100): for _ in range(times): outfh.write("{0}\n".format("*" * length)) TABSIZE = 4 def printTabbed(outfh, string, tabs = 0): outfh.write("{0}{1}\n".format(" " * (TABSIZE * tabs), string)) def getGitLogDifferences(outfh, gitrootfolder, previousRelease, currentRelease, tripledot = False): if tripledot: releaseExpression = previousRelease + "..." + currentRelease else: releaseExpression = previousRelease + ".." + currentRelease currentdir = os.getcwd() os.chdir(gitrootfolder) gitlog = [] printTabbed(outfh, "Executing: {0} {1} {2} {3}".format(gitExecutable, "log", "--oneline", releaseExpression)) proc = subprocess.Popen([gitExecutable, "log", "--oneline", releaseExpression], stdout=subprocess.PIPE) while True: line = proc.stdout.readline() if line: linestring = line.decode('utf-8').rstrip() gitlog.append(linestring) #printTabbed(outfh, linestring, 1) else: break proc.wait() if proc.returncode > 0: raise GitException("Git executable returned an error") os.chdir(currentdir) return gitlog jiraprojectpattern = { 'GIS' : ( re.compile("^.* +(?:[gG][iI][sS][ _-]*|[tT]rac \#*|\#\s*)(\d+):*(.*)$"), re.compile('^(\S*) Revert " *GIS-(\d+):* (.*)"$'), ), 'IMB': ( re.compile("^.* +(?:[Ii][Mm][Bb][ _-]*|\#\s*)(\d+):*(.*)$"), re.compile('^(\S*) Revert " *IMB-(\d+):* (.*)"$'), ), 'HMBXR5601': ( re.compile("^.* +(?:[Hh][Mm][Bb][Xx][Rr]5601[ _-]*|\#\s*)(\d+):*(.*)$"), re.compile('^(\S*) Revert " *HMBXR5601-(\d+):* (.*)"$'), ), 'SMB': ( re.compile("^.* +(?:[Ss][Mm][Bb][ _-]*|\#\s*)(\d+):*(.*)$"), re.compile('^(\S*) Revert " *SMB-(\d+):* (.*)"$'), ), 'HMBFDHV': ( re.compile("^.* +(?:[Hh][Mm][Bb][Ff][Dd][Hh][Vv][ _-]*|\#\s*)(\d+):*(.*)$"), re.compile('^(\S*) Revert " *HMBFDHV-(\d+):* (.*)"$'), ), } mergepattern = re.compile("^(.*)((?:Merge branch '.*'|Merge remote-tracking branch '.*'|Merge commit '.*'|Add '.*' from commit).*)$") def processLog(gitlog, jirakeyprefix): reverts = [] merges = {} other = [] numbered = {} (expectedpattern, revertpattern) = jiraprojectpattern[jirakeyprefix] for line in gitlog: expectedmatch = expectedpattern.match(line) revertmatch = revertpattern.match(line) mergematch = mergepattern.match(line) if expectedmatch == None and revertmatch == None and mergematch == None: other.append(line) if revertmatch: gisnumber = jirakeyprefix + "-" + revertmatch.group(2) description = revertmatch.group(3) reverts.append("Revert: {0} {1}".format(gisnumber, description)) if mergematch: merge = mergematch.group(2) if not merge in merges: merges[merge] = 1 else: merges[merge] += 1 if expectedmatch: gisnumber = jirakeyprefix + "-" + expectedmatch.group(1) description = expectedmatch.group(2) if not gisnumber in numbered: numbered[gisnumber] = [] numbered[gisnumber].append(description) return (reverts, merges, other, numbered) def showDifferences(differences, jirakeyprefix, outfh): (revertslog, mergeslog, otherlog, numberedlog) = differences printDivider(outfh) printTabbed(outfh, jirakeyprefix + "-Numbers Log:") for (gisnumber, descriptions) in sorted(numberedlog.items()): printTabbed(outfh, gisnumber, 1) descriptions = numberedlog[gisnumber]; for description in descriptions: printTabbed(outfh, description, 2) printDivider(outfh) printTabbed(outfh, "Revert log:") for reversion in sorted(revertslog): printTabbed(outfh, reversion, 1) printDivider(outfh) printTabbed(outfh, "Merges log:") for merge in sorted(mergeslog): printTabbed(outfh, merge, 1) printDivider(outfh) printTabbed(outfh, "Other log:") for other in sorted(otherlog): printTabbed(outfh, other, 1) def main(argv=None): # IGNORE:C0111 '''Command line options.''' if argv is None: argv = sys.argv else: sys.argv.extend(argv) program_name = os.path.basename(sys.argv[0]) program_version = "v%s" % __version__ program_build_date = str(__updated__) program_version_message = '%%(prog)s %s (%s)' % (program_version, program_build_date) program_shortdesc = __import__('__main__').__doc__.split("\n")[1] program_license = '''%s Created by dan on %s. Copyright 2017 Global Inkjet Systems Ltd. All rights reserved. Distributed on an "AS IS" basis without warranties or conditions of any kind, either express or implied. USAGE ''' % (program_shortdesc, str(__date__)) try: # Setup argument parser parser = ArgumentParser(description=program_license, formatter_class=RawDescriptionHelpFormatter) parser.add_argument("-g", "--gitroot", dest="gitrootfolder", action="store", default="GitRepository", help="root path of source files [default: %(default)s]") parser.add_argument("-s", "--sourceversion", dest="sourceversion", action="store", default="origin/master", help="source version branch or tag to discover compare against [default: %(default)s]") parser.add_argument("-p", "--previousversion", dest="previousversion", action="store", default="origin/master", help="source branch or tag to compare with [default: %(default)s]") parser.add_argument("-j", "--jirakeyprefix", dest="jirakeyprefix", action="store", default="GIS", help="jira key prefix [default: %(default)s]") parser.add_argument("-o", "--outputoptions", dest="outputoptions", action="store", default="", help="output options: Can be: opposite notcommon [default: %(default)s]") parser.add_argument("-v", "--versionfolder", dest="versionfolder", action="store", default="", help="version folder where differences file stored [default: %(default)s]") # Process arguments args = parser.parse_args() try: gitrootfolder = args.gitrootfolder sourceversion = args.sourceversion previousversion = args.previousversion jirakeyprefix = args.jirakeyprefix outputoptions = args.outputoptions versionfolder = args.versionfolder print("Git root:", gitrootfolder, "Source version:", sourceversion, "Previous source version:", previousversion) print("Jira key prefix:", jirakeyprefix, "Output options:", outputoptions, "Version folder:", versionfolder) if versionfolder: makeFolder(versionfolder) outfh = open(os.path.join(versionfolder, "differences.txt"), 'w') else: outfh = sys.stdout printDivider(outfh, times = 4) printTabbed(outfh, "Looking for changes in {2} that are not in {1} of the repository at path: {0}".format(gitrootfolder, previousversion, sourceversion)) gitlog = getGitLogDifferences(outfh, gitrootfolder, previousversion, sourceversion) showDifferences(processLog(gitlog, jirakeyprefix), jirakeyprefix, outfh) if 'opposite' in outputoptions.lower(): printDivider(outfh, times = 4) printTabbed(outfh, "Looking for changes in {2} that are not in {1} of the repository at path: {0}".format(gitrootfolder, sourceversion, previousversion)) gitlog = getGitLogDifferences(outfh, gitrootfolder, sourceversion, previousversion) showDifferences(processLog(gitlog, jirakeyprefix), jirakeyprefix, outfh) if 'notcommon' in outputoptions.lower(): printDivider(outfh, times = 4) printTabbed(outfh, "Looking for changes that are not common to {1} or {2} at path: {0}".format(gitrootfolder, sourceversion, previousversion)) gitlog = getGitLogDifferences(outfh, gitrootfolder, sourceversion, previousversion, tripledot = True) showDifferences(processLog(gitlog, jirakeyprefix), jirakeyprefix, outfh) if versionfolder: outfh.close() return 0 except Exception as e: print("Error while determining differences:", e.__repr__()) return 1 except Exception as e: indent = len(program_name) * " " print(program_name + ": " + repr(e) + "\n") print(indent + " for help use --help") return 2 if __name__ == "__main__": sys.exit(main())