[SHELL32_APITEST] Certainly close newly-opened windows (reactos#8171)

It's frustrating when windows open
during a test and remain after the test
is over.
JIRA issue: ROSTESTS-402
- Delete closewnd.cpp. Enhance
  closewnd.h.
- Modify ShellExecCmdLine,
  ShellExec_RunDLL, ShellExecuteEx,
  and ShellExecuteW testcases.
- Certainly close the newly-opened
  windows.

Author: katahiromz

modules/rostests/apitests/shell32/CMakeLists.txt

@@ -2,7 +2,6 @@
 spec2def(shell32_apitest.exe shell32_apitest.spec)
 
 list(APPEND SOURCE
-    closewnd.cpp
     AddCommas.cpp
     CFSFolder.cpp
     CheckEscapes.cpp

modules/rostests/apitests/shell32/RealShellExecuteEx.cpp

@@ -53,7 +53,10 @@ static void TEST_Start(void)
 
 static void TEST_End(void)
 {
-    Sleep(500);
+    // Execution can be asynchronous; you have to wait for it to finish.
+    Sleep(2000);
+
+    // Close newly-opened window(s)
     GetWindowList(&s_List2);
     CloseNewWindows(&s_List1, &s_List2);
     FreeWindowList(&s_List1);
@@ -62,8 +65,6 @@ static void TEST_End(void)
 
 static void TEST_RealShellExecuteExA(void)
 {
-    TEST_Start();
-
     INT_PTR ret;
 
     ret = (INT_PTR)s_fnRealShellExecuteExA(
@@ -82,14 +83,10 @@ static void TEST_RealShellExecuteExA(void)
         ok_long((LONG)ret, 42);
     else
         ok_long((LONG)ret, 2);
-
-    TEST_End();
 }
 
 static void TEST_RealShellExecuteExW(void)
 {
-    TEST_Start();
-
     INT_PTR ret;
 
     ret = (INT_PTR)s_fnRealShellExecuteExW(
@@ -105,8 +102,6 @@ static void TEST_RealShellExecuteExW(void)
         NULL,
         0);
     ok_long((LONG)ret, 42);
-
-    TEST_End();
 }
 
 START_TEST(RealShellExecuteEx)
@@ -129,8 +124,12 @@ START_TEST(RealShellExecuteEx)
         return;
     }
 
+    TEST_Start();
+
     TEST_RealShellExecuteExA();
     TEST_RealShellExecuteExW();
 
+    TEST_End();
+
     FreeLibrary(s_hSHELL32);
 }

modules/rostests/apitests/shell32/ShellExecCmdLine.cpp

@@ -9,6 +9,7 @@
 #include <strsafe.h>
 #include <versionhelpers.h>
 #include "shell32_apitest_sub.h"
+#include "closewnd.h"
 
 #define NDEBUG
 #include <debug.h>
@@ -549,46 +550,6 @@ static const TEST_ENTRY s_entries_2[] =
     { __LINE__, FALSE, TRUE, L"\"Test File 2.bat\" \"Test File.txt\"", s_cur_dir },
 };
 
-typedef struct OPENWNDS
-{
-    UINT count;
-    HWND *phwnd;
-} OPENWNDS;
-
-static OPENWNDS s_wi0 = { 0 }, s_wi1 = { 0 };
-
-static BOOL CALLBACK EnumWindowsProc(HWND hwnd, LPARAM lParam)
-{
-    OPENWNDS *info = (OPENWNDS *)lParam;
-    info->phwnd = (HWND *)realloc(info->phwnd, (info->count + 1) * sizeof(HWND));
-    if (!info->phwnd)
-        return FALSE;
-    info->phwnd[info->count] = hwnd;
-    ++(info->count);
-    return TRUE;
-}
-
-static void CleanupNewlyCreatedWindows(void)
-{
-    EnumWindows(EnumWindowsProc, (LPARAM)&s_wi1);
-    for (UINT i1 = 0; i1 < s_wi1.count; ++i1)
-    {
-        BOOL bFound = FALSE;
-        for (UINT i0 = 0; i0 < s_wi0.count; ++i0)
-        {
-            if (s_wi1.phwnd[i1] == s_wi0.phwnd[i0])
-            {
-                bFound = TRUE;
-                break;
-            }
-        }
-        if (!bFound)
-            PostMessageW(s_wi1.phwnd[i1], WM_CLOSE, 0, 0);
-    }
-    free(s_wi1.phwnd);
-    ZeroMemory(&s_wi1, sizeof(s_wi1));
-}
-
 static void DoEntry(const TEST_ENTRY *pEntry)
 {
     HRESULT hr;
@@ -626,8 +587,33 @@ static void DoEntry(const TEST_ENTRY *pEntry)
 
     ok(result == pEntry->result, "Line %d: result expected %d, was %d\n",
        pEntry->lineno, pEntry->result, result);
+}
+
+static WINDOW_LIST s_List1, s_List2;
+
+static VOID TEST_ShellExecCmdLine(VOID)
+{
+    GetWindowList(&s_List1);
 
-    CleanupNewlyCreatedWindows();
+    // do tests
+    for (size_t i = 0; i < _countof(s_entries_1); ++i)
+    {
+        DoEntry(&s_entries_1[i]);
+    }
+    SetEnvironmentVariableW(L"PATH", s_cur_dir);
+    for (size_t i = 0; i < _countof(s_entries_2); ++i)
+    {
+        DoEntry(&s_entries_2[i]);
+    }
+
+    // Execution can be asynchronous; you have to wait for it to finish.
+    Sleep(2000);
+
+    // Close newly-opened window(s)
+    GetWindowList(&s_List2);
+    CloseNewWindows(&s_List1, &s_List2);
+    FreeWindowList(&s_List1);
+    FreeWindowList(&s_List2);
 }
 
 START_TEST(ShellExecCmdLine)
@@ -657,22 +643,13 @@ START_TEST(ShellExecCmdLine)
         return;
     }
 
