How to use NLogFileConsumer class of Atata package

Best Atata code snippet using Atata.NLogFileConsumer

JsonConfigMapper.cs

Source:JsonConfigMapper.cs

...124            if (section.MessageStartSectionPrefix != null)125                consumerBuilder.WithMessageStartSectionPrefix(section.MessageStartSectionPrefix);126            if (section.MessageEndSectionPrefix != null)127                consumerBuilder.WithMessageEndSectionPrefix(section.MessageEndSectionPrefix);128            if (consumerBuilder.Context is NLogFileConsumer nLogFileConsumer)129                ConfigureNLogFileConsumer(nLogFileConsumer, section.ExtraPropertiesMap);130            else131                consumerBuilder.WithProperties(section.ExtraPropertiesMap);132        }133        // TODO: Remove this method when NLogFileConsumer will get string path/name properties.134        private static void ConfigureNLogFileConsumer(NLogFileConsumer consumer, Dictionary<string, object> propertiesMap)135        {136            foreach (var item in propertiesMap)137            {138                // TODO: v3. Remove first if block.139                if (item.Key.Equals("FolderPath", StringComparison.OrdinalIgnoreCase))140                    consumer.DirectoryPathBuilder = _ => item.Value.ToString();141                else if (item.Key.Equals("DirectoryPath", StringComparison.OrdinalIgnoreCase))142                    consumer.DirectoryPathBuilder = _ => item.Value.ToString();143                else if (item.Key.Equals("FileName", StringComparison.OrdinalIgnoreCase))144                    consumer.FileNameBuilder = _ => item.Value.ToString();145                else if (item.Key.Equals("FilePath", StringComparison.OrdinalIgnoreCase))146                    consumer.FilePathBuilder = _ => item.Value.ToString();147            }148        }...

LogConsumerAtataContextBuilderExtensions.cs

Source:LogConsumerAtataContextBuilderExtensions.cs

