Skip to content

Commit

Permalink
Merge pull request QuantConnect#806 from mushketyk/backtest-plugin
Browse files Browse the repository at this point in the history
Backtest plugin
  • Loading branch information
jaredbroad authored May 18, 2017
2 parents d09466b + 94dc3cb commit 9de02c9
Show file tree
Hide file tree
Showing 32 changed files with 2,270 additions and 7 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -253,3 +253,6 @@ Charts/
# NCrunch files
*.ncrunchsolution
*.ncrunchproject

# QuantConnect plugin files
QuantConnectProjects.xml
13 changes: 12 additions & 1 deletion Api/Api.cs
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public virtual void Initialize(int userId, string token, string dataFolder)
{
_connection = new ApiConnection(userId, token);
_socketConnection = new ApiWebSocketConnection(userId, token);
_marketHoursDatabase = MarketHoursDatabase.FromDataFolder();
_marketHoursDatabase = MarketHoursDatabase.FromDataFolder(dataFolder);
_dataFolder = dataFolder;

//Allow proper decoding of orders from the API.
Expand All @@ -61,6 +61,17 @@ public virtual void Initialize(int userId, string token, string dataFolder)
};
}

/// <summary>
/// Check if Api is successfully connected with correct credentials
/// </summary>
public bool Connected
{
get
{
return _connection.Connected;
}
}

