単体テストの作成時の不快なエラー

先日、私は内部レポートを作成します。このレポートでは、単体テストの作成時に発生する可能性がある不快なミスについて開発者に報告します。 私の観点から最も不愉快なエラーは、テストに合格したときですが、同時に不合格なので、合格しないほうが良いでしょう。 そして、そのようなエラーの例を全員と共有することにしました。 確かにこの領域から伝えるべき何か他のもの。 Node.JSとMochaの例は書かれていますが、一般的に、これらのエラーは他のエコシステムにも当てはまります。



もっと面白くするために、それらのいくつかは問題コードとスポイラーの形でフレーム化されており、それを開くと、問題が何であったかがわかります。 そのため、まずコードを見て、エラーを見つけてから、スポイラーを開くことをお勧めします。 問題の解決策は示されません。自分で考えることを提案します。 怠け者だから。 リストの順序には深い意味はありません。それは、血まみれの涙になったあらゆる種類の実際の問題を思い出したシーケンスにすぎません。 確かに多くのことはあなたには明らかなように思えますが、経験豊富な開発者でさえ誤ってそのようなコードを書くことができます。





行きましょう。

0.テストの欠如

奇妙なことに、テストを書くと開発速度が低下すると多くの人がいまだに信じています。 もちろん、テストの作成とテスト可能なコードの作成により多くの時間を費やす必要があることは明らかです。 しかし、その後デバッグして退行した後は、さらに多くの時間を費やす必要があります...

1.テスト実行の欠如

実行しないテスト、または時々実行するテストがある場合、これはテストがないようです。 さらに悪いことに、古いテストコードと誤ったセキュリティ意識があります。 コードをブランチにプッシュするときは、少なくともCIプロセスでテストを実行する必要があります。 より良い-プッシュの前にローカルで。 そうすれば、開発者は数日でビルドに戻る必要がなくなり、結局のところ、ビルドに合格しませんでした。

2.カバレッジの欠如

それでもテストのカバレッジがわからない場合は、今すぐ読みに行きましょう。 少なくともウィキペディア 。 それ以外の場合、テストでは、チェックするコードの10％の強度でテストする可能性が高くなります。 遅かれ早かれ、あなたは間違いなくそれに踏み込むでしょう。 もちろん、コードを100％網羅しても、完全に正しいことを保証するわけではありませんが、潜在的なエラーがはるかに多く表示されるため、カバレッジがないよりもはるかに優れています。 Node.JSの最新バージョンがそれを読むための組み込みツールを持っているのも不思議ではありません。 一般的に、報道のトピックは深く、非常に全体論的ですが、私はそれについて深く入りすぎません-私は多くについて少し言いたいです。

3。

