Configure unit tests by nzaytsev · Pull Request #3590 · gitkraken/vscode-gitlens

nzaytsev · 2024-09-19T04:33:49Z

Description

makes vscode-tests running with vscode/test-cli
adds testing to GH workflow

Checklist

I have followed the guidelines in the Contributing document
My changes follow the coding style of this project
My changes build without any errors or warnings
My changes have been formatted and linted
My changes include any required corresponding changes to the documentation (including CHANGELOG.md and README.md)
My changes have been rebased and squashed to the minimal number (typically 1) of relevant commits
My changes have a descriptive commit message with a short title, including a Fixes $XXX - or Closes #XXX - prefix to auto-close the issue that your PR addresses

eamodio · 2024-09-19T04:38:14Z

src/repositories.ts

-// import { CharCode } from './string';

-const slash = 47; //CharCode.Slash;
+const slash = CharCode.Slash;


I'd suggest leaving this as 47 -- bundlers don't handle the const enum properly and inject the value at the call site, instead they end up with this whole module/object lookup indirection

ok. is it the problem of project structure? I mean could we store one file for each enum with default export instead? I know it can be inconvenient now, it's just a clarification

eamodio · 2024-09-19T04:38:38Z

src/system/path.ts

 export { basename, dirname, extname, join as joinPaths } from 'path';

-const slash = 47; //slash;
+const slash = CharCode.Slash;


eamodio · 2024-09-19T04:38:55Z

src/system/trie.ts

-// import { CharCode } from './string';

-const slash = 47; //CharCode.Slash;
+const slash = CharCode.Slash;


eamodio · 2024-09-19T04:47:19Z

src/env/node/fast-string-truncated-width.ts

Why was this split out?

it broke the tests running

Actually, I can't remember how I found it first time, but I checked it now, running yarn test without the splitting leads to the error

Mini-developer:vscode-gitlens developer$ yarn test yarn run v1.22.22 $ yarn run build:tests $ tsc -p tsconfig.test.json && tsc-alias -p tsconfig.test.json $ vscode-test ✔ Validated version: 1.93.1 ✔ Found existing install in /Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1 [main 2024-09-19T06:25:25.870Z] update#setState disabled [main 2024-09-19T06:25:25.873Z] update#ctor - updates are disabled by the environment 2024-09-19 13:25:26.624 Code Helper (Renderer)[25737:9616656] CoreText note: Client requested name ".NewYork-Regular", it will get TimesNewRomanPSMT rather than the intended font. All system UI font access should be through proper APIs such as CTFontCreateUIFontForLanguage() or +[NSFont systemFontOfSize:]. 2024-09-19 13:25:26.624 Code Helper (Renderer)[25737:9616656] CoreText note: Set a breakpoint on CTFontLogSystemFontNameRequest to debug. Started local extension host with pid 25762. Loading development extension at /Users/developer/vscode-gitlens Error [ERR_REQUIRE_ESM]: require() of ES Module /Users/developer/vscode-gitlens/node_modules/fast-string-truncated-width/dist/index.js from /Users/developer/vscode-gitlens/out/system/string.js not supported. Instead change the require of index.js in /Users/developer/vscode-gitlens/out/system/string.js to a dynamic import() which is available in all CommonJS modules. at c._load (node:electron/js2c/node_init:2:13801) at y._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:184:6031) at i._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:181:32144) at n._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:146:34326) at Object.<anonymous> (/Users/developer/vscode-gitlens/out/system/string.js:39:55) at c._load (node:electron/js2c/node_init:2:13801) at y._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:184:6031) at i._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:181:32144) at n._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:146:34326) at Object.<anonymous> (/Users/developer/vscode-gitlens/out/git/models/reference.js:28:18) at c._load (node:electron/js2c/node_init:2:13801) at y._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:184:6031) at i._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:181:32144) at n._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:146:34326) at Object.<anonymous> (/Users/developer/vscode-gitlens/out/env/node/git/git.js:43:21) at c._load (node:electron/js2c/node_init:2:13801) at y._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:184:6031) at i._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:181:32144) at n._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:146:34326) at Object.<anonymous> (/Users/developer/vscode-gitlens/out/env/node/providers.js:33:15) at c._load (node:electron/js2c/node_init:2:13801) at y._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:184:6031) at i._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:181:32144) at n._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:146:34326) at Object.<anonymous> (/Users/developer/vscode-gitlens/out/container.js:34:21) at c._load (node:electron/js2c/node_init:2:13801) at y._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:184:6031) at i._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:181:32144) at n._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:146:34326) at Object.<anonymous> (/Users/developer/vscode-gitlens/out/git/gitUri.js:17:21) at c._load (node:electron/js2c/node_init:2:13801) at y._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:184:6031) at i._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:181:32144) at n._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:146:34326) at Object.<anonymous> (/Users/developer/vscode-gitlens/out/repositories.js:8:18) at c._load (node:electron/js2c/node_init:2:13801) at y._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:184:6031) at i._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:181:32144) at n._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:146:34326) at Object.<anonymous> (/Users/developer/vscode-gitlens/out/system/__tests__/trie.test.js:34:24) at c._load (node:electron/js2c/node_init:2:13801) at y._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:184:6031) at i._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:181:32144) at n._load (/Users/developer/vscode-gitlens/.vscode-test/vscode-darwin-1.93.1/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:146:34326) at /Users/developer/vscode-gitlens/node_modules/mocha/lib/mocha.js:416:36 at Array.forEach (<anonymous>) at Mocha.loadFiles (/Users/developer/vscode-gitlens/node_modules/mocha/lib/mocha.js:413:14) [main 2024-09-19T06:25:28.047Z] Extension host with pid 25762 exited with code: 0, signal: unknown.

