From patchwork Tue Sep 5 22:13:03 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jeremy Spewock X-Patchwork-Id: 131182 Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id AFD5E42503; Wed, 6 Sep 2023 00:24:20 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id B86CD4027C; Wed, 6 Sep 2023 00:24:20 +0200 (CEST) Received: from mail-qk1-f225.google.com (mail-qk1-f225.google.com [209.85.222.225]) by mails.dpdk.org (Postfix) with ESMTP id 5F5644013F for ; Wed, 6 Sep 2023 00:24:19 +0200 (CEST) Received: by mail-qk1-f225.google.com with SMTP id af79cd13be357-76da22c090dso180307285a.2 for ; Tue, 05 Sep 2023 15:24:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1693952659; x=1694557459; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=zdoIipl14s5MdVVlSk/5MAEhlZb5RDn6oM+MejVsH0g=; b=DY0MzXnhTj0F862Rvj5ecq/6/aNs5Nqd2jlBQnNtw4S5zeRrymp1vxhl0uKzYQg8ES /0rKyzEf2weJUj7RXONmNO4txHBTEngiBKlIzWOc5xrM3zU/m/U+3CdR8E0eW7cLJJX6 jpKumB4Uv3xZVil2f+ForuGx1VzN4x2glWDcA= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1693952659; x=1694557459; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=zdoIipl14s5MdVVlSk/5MAEhlZb5RDn6oM+MejVsH0g=; b=LF5xUzeWywJYKfYa0d11rh1E4/FkWVDX0ZGI/ynjNVXKhFyEkmJC2noEM88y7/6So3 n8wU6GtFfG4xdQVB//ejNMO0/2M9/N/CoqIE5alDHqqSdIeuDizntmScA5EWCd/B3QLA hCahd2K8YoDS0z504OWkwkK2A8XABAAkDpgYM1Tv070KyGx2+EJXMt2g9Cbfsd83POVy E3Ee9Z8pZ102VmQrRN1NCMt6xFcHodLf3v1ffRNGUN7XNKMMMBBTYpdy9vhE3JlhV/Bh qfaE4QcljT/cTMRFU31dmFat6EyM2E0QdHcjrs7szFlgFYAnlX+ggIWHGzTdZQaMafUZ OaoQ== X-Gm-Message-State: AOJu0YxKDnVLdjP/pzN+Yg8BECmMUB49rf7aOvFKxPcrbedLYeCg36M9 e2T0rAB5wNLVD7nGr9A7WLGc88rCdDiFZOqs8dx9mQYozDyIGNFN8PP4D/vR3aNfnP1eQqv/tSL o0QK24cwfRxETtALtHvG9/TERJHbq8X6deK3ZX4IUHxMw6yRfd9MU66myZcpbAYtUqiv4U1Joo1 t826pe2bFAIcK5iHWUTUW8 X-Google-Smtp-Source: AGHT+IGHbiQop263MCLOHlJLq6lqvTket0giHBReTaXCKNKbXD/2lQMkARx4SqVG/FVuUaPWAXW4aznciuGg X-Received: by 2002:a0c:cd0e:0:b0:64f:92d2:44f8 with SMTP id b14-20020a0ccd0e000000b0064f92d244f8mr12791020qvm.59.1693952658773; Tue, 05 Sep 2023 15:24:18 -0700 (PDT) Received: from postal.iol.unh.edu (postal.iol.unh.edu. [2606:4100:3880:1234::84]) by smtp-relay.gmail.com with ESMTPS id i7-20020a0cf487000000b0063676c5eb2esm874021qvm.29.2023.09.05.15.24.18 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Sep 2023 15:24:18 -0700 (PDT) X-Relaying-Domain: iol.unh.edu Received: from iol.unh.edu (unknown [IPv6:2606:4100:3880:1271:90f9:1b64:f6e6:867f]) by postal.iol.unh.edu (Postfix) with ESMTP id 5ED106052471; Tue, 5 Sep 2023 18:24:18 -0400 (EDT) From: jspewock@iol.unh.edu To: ci@dpdk.org Cc: aconole@redhat.com, alialnu@nvidia.com, probb@iol.unh.edu, Jeremy Spewock , Adam Hassick Subject: [PATCH 1/1] tools: add get_reruns script Date: Tue, 5 Sep 2023 18:13:03 -0400 Message-ID: <20230905222317.25821-4-jspewock@iol.unh.edu> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20230905222317.25821-2-jspewock@iol.unh.edu> References: <20230905222317.25821-2-jspewock@iol.unh.edu> MIME-Version: 1.0 X-BeenThere: ci@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK CI discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: ci-bounces@dpdk.org From: Jeremy Spewock This script is used to interact with the DPDK Patchwork API to collect a list of retests from comments on patches based on a desired list of contexts to retest. The script uses regex to scan all of the comments since a timestamp that is passed into the script through the CLI for any comment that is requesting a retest. These requests are then filtered based on the desired contexts that you pass into the script through the CLI and then aggregated based on the patch series ID of the series that the comment came from. This aggregated list is then outputted to a JSON file with a timestamp of the most recent comment on patchworks. Signed-off-by: Jeremy Spewock Signed-off-by: Adam Hassick --- tools/get_reruns.py | 219 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 219 insertions(+) create mode 100755 tools/get_reruns.py diff --git a/tools/get_reruns.py b/tools/get_reruns.py new file mode 100755 index 0000000..159ff6e --- /dev/null +++ b/tools/get_reruns.py @@ -0,0 +1,219 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2023 University of New Hampshire + +import argparse +import datetime +import json +import re +from json import JSONEncoder +from typing import Dict, List, Set, Optional + +import requests + + +class JSONSetEncoder(JSONEncoder): + """Custom JSON encoder to handle sets. + + Pythons json module cannot serialize sets so this custom encoder converts + them into lists. + + Args: + JSONEncoder: JSON encoder from the json python module. + """ + + def default(self, input_object): + if isinstance(input_object, set): + return list(input_object) + return input_object + + +class RerunProcessor: + """Class for finding reruns inside an email using the patchworks events + API. + + The idea of this class is to use regex to find certain patterns that + represent desired contexts to rerun. + + Arguments: + desired_contexts: List of all contexts to search for in the bodies of + the comments + time_since: Get all comments since this timestamp + + Attributes: + collection_of_retests: A dictionary that maps patch series IDs to the + set of contexts to be retested for that patch series. + regex: regex used for collecting the contexts from the comment body. + last_comment_timestamp: timestamp of the most recent comment that was + processed + """ + + _desired_contexts: List[str] + _time_since: str + collection_of_retests: Dict[str, Dict[str, Set]] = {} + last_comment_timestamp: Optional[str] = None + # ^ is start of line + # ((?:[a-zA-Z-]+(?:, ?\n?)?)+) is a capture group that gets all test + # labels after "Recheck-request: " + # (?:[a-zA-Z-]+(?:, ?\n?)?)+ means 1 or more of the first match group + # [a-zA-Z0-9-_]+ means 1 more more of any character in the ranges a-z, + # A-Z, 0-9, or the characters '-' or '_' + # (?:, ?\n?)? means 1 or none of this match group which expects + # exactly 1 comma followed by 1 or no spaces followed by + # 1 or no newlines. + # VALID MATCHES: + # Recheck-request: iol-unit-testing, iol-something-else, iol-one-more, + # Recheck-request: iol-unit-testing,iol-something-else, iol-one-more + # Recheck-request: iol-unit-testing, iol-example, iol-another-example, + # more-intel-testing + # INVALID MATCHES: + # Recheck-request: iol-unit-testing, intel-example-testing + # Recheck-request: iol-unit-testing iol-something-else,iol-one-more, + # Recheck-request: iol-unit-testing,iol-something-else,iol-one-more, + # + # more-intel-testing + regex: str = "^Recheck-request: ((?:[a-zA-Z0-9-_]+(?:, ?\n?)?)+)" + + def __init__(self, desired_contexts: List[str], time_since: str) -> None: + self._desired_contexts = desired_contexts + self._time_since = time_since + + def process_reruns(self) -> None: + patchwork_url = f"http://patches.dpdk.org/api/events/?since={self._time_since}" + comment_request_info = [] + for item in [ + "&category=cover-comment-created", + "&category=patch-comment-created", + ]: + response = requests.get(patchwork_url + item) + response.raise_for_status() + comment_request_info.extend(response.json()) + rerun_processor.process_comment_info(comment_request_info) + + def process_comment_info(self, list_of_comment_blobs: List[Dict]) -> None: + """Takes the list of json blobs of comment information and associates + them with their patches. + + Collects retest labels from a list of comments on patches represented + inlist_of_comment_blobs and creates a dictionary that associates them + with their corresponding patch series ID. The labels that need to be + retested are collected by passing the comments body into + get_test_names() method. This method also updates the current UTC + timestamp for the processor to the current time. + + Args: + list_of_comment_blobs: a list of JSON blobs that represent comment + information + """ + + list_of_comment_blobs = sorted( + list_of_comment_blobs, + key=lambda x: datetime.datetime.fromisoformat(x["date"]), + reverse=True, + ) + + if list_of_comment_blobs: + most_recent_timestamp = datetime.datetime.fromisoformat( + list_of_comment_blobs[0]["date"] + ) + # exclude the most recent + most_recent_timestamp = most_recent_timestamp + datetime.timedelta( + microseconds=1 + ) + self.last_comment_timestamp = most_recent_timestamp.isoformat() + + for comment in list_of_comment_blobs: + # before we do any parsing we want to make sure that we are dealing + # with a comment that is associated with a patch series + payload_key = "cover" + if comment["category"] == "patch-comment-created": + payload_key = "patch" + patch_series_arr = requests.get( + comment["payload"][payload_key]["url"] + ).json()["series"] + if not patch_series_arr: + continue + patch_id = patch_series_arr[0]["id"] + + comment_info = requests.get(comment["payload"]["comment"]["url"]) + comment_info.raise_for_status() + content = comment_info.json()["content"] + + labels_to_rerun = self.get_test_names(content) + + # appending to the list if it already exists, or creating it if it + # doesn't + if labels_to_rerun: + self.collection_of_retests[patch_id] = self.collection_of_retests.get( + patch_id, {"contexts": set()} + ) + self.collection_of_retests[patch_id]["contexts"].update(labels_to_rerun) + + def get_test_names(self, email_body: str) -> Set[str]: + """Uses the regex in the class to get the information from the email. + + When it gets the test names from the email, it will all be in one + capture group. We expect a comma separated list of patchwork labels + to be retested. + + Returns: + A set of contexts found in the email that match your list of + desired contexts to capture. We use a set here to avoid duplicate + contexts. + """ + rerun_section = re.findall(self.regex, email_body, re.MULTILINE) + if not rerun_section: + return set() + rerun_list = list(map(str.strip, rerun_section[0].split(","))) + return set(filter(lambda x: x and x in self._desired_contexts, rerun_list)) + + def write_to_output_file(self, file_name: str) -> None: + """Write class information to a JSON file. + + Takes the collection_of_retests and last_comment_timestamp and outputs + them into a json file. + + Args: + file_name: Name of the file to write the output to. + """ + + output_dict = { + "retests": self.collection_of_retests, + "last_comment_timestamp": self.last_comment_timestamp, + } + with open(file_name, "w") as file: + file.write(json.dumps(output_dict, indent=4, cls=JSONSetEncoder)) + + +if __name__ == "__main__": + parser = argparse.ArgumentParser(description="Help text for getting reruns") + parser.add_argument( + "-ts", + "--time-since", + dest="time_since", + required=True, + help="Get all patches since this many days ago (default: 5)", + ) + parser.add_argument( + "--contexts", + dest="contexts_to_capture", + nargs="*", + required=True, + help="List of patchwork contexts you would like to capture", + ) + parser.add_argument( + "-o", + "--out-file", + dest="out_file", + help=( + "Output file where the list of reruns and the timestamp of the" + "last comment in the list of comments" + "(default: rerun_requests.json)." + ), + default="rerun_requests.json", + ) + args = parser.parse_args() + rerun_processor = RerunProcessor(args.contexts_to_capture, args.time_since) + rerun_processor.process_reruns() + rerun_processor.write_to_output_file(args.out_file)