diff --git a/dejacode_toolkit/__init__.py b/dejacode_toolkit/__init__.py index c0e497a1..a75562d7 100644 --- a/dejacode_toolkit/__init__.py +++ b/dejacode_toolkit/__init__.py @@ -10,7 +10,6 @@ from os import getenv from django.conf import settings -from django.core.exceptions import ObjectDoesNotExist import requests @@ -53,11 +52,7 @@ def __init__(self, dataspace): self.basic_auth_user = None self.basic_auth_password = None - try: - dataspace_configuration = dataspace.configuration - except ObjectDoesNotExist: - dataspace_configuration = None - + dataspace_configuration = dataspace.get_configuration() # Take the integration settings from the Dataspace when defined if dataspace_configuration: self.service_url = getattr(dataspace_configuration, self.url_field_name) diff --git a/dje/admin.py b/dje/admin.py index 54c07e44..cedac12b 100644 --- a/dje/admin.py +++ b/dje/admin.py @@ -1056,6 +1056,7 @@ class DataspaceConfigurationForm(forms.ModelForm): "scancodeio_api_key", "vulnerablecode_api_key", "purldb_api_key", + "github_token", ] def __init__(self, *args, **kwargs): @@ -1077,15 +1078,33 @@ class DataspaceConfigurationInline(DataspacedFKMixin, admin.StackedInline): form = DataspaceConfigurationForm verbose_name_plural = _("Configuration") verbose_name = _("Dataspace configuration") - fields = [ - "homepage_layout", - "scancodeio_url", - "scancodeio_api_key", - "vulnerablecode_url", - "vulnerablecode_api_key", - "vulnerabilities_risk_threshold", - "purldb_url", - "purldb_api_key", + fieldsets = [ + ( + "", + {"fields": ("homepage_layout",)}, + ), + ( + "AboutCode Integrations", + { + "fields": ( + "scancodeio_url", + "scancodeio_api_key", + "vulnerablecode_url", + "vulnerablecode_api_key", + "vulnerabilities_risk_threshold", + "purldb_url", + "purldb_api_key", + ) + }, + ), + ( + "GitHub Integration", + { + "fields": [ + "github_token", + ] + }, + ), ] can_delete = False diff --git a/dje/migrations/0008_dataspaceconfiguration_github_token.py b/dje/migrations/0008_dataspaceconfiguration_github_token.py new file mode 100644 index 00000000..7ba4c5a4 --- /dev/null +++ b/dje/migrations/0008_dataspaceconfiguration_github_token.py @@ -0,0 +1,18 @@ +# Generated by Django 5.2.4 on 2025-07-28 13:12 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('dje', '0007_dejacodeuser_timezone'), + ] + + operations = [ + migrations.AddField( + model_name='dataspaceconfiguration', + name='github_token', + field=models.CharField(blank=True, help_text='Personal access token (PAT) or GitHub App token used to authenticate API requests for this integration. Keep this token secure.', max_length=255, verbose_name='GitHub token'), + ), + ] diff --git a/dje/models.py b/dje/models.py index 696012de..3fff6d15 100644 --- a/dje/models.py +++ b/dje/models.py @@ -518,6 +518,16 @@ class DataspaceConfiguration(models.Model): ), ) + github_token = models.CharField( + _("GitHub token"), + max_length=255, + blank=True, + help_text=_( + "Personal access token (PAT) or GitHub App token used to authenticate " + "API requests for this integration. Keep this token secure." + ), + ) + def __str__(self): return f"Configuration for {self.dataspace}" diff --git a/dje/tests/testfiles/test_dataset_workflow.json b/dje/tests/testfiles/test_dataset_workflow.json index a17cfd64..0f5e36a2 100644 --- a/dje/tests/testfiles/test_dataset_workflow.json +++ b/dje/tests/testfiles/test_dataset_workflow.json @@ -16,7 +16,8 @@ ], "is_active": true, "include_applies_to": true, - "include_product": true + "include_product": true, + "issue_tracker_id": "" } }, { diff --git a/docs/index.rst b/docs/index.rst index e8ed616b..0db5acb0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,6 +44,12 @@ Welcome to the very start of your DejaCode journey! reference-2 reference-3-cravex +.. toctree:: + :maxdepth: 1 + :caption: Integrations + + integrations-github + .. toctree:: :maxdepth: 1 :caption: Miscellaneous diff --git a/docs/integrations-github.rst b/docs/integrations-github.rst new file mode 100644 index 00000000..7fd9e946 --- /dev/null +++ b/docs/integrations-github.rst @@ -0,0 +1,75 @@ +.. _integrations_github: + +GitHub Integration +================== + +DejaCode's integration with GitHub allows you to automatically forward +**Workflow Requests** to GitHub repository **Issues**. +This behavior can be selectively applied to any **Request Template** of your choice. + +GitHub Account and Personal Access Token +---------------------------------------- + +To enable integration, you need a GitHub **fine-grained personal access token (PAT)**. + +1. **Access GitHub Developer Settings**: + + - Go to: https://github.com/settings/personal-access-tokens + - Click **"Generate new token"** under *Fine-grained personal access tokens* + +2. **Configure the Token**: + + - **Name**: Give it a clear name (e.g., ``DejaCode Integration``) + - **Expiration**: Set an expiration date (recommended) + - **Resource owner**: Choose your personal GitHub account or organization + +.. note:: + + It is recommended to **create a dedicated GitHub user** with a clear, descriptive + name such as ``dejacode-integration``. This ensures that all GitHub issues managed by + the integration are clearly attributed to that user, improving traceability and + auditability. + +3. **Repository Access**: + + - Under *Repository access*, select **Only select repositories** + - Choose the repository where you want issues to be created and updated + +4. **Permissions**: + + - Under *Repository permissions*, enable:: + + Issues: Read and write + +5. **Save and Copy the Token**: + + - Click **Generate token** + - Copy the token and store it securely — you’ll need it for the next step + +DejaCode Dataspace Configuration +-------------------------------- + +To use your GitHub token in DejaCode: + +1. Go to the **Administration dashboard** +2. Navigate to **Dataspaces**, and select your Dataspace +3. Scroll to the **GitHub Integration** section under **Configuration** +4. Paste your GitHub token in the **GitHub token** field +5. Save the form + +Activate GitHub Integration on Request Templates +------------------------------------------------ + +1. Go to the **Administration dashboard** +2. Navigate to **Workflow** > **Request templates** +3. Create or edit a Request Template in your Dataspace +4. Set the **Issue Tracker ID** field to your GitHub repository URL, e.g.:: + + https://github.com/org/repo_name + +Once the integration is configured: + +- New **Requests** using this template will be automatically pushed to GitHub +- Field updates (like title or priority) and **status changes** (e.g. closed) will be + synced +- New **Comments** on a DejaCode Request will be propagated to the GitHub Issue. diff --git a/workflow/integrations/__init__.py b/workflow/integrations/__init__.py new file mode 100644 index 00000000..f61c4aae --- /dev/null +++ b/workflow/integrations/__init__.py @@ -0,0 +1,7 @@ +# +# Copyright (c) nexB Inc. and others. All rights reserved. +# DejaCode is a trademark of nexB Inc. +# SPDX-License-Identifier: AGPL-3.0-only +# See https://github.com/aboutcode-org/dejacode for support or download. +# See https://aboutcode.org for more information about AboutCode FOSS projects. +# diff --git a/workflow/integrations/github.py b/workflow/integrations/github.py new file mode 100644 index 00000000..92aee9ea --- /dev/null +++ b/workflow/integrations/github.py @@ -0,0 +1,176 @@ +# +# Copyright (c) nexB Inc. and others. All rights reserved. +# DejaCode is a trademark of nexB Inc. +# SPDX-License-Identifier: AGPL-3.0-only +# See https://github.com/aboutcode-org/dejacode for support or download. +# See https://aboutcode.org for more information about AboutCode FOSS projects. +# + +from urllib.parse import urlparse + +from django.conf import settings + +import requests + +GITHUB_API_URL = "https://api.github.com" +DEJACODE_SITE_URL = settings.SITE_URL.rstrip("/") + + +class GitHubIntegration: + """ + A class for managing GitHub issue creation, updates, and comments + from DejaCode requests. + """ + + api_url = GITHUB_API_URL + default_timeout = 10 + + def __init__(self, dataspace): + if not dataspace: + raise ValueError("Dataspace must be provided.") + self.dataspace = dataspace + self.session = self.get_session() + + def get_session(self): + session = requests.Session() + session.headers.update(self.get_headers()) + return session + + def get_headers(self): + github_token = self.dataspace.get_configuration(field_name="github_token") + if not github_token: + raise ValueError("The github_token is not set on the Dataspace.") + return {"Authorization": f"token {github_token}"} + + def sync(self, request): + """Sync the given request with GitHub by creating or updating an issue.""" + try: + repo_id = self.extract_github_repo_path(request.request_template.issue_tracker_id) + except ValueError as error: + raise ValueError(f"Invalid GitHub repository URL: {error}") + + labels = [] + if request.priority: + labels.append(str(request.priority)) + + external_issue = request.external_issue + if external_issue: + self.update_issue( + repo_id=repo_id, + issue_id=external_issue.issue_id, + title=self.make_issue_title(request), + body=self.make_issue_body(request), + state="closed" if request.is_closed else "open", + ) + else: + issue = self.create_issue( + repo_id=repo_id, + title=self.make_issue_title(request), + body=self.make_issue_body(request), + labels=labels, + ) + request.link_external_issue( + platform="github", + repo=repo_id, + issue_id=issue["number"], + ) + + def create_issue(self, repo_id, title, body="", labels=None): + """Create a new GitHub issue.""" + url = f"{self.api_url}/repos/{repo_id}/issues" + data = { + "title": title, + "body": body, + } + if labels: + data["labels"] = labels + + response = self.session.post( + url, + json=data, + timeout=self.default_timeout, + ) + response.raise_for_status() + return response.json() + + def update_issue(self, repo_id, issue_id, title=None, body=None, state=None): + """Update an existing GitHub issue.""" + url = f"{self.api_url}/repos/{repo_id}/issues/{issue_id}" + data = {} + if title: + data["title"] = title + if body: + data["body"] = body + if state: + data["state"] = state + + response = self.session.patch( + url, + json=data, + timeout=self.default_timeout, + ) + response.raise_for_status() + return response.json() + + def post_comment(self, repo_id, issue_id, comment_body): + """Post a comment on an existing GitHub issue.""" + url = f"{self.api_url}/repos/{repo_id}/issues/{issue_id}/comments" + data = {"body": comment_body} + + response = self.session.post( + url, + json=data, + timeout=self.default_timeout, + ) + response.raise_for_status() + return response.json() + + @staticmethod + def extract_github_repo_path(url): + """Extract 'username/repo-name' from a GitHub URL.""" + parsed = urlparse(url) + if "github.com" not in parsed.netloc: + raise ValueError("URL does not point to GitHub.") + + path_parts = [part for part in parsed.path.split("/") if part] + if len(path_parts) < 2: + raise ValueError("Incomplete GitHub repository path.") + + return f"{path_parts[0]}/{path_parts[1]}" + + @staticmethod + def make_issue_title(request): + return f"[DEJACODE] {request.title}" + + @staticmethod + def make_issue_body(request): + request_url = f"{DEJACODE_SITE_URL}{request.get_absolute_url()}" + label_fields = [ + ("📝 Request Template", request.request_template), + ("📦 Product Context", request.product_context), + ("📌 Applies To", request.content_object), + ("🙋 Submitted By", request.requester), + ("👤 Assigned To", request.assignee), + ("🚨 Priority", request.priority), + ("🗒️ Notes", request.notes), + ("🔗️ DejaCode URL", request_url), + ] + + lines = [] + for label, value in label_fields: + if value: + lines.append(f"### {label}\n{value}") + + lines.append("----") + + for question in request.get_serialized_data_as_list(): + label = question.get("label") + value = question.get("value") + input_type = question.get("input_type") + + if input_type == "BooleanField": + value = "Yes" if str(value).lower() in ("1", "true", "yes") else "No" + + lines.append(f"### {label}\n{value}") + + return "\n\n".join(lines) diff --git a/workflow/migrations/0002_requesttemplate_issue_tracker_id_externalissuelink_and_more.py b/workflow/migrations/0002_requesttemplate_issue_tracker_id_externalissuelink_and_more.py new file mode 100644 index 00000000..a7e97487 --- /dev/null +++ b/workflow/migrations/0002_requesttemplate_issue_tracker_id_externalissuelink_and_more.py @@ -0,0 +1,40 @@ +# Generated by Django 5.2.4 on 2025-07-30 07:04 + +import django.db.models.deletion +import uuid +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('dje', '0008_dataspaceconfiguration_github_token'), + ('workflow', '0001_initial'), + ] + + operations = [ + migrations.AddField( + model_name='requesttemplate', + name='issue_tracker_id', + field=models.CharField(blank=True, help_text='Link to associated issue in a tracking application, provided by the integration when the issue is created.', max_length=1000, verbose_name='Issue Tracker ID'), + ), + migrations.CreateModel( + name='ExternalIssueLink', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, verbose_name='UUID')), + ('platform', models.CharField(choices=[('github', 'GitHub'), ('gitlab', 'GitLab'), ('jira', 'Jira'), ('sourcehut', 'SourceHut')], help_text='External issue tracking platform.', max_length=20)), + ('repo', models.CharField(help_text="Repository or project identifier (e.g., 'user/repo-name').", max_length=100)), + ('issue_id', models.CharField(help_text='ID or key of the issue on the external platform.', max_length=100)), + ('dataspace', models.ForeignKey(editable=False, help_text='A Dataspace is an independent, exclusive set of DejaCode data, which can be either nexB master reference data or installation-specific data.', on_delete=django.db.models.deletion.PROTECT, to='dje.dataspace')), + ], + options={ + 'unique_together': {('dataspace', 'platform', 'repo', 'issue_id'), ('dataspace', 'uuid')}, + }, + ), + migrations.AddField( + model_name='request', + name='external_issue', + field=models.ForeignKey(blank=True, help_text='Link to external issue (GitHub, GitLab, Jira, etc.)', null=True, on_delete=django.db.models.deletion.SET_NULL, to='workflow.externalissuelink'), + ), + ] diff --git a/workflow/models.py b/workflow/models.py index 6c46c114..1be8da51 100644 --- a/workflow/models.py +++ b/workflow/models.py @@ -39,6 +39,7 @@ from dje.models import HistoryDateFieldsMixin from dje.models import HistoryFieldsMixin from dje.models import get_unsecured_manager +from workflow.integrations.github import GitHubIntegration from workflow.notification import request_comment_slack_payload from workflow.notification import request_slack_payload @@ -88,6 +89,44 @@ def __str__(self): return self.label +class ExternalIssueLink(DataspacedModel): + class Platform(models.TextChoices): + GITHUB = "github", _("GitHub") + GITLAB = "gitlab", _("GitLab") + JIRA = "jira", _("Jira") + SOURCEHUT = "sourcehut", _("SourceHut") + + platform = models.CharField( + max_length=20, choices=Platform.choices, help_text="External issue tracking platform." + ) + + repo = models.CharField( + max_length=100, help_text="Repository or project identifier (e.g., 'user/repo-name')." + ) + + issue_id = models.CharField( + max_length=100, help_text="ID or key of the issue on the external platform." + ) + + class Meta: + unique_together = ( + ("dataspace", "platform", "repo", "issue_id"), + ("dataspace", "uuid"), + ) + + def __str__(self): + return f"{self.get_platform_display()}:{self.repo}#{self.issue_id}" + + @property + def issue_url(self): + if self.platform == self.Platform.GITHUB: + return f"https://github.com/{self.repo}/issues/{self.issue_id}" + elif self.platform == self.Platform.GITLAB: + return f"https://gitlab.com/{self.repo}/-/issues/{self.issue_id}" + elif self.platform == self.Platform.JIRA: + return f"https://{self.repo}/browse/{self.issue_id}" + + class RequestQuerySet(DataspacedQuerySet): BASE_SELECT_RELATED = [ "request_template", @@ -95,6 +134,7 @@ class RequestQuerySet(DataspacedQuerySet): "assignee", "priority", "product_context", + "external_issue", "last_modified_by", ] @@ -348,6 +388,14 @@ class Status(models.TextChoices): ), ) + external_issue = models.ForeignKey( + to="workflow.ExternalIssueLink", + on_delete=models.SET_NULL, + null=True, + blank=True, + help_text=_("Link to external issue (GitHub, GitLab, Jira, etc.)"), + ) + last_modified_by = LastModifiedByField() objects = DataspacedManager.from_queryset(RequestQuerySet)() @@ -378,8 +426,8 @@ def save(self, *args, **kwargs): # `previous_object_id` logic is only required on edition. previous_object_id = None - is_addition = self.pk - if is_addition: + is_change = self.pk + if is_change: previous_object_id = self.__class__.objects.get(pk=self.pk).object_id super().save(*args, **kwargs) @@ -397,6 +445,8 @@ def save(self, *args, **kwargs): return previous_object.update_request_count() + self.handle_integrations() + def get_absolute_url(self): return reverse("workflow:request_details", args=[self.uuid]) @@ -520,6 +570,45 @@ def serialize_hook(self, hook): "data": serializer.data, } + def close(self, user, reason): + """ + Set the Request status to CLOSED. + A RequestEvent is created and returned. + """ + self.status = self.Status.CLOSED + self.last_modified_by = user + self.save() + event_instance = self.events.create( + user=user, + text=reason, + event_type=RequestEvent.CLOSED, + dataspace=self.dataspace, + ) + return event_instance + + def link_external_issue(self, platform, repo, issue_id): + """Create or return an ExternalIssueLink associated with this Request.""" + if self.external_issue: + return self.external_issue + + external_issue = ExternalIssueLink.objects.create( + dataspace=self.dataspace, + platform=platform, + repo=repo, + issue_id=str(issue_id), + ) + self.update(external_issue=external_issue) + + return external_issue + + def handle_integrations(self): + issue_tracker_id = self.request_template.issue_tracker_id + if not issue_tracker_id: + return + + if "github.com" in issue_tracker_id: + GitHubIntegration(dataspace=self.dataspace).sync(request=self) + @receiver(models.signals.post_delete, sender=Request) def update_request_count_on_delete(sender, instance=None, **kwargs): @@ -545,6 +634,16 @@ class AbstractRequestEvent(HistoryDateFieldsMixin, DataspacedModel): class Meta: abstract = True + def save(self, *args, **kwargs): + """Call the handle_integrations method on save, only for addition.""" + is_addition = not self.pk + super().save(*args, **kwargs) + if is_addition: + self.handle_integrations() + + def handle_integrations(self): + pass + class RequestEvent(AbstractRequestEvent): request = models.ForeignKey( @@ -574,6 +673,21 @@ class Meta: def __str__(self): return f"{self.get_event_type_display()} by {self.user.username}" + def handle_integrations(self): + external_issue = self.request.external_issue + if not external_issue: + return + + if not self.event_type == self.CLOSED: + return + + if external_issue.platform == ExternalIssueLink.Platform.GITHUB: + GitHubIntegration(dataspace=self.dataspace).post_comment( + repo_id=external_issue.repo, + issue_id=external_issue.issue_id, + comment_body=self.text, + ) + class RequestComment(AbstractRequestEvent): request = models.ForeignKey( @@ -644,6 +758,18 @@ def serialize_hook(self, hook): "data": data, } + def handle_integrations(self): + external_issue = self.request.external_issue + if not external_issue: + return + + if external_issue.platform == ExternalIssueLink.Platform.GITHUB: + GitHubIntegration(dataspace=self.dataspace).post_comment( + repo_id=external_issue.repo, + issue_id=external_issue.issue_id, + comment_body=self.text, + ) + class RequestTemplateQuerySet(DataspacedQuerySet): def actives(self): @@ -723,6 +849,16 @@ class RequestTemplate(HistoryFieldsMixin, DataspacedModel): ), ) + issue_tracker_id = models.CharField( + verbose_name=_("Issue Tracker ID"), + max_length=1000, + blank=True, + help_text=_( + "Link to associated issue in a tracking application, " + "provided by the integration when the issue is created." + ), + ) + objects = DataspacedManager.from_queryset(RequestTemplateQuerySet)() class Meta: diff --git a/workflow/templates/workflow/includes/request_list_table.html b/workflow/templates/workflow/includes/request_list_table.html index 2f1765ca..b346985a 100644 --- a/workflow/templates/workflow/includes/request_list_table.html +++ b/workflow/templates/workflow/includes/request_list_table.html @@ -46,6 +46,15 @@ #{{ req.id }} {{ req.title }} + {% if req.external_issue %} +
+ + + {{ req.external_issue }} + + +
+ {% endif %}
{% if filter.form.request_template %} {{ req.request_template.name }} diff --git a/workflow/templates/workflow/request_details.html b/workflow/templates/workflow/request_details.html index 540eb7e4..0deca6ae 100644 --- a/workflow/templates/workflow/request_details.html +++ b/workflow/templates/workflow/request_details.html @@ -22,6 +22,15 @@

