googlecloudplatform / google-cloud-visualstudio

Google Cloud Tools for Visual Studio

Visual Studio Extension for Google Cloud Platform

This repo contains the source code for Cloud Tools for Visual Studio, an extension for integrating Google Cloud Platform into Visual Studio.

Install

You can install the extension from the Visual Studio Marketplace. The current and previous vsix packages are available on the releases page. The latest development vsix package is avalable on appveyor.

Dependencies on Google Cloud SDK

The Visual Studio extension depends on the Cloud SDK for certain functionality, make sure that you have at least version 174.0.0 of the Cloud SDK installed when running the extension.

You can install the Google Cloud SDK from https://cloud.google.com/sdk/. You will also need to make sure that you have the kubectl component. It is used for interactions with Google Kubernetes Engine.

You can make sure that you have all the necessary components installed by running the command:

gcloud components install kubectl

Support

To get help on using the Visual Studio Extension, please log an issue with this project. While we will eventually be able to offer support on Stack Overflow or a Google+ community, for now your best bet is to report issues in this Github project.

Build

To build the extension you will need to have Visual Studio 2017. You will need the the Visual Studio extension development toolset installed to be able to develop and build the extension. You can then open the main solution file: GoogleCloudExtension\GoogleCloudExtension.sln. If you get a build/project load error, try restoring NuGet packages first, as the project files reference files in one of the packages. If you get an error during the restoration of the NuGet packages, ensure that you have enabled nuget.org as a source in the NuGet Package Manager.

Build tools

We use Microsoft.VSSDK.BuildTools. This NuGet package provides MSBuild .props and .targets files we use to build the extension.

Continuous Building/Testing

We use appveyor to build on every push. The latest vsix package built from the master branch can be found here.

Contributing

Patches are encouraged, and may be submitted by forking this project and submitting a Pull Request. See CONTRIBUTING.md for more information.

License

Apache 2.0. See LICENSE for more information.

This extension allows you to opt-in to collect usage data and send it to Google to help improve our products and services. For more information, refer to the Google Privacy Policy.

google-cloud-visualstudio's Issues

No \n between the runtime: custom and api_version: lines.

Because of this the generated app.yaml is bad and the deployment fails with the message:
Unable to assign value 'customapi_version' to attribute 'runtime':.

Actions for zone nodes in the GCE Cloud Explorer source

Currently the zone nodes in the GCE data source for the Cloud Explorer don't have any actions. We should have at least a "Get Info" action that the user can invoke, redirect to the cloud console for further actions until those are implemented locally.

Extension still displays deleted projects

REPRO
Create a new project called aaaaaaaaa and spin up an instance
Delete the aaaaaaaaa project
Install extension and authenticate

CURRENT
By default, the app shows the data for the deleted project, aaaaaaaaa

EXPECTED
Project aaaaaaaaa is not shown in the extensions

Show last published version in Cloud Explorer

Some participants in our study wanted to also see some status about what was running on their IIS instance, in particular what build was currently running, when it was last published, etc.

Parse app.yaml and verify it.

Show relevant pieces of data from the app.yaml in the dialogs, such as the module that is being deployed.

Also, set the stage for having auto-complete for app.yaml.

Possible support for using browser to get user credentials instead of custom dialog

It seems that the best practice is to open the default browser in the system to ask the user for credentials instead of having a custom dialog.

This work will require us to:

• Open an HTTP port on the machine to listen for the redirect from the oauth server to capture the auth_code.
• Show a dialog that the user can use to cancel the operation if they did close the browser window.

Ensure Windows Server 2008 is recognized as as Windows instance.

Currently only Server 2012 is recognized as a Windows instance.

Offer Google Cloud project templates in Visual C#, Web and Cloud nodes

CURRENT
Google Cloud project templates are only offered in a Google Cloud node under Visual C#. most participants in our study missed it and went straight for the project templates in Web, Cloud or directly in Visual C# nodes.

Gcloud integration for password reset.

Implement the gcloud integration for password reset. The extension will be able to reset Windows VMs passwords, given the username and show it to the user.

The user will access this from the context menu for the VM.

Add publish menu entry for project.

This menu entry will show a dialog with information about publishing the project, offer a link to a page with more information about how to publish ASP.NET 4.x apps.

Revise text in dialog

Fix typos, grammar errors, etc...

Implement UI for the Pub/Sub topic publish

Add ability to publish to the topic directly from the Visual Studio.

First time an item is selected in the cloud explorer nothing is shown on the properties window

The very first time an item is selected in the cloud explorer the properties window is not updated, after that it works every time.

