Work on issues #90, #46, #101.

Many changes.  Nostests don't work.  In-process check-in so others can review.

Author: adobeDan

docs/success-guide/setup_config_files.md

@@ -121,8 +121,8 @@ Limits on deletion prevent accidental account deletion in the event of misconfig
 ☐ If you expect the number of directory users to drop by more than 200 between User Sync runs, then you will need to raise the max\_missing\_users value.  These config file entries are to prevent runaway deletion in case of misconfiguration or other problems.
 
 	limits:
-	    max_deletions_per_run: 10   # ceiling on disable/remove/delete
-	    max_missing_users: 200      # abort if this many directory users disappear
+	    max_strays_to_process: 10   # ceiling on disable/remove/delete
+	    max_strays_hard_limit: 200      # abort if this many directory users disappear
 
 
 

docs/user-manual/index.md

@@ -561,13 +561,13 @@ groups:
 User accounts are removed from the Adobe dashboard when
 corresponding users are not present in the directory and the tool
 is invoked with the `--remove-nonexistent-users` option. The
-`max_deletions_per_run` and `max_missing_users` values in
+`max_strays_to_process` and `max_strays_hard_limit` values in
 the `limits` section of the configuration file set limits on
 how many users can be removed at any one time. These limits
 prevent accidental removal of a large number of accounts in case
 of misconfiguration or other errors:
 
-- The value of `max_deletions_per_run` sets a limit on the number
+- The value of `max_strays_to_process` sets a limit on the number
 of account removals in a single run. If more users are flagged
 for removal, they are left for the next run.
 
@@ -577,7 +577,7 @@ raise this value.
 - If your organization has a large number of users in the
 enterprise directory and the number of users read during a sync
 is suddenly small, this could indicate a misconfiguration or
-error situation.  The value of `max_missing_users` is a threshold
+error situation.  The value of `max_strays_hard_limit` is a threshold
 which causes the run to exit and report an error if there are
 this many fewer users in the enterprise directory than in the
 Adobe admin console.
@@ -589,8 +589,8 @@ For example:
 
 ```YAML
 limits:
-  max_deletions_per_run: 10
-  max_missing_users: 200
+  max_strays_to_process: 10
+  max_strays_hard_limit: 200
 ```
 
 This configuration causes User Sync to remove no more than 10
@@ -693,8 +693,8 @@ directory:
         - "Default Adobe Enterprise Support Program configuration"
 
 limits:
-  max_deletions_per_run: 10
-  max_missing_users: 200
+  max_strays_to_process: 10
+  max_strays_hard_limit: 200
 
 logging:
   log_to_file: True

examples/config files - basic/1 user-sync-config.yml

@@ -87,9 +87,14 @@ directory:
   #   - enterpriseID
   #   - federatedID
 
-limits:
-    max_deletions_per_run: 10    # if --remove-nonexistent-users is specified, this is the most users that will be removed.  Others will be left for a later run.  A critical message will be logged.
-    max_missing_users: 200       # if more than this number of user accounts are not found in the directory, user sync will abort with an error and a critical message will be logged.
+limits:   # provide processing controls over stray Adobe users (that is, that are unmatched on customer side)
+          # these controls only apply when strays are being processed for removal or deletion from the Adobe side;
+          # if strays are just being output to a file for later processing, these settings do not apply.
+    max_strays_hard_limit: 200   # If more than this many stray users are found, no processing of them is done.
+                                 # Instead, user sync will abort at the point it would remove or delete them.
+    max_strays_to_process: 10    # If more than this many stray users are found, only this many of them will be
+                                 # removed or deleted, and the the run will terminate normally.  Later runs
+                                 # can be used to process the next batch of them.
 
 logging:
   # specifies whether you wish to generate a log file

examples/config files - custom attributes and mappings/1 user-sync-config.yml

@@ -122,8 +122,8 @@ extensions:
         target_groups.add('Company 2 Users')
 
 limits:
-    max_deletions_per_run: 10    # if --remove-nonexistent-users is specified, this is the most users that will be removed.  Others will be left for a later run.  A critical message will be logged.
-    max_missing_users: 200       # if more than this number of user accounts are not found in the directory, user sync will abort with an error and a critical message will be logged.
+    max_strays_to_process: 10    # if --remove-nonexistent-users is specified, this is the most users that will be removed.  Others will be left for a later run.  A critical message will be logged.
+    max_strays_hard_limit: 200       # if more than this number of user accounts are not found in the directory, user sync will abort with an error and a critical message will be logged.
 
 logging:
   # specifies whether you wish to generate a log file

tests/config_test.py

@@ -99,22 +99,21 @@ def test_get_rule_options(self, mock_id_type,mock_get_dict,mock_get_list,mock_ge
         expected = {
             'after_mapping_hook': None,
             'default_country_code': 'test',
-            'delete_list_output_path': None,
-            'delete_nonexistent_users': False,
-            'delete_user_key_list': None,
+            'delete_strays': False,
             'directory_group_filter': None,
             'directory_group_mapped': False,
+            'disentitle_strays': False,
             'exclude_groups': [],
             'exclude_identity_types': [],
             'exclude_users': [],
             'extended_attributes': None,
             'manage_groups': False,
-            'max_deletions_per_run': 1,
-            'max_missing_users': 1,
+            'max_strays_hard_limit': 1,
+            'max_strays_to_process': 1,
             'new_account_type': 'new_acc',
-            'remove_list_output_path': None,
-            'remove_nonexistent_users': False,
-            'remove_user_key_list': None,
+            'remove_strays': False,
+            'stray_key_list': None,
+            'stray_list_output_path': None,
             'update_user_info': True,
             'username_filter_regex': None,
         }

tests/connector/directory_csv_test.py

@@ -11,7 +11,7 @@ class CSVDirectoryTest(unittest.TestCase):
     def test_normal(self):
         _, file_path = tempfile.mkstemp(".csv")
 
-        field_names = ['firstname', 'lastname', 'email', 'country', 'groups']
+        field_names = ['identity_type', 'firstname', 'lastname', 'email', 'country', 'groups']
         user1 = tests.helper.create_test_user(['Acrobat1', 'Acrobat2'])
         user2 = tests.helper.create_test_user([])
 

tests/helper.py

@@ -42,6 +42,7 @@ def create_test_user(groups):
     firstName = 'User_%d' % next_user_id
     next_user_id += 1    
     user = {
+        'identity_type': 'enterpriseID',
         'firstname': firstName,
         'lastname': 'Test',
         'email': '%s_email@example.com' % firstName,