quantconnect--lean/Algorithm.CSharp/HourResolutionMappingEventRegressionAlgorithm.cs

/*
 * 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 QuantConnect.Data;
using QuantConnect.Interfaces;
using QuantConnect.Data.Market;
using System.Collections.Generic;

namespace QuantConnect.Algorithm.CSharp
{
    /// <summary>
    /// Regression algorithm reproducing GH issue #5232, where we expect SPWR to be mapped to SPWRA
    /// </summary>
    public class HourResolutionMappingEventRegressionAlgorithm : QCAlgorithm, IRegressionAlgorithmDefinition
    {
        private DateTime _dateTime;
        private SymbolChangedEvent _changedEvent;

        /// <summary>
        /// Initialise the data and resolution required, as well as the cash and start-end dates for your algorithm. All algorithms must initialized.
        /// </summary>
        public override void Initialize()
        {
            SetStartDate(2008, 08, 20);
            SetEndDate(2008, 10, 1);

            AddEquity("SPWR", Resolution.Hour, fillForward:false);
        }

        /// <summary>
        /// OnData event is the primary entry point for your algorithm. Each new data point will be pumped in here.
        /// </summary>
        /// <param name="data">Slice object keyed by symbol containing the stock data</param>
        public override void OnData(Slice slice)
        {
            _dateTime = Time.Date;
            if (!Portfolio.Invested)
            {
                SetHoldings("SPWR", 1);
            }

            foreach (var symbolChangedEvent in slice.SymbolChangedEvents.Values)
            {
                _changedEvent = symbolChangedEvent;
                Log($"{Time}: {symbolChangedEvent.OldSymbol} -> {symbolChangedEvent.NewSymbol}");
            }
        }

        public override void OnEndOfAlgorithm()
        {
            if (_dateTime != EndDate.Date)
            {
                throw new RegressionTestException($"Last day was {_dateTime}, should be algorithm end date: {EndDate.Date}");
            }
            if (_changedEvent == null)
            {
                throw new RegressionTestException("We got not symbol change event! 'SPWR' should of been mapped");
            }
        }

        /// <summary>
        /// This is used by the regression test system to indicate if the open source Lean repository has the required data to run this algorithm.
        /// </summary>
        public bool CanRunLocally { get; } = true;

        /// <summary>
        /// This is used by the regression test system to indicate which languages this algorithm is written in.
        /// </summary>
        public List<Language> Languages { get; } = new() { Language.CSharp };

        /// <summary>
        /// Data Points count of all timeslices of algorithm
        /// </summary>
        public long DataPoints => 429;

        /// <summary>
        /// Data Points count of the algorithm history
        /// </summary>
        public int AlgorithmHistoryDataPoints => 0;

        /// <summary>
        /// Final status of the algorithm
        /// </summary>
        public AlgorithmStatus AlgorithmStatus => AlgorithmStatus.Completed;

        /// <summary>
        /// This is used by the regression test system to indicate what the expected statistics are from running the algorithm
        /// </summary>
        public Dictionary<string, string> ExpectedStatistics => new Dictionary<string, string>
        {
            {"Total Orders", "1"},
            {"Average Win", "0%"},
            {"Average Loss", "0%"},
            {"Compounding Annual Return", "-78.316%"},
            {"Drawdown", "31.700%"},
            {"Expectancy", "0"},
            {"Start Equity", "100000"},
            {"End Equity", "83636.96"},
            {"Net Profit", "-16.363%"},
            {"Sharpe Ratio", "-0.498"},
            {"Sortino Ratio", "-0.507"},
            {"Probabilistic Sharpe Ratio", "24.798%"},
            {"Loss Rate", "0%"},
            {"Win Rate", "0%"},
            {"Profit-Loss Ratio", "0"},
            {"Alpha", "0.357"},
            {"Beta", "2.004"},
            {"Annual Standard Deviation", "0.924"},
            {"Annual Variance", "0.854"},
            {"Information Ratio", "-0.073"},
            {"Tracking Error", "0.718"},
            {"Treynor Ratio", "-0.23"},
            {"Total Fees", "$5.40"},
            {"Estimated Strategy Capacity", "$2400000.00"},
            {"Lowest Capacity Asset", "SPWR TDQZFPKOZ5UT"},
            {"Portfolio Turnover", "2.34%"},
            {"Drawdown Recovery", "5"},
            {"OrderListHash", "cc6e8f0ec77d9ed25118562e954bb781"}
        };
    }
}