diff --git a/README.md b/README.md index c8fef2e..1ead18d 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,19 @@ Run `source ~/.zshrc` or restart terminal. ## Usage āš” +### Project structure + +The executable `gitHappens.py` is a small compatibility wrapper around the +`githappens` package: + +- `githappens/main.py` handles CLI argument parsing and command routing. +- `githappens/config.py` loads `configs/config.ini`. +- `githappens/templates.py` loads issue templates and reviewer settings. +- `githappens/gitlab_api.py` contains GitLab API and `glab` interactions. +- `githappens/git_utils.py` contains local Git helpers. +- `githappens/interactive.py` contains terminal prompts. +- `githappens/commands/` contains command-specific workflows. + ### Project selection - Project selection is made automatically if you run script in same path as your project is located. @@ -225,4 +238,3 @@ I suggest checking Gitlab's official API documentation: https://docs.gitlab.com/ ## Donating šŸ’œ Make sure to check this project on [OpenPledge](https://app.openpledge.io/repositories/zigcBenx/gitHappens). - diff --git a/gitHappens.py b/gitHappens.py index 27d47f3..ca0d9fe 100755 --- a/gitHappens.py +++ b/gitHappens.py @@ -1,845 +1,6 @@ #!/usr/bin/env python3 -import subprocess -import json -import argparse -import configparser -import inquirer -import datetime -import re -import os -import requests -import sys -import webbrowser +from githappens.main import main -# Setup config parser and read settings -config = configparser.ConfigParser() -absolute_config_path = os.path.dirname(os.path.abspath(__file__)) -config_path = os.path.join(absolute_config_path, 'configs/config.ini') -config.read(config_path) -BASE_URL = config.get('DEFAULT', 'base_url') -API_URL = BASE_URL + '/api/v4' -GROUP_ID = config.get('DEFAULT', 'group_id') -CUSTOM_TEMPLATE = config.get('DEFAULT', 'custom_template') -GITLAB_TOKEN = config.get('DEFAULT', 'GITLAB_TOKEN').strip('\"\'') -DELETE_BRANCH = config.get('DEFAULT', 'delete_branch_after_merge').lower() == 'true' -DEVELOPER_EMAIL = config.get('DEFAULT', 'developer_email', fallback=None) -SQUASH_COMMITS = config.get('DEFAULT', 'squash_commits').lower() == 'true' -PRODUCTION_PIPELINE_NAME = config.get('DEFAULT', 'production_pipeline_name', fallback='deploy') -PRODUCTION_JOB_NAME = config.get('DEFAULT', 'production_job_name', fallback=None) -PRODUCTION_REF = config.get('DEFAULT', 'production_ref', fallback=None) -MAIN_BRANCH = 'master' - -# Read templates from json config -with open(os.path.join(absolute_config_path,'configs/templates.json'), 'r') as f: - jsonConfig = json.load(f) -TEMPLATES = jsonConfig['templates'] -REVIEWERS = jsonConfig['reviewers'] -PRODUCTION_MAPPINGS = jsonConfig.get('productionMappings', {}) - -def get_project_id(): - project_link = getProjectLinkFromCurrentDir() - if (project_link == -1): - return enterProjectId() - - allProjects = get_all_projects(project_link) - # Find projects id by project ssh link gathered from repo - matching_id = None - for project in allProjects: - if project.get("ssh_url_to_repo") == project_link: - matching_id = project.get("id") - break - return matching_id - -def get_all_projects(project_link): - url = API_URL + "/projects?membership=true&search=" + project_link.split('/')[-1].split('.')[0] - - headers = { - "PRIVATE-TOKEN": GITLAB_TOKEN - } - - response = requests.get(url, headers=headers) - - if response.status_code == 200: - return response.json() - elif response.status_code == 401: - print("Error: Unauthorized (401). Your GitLab token is probably expired, invalid, or missing required permissions.") - print("Please generate a new token and update your configs/config.ini.") - exit(1) - else: - print(f"Request failed with status code {response.status_code}") - return None - -def getProjectLinkFromCurrentDir(): - try: - cmd = 'git remote get-url origin' - result = subprocess.run(cmd.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE) - if result.returncode == 0: - output = result.stdout.decode('utf-8').strip() - return output - else: - return -1 - except FileNotFoundError: - return -1 - -def enterProjectId(): - while True: - project_id = input('Please enter the ID of your GitLab project: ') - if project_id: - return project_id - exit('Invalid project ID.') - -def list_milestones(current=False): - cmd = f'glab api /groups/{GROUP_ID}/milestones?state=active' - result = subprocess.run(cmd.split(), stdout=subprocess.PIPE) - milestones = json.loads(result.stdout) - if current: - today = datetime.date.today().strftime('%Y-%m-%d') - active_milestones = [] - for milestone in milestones: - start_date = milestone['start_date'] - due_date = milestone['due_date'] - if start_date and due_date and start_date <= today and due_date >= today: - active_milestones.append(milestone) - active_milestones.sort(key=lambda x: x['due_date']) - return active_milestones[0] - return milestones - -def select_template(): - template_names = [t['name'] for t in TEMPLATES] - template_names.append(CUSTOM_TEMPLATE) - questions = [ - inquirer.List('template', - message="Select template:", - choices=template_names, - ), - ] - answer = inquirer.prompt(questions) - return answer['template'] - -def getIssueSettings(template_name): - if template_name == CUSTOM_TEMPLATE: - return {} - return next((t for t in TEMPLATES if t['name'] == template_name), None) - -def createIssue(title, project_id, milestoneId, epic, iteration, settings): - if settings: - issueType = settings.get('type') or 'issue' - return executeIssueCreate(project_id, title, settings.get('labels'), milestoneId, epic, iteration, settings.get('weight'), settings.get('estimated_time'), issueType) - print("No settings in template") - exit(2) - pass - -def executeIssueCreate(project_id, title, labels, milestoneId, epic, iteration, weight, estimated_time, issue_type='issue'): - labels = ",".join(labels) if type(labels) == list else labels - assignee_id = getAuthorizedUser()['id'] - issue_command = [ - "glab", "api", - f"/projects/{str(project_id)}/issues", - "-f", f'title={title}', - "-f", f'assignee_ids={assignee_id}', - "-f", f'issue_type={issue_type}' - ] - if labels: - issue_command.append("-f") - issue_command.append(f'labels={labels}') - - if weight: - issue_command.append("-f") - issue_command.append(f'weight={str(weight)}') - - if milestoneId: - issue_command.append("-f") - issue_command.append(f'milestone_id={str(milestoneId)}') - - if epic: - epicId = epic['id'] - issue_command.append("-f") - issue_command.append(f'epic_id={str(epicId)}') - - # Set the description, including iteration, estimated time, and other info - description = "" - if iteration: - iterationId = iteration['id'] - description += f"/iteration *iteration:{str(iterationId)} " - - if estimated_time: - description += f"\n/estimate {estimated_time}m " - - issue_command.extend(["-f", f'description={description}']) - - issue_output = subprocess.check_output(issue_command) - return json.loads(issue_output.decode()) - -def select_milestone(milestones): - milestones = [t['title'] for t in milestones] - questions = [ - inquirer.List('milestones', - message="Select milestone:", - choices=milestones, - ), - ] - answer = inquirer.prompt(questions) - return answer['milestones'] - -def getSelectedMilestone(milestone, milestones): - return next((t for t in milestones if t['title'] == milestone), None) - -def get_milestone(manual): - if manual: - milestones = list_milestones() - return getSelectedMilestone(select_milestone(milestones), milestones) - milestone = list_milestones(True) # select active for today - return milestone - -def get_iteration(manual): - if manual: - iterations = list_iterations() - return getSelectedIteration(select_iteration(iterations), iterations) - return getActiveIteration() - -def getSelectedIteration(iteration, iterations): - return next((t for t in iterations if t['start_date'] + ' - ' + t['due_date'] == iteration), None) - -def select_iteration(iterations): - iterations = [t['start_date'] + ' - ' + t['due_date'] for t in iterations] - questions = [ - inquirer.List('iterations', - message="Select iteration:", - choices=iterations, - ), - ] - answer = inquirer.prompt(questions) - return answer['iterations'] - -def list_iterations(): - cmd = f'glab api /groups/{GROUP_ID}/iterations?state=opened' - result = subprocess.run(cmd.split(), stdout=subprocess.PIPE) - iterations = json.loads(result.stdout) - return iterations - -def getActiveIteration(): - iterations = list_iterations() - today = datetime.date.today().strftime('%Y-%m-%d') - active_iterations = [] - for iteration in iterations: - start_date = iteration['start_date'] - due_date = iteration['due_date'] - if start_date and due_date and start_date <= today and due_date >= today: - active_iterations.append(iteration) - active_iterations.sort(key=lambda x: x['due_date']) - return active_iterations[0] - -def getAuthorizedUser(): - output = subprocess.check_output(["glab", "api", "/user"]) - return json.loads(output) - -def list_epics(): - cmd = f'glab api /groups/{GROUP_ID}/epics?per_page=1000&state=opened' - result = subprocess.run(cmd.split(), stdout=subprocess.PIPE) - return json.loads(result.stdout) - -def select_epic(epics): - epics = [t['title'] for t in epics] - search_query = inquirer.prompt([ - inquirer.Text('search_query', message='Search epic:'), - ])['search_query'] - - # Filter choices based on search query - filtered_epics = [c for c in epics if search_query.lower() in c.lower()] - questions = [ - inquirer.List('epics', - message="Select epic:", - choices=filtered_epics, - ), - ] - answer = inquirer.prompt(questions) - return answer['epics'] - -def getSelectedEpic(epic, epics): - return next((t for t in epics if t['title'] == epic), None) - -def get_epic(): - epics = list_epics() - return getSelectedEpic(select_epic(epics), epics) - -def create_branch(project_id, issue): - issueId = str(issue['iid']) - title = re.sub('\\s+', '-', issue['title']).lower() - title = issueId + '-' + title.replace(':','').replace('(',' ').replace(')', '').replace(' ','-') - branch_output = subprocess.check_output(["glab", "api", f"/projects/{str(project_id)}/repository/branches", "-f", f'branch={title}', "-f", f'ref={MAIN_BRANCH}', "-f", f'issue_iid={issueId}']) - return json.loads(branch_output.decode()) - -def create_merge_request(project_id, branch, issue, labels, milestoneId): - issueId = str(issue['iid']) - branch = branch['name'] - title = issue['title'] - assignee_id = getAuthorizedUser()['id'] - labels = ",".join(labels) if type(labels) == list else labels - merge_request_command = [ - "glab", "api", - f"/projects/{str(project_id)}/merge_requests", - "-f", f'title={title}', - "-f", f'description="Closes #{issueId}"', - "-f", f'source_branch={branch}', - "-f", f'target_branch={MAIN_BRANCH}', - "-f", f'issue_iid={issueId}', - "-f", f'assignee_ids={assignee_id}' - ] - - if SQUASH_COMMITS: - merge_request_command.append("-f") - merge_request_command.append("squash=true") - - if DELETE_BRANCH: - merge_request_command.append("-f") - merge_request_command.append("remove_source_branch=true") - - if labels: - merge_request_command.append("-f") - merge_request_command.append(f'labels={labels}') - - if milestoneId: - merge_request_command.append("-f") - merge_request_command.append(f'milestone_id={str(milestoneId)}') - - mr_output = subprocess.check_output(merge_request_command) - return json.loads(mr_output.decode()) - -def startIssueCreation(project_id, title, milestone, epic, iteration, selectedSettings, onlyIssue): - # Prompt for estimated time - estimated_time = inquirer.prompt([ - inquirer.Text('estimated_time', - message='Estimated time to complete this issue (in minutes, optional)', - validate=lambda _, x: x == '' or x.isdigit()) - ])['estimated_time'] - - # If multiple project IDs, split the estimated time - if isinstance(project_id, list): - estimated_time_per_project = int(estimated_time) / len(project_id) if estimated_time else None - else: - estimated_time_per_project = estimated_time - - # Modify settings to include estimated time - if estimated_time_per_project: - selectedSettings = selectedSettings.copy() if selectedSettings else {} - selectedSettings['estimated_time'] = int(estimated_time_per_project) - - createdIssue = createIssue(title, project_id, milestone, epic, iteration, selectedSettings) - print(f"Issue #{createdIssue['iid']}: {createdIssue['title']} created.") - - if onlyIssue: - return createdIssue - - createdBranch = create_branch(project_id, createdIssue) - - createdMergeRequest = create_merge_request(project_id, createdBranch, createdIssue, selectedSettings.get('labels'), milestone) - print(f"Merge request #{createdMergeRequest['iid']}: {createdMergeRequest['title']} created.") - - print("Run:") - print(" git fetch origin") - print(f" git checkout -b '{createdMergeRequest['source_branch']}' 'origin/{createdMergeRequest['source_branch']}'") - print("to switch to new branch.") - - return createdIssue - -def getCurrentBranch(): - return subprocess.check_output(['git', 'rev-parse', '--abbrev-ref', 'HEAD'], text=True).strip() - -def openMergeRequestInBrowser(): - try: - merge_request_id = getActiveMergeRequestId() - remote_url = subprocess.check_output(["git", "config", "--get", "remote.origin.url"], text=True).strip() - url = BASE_URL + '/' + remote_url.split(':')[1][:-4] - webbrowser.open(f"{url}/-/merge_requests/{merge_request_id}") - except subprocess.CalledProcessError: - return None - -def getActiveMergeRequestId(): - branch_to_find = getCurrentBranch() - return find_merge_request_id_by_branch(branch_to_find) - -def find_merge_request_id_by_branch(branch_name): - return getMergeRequestForBranch(branch_name)['iid'] - -def getMergeRequestForBranch(branchName): - project_id = get_project_id() - api_url = f"{API_URL}/projects/{project_id}/merge_requests" - headers = {"Private-Token": GITLAB_TOKEN} - - params = { - "source_branch": branchName, - } - - response = requests.get(api_url, headers=headers, params=params) - if response.status_code == 200: - merge_requests = response.json() - for mr in merge_requests: - if mr["source_branch"] == branchName: - return mr - else: - print(f"Failed to fetch Merge Requests: {response.status_code} - {response.text}") - return None - -def chooseReviewersManually(): - """Prompt the user to select reviewers manually from the available list, showing names.""" - # Fetch user details for each reviewer ID - reviewer_choices = [] - for reviewer_id in REVIEWERS: - api_url = f"{API_URL}/users/{reviewer_id}" - headers = {"Private-Token": GITLAB_TOKEN} - try: - response = requests.get(api_url, headers=headers) - if response.status_code == 200: - user = response.json() - display_name = f"{user.get('name')} ({user.get('username')})" - reviewer_choices.append((display_name, reviewer_id)) - else: - reviewer_choices.append((str(reviewer_id), reviewer_id)) - except Exception: - reviewer_choices.append((str(reviewer_id), reviewer_id)) - - questions = [ - inquirer.Checkbox( - "selected_reviewers", - message="Select reviewers", - choices=[(name, str(rid)) for name, rid in reviewer_choices], - ) - ] - answers = inquirer.prompt(questions) - if answers and "selected_reviewers" in answers: - return [int(r) for r in answers["selected_reviewers"]] - else: - return [] - -def addReviewersToMergeRequest(reviewers=None): - project_id = get_project_id() - mr_id = getActiveMergeRequestId() - api_url = f"{API_URL}/projects/{project_id}/merge_requests/{mr_id}" - headers = {"Private-Token": GITLAB_TOKEN} - - data = { - "reviewer_ids": reviewers if reviewers is not None else REVIEWERS - } - - requests.put(api_url, headers=headers, json=data) - -def setMergeRequestToAutoMerge(): - project_id = get_project_id() - mr_id = getActiveMergeRequestId() - api_url = f"{API_URL}/projects/{project_id}/merge_requests/{mr_id}/merge" - headers = {"Private-Token": GITLAB_TOKEN} - - data = { - "id": project_id, - "merge_request_iid": mr_id, - "should_remove_source_branch": True, - "merge_when_pipeline_succeeds": True, - "auto_merge_strategy": "merge_when_pipeline_succeeds", - } - - requests.put(api_url, headers=headers, json=data) - -def getMainBranch(): - command = "git symbolic-ref refs/remotes/origin/HEAD | sed 's@^refs/remotes/origin/@@'" - output = subprocess.check_output(command, shell=True, stderr=subprocess.STDOUT, universal_newlines=True) - return output.strip() - - -def get_two_weeks_commits(return_output=False): - two_weeks_ago = (datetime.datetime.now() - datetime.timedelta(weeks=2)).strftime('%Y-%m-%d') - - cmd = f'git log --since={two_weeks_ago} --format="%ad - %ae - %s" --date=short | grep -v "Merge branch"' - if (DEVELOPER_EMAIL): - cmd = f'{cmd} | grep {DEVELOPER_EMAIL}' - try: - output = subprocess.check_output(cmd, shell=True, text=True, stderr=subprocess.DEVNULL, universal_newlines=True).strip() - if output: - if return_output: - return output - print(output) - else: - print("No commits found.") - return "" if return_output else None - except subprocess.CalledProcessError as e: - print(f"No commits were found or an error occurred. (exit status {e.returncode})") - return "" if return_output else None - except FileNotFoundError: - print("Git is not installed or not found in PATH.") - return "" if return_output else None - -def generate_smart_summary(): - commits = get_two_weeks_commits(return_output=True) - if not commits: - return - - # Check if OpenAI API key is set - openai_api_key = config.get('DEFAULT', 'OPENAI_API_KEY', fallback=None) - if not openai_api_key: - print("OpenAI API key not set. Skipping AI summary generation.") - return - - # Dynamically import openai only if API key is present - try: - import openai - except ImportError: - print("OpenAI package not installed. Please install it using: pip install openai") - return - - openai.api_key = openai_api_key - - try: - response = openai.chat.completions.create( - model="gpt-3.5-turbo", - messages=[ - {"role": "system", "content": "You are a helpful assistant that summarizes git commits. Provide a concise, well-organized summary of the main changes and themes."}, - {"role": "user", "content": f"Please summarize these git commits in a clear, bulleted format:\n\n{commits}"} - ] - ) - - print("\nšŸ“‹ AI-Generated Summary of Recent Changes:\n") - print(response.choices[0].message.content) - except Exception as e: - print(f"Error generating AI summary: {e}") - -def process_report(text, minutes): - # Get the incident project ID from config - try: - incident_project_id = config.get('DEFAULT', 'incident_project_id') - except (configparser.NoOptionError, configparser.NoSectionError): - print("Error: incident_project_id not found in config.ini") - print("Please add your incident project ID to configs/config.ini under [DEFAULT] section:") - print("incident_project_id = your_project_id_here") - return - - issue_title = f"Incident Report: {text}" - - selected_label = selectLabels('Department') - - incident_settings = { - 'labels': ['incident', 'report'], - 'onlyIssue': True, - 'type': 'incident' - } - - if selected_label: - incident_settings['labels'].append(selected_label) - - try: - # Create the incident issue - iteration = getActiveIteration() - created_issue = createIssue(issue_title, incident_project_id, False, False, iteration, incident_settings) - issue_iid = created_issue['iid'] - - closeOpenedIssue(issue_iid, incident_project_id) - print(f"Incident issue #{issue_iid} created successfully.") - print(f"Title: {issue_title}") - - # Add time tracking to the issue - time_tracking_command = [ - "glab", "api", - f"/projects/{incident_project_id}/issues/{issue_iid}/add_spent_time", - "-f", f"duration={minutes}m" - ] - - try: - subprocess.run(time_tracking_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE) - print(f"Added {minutes} minutes to issue time tracking.") - except subprocess.CalledProcessError as e: - print(f"Error adding time tracking: {str(e)}") - - except Exception as e: - print(f"Error creating incident issue: {str(e)}") - -def closeOpenedIssue(issue_iid, project_id): - issue_command = [ - "glab", "api", - f"/projects/{project_id}/issues/{issue_iid}", - '-X', 'PUT', - '-f', 'state_event=close' - ] - try: - subprocess.run(issue_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE) - except subprocess.CalledProcessError as e: - print(f"Error closing issue: {str(e)}") - -def selectLabels(search, multiple = False): - labels = getLabelsOfGroup(search) - labels = sorted([t['name'] for t in labels]) - - question_type = inquirer.Checkbox if multiple else inquirer.List - questions = [ - question_type( - 'labels', - message="Select one or more department labels:", - choices=labels, - ), - ] - answer = inquirer.prompt(questions) - return answer['labels'] - -def getLabelsOfGroup(search=''): - cmd = f'glab api /groups/{GROUP_ID}/labels?search={search}' - try: - result = subprocess.run(cmd.split(), stdout=subprocess.PIPE, check=True) - return json.loads(result.stdout) - except subprocess.CalledProcessError as e: - print(f"Error getting labels: {str(e)}") - return [] - -def getCurrentIssueId(): - mr = getMergeRequestForBranch(getCurrentBranch()) - return mr['description'].replace('"','').replace('#','').split()[1] - -def track_issue_time(): - # Get the current merge request - try: - project_id = get_project_id() - issue_id = getCurrentIssueId() - except Exception as e: - print(f"Error getting issue details: {str(e)}") - return - - # Prompt for actual time spent - spent_time = inquirer.prompt([ - inquirer.Text('spent_time', - message='How many minutes did you actually spend on this issue?', - validate=lambda _, x: x.isdigit()) - ])['spent_time'] - - # Add spent time to the issue description - time_tracking_command = [ - "glab", "api", - f"/projects/{project_id}/issues/{issue_id}/notes", - "-f", f"body=/spend {spent_time}m" - ] - - try: - subprocess.run(time_tracking_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True) - print(f"Added {spent_time} minutes to issue {issue_id} time tracking.") - except subprocess.CalledProcessError as e: - print(f"Error adding time tracking: {str(e)}") - except Exception as e: - print(f"Error tracking issue time: {str(e)}") - -def get_last_production_deploy(): - try: - project_id = get_project_id() - api_url = f"{API_URL}/projects/{project_id}/pipelines" - headers = {"Private-Token": GITLAB_TOKEN} - - # Set up parameters for the pipeline search - params = { - "per_page": 50, - "order_by": "updated_at", - "sort": "desc" - } - - # Add ref filter if specified in config - if MAIN_BRANCH: - params["ref"] = MAIN_BRANCH - else: - # Use main branch if no specific ref is configured - try: - main_branch = getMainBranch() - params["ref"] = main_branch - except: - # Fallback to common main branch names - params["ref"] = "main" - - response = requests.get(api_url, headers=headers, params=params) - - if response.status_code != 200: - print(f"Failed to fetch pipelines: {response.status_code} - {response.text}") - return - - pipelines = response.json() - production_pipeline = None - - # Look for production pipeline by name pattern - for pipeline in pipelines: - # Get pipeline details to check jobs - pipeline_detail_url = f"{API_URL}/projects/{project_id}/pipelines/{pipeline['id']}/jobs" - detail_response = requests.get(pipeline_detail_url, headers=headers) - - if detail_response.status_code == 200: - jobs = detail_response.json() - - # Check if this pipeline contains production deployment - for job in jobs: - job_name = job.get('name', '') - stage = job.get('stage', '') - job_status = job.get('status', '').lower() - - # Only consider successful jobs - if job_status != 'success': - continue - - # Check project-specific mapping first - project_mapping = PRODUCTION_MAPPINGS.get(str(project_id)) - if project_mapping: - expected_stage = project_mapping.get('stage', '').lower() - expected_job = project_mapping.get('job', '').lower() - - if (stage.lower() == expected_stage or - (expected_job and job_name.lower() == expected_job)): - production_pipeline = { - 'pipeline': pipeline, - 'production_job': job - } - break - else: - print('Didn\'t find deployment pipeline') - - if production_pipeline: - break - - if not production_pipeline: - print(f"No production deployment found matching pattern") - return - - # Display the results - pipeline = production_pipeline['pipeline'] - job = production_pipeline['production_job'] - - print(f"šŸš€ Last Production Deployment:") - print(f" Pipeline: #{pipeline['id']} - {pipeline['status']}") - print(f" Job: {job['name']} ({job['status']})") - print(f" Branch/Tag: {pipeline['ref']}") - print(f" Started: {job.get('started_at', 'N/A')}") - print(f" Finished: {job.get('finished_at', 'N/A')}") - print(f" Duration: {job.get('duration', 'N/A')} seconds" if job.get('duration') else " Duration: N/A") - print(f" Commit: {pipeline['sha'][:8]}") - print(f" URL: {pipeline['web_url']}") - - # Show time since deployment - if job.get('finished_at'): - try: - finished_time = datetime.datetime.fromisoformat(job['finished_at'].replace('Z', '+00:00')) - time_diff = datetime.datetime.now(datetime.timezone.utc) - finished_time - - if time_diff.days > 0: - print(f" ā° {time_diff.days} days ago") - elif time_diff.seconds > 3600: - hours = time_diff.seconds // 3600 - print(f" ā° {hours} hours ago") - else: - minutes = time_diff.seconds // 60 - print(f" ā° {minutes} minutes ago") - except: - pass - - except Exception as e: - print(f"Error fetching last production deploy: {str(e)}") - -def main(): - global MAIN_BRANCH - - parser = argparse.ArgumentParser("Argument description of Git happens") - parser.add_argument("title", nargs="+", help="Title of issue") - parser.add_argument(f"--project_id", type=str, help="Id or URL-encoded path of project") - parser.add_argument("-m", "--milestone", action='store_true', help="Add this flag, if you want to manually select milestone") - parser.add_argument("--no_epic", action="store_true", help="Add this flag if you don't want to pick epic") - parser.add_argument("--no_milestone", action="store_true", help="Add this flag if you don't want to pick milestone") - parser.add_argument("--no_iteration", action="store_true", help="Add this flag if you don't want to pick iteration") - parser.add_argument("--only_issue", action="store_true", help="Add this flag if you don't want to create merge request and branch alongside issue") - parser.add_argument("-am", "--auto_merge", action="store_true", help="Add this flag to review if you want to set merge request to auto merge when pipeline succeeds") - parser.add_argument("--select", action="store_true", help="Manually select reviewers for merge request (interactive)") - - # If no arguments passed, show help - if len(sys.argv) <= 1: - parser.print_help() - exit(1) - - args = parser.parse_args() - if args.title[0] == 'report': - parts = args.title - if len(parts) != 3: - print("Invalid report format. Use: gh report \"text\" minutes") - return - - text = parts[1] - try: - minutes = int(parts[2].strip()) - process_report(text, minutes) - except ValueError: - print("Invalid minutes. Please provide a valid number.") - return - - # So it takes all text until first known argument - title = " ".join(args.title) - - if title == 'open': - openMergeRequestInBrowser() - return - elif title == 'review': - track_issue_time() - reviewers = None - if getattr(args, "select", False): - reviewers = chooseReviewersManually() - addReviewersToMergeRequest(reviewers=reviewers) - - # Run AI code review and post to MR - try: - from ai_code_review import run_review_for_mr - project_id = get_project_id() - mr_id = getActiveMergeRequestId() - run_review_for_mr(project_id, mr_id, GITLAB_TOKEN, API_URL) - except Exception as e: - print(f"AI review skipped: {e}") - - if(args.auto_merge): - setMergeRequestToAutoMerge() - return - elif title == 'summary': - get_two_weeks_commits() - return - elif title == 'summaryAI': - generate_smart_summary() - return - elif title == 'last deploy': - get_last_production_deploy() - return - elif title == 'ai review': - from ai_code_review import run_review - run_review() - return - - # Get settings for issue from template - selectedSettings = getIssueSettings(select_template()) - - # If template is False, ask for each settings - if not len(selectedSettings): - print('Custom selection of issue settings is not supported yet') - pass - - if args.project_id and selectedSettings.get('projectIds'): - print('NOTE: Overwriting project id from argument...') - - project_id = selectedSettings.get('projectIds') or args.project_id or get_project_id() - - milestone = False - if not args.no_milestone: - milestone = get_milestone(args.milestone)['id'] - - iteration = False - if not args.no_iteration: - # manual pick iteration - iteration = get_iteration(True) - - epic = False - if not args.no_epic: - epic = get_epic() - - MAIN_BRANCH = getMainBranch() - - onlyIssue = selectedSettings.get('onlyIssue') or args.only_issue - - if type(project_id) == list: - for id in project_id: - startIssueCreation(id, title, milestone, epic, iteration, selectedSettings, onlyIssue) - else: - startIssueCreation(project_id, title, milestone, epic, iteration, selectedSettings, onlyIssue) - -if __name__ == '__main__': - main() \ No newline at end of file +if __name__ == "__main__": + main() diff --git a/githappens/__init__.py b/githappens/__init__.py new file mode 100644 index 0000000..87397df --- /dev/null +++ b/githappens/__init__.py @@ -0,0 +1 @@ +"""GitHappens CLI package.""" diff --git a/githappens/commands/__init__.py b/githappens/commands/__init__.py new file mode 100644 index 0000000..92d63c6 --- /dev/null +++ b/githappens/commands/__init__.py @@ -0,0 +1 @@ +"""Command workflow modules for GitHappens.""" diff --git a/githappens/commands/create_issue.py b/githappens/commands/create_issue.py new file mode 100644 index 0000000..d29adcf --- /dev/null +++ b/githappens/commands/create_issue.py @@ -0,0 +1,161 @@ +import datetime + +from .. import config, git_utils, gitlab_api, interactive + + +def get_project_id(): + project_link = git_utils.get_project_link_from_current_dir() + if project_link == -1: + return interactive.enter_project_id() + + all_projects = gitlab_api.get_all_projects(project_link) + if all_projects is None: + return None + matching_id = None + for project in all_projects: + if project.get("ssh_url_to_repo") == project_link: + matching_id = project.get("id") + break + return matching_id + + +def get_selected_milestone(milestone, milestones): + return next((item for item in milestones if item["title"] == milestone), None) + + +def get_milestone(manual): + if manual: + milestones = gitlab_api.list_milestones() + return get_selected_milestone(interactive.select_milestone(milestones), milestones) + return gitlab_api.list_milestones(True) + + +def get_selected_iteration(iteration, iterations): + return next( + ( + item + for item in iterations + if item["start_date"] + " - " + item["due_date"] == iteration + ), + None, + ) + + +def get_active_iteration(): + iterations = gitlab_api.list_iterations() + today = datetime.date.today().strftime("%Y-%m-%d") + active_iterations = [] + for iteration in iterations: + start_date = iteration["start_date"] + due_date = iteration["due_date"] + if start_date and due_date and start_date <= today and due_date >= today: + active_iterations.append(iteration) + active_iterations.sort(key=lambda item: item["due_date"]) + if not active_iterations: + return None + return active_iterations[0] + + +def get_iteration(manual): + if manual: + iterations = gitlab_api.list_iterations() + return get_selected_iteration(interactive.select_iteration(iterations), iterations) + return get_active_iteration() + + +def get_selected_epic(epic, epics): + return next((item for item in epics if item["title"] == epic), None) + + +def get_epic(): + epics = gitlab_api.list_epics() + return get_selected_epic(interactive.select_epic(epics), epics) + + +def create_issue(title, project_id, milestone_id, epic, iteration, settings): + if settings: + issue_type = settings.get("type") or "issue" + return gitlab_api.create_issue( + project_id, + title, + settings.get("labels"), + milestone_id, + epic, + iteration, + settings.get("weight"), + settings.get("estimated_time"), + issue_type, + ) + print("No settings in template") + exit(2) + + +def start_issue_creation(project_id, title, milestone, epic, iteration, selected_settings, only_issue, main_branch): + estimated_time = interactive.prompt_estimated_time() + + if isinstance(project_id, list): + estimated_time_per_project = int(estimated_time) / len(project_id) if estimated_time else None + else: + estimated_time_per_project = estimated_time + + if estimated_time_per_project: + selected_settings = selected_settings.copy() if selected_settings else {} + selected_settings["estimated_time"] = int(estimated_time_per_project) + + created_issue = create_issue(title, project_id, milestone, epic, iteration, selected_settings) + print(f"Issue #{created_issue['iid']}: {created_issue['title']} created.") + + if only_issue: + return created_issue + + created_branch = gitlab_api.create_branch(project_id, created_issue, main_branch) + created_merge_request = gitlab_api.create_merge_request( + project_id, + created_branch, + created_issue, + selected_settings.get("labels"), + milestone, + main_branch, + ) + print(f"Merge request #{created_merge_request['iid']}: {created_merge_request['title']} created.") + + print("Run:") + print(" git fetch origin") + print(f" git checkout -b '{created_merge_request['source_branch']}' 'origin/{created_merge_request['source_branch']}'") + print("to switch to new branch.") + + return created_issue + + +def create_issue_flow(title, args, selected_settings): + if args.project_id and selected_settings.get("projectIds"): + print("NOTE: Overwriting project id from argument...") + + project_id = selected_settings.get("projectIds") or args.project_id or get_project_id() + + milestone = False + if not args.no_milestone: + selected_milestone = get_milestone(args.milestone) + milestone = selected_milestone["id"] if selected_milestone else False + + iteration = False + if not args.no_iteration: + iteration = get_iteration(True) + + epic = False + if not args.no_epic: + epic = get_epic() + + main_branch = git_utils.get_main_branch() + only_issue = selected_settings.get("onlyIssue") or args.only_issue + + if type(project_id) == list: + for project in project_id: + start_issue_creation(project, title, milestone, epic, iteration, selected_settings, only_issue, main_branch) + else: + start_issue_creation(project_id, title, milestone, epic, iteration, selected_settings, only_issue, main_branch) + + +def select_labels(search, multiple=False): + labels = gitlab_api.list_labels(search) + return interactive.select_labels(labels, multiple) diff --git a/githappens/commands/deploy.py b/githappens/commands/deploy.py new file mode 100644 index 0000000..75b0f13 --- /dev/null +++ b/githappens/commands/deploy.py @@ -0,0 +1,91 @@ +import datetime + +import requests + +from .. import config, git_utils, templates +from .create_issue import get_project_id + + +def get_last_production_deploy(): + try: + project_id = get_project_id() + api_url = f"{config.API_URL}/projects/{project_id}/pipelines" + headers = {"Private-Token": config.GITLAB_TOKEN} + params = {"per_page": 50, "order_by": "updated_at", "sort": "desc"} + + if config.MAIN_BRANCH: + params["ref"] = config.MAIN_BRANCH + else: + try: + params["ref"] = git_utils.get_main_branch() + except Exception: + params["ref"] = "main" + + response = requests.get(api_url, headers=headers, params=params) + if response.status_code != 200: + print(f"Failed to fetch pipelines: {response.status_code} - {response.text}") + return + + production_pipeline = None + for pipeline in response.json(): + detail_response = requests.get( + f"{config.API_URL}/projects/{project_id}/pipelines/{pipeline['id']}/jobs", + headers=headers, + ) + if detail_response.status_code == 200: + for job in detail_response.json(): + job_name = job.get("name", "") + stage = job.get("stage", "") + job_status = job.get("status", "").lower() + + if job_status != "success": + continue + + project_mapping = templates.get_production_mappings().get(str(project_id)) + if project_mapping: + expected_stage = project_mapping.get("stage", "").lower() + expected_job = project_mapping.get("job", "").lower() + if stage.lower() == expected_stage or ( + expected_job and job_name.lower() == expected_job + ): + production_pipeline = {"pipeline": pipeline, "production_job": job} + break + else: + print("Didn't find deployment pipeline") + + if production_pipeline: + break + + if not production_pipeline: + print("No production deployment found matching pattern") + return + + pipeline = production_pipeline["pipeline"] + job = production_pipeline["production_job"] + + print("šŸš€ Last Production Deployment:") + print(f" Pipeline: #{pipeline['id']} - {pipeline['status']}") + print(f" Job: {job['name']} ({job['status']})") + print(f" Branch/Tag: {pipeline['ref']}") + print(f" Started: {job.get('started_at', 'N/A')}") + print(f" Finished: {job.get('finished_at', 'N/A')}") + print(f" Duration: {job.get('duration', 'N/A')} seconds" if job.get("duration") else " Duration: N/A") + print(f" Commit: {pipeline['sha'][:8]}") + print(f" URL: {pipeline['web_url']}") + + if job.get("finished_at"): + try: + finished_time = datetime.datetime.fromisoformat( + job["finished_at"].replace("Z", "+00:00") + ) + time_diff = datetime.datetime.now(datetime.timezone.utc) - finished_time + if time_diff.days > 0: + print(f" ā° {time_diff.days} days ago") + elif time_diff.seconds > 3600: + print(f" ā° {time_diff.seconds // 3600} hours ago") + else: + print(f" ā° {time_diff.seconds // 60} minutes ago") + except Exception: + pass + except Exception as error: + print(f"Error fetching last production deploy: {str(error)}") diff --git a/githappens/commands/open_mr.py b/githappens/commands/open_mr.py new file mode 100644 index 0000000..354211c --- /dev/null +++ b/githappens/commands/open_mr.py @@ -0,0 +1,54 @@ +import subprocess +from urllib.parse import urlparse +import webbrowser + +from .. import config, git_utils, gitlab_api +from .create_issue import get_project_id + + +def get_active_merge_request_id(): + branch_to_find = git_utils.get_current_branch() + return find_merge_request_id_by_branch(branch_to_find) + + +def find_merge_request_id_by_branch(branch_name): + merge_request = get_merge_request_for_branch(branch_name) + if not merge_request: + print(f"No active merge request found for branch {branch_name}.") + return None + return merge_request["iid"] + + +def get_merge_request_for_branch(branch_name): + project_id = get_project_id() + return gitlab_api.get_merge_request_for_branch(project_id, branch_name) + + +def open_merge_request_in_browser(): + try: + merge_request_id = get_active_merge_request_id() + if not merge_request_id: + return None + remote_url = subprocess.check_output( + ["git", "config", "--get", "remote.origin.url"], text=True + ).strip() + project_path = project_path_from_remote(remote_url) + if not project_path: + print(f"Could not parse GitLab remote URL: {remote_url}") + return None + url = config.BASE_URL + "/" + project_path + webbrowser.open(f"{url}/-/merge_requests/{merge_request_id}") + except subprocess.CalledProcessError: + return None + + +def project_path_from_remote(remote_url): + if remote_url.startswith("git@"): + _, path = remote_url.split(":", 1) + return path.removesuffix(".git") + + parsed = urlparse(remote_url) + if parsed.scheme in ("http", "https") and parsed.netloc: + return parsed.path.strip("/").removesuffix(".git") + + return None diff --git a/githappens/commands/report.py b/githappens/commands/report.py new file mode 100644 index 0000000..a421d29 --- /dev/null +++ b/githappens/commands/report.py @@ -0,0 +1,57 @@ +import configparser +import subprocess + +from .. import config, gitlab_api +from .create_issue import create_issue, get_active_iteration, select_labels + + +def close_opened_issue(issue_iid, project_id): + gitlab_api.close_opened_issue(issue_iid, project_id) + + +def process_report(text, minutes): + try: + incident_project_id = config.config.get("DEFAULT", "incident_project_id") + except (configparser.NoOptionError, configparser.NoSectionError): + print("Error: incident_project_id not found in config.ini") + print("Please add your incident project ID to configs/config.ini under [DEFAULT] section:") + print("incident_project_id = your_project_id_here") + return + + issue_title = f"Incident Report: {text}" + selected_label = select_labels("Department") + incident_settings = { + "labels": ["incident", "report"], + "onlyIssue": True, + "type": "incident", + } + + if selected_label: + incident_settings["labels"].append(selected_label) + + try: + iteration = get_active_iteration() + created_issue = create_issue( + issue_title, incident_project_id, False, False, iteration, incident_settings + ) + issue_iid = created_issue["iid"] + + close_opened_issue(issue_iid, incident_project_id) + print(f"Incident issue #{issue_iid} created successfully.") + print(f"Title: {issue_title}") + + time_tracking_command = [ + "glab", + "api", + f"/projects/{incident_project_id}/issues/{issue_iid}/add_spent_time", + "-f", + f"duration={minutes}m", + ] + + try: + subprocess.run(time_tracking_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True) + print(f"Added {minutes} minutes to issue time tracking.") + except subprocess.CalledProcessError as error: + print(f"Error adding time tracking: {str(error)}") + except Exception as error: + print(f"Error creating incident issue: {str(error)}") diff --git a/githappens/commands/review.py b/githappens/commands/review.py new file mode 100644 index 0000000..1e3322d --- /dev/null +++ b/githappens/commands/review.py @@ -0,0 +1,75 @@ +import subprocess +import re + +from .. import gitlab_api, git_utils, interactive, templates +from .create_issue import get_project_id +from .open_mr import get_active_merge_request_id, get_merge_request_for_branch + + +def choose_reviewers_manually(): + return interactive.choose_reviewers_manually(templates.get_reviewers(), gitlab_api.get_user) + + +def add_reviewers_to_merge_request(reviewers=None): + project_id = get_project_id() + mr_id = get_active_merge_request_id() + gitlab_api.add_reviewers_to_merge_request( + project_id, + mr_id, + reviewers if reviewers is not None else templates.get_reviewers(), + ) + + +def set_merge_request_to_auto_merge(): + project_id = get_project_id() + mr_id = get_active_merge_request_id() + gitlab_api.set_merge_request_to_auto_merge(project_id, mr_id) + + +def get_current_issue_id(): + mr = get_merge_request_for_branch(git_utils.get_current_branch()) + if not mr: + raise ValueError("No merge request found for the current branch.") + match = re.search(r"Closes\s+#(\d+)", mr.get("description", "").replace('"', "")) + if not match: + raise ValueError("Could not find an issue reference in the merge request description.") + return match.group(1) + + +def track_issue_time(): + try: + project_id = get_project_id() + issue_id = get_current_issue_id() + except Exception as error: + print(f"Error getting issue details: {str(error)}") + return + + spent_time = interactive.prompt_spent_time() + + try: + gitlab_api.add_issue_spent_time(project_id, issue_id, spent_time) + print(f"Added {spent_time} minutes to issue {issue_id} time tracking.") + except subprocess.CalledProcessError as error: + print(f"Error adding time tracking: {str(error)}") + except Exception as error: + print(f"Error tracking issue time: {str(error)}") + + +def review_flow(auto_merge=False, select=False): + track_issue_time() + reviewers = choose_reviewers_manually() if select else None + add_reviewers_to_merge_request(reviewers=reviewers) + + try: + from ai_code_review import run_review_for_mr + + project_id = get_project_id() + mr_id = get_active_merge_request_id() + from .. import config + + run_review_for_mr(project_id, mr_id, config.GITLAB_TOKEN, config.API_URL) + except Exception as error: + print(f"AI review skipped: {error}") + + if auto_merge: + set_merge_request_to_auto_merge() diff --git a/githappens/config.py b/githappens/config.py new file mode 100644 index 0000000..d626b75 --- /dev/null +++ b/githappens/config.py @@ -0,0 +1,40 @@ +import configparser +import os + + +ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +CONFIG_DIR = os.path.join(ROOT_DIR, "configs") +CONFIG_PATH = os.path.join(CONFIG_DIR, "config.ini") +TEMPLATES_PATH = os.path.join(CONFIG_DIR, "templates.json") +MAIN_BRANCH = "master" + + +def load_config(path=CONFIG_PATH): + parser = configparser.ConfigParser() + parser.read(path) + return parser + + +config = load_config() + + +def get_config_value(name, fallback=""): + return config.get("DEFAULT", name, fallback=fallback) + + +def get_bool_config(name, fallback=False): + value = get_config_value(name, str(fallback)) + return str(value).lower() == "true" + + +BASE_URL = get_config_value("base_url", "https://gitlab.com") +API_URL = BASE_URL + "/api/v4" +GROUP_ID = get_config_value("group_id") +CUSTOM_TEMPLATE = get_config_value("custom_template", "Custom") +GITLAB_TOKEN = get_config_value("GITLAB_TOKEN").strip("\"'") +DELETE_BRANCH = get_bool_config("delete_branch_after_merge", True) +DEVELOPER_EMAIL = get_config_value("developer_email", None) +SQUASH_COMMITS = get_bool_config("squash_commits", True) +PRODUCTION_PIPELINE_NAME = get_config_value("production_pipeline_name", "deploy") +PRODUCTION_JOB_NAME = get_config_value("production_job_name", None) +PRODUCTION_REF = get_config_value("production_ref", None) diff --git a/githappens/git_utils.py b/githappens/git_utils.py new file mode 100644 index 0000000..74e0479 --- /dev/null +++ b/githappens/git_utils.py @@ -0,0 +1,72 @@ +import datetime +import subprocess + +from . import config + + +def get_project_link_from_current_dir(): + try: + result = subprocess.run( + ["git", "remote", "get-url", "origin"], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE, + ) + if result.returncode == 0: + return result.stdout.decode("utf-8").strip() + return -1 + except FileNotFoundError: + return -1 + + +def get_current_branch(): + return subprocess.check_output( + ["git", "rev-parse", "--abbrev-ref", "HEAD"], text=True + ).strip() + + +def get_main_branch(): + command = "git symbolic-ref refs/remotes/origin/HEAD | sed 's@^refs/remotes/origin/@@'" + output = subprocess.check_output( + command, shell=True, stderr=subprocess.STDOUT, universal_newlines=True + ) + return output.strip() + + +def get_two_weeks_commits(return_output=False): + two_weeks_ago = ( + datetime.datetime.now() - datetime.timedelta(weeks=2) + ).strftime("%Y-%m-%d") + + try: + output = subprocess.check_output( + [ + "git", + "log", + f"--since={two_weeks_ago}", + "--format=%ad - %ae - %s", + "--date=short", + ], + text=True, + stderr=subprocess.DEVNULL, + universal_newlines=True, + ) + lines = [ + line + for line in output.splitlines() + if "Merge branch" not in line + and (not config.DEVELOPER_EMAIL or config.DEVELOPER_EMAIL in line) + ] + output = "\n".join(lines).strip() + if output: + if return_output: + return output + print(output) + else: + print("No commits found.") + return "" if return_output else None + except subprocess.CalledProcessError as error: + print(f"No commits were found or an error occurred. (exit status {error.returncode})") + return "" if return_output else None + except FileNotFoundError: + print("Git is not installed or not found in PATH.") + return "" if return_output else None diff --git a/githappens/gitlab_api.py b/githappens/gitlab_api.py new file mode 100644 index 0000000..c6f2bb8 --- /dev/null +++ b/githappens/gitlab_api.py @@ -0,0 +1,253 @@ +import datetime +import json +import re +import subprocess + +import requests + +from . import config + + +def api_headers(): + return {"Private-Token": config.GITLAB_TOKEN} + + +def get_authorized_user(): + output = subprocess.check_output(["glab", "api", "/user"]) + return json.loads(output) + + +def get_user(user_id): + response = requests.get(f"{config.API_URL}/users/{user_id}", headers=api_headers()) + if response.status_code == 200: + return response.json() + return None + + +def get_all_projects(project_link): + url = ( + config.API_URL + + "/projects?membership=true&search=" + + project_link.split("/")[-1].split(".")[0] + ) + response = requests.get(url, headers=api_headers()) + + if response.status_code == 200: + return response.json() + if response.status_code == 401: + print("Error: Unauthorized (401). Your GitLab token is probably expired, invalid, or missing required permissions.") + print("Please generate a new token and update your configs/config.ini.") + exit(1) + print(f"Request failed with status code {response.status_code}") + return None + + +def list_milestones(current=False): + result = subprocess.run( + ["glab", "api", f"/groups/{config.GROUP_ID}/milestones?state=active"], + stdout=subprocess.PIPE, + ) + milestones = json.loads(result.stdout) + if current: + today = datetime.date.today().strftime("%Y-%m-%d") + active_milestones = [] + for milestone in milestones: + start_date = milestone["start_date"] + due_date = milestone["due_date"] + if start_date and due_date and start_date <= today and due_date >= today: + active_milestones.append(milestone) + active_milestones.sort(key=lambda item: item["due_date"]) + if not active_milestones: + return None + return active_milestones[0] + return milestones + + +def list_iterations(): + result = subprocess.run( + ["glab", "api", f"/groups/{config.GROUP_ID}/iterations?state=opened"], + stdout=subprocess.PIPE, + ) + return json.loads(result.stdout) + + +def list_epics(): + result = subprocess.run( + ["glab", "api", f"/groups/{config.GROUP_ID}/epics?per_page=1000&state=opened"], + stdout=subprocess.PIPE, + ) + return json.loads(result.stdout) + + +def list_labels(search=""): + try: + result = subprocess.run( + ["glab", "api", f"/groups/{config.GROUP_ID}/labels?search={search}"], + stdout=subprocess.PIPE, + check=True, + ) + return json.loads(result.stdout) + except subprocess.CalledProcessError as error: + print(f"Error getting labels: {str(error)}") + return [] + + +def create_issue(project_id, title, labels, milestone_id, epic, iteration, weight, estimated_time, issue_type="issue"): + labels = ",".join(labels) if type(labels) == list else labels + assignee_id = get_authorized_user()["id"] + issue_command = [ + "glab", + "api", + f"/projects/{str(project_id)}/issues", + "-f", + f"title={title}", + "-f", + f"assignee_ids={assignee_id}", + "-f", + f"issue_type={issue_type}", + ] + if labels: + issue_command.extend(["-f", f"labels={labels}"]) + if weight: + issue_command.extend(["-f", f"weight={str(weight)}"]) + if milestone_id: + issue_command.extend(["-f", f"milestone_id={str(milestone_id)}"]) + if epic: + issue_command.extend(["-f", f"epic_id={str(epic['id'])}"]) + + description = "" + if iteration: + description += f"/iteration *iteration:{str(iteration['id'])} " + if estimated_time: + description += f"\n/estimate {estimated_time}m " + + issue_command.extend(["-f", f"description={description}"]) + issue_output = subprocess.check_output(issue_command) + return json.loads(issue_output.decode()) + + +def create_branch(project_id, issue, main_branch): + issue_id = str(issue["iid"]) + title = re.sub("\\s+", "-", issue["title"]).lower() + title = issue_id + "-" + title.replace(":", "").replace("(", " ").replace(")", "").replace(" ", "-") + branch_output = subprocess.check_output( + [ + "glab", + "api", + f"/projects/{str(project_id)}/repository/branches", + "-f", + f"branch={title}", + "-f", + f"ref={main_branch}", + "-f", + f"issue_iid={issue_id}", + ] + ) + return json.loads(branch_output.decode()) + + +def create_merge_request(project_id, branch, issue, labels, milestone_id, main_branch): + issue_id = str(issue["iid"]) + branch_name = branch["name"] + assignee_id = get_authorized_user()["id"] + labels = ",".join(labels) if type(labels) == list else labels + merge_request_command = [ + "glab", + "api", + f"/projects/{str(project_id)}/merge_requests", + "-f", + f"title={issue['title']}", + "-f", + f'description="Closes #{issue_id}"', + "-f", + f"source_branch={branch_name}", + "-f", + f"target_branch={main_branch}", + "-f", + f"issue_iid={issue_id}", + "-f", + f"assignee_ids={assignee_id}", + ] + if config.SQUASH_COMMITS: + merge_request_command.extend(["-f", "squash=true"]) + if config.DELETE_BRANCH: + merge_request_command.extend(["-f", "remove_source_branch=true"]) + if labels: + merge_request_command.extend(["-f", f"labels={labels}"]) + if milestone_id: + merge_request_command.extend(["-f", f"milestone_id={str(milestone_id)}"]) + + mr_output = subprocess.check_output(merge_request_command) + return json.loads(mr_output.decode()) + + +def get_merge_request_for_branch(project_id, branch_name): + response = requests.get( + f"{config.API_URL}/projects/{project_id}/merge_requests", + headers=api_headers(), + params={"source_branch": branch_name}, + ) + if response.status_code == 200: + for merge_request in response.json(): + if merge_request["source_branch"] == branch_name: + return merge_request + else: + print(f"Failed to fetch Merge Requests: {response.status_code} - {response.text}") + return None + + +def add_reviewers_to_merge_request(project_id, mr_id, reviewers): + requests.put( + f"{config.API_URL}/projects/{project_id}/merge_requests/{mr_id}", + headers=api_headers(), + json={"reviewer_ids": reviewers}, + ) + + +def set_merge_request_to_auto_merge(project_id, mr_id): + requests.put( + f"{config.API_URL}/projects/{project_id}/merge_requests/{mr_id}/merge", + headers=api_headers(), + json={ + "id": project_id, + "merge_request_iid": mr_id, + "should_remove_source_branch": True, + "merge_when_pipeline_succeeds": True, + "auto_merge_strategy": "merge_when_pipeline_succeeds", + }, + ) + + +def add_issue_spent_time(project_id, issue_id, spent_time): + subprocess.run( + [ + "glab", + "api", + f"/projects/{project_id}/issues/{issue_id}/notes", + "-f", + f"body=/spend {spent_time}m", + ], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE, + check=True, + ) + + +def close_opened_issue(issue_iid, project_id): + try: + subprocess.run( + [ + "glab", + "api", + f"/projects/{project_id}/issues/{issue_iid}", + "-X", + "PUT", + "-f", + "state_event=close", + ], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE, + check=True, + ) + except subprocess.CalledProcessError as error: + print(f"Error closing issue: {str(error)}") diff --git a/githappens/interactive.py b/githappens/interactive.py new file mode 100644 index 0000000..e8cc375 --- /dev/null +++ b/githappens/interactive.py @@ -0,0 +1,154 @@ +from . import config +from . import templates as template_config + + +def get_inquirer(): + import inquirer + + return inquirer + + +def enter_project_id(): + while True: + project_id = input("Please enter the ID of your GitLab project: ") + if project_id: + return project_id + exit("Invalid project ID.") + + +def select_template(): + inquirer = get_inquirer() + template_names = [template["name"] for template in template_config.get_templates()] + template_names.append(config.CUSTOM_TEMPLATE) + answer = inquirer.prompt( + [ + inquirer.List( + "template", + message="Select template:", + choices=template_names, + ), + ] + ) + return answer["template"] + + +def select_milestone(milestones): + inquirer = get_inquirer() + choices = [milestone["title"] for milestone in milestones] + answer = inquirer.prompt( + [ + inquirer.List( + "milestones", + message="Select milestone:", + choices=choices, + ), + ] + ) + return answer["milestones"] + + +def select_iteration(iterations): + inquirer = get_inquirer() + choices = [ + iteration["start_date"] + " - " + iteration["due_date"] + for iteration in iterations + ] + answer = inquirer.prompt( + [ + inquirer.List( + "iterations", + message="Select iteration:", + choices=choices, + ), + ] + ) + return answer["iterations"] + + +def select_epic(epics): + inquirer = get_inquirer() + names = [epic["title"] for epic in epics] + search_query = inquirer.prompt( + [inquirer.Text("search_query", message="Search epic:")] + )["search_query"] + filtered_epics = [choice for choice in names if search_query.lower() in choice.lower()] + answer = inquirer.prompt( + [ + inquirer.List( + "epics", + message="Select epic:", + choices=filtered_epics, + ), + ] + ) + return answer["epics"] + + +def prompt_estimated_time(): + inquirer = get_inquirer() + return inquirer.prompt( + [ + inquirer.Text( + "estimated_time", + message="Estimated time to complete this issue (in minutes, optional)", + validate=lambda _, value: value == "" or value.isdigit(), + ) + ] + )["estimated_time"] + + +def prompt_spent_time(): + inquirer = get_inquirer() + return inquirer.prompt( + [ + inquirer.Text( + "spent_time", + message="How many minutes did you actually spend on this issue?", + validate=lambda _, value: value.isdigit(), + ) + ] + )["spent_time"] + + +def select_labels(labels, multiple=False): + inquirer = get_inquirer() + choices = sorted([label["name"] for label in labels]) + question_type = inquirer.Checkbox if multiple else inquirer.List + answer = inquirer.prompt( + [ + question_type( + "labels", + message="Select one or more department labels:", + choices=choices, + ), + ] + ) + return answer["labels"] + + +def choose_reviewers_manually(reviewers, fetch_user): + inquirer = get_inquirer() + reviewer_choices = [] + for reviewer_id in reviewers: + try: + user = fetch_user(reviewer_id) + if user: + display_name = f"{user.get('name')} ({user.get('username')})" + reviewer_choices.append((display_name, reviewer_id)) + else: + reviewer_choices.append((str(reviewer_id), reviewer_id)) + except Exception: + reviewer_choices.append((str(reviewer_id), reviewer_id)) + + answers = inquirer.prompt( + [ + inquirer.Checkbox( + "selected_reviewers", + message="Select reviewers", + choices=[(name, str(reviewer_id)) for name, reviewer_id in reviewer_choices], + ) + ] + ) + if answers and "selected_reviewers" in answers: + return [int(reviewer) for reviewer in answers["selected_reviewers"]] + return [] diff --git a/githappens/main.py b/githappens/main.py new file mode 100644 index 0000000..13ded60 --- /dev/null +++ b/githappens/main.py @@ -0,0 +1,121 @@ +import argparse +import sys + +from . import git_utils, interactive, templates +from .commands.create_issue import create_issue_flow +from .commands.deploy import get_last_production_deploy +from .commands.open_mr import open_merge_request_in_browser +from .commands.report import process_report +from .commands.review import review_flow + + +def generate_smart_summary(): + from . import config + + commits = git_utils.get_two_weeks_commits(return_output=True) + if not commits: + return + + openai_api_key = config.config.get("DEFAULT", "OPENAI_API_KEY", fallback=None) + if not openai_api_key: + print("OpenAI API key not set. Skipping AI summary generation.") + return + + try: + import openai + except ImportError: + print("OpenAI package not installed. Please install it using: pip install openai") + return + + openai.api_key = openai_api_key + + try: + response = openai.chat.completions.create( + model="gpt-3.5-turbo", + messages=[ + { + "role": "system", + "content": "You are a helpful assistant that summarizes git commits. Provide a concise, well-organized summary of the main changes and themes.", + }, + { + "role": "user", + "content": f"Please summarize these git commits in a clear, bulleted format:\n\n{commits}", + }, + ], + ) + + print("\nšŸ“‹ AI-Generated Summary of Recent Changes:\n") + print(response.choices[0].message.content) + except Exception as error: + print(f"Error generating AI summary: {error}") + + +def build_parser(): + parser = argparse.ArgumentParser("Argument description of Git happens") + parser.add_argument("title", nargs="+", help="Title of issue") + parser.add_argument("--project_id", type=str, help="Id or URL-encoded path of project") + parser.add_argument("-m", "--milestone", action="store_true", help="Add this flag, if you want to manually select milestone") + parser.add_argument("--no_epic", action="store_true", help="Add this flag if you don't want to pick epic") + parser.add_argument("--no_milestone", action="store_true", help="Add this flag if you don't want to pick milestone") + parser.add_argument("--no_iteration", action="store_true", help="Add this flag if you don't want to pick iteration") + parser.add_argument("--only_issue", action="store_true", help="Add this flag if you don't want to create merge request and branch alongside issue") + parser.add_argument("-am", "--auto_merge", action="store_true", help="Add this flag to review if you want to set merge request to auto merge when pipeline succeeds") + parser.add_argument("--select", action="store_true", help="Manually select reviewers for merge request (interactive)") + return parser + + +def main(argv=None): + argv = sys.argv[1:] if argv is None else argv + parser = build_parser() + + if len(argv) <= 0: + parser.print_help() + exit(1) + + args = parser.parse_args(argv) + if args.title[0] == "report": + parts = args.title + if len(parts) != 3: + print('Invalid report format. Use: gh report "text" minutes') + return + + text = parts[1] + try: + process_report(text, int(parts[2].strip())) + except ValueError: + print("Invalid minutes. Please provide a valid number.") + return + + title = " ".join(args.title) + + if title == "open": + open_merge_request_in_browser() + return + if title == "review": + review_flow(auto_merge=args.auto_merge, select=getattr(args, "select", False)) + return + if title == "summary": + git_utils.get_two_weeks_commits() + return + if title == "summaryAI": + generate_smart_summary() + return + if title == "last deploy": + get_last_production_deploy() + return + if title == "ai review": + from ai_code_review import run_review + + run_review() + return + + selected_settings = templates.get_issue_settings(interactive.select_template()) + + if not len(selected_settings): + print("Custom selection of issue settings is not supported yet") + + create_issue_flow(title, args, selected_settings) + + +if __name__ == "__main__": + main() diff --git a/githappens/templates.py b/githappens/templates.py new file mode 100644 index 0000000..6c7ff01 --- /dev/null +++ b/githappens/templates.py @@ -0,0 +1,31 @@ +import json + +from . import config + + +def load_template_config(path=config.TEMPLATES_PATH): + with open(path, "r") as file: + return json.load(file) + + +def get_template_data(): + return load_template_config() + + +def get_templates(): + return get_template_data()["templates"] + + +def get_reviewers(): + return get_template_data()["reviewers"] + + +def get_production_mappings(): + return get_template_data().get("productionMappings", {}) + + +def get_issue_settings(template_name, templates=None): + if template_name == config.CUSTOM_TEMPLATE: + return {} + templates = templates if templates is not None else get_templates() + return next((template for template in templates if template["name"] == template_name), {}) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..37f3ecc --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1 @@ +"""GitHappens test suite.""" diff --git a/tests/test_config_templates.py b/tests/test_config_templates.py new file mode 100644 index 0000000..066d486 --- /dev/null +++ b/tests/test_config_templates.py @@ -0,0 +1,44 @@ +import json +import tempfile +import unittest + +from githappens import config, templates + + +class ConfigTemplatesTest(unittest.TestCase): + def test_load_config_reads_values(self): + with tempfile.NamedTemporaryFile("w", delete=False) as file: + file.write("[DEFAULT]\nbase_url=https://gitlab.example.com\n") + file_path = file.name + + parser = config.load_config(file_path) + + self.assertEqual(parser.get("DEFAULT", "base_url"), "https://gitlab.example.com") + + def test_load_template_config_reads_templates(self): + payload = {"templates": [{"name": "Bug"}], "reviewers": [1]} + with tempfile.NamedTemporaryFile("w", delete=False) as file: + json.dump(payload, file) + file_path = file.name + + self.assertEqual(templates.load_template_config(file_path), payload) + + def test_get_issue_settings_returns_matching_template(self): + result = templates.get_issue_settings( + "Bug", + templates=[{"name": "Feature"}, {"name": "Bug", "labels": ["Bug"]}], + ) + + self.assertEqual(result, {"name": "Bug", "labels": ["Bug"]}) + + def test_get_issue_settings_returns_empty_for_custom_template(self): + self.assertEqual(templates.get_issue_settings(config.CUSTOM_TEMPLATE), {}) + + def test_get_issue_settings_returns_empty_for_missing_template(self): + result = templates.get_issue_settings("Missing", templates=[{"name": "Bug"}]) + + self.assertEqual(result, {}) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/test_deploy.py b/tests/test_deploy.py new file mode 100644 index 0000000..84fe014 --- /dev/null +++ b/tests/test_deploy.py @@ -0,0 +1,56 @@ +import unittest +from unittest import mock + +from githappens.commands import deploy + + +class DeployCommandTest(unittest.TestCase): + def test_last_production_deploy_uses_project_mapping(self): + pipeline_response = mock.Mock( + status_code=200, + json=mock.Mock( + return_value=[ + { + "id": 77, + "status": "success", + "ref": "master", + "sha": "abcdef123456", + "web_url": "https://gitlab.example/pipelines/77", + } + ] + ), + ) + jobs_response = mock.Mock( + status_code=200, + json=mock.Mock( + return_value=[ + { + "name": "production", + "stage": "deploy", + "status": "success", + "started_at": "2026-05-12T10:00:00Z", + "finished_at": "2026-05-12T10:02:00Z", + "duration": 120, + } + ] + ), + ) + + with mock.patch("githappens.commands.deploy.get_project_id", return_value=11), \ + mock.patch( + "githappens.commands.deploy.templates.get_production_mappings", + return_value={"11": {"stage": "deploy", "job": "production"}}, + ), \ + mock.patch("githappens.commands.deploy.requests.get", side_effect=[pipeline_response, jobs_response]) as get, \ + mock.patch("builtins.print") as print_mock: + deploy.get_last_production_deploy() + + self.assertEqual(get.call_args_list[0].args[0], f"{deploy.config.API_URL}/projects/11/pipelines") + self.assertEqual(get.call_args_list[1].args[0], f"{deploy.config.API_URL}/projects/11/pipelines/77/jobs") + printed = "\n".join(str(call.args[0]) for call in print_mock.call_args_list) + self.assertIn("Last Production Deployment", printed) + self.assertIn("Job: production (success)", printed) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/test_entrypoint.py b/tests/test_entrypoint.py new file mode 100644 index 0000000..d1c0ab6 --- /dev/null +++ b/tests/test_entrypoint.py @@ -0,0 +1,17 @@ +import importlib.util +import pathlib +import unittest + + +class EntrypointTest(unittest.TestCase): + def test_entrypoint_exposes_main(self): + path = pathlib.Path(__file__).resolve().parents[1] / "gitHappens.py" + spec = importlib.util.spec_from_file_location("gitHappens", path) + module = importlib.util.module_from_spec(spec) + spec.loader.exec_module(module) + + self.assertTrue(callable(module.main)) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/test_git_utils.py b/tests/test_git_utils.py new file mode 100644 index 0000000..6c43dbb --- /dev/null +++ b/tests/test_git_utils.py @@ -0,0 +1,25 @@ +import unittest +from unittest import mock + +from githappens import git_utils + + +class GitUtilsTest(unittest.TestCase): + def test_get_project_link_returns_origin_url(self): + completed = mock.Mock(returncode=0, stdout=b"git@gitlab.com:group/project.git\n") + + with mock.patch("subprocess.run", return_value=completed): + self.assertEqual( + git_utils.get_project_link_from_current_dir(), + "git@gitlab.com:group/project.git", + ) + + def test_get_project_link_returns_minus_one_when_not_git_repo(self): + completed = mock.Mock(returncode=1, stdout=b"") + + with mock.patch("subprocess.run", return_value=completed): + self.assertEqual(git_utils.get_project_link_from_current_dir(), -1) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/test_gitlab_api.py b/tests/test_gitlab_api.py new file mode 100644 index 0000000..9200966 --- /dev/null +++ b/tests/test_gitlab_api.py @@ -0,0 +1,44 @@ +import json +import unittest +from unittest import mock + +from githappens import gitlab_api + + +class GitlabApiTest(unittest.TestCase): + def test_create_branch_uses_issue_iid_and_main_branch(self): + issue = {"iid": 12, "title": "Fix: Broken Thing"} + + with mock.patch("subprocess.check_output", return_value=json.dumps({"name": "12-fix-broken-thing"}).encode()) as check_output: + branch = gitlab_api.create_branch(99, issue, "main") + + self.assertEqual(branch["name"], "12-fix-broken-thing") + command = check_output.call_args.args[0] + self.assertIn("/projects/99/repository/branches", command) + self.assertIn("branch=12-fix-broken-thing", command) + self.assertIn("ref=main", command) + self.assertIn("issue_iid=12", command) + + def test_create_issue_includes_estimate_in_description(self): + with mock.patch("githappens.gitlab_api.get_authorized_user", return_value={"id": 7}), \ + mock.patch("subprocess.check_output", return_value=json.dumps({"iid": 3}).encode()) as check_output: + gitlab_api.create_issue( + 11, + "Title", + ["Bug", "P::1"], + 22, + {"id": 33}, + {"id": 44}, + 5, + 90, + ) + + command = check_output.call_args.args[0] + self.assertIn("labels=Bug,P::1", command) + self.assertIn("milestone_id=22", command) + self.assertIn("epic_id=33", command) + self.assertIn("description=/iteration *iteration:44 \n/estimate 90m ", command) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/test_main_cli.py b/tests/test_main_cli.py new file mode 100644 index 0000000..a84c8dd --- /dev/null +++ b/tests/test_main_cli.py @@ -0,0 +1,28 @@ +import unittest +from unittest import mock + +from githappens import main + + +class MainCliTest(unittest.TestCase): + def test_open_routes_to_open_merge_request_command(self): + with mock.patch("githappens.main.open_merge_request_in_browser") as open_mr: + main.main(["open"]) + + open_mr.assert_called_once_with() + + def test_review_routes_to_review_flow(self): + with mock.patch("githappens.main.review_flow") as review_flow: + main.main(["review", "--select", "--auto_merge"]) + + review_flow.assert_called_once_with(auto_merge=True, select=True) + + def test_report_validates_minutes(self): + with mock.patch("githappens.main.process_report") as process_report: + main.main(["report", "Outage", "15"]) + + process_report.assert_called_once_with("Outage", 15) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/test_open_mr.py b/tests/test_open_mr.py new file mode 100644 index 0000000..2fcff9a --- /dev/null +++ b/tests/test_open_mr.py @@ -0,0 +1,24 @@ +import unittest + +from githappens.commands import open_mr + + +class OpenMergeRequestTest(unittest.TestCase): + def test_project_path_from_ssh_remote(self): + self.assertEqual( + open_mr.project_path_from_remote("git@gitlab.com:group/project.git"), + "group/project", + ) + + def test_project_path_from_https_remote(self): + self.assertEqual( + open_mr.project_path_from_remote("https://gitlab.com/group/project.git"), + "group/project", + ) + + def test_project_path_from_unknown_remote(self): + self.assertIsNone(open_mr.project_path_from_remote("not-a-remote")) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/test_report.py b/tests/test_report.py new file mode 100644 index 0000000..6dcb602 --- /dev/null +++ b/tests/test_report.py @@ -0,0 +1,49 @@ +import configparser +import unittest +from unittest import mock + +from githappens.commands import report + + +class ReportCommandTest(unittest.TestCase): + def test_report_returns_when_incident_project_is_missing(self): + missing_option = configparser.NoOptionError("incident_project_id", "DEFAULT") + + with mock.patch("githappens.commands.report.config.config.get", side_effect=missing_option), \ + mock.patch("githappens.commands.report.create_issue") as create_issue, \ + mock.patch("builtins.print"): + report.process_report("API outage", 15) + + create_issue.assert_not_called() + + def test_report_creates_incident_and_tracks_time(self): + with mock.patch("githappens.commands.report.config.config.get", return_value="99"), \ + mock.patch("githappens.commands.report.select_labels", return_value="Department::SRE"), \ + mock.patch("githappens.commands.report.get_active_iteration", return_value={"id": 5}), \ + mock.patch("githappens.commands.report.create_issue", return_value={"iid": 12}) as create_issue, \ + mock.patch("githappens.commands.report.close_opened_issue") as close_opened_issue, \ + mock.patch("githappens.commands.report.subprocess.run") as run, \ + mock.patch("builtins.print"): + report.process_report("API outage", 15) + + create_issue.assert_called_once() + args = create_issue.call_args.args + self.assertEqual(args[0], "Incident Report: API outage") + self.assertEqual(args[1], "99") + self.assertEqual(args[4], {"id": 5}) + self.assertEqual( + args[5], + { + "labels": ["incident", "report", "Department::SRE"], + "onlyIssue": True, + "type": "incident", + }, + ) + close_opened_issue.assert_called_once_with(12, "99") + run.assert_called_once() + self.assertIn("/projects/99/issues/12/add_spent_time", run.call_args.args[0]) + self.assertIn("duration=15m", run.call_args.args[0]) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/test_review.py b/tests/test_review.py new file mode 100644 index 0000000..4129d10 --- /dev/null +++ b/tests/test_review.py @@ -0,0 +1,24 @@ +import unittest +from unittest import mock + +from githappens.commands import review + + +class ReviewCommandTest(unittest.TestCase): + def test_current_issue_id_reads_closes_reference(self): + with mock.patch("githappens.commands.review.git_utils.get_current_branch", return_value="12-fix"), \ + mock.patch( + "githappens.commands.review.get_merge_request_for_branch", + return_value={"description": '"Closes #42"'}, + ): + self.assertEqual(review.get_current_issue_id(), "42") + + def test_current_issue_id_errors_when_merge_request_is_missing(self): + with mock.patch("githappens.commands.review.git_utils.get_current_branch", return_value="12-fix"), \ + mock.patch("githappens.commands.review.get_merge_request_for_branch", return_value=None): + with self.assertRaises(ValueError): + review.get_current_issue_id() + + +if __name__ == "__main__": + unittest.main()