visual_studio_test.dart 27.6 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:file/memory.dart';
6 7 8
import 'package:flutter_tools/src/base/file_system.dart';
import 'package:flutter_tools/src/base/io.dart' show ProcessException;
import 'package:flutter_tools/src/base/logger.dart';
9
import 'package:flutter_tools/src/base/platform.dart';
10 11 12
import 'package:flutter_tools/src/convert.dart';
import 'package:flutter_tools/src/windows/visual_studio.dart';

13
import '../../src/common.dart';
14
import '../../src/fake_process_manager.dart';
15 16 17

const String programFilesPath = r'C:\Program Files (x86)';
const String visualStudioPath = programFilesPath + r'\Microsoft Visual Studio\2017\Community';
18
const String cmakePath = visualStudioPath + r'\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin\cmake.exe';
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
const String vswherePath = programFilesPath + r'\Microsoft Visual Studio\Installer\vswhere.exe';

final Platform windowsPlatform = FakePlatform(
  operatingSystem: 'windows',
  environment: <String, String>{
    'PROGRAMFILES(X86)': r'C:\Program Files (x86)\',
  },
);

// A minimum version of a response where a VS installation was found.
const Map<String, dynamic> _defaultResponse = <String, dynamic>{
  'installationPath': visualStudioPath,
  'displayName': 'Visual Studio Community 2019',
  'installationVersion': '16.2.29306.81',
  'isRebootRequired': false,
  'isComplete': true,
  'isLaunchable': true,
  'isPrerelease': false,
  'catalog': <String, dynamic>{
    'productDisplayVersion': '16.2.5',
  },
};

42 43 44 45 46 47 48 49 50 51 52 53 54 55
// A minimum version of a response where a Build Tools installation was found.
const Map<String, dynamic> _defaultBuildToolsResponse = <String, dynamic>{
  'installationPath': visualStudioPath,
  'displayName': 'Visual Studio Build Tools 2019',
  'installationVersion': '16.7.30413.136',
  'isRebootRequired': false,
  'isComplete': true,
  'isLaunchable': true,
  'isPrerelease': false,
  'catalog': <String, dynamic>{
    'productDisplayVersion': '16.7.2',
  },
};

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
// A response for a VS installation that's too old.
const Map<String, dynamic> _tooOldResponse = <String, dynamic>{
  'installationPath': visualStudioPath,
  'displayName': 'Visual Studio Community 2017',
  'installationVersion': '15.9.28307.665',
  'isRebootRequired': false,
  'isComplete': true,
  'isLaunchable': true,
  'isPrerelease': false,
  'catalog': <String, dynamic>{
    'productDisplayVersion': '15.9.12',
  },
};

// A version of a response that doesn't include certain installation status
// information that might be missing in older vswhere.
const Map<String, dynamic> _missingStatusResponse = <String, dynamic>{
  'installationPath': visualStudioPath,
  'displayName': 'Visual Studio Community 2017',
  'installationVersion': '16.4.29609.76',
  'catalog': <String, dynamic>{
    'productDisplayVersion': '16.4.1',
  },
};

81 82 83 84
// Arguments for a vswhere query to search for an installation with the
// requirements.
const List<String> _requirements = <String>[
  'Microsoft.VisualStudio.Workload.NativeDesktop',
85
  'Microsoft.VisualStudio.Component.VC.Tools.x86.x64',
86
  'Microsoft.VisualStudio.Component.VC.CMake.Project',
87 88
];

89 90 91 92 93 94 95 96
// Arguments for a vswhere query to search for a Build Tools installation with the
// requirements.
const List<String> _requirementsBuildTools = <String>[
  'Microsoft.VisualStudio.Workload.VCTools',
  'Microsoft.VisualStudio.Component.VC.Tools.x86.x64',
  'Microsoft.VisualStudio.Component.VC.CMake.Project',
];

