refactor: move tmp dir creation/deletion into own file

Author: christiansiegel

gitopscli/cliparser.py

@@ -1,7 +1,7 @@
 import argparse
 import sys
 
-from gitopscli.yaml.yaml_util import yaml_load
+from gitopscli.io.yaml_util import yaml_load
 
 
 def create_cli(args):

gitopscli/commands/create_preview.py

@@ -5,8 +5,9 @@
 import uuid
 
 from gitopscli.git.create_git import create_git
-from gitopscli.yaml.gitops_config import GitOpsConfig
-from gitopscli.yaml.yaml_util import update_yaml_file
+from gitopscli.io.gitops_config import GitOpsConfig
+from gitopscli.io.yaml_util import update_yaml_file
+from gitopscli.io.tmp_dir import create_tmp_dir, delete_tmp_dir
 from gitopscli.gitops_exception import GitOpsException
 
 # pylint: disable=too-many-statements
@@ -29,8 +30,8 @@ def create_preview_command(
 ):
     assert command == "create-preview"
 
-    apps_tmp_dir = __create_tmp_dir()
-    root_tmp_dir = __create_tmp_dir()
+    apps_tmp_dir = create_tmp_dir()
+    root_tmp_dir = create_tmp_dir()
 
     try:
         apps_git = create_git(
@@ -127,8 +128,8 @@ def create_preview_command(
         logging.info("Creating PullRequest comment for pr with id %s and content: %s", pr_id, pr_comment_text)
         apps_git.add_pull_request_comment(pr_id, pr_comment_text, parent_id)
     finally:
-        shutil.rmtree(apps_tmp_dir, ignore_errors=True)
-        shutil.rmtree(root_tmp_dir, ignore_errors=True)
+        delete_tmp_dir(apps_tmp_dir)
+        delete_tmp_dir(root_tmp_dir)
     if create_pr:
         pull_request = __create_pullrequest(config_branch, gitops_config, root_git)
         if auto_merge:
@@ -207,10 +208,3 @@ def __merge_pullrequest(branch, pull_request, root_git):
     logging.info("Pull request merged")
     root_git.delete_branch(branch)
     logging.info("Branch '%s' deleted", branch)
-
-
-def __create_tmp_dir():
-    tmp_dir = f"/tmp/gitopscli/{uuid.uuid4()}"
-    os.makedirs(tmp_dir)
-    logging.info("Created directory %s", tmp_dir)
-    return tmp_dir

gitopscli/commands/delete_preview.py

@@ -1,11 +1,12 @@
 import hashlib
 import logging
 import os
-import shutil
 import uuid
+import shutil
 
 from gitopscli.git.create_git import create_git
-from gitopscli.yaml.gitops_config import GitOpsConfig
+from gitopscli.io.gitops_config import GitOpsConfig
+from gitopscli.io.tmp_dir import create_tmp_dir, delete_tmp_dir
 from gitopscli.gitops_exception import GitOpsException
 
 
@@ -25,8 +26,8 @@ def delete_preview_command(
 ):
     assert command == "delete-preview"
 
-    apps_tmp_dir = __create_tmp_dir()
-    root_tmp_dir = __create_tmp_dir()
+    apps_tmp_dir = create_tmp_dir()
+    root_tmp_dir = create_tmp_dir()
 
     try:
         apps_git = create_git(
@@ -79,8 +80,8 @@ def delete_preview_command(
         logging.info("Pushed branch %s", config_branch)
 
     finally:
-        shutil.rmtree(apps_tmp_dir, ignore_errors=True)
-        shutil.rmtree(root_tmp_dir, ignore_errors=True)
+        delete_tmp_dir(apps_tmp_dir)
+        delete_tmp_dir(root_tmp_dir)
     if create_pr:
         pull_request = __create_pullrequest(config_branch, gitops_config, root_git)
         if auto_merge:
@@ -102,10 +103,3 @@ def __merge_pullrequest(branch, pull_request, root_git):
     logging.info("Pull request merged")
     root_git.delete_branch(branch)
     logging.info("Branch '%s' deleted", branch)
-
-
-def __create_tmp_dir():
-    tmp_dir = f"/tmp/gitopscli/{uuid.uuid4()}"
-    os.makedirs(tmp_dir)
-    logging.info("Created directory %s", tmp_dir)
-    return tmp_dir

gitopscli/commands/deploy.py

@@ -1,10 +1,10 @@
 import logging
 import os
-import shutil
 import uuid
 
 from gitopscli.git.create_git import create_git
-from gitopscli.yaml.yaml_util import update_yaml_file, yaml_dump
+from gitopscli.io.yaml_util import update_yaml_file, yaml_dump
+from gitopscli.io.tmp_dir import create_tmp_dir, delete_tmp_dir
 from gitopscli.gitops_exception import GitOpsException
 
 
@@ -26,9 +26,7 @@ def deploy_command(
 ):
     assert command == "deploy"
 
-    tmp_dir = f"/tmp/gitopscli/{uuid.uuid4()}"
-    os.makedirs(tmp_dir)
-    logging.info("Created directory %s", tmp_dir)
+    tmp_dir = create_tmp_dir()
 
     try:
         git = create_git(
@@ -59,7 +57,7 @@ def deploy_command(
         git.push(config_branch)
         logging.info("Pushed branch %s", config_branch)
     finally:
-        shutil.rmtree(tmp_dir, ignore_errors=True)
+        delete_tmp_dir(tmp_dir)
 
     if create_pr:
         __create_pr(git, config_branch, file, updated_values, auto_merge)

gitopscli/commands/sync_apps.py

@@ -1,12 +1,11 @@
 import logging
 import os
-import shutil
-import uuid
 
 from ruamel.yaml import YAML
 
 from gitopscli.git.create_git import create_git
-from gitopscli.yaml.yaml_util import merge_yaml_element
+from gitopscli.io.yaml_util import merge_yaml_element
+from gitopscli.io.tmp_dir import create_tmp_dir, delete_tmp_dir
 from gitopscli.gitops_exception import GitOpsException
 
 
@@ -25,12 +24,8 @@ def sync_apps_command(
 ):
     assert command == "sync-apps"
 
-    apps_tmp_dir = f"/tmp/gitopscli/{uuid.uuid4()}"
-    os.makedirs(apps_tmp_dir)
-    logging.info("Created directory %s", apps_tmp_dir)
-    root_tmp_dir = f"/tmp/gitopscli/{uuid.uuid4()}"
-    os.makedirs(root_tmp_dir)
-    logging.info("Created directory %s", root_tmp_dir)
+    apps_tmp_dir = create_tmp_dir()
+    root_tmp_dir = create_tmp_dir()
 
     try:
         apps_git = create_git(
@@ -58,8 +53,8 @@ def sync_apps_command(
 
         __sync_apps(apps_git, root_git)
     finally:
-        shutil.rmtree(apps_tmp_dir, ignore_errors=True)
-        shutil.rmtree(root_tmp_dir, ignore_errors=True)
+        delete_tmp_dir(apps_tmp_dir)
+        delete_tmp_dir(root_tmp_dir)
 
 
 def __sync_apps(apps_git, root_git):

gitopscli/yaml/__init__.py gitopscli/io/__init__.pygitopscli/yaml/__init__.py renamed to gitopscli/io/__init__.py

@@ -0,0 +1,13 @@
+import uuid
+import os
+import shutil
+
+
+def create_tmp_dir():
+    tmp_dir = f"/tmp/gitopscli/{uuid.uuid4()}"
+    os.makedirs(tmp_dir)
+    return tmp_dir
+
+
+def delete_tmp_dir(tmp_dir):
+    shutil.rmtree(tmp_dir, ignore_errors=True)

gitopscli/yaml/gitops_config.py gitopscli/io/gitops_config.pygitopscli/yaml/gitops_config.py renamed to gitopscli/io/gitops_config.py

@@ -1,5 +1,5 @@
 black==19.10b0
 pylint==2.4.4
-pytest==5.3.4
+pytest==5.4.2
 mkdocs==1.0.4
 mkdocs-material==4.6.3