/// <summary>
/// Create a project with the specified name and language via QuantConnect.com API
/// </summary>
Expand Down
3 changes: 3 additions & 0 deletions Api/QuantConnect.Api.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@
<CodeAnalysisIgnoreBuiltInRules>false</CodeAnalysisIgnoreBuiltInRules>
<Prefer32Bit>false</Prefer32Bit>
</PropertyGroup>
<PropertyGroup>
<SignAssembly>false</SignAssembly>
</PropertyGroup>
<ItemGroup>
<Reference Include="ICSharpCode.SharpZipLib, Version=0.85.4.369, Culture=neutral, PublicKeyToken=1b03e6acf1164f73, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion>
Expand Down
13 changes: 12 additions & 1 deletion Common/Securities/MarketHoursDatabase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -118,12 +118,23 @@ public DateTimeZone GetDataTimeZone(string market, Symbol symbol, SecurityType s
/// </summary>
/// <returns>A <see cref="MarketHoursDatabase"/> class that represents the data in the market-hours folder</returns>
public static MarketHoursDatabase FromDataFolder()
{
return FromDataFolder(Globals.DataFolder);
}

/// <summary>
/// Gets the instance of the <see cref="MarketHoursDatabase"/> class produced by reading in the market hours
/// data found in /Data/market-hours/
/// </summary>
/// <param name="dataFolder">Path to the data folder</param>
/// <returns>A <see cref="MarketHoursDatabase"/> class that represents the data in the market-hours folder</returns>
public static MarketHoursDatabase FromDataFolder(string dataFolder)
{
lock (DataFolderMarketHoursDatabaseLock)
{
if (_dataFolderMarketHoursDatabase == null)
{
var path = Path.Combine(Globals.DataFolder, "market-hours", "market-hours-database.json");
var path = Path.Combine(dataFolder, "market-hours", "market-hours-database.json");
_dataFolderMarketHoursDatabase = FromFile(path);
}
}
Expand Down
10 changes: 9 additions & 1 deletion QuantConnect.Lean.sln
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 14
VisualStudioVersion = 14.0.25123.0
VisualStudioVersion = 14.0.25420.1
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QuantConnect.Lean.Launcher", "Launcher\QuantConnect.Lean.Launcher.csproj", "{09E7B916-E58B-4021-BD8B-C10B4446E226}"
EndProject
Expand Down Expand Up @@ -58,6 +58,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".nuget", ".nuget", "{93A63A
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QuantConnect.ToolBox", "ToolBox\QuantConnect.ToolBox.csproj", "{AC9A142C-B485-44D7-91FF-015C22C43D05}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QuantConnect.VisualStudioPlugin", "VisualStudioPlugin\QuantConnect.VisualStudioPlugin.csproj", "{5326A9FB-0270-4647-8C43-20C5607DB529}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -196,6 +198,12 @@ Global
{AC9A142C-B485-44D7-91FF-015C22C43D05}.Release|Any CPU.ActiveCfg = Release|Any CPU
{AC9A142C-B485-44D7-91FF-015C22C43D05}.Release|Any CPU.Build.0 = Release|Any CPU
{AC9A142C-B485-44D7-91FF-015C22C43D05}.Release|x64.ActiveCfg = Release|Any CPU
{5326A9FB-0270-4647-8C43-20C5607DB529}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{5326A9FB-0270-4647-8C43-20C5607DB529}.Debug|x64.ActiveCfg = Debug|Any CPU
{5326A9FB-0270-4647-8C43-20C5607DB529}.Debug|x64.Build.0 = Debug|Any CPU
{5326A9FB-0270-4647-8C43-20C5607DB529}.Release|Any CPU.ActiveCfg = Release|Any CPU
{5326A9FB-0270-4647-8C43-20C5607DB529}.Release|x64.ActiveCfg = Release|Any CPU
{5326A9FB-0270-4647-8C43-20C5607DB529}.Release|x64.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down
30 changes: 26 additions & 4 deletions Tests/API/ApiTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -68,25 +68,47 @@ public void Projects_CanBeCreatedAndDeleted_Successfully()
}

/// <summary>
/// Test successfully authenticating with the API using valid credentials.
/// Test successfully authenticating with the ApiConnection using valid credentials.
/// </summary>
[Test]
public void ApiWillAuthenticate_ValidCredentials_Successfully()
public void ApiConnectionWillAuthenticate_ValidCredentials_Successfully()
{
var connection = new ApiConnection(_testAccount, _testToken);
Assert.IsTrue(connection.Connected);
}

/// <summary>
/// Test that the Api will reject invalid credentials
/// Test successfully authenticating with the API using valid credentials.
/// </summary>
[Test]
public void ApiWillAuthenticate_InvalidCredentials_Unsuccessfully()
public void ApiWillAuthenticate_ValidCredentials_Successfully()
{
var api = new Api.Api();
api.Initialize(_testAccount, _testToken, _dataFolder);
Assert.IsTrue(api.Connected);
}

/// <summary>
/// Test that the ApiConnection will reject invalid credentials
/// </summary>
[Test]
public void ApiConnectionWillAuthenticate_InvalidCredentials_Unsuccessfully()
{
var connection = new ApiConnection(_testAccount, "");
Assert.IsFalse(connection.Connected);
}

/// <summary>
/// Test that the Api will reject invalid credentials
/// </summary>
[Test]
public void ApiWillAuthenticate_InvalidCredentials_Unsuccessfully()
{
var api = new Api.Api();
api.Initialize(_testAccount, "", _dataFolder);
Assert.IsFalse(api.Connected);
}

/// <summary>
/// Test updating the files associated with a project
/// </summary>
Expand Down
102 changes: 102 additions & 0 deletions VisualStudioPlugin/AuthorizationManager.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

using System;

namespace QuantConnect.VisualStudioPlugin
{
/// <summary>
/// Singleton that stores a reference to an authenticated Api instance
/// </summary>
public class AuthorizationManager
{
private static readonly Log _log = new Log(typeof(AuthorizationManager));

private static AuthorizationManager _authorizationManager = new AuthorizationManager();
private Api.Api _api;

/// <summary>
/// Get singleton authorization manager instance accessable from multiple commands
/// </summary>
/// <returns>singleton authorization instance</returns>
public static AuthorizationManager GetInstance()
{
return _authorizationManager;
}

/// <summary>
/// Get an authenticated API instance.
/// </summary>
/// <returns>Authenticated API instance</returns>
/// <exception cref="NotAuthenticatedException">It API is not authenticated</exception>
public Api.Api GetApi()
{
if (_api == null)
{
throw new InvalidOperationException("Accessing API without logging in first");
}
return _api;
}

/// <summary>
/// Check if the API is authenticated
/// </summary>
/// <returns>true if API is authenticated, false otherwise</returns>
public bool IsLoggedIn()
{
return _api != null;
}

/// <summary>
/// Authenticate API
/// </summary>
/// <param name="userId">User id to authenticate the API</param>
/// <param name="accessToken">Access token to authenticate the API</param>
/// <returns>true if successfully authenticated API, false otherwise</returns>
public bool LogIn(Credentials credentials, string dataFolderPath)
{
_log.Info($"Authenticating QuantConnect API with data folder {dataFolderPath}");
try
{
var api = new Api.Api();
api.Initialize(int.Parse(credentials.UserId), credentials.AccessToken, dataFolderPath);
if (api.Connected)
{
_api = api;
return true;
}
else
{
return false;
}
}
catch (FormatException)
{
// User id is not a number
return false;
}

}

/// <summary>
/// Log out the API
/// </summary>
public void LogOut()
{
_api = null;
}

}
}
60 changes: 60 additions & 0 deletions VisualStudioPlugin/Credentials.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

namespace QuantConnect.VisualStudioPlugin
{
/// <summary>
/// Credentials to use QuantConnect API. Consists of a user id and an access token
/// </summary>
public struct Credentials
{
private string _userId;
private string _accessToken;

/// <summary>
/// Create Credentials
/// </summary>
/// <param name="userId">User id</param>
/// <param name="accessToken">Access token</param>
public Credentials(string userId, string accessToken)
{
_userId = userId;
_accessToken = accessToken;
}

/// <summary>
/// User id for QuantConnect API
/// </summary>
public string UserId
{
get
{
return _userId;
}
}

/// <summary>
/// Access token for QuantConnect API
/// </summary>
public string AccessToken
{
get
{
return _accessToken;
}
}

}
}
68 changes: 68 additions & 0 deletions VisualStudioPlugin/CredentialsManager.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

using CredentialManagement;

namespace QuantConnect.VisualStudioPlugin
{
/// <summary>
/// Class for storring and retrieving credentils from local Windows credentials store
/// </summary>
class CredentialsManager
{
private const string CREDENTIAL_TARGET = "QuantConnectPlugin";

/// <summary>
/// Get latest storred QuantConnect credentials.
/// </summary>
/// <returns>Latest storred credentials if they exist, null otherwise</returns>
public Credentials? GetLastCredential()
{
var credential = new Credential { Target = CREDENTIAL_TARGET };
if (!credential.Load())
{
return null;
}

return new Credentials(credential.Username, credential.Password);
}

/// <summary>
/// Store latests credentials. Overwrites last storred credentials.
/// </summary>
/// <param name="credentials">Credentials to store</param>
public void StoreCredentials(Credentials credentials)
{
var credential = new Credential
{
Target = CREDENTIAL_TARGET,
Username = credentials.UserId,
Password = credentials.AccessToken,
PersistanceType = PersistanceType.LocalComputer
};

credential.Save();
}

/// <summary>
/// Remove last storred credentials. After this GetLastCredential will return null.
/// </summary>
public void ForgetCredentials()
{
var credential = new Credential { Target = CREDENTIAL_TARGET };
credential.Delete();
}
}
}
Binary file added VisualStudioPlugin/Key.snk
Binary file not shown.
Loading

0 comments on commit 9de02c9

Please sign in to comment.