97 98 99 100 101 102
// Sets up the mock environment so that searching for Visual Studio with
// exactly the given required components will provide a result. By default it
// return a preset installation, but the response can be overridden.
void setMockVswhereResponse(
  FileSystem fileSystem,
  FakeProcessManager processManager, [
103 104 105 106 107 108
  List<String>? requiredComponents,
  List<String>? additionalArguments,
  Map<String, dynamic>? response,
  String? responseOverride,
  int? exitCode,
  Exception? exception,
109 110
]) {
  fileSystem.file(vswherePath).createSync(recursive: true);
111
  fileSystem.file(cmakePath).createSync(recursive: true);
112
  final String finalResponse = responseOverride
113
    ?? (response != null ? json.encode(<Map<String, dynamic>>[response]) : '');
114 115 116 117 118 119 120 121 122
  final List<String> requirementArguments = requiredComponents == null
    ? <String>[]
    : <String>['-requires', ...requiredComponents];

  processManager.addCommand(FakeCommand(
    command: <String>[
      vswherePath,
      '-format',
      'json',
123 124
      '-products',
      '*',
125 126 127
      '-utf8',
      '-latest',
      ...?additionalArguments,
128
      ...requirementArguments,
129 130
    ],
    stdout: finalResponse,
131 132
    exception: exception,
    exitCode: exitCode ?? 0,
133 134
  ));
}
135

136 137 138
// Sets whether or not a vswhere query with the required components will
// return an installation.
void setMockCompatibleVisualStudioInstallation(
139
  Map<String, dynamic>? response,
140
  FileSystem fileSystem,
141
  FakeProcessManager processManager, [
142 143
  int? exitCode,
  Exception? exception,
144
]) {
145 146 147
  setMockVswhereResponse(
    fileSystem,
    processManager,
148
    _requirements,
149 150
    <String>['-version', '16'],
    response,
151 152 153
    null,
    exitCode,
    exception,
154
  );
155 156
}

157 158 159
// Sets whether or not a vswhere query with the required components will
// return a pre-release installation.
void setMockPrereleaseVisualStudioInstallation(
160
  Map<String, dynamic>? response,
161
  FileSystem fileSystem,
162
  FakeProcessManager processManager, [
163 164
  int? exitCode,
  Exception? exception,
165
]) {
166 167 168
  setMockVswhereResponse(
    fileSystem,
    processManager,
169
    _requirements,
170 171
    <String>['-version', '16', '-prerelease'],
    response,
172 173 174
    null,
    exitCode,
    exception,
175 176
  );
}
177

178 179 180
// Sets whether or not a vswhere query with the required components will
// return an Build Tools installation.
void setMockCompatibleVisualStudioBuildToolsInstallation(
181
  Map<String, dynamic>? response,
182
  FileSystem fileSystem,
183
  FakeProcessManager processManager, [
184 185
  int? exitCode,
  Exception? exception,
186
]) {
187 188 189 190 191 192
  setMockVswhereResponse(
    fileSystem,
    processManager,
    _requirementsBuildTools,
    <String>['-version', '16'],
    response,
193 194 195
    null,
    exitCode,
    exception,
196 197 198 199 200 201
  );
}

// Sets whether or not a vswhere query with the required components will
// return a pre-release Build Tools installation.
void setMockPrereleaseVisualStudioBuildToolsInstallation(
202
  Map<String, dynamic>? response,
203
  FileSystem fileSystem,
204
  FakeProcessManager processManager, [
205 206
  int? exitCode,
  Exception? exception,
207
]) {
208 209 210 211 212 213
  setMockVswhereResponse(
    fileSystem,
    processManager,
    _requirementsBuildTools,
    <String>['-version', '16', '-prerelease'],
    response,
214 215 216
    null,
    exitCode,
    exception,
217 218 219
  );
}

