test: add integratin test of issue and json creation

Author: EvaMart

pytest.ini

@@ -3,4 +3,6 @@
 addopts = -m "not manual"
 markers =
     manual: marks tests that should only run when manually triggered
-asyncio_mode = auto
+asyncio_mode = auto
+env_files =
+    .env

src/application/services/integration/disambiguation/disambiguator.py

@@ -104,7 +104,8 @@ async def process_conflict(key, conflict, instances_dict):
             else:
                 ## conflict file creation
                 content, filename = generate_conflict_file(conflict, key)
-                conflict_url = commit_conflict_json(content, filename)
+                path = f"human_annotations/conflicts/{filename}"
+                conflict_url = commit_conflict_json(content, path)
 
                 ## issue creation
                 context = generate_context(key, full_conflict, conflict_url)

src/application/services/integration/disambiguation/github_issue.jinja2

@@ -2,7 +2,9 @@
 
 A conflict has been detected between two software metadata entries with the same name but no shared repository or website. Please review the metadata and provide your decision using the format below.
 
-**Annotation Guidelines**: refer to the [annotation guidelines](https://link-to-guidelines.example.com) if needed.
+**Annotation Guidelines**: refer to the [annotation guidelines](https://link-to-guidelines.example.com) if needed. 
+
+**Conflict** (for reference): [{{conflict_url}}]({{conflict_url}})
 
 ---
 
@@ -52,10 +54,6 @@ Use the **exact format shown** in a single comment, replacing the values as need
 }
 ```
 
-### Conflict annotation 
-
-- JSON file: [{{conflict_url}}]({{conflict_url}})
-
 ---
 
 Thank you! Your annotation will be automatically ingested and logged.

src/application/services/integration/disambiguation/issues.py

@@ -12,7 +12,7 @@
 GITHUB_API = "https://api.github.com"
 BRANCH = "main"
 
-def commit_conflict_json(conflict: dict, filename: str) -> str:
+def commit_conflict_json(conflict: dict, path: str, branch=BRANCH, repo=REPO) -> str:
     """
     Commit a conflict JSON file to human_annotations/conflicts/.
 
@@ -23,19 +23,18 @@ def commit_conflict_json(conflict: dict, filename: str) -> str:
     Returns:
         str: GitHub URL to the committed file
     """
-    path = f"human_annotations/conflicts/{filename}"
-    url = f"{GITHUB_API}/repos/{REPO}/contents/{path}"
+    
+    url = f"{GITHUB_API}/repos/{repo}/contents/{path}"
 
     # prepare content
     content = json.dumps(conflict, indent=2, sort_keys=True)
     encoded = base64.b64encode(content.encode("utf-8")).decode("utf-8")
 
     payload = {
-        "message": f"Add conflict annotation: {filename}",
+        "message": f"Add conflict annotation: {path}",
         "content": encoded,
-        "branch": BRANCH,
+        "branch": branch,
     }
-
     headers = {
         "Authorization": f"Bearer {GITHUB_TOKEN}",
         "Accept": "application/vnd.github+json",
@@ -259,7 +258,7 @@ def generate_conflict_file(conflict, conflict_name):
 
 
 
-def create_github_issue(title, body, labels=None):
+def create_github_issue(title, body, labels=None, repo=REPO):
     """
     Create a GitHub issue and commit associated conflict JSON.
 
@@ -281,7 +280,7 @@ def create_github_issue(title, body, labels=None):
 
     print(f"Making Github issue ... ")
 
-    url = f"{GITHUB_API}/repos/{REPO}/issues"
+    url = f"{GITHUB_API}/repos/{repo}/issues"
     headers = {
         "Authorization": f"Bearer {GITHUB_TOKEN}",
         "Accept": "application/vnd.github+json",

tests/application/services/integration/test_github_issue.py

@@ -1,8 +1,10 @@
 import json
 import random
 import pytest
+import uuid
+
 from pprint import pprint
-from src.application.services.integration.disambiguation.issues import generate_context, generate_conflict_file, generate_github_body, stable_hash
+from src.application.services.integration.disambiguation.issues import generate_context, generate_conflict_file, commit_conflict_json, generate_github_body, stable_hash, create_github_issue
 
 
 full_conflict ={
@@ -364,7 +366,8 @@ def test_stable_hash_list_order_matters_by_default():
 # --------------------------------------------------------------------------------
 
 def test_generate_conflict_file(): 
-    # This function requires "conflict" and "conflict name". conflict is the original conflict, without any processing
+    # The function "generate_conflict_file" requires "conflict" and "conflict name" as arguments.
+    # "conflict" is the full conflict, without any processing
     conflict_name = "ale/cmd" 
 
     content, filename = generate_conflict_file(full_conflict, conflict_name) 
@@ -374,12 +377,33 @@ def test_generate_conflict_file():
 
     assert "ale/cmd_" in filename  
     assert type(content) == dict
-    
 
 
-# Push issue
-## In a test branch
+# --------------- Full Integration Test --------------------------------------------
+#
+# Run with: PYTHONPATH=$(pwd) pytest -v -s -m manual tests/application/services/integration/test_github_issue.py 
+#
+# It creates an issue and adds the conflict file to https://github.com/EvaMart/test-integrations/ 
+
+@pytest.mark.manual
+def test_create_github_issue():
+    # Push issue
+    conflict_name = "ale/cmd"
+    REPO = 'EvaMart/test-integrations'
+    GITHUB_API = "https://api.github.com"
+    # -------- generating URL --------
+    content, filename = generate_conflict_file(full_conflict, conflict_name) 
+    
+    random_suffix = uuid.uuid4().hex
+    filename = f"human_annotations/conflicts/test_{random_suffix}.json"
+    
+    conflict_url = commit_conflict_json(content, filename, 'main', REPO)
+    context = generate_context(conflict_name, full_conflict, conflict_url)
+    body = generate_github_body(context)
+    
+    title = f"Manual resolution needed for {conflict_name}"
+    labels = ['test']
+    repo = 'evamart/test-integrations'
+    response = create_github_issue(title, body, labels, repo)
+  
 
-# commit JSON file -> This requires making changes to the code
-## commit to a test branch
-## assert the URL is correct