${AssemblyVersion}: add type (File, Assembly, Informational) option

[alexangas]

Fixes #2480.

Requires documentation updates at https://github.com/nlog/nlog/wiki/AssemblyVersion-Layout-Renderer and https://github.com/NLog/NLog/wiki/Platform-Support (see code for details).

[304NotModified]

The build server says:

'AssemblyVersionLayoutRenderer.GetVersion()': not all code paths return a value [C:\projects\nlog\src\NLog\NLog.csproj]

Could you please check that?
See https://github.com/NLog/NLog/pull/2487/files#r159549927

[304NotModified]

missing return ;)

[304NotModified]

nice, looks good!

[304NotModified]

nice!

[304NotModified]

Unfortunately, it fails on Travis

.> NLog.UnitTests.LayoutRenderers.AssemblyVersionTests.AssemblyVersionTypeTest(type: Assembly, expected: "1.1.1.1") [FAIL]
System.InvalidOperationException : Unable to find field m_entryAssembly

Any idea why? See https://travis-ci.org/NLog/NLog/builds/324836802

[codecov]

Codecov Report

Merging #2487 into master will decrease coverage by 1%.
The diff coverage is 70%.

@@           Coverage Diff           @@
##           master   #2487    +/-   ##
=======================================
- Coverage      82%     82%    -1%     
=======================================
  Files         322     322            
  Lines       24215   23219   -996     
  Branches     3225    2888   -337     
=======================================
- Hits        19912   18939   -973     
+ Misses       3542    3511    -31     
- Partials      761     769     +8

[alexangas]

The issue appears to be the way that xunit handles app domains, described in microsoft/vstest#649. This means that calls to Assembly.GetEntryAssembly() may return null (as can happen in existing EntryAssemblyVersionTest) or attempts to force set it may fail (as can happen in new AssemblyVersionTypeTest).

There may be a way to get around this by changing the xunit config value xunit.appDomain, but it looks like this may affect all tests and cause adverse effects.

So in these most recent pushes I have taken the same approach as the existing EntryAssemblyVersionTest when this wasn't working where it effectively skips the test if there are problems. It also attempts to log that.

[304NotModified]

So in these most recent pushes I have taken the same approach as the existing EntryAssemblyVersionTest when this wasn't working where it effectively skips the test if there are problems. It also attempts to log that

seems to work great!

Thanks, looks good!

Could you please update the wiki and add "Introduced in NLog 4.5"? Thanks in advance!

[alexangas]

Really appreciate all your help. I've updated https://github.com/nlog/nlog/wiki/AssemblyVersion-Layout-Renderer and https://github.com/NLog/NLog/wiki/Platform-Support.

[304NotModified]

thanks! also for adding examples! 👍 👍