Merge pull request #187 from menkej/empty-folders

Empty folders are no longer created when only printing filenames.

Author: menkej

icloudpd/base.py

@@ -403,13 +403,6 @@ def download_photo(counter, photo):
             date_path = folder_structure.format(created_date)
 
         download_dir = os.path.normpath(os.path.join(directory, date_path))
-
-        if not os.path.exists(download_dir):
-            try:
-                os.makedirs(download_dir)
-            except OSError:  # pragma: no cover
-                pass        # pragma: no cover
-
         download_size = size
 
         try:

icloudpd/download.py

@@ -36,6 +36,15 @@ def download_media(icloud, photo, download_path, size):
     """Download the photo to path, with retries and error handling"""
     logger = setup_logger()
 
+    # get back the directory for the file to be downloaded and create it if not there already
+    download_dir = os.path.dirname(download_path)
+
+    if not os.path.exists(download_dir):
+        try:
+            os.makedirs(download_dir)
+        except OSError:  # pragma: no cover
+            pass         # pragma: no cover
+
     for retries in range(constants.MAX_RETRIES):
         try:
             photo_response = photo.download(size)

scripts/run_all_checks

@@ -1,5 +1,11 @@
 #!/bin/bash
 set -euo pipefail
+
+# realpath not availabe on Mac by default...
+realpath() {
+    [[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
+}
+
 CURRENT_DIR=$(dirname "$0")
 ROOT_DIR="$(realpath $(dirname "$0")/..)"
 

scripts/test

@@ -1,5 +1,11 @@
 #!/bin/bash
 set -euo pipefail
+
+# realpath not availabe on Mac by default...
+realpath() {
+    [[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
+}
+
 CURRENT_DIR=$(dirname "$0")
 ROOT_DIR="$(realpath $(dirname "$0")/..)"
 

tests/test_listing_recent_photos.py

@@ -1,17 +1,17 @@
 from unittest import TestCase
-from vcr import VCR
 import os
 import shutil
-import click
-from click.testing import CliRunner
 import json
 import mock
+from vcr import VCR
+from click.testing import CliRunner
 from icloudpd.base import main
 from tests.helpers.print_result_exception import print_result_exception
 
 vcr = VCR(decode_compressed_response=True)
 
 class ListingRecentPhotosTestCase(TestCase):
+
     def test_listing_recent_photos(self):
         base_dir = os.path.normpath("tests/fixtures/Photos")
         if os.path.exists(base_dir):
@@ -69,6 +69,45 @@ def test_listing_recent_photos(self):
                 os.path.join(base_dir, os.path.normpath("2018/07/30/IMG_7404.MOV")), filenames[7]
             )
 
+            assert result.exit_code == 0
+
+    def test_listing_photos_does_not_create_folders(self):
+        base_dir = os.path.normpath("tests/fixtures/Photos")
+        if os.path.exists(base_dir):
+            shutil.rmtree(base_dir)
+        os.makedirs(base_dir)
+
+        # make sure the directory does not exist yet.
+        # Should only be created after download, not after just --print-filenames
+        self.assertFalse(os.path.exists(os.path.join(base_dir, os.path.normpath("2018/07/31"))))
+
+        # Note - This test uses the same cassette as test_download_photos.py
+        with vcr.use_cassette("tests/vcr_cassettes/listing_photos.yml"):
+            # Pass fixed client ID via environment variable
+            os.environ["CLIENT_ID"] = "DE309E26-942E-11E8-92F5-14109FE0B321"
+            runner = CliRunner()
+            result = runner.invoke(
+                main,
+                [
+                    "--username",
+                    "jdoe@gmail.com",
+                    "--password",
+                    "password1",
+                    "--recent",
+                    "5",
+                    "--only-print-filenames",
+                    "--no-progress-bar",
+                    "--threads-num",
+                    1,
+                    "-d",
+                    base_dir,
+                ],
+            )
+            print_result_exception(result)
+            # make sure the directory still does not exist.
+            # Should only be created after download, not after just --print-filenames
+            self.assertFalse(
+                os.path.exists(os.path.join(base_dir, os.path.normpath("2018/07/31"))))
 
             assert result.exit_code == 0
 
@@ -110,19 +149,24 @@ def test_listing_recent_photos_with_missing_filenameEnc(self):
 
                     # self.assertEqual(len(filenames), 5)
                     self.assertEqual(
-                        os.path.join(base_dir, os.path.normpath("2018/07/31/AY6c_BsE0jja.JPG")), filenames[0]
+                        os.path.join(base_dir, os.path.normpath("2018/07/31/AY6c_BsE0jja.JPG")),
+                        filenames[0]
                     )
                     self.assertEqual(
-                        os.path.join(base_dir, os.path.normpath("2018/07/31/AY6c_BsE0jja.MOV")), filenames[1]
+                        os.path.join(base_dir, os.path.normpath("2018/07/31/AY6c_BsE0jja.MOV")),
+                        filenames[1]
                     )
                     self.assertEqual(
-                        os.path.join(base_dir, os.path.normpath("2018/07/30/IMG_7408.JPG")), filenames[2]
+                        os.path.join(base_dir, os.path.normpath("2018/07/30/IMG_7408.JPG")),
+                        filenames[2]
                     )
                     self.assertEqual(
-                        os.path.join(base_dir, os.path.normpath("2018/07/30/IMG_7408.MOV")), filenames[3]
+                        os.path.join(base_dir, os.path.normpath("2018/07/30/IMG_7408.MOV")),
+                        filenames[3]
                     )
                     self.assertEqual(
-                        os.path.join(base_dir, os.path.normpath("2018/07/30/AZ_wAGT9P6jh.JPG")), filenames[4]
+                        os.path.join(base_dir, os.path.normpath("2018/07/30/AZ_wAGT9P6jh.JPG")),
+                        filenames[4]
                     )
                     assert result.exit_code == 0
 
@@ -186,5 +230,4 @@ def test_listing_recent_photos_with_missing_downloadURL(self):
                     self.assertEqual(
                         first_arg['asset_record']['fields']['assetDate']['value'],
                         1533021744816)
-                    assert result.exit_code == 0
-
+                    assert result.exit_code == 0