test: Add test for "needCheckForUpdates"

[tanishiking]

#1144

This commit adds a test for needCheckForUpdates.

For adding unit tests, this commit abstract away the logic that needs
access to vscode APIs, becuase we need to run an integration test for
accessing vscode APIs.
see: microsoft/vscode-wordcount#5 (comment)
microsoft/vscode#82471 (comment)

[tanishiking]

Copied from tanishiking#82

kpodsiad commented 7 hours ago
One problem with assert is that it doesn't provide meaningful error messages. I was thinking about using earl, wdyt?

Yeah, adding an assertion library is good 👍
However, in that case, I would choose chai as its tried and tested solution (or I would pick jest instead of mocha + earljs as all-in-one test framework, but I personally prefer mocha + chai + sinon for testing node project).

[tanishiking]

we can use spy.calledWith(...), but this way will show better error message if test fail (while calledWith shows true or false)

[kpodsiad]

Copied from tanishiking#82

kpodsiad commented 7 hours ago
One problem with assert is that it doesn't provide meaningful error messages. I was thinking about using earl, wdyt?

Yeah, adding an assertion library is good 👍 However, in that case, I would choose chai as its tried and tested solution (or I would pick jest instead of mocha + earljs as all-in-one test framework, but I personally prefer mocha + chai + sinon for testing node project).

Actually I was wrong. assert is good enough, it has meaningful errors and it doesn't require additional dependency. I intentionally switched jest to mocha in this repository simple because it's much smaller than jest and it doesn't bring so many dependencies (I recall some problems with them)

[tanishiking]

I intentionally switched jest to mocha in this repository simple because it's much smaller than jest and it doesn't bring so many dependencies

Yeah, I also think mocha chai sinon would be noice in this repository (than jest) 👍
You don't want to add chai as a dependency? I prefer to use chai because I like BDD style testing and it's small library.

[kpodsiad]

You don't want to add chai as a dependency? I prefer to use chai because I like BDD style testing and it's small library.

It's ok, I just meant that I forgot that node's assert also provides good errors ;)

I think we're missing one important think (correct me if I' worng) - do we have some docs how to run single test file, single test from suite? That would be nice to have.
TBH, even yarn test might be useful for people like don't do js day to day.

[kpodsiad]

I think it's more common to use interface for such data types

[tanishiking]

I don't have a strong opinion, but I prefer to use type over interface for the data types that shouldn't be extended (by inheritance or declaration merging).

[kpodsiad]

SO it's not a problem that interface is located in the same file which has imports from vscode package as long as it doesn't use them, nice. Maybe I'll rewrite/write some unit tests for test explorer then :D

[tanishiking]

Thanks! Added docs on how to run tests b70d5b3
merging after CIs pass