The Azure cloud shell connector (microsoft#1808)

* We can now connect to the Azure cloud shell microsoft#1235

Author: PankajBhojwani

src/cascadia/CascadiaPackage/CascadiaPackage.wapproj

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="15.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <Import Project="..\..\..\common.openconsole.props" Condition="'$(OpenConsoleDir)'==''" />
   <Import Project="$(OpenConsoleDir)src\wap-common.build.pre.props" />
@@ -257,6 +257,8 @@
     <Content Include="ProfileIcons\{61c54bbd-c2c6-5271-96e7-009a87ff44bf}.scale-200.png" />
     <Content Include="ProfileIcons\{9acb9455-ca41-5af7-950f-6bca1bc9722f}.scale-100.png" />
     <Content Include="ProfileIcons\{9acb9455-ca41-5af7-950f-6bca1bc9722f}.scale-200.png" />
+    <Content Include="ProfileIcons\{b453ae62-4e3d-5e58-b989-0a998ec441b8}.scale-100.png" />
+    <Content Include="ProfileIcons\{b453ae62-4e3d-5e58-b989-0a998ec441b8}.scale-200.png" />
     <PRIResource Include="Resources\en-US\Resources.resw" />
   </ItemGroup>
   <Import Project="$(OpenConsoleDir)src\wap-common.build.post.props" />
@@ -277,7 +279,8 @@
         <!-- Override the filename for OpenConsole.exe (only) -->
         <TargetPath Condition="'%(Filename)' == 'OpenConsole' and '%(Extension)' == '.exe'">conhost.exe</TargetPath>
         <!-- Blank the SourceProject here to vend all files into the root of the package. -->
-        <SourceProject></SourceProject>
+        <SourceProject>
+        </SourceProject>
       </_FilteredNonWapProjProjectOutput>
     </ItemGroup>
   </Target>
@@ -302,4 +305,4 @@
     </ItemGroup>
   </Target>
 
-</Project>
+</Project>

src/cascadia/CascadiaPackage/ProfileIcons/{b453ae62-4e3d-5e58-b989-0a998ec441b8}.scale-100.png

@@ -916,12 +916,8 @@ namespace winrt::TerminalApp::implementation
     {
         // Initialize the new tab
 
-        // Create a Conhost connection based on the values in our settings object.
-        auto connection = TerminalConnection::ConhostConnection(settings.Commandline(),
-                                                                settings.StartingDirectory(),
-                                                                30,
-                                                                80,
-                                                                winrt::guid());
+        // Create a connection based on the values in our settings object.
+        const auto connection = _CreateConnectionFromSettings(profileGuid, settings);
 
         TermControl term{ settings, connection };
 
@@ -1333,12 +1329,7 @@ namespace winrt::TerminalApp::implementation
                                             _settings->GlobalSettings().GetDefaultProfile();
         const auto controlSettings = _settings->MakeSettings(realGuid);
 
-        // Create a Conhost connection based on the values in our settings object.
-        auto controlConnection = TerminalConnection::ConhostConnection(controlSettings.Commandline(),
-                                                                       controlSettings.StartingDirectory(),
-                                                                       30,
-                                                                       80,
-                                                                       winrt::guid());
+        const auto controlConnection = _CreateConnectionFromSettings(realGuid, controlSettings);
 
         TermControl newControl{ controlSettings, controlConnection };
 
@@ -1467,6 +1458,32 @@ namespace winrt::TerminalApp::implementation
         }
     }
 
+    // Method Description:
+    // - Creates a new connection based on the profile settings
+    // Arguments:
+    // - the profile GUID we want the settings from
+    // - the terminal settings
+    // Return value:
+    // - the desired connection
+    TerminalConnection::ITerminalConnection App::_CreateConnectionFromSettings(GUID profileGuid, winrt::Microsoft::Terminal::Settings::TerminalSettings settings)
+    {
+        const auto* const profile = _settings->FindProfile(profileGuid);
+        TerminalConnection::ITerminalConnection connection{ nullptr };
+        // The Azure connection has a boost dependency, and boost does not support ARM64
+        // so we make sure that we do not try to compile the Azure connection code if we are in ARM64 (we would get build errors otherwise)
+#ifndef _M_ARM64
+        if (profile->HasConnectionType() && profile->GetConnectionType() == AzureConnectionType)
+        {
+            connection = TerminalConnection::AzureConnection(settings.InitialRows(), settings.InitialCols());
+        }
+        else
+#endif
+        {
+            connection = TerminalConnection::ConhostConnection(settings.Commandline(), settings.StartingDirectory(), settings.InitialRows(), settings.InitialCols(), winrt::guid());
+        }
+        return connection;
+    }
+
     // -------------------------------- WinRT Events ---------------------------------
     // Winrt events need a method for adding a callback to the event and removing the callback.
     // These macros will define them both for you.

