// Copyright (C) Stichting Deltares 2017. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

using System;
using Core.Common.Base.Service;
using Core.Common.TestUtil;
using NUnit.Framework;

namespace Core.Common.Base.Test.Service
{
    [TestFixture]
    public class ActivityTest
    {
        [Test]
        public void DefaultConstructor_ExpectedValues()
        {
            // Call
            var activity = new SimpleActivity(false, false, false);

            // Assert
            Assert.AreEqual("", activity.Name);
            Assert.AreEqual(ActivityState.None, activity.State);
            Assert.IsNull(activity.ProgressText);
            CollectionAssert.IsEmpty(activity.LogMessages);
        }

        [Test]
        public void ProgressText_SetValue_ProgressChangedListenersAreNotified()
        {
            // Setup
            const string someProgress = "Some progress";

            var counter = 0;
            var activity = new SimpleActivity(false, false, false);

            activity.ProgressChanged += (sender, args) => counter++;

            // Call
            activity.SetProgressText(someProgress);

            // Assert
            Assert.AreEqual(1, counter);
            Assert.AreEqual(someProgress, activity.ProgressText);
        }

        [Test]
        public void Run_ActivityWithSuccessfulRun_StateIsChangedToExecuted()
        {
            // Setup
            var activity = new SimpleActivity(false, false, false);

            // Call
            activity.Run();

            // Assert
            Assert.AreEqual(ActivityState.Executed, activity.State);
        }

        [Test]
        public void Run_ActivityWithFailingRun_StateIsChangedToFailed()
        {
            // Setup
            var activity = new SimpleActivity(true, false, false);

            // Call
            activity.Run();

            // Assert
            Assert.AreEqual(ActivityState.Failed, activity.State);
        }

        [Test]
        public void Cancel_ActivityWithSuccessfulCancel_StateIsChangedToCanceled()
        {
            // Setup
            var activity = new SimpleActivity(false, false, false);

            // Call
            activity.Cancel();

            // Assert
            Assert.AreEqual(ActivityState.Canceled, activity.State);
        }

        [Test]
        public void Cancel_ActivityWithFailingCancel_StateIsChangedToFailed()
        {
            // Setup
            var activity = new SimpleActivity(false, true, false);

            // Call
            activity.Cancel();

            // Assert
            Assert.AreEqual(ActivityState.Failed, activity.State);
        }

        [Test]
        public void Finish_ActivityWithExecutedStateAndSuccessfulFinish_MessageIsSendToLogAndStateIsChangedToFinished()
        {
            // Setup
            var activity = new SimpleActivity(false, false, false, ActivityState.Executed);

            // Call / Assert
            TestHelper.AssertLogMessagesAreGenerated(() => activity.Finish(), new[]
            {
                "Uitvoeren van '' is gelukt."
            });

            Assert.AreEqual(ActivityState.Finished, activity.State);
        }

        [Test]
        [TestCase(ActivityState.Failed, "Uitvoeren van '' is mislukt.")]
        [TestCase(ActivityState.Canceled, "Uitvoeren van '' is geannuleerd.")]
        [TestCase(ActivityState.Skipped, "Uitvoeren van '' is overgeslagen.")]
        public void Finish_ActivityWithCertainStateAndSuccessfulFinish_MessageIsSendToLogAndStateIsPreserved(ActivityState state, string message)
        {
            // Setup
            var activity = new SimpleActivity(false, false, false, state);

            // Call / Assert
            TestHelper.AssertLogMessagesAreGenerated(() => activity.Finish(), new[]
            {
                message
            });

            Assert.AreEqual(state, activity.State);
        }

        [Test]
        public void Finish_ActivityWithNoneStateAndSuccessfulFinish_NoMessageIsSendToLogAndStateIsPreserved()
        {
            // Setup
            var activity = new SimpleActivity(false, false, false);

            // Call / Assert
            TestHelper.AssertLogMessagesCount(() => activity.Finish(), 0);
            Assert.AreEqual(ActivityState.None, activity.State);
        }

        [Test]
        [TestCase(ActivityState.Executed)]
        [TestCase(ActivityState.Canceled)]
        [TestCase(ActivityState.Skipped)]
        public void Finish_ActivityWithCertainStateAndFailingFinish_MessageIsSendToLogAndStateIsChangedToFailed(ActivityState state)
        {
            // Setup
            var activity = new SimpleActivity(false, false, true, state);

            // Call / Assert
            TestHelper.AssertLogMessagesAreGenerated(() => activity.Finish(), new[]
            {
                "Uitvoeren van '' is mislukt."
            });

            Assert.AreEqual(ActivityState.Failed, activity.State);
        }

        [Test]
        public void Finish_ActivityWithNoneStateAndFailingFinish_NoMessageIsSendToLogAndStateIsPreserved()
        {
            // Setup
            var activity = new SimpleActivity(false, false, true);

            // Call / Assert
            TestHelper.AssertLogMessagesCount(() => activity.Finish(), 0);
            Assert.AreEqual(ActivityState.None, activity.State);
        }

        private class SimpleActivity : Activity
        {
            private readonly bool throwOnRun;
            private readonly bool throwOnCancel;
            private readonly bool throwOnFinish;

            public SimpleActivity(bool throwOnRun, bool throwOnCancel, bool throwOnFinish, ActivityState state = ActivityState.None)
            {
                this.throwOnRun = throwOnRun;
                this.throwOnCancel = throwOnCancel;
                this.throwOnFinish = throwOnFinish;

                State = state;
            }

            public void SetProgressText(string progressText)
            {
                ProgressText = progressText;
            }

            protected override void OnRun()
            {
                if (throwOnRun)
                {
                    throw new Exception("Error during run");
                }
            }

            protected override void OnCancel()
            {
                if (throwOnCancel)
                {
                    throw new Exception("Error during cancel");
                }
            }

            protected override void OnFinish()
            {
                if (throwOnFinish)
                {
                    throw new Exception("Error during finish");
                }
            }
        }
    }
}