Merge pull request #433 from Sillyboi2001/Orderedstateslist

Test Cases for CommonUI/OrderedStatesList

CommonUI/src/Components/ErrorMessage/ErrorMessage.tsx

@@ -13,6 +13,7 @@ const ErrorMessage: FunctionComponent<ComponentProps> = (
             {props.error} <br />{' '}
             {props.onRefreshClick ? (
                 <span
+                    role={'refresh-button'}
                     onClick={() => {
                         if (props.onRefreshClick) {
                             props.onRefreshClick();

CommonUI/src/Tests/Components/OrderedStatesList.test.tsx

@@ -0,0 +1,124 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import OrderedStatesList, {
+    ComponentProps,
+} from '../../Components/OrderedStatesList/OrderedStatesList';
+
+describe('OrderedSateList', () => {
+    const defaultProps: ComponentProps = {
+        data: [{ title: 'item 1', description: 'description 1', order: 1 }],
+        singularLabel: 'Item',
+        titleField: 'title',
+        id: 'new-item-button',
+        orderField: 'order',
+        noItemsMessage: 'No Item',
+        shouldAddItemInTheEnd: true,
+        shouldAddItemInTheBegining: true,
+    };
+
+    it('should render all components', () => {
+        render(<OrderedStatesList {...defaultProps} />);
+        expect(screen.getByText('item 1')).toBeInTheDocument;
+    });
+    it('renders Item components for each item in data prop', () => {
+        const props: ComponentProps = {
+            ...defaultProps,
+            data: [
+                { title: 'item 1', description: 'description 1', order: 1 },
+                { title: 'item 2', description: 'description 2', order: 2 },
+                { title: 'item 3', description: 'description 3', order: 3 },
+            ],
+        };
+        render(<OrderedStatesList {...props} />);
+        expect(props.data).toHaveLength(3);
+    });
+    it('renders a ComponentLoader if isLoading prop is true', () => {
+        const props: ComponentProps = {
+            ...defaultProps,
+            isLoading: true,
+        };
+        render(<OrderedStatesList {...props} />);
+        expect(screen.getByRole('bar-loader')).toBeInTheDocument();
+    });
+    it('should render an error message if error prop is present', () => {
+        const props: ComponentProps = {
+            ...defaultProps,
+            error: 'Error Message',
+        };
+        render(<OrderedStatesList {...props} />);
+        expect(screen.getByText('Error Message')).toBeInTheDocument();
+    });
+    it('should render "No Item" message when there is no data', () => {
+        const props: ComponentProps = {
+            ...defaultProps,
+            data: [],
+        };
+        const { getByText } = render(<OrderedStatesList {...props} />);
+        expect(getByText('No Item')).toBeInTheDocument();
+    });
+    it('calls the onRefreshClick function when the refresh button is clicked', () => {
+        const props: ComponentProps = {
+            ...defaultProps,
+            data: [],
+            onRefreshClick: jest.fn(),
+        };
+        render(<OrderedStatesList {...props} />);
+        const refreshButton: HTMLElement = screen.getByRole('refresh-button');
+        refreshButton.click();
+        expect(props.onRefreshClick).toHaveBeenCalled();
+    });
+    it('should call the onCreateNewItem prop when the "New Item" button is clicked', () => {
+        const props: ComponentProps = {
+            ...defaultProps,
+            onCreateNewItem: jest.fn(),
+        };
+        const { getByText } = render(<OrderedStatesList {...props} />);
+        const newItem: HTMLElement = getByText('Add New Item');
+        newItem.click();
+        expect(props.onCreateNewItem).toHaveBeenCalled();
+    });
+    it('renders ErrorMessage with error message and callback when error is defined', () => {
+        const props: ComponentProps = {
+            ...defaultProps,
+            error: 'Failed to load data',
+            onRefreshClick: jest.fn(),
+        };
+        render(<OrderedStatesList {...props} />);
+        expect(screen.getByText('Failed to load data')).toBeInTheDocument();
+        expect(screen.getByRole('refresh-button')).toBeInTheDocument();
+        screen.getByRole('refresh-button').click();
+        expect(props.onRefreshClick).toHaveBeenCalled();
+    });
+    it('renders ErrorMessage with default message and callback when data is empty and noItemsMessage is not defined', () => {
+        const props: ComponentProps = {
+            ...defaultProps,
+            data: [],
+            noItemsMessage: undefined,
+            onRefreshClick: jest.fn(),
+        };
+        render(<OrderedStatesList {...props} />);
+        expect(
+            screen.getByText(`No ${props.singularLabel.toLowerCase()}`)
+        ).toBeInTheDocument();
+        expect(screen.getByRole('refresh-button')).toBeInTheDocument();
+        screen.getByRole('refresh-button').click();
+        expect(props.onRefreshClick).toHaveBeenCalled();
+    });
+    it('should render custom title element provided by getTitleElement function', () => {
+        const props: ComponentProps = {
+            ...defaultProps,
+            getTitleElement: jest.fn(),
+        };
+        render(<OrderedStatesList {...props} />);
+        expect(props.getTitleElement).toHaveBeenCalled();
+    });
+    it('should render custom title element provided by getDescriptionElement function', () => {
+        const props: ComponentProps = {
+            ...defaultProps,
+            getDescriptionElement: jest.fn(),
+        };
+        render(<OrderedStatesList {...props} />);
+        expect(props.getDescriptionElement).toHaveBeenCalled();
+    });
+});