From patchwork Mon Oct 7 22:16:44 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Johan Herland X-Patchwork-Id: 1172974 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 46nFGl3y5hz9s7T for ; Tue, 8 Oct 2019 09:17:51 +1100 (AEDT) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=herland.net Received: from bilbo.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 46nFGl2zmbzDqHK for ; Tue, 8 Oct 2019 09:17:51 +1100 (AEDT) X-Original-To: patchwork@lists.ozlabs.org Delivered-To: patchwork@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=gmail.com (client-ip=209.85.167.53; helo=mail-lf1-f53.google.com; envelope-from=jherland@gmail.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=herland.net Received: from mail-lf1-f53.google.com (mail-lf1-f53.google.com [209.85.167.53]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 46nFFg34z6zDqJL for ; Tue, 8 Oct 2019 09:16:54 +1100 (AEDT) Received: by mail-lf1-f53.google.com with SMTP id q12so5449677lfc.11 for ; Mon, 07 Oct 2019 15:16:54 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Xz+CldcsyBTor7b40MR8pllz10TlP0gXlYea1OMysOc=; b=VdsnsUjseW2w9eoXxY8OFRYf5M7DXffVYuXQ07ZqGBKoI4WQloffTAlkj9Ti1ZE0Ol NJd1KeJHB6xBrBXSlQ0Xb4X/hm8ZrLRlK5rcHf2eOzcAdNQQz++6Erv9anF5UAALS8by +c+eUPmC7l6w+bRznInuf7F36rdBumSIvW2QpiCyyRgLstnT84+UvE9cesBDUq2dHvpw NOwsxuiPSp5sq2DOsiU2qLsXNJd9nvE0BfsbJEzbETq89XNWTO1E5ofBjzT1bkzjnPUi gDcZyp6cq7DVbrNxOGQg9T5zte+VZeVX+NybFeuJ2QfNpglEoPyfLPAsDBuuD+erXwn5 n1DQ== X-Gm-Message-State: APjAAAUvLotqRRi+UMrfcLokURgsLDu8T7Jdl88QYV1K0s8IX0YZs6K7 Ee3BSQn2oAdsg8FjboLpKV4EsHy56AM= X-Google-Smtp-Source: APXvYqxycObUyzDhMrbWc1CpTzp4fhBdQ+CpbV9lMrwbLueofHny4cZOssrgILVuvFVZmfvvegLqtA== X-Received: by 2002:a19:98e:: with SMTP id 136mr18623568lfj.156.1570486611434; Mon, 07 Oct 2019 15:16:51 -0700 (PDT) Received: from beta.herland (160.37-191-159.fiber.lynet.no. [37.191.159.160]) by smtp.gmail.com with ESMTPSA id s7sm3370081ljs.16.2019.10.07.15.16.50 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 07 Oct 2019 15:16:50 -0700 (PDT) From: Johan Herland To: patchwork@lists.ozlabs.org Subject: [PATCH v2 2/3] Include the responsible actor in applicable events Date: Tue, 8 Oct 2019 00:16:44 +0200 Message-Id: <20191007221645.13186-3-johan@herland.net> X-Mailer: git-send-email 2.19.2 In-Reply-To: <20191007221645.13186-1-johan@herland.net> References: <20191007221645.13186-1-johan@herland.net> MIME-Version: 1.0 X-BeenThere: patchwork@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Patchwork development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Mauro Carvalho Chehab Errors-To: patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Patchwork" We want to use the events as an audit log. An important part of this is recording _who_ made the changes that the events represent. To accomplish this, we need to know the current user (aka. request.user) at the point where we create the Event instance. Event creation is currently triggered by signals, but neither the signal handlers, nor the model classes themselves have easy access to request.user. For Patch-based events (patch-created, patch-state-changed, patch-delegated, patch-completed), we can do the following hack: The relevant events are created in signal handlers that are all hooked up to either the pre_save or post_save signals sent by Patch.save(). But before calling Patch.save(), Patchwork must naturally query Patch.is_editable() to ascertain whether the patch can in fact be changed by the current user. Thus, we only need a way to communicate the current user from Patch.is_editable() to the signal handlers that create the resulting Events. The Patch object itself is available in both places, so we simply add an ._edited_by attribute to the instance (which fortunately is not detected as a persistent db field by Django). The series-completed event is also triggered by Patch.save(), so uses the same trick as above. For the check-created event the current user always happens to be the same as the .user field recorded in the Check object itself. The remaining events (cover-created, series-created) are both triggered by incoming emails, hence have no real actor as such, so we simply leave the actor as None/NULL. Closes: #73 Cc: Mauro Carvalho Chehab Signed-off-by: Johan Herland --- patchwork/models.py | 6 +++++- patchwork/signals.py | 10 ++++++++-- patchwork/tests/test_events.py | 7 +++++++ 3 files changed, 20 insertions(+), 3 deletions(-) diff --git a/patchwork/models.py b/patchwork/models.py index b43c15a..f37572e 100644 --- a/patchwork/models.py +++ b/patchwork/models.py @@ -498,9 +498,13 @@ class Patch(Submission): return False if user in [self.submitter.user, self.delegate]: + self._edited_by = user return True - return self.project.is_editable(user) + if self.project.is_editable(user): + self._edited_by = user + return True + return False @property def combined_check_state(self): diff --git a/patchwork/signals.py b/patchwork/signals.py index 666199b..987cc5a 100644 --- a/patchwork/signals.py +++ b/patchwork/signals.py @@ -77,6 +77,7 @@ def create_patch_created_event(sender, instance, created, raw, **kwargs): return Event.objects.create( category=Event.CATEGORY_PATCH_CREATED, project=patch.project, + actor=getattr(patch, '_edited_by', None), patch=patch) # don't trigger for items loaded from fixtures or new items @@ -93,6 +94,7 @@ def create_patch_state_changed_event(sender, instance, raw, **kwargs): return Event.objects.create( category=Event.CATEGORY_PATCH_STATE_CHANGED, project=patch.project, + actor=getattr(patch, '_edited_by', None), patch=patch, previous_state=before, current_state=after) @@ -116,6 +118,7 @@ def create_patch_delegated_event(sender, instance, raw, **kwargs): return Event.objects.create( category=Event.CATEGORY_PATCH_DELEGATED, project=patch.project, + actor=getattr(patch, '_edited_by', None), patch=patch, previous_delegate=before, current_delegate=after) @@ -139,6 +142,7 @@ def create_patch_completed_event(sender, instance, raw, **kwargs): return Event.objects.create( category=Event.CATEGORY_PATCH_COMPLETED, project=patch.project, + actor=getattr(patch, '_edited_by', None), patch=patch, series=patch.series) @@ -184,6 +188,7 @@ def create_check_created_event(sender, instance, created, raw, **kwargs): return Event.objects.create( category=Event.CATEGORY_CHECK_CREATED, project=check.patch.project, + actor=check.user, patch=check.patch, created_check=check) @@ -219,10 +224,11 @@ def create_series_completed_event(sender, instance, raw, **kwargs): # exists in the wild ('PATCH 5/n'), so we probably want to retest a series # in that case. - def create_event(series): + def create_event(series, actor): return Event.objects.create( category=Event.CATEGORY_SERIES_COMPLETED, project=series.project, + actor=actor, series=series) # don't trigger for items loaded from fixtures, new items or items that @@ -241,4 +247,4 @@ def create_series_completed_event(sender, instance, raw, **kwargs): # we can't use "series.received_all" here since we haven't actually saved # the instance yet so we duplicate that logic here but with an offset if (instance.series.received_total + 1) >= instance.series.total: - create_event(instance.series) + create_event(instance.series, getattr(instance, '_edited_by', None)) diff --git a/patchwork/tests/test_events.py b/patchwork/tests/test_events.py index e5c40b5..415237f 100644 --- a/patchwork/tests/test_events.py +++ b/patchwork/tests/test_events.py @@ -110,8 +110,10 @@ class PatchChangedTest(_BaseTestCase): patch = utils.create_patch(series=None) old_state = patch.state new_state = utils.create_state() + actor = utils.create_maintainer(project=patch.project) patch.state = new_state + self.assertTrue(patch.is_editable(actor)) patch.save() events = _get_events(patch=patch) @@ -120,6 +122,7 @@ class PatchChangedTest(_BaseTestCase): self.assertEqual(events[1].category, Event.CATEGORY_PATCH_STATE_CHANGED) self.assertEqual(events[1].project, patch.project) + self.assertEqual(events[1].actor, actor) self.assertEventFields(events[1], previous_state=old_state, current_state=new_state) @@ -127,10 +130,12 @@ class PatchChangedTest(_BaseTestCase): # purposefully setting series to None to minimize additional events patch = utils.create_patch(series=None) delegate_a = utils.create_user() + actor = utils.create_maintainer(project=patch.project) # None -> Delegate A patch.delegate = delegate_a + self.assertTrue(patch.is_editable(actor)) patch.save() events = _get_events(patch=patch) @@ -139,6 +144,7 @@ class PatchChangedTest(_BaseTestCase): self.assertEqual(events[1].category, Event.CATEGORY_PATCH_DELEGATED) self.assertEqual(events[1].project, patch.project) + self.assertEqual(events[1].actor, actor) self.assertEventFields(events[1], current_delegate=delegate_a) delegate_b = utils.create_user() @@ -175,6 +181,7 @@ class CheckCreatedTest(_BaseTestCase): self.assertEqual(events.count(), 1) self.assertEqual(events[0].category, Event.CATEGORY_CHECK_CREATED) self.assertEqual(events[0].project, check.patch.project) + self.assertEqual(events[0].actor, check.user) self.assertEventFields(events[0])