Back to Repositories

Testing Easycom Component Registration System in dcloudio/uni-app

This test suite validates the easycom component auto-registration system in uni-app, focusing on component pattern matching and path resolution. It verifies the initialization of easycom configurations and tests the matching functionality for different component patterns.

Test Coverage Overview

The test suite provides comprehensive coverage of the easycom initialization and matching functionality.

Key areas tested include:

Component pattern registration with regular expressions
Path normalization for different component locations
Directory structure handling for components
Support for uni-modules plugin components

Implementation Analysis

The testing approach utilizes Jest’s describe/test structure to organize related test cases. The implementation leverages path resolution and pattern matching to verify component registration.

Technical patterns include:

Regular expression pattern matching for component names
Path normalization across different platforms
Dynamic component replacement path generation

Technical Details

Testing infrastructure includes:

Jest as the testing framework
Path module for filesystem operations
Custom normalizePath utility for cross-platform compatibility
Mock component directory structure in examples/easycom

Best Practices Demonstrated

The test suite demonstrates several testing best practices for component registration systems.

Notable practices include:

Isolated test environment with mock directory structure
Comprehensive pattern matching verification
Platform-specific path handling
Clear test case organization and naming

dcloudio/uni-app

packages/uni-cli-shared/__tests__/easycom.spec.ts

            
import path from 'path'
import { normalizePath } from '../src/utils'
import { initEasycoms, matchEasycom } from '../src/easycom'

const rootDir = path.resolve(__dirname, 'examples/easycom')

describe('easycom', () => {
  test('initEasycom with dirs', () => {
    expect(
      initEasycoms(rootDir, { platform: 'h5', dirs: [] }).easycoms
    ).toEqual([
      {
        name: 'test',
        pattern: new RegExp('^test$'),
        replacement: normalizePath(
          path.resolve(rootDir, 'components/test/test.vue')
        ),
      },
      {
        name: 'test1',
        pattern: new RegExp('^test1$'),
        replacement: normalizePath(
          path.resolve(rootDir, 'components/test1/test1.vue')
        ),
      },
      {
        name: 'test2',
        pattern: new RegExp('^test2$'),
        replacement: normalizePath(
          path.resolve(rootDir, 'uni_modules/plugin/components/test2/test2.vue')
        ),
      },
      {
        name: '^uni-(.*)',
        pattern: new RegExp('^uni-(.*)'),
        replacement: normalizePath(
          path.resolve(rootDir, 'components/uni-$1.vue')
        ),
      },
    ])
    expect(matchEasycom('test')).toBe(
      normalizePath(path.resolve(rootDir, 'components/test/test.vue'))
    )
    expect(matchEasycom('test1')).toBe(
      normalizePath(path.resolve(rootDir, 'components/test1/test1.vue'))
    )
    expect(matchEasycom('test2')).toBe(
      normalizePath(
        path.resolve(rootDir, 'uni_modules/plugin/components/test2/test2.vue')
      )
    )
    expect(matchEasycom('uni-test1')).toBe(
      normalizePath(path.resolve(rootDir, 'components/uni-test1.vue'))
    )
  })
})