using NUnit.Framework;

namespace Chernobyl.Measures.Time
{
    /// <summary>
    /// Tests for implementations of the <see cref="ITime"/> type.
    /// </summary>
    public abstract class TimeTests
    {
        [Test, Description("")]
        public void ToSecondsTest()
        {
            ITime time = CreateTime();

            Assert.AreEqual(ToSecondsValue, time.ToSeconds(),
                "The value returned by ITime.ToSeconds() is not the expected " + 
                "value.");
        }

        /// <summary>
        /// The expected value of the <see cref="ITime.ToSeconds()"/> return 
        /// value on the <see cref="ITime"/> instance returned by 
        /// <see cref="CreateTime()"/>.
        /// </summary>
        protected static readonly Seconds ToSecondsValue = new Seconds(42);

        /// <summary>
        /// Creates the <see cref="ITime"/> instance to be tested. The instance
        /// must be returned in a form such that the <see cref="Seconds"/> value
        /// returned by <see cref="ITime.ToSeconds()"/> is equal to the value
        /// <see cref="ToSecondsValue"/>.
        /// </summary>
        /// <returns></returns>
        protected abstract ITime CreateTime();
    }
}