Update PR

* Update PR

Author: abraunegg

docs/end_to_end_testing.md

@@ -2,7 +2,7 @@
 
 Placeholder document that will detail all test cases and coverage
 
-| <div style="width: 110px;">Test Case</div> | Description | Details |
+| Test Case | Description | Details |
 |:---|:---|:---|
 | 0001 | Basic Resync | - validate that the E2E framework can invoke the client<br> - validate that the configured environment is sufficient to run a basic sync<br> - provide a simple baseline smoke test before more advanced E2E scenarios |
 | 0002 | 'sync_list' Validation | This validates sync_list as a policy-conformance test.<br><br>The test is considered successful when all observed sync operations involving the fixture tree match the active sync_list rules.<br><br>This test covers exclusions, inclusions, wildcard and globbing for paths and files. Specific 'sync_list' test coverage is as follows:<br>- Scenario SL-0001: root directory include with trailing slash<br>- Scenario SL-0002: root include without trailing slash<br>- Scenario SL-0003: non-root include by name<br>- Scenario SL-0004: include tree with nested exclusion<br>- Scenario SL-0005: included tree with hidden directory excluded<br>- Scenario SL-0006: file-specific include inside named directory<br>- Scenario SL-0007: rooted include of Programming tree<br>- Scenario SL-0008: exclude Android recursive build output and include Programming<br>- Scenario SL-0009: exclude Android recursive .cxx content and include Programming<br>- Scenario SL-0010: exclude Web recursive build output and include Programming<br>- Scenario SL-0011: exclude .gradle anywhere and include Programming<br>- Scenario SL-0012: exclude build/kotlin anywhere and include Programming<br>- Scenario SL-0013: exclude .venv and venv anywhere and include Programming<br>- Scenario SL-0014: exclude common cache and vendor directories and include Programming<br>- Scenario SL-0015: complex style Programming ruleset<br>- Scenario SL-0016: massive mixed rule set across Programming Documents and Work<br>- Scenario SL-0017: stress test kitchen sink rule set with broad include and targeted file include<br>- Scenario SL-0018: exact trailing slash configuration with cleanup validation<br>- Scenario SL-0019: no trailing slash workaround with cleanup validation<br>- Scenario SL-0020: focused trailing slash Projects regression for sibling path survival<br>- Scenario SL-0021: focused no trailing slash Projects regression for sibling path survival<br> |

src/sync.d

@@ -7871,49 +7871,101 @@ class SyncEngine {
 							// Resolve 'Directory not empty' error when deleting local files
 							try {
 								auto directoryEntries = dirEntries(path, SpanMode.depth, false);
+								bool pathShouldBeRemoved;
+								
 								foreach (DirEntry child; directoryEntries) {
 									// set for error logging
 									currentPath = child.name;
-								
-									// what sort of child is this?
-									if (isDir(child.name)) {
-										addLogEntry("Removing local directory: " ~ child.name);
+									
+									// reset pathShouldBeRemoved
+									pathShouldBeRemoved = true;
+									
+									// Issue #3655: Deletion of local data where 'sync_list' is expecting this to be kept
+									// If we are in a --download-only --cleanup-local-files + using a 'sync_list' the expectation here is that matches to 'sync_list' inclusion are kept
+									// If we get to this point, we have already validated '--download-only --cleanup-local-files' so this is now just about 'sync_list' inclusion
+									
+									// Is 'sync_list' configured?
+									if (syncListConfigured) {
+										// Should this path be removed?
+										// selectiveSync.isPathExcludedViaSyncList() returns 'true' if the path is excluded, 'false' if the path is to be included
+										pathShouldBeRemoved = selectiveSync.isPathExcludedViaSyncList(child.name);
+									}
+									
+									// What action should be taken?
+									if (pathShouldBeRemoved) {
+										// Path should be removed
+										// what sort of child is this?
+										if (isDir(child.name)) {
+											addLogEntry("Removing local directory: " ~ child.name);
+										} else {
+											addLogEntry("Removing local file: " ~ child.name);
+										}
+										
+										// Are we in a --dry-run scenario?
+										if (!dryRun) {
+											// No --dry-run ... process local delete
+											if (exists(child)) {
+												try {
+													attrIsDir(child.linkAttributes) ? rmdir(child.name) : safeRemove(child.name);
+												} catch (FileException e) {
+													// display the error message
+													displayFileSystemErrorMessage(e.msg, thisFunctionName, currentPath);
+												}
+											}
+										}
 									} else {
-										addLogEntry("Removing local file: " ~ child.name);
+										// Path should be retained
+										// what sort of child is this?
+										if (isDir(child.name)) {
+											addLogEntry("Local directory should be retained due to 'sync_list' inclusion: " ~ child.name);
+										} else {
+											addLogEntry("Local file should be retained due to 'sync_list' inclusion: " ~ child.name);
+										}
 									}
 
+								
+									
+									
+									
+								}
+								// Clear directoryEntries
+								object.destroy(directoryEntries);
+								
+								bool parentalPathShouldBeRemoved = true;
+								
+								// Is 'sync_list' configured?
+								if (syncListConfigured) {
+									parentalPathShouldBeRemoved = selectiveSync.isPathExcludedViaSyncList(path);
+								}
+								
+								// What action should be taken?
+								if (parentalPathShouldBeRemoved) {
+								
+									// Remove the parental path now that it is empty of children
+									addLogEntry("Removing local directory: " ~ path);
 									// are we in a --dry-run scenario?
 									if (!dryRun) {
 										// No --dry-run ... process local delete
-										if (exists(child)) {
+										if (exists(path)) {
+										
 											try {
-												attrIsDir(child.linkAttributes) ? rmdir(child.name) : safeRemove(child.name);
+												rmdirRecurse(path);
 											} catch (FileException e) {
 												// display the error message
-												displayFileSystemErrorMessage(e.msg, thisFunctionName, currentPath);
+												displayFileSystemErrorMessage(e.msg, thisFunctionName, path);
 											}
+											
 										}
 									}
-								}
-								// Clear directoryEntries
-								object.destroy(directoryEntries);
+								} else {
+									// Path needs to be retained
+									addLogEntry("Local directory should be retained due to 'sync_list' inclusion: " ~ path);
+								
+								
 
-								// Remove the path now that it is empty of children
-								addLogEntry("Removing local directory: " ~ path);
-								// are we in a --dry-run scenario?
-								if (!dryRun) {
-									// No --dry-run ... process local delete
-									if (exists(path)) {
-									
-										try {
-											rmdirRecurse(path);
-										} catch (FileException e) {
-											// display the error message
-											displayFileSystemErrorMessage(e.msg, thisFunctionName, path);
-										}
-										
-									}
 								}
+								
+								
 							} catch (FileException e) {
 								// display the error message
 								displayFileSystemErrorMessage(e.msg, thisFunctionName, currentPath);