Analytics opt-in

Need to implement the analytics opt-in for the extension, ensure it follows the guidelines.

Support dark theme

CURRENT
In dark theme, the UI shows the following UI bugs:

• Project drop down is black text on grey background, almost impossible to read. Text should be light (white or default font color for the theme).
• Tree background is light, should be dark grey with light text.

Error connecting to the localhost server when processing result of OAUTH

It seems that sometimes the browser will fail to connect to the localhost HTTP server opened to receive the OAUTH code after the operation has completed.

Probably a race condition, the localhost server is shutdown before the browser has the chance to talk to it to get the page. This should hopefully go away once the we redirect to an actual HTTP address outside of the machine.

Should use the existing pages for IntelliJ until the VS pages are alive.

Use the right apache license 2.0 headers for all source code.

Need to ensure that all of the source code has the right license headers, probably use the full header instead of the small one we're using now.

Error message to ask to install SDK should include link to SDK install page

REPRO
Install VS extension
Authenticate with GCP credentials
Spin up an ASP.NET instance from Cloud Console
In the Cloud Explorer, refresh the view, then right click on instance you just created and click on "reset..."

CURRENT
Error dialog appears telling the user he needs to install Cloud SDK to do this. Option is only to dismiss the dialog.

EXPECTED (options in order or preference)
Option 1. It just works
Option 2. It offers a wizard to install it, and then continues the flow
Option 3. The dialog offers a link to where the user can download the extension.

Add project templates

Add project templates for GCP projects:

• MVC Project.
• Web API Project.

Use a more descriptive name for the publishing profile in the .publishsettings file.

Currently we use "Google Cloud Profile-WebDeploy". Use something that incorporates the name of the VM.

All commands fail with "Error", Please ensure that Gcloud is installed."

C:\Windows\system32>gcloud -v
Google Cloud SDK 90.0.0

alpha 2015.10.08
app-engine-python 1.9.30
app-engine-python-extras 1.9.21
bq 2.0.18
bq-win 2.0.18
core 2015.12.07
core-win 2015.11.24
gcloud
gsutil 4.16
gsutil-win 4.15
windows-ssh-tools 2015.09.21

Should have link to the Cloud SDK installation when requesting it.

When using a feature that requires the Cloud SDK and it is not installed the extension will prompt the user to install the SDK. The dialog used for this prompt should have a clickable link so the user can easily find and install the SDK.

GCloud is attempting to create a temporary directory in the directory where Visual Studio is installed

Since it is installed per machine under "Program Files" this operation fails and aborts the deployment of the app.

Ensure all API calls use the right app name.

This will allow us to know usage statistics when APIs are called from Visual Studio.

Investigate to see if we can show the version/date of deployment of a published ASP.NET app in a Windows VM

It would be interesting to show the version/deployment date of an ASP.NET app running on a Windows VM. The server component for WebDeploy might be doing this already, we could see if we could surface it.

Have a type parameter in WeakCommand<T> for the type of the parameter for the handler

So the WeakCommand class is the one that does the cast and only calls the command handler if the cast succeeds.

Analytics for the extension

Ensure that the extension has the right analytics in place to track feature use, mainly concerned with:

• Commands, where they are launched, etc...
• Results of the commands, failure, success, etc...
• Counters, numbers of active accounts, etc...

Filter out deleted projects

Ensure that the Cloud Explorer doesn't show deleted projects in the projects dropdown.

Write ToString for the items displayed in the properties window

Currently the full name of the class is displayed in the properties window, we should have a proper implementation of the ToString() method in all item classes displayed in the property window.

Implement UI for the Pub/Sub subscription pull

Add ability to pull from the subscription directly from the Visual Studio.

Detect errors because of APIs not being enabled, show link to enable to the user.

Catch the exception and offer up a link to the user to go to the console to enable the feature.

Update property ID for metrics

Use the official metric ID for cloud products.

Facilitate enabling APIs and pulling down the appropriate NuGet packages

There is an opportunity to help users quickly get up to speed developing against our APIs. That would involve using the extension to enable a new API, pull its associated NuGet packages, and provisioning credentials to help them get up to speed.

Ensure templates build out of the box

It seems that the project templates carry some dependencies from the machine in which they were created. Ensure that the templates can build everywhere.

Missing contextual menu on parent nodes in the Cloud Explorer tree

CURRENT
Right-clicking on parent nodes (like a service node or region node) does nothing. Users might infer that right click is not available on this UI.

