IViewBagTestBuilder.cs

namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data
{
    using System;
    using System.Collections.Generic;

    /// <summary>
    /// Used for testing dynamic view bag.
    /// </summary>
    public interface IViewBagTestBuilder
    {
        /// <summary>
        /// Tests whether the dynamic view bag contains entry with the provided key.
        /// </summary>
        /// <param name="key">Key of the view bag entry.</param>
        /// <returns>The same <see cref="IAndViewBagTestBuilder"/>.</returns>
        IAndViewBagTestBuilder ContainingEntryWithKey(string key);

        /// <summary>
        /// Tests whether the dynamic view bag contains entry with the provided value.
        /// </summary>
        /// <typeparam name="TValue">Type of the view bag entry value.</typeparam>
        /// <param name="value">Value of the view bag entry.</param>
        /// <returns>The same <see cref="IAndViewBagTestBuilder"/>.</returns>
        IAndViewBagTestBuilder ContainingEntryWithValue<TValue>(TValue value);

        /// <summary>
        /// Tests whether the dynamic view bag contains entry with value of the provided type.
        /// </summary>
        /// <typeparam name="TValue">Type of the view bag entry value.</typeparam>
        /// <returns>The same <see cref="IAndViewBagTestBuilder"/>.</returns>
        IAndViewBagTestBuilder ContainingEntryOfType<TValue>();

        /// <summary>
        /// Tests whether the dynamic view bag contains entry with value of the provided type and the given key.
        /// </summary>
        /// <typeparam name="TValue">Type of the view bag entry value.</typeparam>
        /// <param name="key">Key of the view bag entry.</param>
        /// <returns>The same <see cref="IAndViewBagTestBuilder"/>.</returns>
        IAndViewBagTestBuilder ContainingEntryOfType<TValue>(string key);

        /// <summary>
        /// Tests whether the dynamic view bag contains entry with the provided key and corresponding value.
        /// </summary>
        /// <param name="key">Key of the view bag entry.</param>
        /// <param name="value">Value of the view bag entry.</param>
        /// <returns>The same <see cref="IAndViewBagTestBuilder"/>.</returns>
        IAndViewBagTestBuilder ContainingEntry(string key, object value);

        /// <summary>
        /// Tests whether the dynamic view bag contains specific entry by using a builder. 
        /// </summary>
        /// <param name="viewBagEntryTestBuilder">Builder for setting specific dynamic view bag entry tests.</param>
        /// <returns>The same <see cref="IAndViewBagTestBuilder"/>.</returns>
        IAndViewBagTestBuilder ContainingEntry(Action<IDataProviderEntryKeyTestBuilder> viewBagEntryTestBuilder);

        /// <summary>
        /// Tests whether the dynamic view bag contains the provided entries. 
        /// </summary>
        /// <param name="entries">Anonymous object of view bag entries.</param>
        /// <returns>The same <see cref="IAndViewBagTestBuilder"/>.</returns>
        IAndViewBagTestBuilder ContainingEntries(object entries);

        /// <summary>
        /// Tests whether the dynamic view bag contains the provided entries. 
        /// </summary>
        /// <param name="entries">Dictionary of view bag entries.</param>
        /// <returns>The same <see cref="IAndViewBagTestBuilder"/>.</returns>
        IAndViewBagTestBuilder ContainingEntries(IDictionary<string, object> entries);


        /// <summary>
        /// Tests whether the view bag entry passes the given assertions.
        /// </summary>
        /// <param name="assertions">Action containing all assertions for the view bag entry.</param>
        /// <returns>The same <see cref="IAndViewBagTestBuilder"/>.</returns>
        IAndViewBagTestBuilder Passing(Action assertions);

        /// <summary>
        /// Tests whether the view bag entry passes the given predicate.
        /// </summary>
        /// <param name="predicate">Predicate testing the view bag entry.</param>
        /// <returns>The same <see cref="IAndViewBagTestBuilder"/>.</returns>
        IAndViewBagTestBuilder Passing(Func< bool> predicate);
    }
}