proph.py

import sys
import random
from local_settings import *
from automation.group_membership import load as load_group_membership
from automation.group_membership import translate as group_translator
from automation.generate_diffs_from_phab_repos import GenerateDiffs
from automation.generate_comparison_diff_across_repos import GenerateRepoComparison
from automation.diffs import diffs as submitted_diffs
from automation.repos import repos as repos_util
from phabricator.project import project as phab_project
from phabricator.user import user as phab_user
from phabricator.diff import diff as phab_diff
from phabricator.policy import policy as phab_policy
from phabricator.repository import repository as phab_repo

arg_task = sys.argv[1]


class LoadRawDiffs():
    def print_callsign_mappings(self):
        callsign_mappings = phab_diff.get_callsign_mapping()
        for mapping in callsign_mappings:
            print('{0}\t{1}'.format(mapping['callsign'], mapping['name']))

    def print_diff_mappings(self, dir):
        diff_files = submitted_diffs.get_all(dir)
        for diff_file in diff_files:
            callsign_mappings = phab_diff.get_callsign_mapping()
            group_number = submitted_diffs.get_diff_group_number(diff_file, callsign_mappings=callsign_mappings)
            print('Diff file {0} is by group {1}'.format(diff_file, group_number))

    def go(self, dir, project_part):
        diff_files = submitted_diffs.get_all(dir)
        for diff_file in diff_files:
            self.create_diff_and_revision(os.path.join(dir, diff_file), project_part)

    def create_diff_and_revision(self, diff_file, project_part):
        callsign_mappings = phab_diff.get_callsign_mapping()
        group_number = submitted_diffs.get_diff_group_number(diff_file, callsign_mappings=callsign_mappings)
        if not group_number:
            print('Error: Could not determine group number from filename: %s' % diff_file)
            return -1
        project_name = group_translator.build_project_name(
            group_num=group_number,
            project_part=project_part,
            is_marking_group=False
        )
        marking_project_name = group_translator.build_project_name(
            group_num=group_number,
            project_part=project_part,
            is_marking_group=True
        )
        # this code will only run if we know a group to which we should assign this diff to
        marking_project_phid = phab_project.get_phid_from_name(marking_project_name)
        if not marking_project_phid:
            print("Error: could not find project PHID for diff: %s" % diff_file)
            return -1
        # this code will only run if we have a valid phid for the project
        diff_id = self.create_diff_from_file(diff_file)
        if diff_id < 0:
            print('Error: Could not create differential with file: %s' % diff_file)
            return -1
        # this code will only run if we successfully created a diff
        revision_id = phab_diff.create_revision(
            diff_id=diff_id,
            title=project_name
        )
        if not revision_id:
            print('Error: Unable to create revision for diff file: %s' % diff_file)
        # this code will only run if we have successfully created a diff & revision
        policy_phid = phab_policy.create_project_policy([marking_project_phid])
        if not policy_phid:
            print("Error: unable to create policy")
            return -1
        # this code will only run if we have a policy to add to our new revision
        phab_diff.set_revision_policy(
            revision_id=revision_id,
            view_policy=policy_phid,
            edit_policy=policy_phid
        )
        revision_phid = phab_diff.get_phid_from_id(revision_id)
        if not revision_phid:
            print("Error: unable to obtain phid for revision")
            return -1
        # this code will only run if we know our marking project and revision phids
        self.assign_project_users_to_diff_revision_as_reviewers(revision_phid , marking_project_phid)
        print("Success for project: %s" % (project_name))
        '''
        print("    (diff_id: %s revision_id: %s policy_phid: %s diff_file: %s)" % (
            diff_id,
            revision_id,
            policy_phid,
            diff_file
        ))
        '''

    def assign_project_users_to_diff_revision_as_reviewers(self, revision_phid, project_phid):
        user_phids = phab_project.get_users(project_phid)
        for user_phid in user_phids:
            if user_phid not in PHAB_SUPER_USER_PHIDS:
                phab_diff.set_revision_reviewer(revision_phid, user_phid)

    def create_diff_from_file(self, diff_location):
        """
        Create a phabricator diff from a file
        :param diff_location: String: Location of the file
        :return: ID of created diff if successful. -1 if failure
        """
        with open(diff_location, 'r') as file:
            data = file.read()
            return phab_diff.create_raw(diff=data)


class Enroll():
    def go(self, csv):
        """
        go creates users.
        """
        # Create users
        users = load_group_membership.from_csv(csv)
        success = self.create_users(users)
        if success:
            print('User creation completed successfully.')
        else:
            print('User creation failed.')

    def create_users(self, users):
        """
        create_users creates users in Phabricator from a Dict of users.
        :param users: Dictionary of users.
        :return: Boolean True if successful.
        """
        success = True
        for user in users:
            error = phab_user.create(
                user['User Name'],
                user['Password'],
                user['Student Name'],
                user['Email']
            )
            if error:
                success = False
                print("Creating user %s %s failed. Attention is required." % (
                    user['User Name'],
                    user['Student Name']
                ))
            else:
                print("User %s (%s) successfully created." % (
                    user['User Name'],
                    user['Student Name']
                ))
        return success


