https://github.com/ymzuiku/eest

Easy-to-use, incredibly fast, test tool that maintains the `original operating environment'.
https://github.com/ymzuiku/eest

Last synced: about 2 months ago
JSON representation

Easy-to-use, incredibly fast, test tool that maintains the `original operating environment'.

• Host: GitHub
• URL: https://github.com/ymzuiku/eest
• Owner: ymzuiku
• License: mit
• Created: 2019-09-30T02:32:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-13T15:33:22.000Z (over 5 years ago)
• Last Synced: 2025-02-23T10:22:38.795Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 94.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-CN.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Eest

> 易用的, 速度惊人的, 保持`原运行环境`的测试工具

> 有着原始的 console 打印和原始报错信息，回归了源程序本来的面貌

做一个测试需要哪些任务：

- 引入源程序

- 执行并且记录测试结果

Eest 就只做了这些

## Eest 存在的意义

jest \ ava 等测试库做的都太多了，它们为了更好的定位错误，分离执行测试程序和执行程序，这导致于测试执行过程中的程序和我们平时执行过程中所呈现的感受不一致。每当我们执行这些测试程序的时候，都有一种和执行源程序不一致的感官。

回想测试的本质是什么？它仅仅是代替我们手动去校验程序。我们需要的仅仅是一个自动执行的程序，根据我们描述的校验规则去执行。程序异常和源程序一样，唯一的不同仅仅是我们多写了一些测试用例。

Eest 就是如此，虽然 jest 很伟大，但是 Eest 才是我要的。它让我感觉编写和执行测试代码没有任何负担，有着原始的 console 打印和原始报错信息，回归了源程序本来的面貌。

既然是最原始的面貌，它给我们带来了:

- 高性能, 难以置信的快速

- 没有全局变量

- 没有黑魔法

- 没有需要额外学习的 API

于此同时，我们为此失去：

- 没有测试覆盖率检查：如果你非常需要它，或许未来会有一个平行的运行环境去补获测试覆盖率

- 没有分离每个单元的运行环境：这对于某些情况来说是好事，它或许可以暴露有副作用的函数

## 原理

Eest 原理非常简单，它仅仅是提供了几个函数，用于我们记录校验的结果，我们引入测试目标代码，并且使用 node 执行。最后 Eest 抛出测试校验结果，仅此而已。它简单到以致于作者仅仅是在睡觉前两个小时的编写就完成了核心功能。

Eest 也不会多做额外的事情，甚至 watch 等行为都交给现成的第三方库，如 nodemon

## 安装

```sh

$ npm i eest --save

```

## 使用

**创建文件**

```md

- controller;

  createUser.js;

  createUser.spec.js; //我们在需要测试的 js 附近创建一个用于测试的文件，文件名随意

```

**编写测试文件**

```js

const createUser = require('createUser');

module.exports = (describe, cache) => {

  // console.log(cache) // {} global cache data

  describe('Create user', async test => {

    // get async/await something

    const db = await MongoClient('....');

    test('Check password length', assert => {

      const user = createUser('username', '123');

      assert(user.password.length >= 6);

    });

  });

};

```

## 对整个项目进行测试

我们编写 package.json , 添加 scripts

```json

{

  "scripts": {

    "test": "eest ./src 'spec.js, test.js'"

  }

}

```

以上脚本表示，命令执行目录下，文件名包含 spec.js 或 test.js 的文件都会被引入并进行测试

之所以没有进行分离执行，一是为了更好的性能，并且作者希望它们之间若有干扰，由开发者自行处理。

## 自动焦距错误测试文件

Eest 会自动 Focus 上一次错误的测试文件，这样可以在成百上千个测试文件中，聚焦当前遇到错误的文件堆盏，大幅度提高性能，当错误解决之后，Eest 才会重新遍历整个测试目标文件夹。

错误的缓存文件储存在 `node_modules/_eestErrorCache.json`, 我们亦可手动清除它来重新遍历整个测试文件夹

## Watch

Eest 原本的设计仅仅是引入测试对象，执行 node 程序的极简方式，因为简单，所以自然和 node 周边的生态有了很好的兼容。我们可以直接使用 nodemon 等库做改动监听：

```sh

$ npm i nodemon --save

```

修改 package.json, 使用 nodemon:

```json

{

  "scripts": {

    "test": "nodemon node_modules/.bin/eest ./src 'spec.js, test.js' -watch"

  }

}

```

添加 `-watch` 表示程序执行之后不会主动退出

## Babel

为了不污染原项目的 babel，我们使用 @babel/register, 并且在测试启动前引入它。

我们使用 eest.config.js 文件，它会在所有测试执行之前执行

安装 @babel/register:

```sh

yarn add @babel/core @babel/register -D

```

在项目根目录创建 `eest.config.js`:

```js

const { resolve } = require('path');

require('@babel/register')({

  ignore: [/node_modules/],

  cache: true,

  configFile: resolve(__dirname, 'babel.eest.json'),

});

```

创建 babel.eest.json 编写 babel 配置.

更多 babel 信息，请参考：https://babeljs.io/docs/en/next/babel-register.html

执行测试:

```js

eest ./src spec.js

```

## 配置 mongodb 或其他前置条件

在项目根目录创建 `eest.config.js`:

```js

// 导出的函数会在 promise 之后再执行后续的测试

modules.exports = async cache => {

  cache.db = await MongodbClient('...');

};

```

谢谢使用