Improve code coverage in Pagination.tsx (#3246)

PalisadoesFoundation · Jan 11, 2025 · e3a2bdf · e3a2bdf
1 parent e343b0c
commit e3a2bdf
Show file tree

Hide file tree

Showing 2 changed files with 96 additions and 44 deletions.
diff --git a/src/components/Pagination/Pagination.spec.tsx b/src/components/Pagination/Pagination.spec.tsx
@@ -6,60 +6,115 @@ import { createTheme, ThemeProvider } from '@mui/material/styles';
 import Pagination from './Pagination';
 import { store } from 'state/store';
 import userEvent from '@testing-library/user-event';
-import { describe, it } from 'vitest';
-
-describe('Testing Pagination component', () => {
-  const props = {
-    count: 5,
-    page: 10,
-    rowsPerPage: 5,
-    onPageChange: (): number => {
-      return 10;
-    },
+import { describe, it, vi, expect } from 'vitest';
+
+describe('Pagination component tests', () => {
+  const mockOnPageChange = vi.fn();
+
+  const defaultProps = {
+    count: 20, // Total items
+    page: 2, // Current page
+    rowsPerPage: 5, // Items per page
+    onPageChange: mockOnPageChange, // Mocked callback for page change
   };
 
-  it('Component should be rendered properly on rtl', async () => {
+  it('should render all pagination buttons and invoke onPageChange for navigation', async () => {
     render(
       <BrowserRouter>
         <Provider store={store}>
-          <Pagination {...props} />
+          <Pagination {...defaultProps} />
         </Provider>
       </BrowserRouter>,
     );
+
+    // Ensure all buttons are rendered
+    expect(screen.getByTestId('firstPage')).toBeInTheDocument();
+    expect(screen.getByTestId('previousPage')).toBeInTheDocument();
+    expect(screen.getByTestId('nextPage')).toBeInTheDocument();
+    expect(screen.getByTestId('lastPage')).toBeInTheDocument();
+
+    // Simulate button clicks and verify callback invocation
+    await act(async () => {
+      userEvent.click(screen.getByTestId('nextPage'));
+    });
+    expect(mockOnPageChange).toHaveBeenCalledWith(expect.anything(), 3); // Next page
+
+    await act(async () => {
+      userEvent.click(screen.getByTestId('previousPage'));
+    });
+    expect(mockOnPageChange).toHaveBeenCalledWith(expect.anything(), 1); // Previous page
+
+    await act(async () => {
+      userEvent.click(screen.getByTestId('firstPage'));
+    });
+    expect(mockOnPageChange).toHaveBeenCalledWith(expect.anything(), 0); // First page
+
     await act(async () => {
-      userEvent.click(screen.getByTestId(/nextPage/i));
-      userEvent.click(screen.getByTestId(/previousPage/i));
+      userEvent.click(screen.getByTestId('lastPage'));
     });
+    expect(mockOnPageChange).toHaveBeenCalledWith(expect.anything(), 3); // Last page
   });
-});
 
-const props = {
-  count: 5,
-  page: 10,
-  rowsPerPage: 5,
-  onPageChange: (): number => {
-    return 10;
-  },
-  theme: { direction: 'rtl' },
-};
-
-it('Component should be rendered properly', async () => {
-  const theme = createTheme({
-    direction: 'rtl',
+  it('should disable navigation buttons at the boundaries', () => {
+    render(
+      <BrowserRouter>
+        <Provider store={store}>
+          <Pagination {...defaultProps} page={0} />
+        </Provider>
+      </BrowserRouter>,
+    );
+
+    // First and Previous buttons should be disabled on the first page
+    expect(screen.getByTestId('firstPage')).toBeDisabled();
+    expect(screen.getByTestId('previousPage')).toBeDisabled();
+
+    // Next and Last buttons should not be disabled
+    expect(screen.getByTestId('nextPage')).not.toBeDisabled();
+    expect(screen.getByTestId('lastPage')).not.toBeDisabled();
   });
 
-  render(
-    <BrowserRouter>
-      <Provider store={store}>
-        <ThemeProvider theme={theme}>
-          <Pagination {...props} />
-        </ThemeProvider>
-      </Provider>
-    </BrowserRouter>,
-  );
-
-  await act(async () => {
-    userEvent.click(screen.getByTestId(/nextPage/i));
-    userEvent.click(screen.getByTestId(/previousPage/i));
+  it('should render correctly with RTL direction', async () => {
+    const rtlTheme = createTheme({ direction: 'rtl' });
+
+    render(
+      <BrowserRouter>
+        <Provider store={store}>
+          <ThemeProvider theme={rtlTheme}>
+            <Pagination {...defaultProps} />
+          </ThemeProvider>
+        </Provider>
+      </BrowserRouter>,
+    );
+
+    // Verify buttons render properly in RTL mode
+    expect(screen.getByTestId('firstPage')).toBeInTheDocument();
+    expect(screen.getByTestId('lastPage')).toBeInTheDocument();
+
+    // Simulate a button click in RTL mode
+    await act(async () => {
+      userEvent.click(screen.getByTestId('nextPage'));
+    });
+    expect(mockOnPageChange).toHaveBeenCalledWith(expect.anything(), 3); // Next page
+  });
+
+  it('should disable Next and Last buttons on the last page', () => {
+    render(
+      <BrowserRouter>
+        <Provider store={store}>
+          <Pagination
+            {...defaultProps}
+            page={Math.ceil(defaultProps.count / defaultProps.rowsPerPage) - 1}
+          />
+        </Provider>
+      </BrowserRouter>,
+    );
+
+    // Next and Last buttons should be disabled on the last page
+    expect(screen.getByTestId('nextPage')).toBeDisabled();
+    expect(screen.getByTestId('lastPage')).toBeDisabled();
+
+    // First and Previous buttons should not be disabled
+    expect(screen.getByTestId('firstPage')).not.toBeDisabled();
+    expect(screen.getByTestId('previousPage')).not.toBeDisabled();
   });
 });
diff --git a/src/components/Pagination/Pagination.tsx b/src/components/Pagination/Pagination.tsx
@@ -37,7 +37,6 @@ function pagination(props: InterfaceTablePaginationActionsProps): JSX.Element {
    *
    * @param event - The click event.
    */
-  /* istanbul ignore next */
   const handleFirstPageButtonClick = (
     event: React.MouseEvent<HTMLButtonElement>,
   ): void => {
@@ -63,7 +62,6 @@ function pagination(props: InterfaceTablePaginationActionsProps): JSX.Element {
    * @param event - The click event.
    */
 
-  /* istanbul ignore next */
   const handleNextButtonClick = (
     event: React.MouseEvent<HTMLButtonElement>,
   ): void => {
@@ -76,7 +74,6 @@ function pagination(props: InterfaceTablePaginationActionsProps): JSX.Element {
    *
    * @param event - The click event.
    */
-  /* istanbul ignore next */
   const handleLastPageButtonClick = (
     event: React.MouseEvent<HTMLButtonElement>,
   ): void => {