220 221 222
// Sets whether or not a vswhere query searching for 'all' and 'prerelease'
// versions will return an installation.
void setMockAnyVisualStudioInstallation(
223
  Map<String, dynamic>? response,
224
  FileSystem fileSystem,
225
  FakeProcessManager processManager, [
226 227
  int? exitCode,
  Exception? exception,
228
]) {
229 230 231 232 233 234
  setMockVswhereResponse(
    fileSystem,
    processManager,
    null,
    <String>['-prerelease', '-all'],
    response,
235 236 237
    null,
    exitCode,
    exception,
238 239
  );
}
240

241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
// Set a pre-encoded query result.
void setMockEncodedAnyVisualStudioInstallation(
  String response,
  FileSystem fileSystem,
  FakeProcessManager processManager,
) {
  setMockVswhereResponse(
    fileSystem,
    processManager,
    null,
    <String>['-prerelease', '-all'],
    null,
    response,
  );
}
256

257 258 259
// Sets up the mock environment for a Windows 10 SDK query.
//
// registryPresent controls whether or not the registry key is found.
260
// filesPresent controls where or not there are any SDK folders at the location
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
// returned by the registry query.
void setMockSdkRegResponse(
  FileSystem fileSystem,
  FakeProcessManager processManager, {
  bool registryPresent = true,
  bool filesPresent = true,
}) {
  const String registryPath = r'HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Microsoft SDKs\Windows\v10.0';
  const String registryKey = r'InstallationFolder';
  const String installationPath = r'C:\Program Files (x86)\Windows Kits\10\';
  final String stdout = registryPresent
    ? '''
$registryPath
    $registryKey    REG_SZ    $installationPath
'''
    : '''

ERROR: The system was unable to find the specified registry key or value.
''';

  if (filesPresent) {
    final Directory includeDirectory =  fileSystem.directory(installationPath).childDirectory('Include');
    includeDirectory.childDirectory('10.0.17763.0').createSync(recursive: true);
    includeDirectory.childDirectory('10.0.18362.0').createSync(recursive: true);
    // Not an actual version; added to ensure that version comparison is number, not string-based.
    includeDirectory.childDirectory('10.0.184.0').createSync(recursive: true);
  }

  processManager.addCommand(FakeCommand(
    command: const <String>[
      'reg',
      'query',
      registryPath,
      '/v',
      registryKey,
    ],
    stdout: stdout,
  ));
}

301 302
// Create a visual studio instance with a FakeProcessManager.
VisualStudioFixture setUpVisualStudio() {
303
  final FakeProcessManager processManager = FakeProcessManager.empty();
304 305 306 307 308 309 310 311 312 313 314
  final FileSystem fileSystem = MemoryFileSystem.test(style: FileSystemStyle.windows);
  final BufferLogger logger = BufferLogger.test();
  final VisualStudio visualStudio = VisualStudio(
    fileSystem: fileSystem,
    platform: windowsPlatform,
    logger: logger,
    processManager: processManager,
  );
  return VisualStudioFixture(visualStudio, fileSystem, processManager);
}

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
// Set all vswhere query with the required components return null.
void setNoViableToolchainInstallation(
  VisualStudioFixture fixture,
) {
  setMockCompatibleVisualStudioInstallation(
    null,
    fixture.fileSystem,
    fixture.processManager,
  );
  setMockCompatibleVisualStudioBuildToolsInstallation(
    null,
    fixture.fileSystem,
    fixture.processManager,
  );
  setMockPrereleaseVisualStudioInstallation(
    null,
    fixture.fileSystem,
    fixture.processManager,
  );
  setMockPrereleaseVisualStudioBuildToolsInstallation(
    null,
    fixture.fileSystem,
    fixture.processManager,
  );
}

