generator-langium: extended yeoman generator extension to offer parsing, linking, and validation test stubs (#1282) #1298

sailingKieler · 2023-11-20T15:51:56Z

providing additional automated tests for ~~the cases of 'stubsOnly',~~ 'vitest'~~, and 'jest'~~

dhuebner · 2023-11-21T08:51:14Z

@sailingKieler
Running npm run test currently fails for me with:

 FAIL  packages/generator-langium/test/yeoman-generator.test.ts > Check yeoman generator works > 3 Should produce files for Vitest
Error: EACCES: permission denied, mkdir '/__yo-gen-testing'

Could it be that there are too many ..?

Dir name in my case is: __dirname: /workspace/langium/packages/generator-langium/
Test tries to write to: Generating into directory: /__yo-gen-testing

sailingKieler · 2023-11-21T09:11:47Z

Hi Dennis,

@sailingKieler Running npm run test currently fails for me with:
 FAIL  packages/generator-langium/test/yeoman-generator.test.ts > Check yeoman generator works > 3 Should produce files for Vitest
Error: EACCES: permission denied, mkdir '/__yo-gen-testing'
Could it be that there are too many ..?

Dir name in my case is: __dirname: /workspace/langium/packages/generator-langium/ Test tries to write to: Generating into directory: /__yo-gen-testing

The test is supposed to write __yo-gen-testing next to langium, i.e. to /workspace/__yo-gen-testing in order to not see the langium root node_modules. Did you test it on Gitpod?

dhuebner · 2023-11-21T09:35:06Z

@sailingKieler
Yes, I tested it with GitPod. I think the tests should not create files outside the workspace in any (except temp) case. However it seems that there is an additional .. in '../../../../__yo-gen-testing' that can me omitted. Can you confirm?

sailingKieler · 2023-11-21T09:39:09Z

@dhuebner you're right, and I guess that's due to the introduction of

langium/packages/generator-langium/test/yeoman-generator.test.ts

Line 13 in 02b3c92

const __dirname = url.fileURLToPath(new URL('../', import.meta.url));

I had to rebase on. I'll fix that! Thanks a lot for testing! 🙏

spoenemann

Thanks! This is a good addition that has been missing so far.

packages/generator-langium/src/index.ts

spoenemann · 2023-11-21T09:59:05Z

packages/generator-langium/templates/test/test/parsing/parsing.test.ts

+        `);
+
+        // check for absensce of parser errors the classic way:
+        //  deacivated, find a much more human readable way below!


Note: "more human readable" is true for the test output in case of failure, but the readability of the test code is worse. In that regard, I prefer the straightforward one-liner.

I propose to keep the code as it it, but add more explanation why it's useful to optimize for test output readability.

It's basically everybody's choice to switch back to the one liner version.
Regrettably there's no way of attaching custom messages in case of failures AFAIK.

I think it's a chance to show users alternatives. 😉

Added some explanation:

langium/packages/generator-langium/templates/test/test/parsing/parsing.test.ts

Lines 28 to 37 in 01c9028

// check for absensce of parser errors the classic way:

// deacivated, find a much more human readable way below!

// expect(document.parseResult.parserErrors).toHaveLength(0);

expect(

// here we use a (tagged) template expression to create a human readable representation

// of the AST part we are interested in and that is to be compared to our expectation;

// prior to the tagged template expression we check for validity of the parsed document object

// by means of the reusable function 'checkDocumentValid()' to sort out (critical) typos first;

checkDocumentValid(document) || s`

Regrettably there's no way of attaching custom messages in case of failures AFAIK.

There is, just use expect(value, failureMessage)...

😱 Since when is that?

Since we switched to vitest :)

sailingKieler · 2023-11-21T16:29:19Z

@dhuebner feel free to give another try

packages/generator-langium/templates/test/test/linking/linking.test.ts

packages/generator-langium/templates/test/test/parsing/parsing.test.ts

packages/generator-langium/templates/test/test/validating/validating.test.ts

sailingKieler · 2023-11-23T14:21:17Z

okay I dropped the options, and the Jest support, apparently I'm the only lonely wolf using it (in a commercial project).

