From 63a604289cfb120437deab0ea996818e9fe2cfe8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Santiago=20Due=C3=B1as?= Date: Thu, 11 Dec 2025 14:12:25 +0100 Subject: [PATCH] [git] Add commit hash to events MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The commit hash has been included on git linked events, such actions and identities, for traceability purposes. Fixes #12 Signed-off-by: Santiago Dueñas --- chronicler/events/core/git.py | 25 ++++++++++++++++--- docs/events.md | 16 ++++++------ .../unreleased/commit-hash-in-git-events.yml | 9 +++++++ tests/test_git.py | 18 +++++++++++++ 4 files changed, 56 insertions(+), 12 deletions(-) create mode 100644 releases/unreleased/commit-hash-in-git-events.yml diff --git a/chronicler/events/core/git.py b/chronicler/events/core/git.py index ea386f8..be1905c 100644 --- a/chronicler/events/core/git.py +++ b/chronicler/events/core/git.py @@ -26,6 +26,7 @@ from ...eventizer import Eventizer, uuid, Identity + GIT_EVENT_COMMIT = "org.grimoirelab.events.git.commit" GIT_EVENT_MERGE_COMMIT = "org.grimoirelab.events.git.merge" GIT_EVENT_ACTION_ADDED = "org.grimoirelab.events.git.file.added" @@ -101,6 +102,7 @@ def eventize_item(self, raw_item: dict[str, Any]) -> list[CloudEvent]: events.append(event) action_events = self._eventize_commit_actions(event, + raw_item['data']['commit'], raw_item['data']['files']) events.extend(action_events) @@ -112,7 +114,7 @@ def eventize_item(self, raw_item: dict[str, Any]) -> list[CloudEvent]: return events - def _eventize_commit_actions(self, parent_event: CloudEvent, raw_files_data): + def _eventize_commit_actions(self, parent_event: CloudEvent, commit_hash, raw_files_data): events = [] @@ -127,7 +129,10 @@ def _eventize_commit_actions(self, parent_event: CloudEvent, raw_files_data): if parent_event['type'] == GIT_EVENT_COMMIT: action_event = self._process_action(parent_event['source'], parent_event['time'], - parent_event['id'], actions, file_data) + parent_event['id'], + commit_hash, + actions, + file_data) events.append(action_event) else: prev_merge_action = None @@ -137,12 +142,15 @@ def _eventize_commit_actions(self, parent_event: CloudEvent, raw_files_data): action_event = self._process_action(parent_event['source'], parent_event['time'], - parent_event['id'], action, file_data) + parent_event['id'], + commit_hash, + action, + file_data) events.append(action_event) prev_merge_action = action return events - def _process_action(self, source, time, event_uuid, action, file_data): + def _process_action(self, source, time, event_uuid, commit_hash, action, file_data): if action == 'A': event_type = GIT_EVENT_ACTION_ADDED elif action == 'M': @@ -165,6 +173,7 @@ def _process_action(self, source, time, event_uuid, action, file_data): event_id = uuid(*id_args) data = { + "commit": commit_hash, "filename": file_data['file'], "modes": file_data['modes'], "indexes": file_data['indexes'], @@ -191,11 +200,14 @@ def _eventize_commit_identities(self, parent_event: CloudEvent, raw_item: dict[s events = [] + commit_hash = raw_item["data"]["commit"] + authors = self._parse_authors(raw_item["data"]["Author"]) identity_events = self._process_identities(parent_event['source'], parent_event['time'], parent_event['id'], GIT_EVENT_COMMIT_AUTHORED_BY, + commit_hash, authors) events.extend(identity_events) @@ -204,6 +216,7 @@ def _eventize_commit_identities(self, parent_event: CloudEvent, raw_item: dict[s parent_event['time'], parent_event['id'], GIT_EVENT_COMMIT_COMMITTED_BY, + commit_hash, committers) events.extend(identity_events) @@ -213,6 +226,7 @@ def _eventize_commit_identities(self, parent_event: CloudEvent, raw_item: dict[s parent_event['time'], parent_event['id'], event_type, + commit_hash, signers) events.extend(identity_events) @@ -224,6 +238,7 @@ def _process_identities( time: str, event_uuid: str, event_type: str, + commit_hash: str, raw_identities: list[str] ) -> Generator[CloudEvent, None, None]: """Obtain identity events from a list of identities. @@ -232,6 +247,7 @@ def _process_identities( :param time: time of the event :param event_uuid: UUID of the parent event :param event_type: type of the identity event + :param commit_hash: hash of the commit where identities contributed :param raw_identities: list of strings with the identities information :returns: generator of CloudEvent with the identity information @@ -252,6 +268,7 @@ def _process_identities( event_id = uuid(event_uuid, role, identity_id) data = { + "commit": commit_hash, "source": "git", "name": identity.name, "username": identity.username, diff --git a/docs/events.md b/docs/events.md index 7bac48e..b1a1344 100644 --- a/docs/events.md +++ b/docs/events.md @@ -4,7 +4,7 @@ Each event is structured into two parts: -- Attributes: metadata providing contextual information about the event and present in +- Attributes: metadata providing contextual information about the event and present in all types of events. The attributes are based on the CloudEvents specification. - Data: other information specific to the event. @@ -64,6 +64,7 @@ Git events are related to commits in git repositories. | Field | Type | Description | |---------------|-----------------|------------------------------------------------------------| +| commit | `String` | Commit hash | | filename | `String` | Name of the file | | modes | `List (String)` | Git file modes | | indexes | `List (String)` | Git indexes | @@ -100,7 +101,6 @@ Git events are related to commits in git repositories. File objects found in the `files` field of [commit](#commit) and [merge commit](#merge-commit) events. - | Field | Type | Description | |---------|-----------------|-------------------------------------| | action | `String` | Identifier of the action performed | @@ -110,13 +110,13 @@ File objects found in the `files` field of [commit](#commit) and [merge commit]( | modes | `List (String)` | Git file modes | | removed | `String` | Number of deleted lines in the file | - #### Commit contributors Information about contributors related to a commit. | Field | Type | Description | |----------|----------|---------------------------------------------------| +| commit | `String` | Commit hash | | name | `String` | Name of the contributor | | username | `String` | Username of the contributor | | email | `String` | Email of the contributor | @@ -138,7 +138,7 @@ Identifies the person who applied or committed the patch to the repository. ##### Acked-by -Identifies the person who is more familiar with the area the patch +Identifies the person who is more familiar with the area the patch attempts to modify and has approved the patch. - Event type: `org.grimoirelab.events.git.commit.acked_by` @@ -151,14 +151,14 @@ Identifies people who exchanged drafts of a patch before submitting it. ##### Helped-by -Identifies someone who suggested ideas for changes without providing the precise +Identifies someone who suggested ideas for changes without providing the precise changes in patch form. - Event type: `org.grimoirelab.events.git.commit.helped_by` ##### Mentored-by -Identifies someone who helped develop a patch as part of a mentorship program +Identifies someone who helped develop a patch as part of a mentorship program (e.g., GSoC or Outreachy). - Event type: `org.grimoirelab.events.git.commit.mentored_by` @@ -170,14 +170,14 @@ Identifies the person who found the bug that the patch attempts to fix. - Event type: `org.grimoirelab.events.git.commit.reported_by` ##### Reviewed-by -Identifies the reviewer who, after a detailed analysis, is completely satisfied +Identifies the reviewer who, after a detailed analysis, is completely satisfied with the patch. - Event type: `org.grimoirelab.events.git.commit.reviewed_by` ##### Signed-off-by -Indicates that the committer certifies they have the rights to submit the work, +Indicates that the committer certifies they have the rights to submit the work, typically by adding a sign-off line in the commit message. - Event type: `org.grimoirelab.events.git.commit.signed_off_by` diff --git a/releases/unreleased/commit-hash-in-git-events.yml b/releases/unreleased/commit-hash-in-git-events.yml new file mode 100644 index 0000000..9113300 --- /dev/null +++ b/releases/unreleased/commit-hash-in-git-events.yml @@ -0,0 +1,9 @@ +--- +title: Commit hash in Git events +category: added +author: Santiago Dueñas +issue: 12 +notes: > + Git events - including actions and identities events - + will include the commit hash for traceability purposes. + diff --git a/tests/test_git.py b/tests/test_git.py index 17bcf60..c805fdb 100644 --- a/tests/test_git.py +++ b/tests/test_git.py @@ -101,6 +101,7 @@ def test_eventize_item_commit(self): self.assertEqual(action_event['type'], GIT_EVENT_ACTION_ADDED) self.assertEqual(action_event['source'], 'https://example.git') self.assertEqual(action_event['time'], 1344966351.0) + self.assertEqual(action_event.data['commit'], 'c6ba8f7a1058db3e6b4bc6f1090e932b107605fb') self.assertEqual(action_event.data['filename'], 'ddd/finalthing') self.assertEqual(action_event.data['added_lines'], '0') self.assertEqual(action_event.data['deleted_lines'], '0') @@ -110,6 +111,7 @@ def test_eventize_item_commit(self): self.assertEqual(identity_event['type'], GIT_EVENT_COMMIT_AUTHORED_BY) self.assertEqual(identity_event['source'], 'https://example.git') self.assertEqual(identity_event['time'], 1344966351.0) + self.assertEqual(identity_event.data['commit'], 'c6ba8f7a1058db3e6b4bc6f1090e932b107605fb') self.assertEqual(identity_event.data['name'], 'Eduardo Morais') self.assertEqual(identity_event.data['email'], 'companheiro.vermelho@example.com') self.assertIsNone(identity_event.data['username']) @@ -122,6 +124,7 @@ def test_eventize_item_commit(self): self.assertEqual(identity_event['type'], GIT_EVENT_COMMIT_COMMITTED_BY) self.assertEqual(identity_event['source'], 'https://example.git') self.assertEqual(identity_event['time'], 1344966351.0) + self.assertEqual(identity_event.data['commit'], 'c6ba8f7a1058db3e6b4bc6f1090e932b107605fb') self.assertEqual(identity_event.data['name'], 'Eduardo Morais') self.assertEqual(identity_event.data['email'], 'companheiro.vermelho@example.com') self.assertIsNone(identity_event.data['username']) @@ -202,6 +205,7 @@ def test_eventize_item_merge_commit(self): self.assertEqual(action_event['type'], GIT_EVENT_ACTION_MODIFIED) self.assertEqual(action_event['source'], 'https://example.git') self.assertEqual(action_event['time'], 1392185439.0) + self.assertEqual(action_event.data['commit'], '456a68ee1407a77f3e804a30dff245bb6c6b872f') self.assertEqual(action_event.data['filename'], 'aaa/otherthing.renamed') self.assertEqual(action_event.data['added_lines'], '1') self.assertEqual(action_event.data['deleted_lines'], '0') @@ -211,6 +215,7 @@ def test_eventize_item_merge_commit(self): self.assertEqual(action_event['type'], GIT_EVENT_ACTION_REPLACED) self.assertEqual(action_event['source'], 'https://example.git') self.assertEqual(action_event['time'], 1392185439.0) + self.assertEqual(action_event.data['commit'], '456a68ee1407a77f3e804a30dff245bb6c6b872f') self.assertEqual(action_event.data['filename'], 'aaa/otherthing.renamed') self.assertEqual(action_event.data['added_lines'], '1') self.assertEqual(action_event.data['deleted_lines'], '0') @@ -220,6 +225,7 @@ def test_eventize_item_merge_commit(self): self.assertEqual(identity_event['type'], GIT_EVENT_COMMIT_AUTHORED_BY) self.assertEqual(identity_event['source'], 'https://example.git') self.assertEqual(identity_event['time'], 1392185439.0) + self.assertEqual(identity_event.data['commit'], '456a68ee1407a77f3e804a30dff245bb6c6b872f') self.assertEqual(identity_event.data['name'], 'Zhongpeng Lin (\u6797\u4e2d\u9e4f)') self.assertEqual(identity_event.data['email'], 'lin.zhp@example.com') self.assertIsNone(identity_event.data['username']) @@ -232,6 +238,7 @@ def test_eventize_item_merge_commit(self): self.assertEqual(identity_event['type'], GIT_EVENT_COMMIT_COMMITTED_BY) self.assertEqual(identity_event['source'], 'https://example.git') self.assertEqual(identity_event['time'], 1392185439.0) + self.assertEqual(identity_event.data['commit'], '456a68ee1407a77f3e804a30dff245bb6c6b872f') self.assertEqual(identity_event.data['name'], 'Zhongpeng Lin (\u6797\u4e2d\u9e4f)') self.assertEqual(identity_event.data['email'], 'lin.zhp@example.com') self.assertIsNone(identity_event.data['username']) @@ -389,6 +396,7 @@ def test_eventize_commit_copy_files(self): self.assertEqual(action_event['type'], GIT_EVENT_ACTION_COPIED) self.assertEqual(action_event['source'], 'https://example.git') self.assertEqual(action_event['time'], 1556580356.0) + self.assertEqual(action_event.data['commit'], '7882c41g607ee5273da9637da0bb20ca7634cb83') self.assertEqual(action_event.data['filename'], 'packages/react-events/FocusScope.js') self.assertEqual(action_event.data['new_filename'], 'packages/react-events/drag.js') self.assertEqual(action_event.data['added_lines'], '0') @@ -400,6 +408,7 @@ def test_eventize_commit_copy_files(self): self.assertEqual(action_event['type'], GIT_EVENT_ACTION_COPIED) self.assertEqual(action_event['source'], 'https://example.git') self.assertEqual(action_event['time'], 1556580356.0) + self.assertEqual(action_event.data['commit'], '7882c41g607ee5273da9637da0bb20ca7634cb83') self.assertEqual(action_event.data['filename'], 'packages/react-events/FocusScope.js') self.assertEqual(action_event.data['new_filename'], 'packages/react-events/focus-scope.js') self.assertEqual(action_event.data['added_lines'], '0') @@ -411,6 +420,7 @@ def test_eventize_commit_copy_files(self): self.assertEqual(identity_event['type'], GIT_EVENT_COMMIT_AUTHORED_BY) self.assertEqual(identity_event['source'], 'https://example.git') self.assertEqual(identity_event['time'], 1556580356.0) + self.assertEqual(identity_event.data['commit'], '7882c41g607ee5273da9637da0bb20ca7634cb83') self.assertEqual(identity_event.data['name'], 'Tom') self.assertEqual(identity_event.data['email'], 'tom@example.com') self.assertIsNone(identity_event.data['username']) @@ -424,6 +434,7 @@ def test_eventize_commit_copy_files(self): self.assertEqual(identity_event['type'], GIT_EVENT_COMMIT_COMMITTED_BY) self.assertEqual(identity_event['source'], 'https://example.git') self.assertEqual(identity_event['time'], 1556580356.0) + self.assertEqual(identity_event.data['commit'], '7882c41g607ee5273da9637da0bb20ca7634cb83') self.assertEqual(identity_event.data['name'], 'GitHub') self.assertEqual(identity_event.data['email'], 'noreply@github.com') self.assertIsNone(identity_event.data['username']) @@ -589,6 +600,7 @@ def test_eventize_item_pair_programming(self): self.assertEqual(identity_event['id'], 'd79b2902045c0caa80a862f1b265cf8b9b949062') self.assertEqual(identity_event['linked_event'], '439b7a02af9b8f6041951b3b2dc96b6929ea94a8') self.assertEqual(identity_event['source'], 'https://example.git') + self.assertEqual(identity_event.data['commit'], 'c6ba8f7a1058db3e6b4bc6f1090e932b107605fb') self.assertEqual(identity_event.data['name'], 'José Pérez') self.assertIsNone(identity_event.data['email']) self.assertIsNone(identity_event.data['username']) @@ -601,6 +613,7 @@ def test_eventize_item_pair_programming(self): self.assertEqual(identity_event['id'], 'e9be85bc27c70ab87ca1f598af9e38c6f67e5f22') self.assertEqual(identity_event['linked_event'], '439b7a02af9b8f6041951b3b2dc96b6929ea94a8') self.assertEqual(identity_event['source'], 'https://example.git') + self.assertEqual(identity_event.data['commit'], 'c6ba8f7a1058db3e6b4bc6f1090e932b107605fb') self.assertEqual(identity_event.data['source'], 'git') self.assertEqual(identity_event.data['name'], 'Sherlock Holmes') self.assertIsNone(identity_event.data['email']) @@ -614,6 +627,7 @@ def test_eventize_item_pair_programming(self): self.assertEqual(identity_event['linked_event'], '439b7a02af9b8f6041951b3b2dc96b6929ea94a8') self.assertEqual(identity_event['source'], 'https://example.git') self.assertEqual(identity_event['time'], 1344966351.0) + self.assertEqual(identity_event.data['commit'], 'c6ba8f7a1058db3e6b4bc6f1090e932b107605fb') self.assertEqual(identity_event.data['source'], 'git') self.assertEqual(identity_event.data['name'], 'John Smith') self.assertIsNone(identity_event.data['email']) @@ -627,6 +641,7 @@ def test_eventize_item_pair_programming(self): self.assertEqual(identity_event['linked_event'], '439b7a02af9b8f6041951b3b2dc96b6929ea94a8') self.assertEqual(identity_event['source'], 'https://example.git') self.assertEqual(identity_event['time'], 1344966351.0) + self.assertEqual(identity_event.data['commit'], 'c6ba8f7a1058db3e6b4bc6f1090e932b107605fb') self.assertEqual(identity_event.data['source'], 'git') self.assertIsNone(identity_event.data['name']) self.assertIsNone(identity_event.data['username']) @@ -640,6 +655,7 @@ def test_eventize_item_pair_programming(self): self.assertEqual(identity_event['linked_event'], '439b7a02af9b8f6041951b3b2dc96b6929ea94a8') self.assertEqual(identity_event['source'], 'https://example.git') self.assertEqual(identity_event['time'], 1344966351.0) + self.assertEqual(identity_event.data['commit'], 'c6ba8f7a1058db3e6b4bc6f1090e932b107605fb') self.assertEqual(identity_event.data['source'], 'git') self.assertEqual(identity_event.data['name'], 'José Pérez') self.assertIsNone(identity_event.data['email']) @@ -653,6 +669,7 @@ def test_eventize_item_pair_programming(self): self.assertEqual(identity_event['linked_event'], '439b7a02af9b8f6041951b3b2dc96b6929ea94a8') self.assertEqual(identity_event['source'], 'https://example.git') self.assertEqual(identity_event['time'], 1344966351.0) + self.assertEqual(identity_event.data['commit'], 'c6ba8f7a1058db3e6b4bc6f1090e932b107605fb') self.assertEqual(identity_event.data['source'], 'git') self.assertEqual(identity_event.data['name'], 'Sherlock Holmes') self.assertIsNone(identity_event.data['email']) @@ -666,6 +683,7 @@ def test_eventize_item_pair_programming(self): self.assertEqual(identity_event['linked_event'], '439b7a02af9b8f6041951b3b2dc96b6929ea94a8') self.assertEqual(identity_event['source'], 'https://example.git') self.assertEqual(identity_event['time'], 1344966351.0) + self.assertEqual(identity_event.data['commit'], 'c6ba8f7a1058db3e6b4bc6f1090e932b107605fb') self.assertEqual(identity_event.data['source'], 'git') self.assertIsNone(identity_event.data['name']) self.assertIsNone(identity_event.data['username'])