SCANNPM-130 Refactor integration tests to use tsx and Node test runner by vdiez · Pull Request #383 · SonarSource/sonar-scanner-npm

vdiez · 2026-01-08T16:11:07Z

Summary

Migrate integration tests from Jest to Node's native test runner (node:test)
Use tsx to run TypeScript directly without compilation step
Move orchestrator from tools/orchestrator/ to test/integration/orchestrator/
Convert scanner.test.js to scanner.test.ts with ESM imports
Add CLI test alongside existing API test
Add tsconfig.json for both unit and integration tests
Move test/setup.ts to test/unit/setup.ts
Simplify CI workflow by removing orchestrator build step
Add CLAUDE.md with project documentation

Test plan

Unit tests pass (npm test)
Integration tests pass (npm run test-integration)
Build succeeds (npm run build)
CI workflow passes

🤖 Generated with Claude Code

- Migrate integration tests from Jest to Node's native test runner - Use tsx to run TypeScript directly without compilation - Move orchestrator from tools/orchestrator to test/integration/orchestrator - Convert scanner.test.js to scanner.test.ts with ESM imports - Add CLI test alongside existing API test - Add tsconfig.json for both unit and integration tests - Move test/setup.ts to test/unit/setup.ts - Simplify CI workflow by removing orchestrator build step - Add CLAUDE.md with project documentation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

hashicorp-vault-sonar-prod · 2026-01-08T16:12:31Z

SCANNPM-130

sonarqubecloud · 2026-01-08T16:14:24Z

SonarQube reviewer guide

Important

We are currently testing different models for AI Summary.
Please give us your feedback by filling this form.

Model A:

Summary: Restructure integration test setup and move orchestrator tools into test directory

Review Focus: The PR migrates integration tests from Jest to Node's native test runner with ESM support, consolidates orchestrator tools within the test directory, and removes duplication in the CI workflow. Key changes include:

Migration to Node test runner with TypeScript via tsx
Orchestrator tools moved from tools/ to test/integration/
Integration test setup streamlined in CI workflow
Added CLAUDE.md documentation file

Start review at: test/integration/scanner.test.ts. This is the core integration test file that demonstrates the new test structure and validates both API and CLI invocation patterns.

Model B:

Summary: Restructures the integration test infrastructure by relocating the orchestrator from tools/ to test/integration/, converting it to ESM, and modernizing the test runner from Jest to Node's native test framework with tsx.

Review Focus:

The CI/CD workflow change moving npm pack earlier in the build pipeline—verify this doesn't break the integration test setup
ESM conversion in orchestrator files, particularly __dirname/__filename polyfills and import statement changes
Integration test migration from Jest to Node's native test runner (scanner.test.js → scanner.test.ts)
The new test-integration script now runs npm install before tests—ensure lock file is committed and accurate

Start review at: .github/workflows/build.yml. The workflow restructuring is the linchpin of this PR—moving npm pack from the "Setup integration test" step into the build step, then removing that entire setup step. This affects test execution flow and should be validated against the relocated orchestrator paths and the updated integration test imports.

See all code changes, issues, and quality metrics in one place.

Quality Gate failed

Failed conditions
1 New issue

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

zglicz

Great overall, small qs

zglicz · 2026-01-09T09:54:57Z

.github/workflows/build.yml

-      - name: Setup integration test
-        run: |
-          (cd build && npm pack)
-          cp build/sonar-scan-SNAPSHOT.tgz test/integration
-          (cd test/integration && npm install --no-save sonar-scan-SNAPSHOT.tgz)
-          (cd tools/orchestrator && npm run build)
-        shell: bash
-


zglicz · 2026-01-09T09:55:15Z

test/integration/orchestrator/download.ts

+import * as https from 'node:https';
+import * as fs from 'node:fs';
+import { execSync } from 'node:child_process';
+import * as path from 'node:path';
 import * as mkdirp from 'mkdirp';
-import * as os from 'os';
+import * as os from 'node:os';


we don't have this as a rule already? or was it accepted?

zglicz · 2026-01-09T09:55:41Z

test/integration/package.json