{{ request_instance }} {{ request_instance.title }}

+ {% if request_instance.external_issue %} +
+ + + {{ request_instance.external_issue }} + + +
+ {% endif %}
diff --git a/workflow/templates/workflow/request_form.html b/workflow/templates/workflow/request_form.html index 677d996a..19b89164 100644 --- a/workflow/templates/workflow/request_form.html +++ b/workflow/templates/workflow/request_form.html @@ -21,6 +21,15 @@

{% if request_instance %}{# Edition #} Edit: {{ request_instance }} {{ request_instance.title }} + {% if request_instance.external_issue %} + • + + + {{ request_instance.external_issue }} + + + + {% endif %} {% else %}{# Addition #} New Request {% endif %} diff --git a/workflow/tests/test_integrations.py b/workflow/tests/test_integrations.py new file mode 100644 index 00000000..bff03f15 --- /dev/null +++ b/workflow/tests/test_integrations.py @@ -0,0 +1,123 @@ +# +# Copyright (c) nexB Inc. and others. All rights reserved. +# DejaCode is a trademark of nexB Inc. +# SPDX-License-Identifier: AGPL-3.0-only +# See https://github.com/aboutcode-org/dejacode for support or download. +# See https://aboutcode.org for more information about AboutCode FOSS projects. +# + +from unittest import mock + +from django.contrib.contenttypes.models import ContentType +from django.test import TestCase + +from dje.models import Dataspace +from dje.tests import create_superuser +from workflow.integrations.github import GitHubIntegration +from workflow.models import Question +from workflow.models import RequestTemplate + + +class GitHubIntegrationTestCase(TestCase): + def setUp(self): + patcher = mock.patch("workflow.models.Request.handle_integrations", return_value=None) + self.mock_handle_integrations = patcher.start() + self.addCleanup(patcher.stop) + + self.dataspace = Dataspace.objects.create(name="nexB") + self.dataspace.set_configuration("github_token", "fake-token") + self.super_user = create_superuser("nexb_user", self.dataspace) + self.component_ct = ContentType.objects.get( + app_label="component_catalog", model="component" + ) + self.request_template = RequestTemplate.objects.create( + name="GitHub Template", + description="Integration test template", + content_type=self.component_ct, + dataspace=self.dataspace, + issue_tracker_id="https://github.com/nexB/repo", + ) + self.question = Question.objects.create( + template=self.request_template, + label="Example Question", + input_type="TextField", + position=0, + dataspace=self.dataspace, + ) + self.request = self.request_template.create_request( + title="Example Request", + requester=self.super_user, + serialized_data='{"Example Question": "Some value"}', + ) + self.github = GitHubIntegration(dataspace=self.dataspace) + + def test_extract_github_repo_path_valid_url(self): + url = "https://github.com/user/repo" + result = GitHubIntegration.extract_github_repo_path(url) + self.assertEqual(result, "user/repo") + + def test_extract_github_repo_path_invalid_url(self): + with self.assertRaises(ValueError): + GitHubIntegration.extract_github_repo_path("https://example.com/user/repo") + + def test_get_headers_returns_auth_header(self): + headers = self.github.get_headers() + self.assertEqual(headers, {"Authorization": "token fake-token"}) + + def test_make_issue_title(self): + title = GitHubIntegration.make_issue_title(self.request) + self.assertEqual(title, "[DEJACODE] Example Request") + + def test_make_issue_body_contains_question(self): + body = GitHubIntegration.make_issue_body(self.request) + self.assertIn("### Example Question", body) + self.assertIn("Some value", body) + + @mock.patch("requests.Session.post") + def test_create_issue_calls_post(self, mock_session_post): + mock_session_post.return_value.json.return_value = {"number": 10} + mock_session_post.return_value.raise_for_status.return_value = None + + issue = self.github.create_issue( + repo_id="user/repo", + title="Issue Title", + body="Issue Body", + labels=["High"], + ) + + self.assertEqual(issue["number"], 10) + mock_session_post.assert_called_once() + + @mock.patch("requests.Session.patch") + def test_update_issue_calls_patch(self, mock_session_patch): + mock_session_patch.return_value.json.return_value = {"state": "closed"} + mock_session_patch.return_value.raise_for_status.return_value = None + + response = self.github.update_issue( + repo_id="user/repo", + issue_id=123, + title="Updated title", + body="Updated body", + state="closed", + ) + + self.assertEqual(response["state"], "closed") + mock_session_patch.assert_called_once() + + @mock.patch("requests.Session.post") + def test_post_comment_calls_post(self, mock_session_post): + mock_session_post.return_value.json.return_value = {"id": 77, "body": "Test comment"} + mock_session_post.return_value.raise_for_status.return_value = None + + response = self.github.post_comment( + repo_id="user/repo", + issue_id=42, + comment_body="Test comment", + ) + + self.assertEqual(response["body"], "Test comment") + mock_session_post.assert_called_once_with( + "https://api.github.com/repos/user/repo/issues/42/comments", + json={"body": "Test comment"}, + timeout=self.github.default_timeout, + ) diff --git a/workflow/tests/test_models.py b/workflow/tests/test_models.py index d618d205..07231e4d 100644 --- a/workflow/tests/test_models.py +++ b/workflow/tests/test_models.py @@ -7,6 +7,7 @@ # import json +from unittest import mock from django.contrib.contenttypes.models import ContentType from django.test import TestCase @@ -350,6 +351,30 @@ def test_request_queryset_status_methods(self): self.assertIn(self.request2, qs) self.assertNotIn(request3, qs) + def test_request_model_close_method(self): + self.request1.close(user=self.super_user, reason="Reason") + self.request1.refresh_from_db() + self.assertEqual(Request.Status.CLOSED, self.request1.status) + self.assertEqual(self.super_user, self.request1.last_modified_by) + close_event = self.request1.events.get(event_type=RequestEvent.CLOSED) + self.assertEqual(self.super_user, close_event.user) + self.assertEqual("Reason", close_event.text) + + def test_request_model_link_external_issue(self): + external_issue = self.request1.link_external_issue( + platform="github", + repo="org/repo", + issue_id="1", + ) + self.assertEqual(self.nexb_dataspace, external_issue.dataspace) + self.assertEqual("github", external_issue.platform) + self.assertEqual("org/repo", external_issue.repo) + self.assertEqual("1", external_issue.issue_id) + self.assertEqual("https://github.com/org/repo/issues/1", external_issue.issue_url) + + self.request1.refresh_from_db() + self.assertEqual(external_issue, self.request1.external_issue) + def test_request_model_is_draft_property(self): self.request1.status = Request.Status.OPEN self.assertFalse(self.request1.is_draft) @@ -564,3 +589,21 @@ def test_request_content_object_update_request_count_on_delete(self): component1.delete() request1.delete() + + @mock.patch("workflow.integrations.github.GitHubIntegration.sync") + def test_sync_called_on_save_when_issue_tracker_is_github(self, mock_sync): + mock_sync.return_value = None + self.nexb_dataspace.set_configuration("github_token", "fake-token") + + self.request_template1.create_request( + title="Example Request", + requester=self.super_user, + ) + mock_sync.assert_not_called() + + self.request_template1.update(issue_tracker_id="https://github.com/org/repo") + request = self.request_template1.create_request( + title="Example Request", + requester=self.super_user, + ) + mock_sync.assert_called_once_with(request=request) diff --git a/workflow/views.py b/workflow/views.py index d38fcdf1..1cc97ae3 100644 --- a/workflow/views.py +++ b/workflow/views.py @@ -244,15 +244,7 @@ def request_details_view(request, request_uuid): closed_reason = request.POST.get("closed_reason") if closed_reason and request_instance.has_close_permission(request.user): - request_instance.status = Request.Status.CLOSED - request_instance.last_modified_by = request.user - request_instance.save() - event_instance = request_instance.events.create( - user=request.user, - text=closed_reason, - event_type=RequestEvent.CLOSED, - dataspace=request_instance.dataspace, - ) + event_instance = request_instance.close(user=request.user, reason=closed_reason) send_request_comment_notification(request, event_instance, closed=True) messages.success(request, f"Request {request_instance} closed") return redirect("workflow:request_list")