Write productId and productPath to output

heaths · heaths · commit 05d412dc641b · 2017-10-02T13:18:50.000-07:00
Partly resolves #104
diff --git a/docker/Tests/vswhere.tests.ps1 b/docker/Tests/vswhere.tests.ps1
@@ -219,6 +219,18 @@ Describe 'vswhere' {
             $instance.channelId | Should Be 'VisualStudio.15.Release/public.d15rel/15.0.26117.0'
             $instance.enginePath | Should Be 'C:\Program Files (x86)\Microsoft Visual Studio\Installer\resources\app\ServiceHub\Services\Microsoft.VisualStudio.Setup.Service'
         }
+
+        It '-property productId' {
+            $instances = C:\bin\vswhere.exe -latest -property productId -format json | ConvertFrom-Json
+            $instances.Count | Should Be 1
+            $instances[0].productId | Should Be 'Microsoft.VisualStudio.Product.Enterprise'
+        }
+
+        It '-property productPath' {
+            $instances = C:\bin\vswhere.exe -latest -property productPath -format json | ConvertFrom-Json
+            $instances.Count | Should Be 1
+            $instances[0].productPath | Should Be 'C:\VS\Enterprise\Common7\IDE\devenv.exe'
+        }
     }
 
     Context '-latest -all' {
diff --git a/src/vswhere.lib/Formatter.cpp b/src/vswhere.lib/Formatter.cpp
@@ -17,6 +17,8 @@ Formatter::Formatter()
         { L"installationName", bind(&Formatter::GetInstallationName, this, _1, _2) },
         { L"installationPath", bind(&Formatter::GetInstallationPath, this, _1, _2) },
         { L"installationVersion", bind(&Formatter::GetInstallationVersion, this, _1, _2) },
+        { L"productId", bind(&Formatter::GetProductId, this, _1, _2) },
+        { L"productPath", bind(&Formatter::GetProductPath, this, _1, _2) },
         { L"isPrerelease", bind(&Formatter::GetIsPrerelease, this, _1, _2) },
         { L"displayName", bind(&Formatter::GetDisplayName, this, _1, _2) },
         { L"description", bind(&Formatter::GetDescription, this, _1, _2) },
@@ -305,6 +307,58 @@ HRESULT Formatter::GetInstallationVersion(_In_ ISetupInstance* pInstance, _Out_
     return GetStringProperty(bind(&ISetupInstance::GetInstallationVersion, pInstance, _1), pvtInstallationVersion);
 }
 
+HRESULT Formatter::GetProductId(_In_ ISetupInstance* pInstance, _Out_ VARIANT* pvtProductId)
+{
+    ISetupInstance2Ptr instance;
+
+    auto hr = pInstance->QueryInterface(&instance);
+    if (SUCCEEDED(hr))
+    {
+        ISetupPackageReferencePtr reference;
+
+        hr = instance->GetProduct(&reference);
+        if (SUCCEEDED(hr))
+        {
+            variant_t vt;
+
+            hr = reference->GetId(&vt.bstrVal);
+            if (SUCCEEDED(hr))
+            {
+                vt.vt = VT_BSTR;
+                *pvtProductId = vt.Detach();
+            }
+        }
+    }
+
+    return hr;
+}
+
+HRESULT Formatter::GetProductPath(_In_ ISetupInstance* pInstance, _Out_ VARIANT* pvtProductPath)
+{
+    ISetupInstance2Ptr instance;
+
+    auto hr = pInstance->QueryInterface(&instance);
+    if (SUCCEEDED(hr))
+    {
+        bstr_t bstrProductPath;
+
+        hr = instance->GetProductPath(bstrProductPath.GetAddress());
+        if (SUCCEEDED(hr))
+        {
+            variant_t vt;
+
+            hr = instance->ResolvePath(bstrProductPath, &vt.bstrVal);
+            if (SUCCEEDED(hr))
+            {
+                vt.vt = VT_BSTR;
+                *pvtProductPath = vt.Detach();
+            }
+        }
+    }
+
+    return hr;
+}
+
 HRESULT Formatter::GetIsPrerelease(_In_ ISetupInstance* pInstance, _Out_ VARIANT* pvtIsPrerelease)
 {
     ISetupInstanceCatalogPtr catalog;
diff --git a/src/vswhere.lib/Formatter.h b/src/vswhere.lib/Formatter.h
@@ -66,11 +66,12 @@ class Formatter
     HRESULT GetInstallationName(_In_ ISetupInstance* pInstance, _Out_ VARIANT* pvtInstallationName);
     HRESULT GetInstallationPath(_In_ ISetupInstance* pInstance, _Out_ VARIANT* pvtInstallationPath);
     HRESULT GetInstallationVersion(_In_ ISetupInstance* pInstance, _Out_ VARIANT* pvtInstallationVersion);
+    HRESULT GetProductId(_In_ ISetupInstance* pInstance, _Out_ VARIANT* pvtProductId);
+    HRESULT GetProductPath(_In_ ISetupInstance* pInstance, _Out_ VARIANT* pvtProductPath);
     HRESULT GetIsPrerelease(_In_ ISetupInstance* pInstance, _Out_ VARIANT* pvtIsPrerelease);
     HRESULT GetDisplayName(_In_ ISetupInstance* pInstance, _Out_ VARIANT* pvtDisplayName);
     HRESULT GetDescription(_In_ ISetupInstance* pInstance, _Out_ VARIANT* pvtDescription);
 
-
     void WriteInternal(_In_ const CommandArgs& args, _In_ Console& console, _In_ ISetupInstance* pInstance);
     void WriteProperty(_In_ Console& console, _In_ const std::wstring& name, _In_ const variant_t& value);
     void WriteProperties(_In_ const CommandArgs& args, _In_ Console& console, _In_ ISetupInstance* pInstance);
diff --git a/test/vswhere.test/TestInstance.h b/test/vswhere.test/TestInstance.h
@@ -5,7 +5,6 @@
 
 #pragma once
 
-
 class TestInstance :
     public ISetupInstance2
 {
@@ -151,7 +150,34 @@ class TestInstance :
         _Out_ BSTR* pbstrAbsolutePath
     )
     {
-        return E_NOTIMPL;
+        if (!pbstrAbsolutePath)
+        {
+            return E_POINTER;
+        }
+
+        bstr_t bstrPath;
+
+        auto hr = GetInstallationPath(bstrPath.GetAddress());
+        if (SUCCEEDED(hr))
+        {
+            std::experimental::filesystem::v1::path absolutePath((LPWSTR)bstrPath);
+
+            hr = GetProductPath(bstrPath.GetAddress());
+            if (SUCCEEDED(hr))
+            {
+                absolutePath.append((LPWSTR)bstrPath);
+
+                *pbstrAbsolutePath = ::SysAllocString(absolutePath.c_str());
+                if (!*pbstrAbsolutePath)
+                {
+                    return E_OUTOFMEMORY;
+                }
+
+                return S_OK;
+            }
+        }
+
+        return E_FAIL;
     }
 
     // ISetupInstance2
@@ -277,6 +303,10 @@ class TestInstance :
         if (SUCCEEDED(hr))
         {
             *pbstrValue = ::SysAllocString(value.c_str());
+            if (!*pbstrValue)
+            {
+                return E_OUTOFMEMORY;
+            }
         }
 
         return hr;
diff --git a/test/vswhere.test/TextFormatterTests.cpp b/test/vswhere.test/TextFormatterTests.cpp
@@ -67,4 +67,59 @@ TEST_CLASS(TextFormatterTests)
 
         Assert::AreEqual(expected, console);
     }
+
+    BEGIN_TEST_METHOD_ATTRIBUTE(Writes_ProductId)
+        TEST_WORKITEM(104)
+    END_TEST_METHOD_ATTRIBUTE()
+    TEST_METHOD(Writes_ProductId)
+    {
+        CommandArgs args;
+        TestConsole console(args);
+
+        TestPackageReference product =
+        {
+            { L"Id", L"Microsoft.VisualStudio.Product.Enterprise" },
+        };
+
+        TestInstance::MapType properties =
+        {
+            { L"InstanceId", L"a1b2c3" },
+        };
+
+        TestInstance instance(&product, {}, properties);
+
+        TextFormatter sut;
+        sut.Write(args, console, &instance);
+
+        auto expected =
+            L"instanceId: a1b2c3\n"
+            L"productId: Microsoft.VisualStudio.Product.Enterprise\n";
+
+        Assert::AreEqual(expected, console);
+    }
+
+    BEGIN_TEST_METHOD_ATTRIBUTE(Writes_ProductPath)
+        TEST_WORKITEM(104)
+    END_TEST_METHOD_ATTRIBUTE()
+    TEST_METHOD(Writes_ProductPath)
+    {
+        CommandArgs args;
+        TestConsole console(args);
+        TestInstance instance =
+        {
+            { L"InstanceId", L"a1b2c3" },
+            { L"InstallationPath", L"C:\\ShouldNotExist" },
+            { L"ProductPath", L"Common7\\IDE\\devenv.exe" },
+        };
+
+        TextFormatter sut;
+        sut.Write(args, console, &instance);
+
+        auto expected =
+            L"instanceId: a1b2c3\n"
+            L"installationPath: C:\\ShouldNotExist\n"
+            L"productPath: C:\\ShouldNotExist\\Common7\\IDE\\devenv.exe\n";
+
+        Assert::AreEqual(expected, console);
+    }
 };
diff --git a/test/vswhere.test/stdafx.h b/test/vswhere.test/stdafx.h
@@ -14,6 +14,7 @@
 #include <windows.h>
 
 // STL headers
+#include <filesystem>
 #include <unordered_map>
 
 // Project headers
diff --git a/version.json b/version.json
@@ -1,6 +1,6 @@
 ﻿{
   "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "2.1",
+  "version": "2.2",
   "publicReleaseRefSpec": [
     "^refs/heads/master$",
     "^refs/heads/release/",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",`
`3`		`- "version": "2.1",`
	`3`	`+ "version": "2.2",`
`4`	`4`	`"publicReleaseRefSpec": [`
`5`	`5`	`"^refs/heads/master$",`
`6`	`6`	`"^refs/heads/release/",`