feat: add a method in system api to get platform name (#465)

* feat: add a method in system api to get system name

Signed-off-by: Philippe Martin <[email protected]>

* feat: return os.platform

Signed-off-by: Philippe Martin <[email protected]>

---------

Signed-off-by: Philippe Martin <[email protected]>

Author: feloy

packages/channels/src/interface/system-api.ts

@@ -22,4 +22,5 @@ export interface SystemApi {
   openExternal(uri: string): Promise<boolean>;
   clipboardWriteText(text: string): Promise<void>;
   getFreePort(startPort: number): Promise<number>;
+  getPlatformName(): Promise<string>;
 }

packages/extension/src/manager/system-api.spec.ts

@@ -0,0 +1,34 @@
+/**********************************************************************
+ * Copyright (C) 2025 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import { describe, expect, test, vi } from 'vitest';
+import { SystemApiImpl } from '/@/manager/system-api';
+import * as os from 'node:os';
+
+vi.mock(import('node:os'));
+
+describe('getPlatformName', async () => {
+  const systemApi = new SystemApiImpl();
+
+  test('should return value from os.platform', async () => {
+    // testing with a non-tested platform, to be sure that the value is not obtained from the system
+    vi.mocked(os.platform).mockReturnValue('sunos');
+    const platformName = await systemApi.getPlatformName();
+    expect(platformName).toBe('sunos');
+  });
+});

packages/extension/src/manager/system-api.ts

@@ -19,6 +19,7 @@
 import { injectable } from 'inversify';
 import type { SystemApi } from '@kubernetes-dashboard/channels';
 import * as podmanDesktopApi from '@podman-desktop/api';
+import * as os from 'node:os';
 
 @injectable()
 export class SystemApiImpl implements SystemApi {
@@ -33,4 +34,8 @@ export class SystemApiImpl implements SystemApi {
   async getFreePort(startPort: number): Promise<number> {
     return podmanDesktopApi.net.getFreePort(startPort);
   }
+
+  async getPlatformName(): Promise<string> {
+    return os.platform();
+  }
 }