...50        /// </summary>51        /// <param name="builder">The builder.</param>52        /// <param name="filePath">The file path.</param>53        /// <returns>The same builder instance.</returns>54        public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithFilePath(55            this LogConsumerAtataContextBuilder<NLogFileConsumer> builder,56            string filePath)57        {58            filePath.CheckNotNullOrWhitespace(nameof(filePath));59            return builder.WithFilePath(_ => filePath);60        }61        /// <summary>62        /// Specifies the full file path builder for the log file.63        /// </summary>64        /// <param name="builder">The builder.</param>65        /// <param name="filePathBuilder">The file path builder function.</param>66        /// <returns>The same builder instance.</returns>67        public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithFilePath(68            this LogConsumerAtataContextBuilder<NLogFileConsumer> builder,69            Func<AtataContext, string> filePathBuilder)70        {71            builder.Context.FilePathBuilder = filePathBuilder;72            return builder;73        }74        [Obsolete("Use " + nameof(WithArtifactsDirectoryPath) + " instead.")] // Obsolete since v2.0.0.75        public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithArtifactsFolderPath(76            this LogConsumerAtataContextBuilder<NLogFileConsumer> builder)77            =>78            builder.WithArtifactsDirectoryPath();79        /// <summary>80        /// Sets the <see cref="AtataContext.Artifacts"/> directory as the directory path of the file screenshot consumer.81        /// </summary>82        /// <param name="builder">The builder.</param>83        /// <returns>The same builder instance.</returns>84        public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithArtifactsDirectoryPath(85            this LogConsumerAtataContextBuilder<NLogFileConsumer> builder)86            =>87            builder.WithDirectoryPath(x => x.Artifacts.FullName);88        [Obsolete("Use " + nameof(WithDirectoryPath) + " instead.")] // Obsolete since v2.0.0.89        public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithFolderPath(90            this LogConsumerAtataContextBuilder<NLogFileConsumer> builder,91            string folderPath)92            =>93            builder.WithDirectoryPath(folderPath);94        [Obsolete("Use " + nameof(WithDirectoryPath) + " instead.")] // Obsolete since v2.0.0.95        public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithFolderPath(96            this LogConsumerAtataContextBuilder<NLogFileConsumer> builder,97            Func<AtataContext, string> folderPathBuilder)98            =>99            builder.WithDirectoryPath(folderPathBuilder);100        /// <summary>101        /// Specifies the directory path of the log file.102        /// </summary>103        /// <param name="builder">The builder.</param>104        /// <param name="directoryPath">The directory path.</param>105        /// <returns>The same builder instance.</returns>106        public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithDirectoryPath(107            this LogConsumerAtataContextBuilder<NLogFileConsumer> builder,108            string directoryPath)109        {110            directoryPath.CheckNotNullOrWhitespace(nameof(directoryPath));111            return builder.WithDirectoryPath(_ => directoryPath);112        }113        /// <summary>114        /// Specifies the directory path builder for the log file.115        /// </summary>116        /// <param name="builder">The builder.</param>117        /// <param name="directoryPathBuilder">The directory path builder function.</param>118        /// <returns>The same builder instance.</returns>119        public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithDirectoryPath(120            this LogConsumerAtataContextBuilder<NLogFileConsumer> builder,121            Func<AtataContext, string> directoryPathBuilder)122        {123            builder.Context.DirectoryPathBuilder = directoryPathBuilder;124            return builder;125        }126        /// <summary>127        /// Specifies the file name of the log file.128        /// </summary>129        /// <param name="builder">The builder.</param>130        /// <param name="fileName">The file path.</param>131        /// <returns>The same builder instance.</returns>132        public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithFileName(133            this LogConsumerAtataContextBuilder<NLogFileConsumer> builder,134            string fileName)135        {136            fileName.CheckNotNullOrWhitespace(nameof(fileName));137            return builder.WithFileName(_ => fileName);138        }139        /// <summary>140        /// Specifies the file name builder for the log file.141        /// </summary>142        /// <param name="builder">The builder.</param>143        /// <param name="fileNameBuilder">The file path builder function.</param>144        /// <returns>The same builder instance.</returns>145        public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithFileName(146            this LogConsumerAtataContextBuilder<NLogFileConsumer> builder,147            Func<AtataContext, string> fileNameBuilder)148        {149            builder.Context.FileNameBuilder = fileNameBuilder;150            return builder;151        }152        /// <summary>153        /// Specifies the layout of log event.154        /// </summary>155        /// <param name="builder">The builder.</param>156        /// <param name="layout">The layout of log event.</param>157        /// <returns>The same builder instance.</returns>158        public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithLayout(159            this LogConsumerAtataContextBuilder<NLogFileConsumer> builder,160            string layout)161        {162            builder.Context.Layout = layout;163            return builder;164        }165    }166}...

NLogFileConsumerTests.cs

Source:NLogFileConsumerTests.cs