const {assert} = require('chai'); const Promise = require('bluebird'); const sinon = require('sinon'); class MightyLibrary { static someLongFunction() { return Promise.resolve(1); // just imagine a really complex and long function here } } async function doItQuickOrFail() { let res; try { res = await MightyLibrary.someLongFunction().timeout(1000); } catch (err) { if (err instanceof Promise.TimeoutError) { return false; } throw err; } return res; } describe('using Timeouts', ()=>{ it('should return false if waited too much', async ()=>{ // stub function to emulate looong work sinon.stub(MightyLibrary, 'someLongFunction').callsFake(()=>Promise.delay(10000).then(()=>true)); const res = await doItQuickOrFail(); assert.equal(res, false); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

4。

 const fs = require('fs'); const testData = JSON.parse(fs.readFileSync('./testData.json', 'utf8')); describe('some block', ()=>{ it('should do something', ()=>{ someTest(testData); }) })
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

5。

 const {assert} = require('chai'); const sinon = require('sinon'); class Dog { // eslint-disable-next-line class-methods-use-this say() { return 'Wow'; } } describe('stubsEverywhere', ()=>{ before(()=>{ sinon.stub(Dog.prototype, 'say').callsFake(()=>{ return 'meow'; }); }); it('should say meow', ()=>{ const dog = new Dog(); assert.equal(dog.say(), 'meow', 'dog should say "meow!"'); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

6。

 const sinon = require('sinon'); const {assert} = require('chai'); class Widget { fetch() {} loadData() { this.fetch(); } } if (!sinon.sandbox || !sinon.sandbox.stub) { sinon.sandbox = sinon.createSandbox(); } describe('My widget', () => { it('is awesome', () => { const widget = new Widget(); widget.fetch = sinon.sandbox.stub().returns({ one: 1, two: 2 }); widget.loadData(); assert.isTrue(widget.fetch.called); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

7.テストファイルの膨大なテストデータ

非常に頻繁に、JSONファイル、さらにはXMLがどれほど巨大であるかをテストに直接見ました。 なぜこれを行う価値がないのかは明らかだと思います。見たり編集したりするのは苦痛になりますが、どのIDEでも感謝することはありません。 大きなテストデータがある場合は、テストファイルから取り出します。

8。

 const {assert} = require('chai'); const crypto = require('crypto'); describe('extraTests', ()=>{ it('should generate unique bytes', ()=>{ const arr = []; for (let i = 0; i < 1000; i++) { const value = crypto.randomBytes(256); arr.push(value); } const unique = arr.filter((el, index)=>arr.indexOf(el) === index); assert.equal(arr.length, unique.length, 'Data is not random enough!'); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

9.モックの欠如

ライブデータベースと100のサービスでテストを実行し、それらに対してテストを実行する方がはるかに簡単です。

しかし、遅かれ早かれ実を結びます-データ削除テストは製品ベースで実行され、パートナーサービスの破損により低下し始めます。または、CIには実行するためのベースがありません。 一般的に、アイテムは非常に全体的ですが、原則として-外部サービスをエミュレートできる場合は、それを行うことをお勧めします。

11。

 const {assert} = require('chai'); class CustomError extends Error { } function mytestFunction() { throw new CustomError('important message'); } describe('badCompare', ()=>{ it('should throw only my custom errors', ()=>{ let errorHappened = false; try { mytestFunction(); } catch (err) { errorHappened = true; assert.isTrue(err instanceof CustomError); } assert.isTrue(errorHappened); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

12。

 const {assert} = require('chai'); function someVeryBigFunc1() { return 1; // imagine a tonn of code here } function someVeryBigFunc2() { return 2; // imagine a tonn of code here } describe('all Before Tests', ()=>{ let res1; let res2; before(async ()=>{ res1 = await someVeryBigFunc1(); res2 = await someVeryBigFunc2(); }); it('should return 1', ()=>{ assert.equal(res1, 1); }); it('should return 2', ()=>{ assert.equal(res2, 2); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

13。

 const {assert} = require('chai'); const moment = require('moment'); function someDateBasedFunction(date) { if (moment().isAfter(date)) { return 0; } return 1; } describe('useFutureDate', ()=>{ it('should return 0 for passed date', ()=>{ const pastDate = moment('2010-01-01'); assert.equal(someDateBasedFunction(pastDate), 0); }); it('should return 1 for future date', ()=>{ const itWillAlwaysBeInFuture = moment('2030-01-01'); assert.equal(someDateBasedFunction(itWillAlwaysBeInFuture), 1); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

14。

 describe('dynamicRequires', ()=>{ it('should return english locale', ()=>{ // HACK : // Some people mutate locale in tests to chinese so I will require moment here // eslint-disable-next-line global-require const moment = require('moment'); const someDate = moment('2010-01-01').format('MMMM'); assert.equal(someDate, 'January'); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

15。

 function someComplexFunc() { // Imagine a piece of really strange code here return 1; } describe('cryptic', ()=>{ it('success', ()=>{ const result = someComplexFunc(); assert.equal(result, 1); }); it('should not fail', ()=>{ const result = someComplexFunc(); assert.equal(result, 1); }); it('is right', ()=>{ const result = someComplexFunc(); assert.equal(result, 1); }); it('makes no difference for solar system', ()=>{ const result = someComplexFunc(); assert.equal(result, 1); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

16。

 const {assert} = require('chai'); const Promise = require('bluebird'); function someTomeoutingFunction() { throw new Promise.TimeoutError(); } describe('no Error check', ()=>{ it('should throw error', async ()=>{ let timedOut = false; try { await someTomeoutingFunction(); } catch (err) { timedOut = true; } assert.equal(timedOut, true); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

17。

 function someBadFunc() { throw new Error('I am just wrong!'); } describe.skip('skipped test', ()=>{ it('should be fine', ()=>{ someBadFunc(); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここにそのような選択が出てきました。 これらのテストはすべてテストに合格しますが、設計上破損しています。 コメント、またはそのような間違いを収集するために作成したリポジトリにオプションを追加します。