testing-pyramid-agent

actions:

• type: suggest message: | To analyze test distribution, first identify the test framework and check for coverage commands:

  1. Check package.json for test framework dependencies (jest, vitest, playwright, cypress, mocha)
  2. Look for coverage scripts in package.json scripts section (test:coverage, coverage, etc.)
  3. Use the framework's list command to identify test files:
     • Jest: npx jest --listTests
     • Vitest: npx vitest list
     • Playwright: npx playwright test --list
     • Cypress: Check cypress.config.js for test patterns

  Then classify tests by:

  • File path (e2e/, integration/, unit/)
  • Content keywords (mock, playwright, cypress, database, etc.)
  • Test framework indicators

  Target distribution: 70% unit, 20% integration, 10% E2E

examples:

• description: "Unit Test Example" input: | // Bad: Testing multiple units together test('process user data', () => { const result = processUserData(validateUser(createUser(data))); expect(result).toBe(expected); }); output: | // Good: Testing single unit with clear arrangement describe('User Processing', () => { it('should process valid user data correctly', () => { // Arrange const mockUser = createMockUser();

    // Act
    const result = processUserData(mockUser);
  
    // Assert
    expect(result).toEqual(expected);
  });
  

  });

• description: "Integration Test Example" input: | // Bad: Testing everything in one E2E test test('user workflow', async () => { await createUser(); await loginUser(); await updateProfile(); await deleteUser(); }); output: | // Good: Focused integration test describe('User Authentication Integration', () => { it('should successfully authenticate valid user', async () => { // Arrange const user = await createTestUser();

    // Act
    const result = await authService.authenticate(user.credentials);
  
    // Assert
    expect(result.authenticated).toBe(true);
  });
  

  });

• description: "E2E Test Example" input: | // Bad: Testing minor features end-to-end test('user can change avatar', async () => { await page.goto('/profile'); await page.click('#avatar'); await page.upload('#file-input', 'test.jpg'); await expect(page.locator('#avatar')).toHaveAttribute('src', /test/); }); output: | // Good: E2E test for critical user journey describe('Critical User Journey', () => { it('should allow user to complete checkout process', async () => { // Arrange await loginAsTestUser(); // Act await navigateToProducts(); await addItemToCart(); await proceedToCheckout(); await fillShippingDetails(); await completePayment();

    // Assert
    await expect(page.locator('#order-confirmation')).toBeVisible();
  });
  

  });

tests:

• input: | // Single test file with no structure test('it works', () => { expect(true).toBe(true); }); output: | describe('Feature Module', () => { describe('Unit Tests', () => { it('should handle valid input correctly', () => { // Arrange const input = validTestData(); // Act const result = processInput(input);

      // Assert
      expect(result).toBe(expected);
    });
  });
  
  describe('Integration Tests', () => {
    it('should integrate with dependent service', async () => {
      // Arrange
      const service = new DependentService();
  
      // Act
      const result = await service.process();
  
      // Assert
      expect(result).toMatchExpectedIntegration();
    });
  });
  

  });

metadata: priority: high version: 1.0

Testing Pyramid Analysis

This rule provides guidance on the testing pyramid principle and how to analyze test distribution in your repository.