src/cascadia/CascadiaPackage/ProfileIcons/{b453ae62-4e3d-5e58-b989-0a998ec441b8}.scale-200.png

@@ -101,6 +101,7 @@ namespace winrt::TerminalApp::implementation
         void _RegisterTerminalEvents(Microsoft::Terminal::TerminalControl::TermControl term, std::shared_ptr<Tab> hostingTab);
 
         void _CreateNewTabFromSettings(GUID profileGuid, winrt::Microsoft::Terminal::Settings::TerminalSettings settings);
+        winrt::Microsoft::Terminal::TerminalConnection::ITerminalConnection _CreateConnectionFromSettings(GUID profileGuid, winrt::Microsoft::Terminal::Settings::TerminalSettings settings);
 
         void _OpenNewTab(std::optional<int> profileIndex);
         void _DuplicateTabViewItem();

src/cascadia/TerminalApp/App.cpp

@@ -239,6 +239,19 @@ void CascadiaSettings::_CreateDefaultProfiles()
     powershellProfile.SetDefaultBackground(POWERSHELL_BLUE);
     powershellProfile.SetUseAcrylic(false);
 
+    // The Azure connection has a boost dependency, and boost does not support ARM64
+    // so we don't create a default profile for the Azure cloud shell if we're in ARM64
+#ifndef _M_ARM64
+    auto azureCloudShellProfile{ _CreateDefaultProfile(L"Azure Cloud Shell") };
+    azureCloudShellProfile.SetCommandline(L"Azure");
+    azureCloudShellProfile.SetStartingDirectory(DEFAULT_STARTING_DIRECTORY);
+    azureCloudShellProfile.SetColorScheme({ L"Solarized Dark" });
+    azureCloudShellProfile.SetAcrylicOpacity(0.85);
+    azureCloudShellProfile.SetUseAcrylic(true);
+    azureCloudShellProfile.SetCloseOnExit(false);
+    azureCloudShellProfile.SetConnectionType(AzureConnectionType);
+#endif
+
     // If the user has installed PowerShell Core, we add PowerShell Core as a default.
     // PowerShell Core default folder is "%PROGRAMFILES%\PowerShell\[Version]\".
     std::filesystem::path psCoreCmdline{};
@@ -261,6 +274,9 @@ void CascadiaSettings::_CreateDefaultProfiles()
 
     _profiles.emplace_back(powershellProfile);
     _profiles.emplace_back(cmdProfile);
