Fix bug in Config.py initialization and rework support for MsvcQueryVersionToolsetTests.

Changes:
* module-level initialization index was not renamed from vc_version to msvc_version.
* Add function to return toolset sxs map and versions list in ScriptArguments.py
* Add additional fields to extended version components
* Add data structure for installed vcs versions/toolsets for testing
* Update vcTests.py to new data structure.

Author: jcbrill

SCons/Tool/MSCommon/MSVC/Config.py

@@ -230,7 +230,7 @@
 
     MSVC_BUILDTOOLS_INTERNAL[vc_buildtools] = vc_buildtools_def
     MSVC_BUILDTOOLS_EXTERNAL[vc_buildtools] = vc_buildtools_def
-    MSVC_BUILDTOOLS_EXTERNAL[vc_version] = vc_buildtools_def
+    MSVC_BUILDTOOLS_EXTERNAL[msvc_version] = vc_buildtools_def
 
     for vc_buildseries_def in vc_buildseries_list:
         VC_BUILDTOOLS_MAP[vc_buildseries_def.vc_buildseries] = vc_buildtools_def

SCons/Tool/MSCommon/MSVC/ScriptArguments.py

@@ -1066,6 +1066,14 @@ def _msvc_toolset_versions_internal(msvc_version, vc_dir, full: bool=True, sxs:
 
     return toolset_versions
 
+def _msvc_version_toolsets_internal(msvc_version, vc_dir):
+
+    msvc = _msvc_version(msvc_version)
+
+    toolsets_sxs, toolsets_full = _msvc_version_toolsets(msvc, vc_dir)
+
+    return toolsets_sxs, toolsets_full
+
 def _msvc_toolset_versions_spectre_internal(msvc_version, vc_dir):
 
     msvc = _msvc_version(msvc_version)

SCons/Tool/MSCommon/MSVC/Util.py

@@ -351,17 +351,21 @@ def msvc_version_components(vcver):
     return msvc_version_components_def
 
 _MSVC_EXTENDED_VERSION_COMPONENTS_DEFINITION = namedtuple('MSVCExtendedVersionComponentsDefinition', [
-    'msvc_version', # msvc version (e.g., '14.1Exp')
-    'msvc_verstr',  # msvc version numeric string (e.g., '14.1')
-    'msvc_suffix',  # msvc version component type (e.g., 'Exp')
-    'msvc_vernum',  # msvc version floating point number (e.g, 14.1)
-    'msvc_major',   # msvc major version integer number (e.g., 14)
-    'msvc_minor',   # msvc minor version integer number (e.g., 1)
-    'msvc_comps',   # msvc version components tuple (e.g., ('14', '1'))
+    'msvc_version',      # msvc version (e.g., '14.1Exp')
+    'msvc_verstr',       # msvc version numeric string (e.g., '14.1')
+    'msvc_suffix',       # msvc version component type (e.g., 'Exp')
+    'msvc_suffix_rank',  # msvc version component rank (0, 1)
+    'msvc_vernum',       # msvc version floating point number (e.g, 14.1)
+    'msvc_major',        # msvc major version integer number (e.g., 14)
+    'msvc_minor',        # msvc minor version integer number (e.g., 1)
+    'msvc_comps',        # msvc version components tuple (e.g., ('14', '1'))
     'msvc_buildtools',       # msvc build tools
+    'msvc_buildtools_num',   # msvc build tools integer number
     'msvc_buildseries',      # msvc build series
+    'msvc_buildseries_num',  # msvc build series floating point number
     'msvc_toolset_version',  # msvc toolset version
     'msvc_toolset_comps',    # msvc toolset version components
+    'msvc_toolset_is_sxs',   # msvc toolset version is sxs
     'version',               # msvc version or msvc toolset version
 ])
 
@@ -386,6 +390,7 @@ def msvc_extended_version_components(version):
 
     msvc_toolset_version = m.group('version')
     msvc_toolset_comps = tuple(msvc_toolset_version.split('.'))
+    msvc_toolset_is_sxs = is_toolset_sxs(msvc_toolset_version)
 
     vc_verstr = get_msvc_version_prefix(msvc_toolset_version)
     if not vc_verstr:
@@ -414,14 +419,18 @@ def msvc_extended_version_components(version):
         msvc_version = msvc_version,
         msvc_verstr = msvc_verstr,
         msvc_suffix = msvc_suffix,
+        msvc_suffix_rank = 0 if not msvc_suffix else 1,
         msvc_vernum = msvc_vernum,
         msvc_major = msvc_major,
         msvc_minor = msvc_minor,
         msvc_comps = msvc_comps,
-        msvc_buildtools = vc_buildtools_def.vc_buildtools,
+        msvc_buildtools = vc_buildtools_def.msvc_version,
+        msvc_buildtools_num = vc_buildtools_def.msvc_version_numeric,
         msvc_buildseries = vc_buildseries_def.vc_version,
+        msvc_buildseries_num = vc_buildseries_def.vc_version_numeric,
         msvc_toolset_version = msvc_toolset_version,
         msvc_toolset_comps = msvc_toolset_comps,
+        msvc_toolset_is_sxs = msvc_toolset_is_sxs,
         version = version,
     )
 