...4using NUnit.Framework;5using NUnit.Framework.Internal;6namespace Atata.Tests7{8    public class NLogFileConsumerTests : UITestFixtureBase9    {10        [Test]11        public void ConfigureByDefault()12        {13            ConfigureBaseAtataContext()14                .LogConsumers.AddNLogFile()15                .Build();16            WriteLogMessageAndAssertItInFile(17                Path.Combine(AtataContext.Current.Artifacts.FullName, NLogFileConsumer.DefaultFileName));18        }19        [Test]20        public void ConfigureWithFilePath()21        {22            using var directoryFixture = DirectoryFixture.CreateUniqueDirectory();23            string filePath = Path.Combine(directoryFixture.DirectoryPath, "test.log");24            ConfigureBaseAtataContext()25                .LogConsumers.AddNLogFile()26                    .WithFilePath(filePath)27                .Build();28            WriteLogMessageAndAssertItInFile(filePath);29        }30        [Test]31        public void ConfigureWithFilePathThatContainsVariables()32        {33            using var directoryFixture = DirectoryFixture.CreateUniqueDirectory();34            string filePath = Path.Combine(directoryFixture.DirectoryPath, "{test-name-sanitized}-{driver-alias}", "test.log");35            ConfigureBaseAtataContext()36                .LogConsumers.AddNLogFile()37                    .WithFilePath(filePath)38                .Build();39            WriteLogMessageAndAssertItInFile(40                Path.Combine(directoryFixture.DirectoryPath, $"{AtataContext.Current.TestNameSanitized}-{AtataContext.Current.DriverAlias}", "test.log"));41        }42        [Test]43        public void ConfigureWithDirectoryPath()44        {45            using var directoryFixture = DirectoryFixture.CreateUniqueDirectory();46            ConfigureBaseAtataContext()47                .LogConsumers.AddNLogFile()48                    .WithDirectoryPath(directoryFixture.DirectoryPath)49                .Build();50            WriteLogMessageAndAssertItInFile(51                Path.Combine(directoryFixture.DirectoryPath, NLogFileConsumer.DefaultFileName));52        }53        [Test]54        public void ConfigureWithDirectoryPathThatContainsVariables()55        {56            ConfigureBaseAtataContext()57                .LogConsumers.AddNLogFile()58                    .WithDirectoryPath("{artifacts}/1")59                .Build();60            WriteLogMessageAndAssertItInFile(61                Path.Combine(AtataContext.Current.Artifacts.FullName, "1", NLogFileConsumer.DefaultFileName));62        }63        [Test]64        public void ConfigureWithArtifactsDirectoryPath()65        {66            ConfigureBaseAtataContext()67                .LogConsumers.AddNLogFile()68                    .WithArtifactsDirectoryPath()69                .Build();70            WriteLogMessageAndAssertItInFile(71                Path.Combine(AtataContext.Current.Artifacts.FullName, NLogFileConsumer.DefaultFileName));72        }73        [Test]74        public void ConfigureWithFileName()75        {76            string fileName = Guid.NewGuid().ToString();77            ConfigureBaseAtataContext()78                .LogConsumers.AddNLogFile()79                    .WithFileName(fileName)80                .Build();81            WriteLogMessageAndAssertItInFile(82                Path.Combine(AtataContext.Current.Artifacts.FullName, fileName));83        }84        private static void WriteLogMessageAndAssertItInFile(string filePath)85        {...

NLogFileConsumer

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    }14}15using Atata;16using NUnit.Framework;17{18    {19        public void SetUp()20        {21                Build();22        }23        public void TearDown()24        {25            AtataContext.Current?.CleanUp();26        }27    }28}29using Atata;30using NUnit.Framework;31{32    {33        public void SetUp()34        {35                Build();36        }37        public void TearDown()38        {39            AtataContext.Current?.CleanUp();40        }41    }42}43using Atata;44using NUnit.Framework;45{46    {47        public void SetUp()48        {

NLogFileConsumer

Using AI Code Generation

1using Atata;2using NUnit.Framework;3{4    {5        public void Setup()6        {7            AtataContext.Configure()8                .UseChrome()9                .UseNLog()10                .UseNLogFile("NLog.txt")11                .AddNLogFileLoggingConsumer()12                .Build();13        }14        public void Test1()15        {16            AtataContext.Configure().UseNLog().UseNLogFile("NLog.txt").AddNLogFileLoggingConsumer().Build();17            Go.To<GooglePage>();18        }19    }20}21using Atata;22using NUnit.Framework;23{24    {25        public void Setup()26        {27            AtataContext.Configure()28                .UseChrome()29                .UseNLog()30                .UseNLogConsole()31                .AddNLogConsoleLoggingConsumer()32                .Build();33        }34        public void Test1()35        {36            AtataContext.Configure().UseNLog().UseNLogConsole().AddNLogConsoleLoggingConsumer().Build();37            Go.To<GooglePage>();38        }39    }40}41using Atata;42using NUnit.Framework;43{44    {45        public void Setup()46        {47            AtataContext.Configure()48                .UseChrome()49                .UseNLog()50                .UseNLogTrace()51                .AddNLogTraceLoggingConsumer()52                .Build();53        }54        public void Test1()55        {56            AtataContext.Configure().UseNLog().UseNLogTrace().AddNLogTraceLoggingConsumer().Build();57            Go.To<GooglePage>();58        }59    }60}61using Atata;62using NUnit.Framework;63{64    {65        public void Setup()66        {67            AtataContext.Configure()68                .UseChrome()

NLogFileConsumer

Using AI Code Generation

1using NLog;2using NLog.Config;3using NLog.Targets;4using System;5using System.Collections.Generic;6using System.Linq;7using System.Text;8using System.Threading.Tasks;9{10    {11        static void Main(string[] args)12        {13            var config = new LoggingConfiguration();14            var target = new FileTarget();15            config.AddTarget("file", target);16            target.FileName = "${basedir}/log.txt";17            target.Layout = "${longdate} ${level} ${message} ${exception:format=tostring}";18            config.AddRuleForAllLevels(target);19            LogManager.Configuration = config;20            var logger = LogManager.GetLogger("NLog");21            logger.Info("NLog info message");22            logger.Error("NLog error message");23            logger.Fatal("NLog fatal message");24            AtataContext.Configure()25                .UseNLog()26                .UseChrome()27                .UseCulture("en-US")28                .AddNLogFileTarget()29                .Build();30            using (AtataContext.Configure().LogNUnitError())31            {32                Go.To<GooglePage>()33                    .SearchFor("Atata")34                    .Results.Should.HaveCountGreaterOrEqual(1);35            }36        }37    }38}

NLogFileConsumer

Using AI Code Generation

1using Atata;2using NUnit.Framework;3{4    {5        public void OneTimeSetUp()6        {7                Build();8        }9        public void OneTimeTearDown()10        {11            AtataContext.Current?.CleanUp();12        }13    }14}15using Atata;16using NUnit.Framework;17{18    {19        public void OneTimeSetUp()20        {21                Build();22        }23        public void OneTimeTearDown()24        {25            AtataContext.Current?.CleanUp();26        }27    }28}29using Atata;30using NUnit.Framework;31{32    {33        public void OneTimeSetUp()34        {35                Build();36        }37        public void OneTimeTearDown()38        {39            AtataContext.Current?.CleanUp();40        }41    }42}43using Atata;44using NUnit.Framework;45{46    {47        public void OneTimeSetUp()48        {

NLogFileConsumer

Using AI Code Generation

1using Atata;2using NUnit.Framework;3using System;4{5    {6        public void SetUp()7        {8            AtataContext.Configure()9                .UseChrome()10                .UseCulture("en-US")11                .UseAllNUnitFeatures()12                .UseNLog()13                .LogNUnitError()14                .LogNUnitWarning()15                .LogNUnitInfo()16                .LogNUnitDebug()17                .LogNUnitTrace()18                .AddNLogFileConsumer()19                .Build();20            AtataContext.Current.AutoSetUpDriverToUse();21        }22        public void TearDown()23        {24            AtataContext.Current?.CleanUp();25        }26    }27}28using Atata;29using NUnit.Framework;30using System;31{32    {33        public void SetUp()34        {35            AtataContext.Configure()36                .UseChrome()37                .UseCulture("en-US")38                .UseAllNUnitFeatures()39                .UseNLog()40                .LogNUnitError()41                .LogNUnitWarning()42                .LogNUnitInfo()43                .LogNUnitDebug()44                .LogNUnitTrace()45                .AddNLogTraceLogConsumer()46                .Build();47            AtataContext.Current.AutoSetUpDriverToUse();48        }49        public void TearDown()50        {51            AtataContext.Current?.CleanUp();52        }53    }54}55using Atata;56using NUnit.Framework;57using System;58{59    {60        public void SetUp()61        {62            AtataContext.Configure()63                .UseChrome()64                .UseCulture("en-US")65                .UseAllNUnitFeatures()66                .UseNLog()67                .LogNUnitError()68                .LogNUnitWarning()

NLogFileConsumer

Using AI Code Generation

1using Atata;2using Atata.Logging.NLog;3using NUnit.Framework;4using System;5{6    {7        public void SetUp()8        {9            AtataContext.Configure()10                .UseChrome()11                .UseCulture("en-US")12                .UseAllNUnitFeatures()13                .AddNLogFileLogging("log.txt")14                .Build();15        }16        public void TearDown()17        {18            AtataContext.Current?.CleanUp();19        }20    }21}22using Atata;23using Atata.Logging.NLog;24using NUnit.Framework;25using System;26{27    {28        public void SetUp()29        {30            AtataContext.Configure()31                .UseChrome()32                .UseCulture("en-US")33                .UseAllNUnitFeatures()34                .AddNLogConsoleLogging()35                .Build();36        }37        public void TearDown()38        {39            AtataContext.Current?.CleanUp();40        }41    }42}43using Atata;44using Atata.Logging.NLog;45using NUnit.Framework;46using System;47{48    {49        public void SetUp()50        {51            AtataContext.Configure()52                .UseChrome()53                .UseCulture("en-US")54                .UseAllNUnitFeatures()55                .AddNLogTraceLogging()56                .Build();57        }58        public void TearDown()59        {60            AtataContext.Current?.CleanUp();61        }62    }63}64using Atata;65using Atata.Logging.NLog;66using NUnit.Framework;67using System;68{

NLogFileConsumer

Using AI Code Generation

1using System;2using Atata;3using NUnit.Framework;4{5    {6        public void SetUp()7        {8                Build();9        }10        public void Test1()11        {12                LogOut.ClickAndGo();13        }14        public void TearDown()15        {16            AtataContext.Current?.CleanUp();17        }18    }19}20using System;21using Atata;22using NUnit.Framework;23{24    {25        public void SetUp()26        {27                Build();28        }29        public void Test1()30        {31                LogOut.ClickAndGo();32        }33        public void TearDown()34        {35            AtataContext.Current?.CleanUp();36        }37    }38}39using System;40using Atata;41using NUnit.Framework;42{43    {44        public void SetUp()45        {46                Build();47        }48        public void Test1()49        {50                LogOut.ClickAndGo();51        }52        public void TearDown()53        {54            AtataContext.Current?.CleanUp();55        }56    }57}58using System;59using Atata;60using NUnit.Framework;61{62    {63        public void SetUp()64        {

NLogFileConsumer

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        public void SetUp()11        {12            AtataContext.Configure()13                .UseChrome()14                .UseNLog()15                .UseCulture("en-US")16                .AddNLogFileConsumer("bin/2.log")17                .Build();18        }19        public void NLogTest()20        {21            Go.To<GoogleSearchPage>()22                .SearchFor("Atata");23        }24        public void TearDown()25        {26            AtataContext.Current.CleanUp();27        }28    }29}30using Atata;31using NUnit.Framework;32using System;33using System.Collections.Generic;34using System.Linq;35using System.Text;36using System.Threading.Tasks;37{38    {39        public void SetUp()40        {41            AtataContext.Configure()42                .UseChrome()43                .UseNLog()44                .UseCulture("en-US")45                .AddNLogConsoleConsumer()46                .Build();47        }48        public void NLogTest()49        {50            Go.To<GoogleSearchPage>()51                .SearchFor("Atata");52        }53        public void TearDown()54        {55            AtataContext.Current.CleanUp();56        }57    }58}

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.