(#5) Renamed public functions and added tests for window api functions

Author: s1hofmann

index.ts

@@ -33,7 +33,7 @@ const screen = new Screen(screenActions);
 const assert = new Assert(screen);
 
 const {straightTo, up, down, left, right} = createMovementApi(nativeActions, lineHelper);
-const {windows, activeWindow } = createWindowApi(nativeActions);
+const {getWindows, getActiveWindow } = createWindowApi(nativeActions);
 
 export {
   clipboard,
@@ -46,6 +46,6 @@ export {
   down,
   left,
   right,
-  windows,
-  activeWindow,
+  getWindows,
+  getActiveWindow,
 };

lib/window-api.interface.ts

@@ -4,6 +4,6 @@
 import { Window } from "./window.class";
 
 export interface WindowApi {
-  windows(): Promise<Window[]>;
-  activeWindow(): Promise<Window>;
+  getWindows(): Promise<Window[]>;
+  getActiveWindow(): Promise<Window>;
 }

lib/window.function.spec.ts

@@ -0,0 +1,33 @@
+import {createWindowApi} from "./window.function";
+import {NativeAdapter} from "./adapter/native.adapter.class";
+import {Window} from "./window.class";
+
+describe("WindowApi", () => {
+    describe("getWindows", () => {
+        it("should return a list of open Windows", async () => {
+            // GIVEN
+            const SUT = createWindowApi(new NativeAdapter());
+
+            // WHEN
+            const windows = await SUT.getWindows()
+
+            // THEN
+            windows.forEach(wnd => {
+                expect(wnd).toEqual(expect.any(Window));
+            });
+        });
+    });
+
+    describe("getActiveWindow", () => {
+        it("should return the a single Window which is currently active", async () => {
+            // GIVEN
+            const SUT = createWindowApi(new NativeAdapter());
+
+            // WHEN
+            const window = await SUT.getActiveWindow();
+
+            // THEN
+            expect(window).toEqual(expect.any(Window));
+        });
+    });
+});

lib/window.function.ts

@@ -4,11 +4,11 @@ import { Window } from "./window.class";
 
 export const createWindowApi = (nativeAdapter: NativeAdapter): WindowApi => {
   return ({
-    async activeWindow(): Promise<Window> {
+    async getActiveWindow(): Promise<Window> {
       const windowHandle = await nativeAdapter.getActiveWindow();
       return new Window(nativeAdapter, windowHandle);
     },
-    async windows(): Promise<Window[]> {
+    async getWindows(): Promise<Window[]> {
       const windowHandles = await nativeAdapter.getWindows();
       return windowHandles.map((handle: number) => {
         return new Window(nativeAdapter, handle);