Add tests for useResponseSteps

Signed-off-by: Erik Engervall <erik.engervall@gmail.com>

plugins/github-release-manager/src/hooks/useResponseSteps.test.ts

@@ -0,0 +1,143 @@
+/*
+ * Copyright 2021 Spotify AB
+ *
+ * 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.
+ */
+
+import { renderHook, act } from '@testing-library/react-hooks';
+
+import { useResponseSteps } from './useResponseSteps';
+
+describe('useResponseSteps', () => {
+  it('should export expected variables', () => {
+    const { result } = renderHook(() => useResponseSteps());
+
+    expect(result.current).toMatchInlineSnapshot(`
+      Object {
+        "abortIfError": [Function],
+        "addStepToResponseSteps": [Function],
+        "asyncCatcher": [Function],
+        "responseSteps": Array [],
+      }
+    `);
+  });
+
+  describe('addStepToResponseSteps', () => {
+    it('should add responseSteps to state', async () => {
+      const { result } = renderHook(() => useResponseSteps());
+
+      expect(result.current.responseSteps).toMatchInlineSnapshot(`Array []`);
+
+      act(() => {
+        result.current.addStepToResponseSteps({
+          message: 'totally added a messaage ✌🏼',
+        });
+      });
+
+      expect(result.current.responseSteps).toMatchInlineSnapshot(`
+              Array [
+                Object {
+                  "message": "totally added a messaage ✌🏼",
+                },
+              ]
+          `);
+    });
+  });
+
+  describe('asyncCatcher', () => {
+    it('should catch Errors and add as failure step, then throw', async () => {
+      const { result } = renderHook(() => useResponseSteps());
+
+      expect(result.current.responseSteps).toMatchInlineSnapshot(`Array []`);
+
+      await act(async () => {
+        await new Promise((_, reject) => reject(new Error(':(')))
+          .catch(result.current.asyncCatcher)
+          .catch(
+            () => void 0, // swallow
+          );
+      });
+
+      expect(result.current.responseSteps).toMatchInlineSnapshot(`
+        Array [
+          Object {
+            "icon": "failure",
+            "message": "Something went wrong 🔥",
+            "secondaryMessage": "Error message: :(",
+          },
+        ]
+      `);
+    });
+
+    it('should catch unknown Errors and add as failure step, then throw', async () => {
+      const { result } = renderHook(() => useResponseSteps());
+
+      expect(result.current.responseSteps).toMatchInlineSnapshot(`Array []`);
+
+      await act(async () => {
+        await new Promise((_, reject) => reject())
+          .catch(result.current.asyncCatcher)
+          .catch(
+            () => void 0, // swallow
+          );
+      });
+
+      expect(result.current.responseSteps).toMatchInlineSnapshot(`
+        Array [
+          Object {
+            "icon": "failure",
+            "message": "Something went wrong 🔥",
+            "secondaryMessage": "Error message: unknown",
+          },
+        ]
+      `);
+    });
+  });
+
+  describe('abortIfError', () => {
+    it('should throw if Error and add a failure step', async () => {
+      const { result } = renderHook(() => useResponseSteps());
+
+      expect(result.current.responseSteps).toMatchInlineSnapshot(`Array []`);
+
+      act(() => {
+        try {
+          result.current.abortIfError(new Error('Das kaboom'));
+        } catch (error) {
+          //
+        }
+      });
+
+      expect(result.current.responseSteps).toMatchInlineSnapshot(`
+        Array [
+          Object {
+            "icon": "failure",
+            "message": "Skipped due to error in previous step",
+          },
+        ]
+      `);
+    });
+
+    it('should do nothing if not Error', async () => {
+      const { result } = renderHook(() => useResponseSteps());
+
+      expect(result.current.responseSteps).toMatchInlineSnapshot(`Array []`);
+
+      act(() => {
+        result.current.abortIfError(undefined);
+      });
+
+      expect(result.current.responseSteps).toMatchInlineSnapshot(`Array []`);
+    });
+  });
+});

plugins/github-release-manager/src/hooks/useResponseSteps.ts

@@ -30,14 +30,7 @@ export function useResponseSteps() {
     setResponseSteps([...responseSteps, responseStep]);
   };
 
-  const abortIfError = (error?: Error) => {
-    if (error) {
-      addStepToResponseSteps(RESPONSE_STEP_FAILURE_ABORT);
-      throw error;
-    }
-  };
-
-  const asyncCatcher = (error?: Error): never => {
+  const asyncCatcher = (error: Error): never => {
     const responseStepError: ResponseStep = {
       message: 'Something went wrong 🔥',
       secondaryMessage: `Error message: ${
@@ -50,6 +43,13 @@ export function useResponseSteps() {
     throw error;
   };
 
+  const abortIfError = (error?: Error) => {
+    if (error) {
+      addStepToResponseSteps(RESPONSE_STEP_FAILURE_ABORT);
+      throw error;
+    }
+  };
+
   return {
     responseSteps,
     addStepToResponseSteps,