ah, remembered. mocha can't import from 'vscode', so if you need to test any module that imports from vscode, you should think about it's mock. I tried different ways to mock in mocha, but it didn't work

used fork
https://github.com/nzaytsev/fast-string-truncated-width
@gk-nzaytsev/fast-string-truncated-width@1.1.0

eamodio · 2024-09-19T04:47:33Z

src/env/browser/fast-string-truncated-width.ts

Why was this split out?

see comment above

eamodio · 2024-09-19T04:49:01Z

webpack.config.js

 					cache: true,
 					cacheLocation: path.join(__dirname, '.eslintcache', 'webviews/'),
 					cacheStrategy: 'content',
+					// uses config file src/webviews/apps/.eslintrc.json


What is this comment for?

unnecessary, I'll remove

eamodio · 2024-09-19T04:50:11Z

.github/workflows/unit-tests.yml

Can we make these a "check" on the PR, so it can't be merged until they pass?

of course, I wanted to do this. but I need admin permission to GH for this. I tested on my test repos

Here is my local repo ruleset configuration

- Stored in __tests__ subdirectories - Adds sample tests for iterable and color - Adds restriction for using .only tests suites

lishaduck · 2024-10-08T03:25:24Z

tsconfig.test.json

+		"module": "CommonJS",
+		"moduleResolution": "Node",


Happened to see this PR in the release notes, and skimmed through it as I was curious 🙃.

Is there a reason to use the "Node" moduleResolution? https://www.typescriptlang.org/tsconfig/#moduleResolution (It's deprecated in favor of the equivalent Node10, which is itself discouraged)

Actually, there was an issue with other moduleResolution values, there is a bulk of issues on mocha side. As a rude example - this. But now tests building is moved to esbuild and now moduleResolution is not considered when building. It can be safely removed. /cc @eamodio

#3648

nzaytsev mentioned this pull request Sep 19, 2024

Fixes unit tests runnings and improves eslint configuration #3391

Closed

7 tasks

nzaytsev requested a review from eamodio September 19, 2024 04:37

nzaytsev linked an issue Sep 19, 2024 that may be closed by this pull request

Configure unit tests #3570

Closed

eamodio requested changes Sep 19, 2024

View reviewed changes

nzaytsev force-pushed the debt/unit-tests branch from f876184 to 0005bcf Compare September 19, 2024 06:44

nzaytsev requested a review from eamodio September 19, 2024 06:45

nzaytsev force-pushed the debt/unit-tests branch 3 times, most recently from e9cb6b1 to 3ba8253 Compare September 20, 2024 09:05

nzaytsev added 2 commits September 20, 2024 10:47

Adds new unit test structure

7f8b287

- Stored in __tests__ subdirectories - Adds sample tests for iterable and color - Adds restriction for using .only tests suites

Adds docker config and test workflow

3c8cee6

eamodio force-pushed the debt/unit-tests branch from 3ba8253 to 3c8cee6 Compare September 20, 2024 14:57

eamodio approved these changes Sep 20, 2024

View reviewed changes

eamodio merged commit 5de3214 into main Sep 20, 2024

lishaduck reviewed Oct 8, 2024

View reviewed changes

eamodio deleted the debt/unit-tests branch October 14, 2024 14:48

Conversation

nzaytsev commented Sep 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nzaytsev Sep 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nzaytsev commented Sep 19, 2024 •

edited

Loading

nzaytsev Sep 19, 2024 •

edited

Loading