341 342
void main() {
  group('Visual Studio', () {
343 344 345 346 347 348 349 350 351 352 353 354
    testWithoutContext('isInstalled throws when PROGRAMFILES(X86) env not set', () {
      final VisualStudio visualStudio = VisualStudio(
        logger: BufferLogger.test(),
        fileSystem: MemoryFileSystem.test(style: FileSystemStyle.windows),
        platform: FakePlatform(operatingSystem: 'windows'),
        processManager: FakeProcessManager.any(),
      );

      expect(() => visualStudio.isInstalled,
          throwsToolExit(message: '%PROGRAMFILES(X86)% environment variable not found'));
    });

355 356 357
    testWithoutContext('isInstalled and cmakePath correct when vswhere is missing', () {
      final FileSystem fileSystem = MemoryFileSystem.test(style: FileSystemStyle.windows);
      const Exception exception = ProcessException('vswhere', <String>[]);
358
      final FakeProcessManager fakeProcessManager = FakeProcessManager.empty();
359

360 361 362 363 364
      setMockCompatibleVisualStudioInstallation(null, fileSystem, fakeProcessManager, null, exception);
      setMockCompatibleVisualStudioBuildToolsInstallation(null, fileSystem, fakeProcessManager, null, exception);
      setMockPrereleaseVisualStudioInstallation(null, fileSystem, fakeProcessManager, null, exception);
      setMockPrereleaseVisualStudioBuildToolsInstallation(null, fileSystem, fakeProcessManager, null, exception);
      setMockAnyVisualStudioInstallation(null, fileSystem, fakeProcessManager, null, exception);
365

366 367
      final VisualStudio visualStudio = VisualStudio(
        logger: BufferLogger.test(),
368
        fileSystem: fileSystem,
369
        platform: windowsPlatform,
370
        processManager: fakeProcessManager,
371
      );
372

373
      expect(visualStudio.isInstalled, false);
374
      expect(visualStudio.cmakePath, isNull);
375 376
    });

377 378
    testWithoutContext(
        'isInstalled returns false when vswhere returns non-zero', () {
379
      final FileSystem fileSystem = MemoryFileSystem.test(style: FileSystemStyle.windows);
380
      final FakeProcessManager fakeProcessManager = FakeProcessManager.empty();
381 382 383 384 385 386 387

      setMockCompatibleVisualStudioInstallation(null, fileSystem, fakeProcessManager, 1);
      setMockCompatibleVisualStudioBuildToolsInstallation(null, fileSystem, fakeProcessManager, 1);
      setMockPrereleaseVisualStudioInstallation(null, fileSystem, fakeProcessManager, 1);
      setMockPrereleaseVisualStudioBuildToolsInstallation(null, fileSystem, fakeProcessManager, 1);
      setMockAnyVisualStudioInstallation(null, fileSystem, fakeProcessManager, 1);

388 389
      final VisualStudio visualStudio = VisualStudio(
        logger: BufferLogger.test(),
390
        fileSystem: fileSystem,
391
        platform: windowsPlatform,
392
        processManager: fakeProcessManager,
393
      );
394 395

      expect(visualStudio.isInstalled, false);
396
      expect(visualStudio.cmakePath, isNull);
397 398
    });

399 400 401 402
    testWithoutContext('VisualStudio getters return the right values if no installation is found', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

403 404
      setNoViableToolchainInstallation(fixture);

405 406 407 408 409
      setMockAnyVisualStudioInstallation(
        null,
        fixture.fileSystem,
        fixture.processManager,
      );
410 411

      expect(visualStudio.isInstalled, false);
412
      expect(visualStudio.isAtLeastMinimumVersion, false);
413 414 415 416 417 418 419 420 421 422
      expect(visualStudio.hasNecessaryComponents, false);
      expect(visualStudio.isComplete, false);
      expect(visualStudio.isRebootRequired, false);
      expect(visualStudio.isLaunchable, false);
      expect(visualStudio.displayName, null);
      expect(visualStudio.displayVersion, null);
      expect(visualStudio.installLocation, null);
      expect(visualStudio.fullVersion, null);
    });

423 424 425 426 427 428 429 430 431
    testWithoutContext('necessaryComponentDescriptions suggest the right VS tools on major version 16', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

      setMockCompatibleVisualStudioInstallation(
        _defaultResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
432

433
      final String toolsString = visualStudio.necessaryComponentDescriptions()[0];
434

435
      expect(toolsString.contains('v142'), true);
436 437
    });

438 439 440 441
    testWithoutContext('necessaryComponentDescriptions suggest the right VS tools on an old version', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

442 443
      setNoViableToolchainInstallation(fixture);

444 445 446 447 448
      setMockAnyVisualStudioInstallation(
        _tooOldResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
449

450
      final String toolsString = visualStudio.necessaryComponentDescriptions()[0];
451

452 453 454
      expect(toolsString.contains('v142'), true);
    });

455 456 457 458
    testWithoutContext('isInstalled returns true even with missing status information', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

459 460
      setNoViableToolchainInstallation(fixture);

461 462 463 464 465
      setMockAnyVisualStudioInstallation(
        _missingStatusResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
466 467 468 469

      expect(visualStudio.isInstalled, true);
    });

470 471 472 473
    testWithoutContext('isInstalled returns true when VS is present but missing components', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

474 475
      setNoViableToolchainInstallation(fixture);

476 477 478 479 480
      setMockAnyVisualStudioInstallation(
        _defaultResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
481 482 483 484

      expect(visualStudio.isInstalled, true);
    });

485 486 487 488
    testWithoutContext('isInstalled returns true when VS is present but too old', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

489 490
      setNoViableToolchainInstallation(fixture);

491 492 493 494 495
      setMockAnyVisualStudioInstallation(
        _tooOldResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
496 497 498 499

      expect(visualStudio.isInstalled, true);
    });

500 501 502
    testWithoutContext('isInstalled returns true when a prerelease version of VS is present', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;
503

504
      final Map<String, dynamic> response = Map<String, dynamic>.of(_defaultResponse)
505
        ..['isPrerelease'] = true;
506 507 508 509 510
      setMockCompatibleVisualStudioInstallation(
        null,
        fixture.fileSystem,
        fixture.processManager,
      );
511 512
      setMockCompatibleVisualStudioBuildToolsInstallation(
        null,
513 514 515
        fixture.fileSystem,
        fixture.processManager,
      );
516 517
      setMockPrereleaseVisualStudioInstallation(
        response,
518 519 520
        fixture.fileSystem,
        fixture.processManager,
      );
521

522
      expect(visualStudio.isInstalled, true);
523
      expect(visualStudio.isPrerelease, true);
524 525
    });

526
    testWithoutContext('isInstalled returns true when a prerelease version of Build Tools is present', () {
527 528 529
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

530 531
      final Map<String, dynamic> response = Map<String, dynamic>.of(_defaultBuildToolsResponse)
        ..['isPrerelease'] = true;
532 533 534 535 536
      setMockCompatibleVisualStudioInstallation(
        null,
        fixture.fileSystem,
        fixture.processManager,
      );
537 538 539 540 541
      setMockCompatibleVisualStudioBuildToolsInstallation(
        null,
        fixture.fileSystem,
        fixture.processManager,
      );
542 543 544 545 546
      setMockPrereleaseVisualStudioInstallation(
        null,
        fixture.fileSystem,
        fixture.processManager,
      );
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
      setMockPrereleaseVisualStudioBuildToolsInstallation(
        response,
        fixture.fileSystem,
        fixture.processManager,
      );

      expect(visualStudio.isInstalled, true);
      expect(visualStudio.isPrerelease, true);
    });

    testWithoutContext('isAtLeastMinimumVersion returns false when the version found is too old', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

      setNoViableToolchainInstallation(fixture);

563 564 565 566 567
      setMockAnyVisualStudioInstallation(
        _tooOldResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
568 569 570 571 572

      expect(visualStudio.isInstalled, true);
      expect(visualStudio.isAtLeastMinimumVersion, false);
    });

573 574 575 576
    testWithoutContext('isComplete returns false when an incomplete installation is found', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

577
      setNoViableToolchainInstallation(fixture);
578

579
      final Map<String, dynamic> response = Map<String, dynamic>.of(_defaultResponse)
580
        ..['isComplete'] = false;
581 582 583 584 585
      setMockAnyVisualStudioInstallation(
        response,
        fixture.fileSystem,
        fixture.processManager,
      );
586 587 588 589 590

      expect(visualStudio.isInstalled, true);
      expect(visualStudio.isComplete, false);
    });

