Skip to content

Christian Gerdes / WebServicePlugins

Go to a project
Toggle navigation
Toggle navigation pinning
Commit 30219022 302190229046be38f993758941863f0033d25516 by Christian Gerdes
Options

- Implemented issue #2 Initialize of VSIX now automatically installs the recorde… 

…r plugin on first launch into the users WebTestPlugins folder. Tested in Exp and working.
- Launching of Exp on F5 is now checked in (csproj.user file) and no longer ignored.
1 parent d3013cb5
Inline Side-by-side
Showing 7 changed files with 288 additions and 3 deletions
......@@ -3,7 +3,7 @@
# User-specific files
*.suo
*.user
# *.user
*.sln.docstates
# Build results
......
//------------------------------------------------------------------------------
// <copyright file="InfoCommand.cs" company="Company">
// Copyright (c) Company. All rights reserved.
// </copyright>
//------------------------------------------------------------------------------
using System;
using System.ComponentModel.Design;
using System.Globalization;
using Microsoft.VisualStudio.Shell;
using Microsoft.VisualStudio.Shell.Interop;
namespace WebTest.WebServive.Plugin
{
/// <summary>
/// Command handler
/// </summary>
internal sealed class InfoCommand
{
/// <summary>
/// Command ID.
/// </summary>
public const int CommandId = 0x0100;
/// <summary>
/// Command menu group (command set GUID).
/// </summary>
public static readonly Guid CommandSet = new Guid("dabd9d62-5ee8-4639-a7d5-71485c06eeca");
/// <summary>
/// VS Package that provides this command, not null.
/// </summary>
private readonly Package package;
/// <summary>
/// Initializes a new instance of the <see cref="InfoCommand"/> class.
/// Adds our command handlers for menu (commands must exist in the command table file)
/// </summary>
/// <param name="package">Owner package, not null.</param>
private InfoCommand(Package package)
{
if (package == null)
{
throw new ArgumentNullException("package");
}
this.package = package;
OleMenuCommandService commandService = this.ServiceProvider.GetService(typeof(IMenuCommandService)) as OleMenuCommandService;
if (commandService != null)
{
var menuCommandID = new CommandID(CommandSet, CommandId);
var menuItem = new MenuCommand(this.MenuItemCallback, menuCommandID);
commandService.AddCommand(menuItem);
}
}
/// <summary>
/// Gets the instance of the command.
/// </summary>
public static InfoCommand Instance
{
get;
private set;
}
/// <summary>
/// Gets the service provider from the owner package.
/// </summary>
private IServiceProvider ServiceProvider
{
get
{
return this.package;
}
}
/// <summary>
/// Initializes the singleton instance of the command.
/// </summary>
/// <param name="package">Owner package, not null.</param>
public static void Initialize(Package package)
{
Instance = new InfoCommand(package);
}
/// <summary>
/// This function is the callback used to execute the command when the menu item is clicked.
/// See the constructor to see how the menu item is associated with this function using
/// OleMenuCommandService service and MenuCommand class.
/// </summary>
/// <param name="sender">Event sender.</param>
/// <param name="e">Event args.</param>
private void MenuItemCallback(object sender, EventArgs e)
{
string message = string.Format(CultureInfo.CurrentCulture, "Inside {0}.MenuItemCallback()", this.GetType().FullName);
string title = "InfoCommand";
// Show a message box to prove we were here
VsShellUtilities.ShowMessageBox(
this.ServiceProvider,
message,
title,
OLEMSGICON.OLEMSGICON_INFO,
OLEMSGBUTTON.OLEMSGBUTTON_OK,
OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST);
}
}
}
......@@ -51,6 +51,7 @@
<WarningLevel>4</WarningLevel>
</PropertyGroup>
<ItemGroup>
<Compile Include="InfoCommand.cs" />
<Compile Include="Properties\AssemblyInfo.cs" />
<Compile Include="WebServiceVSPackage.cs" />
</ItemGroup>
......@@ -63,8 +64,12 @@
</ItemGroup>
<ItemGroup>
<Content Include="index.html" />
<Content Include="Resources\InfoCommand.png" />
<Content Include="Resources\WebServiceVSPackage.ico" />
<Content Include="stylesheet.css" />
<VSCTCompile Include="WebServiceVSPackage.vsct">
<ResourceName>Menus.ctmenu</ResourceName>
</VSCTCompile>
</ItemGroup>
<ItemGroup>
<Reference Include="EnvDTE, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
......@@ -80,9 +85,8 @@
<EmbedInteropTypes>False</EmbedInteropTypes>
</Reference>
<Reference Include="Extensibility, Version=7.0.3300.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
<EmbedInteropTypes>True</EmbedInteropTypes>
<EmbedInteropTypes>False</EmbedInteropTypes>
</Reference>
<Reference Include="Microsoft.Build.Framework" />
<Reference Include="Microsoft.CSharp" />
<Reference Include="Microsoft.VisualStudio.CommandBars, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
<EmbedInteropTypes>False</EmbedInteropTypes>
......
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="14.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
<ProjectView>ProjectFiles</ProjectView>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|AnyCPU'">
<StartAction>Program</StartAction>
<StartProgram>C:\Program Files %28x86%29\Microsoft Visual Studio 14.0\Common7\IDE\devenv.exe</StartProgram>
<StartArguments>/rootsuffix Exp</StartArguments>
</PropertyGroup>
</Project>
\ No newline at end of file
......@@ -18,6 +18,9 @@ using Microsoft.Win32;
using EnvDTE;
using EnvDTE80;
using WebTest.WebService.Plugin.ResultTab;
using Microsoft.VisualStudio.Settings;
using Microsoft.VisualStudio.Shell.Settings;
using System.IO;
namespace WebTest.WebServive.Plugin
{
......@@ -43,6 +46,7 @@ namespace WebTest.WebServive.Plugin
[Guid(WebServiceVSPackage.PackageGuidString)]
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1650:ElementDocumentationMustBeSpelledCorrectly", Justification = "pkgdef, VS and vsixmanifest are valid VS terms")]
[ProvideAutoLoad(UIContextGuids80.SolutionExists)]
[ProvideMenuResource("Menus.ctmenu", 1)]
public sealed class WebServiceVSPackage : Package
{
/// <summary>
......@@ -69,11 +73,15 @@ namespace WebTest.WebServive.Plugin
/// </summary>
protected override void Initialize()
{
// check setup
checkSetup();
base.Initialize();
DTE2 dte = (DTE2)GetService(typeof(DTE));
_wsp_connect = new WebTest.WebService.Plugin.ResultTab.Connect();
_wsp_connect.OnConnection(dte, Extensibility.ext_ConnectMode.ext_cm_Startup, null, ref _arr);
WebTest.WebServive.Plugin.InfoCommand.Initialize(this);
}
......@@ -86,6 +94,65 @@ namespace WebTest.WebServive.Plugin
base.Dispose(disposing);
}
bool checkSetup()
{
RegistryKey rk = Registry.CurrentUser.OpenSubKey("SOFTWARE\\WebServicePlugin");
bool installOK = false;
if(rk == null)
{
// Registry key not found, i.e. we did not install the dll's before
installOK = false;
} else
{
// Registry key found, check if we are installed
Object regInstalled = rk.GetValue("INSTALLED");
if (regInstalled != null)
{
Int32 val = (Int32)regInstalled;
if (val == 1) installOK = true;
else installOK = false;
} else
{
installOK = false;
}
}
// Install if we need to install, and show info message when done
if(installOK == false)
{
string messageLoc = new Uri(typeof(WebService.Plugin.MessageEditors.XmlMessageEditor).Assembly.CodeBase).LocalPath;
string runtimeLoc = new Uri(typeof(WebService.Plugin.Runtime.WebServicePlugin).Assembly.CodeBase).LocalPath;
// Check if the old runtime was found in PublicAssemblies (old version installed there)
if (runtimeLoc.Contains("PublicAssemblies"))
{
// CONFLICT
VsShellUtilities.ShowMessageBox(this, "Previous version of the runtime dll was found in the PublicAssemblies folder. This version will conflict with this new version of the plugin. Please remove it and restart Visual Studio.\n\n Path to the DLL: " + runtimeLoc,
"Conflicting previous version", OLEMSGICON.OLEMSGICON_CRITICAL, OLEMSGBUTTON.OLEMSGBUTTON_OK, OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST);
return false;
}
else
{
// OK to proceed
// Copy message editor plugins and recorder plugin to users webtest dir
ShellSettingsManager sm = new ShellSettingsManager(this);
string pluginPath = sm.GetApplicationDataFolder(ApplicationDataFolder.Documents) + @"\WebTestPlugins\";
Directory.CreateDirectory(pluginPath);
pluginPath += Path.GetFileName(messageLoc);
File.Copy(messageLoc, pluginPath, true);
//Update the registry
RegistryKey wrk = Registry.CurrentUser.CreateSubKey("SOFTWARE\\WebServicePlugin");
wrk.SetValue("INSTALLED", 1, RegistryValueKind.DWord);
//Tell the user
VsShellUtilities.ShowMessageBox(this, "Recorder plugin copied to: " + pluginPath, "Plugin files installed", OLEMSGICON.OLEMSGICON_INFO, OLEMSGBUTTON.OLEMSGBUTTON_OK, OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST);
}
}
return installOK;
}
#endregion
Connect _wsp_connect = null;
Array _arr = new object[0];
......
<?xml version="1.0" encoding="utf-8"?>
<CommandTable xmlns="http://schemas.microsoft.com/VisualStudio/2005-10-18/CommandTable" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<!-- This is the file that defines the actual layout and type of the commands.
It is divided in different sections (e.g. command definition, command
placement, ...), with each defining a specific set of properties.
See the comment before each section for more details about how to
use it. -->
<!-- The VSCT compiler (the tool that translates this file into the binary
format that VisualStudio will consume) has the ability to run a preprocessor
on the vsct file; this preprocessor is (usually) the C++ preprocessor, so
it is possible to define includes and macros with the same syntax used
in C++ files. Using this ability of the compiler here, we include some files
defining some of the constants that we will use inside the file. -->
<!--This is the file that defines the IDs for all the commands exposed by VisualStudio. -->
<Extern href="stdidcmd.h"/>
<!--This header contains the command ids for the menus provided by the shell. -->
<Extern href="vsshlids.h"/>
<!--The Commands section is where commands, menus, and menu groups are defined.
This section uses a Guid to identify the package that provides the command defined inside it. -->
<Commands package="guidWebServiceVSPackage">
<!-- Inside this section we have different sub-sections: one for the menus, another
for the menu groups, one for the buttons (the actual commands), one for the combos
and the last one for the bitmaps used. Each element is identified by a command id that
is a unique pair of guid and numeric identifier; the guid part of the identifier is usually
called "command set" and is used to group different command inside a logically related
group; your package should define its own command set in order to avoid collisions
with command ids defined by other packages. -->
<!-- In this section you can define new menu groups. A menu group is a container for
other menus or buttons (commands); from a visual point of view you can see the
group as the part of a menu contained between two lines. The parent of a group
must be a menu. -->
<Groups>
<Group guid="guidWebServiceVSPackageCmdSet" id="MyMenuGroup" priority="0x0600">
<Parent guid="guidSHLMainMenu" id="IDM_VS_MENU_TOOLS"/>
</Group>
</Groups>
<!--Buttons section. -->
<!--This section defines the elements the user can interact with, like a menu command or a button
or combo box in a toolbar. -->
<Buttons>
<!--To define a menu group you have to specify its ID, the parent menu and its display priority.
The command is visible and enabled by default. If you need to change the visibility, status, etc, you can use
the CommandFlag node.
You can add more than one CommandFlag node e.g.:
<CommandFlag>DefaultInvisible</CommandFlag>
<CommandFlag>DynamicVisibility</CommandFlag>
If you do not want an image next to your command, remove the Icon node /> -->
<Button guid="guidWebServiceVSPackageCmdSet" id="InfoCommandId" priority="0x0100" type="Button">
<Parent guid="guidWebServiceVSPackageCmdSet" id="MyMenuGroup" />
<Icon guid="guidImages" id="bmpPic1" />
<Strings>
<ButtonText>Invoke InfoCommand</ButtonText>
</Strings>
</Button>
</Buttons>
<!--The bitmaps section is used to define the bitmaps that are used for the commands.-->
<Bitmaps>
<!-- The bitmap id is defined in a way that is a little bit different from the others:
the declaration starts with a guid for the bitmap strip, then there is the resource id of the
bitmap strip containing the bitmaps and then there are the numeric ids of the elements used
inside a button definition. An important aspect of this declaration is that the element id
must be the actual index (1-based) of the bitmap inside the bitmap strip. -->
<Bitmap guid="guidImages" href="Resources\InfoCommand.png" usedList="bmpPic1, bmpPic2, bmpPicSearch, bmpPicX, bmpPicArrows, bmpPicStrikethrough"/>
</Bitmaps>
</Commands>
<Symbols>
<!-- This is the package guid. -->
<GuidSymbol name="guidWebServiceVSPackage" value="{7e15e6a8-3708-4be9-92f4-92218254a23d}" />
<!-- This is the guid used to group the menu commands together -->
<GuidSymbol name="guidWebServiceVSPackageCmdSet" value="{dabd9d62-5ee8-4639-a7d5-71485c06eeca}">
<IDSymbol name="MyMenuGroup" value="0x1020" />
<IDSymbol name="InfoCommandId" value="0x0100" />
</GuidSymbol>
<GuidSymbol name="guidImages" value="{fe1ce9bc-93c0-4c17-bbb5-6107d6492e08}" >
<IDSymbol name="bmpPic1" value="1" />
<IDSymbol name="bmpPic2" value="2" />
<IDSymbol name="bmpPicSearch" value="3" />
<IDSymbol name="bmpPicX" value="4" />
<IDSymbol name="bmpPicArrows" value="5" />
<IDSymbol name="bmpPicStrikethrough" value="6" />
</GuidSymbol>
</Symbols>
</CommandTable>