-    // record open windows
-    if (!EnumWindows(EnumWindowsProc, (LPARAM)&s_wi0))
-    {
-        skip("EnumWindows failed\n");
-        free(s_wi0.phwnd);
-        return;
-    }
-
     // s_win_test_exe
     GetWindowsDirectoryW(s_win_test_exe, _countof(s_win_test_exe));
     PathAppendW(s_win_test_exe, L"test program.exe");
     BOOL ret = CopyFileW(s_sub_program, s_win_test_exe, FALSE);
     if (!ret)
     {
         skip("Please retry with admin rights\n");
-        free(s_wi0.phwnd);
         return;
     }
 
@@ -700,27 +677,14 @@ START_TEST(ShellExecCmdLine)
     // s_cur_dir
     GetCurrentDirectoryW(_countof(s_cur_dir), s_cur_dir);
 
-    // do tests
-    for (size_t i = 0; i < _countof(s_entries_1); ++i)
-    {
-        DoEntry(&s_entries_1[i]);
-    }
-    SetEnvironmentVariableW(L"PATH", s_cur_dir);
-    for (size_t i = 0; i < _countof(s_entries_2); ++i)
-    {
-        DoEntry(&s_entries_2[i]);
-    }
+    TEST_ShellExecCmdLine();
 
-    Sleep(2000);
-    CleanupNewlyCreatedWindows();
+    // Some process can lock the file of s_win_test_exe
+    Sleep(1000);
 
     // clean up
     ok(DeleteFileW(s_win_test_exe), "failed to delete the test file\n");
     ok(DeleteFileW(s_sys_bat_file), "failed to delete the test file\n");
     ok(DeleteFileA("Test File 1.txt"), "failed to delete the test file\n");
     ok(DeleteFileA("Test File 2.bat"), "failed to delete the test file\n");
