Allow the directory used for storing intermediate files to be changed via argument.

Author: yoshi-automation

scripts/changesummary.py

@@ -49,14 +49,16 @@ class ChangeSummary:
         artifacts.
     """
 
-    def __init__(self, new_artifacts_dir, current_artifacts_dir, file_list):
+    def __init__(self, new_artifacts_dir, current_artifacts_dir, temp_dir, file_list):
         """Initializes an instance of a ChangeSummary.
 
         Args:
             new_artifacts_dir (str): The relative path to the directory with the
                 new discovery artifacts.
             current_artifacts_dir (str): The relative path to the directory with
                 the current discovery artifacts.
+            temp_dir (str): The relative path to the directory used for
+                temporary storage where intermediate files will be stored.
             file_list (list): A list of strings containing files to analyze.
         """
         if file_list is None:
@@ -65,6 +67,7 @@ def __init__(self, new_artifacts_dir, current_artifacts_dir, file_list):
         self._file_list = file_list
         self._new_artifacts_dir = new_artifacts_dir
         self._current_artifacts_dir = current_artifacts_dir
+        self._temp_dir = temp_dir
 
         # Sanity checks to ensure artifact directories exist
         self._raise_if_artifacts_dir_not_found(self._new_artifacts_dir)
@@ -497,16 +500,15 @@ def detect_discovery_changes(self):
             sort_columns = ["Name", "Version", "ChangeType", "Key"]
             result.sort_values(by=sort_columns, ascending=True, inplace=True)
 
-            # Create a temp/ folder which be used by the `createcommits.sh` and
-            # `buildprbody.py` scripts
-            temp_folder = "temp/"
-            os.makedirs(os.path.dirname(temp_folder), exist_ok=True)
+            # Create a folder which be used by the `createcommits.sh` and
+            # `buildprbody.py` scripts.
+            os.makedirs(os.path.dirname(self._temp_dir), exist_ok=True)
 
             # Create a summary which contains a conventional commit message
             # for each API and write it to disk.
-            summary_df = self._get_summary_and_write_to_disk(result, temp_folder)
+            summary_df = self._get_summary_and_write_to_disk(result, self._temp_dir)
 
             # Create verbose change information for each API which contains
             # a list of changes by key and write it to disk.
-            self._write_verbose_changes_to_disk(result, temp_folder, summary_df)
+            self._write_verbose_changes_to_disk(result, self._temp_dir, summary_df)
 

scripts/updatediscoveryartifacts.py

@@ -20,25 +20,25 @@
 import describe
 import changesummary
 
-DISCOVERY_DOC_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)),
-                                    '../googleapiclient/discovery_cache/documents')
-REFERENCE_DOC_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)),
-                                    '../docs/dyn')
+SCRIPTS_DIR = os.path.dirname(os.path.realpath(__file__))
+DISCOVERY_DOC_DIR = os.path.join(SCRIPTS_DIR, '../googleapiclient/discovery_cache/documents')
+REFERENCE_DOC_DIR = os.path.join(SCRIPTS_DIR, '../docs/dyn')
+TEMP_DIR = os.path.join(SCRIPTS_DIR, 'temp')
 
 # Clear discovery documents and reference documents directory
 shutil.rmtree(DISCOVERY_DOC_DIR, ignore_errors=True)
 shutil.rmtree(REFERENCE_DOC_DIR, ignore_errors=True)
 
 # Clear temporary directory
-shutil.rmtree('temp', ignore_errors=True)
+shutil.rmtree(TEMP_DIR, ignore_errors=True)
 
 # Check out a fresh copy
 subprocess.call(['git', 'checkout', DISCOVERY_DOC_DIR])
 subprocess.call(['git', 'checkout', REFERENCE_DOC_DIR])
 
 # Snapshot current discovery artifacts to a temporary directory
-with tempfile.TemporaryDirectory() as tmpdirname:
-    shutil.copytree(DISCOVERY_DOC_DIR, tmpdirname, dirs_exist_ok=True)
+with tempfile.TemporaryDirectory() as current_discovery_doc_dir:
+    shutil.copytree(DISCOVERY_DOC_DIR, current_discovery_doc_dir, dirs_exist_ok=True)
 
     # Download discovery artifacts and generate documentation
     describe.generate_all_api_documents()
@@ -59,9 +59,12 @@
     all_changed_files = [os.path.basename(file_name) for file_name in git_diff_output.split('\n')]
     json_changed_files = [file for file in all_changed_files if file.endswith(".json")]
 
+    # Create temporary directory
+    os.mkdir(TEMP_DIR)
+
     # Analyze the changes in discovery artifacts using the changesummary module
-    changesummary.ChangeSummary(DISCOVERY_DOC_DIR, tmpdirname, json_changed_files).detect_discovery_changes()
+    changesummary.ChangeSummary(DISCOVERY_DOC_DIR, current_discovery_doc_dir, TEMP_DIR, json_changed_files).detect_discovery_changes()
 
     # Write a list of the files changed to a file called `changed files` which will be used in the `createcommits.sh` script.
-    with open(os.path.join("temp", "changed_files"), "w") as f:
+    with open(os.path.join(TEMP_DIR, "changed_files"), "w") as f:
         f.writelines('\n'.join(all_changed_files))