Modified tests that starts processes to use the new console attribute set to false to prevent window flicker while running tests.

Modified tests that started/killed notepad.exe to use calc.exe instead. This change prevents killing potentially open/unsaved documents.

Author: end2endzone

src/tests/CMakeLists.txt

@@ -149,7 +149,7 @@ add_executable(sa.tests
 
 # Group external files as filter for Visual Studio
 source_group("Test Data Files"          FILES ${CONFIGURATION_TEST_FILES})
-source_group("Test Source Files"        FILES ${HEADER_AND_SOURCE_TEST_FILES})
+source_group("Test Source Files"        FILES ${HEADER_AND_SOURCE_TEST_FILES} ${PLUGINS_TEST_FILES})
 
 # Unit test projects requires to link with pthread if also linking with gtest
 if(NOT WIN32)

src/tests/TestActionExecute.cpp

@@ -38,6 +38,7 @@
 #include "rapidassist/environment.h"
 #include "rapidassist/process.h"
 #include "rapidassist/cli.h"
+#include "rapidassist/random.h"
 
 #ifndef WIN32_LEAN_AND_MEAN
 #define WIN32_LEAN_AND_MEAN 1
@@ -55,14 +56,160 @@ namespace shellanything
 {
   namespace test
   {
+    ra::strings::StringVector RunProcesAndCaptureOutput(const std::string& base_command)
+    {
+      static const ra::strings::StringVector EMPTY_LIST;
+
+      std::string random_value = ra::strings::ToString(ra::random::GetRandomInt(0, 32767) + 10000);
+      std::string temp_file = ra::filesystem::GetTemporaryDirectory() + "\\" + __FUNCTION__ + "." + random_value + ".tmp";
+      ra::strings::Replace(temp_file, "::", ".");
+
+      // Execute
+      std::string full_command = base_command + ">" + temp_file;
+      int exit_code = system(full_command.c_str());
+
+      if (exit_code != 0)
+        return EMPTY_LIST; // error
+
+      ra::strings::StringVector output;
+      bool success_read = ra::filesystem::ReadTextFile(temp_file, output);
+      if (!success_read)
+        return EMPTY_LIST;
+
+      return output;
+    }
+
+    size_t FindValue(const ra::strings::StringVector& list_values, const std::string& query_value)
+    {
+      for (size_t i = 0; i < list_values.size(); i++)
+      {
+        const std::string& list_value = list_values[i];
+        if (query_value == list_value)
+          return i;
+      }
+      return std::string::npos;
+    }
+
+    ra::strings::StringVector FindNewValues(const ra::strings::StringVector& baseline_values, const ra::strings::StringVector& current_values)
+    {
+      ra::strings::StringVector new_values;
+
+      for (size_t i = 0; i < current_values.size(); i++)
+      {
+        const std::string& current_value = current_values[i];
+        size_t find_pos = FindValue(baseline_values, current_value);
+        if (find_pos == std::string::npos)
+        {
+          // This is a new value
+          new_values.push_back(current_value);
+        }
+      }
+
+      return new_values;
+    }
+
     void KillCalculatorProcess()
     {
+      printf("Killing all calculator processes...\n");
+
       system("cmd.exe /c taskkill /IM calc.exe >NUL 2>NUL");
 
       // On Windows 10, calc.exe launches Calculator which is an application in the Microsoft App Store.
       //The executable path is something similar to C:\Program Files\WindowsApps\Microsoft.WindowsCalculator_10.2103.8.0_x64__8wbfmf6g6wwcr\Calculator.exe
       system("cmd.exe /c WMIC PROCESS WHERE \"ExecutablePath like '%%Microsoft.WindowsCalculator%%Calculator.exe'\"    DELETE >NUL 2>NUL");
       system("cmd.exe /c WMIC PROCESS WHERE \"ExecutablePath like '%%Microsoft.WindowsCalculator%%CalculatorApp.exe'\" DELETE >NUL 2>NUL");
+
+      ra::timing::Millisleep(1000);
+
+      printf("killed.\n");
+    }
+
+    bool StartCalculatorProcess(ra::process::processid_t & pId)
+    {
+      // https://stackoverflow.com/questions/63990787/the-process-id-returned-by-the-createprocess-function-is-different-from-the-task
+      // calc.exe is a stub/proxy which will launch the actual CalculatorApp.exe.
+      // For my system, thats is "C:\Program Files\WindowsApps\Microsoft.WindowsCalculator_11.2405.2.0_x64__8wekyb3d8bbwe\CalculatorApp.exe"
+      // However, a normal user cannot launch this process:
+      //   Windows cannot access the specified device, path, or file.You may not have the appropriate permissions to access the item.
+      // So we hack our way and try our best to detect it...
+      //
+
+
+      /*
+      PropertyManager& pmgr = PropertyManager::GetInstance();
+      printf("Starting calc.exe...\n");
+
+      SelectionContext c;
+      {
+        StringList elements;
+        elements.push_back("C:\\Windows\\System32\\cmd.exe");
+        c.SetElements(elements);
+      }
+
+      ActionExecute ae;
+      ae.SetPath("C:\\Windows\\System32\\calc.exe");
+      ae.SetPid("tmp.pid");
+
+      bool executed = ae.Execute(c);
+      if (!executed)
+      {
+        printf("error: not started.\n");
+        return false;
+      }
+
+      ra::timing::Millisleep(2000);
+
+      bool parsed = ra::strings::Parse(pmgr.GetProperty("tmp.pid"), pId);
+      if (!parsed)
+      {
+        printf("error: unknown pid.\n");
+        return false;
+      }
+
+      printf("started.\n");
+      return true;
+      */
+
+      printf("Starting calc.exe...\n");
+
+      static const std::string base_command = "powershell -ExecutionPolicy bypass -Command \"Get-Process | Where{ $_.ProcessName -eq 'CalculatorApp' } | Select -ExpandProperty 'Id'\"";
+      ra::strings::StringVector baseline_processes = RunProcesAndCaptureOutput(base_command);
+
+      system("start \"\" calc.exe >NUL 2>NUL");
+
+      double start = ra::timing::GetMillisecondsTimer();
+      double elapsed_ms = ra::timing::GetMillisecondsTimer() - start;
+      while (pId == 0 && elapsed_ms < 2500)
+      {
+        ra::timing::Millisleep(250);
+
+        // Search for a new process
+        ra::strings::StringVector new_processes = RunProcesAndCaptureOutput(base_command);
+
+        // Check for new values
+        ra::strings::StringVector new_values = FindNewValues(baseline_processes, new_processes);
+        if (new_values.size() >= 1)
+        {
+          // This is the one
+          std::string pid_str = new_values[0];
+
+          bool parsed = ra::strings::Parse(pid_str, pId);
+          if (parsed)
+          {
+            printf("started.\n");
+            return true;
+          }
+
+          // We failed parsing, ignore this value for the next pass.
+          baseline_processes.push_back(pid_str);
+        }
+
+        // refresh timers
+        elapsed_ms = ra::timing::GetMillisecondsTimer() - start;
+      }
+
+      printf("error: not running.\n");
+      return false;
     }
 
     namespace FindProcessWindows

src/tests/TestPlugins.cpp

@@ -28,6 +28,7 @@
 #include "PropertyManager.h"
 #include "SelectionContext.h"
 #include "SelectionContext.h"
+#include "ActionExecute.h"
 
 #include "rapidassist/testing.h"
 #include "rapidassist/filesystem.h"
@@ -39,6 +40,9 @@ namespace shellanything
 {
   namespace test
   {
+    extern void KillCalculatorProcess();
+    extern bool StartCalculatorProcess(ra::process::processid_t& pId);
+
     static const ConfigFile* INVALID_CONFIGURATION = NULL;
 
     //--------------------------------------------------------------------------------------------------
@@ -160,10 +164,8 @@ namespace shellanything
       //Disable process id property
       pmgr.SetProperty("sa_plugin_process.pid", "");
 
-      //Kill all instances of notepad.exe
-      printf("Killing notepad.exe processes...\n");
-      system("taskkill /F /IM notepad.exe");
-      printf("done.\n");
+      //Kill all instances of calc.exe
+      KillCalculatorProcess();
 
       //Set all menus visible
       for (size_t i = 0; i < menus.size(); i++)
@@ -192,12 +194,9 @@ namespace shellanything
         ASSERT_FALSE(menu->IsVisible()) << "menu[" << i << "] named '" << menu->GetName() << "' should be invisible";
       }
 
-      //Start notepad
-      printf("Starting notepad.exe...\n");
-      ra::process::processid_t notepad_pid = ra::process::StartProcess("C:\\Windows\\System32\\notepad.exe");
-      ra::timing::Millisleep(2000);
-      ASSERT_NE(0, notepad_pid);
-      printf("done.\n");
+      //Start calc
+      ra::process::processid_t pId = 0;
+      ASSERT_TRUE( StartCalculatorProcess(pId) );
 
       //Set all menus visible
       for (size_t i = 0; i < menus.size(); i++)
@@ -222,8 +221,8 @@ namespace shellanything
         menu->SetVisible(false);
       }
 
-      std::string notepad_pid_str = ra::strings::ToString(notepad_pid);
-      pmgr.SetProperty("sa_plugin_process.pid", notepad_pid_str);
+      // Change a property which is used by menus to filter visibility by pid
+      pmgr.SetProperty("sa_plugin_process.pid", ra::strings::ToString(pId));
 
       //Update menus again
       config0->Update(c);
@@ -236,7 +235,7 @@ namespace shellanything
       }
 
       //Cleanup
-      ra::process::Kill(notepad_pid);
+      KillCalculatorProcess();
       ASSERT_TRUE(workspace.Cleanup()) << "Failed deleting workspace directory '" << workspace.GetBaseDirectory() << "'.";
     }
     //--------------------------------------------------------------------------------------------------

src/tests/test_files/TestActionExecute.testWaitInfinite.xml

@@ -4,7 +4,7 @@
 
     <menu name="menu">
       <actions>
-        <exec path="powershell.exe" arguments="-nologo -executionpolicy bypass -Command &quot;Start-Sleep -Seconds 10&quot;" wait="true" />
+        <exec path="powershell.exe" arguments="-nologo -executionpolicy bypass -Command &quot;Start-Sleep -Seconds 10&quot;" wait="true" console="false" />
       </actions>
     </menu>
 

src/tests/test_files/TestActionExecute.testWaitTimeout.xml

@@ -4,7 +4,7 @@
 
     <menu name="expected_exec_timeout">
       <actions>
-        <exec path="powershell.exe" arguments="-nologo -executionpolicy bypass -Command &quot;Start-Sleep -Seconds 30&quot;" wait="true" timeout="10" />
+        <exec path="powershell.exe" arguments="-nologo -executionpolicy bypass -Command &quot;Start-Sleep -Seconds 30&quot;" wait="true" timeout="10" console="false" />
       </actions>
     </menu>
 

src/tests/test_files/TestActionProperty.testLiveProperties.xml

@@ -5,23 +5,23 @@
     <menu name="Test">
       <actions>
         <!-- Setting the clipboard from outside of the scope of ShellAnything -->
-        <exec path="powershell.exe" arguments="Set-Clipboard -Value &quot;Luke&quot;" wait="true" timeout="10" />
+        <exec path="powershell.exe" arguments="Set-Clipboard -Value &quot;Luke&quot;" wait="true" timeout="10" console="false" />
 
         <!-- Expect the live property `clipboard` is updated -->
         <property name="character1" value="${clipboard}" />
 
 
 
         <!-- Setting the clipboard from outside of the scope of ShellAnything -->
-        <exec path="powershell.exe" arguments="Set-Clipboard -Value &quot;Leia&quot;" wait="true" timeout="10" />
+        <exec path="powershell.exe" arguments="Set-Clipboard -Value &quot;Leia&quot;" wait="true" timeout="10" console="false" />
 
         <!-- Expect the live property `clipboard` is updated -->
         <property name="character2" value="${clipboard}" />
 
 
 
         <!-- Setting the clipboard from outside of the scope of ShellAnything -->
-        <exec path="powershell.exe" arguments="Set-Clipboard -Value &quot;Han&quot;" wait="true" timeout="10" />
+        <exec path="powershell.exe" arguments="Set-Clipboard -Value &quot;Han&quot;" wait="true" timeout="10" console="false" />
 
         <!-- Expect the live property `clipboard` is updated -->
         <property name="character3" value="${clipboard}" />

src/tests/test_files/TestPlugins.testProcess.xml

@@ -14,28 +14,28 @@
   </plugins>
   <shell>
 
-    <menu name="Terminate Notepad (by filename)">
-      <visibility process_filename="notepad.exe" />
+    <menu name="Terminate Calc (by filename)">
+      <visibility process_filename="CalculatorApp.exe" />
       <actions>
-        <terminateprocess filename="notepad.exe" />
+        <terminateprocess filename="CalculatorApp.exe" />
       </actions>
     </menu>
 
-    <menu name="Terminate Notepad (by pid)">
+    <menu name="Terminate Calc (by pid)">
       <visibility process_pid="${sa_plugin_process.pid}" />
       <actions>
         <terminateprocess pid="${sa_plugin_process.pid}" />
       </actions>
     </menu>
 
-    <menu name="Kill Notepad (by filename)">
-      <visibility process_filename="notepad.exe" />
+    <menu name="Kill Calc (by filename)">
+      <visibility process_filename="CalculatorApp.exe" />
       <actions>
-        <killprocess filename="notepad.exe" />
+        <killprocess filename="CalculatorApp.exe" />
       </actions>
     </menu>
 
-    <menu name="Kill Notepad (by pid)">
+    <menu name="Kill Calc (by pid)">
       <visibility process_pid="${sa_plugin_process.pid}" />
       <actions>
         <killprocess pid="${sa_plugin_process.pid}" />