Linux Dash后端单元测试：Mocha与Chai测试框架应用

Linux Dash后端单元测试：Mocha与Chai测试框架应用

【免费下载链接】linux-dash A beautiful web dashboard for Linux 项目地址: https://gitcode.com/gh_mirrors/li/linux-dash

1. 测试环境搭建

1.1 测试框架选择

Linux Dash后端采用Node.js/Express架构，选择Mocha作为测试运行器（Test Runner），Chai作为断言库（Assertion Library）。Mocha提供灵活的测试组织方式，支持异步测试和自定义报告；Chai提供BDD/TDD风格的断言语法，增强测试代码可读性。

1.2 环境准备

# 克隆项目仓库
git clone https://gitcode.com/gh_mirrors/li/linux-dash
cd linux-dash

# 安装测试依赖（假设Node.js环境已配置）
npm install mocha chai --save-dev

2. 测试用例设计

2.1 核心测试目标

Linux Dash后端index.js提供三大核心功能，对应测试场景如下：

功能模块	测试类型	关键断言点
HTTP服务器启动	集成测试	端口监听成功、200状态码返回
API数据接口	功能测试	JSON格式验证、状态码校验
WebSocket通信	端到端测试	连接建立、数据推送完整性

2.2 测试用例结构

test/
├── server.test.js       # 主测试文件
├── api/                 # API测试模块
│   ├── cpu.test.js      # CPU监控接口测试
│   └── disk.test.js     # 磁盘监控接口测试
└── websocket.test.js    # WebSocket测试

3. 核心测试实现

3.1 HTTP服务器基础测试

const { expect } = require('chai');
const http = require('http');
const server = require('../app/server/index.js');

describe('HTTP Server Initialization', () => {
  after((done) => {
    server.close(done); // 测试结束后关闭服务器
  });

  it('should start server on port 80', (done) => {
    http.get('http://localhost:80', (res) => {
      expect(res.statusCode).to.equal(200);
      done();
    });
  });

  it('should serve static files from /app directory', (done) => {
    http.get('http://localhost:80/index.html', (res) => {
      expect(res.headers['content-type']).to.include('text/html');
      done();
    });
  });
});

3.2 API接口测试

针对/server端点的动态数据接口测试：

describe('API Endpoint: /server', () => {
  it('should return 200 for valid module', (done) => {
    http.get('http://localhost:80/server?module=cpu', (res) => {
      expect(res.statusCode).to.equal(200);
      done();
    });
  });

  it('should return 500 for invalid module', (done) => {
    http.get('http://localhost:80/server?module=invalid', (res) => {
      expect(res.statusCode).to.equal(500);
      done();
    });
  });

  it('should return JSON formatted data', (done) => {
    http.get('http://localhost:80/server?module=memory', (res) => {
      let data = '';
      res.on('data', (chunk) => data += chunk);
      res.on('end', () => {
        expect(() => JSON.parse(data)).not.to.throw(); // 验证JSON格式
        const result = JSON.parse(data);
        expect(result).to.have.property('total'); // 内存数据特有字段
        done();
      });
    });
  });
});

3.3 WebSocket通信测试

使用ws模块模拟客户端连接测试：

const WebSocket = require('ws');

describe('WebSocket Service', () => {
  it('should establish connection', (done) => {
    const ws = new WebSocket('ws://localhost:80');
    
    ws.on('open', () => {
      expect(ws.readyState).to.equal(WebSocket.OPEN);
      ws.close();
      done();
    });
  });

  it('should receive CPU data on request', (done) => {
    const ws = new WebSocket('ws://localhost:80');
    
    ws.on('open', () => {
      ws.send('cpu'); // 请求CPU数据
    });
    
    ws.on('message', (data) => {
      const result = JSON.parse(data);
      expect(result.moduleName).to.equal('cpu');
      expect(result.output).to.include('usage');
      ws.close();
      done();
    });
  });
});

3. 测试执行与报告

3.1 配置测试脚本

修改package.json添加测试命令：

{
  "scripts": {
    "test": "mocha test/**/*.test.js --reporter spec",
    "test:coverage": "nyc mocha test/**/*.test.js"
  }
}

3.2 运行测试与结果分析

# 执行基础测试
npm test

# 生成覆盖率报告（需额外安装nyc）
npm install nyc --save-dev
npm run test:coverage

测试报告样例：

  HTTP Server Initialization
    ✓ should start server on port 80
    ✓ should serve static files from /app directory

  API Endpoint: /server
    ✓ should return 200 for valid module
    ✓ should return 500 for invalid module
    ✓ should return JSON formatted data

  WebSocket Service
    ✓ should establish connection
    ✓ should receive CPU data on request

  7 passing (1.23s)

4. 测试最佳实践

4.1 异步测试处理

Linux Dash大量依赖异步I/O（如child_process.spawn调用linux_json_api.sh），测试中需正确处理异步流程：

// 使用done回调处理异步
it('async test example', (done) => {
  setTimeout(() => {
    expect(1 + 1).to.equal(2);
    done(); // 必须调用done标识完成
  }, 1000);
});

// 或使用async/await
it('async/await example', async () => {
  const result = await new Promise(resolve => {
    setTimeout(() => resolve(2), 1000);
  });
  expect(result).to.equal(2);
});

4.2 测试隔离与Mock

对getPluginData等核心函数进行Mock，避免测试依赖外部脚本：

const sinon = require('sinon'); // 需安装sinon
const { expect } = require('chai');
const server = require('../app/server/index.js');

describe('getPluginData', () => {
  beforeEach(() => {
    // Mock child_process.spawn
    sinon.stub(require('child_process'), 'spawn').returns({
      stdout: { on: (event, cb) => cb('{"test": "data"}') },
      on: (event, cb) => cb(0) // 模拟命令成功退出
    });
  });

  afterEach(() => {
    require('child_process').spawn.restore();
  });

  it('should parse script output', (done) => {
    server.getPluginData('test', (code, output) => {
      expect(code).to.equal(0);
      expect(output).to.deep.equal(['{"test": "data"}']);
      done();
    });
  });
});

5. 常见问题解决方案

5.1 端口冲突问题

测试环境与开发环境端口冲突时，动态指定测试端口：

// 在测试文件顶部添加
process.env.LINUX_DASH_SERVER_PORT = 3000; // 测试专用端口
const server = require('../app/server/index.js');

5.2 异步测试超时

Mocha默认超时时间为2秒，可通过this.timeout()调整：

it('long running test', function() {
  this.timeout(5000); // 延长超时至5秒
  // ... 耗时测试逻辑
});

6. 测试架构演进

6.1 测试金字塔实现

【免费下载链接】linux-dash A beautiful web dashboard for Linux 项目地址: https://gitcode.com/gh_mirrors/li/linux-dash