RECOMMENDATION
Offer options on right-click of nodes, even if those options only take them to the Console for now.

Need to store the current GCP project in between sessions.

Currently the current user is persisted, globally for the machine, but the project is not. The proposed change is to store the current user and current project per project. In the project options section.

Detect the appropriate port is open for the requested action in a GCE VM

When requesting an action, detect that the necessary port is open or not in the instance and if not prompt the user with a warning and the possibility of opening said port before the action is taken.

For example, if the user invokes the "Open Terminal Server Session..." command in the instance's context menu then check that the RDP port is opened on the target machine. If we can't determine that it is open, we can prompt the user with a special dialog to let the user know that the operation might fail unless we open the port; we can offer opening the port before the terminal session is started.

This will help eliminate some of the friction related to firewall ports. The user can close the port after the operation is completed, for security reasons.

Add Google Cloud option in the Publish wizard

Many participants in our study expected to see a publish template wizard in the current "Publish" wizard of Visual Studio, similar to the Azure options.

Styling of dialogs, ui theming

Need to ensure that we're using the right brushes for all backgrounds, foregrounds, etc... So the dialogs and tool windows look as close as the native ones in Visual Studio as possible.

Review the images added to the project.

Remove the images that are not used and/or update with final images.

Consider: Showing all available services in Cloud Explorer

Currently, only a limited set of the GCP services are exposed in the Cloud Explorer. However, there is not obvious reason for the user as to why, and they may draw misleading inferences as to whether the other services do not exist, or are not available for ASP.NET developers.

I suggest two avenues for solutions:
Option 1) Only show services that are enabled, and a clear affordance for adding more
Option 2) Show all the services that are available, distinguishing the active ones from the inactive ones, e.g. greying out inactive, or separating into two lists, active and inactive ones.

If there are no projects for a particular user, use a dummy project placeholder to show the message

Currently if an account is selected that doesn't have any projects the projects dropdown is just empty. Need to clearly show that. Perhaps even have a special empty state for the control.

Wrong URL when browsing to buckets.

Currently we're opening an internal website, which is not the URL we should navigate. It should be https://console.cloud.google.com/storage/browser/{bucket}/?project={project}.

Add Google Cloud Option in ASP.NET New Project templates

New project templates for ASP.NET contain options pertaining to deploying to Azure which are enabled by default. Consider having the extension modify them to add a Google Cloud option as well.

Use the preconditions library.

Jon has a nice preconditions library up in his repo here, copy it in this repo for now and use it in the code when null checks, and other conditions are required.

Icons, etc... for the Visual Studio extension

Need to have an updated set of icons for the extension.

The preliminary list of needed icons is:

• Icons for the areas covered by the extension:
  • GCE
  • GCS
  • Pub/Sub
• Icons for commands:
  • Refresh
  • Filter to Windows machines only.
  • Possibly icons for the main commands, Manage Accounts and Cloud Explorer.

Review generated code for commands in the extension

Modernize the code when possible.

Zero state for the cloud explorer

Ensure that the zero state for the Cloud Explorer is meaningful. It should:

• Show the user that they need to log in, if they are not already.
• Show that there are not projects, encourage them to go to the console to create one.
• Show that there are no instances/buckets, encourage them to go the console to create one.

Currently the list of projects is empty, but the different data sources for the cloud explorer do show a meaningful message, although not the best.

It should show that there are no projects.

Ensure the current credentials are used when launching ASP.NET projects

When launching ASP.NET projects locally, if the project is using the useable auth library it will pick up the credentials to use, the application_default_credentials.json file, that is generated by GCloud CLI. We want to ensure that the app will instead pick up the credentials for the current user selected in Visual Studio.
In order to do this we need to set the environment variable GOOGLE_APPLICATION_CREDENTIALS to point to a file of our creation which will contain the credentials for the currently selected user. This file will be overwritten every time the current user is changed in Visual Studio.
Because it is an env variable it will be inherited by the child process (created when the app is started by Visual Studio) so we will set that variable in Visual Studio's own environment.

Menu not showing up

I was running the new installer experience, and I've ran into a situation where the plug-in is installed but the menu isn't showing up within Visual Studio.

It's possible the problem is with my machine or how I am calling VSIXInstaller.exe. Does anything from the VSIX log stand out? Did you release an update of your plug-in recently that would have caused problems? (The installer pulls from https://storage.googleapis.com/aspnet-mvm/extension/GoogleCloudExtension.vsix.)

Screen shot

https://screenshot.googleplex.com/JfSHH3WyT4k.png

Installation command (via NSIS)