+  "dependencies": {
+    "axios": "1.13.2",
+    "mkdirp": "3.0.1",
+    "@sonar/scan": "file:../../build/sonar-scan-SNAPSHOT.tgz"


sooo much better!

zglicz · 2026-01-09T09:55:58Z

test/integration/scanner.test.ts

+  return path.join(__dirname.replace(/\\+/g, '/'), '/fixtures/fake_project_for_integration/src');
+}
+
+async function assertOneIssueAtLine21(projectKey: string) {


thats a bit specific function name

zglicz · 2026-01-09T09:59:25Z

test/integration/scanner.test.ts

+    execSync(
+      `npx sonar ` +
+        `-Dsonar.host.url=${SONAR_HOST_URL} ` +
+        `-Dsonar.token=${token} ` +
+        `-Dsonar.projectKey=${projectKey} ` +
+        `-Dsonar.projectName=${projectKey} ` +
+        `-Dsonar.log.level=DEBUG ` +
+        `-Dsonar.sources=${getSourcesPath()}`,
+      { stdio: 'inherit' },
+    );


hm... 1 worry I could have here that the developer could have @sonar/scan installed locally and it wouldn't be the one picked up by npx sonar . Can we add a verify so that this actually runs the locally installed package?

zglicz · 2026-01-09T10:00:07Z

CLAUDE.md

+
+## Project Overview
+
+`@sonar/scan` is an NPM module that triggers SonarQube Server and SonarCloud analyses on JavaScript codebases without requiring specific tools or Java runtime installation. The scanner detects server capabilities and either uses JRE provisioning (preferred, SonarQube 10.6+) or falls back to native sonar-scanner-cli.


I would remove any mention of versions in the this md file

zglicz · 2026-01-09T10:01:21Z

CLAUDE.md

+- `getLatestSonarQube()` - Download/cache SonarQube
+- `startAndReady(sqPath, maxWaitMs)` - Start and wait until operational
+- `stop(sqPath)` - Stop SonarQube instance
+- `generateToken()` - Generate GLOBAL_ANALYSIS_TOKEN
+- `createProject()` - Create project with random key
+- `waitForAnalysisFinished(maxWaitMs)` - Poll until analysis queue empty
+- `getIssues(projectKey)` - Fetch detected issues


is that a bit too much specifics of the implementation?

zglicz · 2026-01-09T10:01:55Z

knip.json

-    "tools/orchestrator": {
-      "entry": ["scripts/*"],
-      "ignore": ["dist/**/*"]
+    "test/integration": {


should unit tests be also included here?

i will once i remove jest

zglicz · 2026-01-09T10:02:50Z

package.json

    "build": "npm run license && tsc && tsx scripts/generate-package-json.ts",
    "test": "node_modules/.bin/jest --coverage",
-    "test-integration": "cd test/integration && npm test",
+    "test-integration": "cd test/integration && npm install && npm test",


does this command change where the user is? perhaps it should be in parenthesis?

vdiez · 2026-01-09T12:00:59Z

I will handle the comments in the next PR, @zglicz

vdiez requested a review from zglicz January 8, 2026 16:11

hashicorp-vault-sonar-prod bot changed the title ~~Refactor integration tests to use tsx and Node test runner~~ SCANNPM-130 Refactor integration tests to use tsx and Node test runner Jan 8, 2026

zglicz approved these changes Jan 9, 2026

View reviewed changes

vdiez merged commit 0a88f6e into master Jan 9, 2026
9 of 10 checks passed

vdiez deleted the refactor/integration-tests-tsx branch January 9, 2026 12:01


		## Project Overview

		`@sonar/scan` is an NPM module that triggers SonarQube Server and SonarCloud analyses on JavaScript codebases without requiring specific tools or Java runtime installation. The scanner detects server capabilities and either uses JRE provisioning (preferred, SonarQube 10.6+) or falls back to native sonar-scanner-cli.

Conversation

vdiez commented Jan 8, 2026

Summary

Test plan

Uh oh!

hashicorp-vault-sonar-prod bot commented Jan 8, 2026 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonarqubecloud bot commented Jan 8, 2026

SonarQube reviewer guide

Model A:

Model B:

Quality Gate failed

Uh oh!

zglicz left a comment

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!

vdiez commented Jan 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hashicorp-vault-sonar-prod bot commented Jan 8, 2026 •

edited by atlassian bot

Loading