-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
${AssemblyVersion}: add type (File, Assembly, Informational) option #2487
Merged
304NotModified
merged 16 commits into
NLog:master
from
alexangas:feature/assembly-renderer-add-version-types
Jan 4, 2018
Merged
Changes from 12 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
5b22751
Added AssemblyVersionType enum
alexangas 4c6551b
Split out assembly version methods by conditional compilation
alexangas 503f4b9
Implementing more version types
alexangas 838fce5
Bug fixes
alexangas 5ca1afa
Added more #ifs
alexangas 6eb2a05
Fixed erroneous reference
alexangas 0f59728
Finished with version targeting
alexangas 49a0965
Retrieving assembly version from correct place. Tests for different v…
alexangas ae7b9d5
Clean ups
alexangas 6e2528f
Clean ups
alexangas e253b9b
Another clean up
alexangas 546b213
Added null checks
alexangas cd6b78c
adding return
304NotModified 8480297
Extended version type support to UWP >= .NET Standard 1.5. Better han…
alexangas 9384e44
Correct unit test check for error message
alexangas 29f7e6e
Typo
alexangas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
// | ||
// Copyright (c) 2004-2017 Jaroslaw Kowalski <jaak@jkowalski.net>, Kim Christensen, Julian Verdurmen | ||
// | ||
// All rights reserved. | ||
// | ||
// Redistribution and use in source and binary forms, with or without | ||
// modification, are permitted provided that the following conditions | ||
// are met: | ||
// | ||
// * Redistributions of source code must retain the above copyright notice, | ||
// this list of conditions and the following disclaimer. | ||
// | ||
// * Redistributions in binary form must reproduce the above copyright notice, | ||
// this list of conditions and the following disclaimer in the documentation | ||
// and/or other materials provided with the distribution. | ||
// | ||
// * Neither the name of Jaroslaw Kowalski nor the names of its | ||
// contributors may be used to endorse or promote products derived from this | ||
// software without specific prior written permission. | ||
// | ||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | ||
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF | ||
// THE POSSIBILITY OF SUCH DAMAGE. | ||
// | ||
|
||
namespace NLog.LayoutRenderers | ||
{ | ||
/// <summary> | ||
/// Type of assembly version to retrieve. | ||
/// </summary> | ||
public enum AssemblyVersionType | ||
{ | ||
/// <summary> | ||
/// Gets the assembly version. | ||
/// </summary> | ||
Assembly, | ||
|
||
/// <summary> | ||
/// Gets the file version. | ||
/// </summary> | ||
File, | ||
|
||
/// <summary> | ||
/// Gets additional version information. | ||
/// </summary> | ||
Informational | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -31,10 +31,11 @@ | |
// THE POSSIBILITY OF SUCH DAMAGE. | ||
// | ||
|
||
using System.Reflection; | ||
|
||
namespace NLog.UnitTests.LayoutRenderers | ||
{ | ||
using System; | ||
using System.Reflection; | ||
using NLog.LayoutRenderers; | ||
using Xunit; | ||
|
||
public class AssemblyVersionTests : NLogTestBase | ||
|
@@ -52,5 +53,93 @@ public void AssemblyNameVersionTest() | |
{ | ||
AssertLayoutRendererOutput("${assembly-version:NLogAutoLoadExtension}", "2.0.0.0"); | ||
} | ||
|
||
[Fact] | ||
public void AssemblyNameVersionTypeTest() | ||
{ | ||
AssertLayoutRendererOutput("${assembly-version:name=NLogAutoLoadExtension:type=assembly}", "2.0.0.0"); | ||
AssertLayoutRendererOutput("${assembly-version:name=NLogAutoLoadExtension:type=file}", "2.0.0.0"); | ||
AssertLayoutRendererOutput("${assembly-version:name=NLogAutoLoadExtension:type=informational}", "1.0.0"); | ||
} | ||
|
||
#if !NETSTANDARD | ||
private const string AssemblyVersionTest = "1.1.1.1"; | ||
private const string AssemblyFileVersionTest = "1.1.1.2"; | ||
private const string AssemblyInformationalVersionTest = "Version 1"; | ||
|
||
[Theory] | ||
[InlineData(AssemblyVersionType.Assembly, AssemblyVersionTest)] | ||
[InlineData(AssemblyVersionType.File, AssemblyFileVersionTest)] | ||
[InlineData(AssemblyVersionType.Informational, AssemblyInformationalVersionTest)] | ||
public void AssemblyVersionTypeTest(AssemblyVersionType type, string expected) | ||
{ | ||
LogManager.Configuration = CreateConfigurationFromString(@" | ||
<nlog> | ||
<targets><target name='debug' type='Debug' layout='${assembly-version:type=" + type.ToString().ToLower() + @"}' /></targets> | ||
<rules><logger name='*' minlevel='Debug' writeTo='debug' /></rules> | ||
</nlog>"); | ||
var logger = LogManager.GetLogger("SomeLogger"); | ||
var compiledAssembly = GenerateTestAssembly(); | ||
var testLoggerType = compiledAssembly.GetType("LogTester.LoggerTest"); | ||
var logMethod = testLoggerType.GetMethod("TestLog"); | ||
var testLoggerInstance = Activator.CreateInstance(testLoggerType); | ||
logMethod.Invoke(testLoggerInstance, new object[] { logger, compiledAssembly }); | ||
AssertDebugLastMessage("debug", expected); | ||
} | ||
|
||
private static Assembly GenerateTestAssembly() | ||
{ | ||
const string code = @" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nice! |
||
using System; | ||
using System.Reflection; | ||
|
||
[assembly: AssemblyVersion(""" + AssemblyVersionTest + @""")] | ||
[assembly: AssemblyFileVersion(""" + AssemblyFileVersionTest + @""")] | ||
[assembly: AssemblyInformationalVersion(""" + AssemblyInformationalVersionTest + @""")] | ||
|
||
namespace LogTester | ||
{ | ||
public class LoggerTest | ||
{ | ||
public void TestLog(NLog.Logger logger, Assembly assembly) | ||
{ | ||
if (System.Reflection.Assembly.GetEntryAssembly() == null) | ||
SetEntryAssembly(assembly); // Required in some unit testing scenarios, see https://github.com/Microsoft/vstest/issues/649 | ||
logger.Debug(""msg""); | ||
} | ||
|
||
private static void SetEntryAssembly(Assembly assembly) | ||
{ | ||
var manager = new AppDomainManager(); | ||
|
||
var domain = AppDomain.CurrentDomain; | ||
if (domain == null) | ||
throw new InvalidOperationException(""Current app domain is null""); | ||
|
||
var entryAssemblyField = manager.GetType().GetField(""m_entryAssembly"", BindingFlags.Instance | BindingFlags.NonPublic); | ||
if (entryAssemblyField == null) | ||
throw new InvalidOperationException(""Unable to find field m_entryAssembly""); | ||
entryAssemblyField.SetValue(manager, assembly); | ||
|
||
var domainManagerField = domain.GetType().GetField(""_domainManager"", BindingFlags.Instance | BindingFlags.NonPublic); | ||
if (domainManagerField == null) | ||
throw new InvalidOperationException(""Unable to find field _domainManager""); | ||
domainManagerField.SetValue(domain, manager); | ||
} | ||
} | ||
}"; | ||
|
||
var provider = new Microsoft.CSharp.CSharpCodeProvider(); | ||
var parameters = new System.CodeDom.Compiler.CompilerParameters | ||
{ | ||
GenerateInMemory = true, | ||
GenerateExecutable = false, | ||
ReferencedAssemblies = {"NLog.dll"} | ||
}; | ||
System.CodeDom.Compiler.CompilerResults results = provider.CompileAssemblyFromSource(parameters, code); | ||
var compiledAssembly = results.CompiledAssembly; | ||
return compiledAssembly; | ||
} | ||
#endif | ||
} | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing
return
;)