/*
* 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;
using System.Collections.Immutable;
using System.Linq;
using System.Reflection;
using QuantConnect.Brokerages;
using QuantConnect.Securities;
namespace QuantConnect.Tests
{
///
/// Provides symbol instances for unit tests
///
public static class Symbols
{
public static readonly Symbol SPY = CreateEquitySymbol("SPY");
public static readonly Symbol AAPL = CreateEquitySymbol("AAPL");
public static readonly Symbol MSFT = CreateEquitySymbol("MSFT");
public static readonly Symbol ZNGA = CreateEquitySymbol("ZNGA");
public static readonly Symbol FXE = CreateEquitySymbol("FXE");
public static readonly Symbol LODE = CreateEquitySymbol("LODE");
public static readonly Symbol IBM = CreateEquitySymbol("IBM");
public static readonly Symbol GOOG = CreateEquitySymbol("GOOG");
public static readonly Symbol NFLX = CreateEquitySymbol("NFLX");
public static readonly Symbol CAT = CreateEquitySymbol("CAT");
public static readonly Symbol SGX = CreateEquitySymbol("SGX", Market.SGX);
public static readonly Symbol SBIN = CreateEquitySymbol("SBIN",Market.India);
public static readonly Symbol IDEA = CreateEquitySymbol("IDEA", Market.India);
public static readonly Symbol LOW = CreateEquitySymbol("LOW");
public static readonly Symbol USDJPY = CreateForexSymbol("USDJPY");
public static readonly Symbol EURUSD = CreateForexSymbol("EURUSD");
public static readonly Symbol EURGBP = CreateForexSymbol("EURGBP");
public static readonly Symbol GBPUSD = CreateForexSymbol("GBPUSD");
public static readonly Symbol GBPJPY = CreateForexSymbol("GBPJPY");
public static readonly Symbol BTCUSD = CreateCryptoSymbol("BTCUSD");
public static readonly Symbol LTCUSD = CreateCryptoSymbol("LTCUSD");
public static readonly Symbol ETHUSD = CreateCryptoSymbol("ETHUSD");
public static readonly Symbol BTCEUR = CreateCryptoSymbol("BTCEUR");
public static readonly Symbol ETHBTC = CreateCryptoSymbol("ETHBTC");
public static readonly Symbol DE10YBEUR = CreateCfdSymbol("DE10YBEUR", Market.Oanda);
public static readonly Symbol DE30EUR = CreateCfdSymbol("DE30EUR", Market.Oanda);
public static readonly Symbol XAGUSD = CreateCfdSymbol("XAGUSD", Market.Oanda);
public static readonly Symbol XAUUSD = CreateCfdSymbol("XAUUSD", Market.Oanda);
public static readonly Symbol XAUJPY = CreateCfdSymbol("XAUJPY", Market.Oanda);
public static readonly Symbol SPY_Option_Chain = CreateOptionsCanonicalSymbol("SPY");
public static readonly Symbol SPY_C_192_Feb19_2016 = CreateOptionSymbol("SPY", OptionRight.Call, 192m, new DateTime(2016, 02, 19));
public static readonly Symbol SPY_P_192_Feb19_2016 = CreateOptionSymbol("SPY", OptionRight.Put, 192m, new DateTime(2016, 02, 19));
public static readonly Symbol Fut_SPY_Feb19_2016 = CreateFutureSymbol(Futures.Indices.SP500EMini, new DateTime(2016, 02, 19));
public static readonly Symbol Fut_SPY_Mar19_2016 = CreateFutureSymbol(Futures.Indices.SP500EMini, new DateTime(2016, 03, 19));
public static readonly Symbol ES_Future_Chain = CreateFuturesCanonicalSymbol(Futures.Indices.SP500EMini);
public static readonly Symbol Future_ESZ18_Dec2018 = CreateFutureSymbol(Futures.Indices.SP500EMini, new DateTime(2018, 12, 21));
public static readonly Symbol Future_CLF19_Jan2019 = CreateFutureSymbol("CL", new DateTime(2018, 12, 19));
public static readonly Symbol SPX = CreateIndexSymbol("SPX");
public static readonly ImmutableArray All =
typeof(Symbols).GetFields(BindingFlags.Public | BindingFlags.Static)
.Where(field => field.FieldType == typeof(Symbol))
.Select(field => (Symbol) field.GetValue(null))
.ToImmutableArray();
///
/// Can be supplied in TestCase attribute
///
public enum SymbolsKey
{
SPY,
AAPL,
MSFT,
SBIN,
IDEA,
ZNGA,
FXE,
USDJPY,
EURUSD,
BTCUSD,
EURGBP,
GBPUSD,
DE10YBEUR,
SPY_C_192_Feb19_2016,
SPY_P_192_Feb19_2016,
Fut_SPY_Feb19_2016,
Fut_SPY_Mar19_2016
}
///
/// Convert key into symbol instance
///
/// the symbol key
/// The matching symbol instance
/// Using reflection minimizes maintenance but is slower at runtime.
public static Symbol Lookup(SymbolsKey key)
{
return (Symbol)typeof(Symbols).GetField(key.ToString(), BindingFlags.Public | BindingFlags.Static).GetValue(null);
}
///
/// Gets a symbol matching the specified
///
public static Symbol GetBySecurityType(SecurityType type)
{
switch (type)
{
case SecurityType.Equity: return SPY;
case SecurityType.Option: return SPY_C_192_Feb19_2016;
case SecurityType.Forex: return EURUSD;
case SecurityType.Future: return Future_CLF19_Jan2019;
case SecurityType.Cfd: return XAGUSD;
case SecurityType.Crypto: return BTCUSD;
case SecurityType.Index: return SPX;
default:
throw new NotImplementedException($"Symbols.GetBySecurityType({type}) is not implemented.");
}
}
private static Symbol CreateForexSymbol(string symbol)
{
return Symbol.Create(symbol, SecurityType.Forex, Market.Oanda);
}
private static Symbol CreateEquitySymbol(string symbol, string market = Market.USA)
{
TestGlobals.Initialize();
return Symbol.Create(symbol, SecurityType.Equity, market);
}
public static Symbol CreateFutureSymbol(string symbol, DateTime expiry)
{
string market;
if (!SymbolPropertiesDatabase.FromDataFolder().TryGetMarket(symbol, SecurityType.Future, out market))
{
market = DefaultBrokerageModel.DefaultMarketMap[SecurityType.Future];
}
return Symbol.CreateFuture(symbol, market, expiry);
}
public static Symbol CreateFutureOptionSymbol(Symbol underlying, OptionRight right, decimal strike, DateTime expiry)
{
return Symbol.CreateOption(underlying, underlying.ID.Market, OptionStyle.American, right, strike, expiry);
}
private static Symbol CreateCfdSymbol(string symbol, string market)
{
return Symbol.Create(symbol, SecurityType.Cfd, market);
}
internal static Symbol CreateOptionSymbol(string symbol, OptionRight right, decimal strike, DateTime expiry, string market = Market.USA)
{
return Symbol.CreateOption(symbol, market, OptionStyle.American, right, strike, expiry);
}
private static Symbol CreateCryptoSymbol(string symbol)
{
return Symbol.Create(symbol, SecurityType.Crypto, Market.Coinbase);
}
private static Symbol CreateOptionsCanonicalSymbol(string underlying)
{
return Symbol.Create(underlying, SecurityType.Option, Market.USA, "?" + underlying);
}
public static Symbol CreateFuturesCanonicalSymbol(string ticker)
{
string market;
if (!SymbolPropertiesDatabase.FromDataFolder().TryGetMarket(ticker, SecurityType.Future, out market))
{
market = DefaultBrokerageModel.DefaultMarketMap[SecurityType.Future];
}
return Symbol.Create(ticker, SecurityType.Future, market, "/" + ticker);
}
internal static Symbol CreateIndexSymbol(string ticker)
{
return Symbol.Create(ticker, SecurityType.Index, Market.USA);
}
}
}