Back to Repositories

Testing ClipboardButton Component Functionality in Apache Airflow

This test suite evaluates the functionality of the ClipboardButton component in Apache Airflow’s web interface. It focuses on verifying the clipboard copying mechanism and user interaction flows using Jest and React Testing Library. The tests ensure proper handling of clipboard operations through window.prompt mocking.

Test Coverage Overview

The test coverage focuses on the core clipboard functionality, specifically testing the button rendering and click interaction.

Tests button rendering and visibility
Verifies clipboard copy functionality
Validates prompt message content
Handles window.prompt mocking

Implementation Analysis

The testing approach utilizes React Testing Library’s render and fireEvent utilities for component interaction simulation. The implementation employs Jest’s mocking capabilities to override the window.prompt function, allowing for controlled testing of the clipboard functionality.

Key patterns include component rendering, event simulation, and prompt verification.

Technical Details

Testing Stack:

Jest as the testing framework
React Testing Library for component testing
TypeScript for type-safe testing
@testing-library/jest-dom for DOM assertions

Best Practices Demonstrated

The test suite demonstrates several testing best practices including proper setup and teardown of mocks, isolation of component functionality, and user-centric testing approaches.

Clean mock management
Focused component testing
User interaction simulation
Proper assertion patterns

apache/airflow

airflow/www/static/js/components/Clipboard.test.tsx

            
/*!
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

/* global describe, test, expect, jest, window */

import React from "react";
import "@testing-library/jest-dom";
import { render, fireEvent } from "@testing-library/react";

import { ClipboardButton } from "./Clipboard";

describe("ClipboardButton", () => {
  test("Loads button", async () => {
    const windowPrompt = window.prompt;
    window.prompt = jest.fn();
    const { getByText } = render(<ClipboardButton value="lorem ipsum" />);

    const button = getByText(/copy/i);
    fireEvent.click(button);
    expect(window.prompt).toHaveBeenCalledWith(
      "Copy to clipboard: Ctrl+C, Enter",
      "lorem ipsum"
    );
    window.prompt = windowPrompt;
  });
});