Should it then be a question, at all? Maybe not.

packages/generator-langium/templates/test/test/linking/linking.test.ts

spoenemann

Thanks, it looks really good. Just two issues:

I see this in the editor for tsconfig.json:

File '/workspace/langium/examples/hello-world/test/linking/linking.test.ts' is not under 'rootDir' '/workspace/langium/examples/hello-world/src'. 'rootDir' is expected to contain all source files.
  The file is in the program because:
    Matched by include pattern 'test/**/*.ts' in '/workspace/langium/examples/hello-world/tsconfig.json'
  File is ECMAScript module because '/workspace/langium/examples/hello-world/package.json' has field "type" with value "module"

I get the following error when I answer "Yes" to all questions:

"initialize" is not exported by "../../node_modules/vscode/extensions.js", imported by "../../node_modules/monaco-languageclient/lib/monaco-vscode-api-services.js".
file: /workspace/langium/node_modules/monaco-languageclient/lib/monaco-vscode-api-services.js:6:9
4:  * ------------------------------------------------------------------------------------------ */
5: import { ILogService, initialize, StandaloneServices } from 'vscode/services';
6: import { initialize as initializeVscodeExtensions } from 'vscode/extensions';
            ^
7: import getLanguagesServiceOverride from '@codingame/monaco-vscode-languages-service-override';
8: import getModelServiceOverride from '@codingame/monaco-vscode-model-service-override';
error during build:
RollupError: "initialize" is not exported by "../../node_modules/vscode/extensions.js", imported by "../../node_modules/monaco-languageclient/lib/monaco-vscode-api-services.js".

kaisalmen · 2023-12-11T09:27:41Z

@spoenemann the second problem I will fix with a separate PR. The minor updates of monaco-vscode-api are pretty major and therefore this error surfaces here. There is CodinGame/monaco-vscode-api#291

kaisalmen · 2023-12-11T10:00:35Z

⬆️ Fix is here: #1317

@sailingKieler consider upgrading to vite v5 / vitest v1 before merging this PR.

sailingKieler · 2023-12-11T13:47:31Z

@sailingKieler consider upgrading to vite v5 / vitest v1 before merging this PR.

Wouldn't that be out of scope for this PR?

kaisalmen · 2023-12-11T13:52:57Z

Wouldn't that be out of scope for this PR?

Only for the generated output, not the whole project

sailingKieler · 2023-12-11T13:55:45Z

Only for the generated output, not the whole project

Of course 🤦🏽‍♂️ 😅

sailingKieler · 2023-12-12T13:35:30Z

consider upgrading to vite v5 / vitest v1 before merging this PR.

Tested upgrading to vitest ~1.0.0 but that requires Node.js v18, see
https://github.com/vitest-dev/vitest/blob/66933c3a590fa5cff35e252a5f107b0f41d9248b/packages/vitest/package.json#L103-L105 and
https://github.com/vitest-dev/vitest/blob/66933c3a590fa5cff35e252a5f107b0f41d9248b/packages/vitest/package.json#L111-L113

The latter causes a conflict during npm i:

npm ERR! code ERESOLVE
npm ERR! ERESOLVE could not resolve
npm ERR! 
npm ERR! While resolving: [email protected]
npm ERR! Found: @types/[email protected]
npm ERR! node_modules/@types/node
npm ERR!   dev @types/node@"~16.18.41" from the root project
npm ERR!   peerOptional @types/node@">= 14" from [email protected]
npm ERR!   node_modules/vite
npm ERR!     dev vite@"~4.4.11" from the root project
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peerOptional @types/node@"^18.0.0 || >=20.0.0" from [email protected]
npm ERR! node_modules/vitest
npm ERR!   dev vitest@"~1.0.0" from the root project
npm ERR! 
npm ERR! Conflicting peer dependency: @types/[email protected]
npm ERR! node_modules/@types/node
npm ERR!   peerOptional @types/node@"^18.0.0 || >=20.0.0" from [email protected]
npm ERR!   node_modules/vitest
npm ERR!     dev vitest@"~1.0.0" from the root project

