botfood.py

import os, os.path
import json
import urllib


class BotFood:
    """It\'s what bots crave!!!"""
    def __init__(self, request, is_request=True, rb_client=None):
        """Make a payload out of a review list"""
        self.rb_client = rb_client
        if is_request:
            self.review_request = {
                'metadata': BotFood.get_request_metadata(request),
                'diffs': BotFood.process_diff_lists(request.get_diffs())
            }
        else:
            # So the bot food already exists treat request as path to botfood_folder
            self.input_dir = request

    @staticmethod
    def flatten_resource(resource):
        """Have one of those nasty resources from review board, but just want all its fields?"""
        obj = {}
        for field in resource._fields:
            obj[field] = resource._fields[field]
        return obj

    @staticmethod
    def get_request_metadata(request):
        metadata = BotFood.flatten_resource(request)
        metadata['repo'] = BotFood.get_request_repo_info(request)
        return metadata

    @staticmethod
    def get_request_repo_info(request):
        repo = request.get_repository()
        if repo:
            return BotFood.flatten_resource(repo)
        else:
            return None

    @staticmethod
    def process_diff_lists(difflist):
        result = []
        for diff in difflist:
            obj = {
                'diff': diff._url,
                'resource': diff,
                'revision': diff.revision,
                'files': [],
                'metadata': BotFood.flatten_resource(diff)
            }
            diff_file_list = diff.get_files()

            for file_diff in diff_file_list:
                fileobj = {
                    'filediff_id' : file_diff.id,
                    'name': file_diff.source_file,
                    'metadata': BotFood.flatten_resource(file_diff),
                    'filediff_data': BotFood.flatten_resource(file_diff.get_diff_data())
                }

                try:
                    fileobj['original'] = file_diff.get_original_file()._url
                except:
                    pass
                try:
                    fileobj['patched'] = file_diff.get_patched_file()._url
                except:
                    pass

                obj['files'].append(fileobj)
            result.append(obj)

        return result

    def save_request(self, request, path):
        if not os.path.exists(path):
            os.mkdir(path)

        "Save request metadatafile file"
        with open(os.path.join(path, 'request_metadata.json'), 'w') as outfile:
            json.dump(request['metadata'], outfile)

        for diff in request['diffs']:
            self.save_diff(request['metadata']['id'], diff, os.path.join(path, "revision" + str(diff['revision'])))

        return path

    def save_diff(self, request_id, diff, path):
        if not os.path.exists(path):
            os.mkdir(path)

        diff_content = diff['resource'].get_patch()
        with open(os.path.join(path, 'diff'), 'w') as outfile:
            outfile.write(diff_content.data)

        for fileobj in diff['files']:
            file_dir_name = fileobj['name'].replace("/", "_")
            file_dir_name = file_dir_name.replace("\\" , "_")
            file_dir_name += ".file"
            self.save_file_obj(request_id, diff['revision'], fileobj, os.path.join(path, file_dir_name))

    def save_file_obj(self, review_request_id, diff_revision, fileobj, path):
        """Save the original,patched and metadata about this fileobj"""
        if not os.path.exists(path):
            os.mkdir(path)

        "Download original"
        if 'original' in fileobj:
            urllib.urlretrieve(fileobj['original'],
                               os.path.join(path, 'original'))
        "Download patched"
        if 'patched' in fileobj:
            urllib.urlretrieve(fileobj['patched'],
                               os.path.join(path, 'patched'))
        "Download diff"
        diff = self.rb_client.get_root().get_file(review_request_id=review_request_id,
                             diff_revision=diff_revision,
                             filediff_id=fileobj['filediff_id'])
        diff = diff.get_patch()
        with open(os.path.join(path, "diff"), 'w') as outfile:
            outfile.write(diff.data)

        "Leave behind some metadata"
        with open(os.path.join(path, 'file_metadata.json'), 'w') as outfile:
            json.dump(fileobj['metadata'], outfile)

        with open(os.path.join(path, 'filediff_metadata.json'), 'w') as outfile:
            json.dump(fileobj['filediff_data'], outfile)

    def save(self, path):
        """Save the botfood_folder object, including downloading the files it has urls to"""
        request_path = os.path.join(path, str(self.review_request['metadata']['id']))
        self.save_request(self.review_request, request_path)
        return request_path