-    free(s_wi0.phwnd);
-
-    DoWaitForWindow(SUB_CLASSNAME, SUB_CLASSNAME, TRUE, TRUE);
-    Sleep(100);
 }

modules/rostests/apitests/shell32/ShellExec_RunDLL.cpp

@@ -26,36 +26,41 @@ static VOID TEST_ShellExec_RunDLLW(VOID)
     ShellExec_RunDLLW(NULL, NULL, L"?0?notepad.exe", SW_SHOWNORMAL);
 }
 
-static VOID CleanupWindowList(VOID)
+static BOOL CloseNotepad(VOID)
 {
-    GetWindowListForClose(&s_List2);
+    HWND hwndNew;
+    WCHAR szClass[64];
+
+    // Execution can be asynchronous; you have to wait for it to finish.
+    Sleep(1000);
+
+    // Close newly-opened window(s)
+    GetWindowList(&s_List2);
+    hwndNew = FindNewWindow(&s_List1, &s_List2);
+    if (!GetClassNameW(hwndNew, szClass, _countof(szClass)))
+        szClass[0] = UNICODE_NULL;
     CloseNewWindows(&s_List1, &s_List2);
     FreeWindowList(&s_List1);
     FreeWindowList(&s_List2);
+    return lstrcmpiW(szClass, L"Notepad") == 0;
 }
 
 START_TEST(ShellExec_RunDLL)
 {
-    HWND hwndNotepad;
+    BOOL ret;
 
     GetWindowList(&s_List1);
     TEST_ShellExec_RunDLL();
-    Sleep(1000);
-    hwndNotepad = FindWindowW(L"Notepad", NULL);
-    ok(hwndNotepad != NULL, "Notepad not found\n");
-    CleanupWindowList();
+    ret = CloseNotepad();
+    ok(ret, "Notepad not found\n");
 
     GetWindowList(&s_List1);
     TEST_ShellExec_RunDLLA();
-    Sleep(1000);
-    hwndNotepad = FindWindowW(L"Notepad", NULL);
-    ok(hwndNotepad != NULL, "Notepad not found\n");
-    CleanupWindowList();
+    ret = CloseNotepad();
+    ok(ret, "Notepad not found\n");
 
     GetWindowList(&s_List1);
     TEST_ShellExec_RunDLLW();
-    Sleep(1000);
-    hwndNotepad = FindWindowW(L"Notepad", NULL);
-    ok(hwndNotepad != NULL, "Notepad not found\n");
-    CleanupWindowList();
+    ret = CloseNotepad();
+    ok(ret, "Notepad not found\n");
 }

modules/rostests/apitests/shell32/ShellExecuteEx.cpp

@@ -314,17 +314,30 @@ static BOOL TEST_Start(void)
 
 static void TEST_End(void)
 {
-    GetWindowListForClose(&s_List2);
-    CloseNewWindows(&s_List1, &s_List2);
-    FreeWindowList(&s_List1);
-    FreeWindowList(&s_List2);
-
     DeleteFileW(s_win_test_exe);
     DeleteFileW(s_sys_test_exe);
     DeleteFileW(s_win_txt_file);
     DeleteFileW(s_sys_txt_file);
     DeleteFileW(s_win_bat_file);
     DeleteFileW(s_sys_bat_file);
+
+    // Execution can be asynchronous; you have to wait for it to finish.
+    INT nCount = GetWindowCount();
+    for (INT i = 0; i < 100; ++i)
+    {
+        INT nOldCount = nCount;
+        Sleep(3000);
+        nCount = GetWindowCount();
+        if (nOldCount == nCount)
+            break;
+    }
+    Sleep(3000);
+
+    // Close newly-opened window(s)
+    GetWindowList(&s_List2);
+    CloseNewWindows(&s_List1, &s_List2);
+    FreeWindowList(&s_List1);
+    FreeWindowList(&s_List2);
 }
 
 static void test_properties()