Nothing too crazy is going on here. This worked in the past, so I assume it has to do with versioning or a botched uninstall of the plugin (from the Visual Studio UI).

Section /o "Cloud Tools for Visual Studio" section_visualStudioAddIn
  ${DetailLog} "Downloading the Google Cloud extension for Visual Studio:"
  NSISdl::download_quiet /TIMEOUT=30000 \
      "${PATH_TO_GOOGLE_CLOUD_EXTENSION_VSIX}" \
      "$PLUGINSDIR\GoogleCloudExtension.vsix"
  Pop $R0 ; Get the return value.
  ${If} $R0 != "success"
    MessageBox MB_OK|MB_ICONEXCLAMATION "Error downloading the Google Cloud Extension for Visual Studio."
    ${DetailLog} "Download failed: ${PATH_TO_GOOGLE_CLOUD_EXTENSION_VSIX}"
    Abort "Download failed."
  ${EndIf}

  ; Perform the installation.
  ${DetailLog} "Installing: GoogleCloudExtension.vsix"
  ${If} $instMode == 0
    Exec '"$pathToVsIdeFolder\VSIXInstaller.exe" /quiet "$PLUGINSDIR\GoogleCloudExtension.vsix"'
  ${Else}
    Exec '"$pathToVsIdeFolder\VSIXInstaller.exe" /quiet /admin "$PLUGINSDIR\GoogleCloudExtension.vsix"'
  ${EndIf}
SectionEnd

VSIXInstaller.exe log

12/18/2015 11:01:44 AM - Microsoft VSIX Installer
12/18/2015 11:01:45 AM - -------------------------------------------
12/18/2015 11:01:45 AM - Initializing Install...
12/18/2015 11:01:45 AM - Extension Details...
12/18/2015 11:01:45 AM -    Identifier      : GoogleAppEngine.Google.d3d3eeb8-3710-4bd9-97ba-1401bf2acd22
12/18/2015 11:01:45 AM -    Name            : Google Cloud Platform Extension for Visual Studio
12/18/2015 11:01:45 AM -    Author          : Google Inc.
12/18/2015 11:01:45 AM -    Version         : 0.4.20151216
12/18/2015 11:01:45 AM -    Description     : Tools to develop applications for Google Cloud Platform.
12/18/2015 11:01:45 AM -    Locale          : en-US
12/18/2015 11:01:45 AM -    MoreInfoURL     : https://github.com/GoogleCloudPlatform/gcloud-visualstudio
12/18/2015 11:01:45 AM -    InstalledByMSI  : False
12/18/2015 11:01:45 AM -    SupportedFrameworkVersionRange : [4.5,)
12/18/2015 11:01:45 AM - 
12/18/2015 11:01:45 AM -    Supported Products : 
12/18/2015 11:01:45 AM -        Microsoft.VisualStudio.Community
12/18/2015 11:01:45 AM -            Version : [14.0]
12/18/2015 11:01:45 AM - 
12/18/2015 11:01:45 AM -    References      : 
12/18/2015 11:01:45 AM -        -------------------------------------------------------
12/18/2015 11:01:45 AM -        Identifier   : Microsoft.VisualStudio.MPF.14.0
12/18/2015 11:01:45 AM -        Name         : Visual Studio MPF 14.0
12/18/2015 11:01:45 AM -        Version      : [14.0]
12/18/2015 11:01:45 AM -        MoreInfoURL  : 
12/18/2015 11:01:45 AM -        Nested       : No
12/18/2015 11:01:45 AM - 
12/18/2015 11:01:45 AM - 
12/18/2015 11:01:45 AM - Searching for applicable products...
12/18/2015 11:01:45 AM - Found installed product - Microsoft Visual Studio Community 2015
12/18/2015 11:01:47 AM - The extension will be upgraded from version 0.4.20151216.
12/18/2015 11:01:47 AM - Found installed product - Microsoft Visual Studio 2015 Shell (Integrated)
12/18/2015 11:01:47 AM - Found installed product - Global Location
12/18/2015 11:01:47 AM - Uninstalling 'Google Cloud Platform Extension for Visual Studio', version 0.4.20151216.
12/18/2015 11:01:47 AM - Beginning to install extension to Microsoft Visual Studio Community 2015...
12/18/2015 11:01:48 AM - Install to Microsoft Visual Studio Community 2015 completed successfully. The extension has been installed to C:\USERS\CHRSMITH\APPDATA\LOCAL\MICROSOFT\VISUALSTUDIO\14.0\EXTENSIONS\CEOEGGGK.A3I\