591 592 593 594 595
    testWithoutContext(
        "isLaunchable returns false if the installation can't be launched", () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

596
      setNoViableToolchainInstallation(fixture);
597

598
      final Map<String, dynamic> response = Map<String, dynamic>.of(_defaultResponse)
599
        ..['isLaunchable'] = false;
600 601 602 603 604
      setMockAnyVisualStudioInstallation(
        response,
        fixture.fileSystem,
        fixture.processManager,
      );
605 606 607 608 609

      expect(visualStudio.isInstalled, true);
      expect(visualStudio.isLaunchable, false);
    });

610 611 612 613
    testWithoutContext('isRebootRequired returns true if the installation needs a reboot', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

614
      setNoViableToolchainInstallation(fixture);
615

616
      final Map<String, dynamic> response = Map<String, dynamic>.of(_defaultResponse)
617
        ..['isRebootRequired'] = true;
618 619 620 621 622
      setMockAnyVisualStudioInstallation(
        response,
        fixture.fileSystem,
        fixture.processManager,
      );
623 624 625 626 627

      expect(visualStudio.isInstalled, true);
      expect(visualStudio.isRebootRequired, true);
    });

628 629 630 631
    testWithoutContext('hasNecessaryComponents returns false when VS is present but missing components', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

632 633
      setNoViableToolchainInstallation(fixture);

634 635 636 637 638
      setMockAnyVisualStudioInstallation(
        _defaultResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
639

640 641 642
      expect(visualStudio.hasNecessaryComponents, false);
    });