class CreateProjects():
    def go(self, csv, project_part, is_marking_group):
        if is_marking_group:
            self.create_marking_projects(csv, project_part, is_marking_group)
        else:
            self.create_student_projects(csv, project_part, is_marking_group)

    def create_marking_projects(self, students_csv, markers_csv, project_part, icon="policy", color="red"):
        """
        create_project creates projects in Phabricator from a csv.
        :param groups: A unique list of projects.
        :param icon: String of phab icon name.
        :param color: String of phab color.
        :return: None
        """
        all_group_codes = load_group_membership.unique_groups(students_csv)
        all_tutors = load_group_membership.usernames(markers_csv)
        allocations = self.get_random_tutor_marking_allocations(all_tutors, all_group_codes)

        for tutor, group_codes in allocations.iteritems():
            print("Tutor %s is marking groups: %s" % (tutor, group_codes)) # this is in a separate loop to make it print cleanly

        for tutor, group_codes in allocations.iteritems():
            tutor_phid = phab_user.get_phid_from_username(tutor)
            for group_code in group_codes:
                group_name = group_translator.get_project_name_from_group_code(
                    group_code=group_code,
                    project_part=project_part,
                    is_marking_group=True
                )
                phab_project.create(group_name, icon, color, [tutor_phid] + PHAB_SUPER_USER_PHIDS)
                print("Created group: %s" % (group_name,))

    def get_random_tutor_marking_allocations(self, tutors=[], groups=[]):
        if not tutors:
            raise Exception("Error: No tutor usernames")
        random.shuffle(groups)
        tutor_allocations = {tutor: [] for tutor in tutors}
        unallocated_groups = list(groups)

        tutor_index = 0
        while len(unallocated_groups):
            cur_group = unallocated_groups.pop()
            tutor_allocations[tutors[tutor_index]].append(cur_group)
            tutor_index += 1
            tutor_index %= len(tutors)

        return tutor_allocations

    def create_student_projects(self, csv, project_part, icon="policy", color="red"):
        """
        create_project creates projects in Phabricator from a csv.
        :param groups: A unique list of projects.
        :param icon: String of phab icon name.
        :param color: String of phab color.
        :return: None
        """
        groups = load_group_membership.unique_groups(csv)
        for group_code in groups:
            group_name = group_translator.get_project_name_from_group_code(
                group_code=group_code,
                project_part=project_part,
                is_marking_group=False
            )
            if group_name:
                usernames = load_group_membership.users_for_group(csv, group_code)
                phids = []
                for u in usernames:
                    phids.append(phab_user.get_phid_from_username(u))
                phids = phids + PHAB_SUPER_USER_PHIDS

                phab_project.create(group_name, icon, color, phids)
                print("Created group: %s" % (group_name,))
            else:
                print("Skipped: %s" % (group_code,))

    def lockdown_student_projects(self, csv, project_part):
        groups = load_group_membership.unique_groups(csv)
        for group_code in groups:
            group_name = group_translator.get_project_name_from_group_code(
                group_code=group_code,
                project_part=project_part,
                is_marking_group=False
            )
            if group_name:
                project_phid = phab_project.get_phid_from_name(group_name)
                print("Locking down {0} ({1})".format(group_name, project_phid))
                phab_project.set_policy(project_phid, project_phid, project_phid, project_phid)
            else:
                print("Skipped: %s" % (group_code,))


class CreateRepos():
    def create_repos(self, csv, repo_name):
        """
        create_repos creates repositories in Phabricator from a csv.
        :param csv: csv entries of each student and their group.
        :param repo_name: Name that each repository will be given.
        :return: None.
        """
        groups = load_group_membership.unique_groups(csv)
        for group_code in groups:
            group_num = group_translator.get_group_number_from_group_code(group_code)

            if not group_num is None:
                callsign = repos_util.callsign_from_group_num(group_num)
                uri = repos_util.generate_uri(PHAB_API_ADDRESS, callsign)

                phab_repo.create(repo_name, callsign, uri)

                # Sets the repository to be "Hosted on Phabricator".
                details = phab_repo.get_repository_phab_hosted(callsign)
                details = details.replace('importing":true', 'importing":false')
                details = details.replace('false}', 'false,"hosting-enabled":true,"serve-over-http":"readwrite"}')
                phab_repo.set_repository_phab_hosted(details, callsign)

                print("Created repo for group: %s" % (group_num,))
            else:
                print("Skipped: %s" % (group_code,))

    def lockdown_repos(self, csv, projectPhid=False):
        """
        lockdown_repos sets custom policies on the repositories, such that only
        project members can view, edit, and push their repository.
        :param csv: csv entries of each student and their group.
        :return: None.
        """
        groups = load_group_membership.unique_groups(csv)
        for group_code in groups:
            group_num = group_translator.get_group_number_from_group_code(group_code)

            if not group_num is None:
                student_project_name = group_translator.build_project_name(group_num, 1, False)
                student_project_phid = phab_project.get_phid_from_name(student_project_name)

                if student_project_phid is not None:
                    callsign = repos_util.callsign_from_group_num(group_num)

                    if projectPhid == False:
                # Sets the repository policy to only the Project members.
                        policy = phab_policy.create_project_policy([student_project_phid])
                        phab_repo.set_repository_policy(callsign, policy, policy, policy)
                    else:
                        policy = student_project_phid
                        phab_repo.set_repository_policy(callsign, policy, policy, policy)


                    print("Repo %s was assigned policy %s (View,Edit,Push) allowing access from student group %s" % (
                        callsign,
                        policy,
                        student_project_name,
                    ))
                else:
                    print("ERROR: Unable to determine student groups for group %s" % (group_num,))
            else:
                print("Skipped: %s" % (group_code,))


