From 657bd66b9c9514c6af2f10c1dbdeafccff4eab26 Mon Sep 17 00:00:00 2001
From: Jon Meow <46229924+jonmeow@users.noreply.github.com>
Date: Fri, 13 Nov 2020 16:32:11 -0800
Subject: [PATCH] Fix proposal script to handle copyright (#197)

`.tmp` -> `.tmp.md` causes the right copyright to be chosen (new issue due to the check-copyright pre-commit)

The `_get_proposals_dir` changes are to allow pytest to be run from any directory.
---
 src/scripts/new_proposal.py      | 13 +++++++++----
 src/scripts/new_proposal_test.py |  5 ++++-
 2 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/src/scripts/new_proposal.py b/src/scripts/new_proposal.py
index 7636aae40145..d178f1bb3654 100755
--- a/src/scripts/new_proposal.py
+++ b/src/scripts/new_proposal.py
@@ -79,6 +79,13 @@ def _fill_template(template_path, title, pr_num):
     return content
 
 
+def _get_proposals_dir():
+    """Returns the path to the proposals directory."""
+    return os.path.realpath(
+        os.path.join(os.path.dirname(__file__), "../../proposals")
+    )
+
+
 def _run(argv, check=True):
     """Runs a command."""
     cmd = " ".join([shlex.quote(x) for x in argv])
@@ -117,9 +124,7 @@ def main():
     precommit_bin = _find_tool("pre-commit")
 
     # Ensure a good working directory.
-    proposals_dir = os.path.realpath(
-        os.path.join(os.path.dirname(__file__), "../../proposals")
-    )
+    proposals_dir = _get_proposals_dir()
     os.chdir(proposals_dir)
 
     # Verify there are no uncommitted changes.
@@ -140,7 +145,7 @@ def main():
 
     # Copy template.md to a temp file.
     template_path = os.path.join(proposals_dir, "template.md")
-    temp_path = os.path.join(proposals_dir, "new-proposal.tmp")
+    temp_path = os.path.join(proposals_dir, "new-proposal.tmp.md")
     shutil.copyfile(template_path, temp_path)
     _run([git_bin, "add", temp_path])
     _run([git_bin, "commit", "-m", "Creating new proposal: %s" % title])
diff --git a/src/scripts/new_proposal_test.py b/src/scripts/new_proposal_test.py
index 495d01a24fca..8359b356f8eb 100644
--- a/src/scripts/new_proposal_test.py
+++ b/src/scripts/new_proposal_test.py
@@ -8,6 +8,7 @@ Exceptions. See /LICENSE for license information.
 SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 """
 
+import os
 import unittest
 from unittest import mock
 
@@ -44,7 +45,9 @@ class TestNewProposal(unittest.TestCase):
 
     def test_fill_template(self):
         content = new_proposal._fill_template(
-            "../../proposals/template.md", "TITLE", 123
+            os.path.join(new_proposal._get_proposals_dir(), "template.md"),
+            "TITLE",
+            123,
         )
         self.assertTrue(content.startswith("# TITLE\n\n"), content)
         self.assertTrue(