643
    testWithoutContext('cmakePath returns null when VS is present but missing components', () {
644 645 646
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

647 648
      setNoViableToolchainInstallation(fixture);

649 650 651 652 653
      setMockAnyVisualStudioInstallation(
        _defaultResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
654

655
      expect(visualStudio.cmakePath, isNull);
656 657
    });

658
    testWithoutContext('cmakePath returns null when VS is present but with require components but installation is faulty', () {
659 660 661
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

662
      final Map<String, dynamic> response = Map<String, dynamic>.of(_defaultResponse)
663
        ..['isRebootRequired'] = true;
664 665 666 667 668
      setMockCompatibleVisualStudioInstallation(
        response,
        fixture.fileSystem,
        fixture.processManager,
      );
669

670
      expect(visualStudio.cmakePath, isNull);
671 672
    });

673 674 675 676
    testWithoutContext('hasNecessaryComponents returns false when VS is present with required components but installation is faulty', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

677
      final Map<String, dynamic> response = Map<String, dynamic>.of(_defaultResponse)
678
        ..['isRebootRequired'] = true;
679 680 681 682 683
      setMockCompatibleVisualStudioInstallation(
        response,
        fixture.fileSystem,
        fixture.processManager,
      );
684

685 686 687
      expect(visualStudio.hasNecessaryComponents, false);
    });

688 689 690 691
    testWithoutContext('VS metadata is available when VS is present, even if missing components', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

692 693
      setNoViableToolchainInstallation(fixture);

694 695 696 697 698
      setMockAnyVisualStudioInstallation(
        _defaultResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
699

700 701
      expect(visualStudio.displayName, equals('Visual Studio Community 2019'));
      expect(visualStudio.displayVersion, equals('16.2.5'));
702
      expect(visualStudio.installLocation, equals(visualStudioPath));
703
      expect(visualStudio.fullVersion, equals('16.2.29306.81'));
704 705
    });

706
    testWithoutContext('cmakePath returns null when VS is present but when vswhere returns invalid JSON', () {
707 708 709
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

710 711
      setNoViableToolchainInstallation(fixture);

712 713 714 715 716
      setMockEncodedAnyVisualStudioInstallation(
        '{',
        fixture.fileSystem,
        fixture.processManager,
      );
717

718
      expect(visualStudio.cmakePath, isNull);
719 720
    });

