How to use LogConsumerConfiguration class of Atata package

Best Atata code snippet using Atata.LogConsumerConfiguration

LogManager.cs

Source:LogManager.cs

...12    public class LogManager : ILogManager13    {14        private readonly ILogEventInfoFactory _logEventInfoFactory;1516        private readonly List<LogConsumerConfiguration> _logConsumerConfigurations = new List<LogConsumerConfiguration>();17        private readonly List<IScreenshotConsumer> _screenshotConsumers = new List<IScreenshotConsumer>();1819        private readonly List<SecretStringToMask> _secretStringsToMask = new List<SecretStringToMask>();2021        private readonly Stack<LogSection> _sectionEndStack = new Stack<LogSection>();2223        private int _screenshotNumber;2425        public LogManager(ILogEventInfoFactory logEventInfoFactory)26        {27            _logEventInfoFactory = logEventInfoFactory.CheckNotNull(nameof(logEventInfoFactory));28        }2930        /// <summary>31        /// Use the specified consumer configuration for logging.32        /// </summary>33        /// <param name="logConsumerConfiguration">The log consumer configuration.</param>34        /// <returns>35        /// The same <see cref="LogManager" /> instance.36        /// </returns>37        public LogManager Use(LogConsumerConfiguration logConsumerConfiguration)38        {39            logConsumerConfiguration.CheckNotNull(nameof(logConsumerConfiguration));4041            _logConsumerConfigurations.Add(logConsumerConfiguration);4243            return this;44        }4546        /// <summary>47        /// Use the specified screenshot consumer.48        /// </summary>49        /// <param name="consumer">The screenshot consumer.</param>50        /// <returns>The same <see cref="LogManager"/> instance.</returns>51        public LogManager Use(IScreenshotConsumer consumer)52        {53            consumer.CheckNotNull(nameof(consumer));5455            _screenshotConsumers.Add(consumer);56            return this;57        }5859        /// <summary>60        /// Adds the secret strings to mask.61        /// </summary>62        /// <param name="secretStringsToMask">The secret strings to mask.</param>63        /// <returns>The same <see cref="LogManager"/> instance.</returns>64        public LogManager AddSecretStringsToMask(IEnumerable<SecretStringToMask> secretStringsToMask)65        {66            secretStringsToMask.CheckNotNull(nameof(secretStringsToMask));6768            _secretStringsToMask.AddRange(secretStringsToMask);6970            return this;71        }7273        /// <inheritdoc/>74        public void Trace(string message, params object[] args)75        {76            Log(LogLevel.Trace, message, args);77        }7879        /// <inheritdoc/>80        public void Debug(string message, params object[] args)81        {82            Log(LogLevel.Debug, message, args);83        }8485        /// <inheritdoc/>86        public void Info(string message, params object[] args)87        {88            Log(LogLevel.Info, message, args);89        }9091        /// <inheritdoc/>92        public void Warn(string message, params object[] args)93        {94            Log(LogLevel.Warn, message, args);95        }9697        /// <inheritdoc/>98        public void Warn(Exception exception)99        {100            Log(LogLevel.Warn, null, exception);101        }102103        /// <inheritdoc/>104        public void Warn(string message, Exception exception = null)105        {106            Log(LogLevel.Warn, message, exception);107        }108109        /// <inheritdoc/>110        public void Error(Exception exception)111        {112            Log(LogLevel.Error, null, exception);113        }114115        /// <inheritdoc/>116        public void Error(string message, Exception exception = null)117        {118            Log(LogLevel.Error, message, exception);119        }120121        /// <inheritdoc/>122        public void Fatal(Exception exception)123        {124            Log(LogLevel.Fatal, null, exception);125        }126127        /// <inheritdoc/>128        public void Fatal(string message, Exception exception = null)129        {130            Log(LogLevel.Fatal, message, exception);131        }132133        /// <inheritdoc/>134        public void ExecuteSection(LogSection section, Action action)135        {136            action.CheckNotNull(nameof(action));137138            Start(section);139140            try141            {142                action?.Invoke();143            }144            catch (Exception exception)145            {146                section.Exception = exception;147                throw;148            }149            finally150            {151                EndSection();152            }153        }154155        /// <inheritdoc/>156        public TResult ExecuteSection<TResult>(LogSection section, Func<TResult> function)157        {158            function.CheckNotNull(nameof(function));159160            Start(section);161162            try163            {164                TResult result = function.Invoke();165                section.Result = result;166                return result;167            }168            catch (Exception exception)169            {170                section.Exception = exception;171                throw;172            }173            finally174            {175                EndSection();176            }177        }178179        /// <inheritdoc/>180        public void Start(LogSection section)181        {182            section.CheckNotNull(nameof(section));183184            LogEventInfo eventInfo = _logEventInfoFactory.Create(section.Level, section.Message);185            eventInfo.SectionStart = section;186187            section.StartedAt = eventInfo.Timestamp;188            section.Stopwatch.Start();189190            Log(eventInfo);191192            _sectionEndStack.Push(section);193        }194195        /// <inheritdoc/>196        public void EndSection()197        {198            if (_sectionEndStack.Any())199            {200                LogSection section = _sectionEndStack.Pop();201202                section.Stopwatch.Stop();203204                string message = $"{section.Message} ({section.ElapsedTime.ToLongIntervalString()})";205206                if (section.IsResultSet)207                    message = AppendSectionResultToMessage(message, section.Result);208                else if (section.Exception != null)209                    message = AppendSectionResultToMessage(message, section.Exception);210211                LogEventInfo eventInfo = _logEventInfoFactory.Create(section.Level, message);212                eventInfo.SectionEnd = section;213214                Log(eventInfo);215            }216        }217218        private static string AppendSectionResultToMessage(string message, object result)219        {220            string resultAsString = result is Exception resultAsException221                ? BuildExceptionShortSingleLineMessage(resultAsException)222                : Stringifier.ToString(result);223224            string separator = resultAsString.Contains(Environment.NewLine)225                ? Environment.NewLine226                : " ";227228            return $"{message} >>{separator}{resultAsString}";229        }230231        private static string BuildExceptionShortSingleLineMessage(Exception exception)232        {233            string message = exception.Message;234235            int newLineIndex = message.IndexOf(Environment.NewLine, StringComparison.Ordinal);236237            if (newLineIndex >= 0)238            {239                message = message.Substring(0, newLineIndex);240241                message += message[message.Length - 1] == '.'242                    ? ".."243                    : "...";244            }245246            return $"{exception.GetType().FullName}: {message}";247        }248249        private static string PrependHierarchyPrefixesToMessage(string message, LogEventInfo eventInfo, LogConsumerConfiguration logConsumerConfiguration)250        {251            StringBuilder builder = new StringBuilder();252253            if (eventInfo.NestingLevel > 0)254            {255                for (int i = 0; i < eventInfo.NestingLevel; i++)256                {257                    builder.Append(logConsumerConfiguration.MessageNestingLevelIndent);258                }259            }260261            if (logConsumerConfiguration.LogSectionFinish)262            {263                if (eventInfo.SectionStart != null)
...

LogConsumerAtataContextBuilder`1.cs

Source:LogConsumerAtataContextBuilder`1.cs

2{3    public class LogConsumerAtataContextBuilder<TLogConsumer> : LogConsumersAtataContextBuilder, IHasContext<TLogConsumer>4        where TLogConsumer : ILogConsumer5    {6        private readonly LogConsumerConfiguration _logConsumerConfiguration;7        /// <summary>8        /// Initializes a new instance of the <see cref="LogConsumerAtataContextBuilder{TLogConsumer}" /> class.9        /// </summary>10        /// <param name="logConsumer">The log consumer.</param>11        /// <param name="logConsumerConfiguration">The log consumer configuration.</param>12        /// <param name="buildingContext">The building context.</param>13        public LogConsumerAtataContextBuilder(TLogConsumer logConsumer, LogConsumerConfiguration logConsumerConfiguration, AtataBuildingContext buildingContext)14            : base(buildingContext)15        {16            Context = logConsumer;17            _logConsumerConfiguration = logConsumerConfiguration;18        }19        /// <inheritdoc/>20        public TLogConsumer Context { get; }21        /// <summary>22        /// Defines that the logging should not use section-like pair messages (not <c>"Starting: {action}"</c> and <c>"Finished: {action}"</c>, but just <c>"{action}"</c>).23        /// </summary>24        /// <returns>The same builder instance.</returns>25        public LogConsumerAtataContextBuilder<TLogConsumer> WithoutSectionFinish()26        {27            _logConsumerConfiguration.LogSectionFinish = false;...

LogConsumerTests.cs

Source:LogConsumerTests.cs

...12        public void Multiple_ViaSingleConfig()13        {14            AtataContextBuilder builder = AtataContext.Configure().15                ApplyJsonConfig("Configs/LogConsumers");16            LogConsumerConfiguration[] expected =17            {18                new LogConsumerConfiguration(new DebugLogConsumer { Separator = " - " }),19                new LogConsumerConfiguration(new TraceLogConsumer(), LogLevel.Trace, true)20                {21                    MessageNestingLevelIndent = "_ ",22                    MessageStartSectionPrefix = "S:",23                    MessageEndSectionPrefix = "E:",24                },25                new LogConsumerConfiguration(new NUnitTestContextLogConsumer(), LogLevel.Info, false),26                new LogConsumerConfiguration(new NLogConsumer { LoggerName = "somelogger" }, LogLevel.Warn, false),27                new LogConsumerConfiguration(new CustomLogConsumer { IntProperty = 15 }, LogLevel.Error)28            };29            AssertLogConsumers(expected, builder.BuildingContext.LogConsumerConfigurations);30            JsonConfig.Current.LogConsumers.Count.Should().Be(expected.Length);31        }32        [Test]33        public void Multiple_ViaMultipleConfigs()34        {35            AtataContextBuilder builder = AtataContext.Configure().36                ApplyJsonConfig("Configs/DebugLogConsumers").37                ApplyJsonConfig("Configs/TraceLogConsumers");38            LogConsumerConfiguration[] expected =39            {40                new LogConsumerConfiguration(new DebugLogConsumer { Separator = " - " }),41                new LogConsumerConfiguration(new TraceLogConsumer(), LogLevel.Trace, true)42            };43            AssertLogConsumers(expected, builder.BuildingContext.LogConsumerConfigurations);44            JsonConfig.Current.LogConsumers.Select(x => x.Type)45                .Should().Equal(LogConsumerAliases.Debug, LogConsumerAliases.Trace);46        }47        private static void AssertLogConsumers(IEnumerable<LogConsumerConfiguration> expected, IEnumerable<LogConsumerConfiguration> actual)48        {49            actual.Should().BeEquivalentTo(50                expected,51                opt => opt.IncludingAllRuntimeProperties().Using<ILogConsumer>(ctx =>52                {53                    ctx.Subject.Should().BeOfType(ctx.Expectation.GetType());54                    ctx.Subject.Should().BeEquivalentTo(ctx.Expectation, opt2 => opt2.IncludingAllRuntimeProperties());55                }).WhenTypeIs<ILogConsumer>());56        }57        public class CustomLogConsumer : ILogConsumer58        {59            public int? IntProperty { get; set; }60            public void Log(LogEventInfo eventInfo)61            {...

LogConsumerConfiguration

Using AI Code Generation

1using Atata;2using NUnit.Framework;3{4    {5        public void OneTimeSetUp()6        {7            AtataContext.Configure()8                .UseChrome()9                .UseCulture("en-us")10                .UseAllNUnitFeatures()11                .UseNUnitTestName()12                .AddLogConsumer(new LogConsumerConfiguration()13                    .AddFileLogConsumer("logs")14                    .AddConsoleLogConsumer())15                .Build();16        }17        public void OneTimeTearDown()18        {19            AtataContext.Current?.CleanUp();20        }21    }22}23using Atata;24using NUnit.Framework;25{26    {27        public void OneTimeSetUp()28        {29            AtataContext.Configure()30                .UseChrome()31                .UseCulture("en-us")32                .UseAllNUnitFeatures()33                .UseNUnitTestName()34                .AddLogConsumer(new LogConsumerConfiguration()35                    .AddFileLogConsumer("logs")36                    .AddConsoleLogConsumer())37                .Build();38        }39        public void OneTimeTearDown()40        {41            AtataContext.Current?.CleanUp();42        }43    }44}45using Atata;46using NUnit.Framework;47{48    {49        public void OneTimeSetUp()50        {51            AtataContext.Configure()52                .UseChrome()53                .UseCulture("en-us")54                .UseAllNUnitFeatures()55                .UseNUnitTestName()56                .AddLogConsumer(new LogConsumerConfiguration()57                    .AddFileLogConsumer("logs")58                    .AddConsoleLogConsumer())59                .Build();60        }61        public void OneTimeTearDown()62        {63            AtataContext.Current?.CleanUp();64        }65    }

LogConsumerConfiguration

Using AI Code Generation

1using Atata;2using NUnit.Framework;3{4    {5        public void SetUp()6        {7                Build();8        }9        public void TearDown()10        {11            AtataContext.Current?.CleanUp();12        }13        public void SampleAppUITests_1()14        {15                Menu.Click(x => x.Home);16        }17    }18}19using Atata;20using NUnit.Framework;21{22    {23        public void SetUp()24        {25                Build();26        }27        public void TearDown()28        {29            AtataContext.Current?.CleanUp();30        }31        public void SampleAppUITests_1()32        {33                Header.Should.Equal("Customers

LogConsumerConfiguration

Using AI Code Generation

1using Atata;2using NUnit.Framework;3using System;4using System.Collections.Generic;5using System.Linq;6using System.Text;7using System.Threading.Tasks;8{9    {10        private LogConsumerConfiguration _logConsumerConfiguration;11        public void SetUp()12        {13            _logConsumerConfiguration = new LogConsumerConfiguration();14            _logConsumerConfiguration.LogConsumer = new NUnitLogConsumer();15        }16        public void TearDown()17        {18            _logConsumerConfiguration.Restore();19        }20        public void Test()21        {22            Go.To<PageObject>();23        }24    }25}26using Atata;27using NUnit.Framework;28using System;29using System.Collections.Generic;30using System.Linq;31using System.Text;32using System.Threading.Tasks;33{34    {35        public void SetUp()36        {37            LogConsumerConfiguration.Configure().LogConsumer = new NUnitLogConsumer();38        }39        public void TearDown()40        {41            LogConsumerConfiguration.Restore();42        }43        public void Test()44        {45            Go.To<PageObject>();46        }47    }48}49using Atata;50using NUnit.Framework;51using System;52using System.Collections.Generic;53using System.Linq;54using System.Text;55using System.Threading.Tasks;56{57    {58        public void SetUp()59        {60            LogConsumerConfiguration.Configure().LogConsumer = new NUnitLogConsumer();61        }62        public void Test()63        {64            Go.To<PageObject>();65        }66    }67}68using Atata;69using NUnit.Framework;70using System;71using System.Collections.Generic;72using System.Linq;73using System.Text;74using System.Threading.Tasks;75{76    {77        public void SetUp()78        {79            LogConsumerConfiguration.Configure().LogConsumer = new NUnitLogConsumer();80        }

LogConsumerConfiguration

Using AI Code Generation

1using Atata;2using NUnit.Framework;3{4    {5        public void Test1()6        {7                Build();8            Go.To<HomePage>();9        }10    }11}12using Atata;13using NUnit.Framework;14{15    {16        public void Test1()17        {18                Build();19            Go.To<HomePage>();20        }21    }22}23using Atata;24using NUnit.Framework;25{26    {27        public void Test1()28        {29                Build();30            Go.To<HomePage>();31        }32    }33}34using Atata;35using NUnit.Framework;36{37    {38        public void Test1()39        {

LogConsumerConfiguration

Using AI Code Generation

1using Atata;2using NUnit.Framework;3using NUnit.Framework.Interfaces;4using NUnit.Framework.Internal;5using NUnit.Framework.Internal.Builders;6using System;7using System.Collections.Generic;8using System.Linq;9using System.Text;10using System.Threading.Tasks;11{12    {13        public void NUnitLogConsumerTest()14        {15            LogConsumerConfiguration.Current.UseNUnit();16            Go.To<HomePage>();17            AtataContext.Current.Log.Info("This is info message");18            AtataContext.Current.Log.Warn("This is warning message");19            AtataContext.Current.Log.Error("This is error message");20        }21    }22}23using Atata;24using NUnit.Framework;25using NUnit.Framework.Interfaces;26using NUnit.Framework.Internal;27using NUnit.Framework.Internal.Builders;28using System;29using System.Collections.Generic;30using System.Linq;31using System.Text;32using System.Threading.Tasks;33{34    {35        public void NUnitLogConsumerTest()36        {37            LogConsumerConfiguration.Current.UseNUnit();38            Go.To<HomePage>();39            AtataContext.Current.Log.Info("This is info message");40            AtataContext.Current.Log.Warn("This is warning message");41            AtataContext.Current.Log.Error("This is error message");42        }43    }44}45using Atata;46using NUnit.Framework;47using NUnit.Framework.Interfaces;48using NUnit.Framework.Internal;49using NUnit.Framework.Internal.Builders;50using System;51using System.Collections.Generic;52using System.Linq;53using System.Text;54using System.Threading.Tasks;55{56    {57        public void NUnitLogConsumerTest()58        {59            LogConsumerConfiguration.Current.UseNUnit();60            Go.To<HomePage>();61            AtataContext.Current.Log.Info("This is info message");62            AtataContext.Current.Log.Warn("This is warning message");63            AtataContext.Current.Log.Error("This is error message");64        }65    }66}

LogConsumerConfiguration

Using AI Code Generation

1using System;2using Atata;3using NUnit.Framework;4using NUnit.Framework.Interfaces;5using NUnit.Framework.Internal;6using NUnit.Framework.Internal.Builders;7using NUnit.Framework.Internal.Execution;8using NUnit.Framework.Internal.Filters;9using NUnit.Framework.Internal.Listeners;10using NUnit.Framework.Internal.WorkItems;11using NUnitLite;12using NUnitLite.Runner;13{14    {15        public void OneTimeSetUp()16        {17            AtataContext.Configure()18                .UseChrome()19                .UseNUnitTestName()20                .UseLogConsumer(new NUnitLogConsumer())21                .Build();22        }23        public void OneTimeTearDown()24        {25            AtataContext.Current?.CleanUp();26        }27    }28}29using System;30using Atata;31using NUnit.Framework;32using NUnit.Framework.Interfaces;33using NUnit.Framework.Internal;34using NUnit.Framework.Internal.Builders;35using NUnit.Framework.Internal.Execution;36using NUnit.Framework.Internal.Filters;37using NUnit.Framework.Internal.Listeners;38using NUnit.Framework.Internal.WorkItems;39using NUnitLite;40using NUnitLite.Runner;41{42    {43        public void OneTimeSetUp()44        {45            AtataContext.Configure()46                .UseChrome()47                .UseNUnitTestName()48                .UseLogConsumer(new NUnitLogConsumer())49                .Build();50        }51        public void OneTimeTearDown()52        {53            AtataContext.Current?.CleanUp();54        }55    }56}57using System;58using Atata;59using NUnit.Framework;60using NUnit.Framework.Interfaces;61using NUnit.Framework.Internal;62using NUnit.Framework.Internal.Builders;63using NUnit.Framework.Internal.Execution;64using NUnit.Framework.Internal.Filters;65using NUnit.Framework.Internal.Listeners;66using NUnit.Framework.Internal.WorkItems;67using NUnitLite;68using NUnitLite.Runner;69{70    {71        public void OneTimeSetUp()72        {

LogConsumerConfiguration

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Atata;7using NUnit.Framework;8{9    {10        public void _2()11        {12            var config = LogConsumerConfiguration.Create().UseNUnitOut();13            using (var scope = LogConsumerScope.Start(config))14            {15                Go.To<HomePage>()16                    .Search.SearchFor("Atata")17                    .SearchResults.Items[x => x.Title.Should.Equal("Atata Framework")]18                    .Footer.Sitemap.Click();19            }20        }21    }22}23using System;24using System.Collections.Generic;25using System.Linq;26using System.Text;27using System.Threading.Tasks;28using Atata;29using NUnit.Framework;30{31    {32        public void _3()33        {34            var config = LogConsumerConfiguration.Create().UseNUnitOut();35            using (var scope = LogConsumerScope.Start(config))36            {37                Go.To<HomePage>()38                    .Search.SearchFor("Atata")39                    .SearchResults.Items[x => x.Title.Should.Equal("Atata Framework")]40                    .Footer.Sitemap.Click();41            }42        }43    }44}45using System;46using System.Collections.Generic;47using System.Linq;48using System.Text;49using System.Threading.Tasks;50using Atata;51using NUnit.Framework;52{53    {54        public void _4()55        {56            var config = LogConsumerConfiguration.Create().UseNUnitOut();57            using (var scope = LogConsumerScope.Start(config))58            {59                Go.To<HomePage>()60                    .Search.SearchFor("Atata")61                    .SearchResults.Items[x => x.Title.Should.Equal("Atata Framework")]62                    .Footer.Sitemap.Click();63            }64        }65    }66}67using System;68using System.Collections.Generic;69using System.Linq;70using System.Text;71using System.Threading.Tasks;72using Atata;73using NUnit.Framework;

LogConsumerConfiguration

Using AI Code Generation

1using Atata;2{3    using _ = PageObject1;4    {5        [FindById("id1")]6        public Control<_> Control1 { get; private set; }7        [FindById("id2")]8        public Control<_> Control2 { get; private set; }9    }10}11using Atata;12{13    using _ = PageObject2;14    {15        [FindById("id3")]16        public Control<_> Control3 { get; private set; }17        [FindById("id4")]18        public Control<_> Control4 { get; private set; }19    }20}21using Atata;22{23    using _ = PageObject3;24    {25        [FindById("id5")]26        public Control<_> Control5 { get; private set; }27        [FindById("id6")]28        public Control<_> Control6 { get; private set; }29    }30}31using Atata;32{33    using _ = PageObject4;34    {35        [FindById("id7")]36        public Control<_> Control7 { get; private set; }37        [FindById("id8")]38        public Control<_> Control8 { get; private set; }39    }40}41using Atata;42{43    using _ = PageObject5;44    {45        [FindById("id9")]46        public Control<_> Control9 { get; private set; }47        [FindById("id10")]48        public Control<_> Control10 { get; private set; }49    }50}

LogConsumerConfiguration

Using AI Code Generation

1using Atata;2using NUnit.Framework;3{4    {5        public void SetUp()6        {7            AtataContext.Configure()8                .UseChrome()9                .UseNUnitTestName()10                .UseLogConsumer(new LogConsumerConfiguration11                {12                    LogConsumer = new MyLogConsumer(),13                })14                .LogNUnitError()15                .Build();16        }17        public void LogConsumerTest()18        {19            Go.To<HomePage>()20                .Features.Should.HaveCount(4);21        }22    }23}24using Atata;25using NUnit.Framework;26{27    {28        public void SetUp()29        {30            AtataContext.Configure()31                .UseChrome()32                .UseNUnitTestName()33                .UseLogConsumer(new LogConsumerConfiguration34                {35                    LogConsumer = new MyLogConsumer(),36                })37                .LogNUnitError()38                .Build();39        }40        public void LogConsumerTest()41        {42            Go.To<HomePage>()43                .Features.Should.HaveCount(4);44        }45    }46}47using Atata;48using NUnit.Framework;49{50    {51        public void SetUp()52        {53            AtataContext.Configure()54                .UseChrome()55                .UseNUnitTestName()56                .UseLogConsumer(new LogConsumerConfiguration57                {58                    LogConsumer = new MyLogConsumer(),59                })60                .LogNUnitError()61                .Build();62        }

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.