Updating Sync Strategy

Updated comments

Updated comments

Author: Rakshil Modi

awscli/customizations/s3/syncstrategy/nooverwrite.py

@@ -1,4 +1,4 @@
-# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"). You
 # may not use this file except in compliance with the License. A copy of
@@ -27,19 +27,19 @@ class NoOverwriteSync(BaseSync):
 
     ARGUMENT = NO_OVERWRITE
 
+    def __init__(self, sync_type='file_not_at_dest'):
+        super().__init__(sync_type)
+
     def determine_should_sync(self, src_file, dest_file):
-        if not dest_file:
-            # Sync if file does not exist at destination
-            return True
-        elif src_file.compare_key != dest_file.compare_key:
-            # Sync if file exists at both source and destination but the
-            # source file's key is different than the destination file's key
+        if self.sync_type == 'file_not_at_dest':
+            LOG.debug(
+                f"syncing: {src_file.src} -> {src_file.dest}, file does not exist at destination"
+            )
             return True
-        else:
-            # Skip if file exists at both source and destination
+        elif self.sync_type == 'file_at_src_and_dest':
+            # Files exist at both locations must not be synced
             LOG.debug(
-                "Warning: Skipping file %s as it already exists on %s",
-                src_file.src,
-                src_file.dest,
+                f"warning: skipping {src_file.src} -> {src_file.dest}, file exists at destination"
             )
             return False
+        return False

awscli/customizations/s3/syncstrategy/register.py

@@ -50,6 +50,7 @@ def register_sync_strategies(command_table, session, **kwargs):
     register_sync_strategy(session, DeleteSync, 'file_not_at_src')
 
     # Register the noOverwrite sync strategy
+    register_sync_strategy(session, NoOverwriteSync, 'file_not_at_dest')
     register_sync_strategy(session, NoOverwriteSync, 'file_at_src_and_dest')
 
     # Register additional sync strategies here...

tests/unit/customizations/s3/syncstrategy/test_nooverwrite.py

@@ -1,4 +1,4 @@
-# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"). You
 # may not use this file except in compliance with the License. A copy of
@@ -12,99 +12,85 @@
 # language governing permissions and limitations under the License.
 import datetime
 
+import pytest
+
 from awscli.customizations.s3.filegenerator import FileStat
 from awscli.customizations.s3.syncstrategy.nooverwrite import NoOverwriteSync
-from awscli.testutils import unittest
 
 
-class TestNoOverwriteSync(unittest.TestCase):
-    def setUp(self):
-        self.sync_strategy = NoOverwriteSync()
+@pytest.fixture
+def sync_strategy():
+    return NoOverwriteSync()
+
 
-    def test_file_does_not_exist_at_destination(self):
-        """
-        Confirms that files are synced when not present at destination.
-        """
-        time_src = datetime.datetime.now()
+def test_file_does_not_exist_at_destination(sync_strategy):
+    time_src = datetime.datetime.now()
 
-        src_file = FileStat(
-            src='',
-            dest='',
-            compare_key='test.py',
-            size=10,
-            last_update=time_src,
-            src_type='s3',
-            dest_type='local',
-            operation_name='download',
-        )
-        dest_file = None
-        should_sync = self.sync_strategy.determine_should_sync(
-            src_file, dest_file
-        )
-        self.assertTrue(should_sync)
+    src_file = FileStat(
+        src='',
+        dest='',
+        compare_key='test.py',
+        size=10,
+        last_update=time_src,
+        src_type='s3',
+        dest_type='local',
+        operation_name='download',
+    )
+    dest_file = None
+    should_sync = sync_strategy.determine_should_sync(src_file, dest_file)
+    assert should_sync
 
-    def test_file_exists_at_destination_with_different_key(self):
-        """
-        Confirms that files are synced when key differs.
-        """
-        time_src = datetime.datetime.now()
 
-        src_file = FileStat(
-            src='',
-            dest='',
-            compare_key='test.py',
-            size=10,
-            last_update=time_src,
-            src_type='s3',
-            dest_type='s3',
-            operation_name='copy',
-        )
-        dest_file = FileStat(
-            src='',
-            dest='',
-            compare_key='test1.py',
-            size=100,
-            last_update=time_src,
-            src_type='s3',
-            dest_type='s3',
-            operation_name='',
-        )
-        should_sync = self.sync_strategy.determine_should_sync(
-            src_file, dest_file
-        )
-        self.assertTrue(should_sync)
+def test_file_exists_at_destination_with_different_key(sync_strategy):
+    time_src = datetime.datetime.now()
 
-    def test_file_exists_at_destination_with_same_key(self):
-        """
-        Confirm that files with the same key are not synced.
-        """
-        time_src = datetime.datetime.now()
+    src_file = FileStat(
+        src='',
+        dest='',
+        compare_key='test.py',
+        size=10,
+        last_update=time_src,
+        src_type='s3',
+        dest_type='s3',
+        operation_name='copy',
+    )
+    dest_file = FileStat(
+        src='',
+        dest='',
+        compare_key='test1.py',
+        size=100,
+        last_update=time_src,
+        src_type='s3',
+        dest_type='s3',
+        operation_name='',
+    )
+    should_sync = sync_strategy.determine_should_sync(src_file, dest_file)
+    assert should_sync
 
-        src_file = FileStat(
-            src='',
-            dest='',
-            compare_key='test.py',
-            size=10,
-            last_update=time_src,
-            src_type='local',
-            dest_type='s3',
-            operation_name='upload',
-        )
-        dest_file = FileStat(
-            src='',
-            dest='',
-            compare_key='test.py',
-            size=100,
-            last_update=time_src,
-            src_type='local',
-            dest_type='s3',
-            operation_name='',
-        )
-        should_sync = self.sync_strategy.determine_should_sync(
-            src_file, dest_file
-        )
-        self.assertFalse(should_sync)
 
+def test_file_exists_at_destination_with_same_key():
+    sync_strategy = NoOverwriteSync('file_at_src_and_dest')
+    time_src = datetime.datetime.now()
 
-if __name__ == "__main__":
-    unittest.main()
+    src_file = FileStat(
+        src='',
+        dest='',
+        compare_key='test.py',
+        size=10,
+        last_update=time_src,
+        src_type='local',
+        dest_type='s3',
+        operation_name='upload',
+    )
+    dest_file = FileStat(
+        src='',
+        dest='',
+        compare_key='test.py',
+        size=100,
+        last_update=time_src,
+        src_type='local',
+        dest_type='s3',
+        operation_name='',
+    )
+    should_sync = sync_strategy.determine_should_sync(src_file, dest_file)
+    assert not should_sync