test: fix EPERM when corrupting test data folders

Signed-off-by: Akos Kitta <[email protected]>

Author: Akos Kitta

arduino-ide-extension/src/node/arduino-daemon-impl.ts

@@ -16,6 +16,7 @@ import { ArduinoDaemon, NotificationServiceServer } from '../common/protocol';
 import { CLI_CONFIG } from './cli-config';
 import { getExecPath } from './exec-util';
 import { SettingsReader } from './settings-reader';
+import { ProcessUtils } from '@theia/core/lib/node/process-utils';
 
 @injectable()
 export class ArduinoDaemonImpl
@@ -34,6 +35,9 @@ export class ArduinoDaemonImpl
   @inject(SettingsReader)
   private readonly settingsReader: SettingsReader;
 
+  @inject(ProcessUtils)
+  private readonly processUtils: ProcessUtils;
+
   private readonly toDispose = new DisposableCollection();
   private readonly onDaemonStartedEmitter = new Emitter<string>();
   private readonly onDaemonStoppedEmitter = new Emitter<void>();
@@ -84,8 +88,16 @@ export class ArduinoDaemonImpl
       ).unref();
 
       this.toDispose.pushAll([
-        Disposable.create(() => daemon.kill()),
-        Disposable.create(() => this.fireDaemonStopped()),
+        Disposable.create(() => {
+          if (daemon.pid) {
+            this.processUtils.terminateProcessTree(daemon.pid);
+            this.fireDaemonStopped();
+          } else {
+            throw new Error(
+              'The CLI Daemon process does not have a PID. IDE2 could not stop the CLI daemon.'
+            );
+          }
+        }),
       ]);
       this.fireDaemonStarted(port);
       this.onData('Daemon is running.');

arduino-ide-extension/src/test/node/core-client-provider.slow-test.ts

@@ -1,4 +1,5 @@
 import { DisposableCollection } from '@theia/core/lib/common/disposable';
+import { waitForEvent } from '@theia/core/lib/common/promise-util';
 import type { MaybePromise } from '@theia/core/lib/common/types';
 import { FileUri } from '@theia/core/lib/node/file-uri';
 import { Container } from '@theia/core/shared/inversify';
@@ -11,6 +12,7 @@ import {
   CoreService,
   LibraryService,
 } from '../../common/protocol';
+import { ArduinoDaemonImpl } from '../../node/arduino-daemon-impl';
 import { CLI_CONFIG } from '../../node/cli-config';
 import { BoardListRequest } from '../../node/cli-protocol/cc/arduino/cli/commands/v1/board_pb';
 import { CoreClientProvider } from '../../node/core-client-provider';
@@ -263,7 +265,13 @@ async function prepareTestConfigDir(
       container.get<ConfigDirUriProvider>(ConfigDirUriProvider);
     return FileUri.fsPath(configDirUriProvider.configDirUri());
   } finally {
-    toDispose.dispose();
+    const daemon = container.get<ArduinoDaemonImpl>(ArduinoDaemonImpl);
+    // Wait for the daemon stop event. All subprocesses (such as `serial-discovery` and `mdns-discovery`) must terminate.
+    // Otherwise, `EPERM: operation not permitted, unlink` is thrown on Windows when "corrupting" the `directories.data` folder for the tests.
+    await Promise.all([
+      waitForEvent(daemon.onDaemonStopped, 5_000),
+      Promise.resolve(toDispose.dispose()),
+    ]);
   }
 }
 

arduino-ide-extension/src/test/node/test-bindings.ts

@@ -15,6 +15,7 @@ import { waitForEvent } from '@theia/core/lib/common/promise-util';
 import { MockLogger } from '@theia/core/lib/common/test/mock-logger';
 import URI from '@theia/core/lib/common/uri';
 import { FileUri } from '@theia/core/lib/node/file-uri';
+import { ProcessUtils } from '@theia/core/lib/node/process-utils';
 import {
   Container,
   ContainerModule,
@@ -351,6 +352,7 @@ export async function createBaseContainer(
     bind(SettingsReader).toSelf().inSingletonScope();
     bind(LibraryServiceImpl).toSelf().inSingletonScope();
     bind(LibraryService).toService(LibraryServiceImpl);
+    bind(ProcessUtils).toSelf().inSingletonScope();
     params?.additionalBindings?.(bind, rebind);
   });
   container.load(module);