+#ifndef _M_ARM64
+    _profiles.emplace_back(azureCloudShellProfile);
+#endif
     try
     {
         _AppendWslProfiles(_profiles);

src/cascadia/TerminalApp/App.h

@@ -20,6 +20,8 @@ Author(s):
 #include "GlobalAppSettings.h"
 #include "Profile.h"
 
+static constexpr GUID AzureConnectionType = { 0xd9fcfdfa, 0xa479, 0x412c, { 0x83, 0xb7, 0xc5, 0x64, 0xe, 0x61, 0xcd, 0x62 } };
+
 namespace TerminalApp
 {
     class CascadiaSettings;

src/cascadia/TerminalApp/CascadiaSettings.cpp

@@ -26,6 +26,7 @@ static constexpr std::string_view CursorColorKey{ "cursorColor" };
 static constexpr std::string_view CursorShapeKey{ "cursorShape" };
 static constexpr std::string_view CursorHeightKey{ "cursorHeight" };
 
+static constexpr std::string_view ConnectionTypeKey{ "connectionType" };
 static constexpr std::string_view CommandlineKey{ "commandline" };
 static constexpr std::string_view FontFaceKey{ "fontFace" };
 static constexpr std::string_view FontSizeKey{ "fontSize" };
@@ -89,6 +90,7 @@ Profile::Profile(const winrt::guid& guid) :
     _cursorShape{ CursorStyle::Bar },
     _cursorHeight{ DEFAULT_CURSOR_HEIGHT },
 
+    _connectionType{},
     _commandline{ L"cmd.exe" },
     _startingDirectory{},
     _fontFace{ DEFAULT_FONT_FACE },
@@ -280,6 +282,10 @@ Json::Value Profile::ToJson() const
     root[JsonKey(CloseOnExitKey)] = _closeOnExit;
     root[JsonKey(PaddingKey)] = winrt::to_string(_padding);
 
+    if (_connectionType)
+    {
+        root[JsonKey(ConnectionTypeKey)] = winrt::to_string(Utils::GuidToString(_connectionType.value()));
+    }
     if (_scrollbarState)
     {
         const auto scrollbarState = winrt::to_string(_scrollbarState.value());
@@ -406,6 +412,10 @@ Profile Profile::FromJson(const Json::Value& json)
     }
 
     // Control Settings
+    if (auto connectionType{ json[JsonKey(ConnectionTypeKey)] })
+    {
+        result._connectionType = Utils::GuidFromString(GetWstringFromJson(connectionType));
+    }
     if (auto commandline{ json[JsonKey(CommandlineKey)] })
     {
         result._commandline = GetWstringFromJson(commandline);
@@ -511,6 +521,16 @@ void Profile::SetDefaultBackground(COLORREF defaultBackground) noexcept
     _defaultBackground = defaultBackground;
 }
 
+void Profile::SetCloseOnExit(bool defaultClose) noexcept
+{
+    _closeOnExit = defaultClose;
+}
+
+void Profile::SetConnectionType(GUID connectionType) noexcept
+{
+    _connectionType = connectionType;
+}
+
 bool Profile::HasIcon() const noexcept
 {
     return _icon.has_value() && !_icon.value().empty();
@@ -576,6 +596,18 @@ std::wstring_view Profile::GetTabTitle() const noexcept
                std::wstring_view{ L"", 0 };
 }
 
+bool Profile::HasConnectionType() const noexcept
+{
+    return _connectionType.has_value();
+}
+
+GUID Profile::GetConnectionType() const noexcept
+{
+    return HasConnectionType() ?
+               _connectionType.value() :
+               _GUID{};
+}
+
 bool Profile::GetCloseOnExit() const noexcept
 {
     return _closeOnExit;

src/cascadia/TerminalApp/CascadiaSettings.h

@@ -38,6 +38,8 @@ class TerminalApp::Profile final
     std::wstring_view GetName() const noexcept;
     bool HasTabTitle() const noexcept;
     std::wstring_view GetTabTitle() const noexcept;
+    bool HasConnectionType() const noexcept;
+    GUID GetConnectionType() const noexcept;
 
     void SetFontFace(std::wstring fontFace) noexcept;
     void SetColorScheme(std::optional<std::wstring> schemeName) noexcept;
@@ -49,6 +51,8 @@ class TerminalApp::Profile final
     void SetUseAcrylic(bool useAcrylic) noexcept;
     void SetDefaultForeground(COLORREF defaultForeground) noexcept;
     void SetDefaultBackground(COLORREF defaultBackground) noexcept;
+    void SetCloseOnExit(bool defaultClose) noexcept;
+    void SetConnectionType(GUID connectionType) noexcept;
 
     bool HasIcon() const noexcept;
     std::wstring_view GetIconPath() const noexcept;
@@ -69,6 +73,7 @@ class TerminalApp::Profile final
 
     GUID _guid;
     std::wstring _name;
+    std::optional<GUID> _connectionType;
 
     // If this is set, then our colors should come from the associated color scheme
     std::optional<std::wstring> _schemeName;

src/cascadia/TerminalApp/Profile.cpp

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+#pragma once
+
+#include <cpprest/details/web_utilities.h>
+
+const utility::string_t AzureClientID = U("0");