SCons/Tool/MSCommon/vc.py

@@ -1229,7 +1229,10 @@ def vswhere_freeze_env(cls, env):
 # external use
 
 def vswhere_register_executable(vswhere_exe, priority=None, freeze=False):
-    debug('register vswhere_exe=%s, priority=%s, freeze=%s', repr(vswhere_exe), repr(priority), repr(freeze))
+    debug(
+        'register vswhere_exe=%s, priority=%s, freeze=%s',
+        repr(vswhere_exe), repr(priority), repr(freeze)
+    )
     _VSWhereExecutable.register_vswhere_executable(vswhere_exe, priority=priority)
     if freeze:
         _VSWhereExecutable.freeze_vswhere_executable()
@@ -2525,6 +2528,8 @@ def msvc_toolset_versions(msvc_version=None, full: bool=True, sxs: bool=False, v
         repr(msvc_version), repr(full), repr(sxs), repr(vswhere_exe)
     )
 
+    _VSWhereExecutable.vswhere_freeze_executable(vswhere_exe)
+
     rval = []
 
     if not msvc_version:
@@ -2549,6 +2554,8 @@ def msvc_toolset_versions(msvc_version=None, full: bool=True, sxs: bool=False, v
 def msvc_toolset_versions_spectre(msvc_version=None, vswhere_exe=None):
     debug('msvc_version=%s, vswhere_exe=%s', repr(msvc_version), repr(vswhere_exe))
 
+    _VSWhereExecutable.vswhere_freeze_executable(vswhere_exe)
+
     rval = []
 
     if not msvc_version:
@@ -2570,33 +2577,70 @@ def msvc_toolset_versions_spectre(msvc_version=None, vswhere_exe=None):
     rval = MSVC.ScriptArguments._msvc_toolset_versions_spectre_internal(msvc_version, vc_dir)
     return rval
 
-def get_installed_vcs_toolsets_components(env=None):
+_InstalledVersionToolset = namedtuple('_InstalledVersionToolset', [
+    'msvc_version_def',
+    'toolset_version_def',
+])
 
-    vcs = get_installed_vcs(env)
+_InstalledVCSToolsetsComponents = namedtuple('_InstalledVCSToolsetComponents', [
+    'sxs_map',
+    'toolset_vcs',
+    'msvc_toolset_component_defs',
+])
 
+def get_installed_vcs_toolsets_components(vswhere_exe=None):
+    debug('vswhere_exe=%s', repr(vswhere_exe))
+
+    _VSWhereExecutable.vswhere_freeze_executable(vswhere_exe)
+
+    sxs_map = {}
+    toolset_vcs = set()
     msvc_toolset_component_defs = []
 
+    vcs = get_installed_vcs()
     for msvc_version in vcs:
+
+        vc_dir = _find_vc_pdir(msvc_version, vswhere_exe)
+        if not vc_dir:
+            continue
+
         msvc_version_def = MSVC.Util.msvc_version_components(msvc_version)
+        toolset_vcs.add(msvc_version_def.msvc_version)
+
         if msvc_version_def.msvc_vernum > 14.0:
-            # VS2017 and later
-            toolset_all_list = msvc_toolset_versions(msvc_version=msvc_version, full=True, sxs=True)
-            for toolset_version in toolset_all_list:
-                debug('msvc_version=%s, toolset_version=%s', repr(msvc_version), repr(toolset_version))
-                toolset_version_def = MSVC.Util.msvc_extended_version_components(toolset_version)
-                if not toolset_version_def:
-                    continue
-                rval = (msvc_version_def, toolset_version_def)
-                msvc_toolset_component_defs.append(rval)
+
+            toolsets_sxs, toolsets_full = MSVC.ScriptArguments._msvc_version_toolsets_internal(
+                msvc_version, vc_dir
+            )
+
+            debug('msvc_version=%s, toolset_sxs=%s', repr(msvc_version), repr(toolsets_sxs))
+            sxs_map.update(toolsets_sxs)
+
         else:
-            # VS2015 and earlier
-            toolset_version = msvc_version_def.msvc_verstr
+
+            toolsets_full = [msvc_version_def.msvc_verstr]
+
+        for toolset_version in toolsets_full:
             debug('msvc_version=%s, toolset_version=%s', repr(msvc_version), repr(toolset_version))
+
             toolset_version_def = MSVC.Util.msvc_extended_version_components(toolset_version)
-            rval = (msvc_version_def, toolset_version_def)
+            if not toolset_version_def:
+                continue
+            toolset_vcs.add(toolset_version_def.msvc_version)
+
+            rval = _InstalledVersionToolset(
+                msvc_version_def=msvc_version_def,
+                toolset_version_def=toolset_version_def,
+            )
             msvc_toolset_component_defs.append(rval)
 
-    return msvc_toolset_component_defs
+    installed_vcs_toolsets_components = _InstalledVCSToolsetsComponents(
+        sxs_map=sxs_map,
+        toolset_vcs=toolset_vcs,
+        msvc_toolset_component_defs=msvc_toolset_component_defs,
+    )
+
+    return installed_vcs_toolsets_components
 
 def msvc_query_version_toolset(version=None, prefer_newest: bool=True, vswhere_exe=None):
     """
@@ -2642,7 +2686,10 @@ def msvc_query_version_toolset(version=None, prefer_newest: bool=True, vswhere_e
         MSVCToolsetVersionNotFound: when the specified version is not found.
         MSVCArgumentError: when argument validation fails.
     """
-    debug('version=%s, prefer_newest=%s', repr(version), repr(prefer_newest))
+    debug(
+        'version=%s, prefer_newest=%s, vswhere_exe=%s',
+        repr(version), repr(prefer_newest), repr(vswhere_exe)
+    )
 
     _VSWhereExecutable.vswhere_freeze_executable(vswhere_exe)
 

SCons/Tool/MSCommon/vcTests.py

@@ -236,12 +236,7 @@ class Data:
 
     INSTALLED_VCS = MSCommon.vc.get_installed_vcs()
     INSTALLED_VCS_COMPONENTS = MSCommon.vc.get_installed_vcs_components()
-
     INSTALLED_VCS_TOOLSETS_COMPONENTS = MSCommon.vc.get_installed_vcs_toolsets_components()
-    INSTALLED_VCS_TOOLSETS = set()
-    for msvc_version_def, toolset_version_def in INSTALLED_VCS_TOOLSETS_COMPONENTS:
-        INSTALLED_VCS_TOOLSETS.add(msvc_version_def.msvc_version)
-        INSTALLED_VCS_TOOLSETS.add(toolset_version_def.msvc_version)
 
     @classmethod
     def query_version_list(cls, vcver):
@@ -504,7 +499,7 @@ def test_valid_default_msvc(self) -> None:
 
     def test_valid_vcver(self) -> None:
         for symbol in MSCommon.vc._VCVER:
-            have_msvc = bool(symbol in Data.INSTALLED_VCS_TOOLSETS)
+            have_msvc = bool(symbol in Data.INSTALLED_VCS_TOOLSETS_COMPONENTS.toolset_vcs)
             version_def = MSCommon.msvc_version_components(symbol)
             for prefer_newest in (True, False):
                 if not have_msvc: