FileManager: unmanage a file now also unmanages its children

Author: agarny

src/file/filemanager.cpp

@@ -19,6 +19,7 @@ limitations under the License.
 #include "utils.h"
 
 #include <algorithm>
+#include <stack>
 
 namespace libOpenCOR {
 
@@ -36,10 +37,33 @@ void FileManager::Impl::manage(File *pFile)
 
 void FileManager::Impl::unmanage(File *pFile)
 {
-    auto iter = std::ranges::find(mFiles, pFile);
+    // Iteratively unmanage the file and all its child files.
+    // Note: it would be much simpler to use recursion, but Clang-Tidy does not like it.
 
-    if (iter != mFiles.cend()) {
-        mFiles.erase(iter);
+    std::stack<File *> files;
+
+    files.push(pFile);
+
+    while (!files.empty()) {
+        // Retrieve the file at the top of the stack.
+
+        File *file = files.top();
+
+        files.pop();
+
+        // Add the child files to the stack.
+
+        for (const auto &childFile : file->childFiles()) {
+            files.push(childFile.get());
+        }
+
+        // Unmanage the current file.
+
+        auto iter = std::ranges::find(mFiles, file);
+
+        if (iter != mFiles.cend()) {
+            mFiles.erase(iter);
+        }
     }
 }
 

tests/api/file/coveragetests.cpp

@@ -71,3 +71,15 @@ TEST(CoverageFileTest, doNotRetrieveContents)
     EXPECT_EQ(file->type(), libOpenCOR::File::Type::UNKNOWN_FILE);
     EXPECT_EQ(file->contents(), libOpenCOR::UnsignedChars());
 }
+
+TEST(CoverageFileTest, unmanageFileWithChildren)
+{
+    auto file = libOpenCOR::File::create(libOpenCOR::resourcePath(libOpenCOR::COMBINE_2_ARCHIVE));
+    auto fileManager = libOpenCOR::FileManager::instance();
+
+    EXPECT_EQ(fileManager.fileCount(), 3);
+
+    fileManager.unmanage(file);
+
+    EXPECT_EQ(fileManager.fileCount(), 0);
+}

tests/bindings/javascript/file.coverage.test.js

@@ -21,16 +21,22 @@ const libopencor = await libOpenCOR();
 
 describe("File coverage tests", () => {
   let someNullCharacterContentsPtr;
+  let someCombineArchiveContentsPtr;
 
   beforeAll(() => {
     someNullCharacterContentsPtr = utils.allocateMemory(
       libopencor,
       utils.SOME_NULL_CHARACTER_CONTENTS,
     );
+    someCombineArchiveContentsPtr = utils.allocateMemory(
+      libopencor,
+      utils.SOME_COMBINE_ARCHIVE_CONTENTS,
+    );
   });
 
   afterAll(() => {
     utils.freeMemory(libopencor, someNullCharacterContentsPtr);
+    utils.freeMemory(libopencor, someCombineArchiveContentsPtr);
   });
 
   test("Empty file", () => {
@@ -84,4 +90,20 @@ describe("File coverage tests", () => {
     file1.delete();
     file2.delete();
   });
+
+  test("Unmanage file with children", () => {
+    const file = new libopencor.File(utils.resourcePath(utils.COMBINE_ARCHIVE));
+    const fileManager = libopencor.FileManager.instance();
+
+    file.setContents(
+      someCombineArchiveContentsPtr,
+      utils.SOME_COMBINE_ARCHIVE_CONTENTS.length,
+    );
+
+    expect(fileManager.fileCount()).toBe(4);
+
+    fileManager.unmanage(file);
+
+    expect(fileManager.fileCount()).toBe(1);
+  });
 });

tests/bindings/python/test_file_coverage.py

@@ -62,3 +62,14 @@ def test_do_not_retrieve_contents():
 
     assert file.type == oc.File.Type.UnknownFile
     assert file.contents == []
+
+
+def test_unmanage_file_with_children():
+    file = oc.File(utils.resource_path(utils.Combine2Archive))
+    file_manager = oc.FileManager.instance()
+
+    assert file_manager.file_count == 3
+
+    file_manager.unmanage(file)
+
+    assert file_manager.file_count == 0