Do you wanna switch to v18 as minimally required node.js version?

kaisalmen · 2023-12-12T14:09:58Z

Do you wanna switch to v18 as minimally required node.js version?

The question is why not. node 18 was the last LTS version. 20 is the current LTS version. 16 is outdated.

sailingKieler · 2023-12-13T09:21:22Z

Do you wanna switch to v18 as minimally required node.js version?

The question is why not. node 18 was the last LTS version. 20 is the current LTS version. 16 is outdated.

Filed dedicated PR #1319

spoenemann

Thanks, looks good!

sailingKieler · 2023-12-20T13:54:19Z

@msujew @kaisalmen I upgraded the versions of node.js & vitest in the generated package.json, and fixed some further tiny bugs.

Can you guys have a final look?

msujew

Looks good to me. Just minor typos, see below 👍

packages/generator-langium/templates/test/test/validating/validating.test.ts

packages/generator-langium/templates/test/test/parsing/parsing.test.ts

packages/generator-langium/templates/test/test/linking/linking.test.ts

.vscode/launch.json

…ng, linking, and validation test stubs (#1282) * providing an additional automated test running 'npm test' and checking its proper termination

sailingKieler force-pushed the cs/yeoman-lang-test-support branch from 8539202 to cbf46c3 Compare November 20, 2023 16:05

sailingKieler mentioned this pull request Nov 20, 2023

updated import in 'generator.ts' to be properly resolvable without "allowSyntheticDefaultImports": true in 'tsconfig.json' yeoman/generator#1494

Merged

sailingKieler requested review from dhuebner and spoenemann November 20, 2023 17:06

spoenemann reviewed Nov 21, 2023

View reviewed changes

sailingKieler force-pushed the cs/yeoman-lang-test-support branch 3 times, most recently from eda512f to 01c9028 Compare November 21, 2023 16:00

msujew reviewed Nov 22, 2023

View reviewed changes

sailingKieler force-pushed the cs/yeoman-lang-test-support branch 3 times, most recently from e12ba9c to 7b0a010 Compare November 23, 2023 14:17

sailingKieler force-pushed the cs/yeoman-lang-test-support branch 2 times, most recently from 6174214 to af91751 Compare November 23, 2023 15:52

Lotes reviewed Nov 24, 2023

View reviewed changes

packages/generator-langium/templates/test/test/linking/linking.test.ts Show resolved Hide resolved

Lotes reviewed Nov 24, 2023

View reviewed changes

packages/generator-langium/templates/test/test/linking/linking.test.ts Show resolved Hide resolved

sailingKieler force-pushed the cs/yeoman-lang-test-support branch from af91751 to aadafcc Compare November 27, 2023 09:37

spoenemann reviewed Dec 11, 2023

View reviewed changes

sailingKieler force-pushed the cs/yeoman-lang-test-support branch from aadafcc to 89e458a Compare December 12, 2023 13:11

sailingKieler force-pushed the cs/yeoman-lang-test-support branch from 89e458a to 589aef4 Compare December 12, 2023 13:18

sailingKieler force-pushed the cs/yeoman-lang-test-support branch from 589aef4 to b03513b Compare December 12, 2023 13:36

sailingKieler mentioned this pull request Dec 13, 2023

declare minimal node engine version for development to be >= 18.0.0, upgrade vitest to '~1.0.0' #1319

Merged

spoenemann approved these changes Dec 13, 2023

View reviewed changes

sailingKieler force-pushed the cs/yeoman-lang-test-support branch 5 times, most recently from ea60a27 to 21e16c4 Compare December 20, 2023 13:51

msujew approved these changes Dec 21, 2023

View reviewed changes

generator-langium: extended yeoman generator extension to offer parsi…

4f28473

…ng, linking, and validation test stubs (#1282) * providing an additional automated test running 'npm test' and checking its proper termination

sailingKieler force-pushed the cs/yeoman-lang-test-support branch from 21e16c4 to 4f28473 Compare December 21, 2023 15:10

sailingKieler merged commit 2ca2b3a into main Dec 21, 2023
5 checks passed

sailingKieler deleted the cs/yeoman-lang-test-support branch December 21, 2023 15:12

sailingKieler mentioned this pull request Jan 8, 2024

Testing facilities generated out of the box #1282

Closed

spoenemann added this to the v3.0.0 milestone Jan 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

generator-langium: extended yeoman generator extension to offer parsing, linking, and validation test stubs (#1282) #1298

generator-langium: extended yeoman generator extension to offer parsing, linking, and validation test stubs (#1282) #1298

sailingKieler commented Nov 20, 2023 •

edited

Loading

dhuebner commented Nov 21, 2023

sailingKieler commented Nov 21, 2023

dhuebner commented Nov 21, 2023 •

edited

Loading

sailingKieler commented Nov 21, 2023

spoenemann left a comment

spoenemann Nov 21, 2023

spoenemann Nov 21, 2023

sailingKieler Nov 21, 2023 •

edited

Loading

sailingKieler Nov 21, 2023

msujew Nov 22, 2023

sailingKieler Nov 22, 2023

msujew Nov 22, 2023

sailingKieler commented Nov 21, 2023

sailingKieler commented Nov 23, 2023

spoenemann left a comment

kaisalmen commented Dec 11, 2023

kaisalmen commented Dec 11, 2023

sailingKieler commented Dec 11, 2023

kaisalmen commented Dec 11, 2023

sailingKieler commented Dec 11, 2023

sailingKieler commented Dec 12, 2023

kaisalmen commented Dec 12, 2023

sailingKieler commented Dec 13, 2023

spoenemann left a comment

sailingKieler commented Dec 20, 2023

msujew left a comment

	// check for absensce of parser errors the classic way:
	// deacivated, find a much more human readable way below!
	// expect(document.parseResult.parserErrors).toHaveLength(0);

	expect(
	// here we use a (tagged) template expression to create a human readable representation
	// of the AST part we are interested in and that is to be compared to our expectation;
	// prior to the tagged template expression we check for validity of the parsed document object
	// by means of the reusable function 'checkDocumentValid()' to sort out (critical) typos first;
	checkDocumentValid(document) \|\| s`

generator-langium: extended yeoman generator extension to offer parsing, linking, and validation test stubs (#1282) #1298

generator-langium: extended yeoman generator extension to offer parsing, linking, and validation test stubs (#1282) #1298

Conversation

sailingKieler commented Nov 20, 2023 • edited Loading

dhuebner commented Nov 21, 2023

sailingKieler commented Nov 21, 2023

dhuebner commented Nov 21, 2023 • edited Loading

sailingKieler commented Nov 21, 2023

spoenemann left a comment

Choose a reason for hiding this comment

spoenemann Nov 21, 2023

Choose a reason for hiding this comment

spoenemann Nov 21, 2023

Choose a reason for hiding this comment

sailingKieler Nov 21, 2023 • edited Loading

Choose a reason for hiding this comment

sailingKieler Nov 21, 2023

Choose a reason for hiding this comment

msujew Nov 22, 2023

Choose a reason for hiding this comment

sailingKieler Nov 22, 2023

Choose a reason for hiding this comment

msujew Nov 22, 2023

Choose a reason for hiding this comment

sailingKieler commented Nov 21, 2023

sailingKieler commented Nov 23, 2023

spoenemann left a comment

Choose a reason for hiding this comment

kaisalmen commented Dec 11, 2023

kaisalmen commented Dec 11, 2023

sailingKieler commented Dec 11, 2023

kaisalmen commented Dec 11, 2023

sailingKieler commented Dec 11, 2023

sailingKieler commented Dec 12, 2023

kaisalmen commented Dec 12, 2023

sailingKieler commented Dec 13, 2023

spoenemann left a comment

Choose a reason for hiding this comment

sailingKieler commented Dec 20, 2023

msujew left a comment

Choose a reason for hiding this comment

sailingKieler commented Nov 20, 2023 •

edited

Loading

dhuebner commented Nov 21, 2023 •

edited

Loading

sailingKieler Nov 21, 2023 •

edited

Loading