related-tests/index.test.js at main · javascript-studio/related-tests · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
'use strict';

const fs = require('fs/promises');
const { assert, refute, sinon } = require('@sinonjs/referee-sinon');
const withRelatedTests = require('.');

describe('withRelatedTests', () => {
  const noop = 'true';
  const command = 'mocha -R dot';
  const lintStaged = withRelatedTests(command);

  afterEach(() => {
    sinon.restore();
  });

  it('returns noop for empty file list', async () => {
    const script = await lintStaged([]);

    assert.equals(script, noop);
  });

  it('returns file ending with .test.js', async () => {
    sinon.replace(fs, 'readdir', sinon.fake.resolves(['some.test.js']));

    const script = await lintStaged(['some.test.js']);

    assert.equals(script, `${command} some.test.js`);
  });

  it('returns file ending with -test.js', async () => {
    sinon.replace(fs, 'readdir', sinon.fake.resolves(['some-test.js']));

    const script = await lintStaged(['some-test.js']);

    assert.equals(script, `${command} some-test.js`);
  });

  it('returns matching .test.js files if they exist', async () => {
    sinon.replace(
      fs,
      'readdir',
      sinon.fake.resolves(['foo.js', 'foo.test.js', 'bar.js', 'bar.test.js'])
    );

    const script = await lintStaged(['foo.js', 'bar.js']);

    assert.equals(script, `${command} foo.test.js bar.test.js`);
  });

  it('returns matching -test.js files if they exist', async () => {
    sinon.replace(
      fs,
      'readdir',
      sinon.fake.resolves(['foo.js', 'foo-test.js', 'bar.js', 'bar-test.js'])
    );

    const script = await lintStaged(['foo.js', 'bar.js']);

    assert.equals(script, `${command} foo-test.js bar-test.js`);
  });

  it('returns matching _suffix.test.js files if they exist', async () => {
    sinon.replace(
      fs,
      'readdir',
      sinon.fake.resolves(['foo.js', 'foo_abc.test.js', 'foo_xyz.test.js'])
    );

    const script = await lintStaged(['foo.js', 'bar.js']);

    assert.equals(script, `${command} foo_abc.test.js foo_xyz.test.js`);
  });

  it('returns matching -suffix.test.js files if they exist', async () => {
    sinon.replace(
      fs,
      'readdir',
      sinon.fake.resolves(['foo.js', 'foo-abc.test.js', 'foo-xyz.test.js'])
    );

    const script = await lintStaged(['foo.js', 'bar.js']);

    assert.equals(script, `${command} foo-abc.test.js foo-xyz.test.js`);
  });

  it('returns matching -suffix-test.js files if they exist', async () => {
    sinon.replace(
      fs,
      'readdir',
      sinon.fake.resolves(['foo.js', 'foo-abc-test.js', 'foo-xyz-test.js'])
    );

    const script = await lintStaged(['foo.js', 'bar.js']);

    assert.equals(script, `${command} foo-abc-test.js foo-xyz-test.js`);
  });

  it('returns matching .suffix.test.js files if they exist', async () => {
    sinon.replace(
      fs,
      'readdir',
      sinon.fake.resolves(['foo.js', 'foo.abc.test.js', 'foo.xyz.test.js'])
    );

    const script = await lintStaged(['foo.js', 'bar.js']);

    assert.equals(script, `${command} foo.abc.test.js foo.xyz.test.js`);
  });

  it('returns matching .suffix-test.js files if they exist', async () => {
    sinon.replace(
      fs,
      'readdir',
      sinon.fake.resolves(['foo.js', 'foo.abc-test.js', 'foo.xyz-test.js'])
    );

    const script = await lintStaged(['foo.js', 'bar.js']);

    assert.equals(script, `${command} foo.abc-test.js foo.xyz-test.js`);
  });

  it('does not match files with same basename prefix', async () => {
    sinon.replace(
      fs,
      'readdir',
      sinon.fake.resolves(['data.js', 'data.test.js', 'database.test.js'])
    );

    const script = await lintStaged(['data.js']);

    assert.equals(script, `${command} data.test.js`);
  });

  it('does not return matching test they do not exist', async () => {
    sinon.replace(fs, 'readdir', sinon.fake.resolves(['foo.js', 'bar.js']));

    const script = await lintStaged(['foo.js', 'bar.js']);

    assert.equals(script, noop);
  });

  it('returns file and matching test only once', async () => {
    sinon.replace(
      fs,
      'readdir',
      sinon.fake.resolves(['foo.js', 'foo.test.js', 'bar.js', 'bar.test.js'])
    );

    const script = await lintStaged([
      'foo.js',
      'bar.js',
      'foo.test.js',
      'bar.test.js'
    ]);

    assert.equals(script, `${command} foo.test.js bar.test.js`);
  });

  it('does not call fs.readdir for .test.js files', async () => {
    sinon.replace(fs, 'readdir', sinon.fake.rejects(new Error('Unexpected')));

    await lintStaged(['a.test.js', 'foo/b.test.js']);

    refute.called(fs.readdir);
  });

  it('only calls fs.readdir once per directory', async () => {
    sinon.replace(fs, 'readdir', sinon.fake.resolves([]));

    const script = await lintStaged([
      'foo/a.js',
      'foo/b.js',
      'bar/c.js',
      'bar/d.js',
      'bar/e.js'
    ]);

    assert.calledTwice(fs.readdir);
    assert.calledWith(fs.readdir, 'foo');
    assert.calledWith(fs.readdir, 'bar');
    assert.equals(script, 'true');
  });

  it('only adds matching files in same directory', async () => {
    sinon.replace(
      fs,
      'readdir',
      sinon.fake((dir) => {
        switch (dir) {
          case 'foo':
            return Promise.resolve(['file.test.js']);
          case 'bar':
            return Promise.resolve(['other.test.js']);
          default:
            throw new Error(`Unexpected dir "${dir}"`);
        }
      })
    );

    const script = await lintStaged(['foo/file.js', 'bar/file.js']);

    assert.equals(script, `${command} foo/file.test.js`);
  });
});