def thanks():
    print("")
    print("Task complete. ( " + u"\uff65\u203f\uff65".encode('utf-8') + " )")

# Parse arguments to do stuff

if arg_task == 'enroll':
    # python proph.py enroll group_members.csv
    action = Enroll()
    action.go(sys.argv[2])
    thanks()

elif arg_task == 'create-student-groups':
    # python proph.py create-student-groups students.csv 1234
    part = int(sys.argv[3])
    action = CreateProjects()
    action.create_student_projects(sys.argv[2], part)
    thanks()

elif arg_task == 'lockdown-student-groups':
    # python proph.py lockdown-student-groups students.csv 1234
    part = int(sys.argv[3])
    action = CreateProjects()
    action.lockdown_student_projects(sys.argv[2], part)
    thanks()

elif arg_task == 'create-marker-groups':
    # python proph.py create-marker-groups students.csv markers.csv 1234
    part = int(sys.argv[4])
    action = CreateProjects()
    action.create_marking_projects(sys.argv[2], sys.argv[3], part, True)
    thanks()

elif arg_task == 'create-repos':
    # python proph.py create-repos students.csv Project
    action = CreateRepos()
    action.create_repos(sys.argv[2], sys.argv[3])
    thanks()

elif arg_task == 'lockdown-repos':
    # python proph.py lockdown-repos students.csv
    action = CreateRepos()
    action.lockdown_repos(sys.argv[2])
    thanks()

elif arg_task == 'lockdown-repos-project':
    # python proph.py lockdown-repos-project students.csv
    action = CreateRepos()
    action.lockdown_repos(sys.argv[2], True)
    thanks()

elif arg_task == 'load-diffs':
    # python proph.py load-diffs diffs/ 1234
    part = int(sys.argv[3])
    action = LoadRawDiffs()
    action.go(sys.argv[2], part)
    thanks()

elif arg_task == 'print-diff-mappings':
    # python proph.py print-diff-mappings diffs/
    action = LoadRawDiffs()
    action.print_diff_mappings(sys.argv[2])
    thanks()

elif arg_task == 'print-callsign-mappings':
    # python proph.py print-callsign-mappings
    action = LoadRawDiffs()
    action.print_callsign_mappings()
    thanks()

elif arg_task == 'grant-student-diff-access':
    # python proph.py grant-student-diff-access students.csv 1234
    part = int(sys.argv[2])
    all_diffs = phab_diff.get_all_diffs()
    for diff in all_diffs:
        group_number = group_translator.get_group_number_from_project_name(diff['title'])
        project_number = group_translator.get_project_number_from_project_name(diff['title'])
        if project_number == part:
            # note: if your student groups differ from marking groups, you can use the commented out line below
            # make sure you change the number (1) to the student group you want to use.
            student_project_name = group_translator.build_project_name(group_number, 1, False)
            # student_project_name = group_translator.build_project_name(group_number, project_number, False)
            marking_project_name = group_translator.build_project_name(group_number, project_number, True)
            student_project_phid = phab_project.get_phid_from_name(student_project_name)
            marking_project_phid = phab_project.get_phid_from_name(marking_project_name)
            if marking_project_phid is not None and student_project_phid is not None:
                policy = phab_policy.create_project_policy([student_project_phid, marking_project_phid])
                phab_diff.set_revision_policy(diff['id'], policy, policy)
                print('Diff %s was assigned policy %s (View,Edit) allowing access from student group %s and marking group %s' % (
                    diff['title'],
                    policy,
                    student_project_name,
                    marking_project_name,
                ))
            else:
                print('ERROR: Unable to determine student and/or marking groups for %s' % diff['title'])
        else:
            # these diff are not belong to us (probably from a different project)
            pass

    thanks()

elif arg_task == 'generate-diffs':
    # python proph.py generate-diffs 2016-09-25 /var/repo /shared_volume/generated_diffs
    date = sys.argv[2]
    repos = sys.argv[3]
    output = sys.argv[4]
    action = GenerateDiffs()
    action.from_phabricator_repos(repos, output, date)
    thanks()


elif arg_task == 'generate-repo-comparison':
    # python proph.py generate-repo-comparison /var/repo /shared_volume/generated_diffs
    repos = sys.argv[2]
    output = sys.argv[3]
    action = GenerateRepoComparison()
    action.from_phabricator_repos(repos, output)
    thanks()

else:
    print("Unknown command. " + u"\u00af\_(\u30c4)_/\u00af".encode('utf-8'))