extension/test/integration/utils.test.ts

/*---------------------------------------------------------
 * Copyright (C) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See LICENSE in the project root for license information.
 *--------------------------------------------------------*/

import assert from 'assert';
import * as vscode from 'vscode';
import { GoVersion, substituteEnv } from '../../src/util';
import { filterDiags } from '../../src/diagnostics/diagnostics';
import { toolExecutionEnvironment } from '../../src/goEnv';
import sinon = require('sinon');
import { getGoConfig } from '../../src/config';

suite('utils Tests', () => {
	test('substituteEnv: default', () => {
		// prepare test
		const env = Object.assign({}, process.env);
		process.env['test1'] = 'abcd';
		process.env['test2'] = 'defg';

		const actual = substituteEnv(' ${env:test1} \r\n ${env:test2}\r\n${env:test1}');
		const expected = ' abcd \r\n defg\r\nabcd';

		assert.equal(actual, expected);

		// test completed
		process.env = env;
	});

	test('build GoVersion', () => {
		// [input, wantFormat, wantFormatIncludePrerelease, wantIsValid]
		const testCases: [string, string, string, boolean][] = [
			[
				'go version devel go1.17-756fd56bbf Thu Apr 29 01:15:34 2021 +0000 darwin/amd64',
				'devel 1.17-756fd56bbf',
				'devel 1.17-756fd56bbf',
				true
			],
			['go version go1.14 darwin/amd64', '1.14.0', '1.14', true],
			['go version go1.14.1 linux/amd64', '1.14.1', '1.14.1', true],
			['go version go1.15rc1 darwin/amd64', '1.15.0', '1.15rc1', true],
			['go version go1.15.1rc2 windows/amd64', '1.15.1', '1.15.1rc2', true],
			['go version go1.15.3-beta.1 darwin/amd64', '1.15.3', '1.15.3-beta.1', true],
			['go version go1.15.3-beta.1.2.3 foobar/amd64', '1.15.3', '1.15.3-beta.1.2.3', true],
			['go version go10.0.1 js/amd64', 'unknown', 'unknown', false],
			['something wrong', 'unknown', 'unknown', false]
		];
		for (const [input, wantFormat, wantFormatIncludePrerelease, wantIsValid] of testCases) {
			const go = new GoVersion('/path/to/go', input);

			assert.equal(go.isValid(), wantIsValid, `GoVersion(${input}) = ${JSON.stringify(go)}`);
			assert.equal(go.format(), wantFormat, `GoVersion(${input}) = ${JSON.stringify(go)}`);
			assert.equal(go.format(true), wantFormatIncludePrerelease, `GoVersion(${input}) = ${JSON.stringify(go)}`);
		}
	});
});

suite('Diagnostic Deduplication Tests', () => {
	test('filterDiags removes duplicate diagnostics on same line with equal or lower severity', async () => {
		const targetDiagnostics = [
			new vscode.Diagnostic(
				new vscode.Range(1, 2, 1, 3),
				'first line diagnostic',
				vscode.DiagnosticSeverity.Warning
			),
			new vscode.Diagnostic(
				new vscode.Range(2, 0, 2, 3),
				'second line diagnostic',
				vscode.DiagnosticSeverity.Warning
			),
			new vscode.Diagnostic(new vscode.Range(2, 3, 2, 5), 'second line error', vscode.DiagnosticSeverity.Error),
			new vscode.Diagnostic(
				new vscode.Range(4, 0, 4, 3),
				'fourth line diagnostic',
				vscode.DiagnosticSeverity.Warning
			)
		];

		const maskingDiagnostics = [
			new vscode.Diagnostic(
				new vscode.Range(1, 2, 1, 3),
				'first line diagnostic',
				vscode.DiagnosticSeverity.Warning
			),
			new vscode.Diagnostic(new vscode.Range(2, 3, 2, 5), 'second line error', vscode.DiagnosticSeverity.Error)
		];

		const result = filterDiags(targetDiagnostics, maskingDiagnostics);

		// Diagnostics on line 1 and 2 are masked; only line 4 remains.
		assert.strictEqual(result.length, 1);
		assert.strictEqual(result[0], targetDiagnostics[3]);
	});

	test('filterDiags preserves lower priority diagnostics if they have strictly higher severity', async () => {
		const targetDiagnostics = [
			new vscode.Diagnostic(
				new vscode.Range(1, 2, 1, 3),
				'first line error (lower priority, higher severity)',
				vscode.DiagnosticSeverity.Error
			),
			new vscode.Diagnostic(
				new vscode.Range(2, 0, 2, 3),
				'second line warning (lower priority, equal severity)',
				vscode.DiagnosticSeverity.Warning
			)
		];

		const maskingDiagnostics = [
			new vscode.Diagnostic(
				new vscode.Range(1, 0, 1, 5),
				'first line warning (higher priority, lower severity)',
				vscode.DiagnosticSeverity.Warning
			),
			new vscode.Diagnostic(
				new vscode.Range(2, 0, 2, 5),
				'second line warning (higher priority, equal severity)',
				vscode.DiagnosticSeverity.Warning
			)
		];

		const result = filterDiags(targetDiagnostics, maskingDiagnostics);

		// Line 1 Error is preserved because Error (0) is more severe than Warning (1).
		// Line 2 Warning is masked because Warning (1) is not more severe than Warning (1).
		assert.strictEqual(result.length, 1);
		assert.strictEqual(result[0], targetDiagnostics[0]);
	});
});

suite('goEnv', () => {
	const config = require('../../src/config');
	const sandbox = sinon.createSandbox();
	teardown(() => {
		delete process.env.ENV_VAR_FOR_GO_ENV_TEST;
		sandbox.restore();
	});

	test('toolExecutionEnvironment', () => {
		const goConfig = Object.create(getGoConfig(), {
			toolsEnvVars: {
				value: {
					FOOBAR: '${env:ENV_VAR_FOR_GO_ENV_TEST}/baz',
					FOOBAR2: '${env:UNKNOWN_ENV_VAR}/foo'
				}
			}
		});
		sandbox.stub(config, 'getGoConfig').returns(goConfig);
		process.env['ENV_VAR_FOR_GO_ENV_TEST'] = 'foobar';
		const toolExecEnv = toolExecutionEnvironment(undefined, true);
		assert.strictEqual(toolExecEnv.FOOBAR, 'foobar/baz');
		assert.strictEqual(toolExecEnv.FOOBAR2, '/foo');
	});
});