From 83e2ab5d38f9edd5adbcbcb8e896b4fd7140b24d Mon Sep 17 00:00:00 2001
From: MatthewTighe <mtighe@mozilla.com>
Date: Tue, 11 Oct 2022 15:46:45 -0700
Subject: [PATCH] No issue: add script to generate filled telemetry renewal
 request

---
 tools/.gitignore               |  2 ++
 tools/data_renewal_generate.py |  0
 tools/data_renewal_request.py  | 52 ++++++++++++++++++++++++++++++++++
 3 files changed, 54 insertions(+)
 create mode 100644 tools/.gitignore
 mode change 100644 => 100755 tools/data_renewal_generate.py
 create mode 100755 tools/data_renewal_request.py

diff --git a/tools/.gitignore b/tools/.gitignore
new file mode 100644
index 000000000..2a20e4947
--- /dev/null
+++ b/tools/.gitignore
@@ -0,0 +1,2 @@
+*_expiry_list.csv
+*_renewal_request.txt
diff --git a/tools/data_renewal_generate.py b/tools/data_renewal_generate.py
old mode 100644
new mode 100755
diff --git a/tools/data_renewal_request.py b/tools/data_renewal_request.py
new file mode 100755
index 000000000..50228bd45
--- /dev/null
+++ b/tools/data_renewal_request.py
@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+"""
+A script to help generate a data review request comment. Once the CSV has been filled by product,
+copy the filled version into the tools directory and run this script from there to generate a filled
+renewal request data review comment.
+"""
+
+import csv
+import sys
+
+try:
+    version = sys.argv[1]
+except:
+    print ("usage is to include arguments of the form <version>")
+    quit()
+
+expiry_filename = version + "_expiry_list.csv"
+filled_renewal_filename = version + "_filled_renewal_request.txt"
+
+csv_reader = csv.DictReader(open(expiry_filename, 'r'))
+output_string = ""
+total_count = 0
+updated_version = int(version) + 13
+for row in csv_reader:
+    (section, metric) = row["name"].split('.')
+    if row["keep(Y/N)"] == 'n':
+        continue
+    total_count += 1
+    output_string += f'` {row["name"]}`\n'
+    output_string += "1) Provide a link to the initial Data Collection Review Request for this collection.\n"
+    output_string += f'    - {eval(row["data_reviews"])[0]}\n'
+    output_string += "\n"
+    output_string += "2) When will this collection now expire?\n"
+    output_string += f'    - {updated_version}\n'
+    output_string += "\n"
+    output_string += "3) Why was the initial period of collection insufficient?\n"
+    output_string += f'    - {row["reason to extend"]}\n'
+    output_string += "\n"
+    output_string += "———\n"
+
+header = "# Request for Data Collection Renewal\n"
+header += "### Renew for 1 year\n"
+header += f'Total: {total_count}\n'
+header += "———\n\n"
+
+with open(filled_renewal_filename, 'w+') as out:
+    out.write(header + output_string)
+    out.close()