721 722 723 724 725 726 727 728 729
    testWithoutContext('Everything returns good values when VS is present with all components', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

      setMockCompatibleVisualStudioInstallation(
        _defaultResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
730 731 732 733 734 735 736 737 738 739 740 741

      expect(visualStudio.isInstalled, true);
      expect(visualStudio.isAtLeastMinimumVersion, true);
      expect(visualStudio.hasNecessaryComponents, true);
      expect(visualStudio.cmakePath, equals(cmakePath));
    });

    testWithoutContext('Everything returns good values when Build Tools is present with all components', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

      setMockCompatibleVisualStudioInstallation(
742 743 744 745
        null,
        fixture.fileSystem,
        fixture.processManager,
      );
746 747
      setMockCompatibleVisualStudioBuildToolsInstallation(
        _defaultBuildToolsResponse,
748 749 750
        fixture.fileSystem,
        fixture.processManager,
      );
751 752

      expect(visualStudio.isInstalled, true);
753
      expect(visualStudio.isAtLeastMinimumVersion, true);
754
      expect(visualStudio.hasNecessaryComponents, true);
755
      expect(visualStudio.cmakePath, equals(cmakePath));
756 757
    });

758 759 760 761
    testWithoutContext('Metadata is for compatible version when latest is missing components', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

762 763 764 765 766 767 768
      // Return a different version for queries without the required packages.
      final Map<String, dynamic> olderButCompleteVersionResponse = <String, dynamic>{
        'installationPath': visualStudioPath,
        'displayName': 'Visual Studio Community 2017',
        'installationVersion': '15.9.28307.665',
        'catalog': <String, dynamic>{
          'productDisplayVersion': '15.9.12',
769
        },
770 771
      };

772 773 774 775 776
      setMockCompatibleVisualStudioInstallation(
        olderButCompleteVersionResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
777
      // Return a different version for queries without the required packages.
778 779 780 781 782 783 784 785
      final Map<String, dynamic> incompleteVersionResponse = <String, dynamic>{
        'installationPath': visualStudioPath,
        'displayName': 'Visual Studio Community 2019',
        'installationVersion': '16.1.1.1',
        'catalog': <String, String>{
          'productDisplayVersion': '16.1',
        },
      };
786 787 788 789 790
      setMockAnyVisualStudioInstallation(
        incompleteVersionResponse,
        fixture.fileSystem,
        fixture.processManager,
      );
791 792 793 794

      expect(visualStudio.displayName, equals('Visual Studio Community 2017'));
      expect(visualStudio.displayVersion, equals('15.9.12'));
    });
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832

    testWithoutContext('SDK version returns the latest version when present', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

      setMockSdkRegResponse(
        fixture.fileSystem,
        fixture.processManager,
      );

      expect(visualStudio.getWindows10SDKVersion(), '10.0.18362.0');
    });

    testWithoutContext('SDK version returns null when the registry key is not present', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

      setMockSdkRegResponse(
        fixture.fileSystem,
        fixture.processManager,
        registryPresent: false,
      );

      expect(visualStudio.getWindows10SDKVersion(), null);
    });

    testWithoutContext('SDK version returns null when there are no SDK files present', () {
      final VisualStudioFixture fixture = setUpVisualStudio();
      final VisualStudio visualStudio = fixture.visualStudio;

      setMockSdkRegResponse(
        fixture.fileSystem,
        fixture.processManager,
        filesPresent: false,
      );

      expect(visualStudio.getWindows10SDKVersion(), null);
    });
833 834
  });
}
835 836 837 838 839 840 841 842

class VisualStudioFixture {
  VisualStudioFixture(this.visualStudio, this.fileSystem, this.processManager);

  final VisualStudio visualStudio;
  final FileSystem fileSystem;
  final FakeProcessManager processManager;
}