RegistryLayoutRenderer: Support for layouts, RegistryView (32, 64 bit) and all root key names (HKCU/HKLM etc) #925

Niklas-Peter · 2015-09-23T20:59:28Z

Layouts for Key, Value, DefaultValue
Added View
Root key names like "HKLM" are now allowed

Please check the code, especially your conventions for exception handling. ParseKey() and this.DefaultValue.Render() could throw an exception. I do not know, how you would like to handle it.

Obviously Microsoft.Win32 is a problem. Maybe you can add appropriate pre compiler conditions to only activate it on supporting platforms.

304NotModified · 2015-09-25T08:16:25Z

What do you mean with

Obviously Microsoft.Win32 is a problem

I'm on mobile now, so I cannot easily see the code. But did you excluded the code for Silverlight? (see appveyor error)

Niklas-Peter · 2015-09-28T20:12:01Z

Silverlight has already been excluded in the old version and still is. So it should not be the problem. However the enum RegistryView is not supported in .NET 3.5, so I think, that it is the problem.
Furthermore I had accidentally removed using NLog.Internal, so that the extension metod for Exception was missing. I fixed it.

However some unit tests fail, but I am not quite sure, whether the unit tests themselves are correct. Why do you use @ and additionally escape with \\ (see RegistryNamedValueTest and RegistryUnnamedValueTest)? Why do you expect, that defaultValue=C\\:temp results in C:temp (see RegistyDefaultValueTest_with_colon)?

304NotModified · 2015-09-28T20:41:11Z

Why do you expect, that defaultValue=C:temp results in C:temp

We need to escape the : (because separator) and also we need to escape the \ (because of control characters like \n) in C#, so \\:. This one is correct.

Why do you use @ and additionally escape with \

~~I think because Layout is interpreted as string and not an verbatim string. Not sure if this make sense..~~

Just checked the code. The \ seems interpreted by the parser, because also we like to support \n in the xml Config (and so \ needs to be escaped to \\

304NotModified · 2015-09-28T20:48:53Z

src/NLog/LayoutRenderers/RegistryLayoutRenderer.cs


-                    this.subKey = this.key.Substring(pos + 1).Replace('/', '\\');


I think this removal makes it non-backwards-compatible

This one needs comments.

We can make it also conditional with an property (default of course backwardscomp)

Why? I just moved it to ParseKey().

Niklas-Peter · 2015-09-29T18:47:07Z

The reason, why the 3 tests fail, is, that I changed "string" to Layout for Key, Value and DefaultValue. Obviously \\ is treated different, when it is a Layout. I do not know enough about the inner workings of NLog, so I can not fix it. Either you know what to do or we have to change it back to a string, but actually the layouts were the main reason for creating this pull request.

304NotModified · 2015-09-29T19:12:21Z

We can fix it :)

But not now. On holiday with limited Internet / pc. I will look at it this weekend.

304NotModified · 2015-10-04T13:35:21Z

I'm looking at this now :)

304NotModified · 2015-10-04T14:05:57Z

Looked at this:

note: registryValue can be null in registryValue = registryKey.GetValue(renderedValue);
code for handling the Exception should be

       catch (Exception ex)
            {

                if (ex.MustBeRethrown())
                {
                    throw;
                }
               InternalLogger.Error(ex.ToString());
            }

I changed the parsekey for the slashes to:

            if (pos >= 0)
            {
                hiveName = key.Substring(0, pos);

                var subKey1 = key.Substring(pos + 1).Replace('/', '\\');

                //remove duplicates
                subKey1 = subKey1.Replace(@"\\", @"\");
                subKey1 = subKey1.TrimStart('\\');
                this.subKey = subKey1;
            }

RegistyDefaultValueTest_with_colon is still failing. I have to think how to fix this. This has to do with Text cut off when using When layout renderer combined with a colon #444 I guess...

304NotModified · 2015-10-04T14:07:03Z

I will add some tests to the RegistryTests in master, because i'm curious how key was working with forwardsslashes (and that we don't break it)

Niklas-Peter · 2015-10-04T14:11:20Z

note: registryValue can be null in registryValue = registryKey.GetValue(renderedValue);

From MS documentation:

Retrieves the value associated with the specified name. Returns null if the name/value pair does not exist in the registry.

I do not see the problem.

304NotModified · 2015-10-04T14:13:37Z

Retrieves the value associated with the specified name. Returns null if the name/value pair does not exist in the registry

It's a false positive of Resharper :) Can you add this a comment in the code?

Niklas-Peter · 2015-10-04T14:15:23Z

Actually I had already done so, see line 142.

304NotModified · 2015-10-04T14:18:23Z

I see the confusion. It about openSubKey. - my mistake. Posted the wrong code.

https://msdn.microsoft.com/en-us/library/z9f66s0a(v=vs.110).aspx

The subkey requested, or null if the operation failed.

So Reshaper was right :)

304NotModified · 2015-10-04T14:24:27Z

I added some more tests in #937.

if you like, you can merge them for locally testing:

Git commands:

git remote add upstream https://github.com/NLog/NLog.git
git fetch upstream
git checkout patch-1
git merge upstream/master

edit: well, merge is not necessary, only if you would like to debug locally at your site.

304NotModified · 2015-10-13T19:42:17Z

TODO:

fix possible nullref
merge with master
fix slash issue (@304NotModified) - Fix parse of inner layout #975

304NotModified · 2015-10-20T19:50:19Z

Hi @Niklas-Peter ,

The slash isssue has been resolved, see 118b8a5

The parse of the inner layout fixed is fixed in #975

Can you merge with master and fix the last issues?

Niklas-Peter · 2015-10-20T19:58:53Z

I will do that anytime, but currently I do not even have time to fix these small issues ...

304NotModified · 2015-10-20T20:08:42Z

No problem. Any idea when you have time?

The release of 4.2 is nearby, but we can postpone this feature to 4.3

304NotModified · 2015-11-08T00:48:45Z

If you like help this, just add me as a contributor and let me know. I like to have the feature implemented :)

304NotModified · 2015-11-08T00:50:15Z

We need unit test for this.

Niklas-Peter · 2015-11-08T07:05:01Z

I added you as a collaborator to Niklas-Peter/NLog. Is that, what you intended?

304NotModified · 2015-11-08T22:37:32Z

Yes, collaborator I meant :)

- Layouts for Key, Value, DefaultValue - Added View - Root key names like "HKLM" are now allowed Note: I can not find any use for an not set "Value". If Value is null, you would always get the DefaultValue. Maybe you should make it a required parameter? Please check the code, especially your conventions for exception handling. ParseKey() and this.DefaultValue.Render() could throw an exception. I do not know, how you would like to handle it.

304NotModified · 2016-01-24T14:22:14Z

Full change:

the following root keys are now allowed
- HKEY_LOCAL_MACHINE
- HKLM
- HKEY_CURRENT_USER
- HKCU
- HKEY_CLASSES_ROOT
- HKEY_USERS
- HKEY_CURRENT_CONFIG
- HKEY_DYN_DATA
- HKEY_PERFORMANCE_DATA
Key, Value, DefaultValue are now layoutable.
added option RequireEscapingSlashesInDefaultValue for backwardscompat. Default true. In the old situation C:\temp was OK, it should now be C:\\temp, if RequireEscapingSlashesInDefaultValue=false, because DefaultValue is now a Layout.
added option RegistryView. (not for .Net 3.5). Gets or sets the registry view (see: https://msdn.microsoft.com/de-de/library/microsoft.win32.registryview.aspx. Allowed values: Registry32, Registry64, Default

304NotModified · 2016-01-24T14:41:10Z

@bhaeussermann / @page-not-found / @UgurAldanmaz can someone review this one?

I like to include this in NLog 4.3

Thanks!

bhaeussermann · 2016-01-24T15:22:18Z

tests/NLog.UnitTests/LayoutRenderers/RegistryTests.cs

+            </nlog>");
+
+            LogManager.GetLogger("d").Debug("zzz");
+            AssertDebugLastMessage("debug", "reg32");


Can these tests not use AssertLayoutRendererOutput() like the other tests?

I see there are old tests which also use this approach; can be changed to use AssertLayoutRendererOutput()?

Good idea :)

I found a difference. AssertLayoutRendererOutput only renders the layout renderer, while these test cases really writes to the registry. So keep it like this

bhaeussermann · 2016-01-24T15:24:32Z

I checked the code. I cannot find any problems. Just two minor remarks on the tests.

304NotModified · 2016-01-24T18:32:00Z

Thanks @bhaeussermann!

304NotModified · 2016-01-25T19:33:23Z

Merge after successful builds

RegistryLayoutRenderer: Support for layouts, RegistryView (32, 64 bit) and all root key names (HKCU/HKLM etc)

304NotModified · 2016-04-04T22:24:00Z

docs: https://github.com/NLog/NLog/wiki/Registry-Layout-Renderer

304NotModified added feature XSD change labels Sep 26, 2015

304NotModified reviewed Sep 28, 2015
View reviewed changes

304NotModified mentioned this pull request Oct 4, 2015

Added more registry unit tests #937

Merged

304NotModified self-assigned this Oct 11, 2015

304NotModified added the work in progress label Oct 21, 2015

304NotModified added the needs unittests label Nov 8, 2015

Niklas-Peter added 2 commits November 8, 2015 23:38

just for testing: excluded .NET 3.5

ef4d331

304NotModified modified the milestones: 4.4, 4.3 Jan 22, 2016

304NotModified added 2 commits January 24, 2016 15:20

use ThrowExceptions

781fad7

Skip unit test as improved exception handling is deplayed

8fd37e5

revert removal of sourceodetest.exe

a81e1d5

304NotModified added has unittests and removed waiting on other issue labels Jan 24, 2016

Merge remote-tracking branch 'remotes/NLog/master' into patch-1

add18ba

304NotModified added the waiting for review label Jan 24, 2016

304NotModified removed their assignment Jan 24, 2016

304NotModified added the enhancement Improvement on existing feature label Jan 24, 2016

304NotModified changed the title ~~Support for layouts, RegistryView and root key names~~ RegistryLayoutRenderer: Support for layouts, RegistryView (32, 64 bit) and all root key names (HKCU/HKLM etc) Jan 24, 2016

revert changes in global layoutrenderer

4d2e5b3

bhaeussermann reviewed Jan 24, 2016
View reviewed changes

304NotModified self-assigned this Jan 24, 2016

304NotModified mentioned this pull request Jan 25, 2016

Consistent Exception handling v3 #1143

Merged

4 tasks

fix typos

30fc9b6

304NotModified removed the waiting for review label Jan 25, 2016

304NotModified added a commit that referenced this pull request Jan 25, 2016

Merge pull request #925 from Niklas-Peter/patch-1

db70244

RegistryLayoutRenderer: Support for layouts, RegistryView (32, 64 bit) and all root key names (HKCU/HKLM etc)

304NotModified merged commit db70244 into NLog:master Jan 25, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RegistryLayoutRenderer: Support for layouts, RegistryView (32, 64 bit) and all root key names (HKCU/HKLM etc) #925

RegistryLayoutRenderer: Support for layouts, RegistryView (32, 64 bit) and all root key names (HKCU/HKLM etc) #925

Niklas-Peter commented Sep 23, 2015

304NotModified commented Sep 25, 2015

Niklas-Peter commented Sep 28, 2015

304NotModified commented Sep 28, 2015

304NotModified Sep 28, 2015

Niklas-Peter Sep 29, 2015

Niklas-Peter commented Sep 29, 2015

304NotModified commented Sep 29, 2015

304NotModified commented Oct 4, 2015

304NotModified commented Oct 4, 2015

304NotModified commented Oct 4, 2015

Niklas-Peter commented Oct 4, 2015

304NotModified commented Oct 4, 2015

Niklas-Peter commented Oct 4, 2015

304NotModified commented Oct 4, 2015

304NotModified commented Oct 4, 2015

304NotModified commented Oct 13, 2015

304NotModified commented Oct 20, 2015

Niklas-Peter commented Oct 20, 2015

304NotModified commented Oct 20, 2015

304NotModified commented Nov 8, 2015

304NotModified commented Nov 8, 2015

Niklas-Peter commented Nov 8, 2015

304NotModified commented Nov 8, 2015

304NotModified commented Jan 24, 2016

304NotModified commented Jan 24, 2016

bhaeussermann Jan 24, 2016

bhaeussermann Jan 24, 2016

304NotModified Jan 25, 2016

304NotModified Jan 25, 2016

bhaeussermann commented Jan 24, 2016

304NotModified commented Jan 24, 2016

304NotModified commented Jan 25, 2016

304NotModified commented Apr 4, 2016


		this.subKey = this.key.Substring(pos + 1).Replace('/', '\\');

RegistryLayoutRenderer: Support for layouts, RegistryView (32, 64 bit) and all root key names (HKCU/HKLM etc) #925

RegistryLayoutRenderer: Support for layouts, RegistryView (32, 64 bit) and all root key names (HKCU/HKLM etc) #925

Conversation

Niklas-Peter commented Sep 23, 2015

304NotModified commented Sep 25, 2015

Niklas-Peter commented Sep 28, 2015

304NotModified commented Sep 28, 2015

304NotModified Sep 28, 2015

Choose a reason for hiding this comment

Niklas-Peter Sep 29, 2015

Choose a reason for hiding this comment

Niklas-Peter commented Sep 29, 2015

304NotModified commented Sep 29, 2015

304NotModified commented Oct 4, 2015

304NotModified commented Oct 4, 2015

304NotModified commented Oct 4, 2015

Niklas-Peter commented Oct 4, 2015

304NotModified commented Oct 4, 2015

Niklas-Peter commented Oct 4, 2015

304NotModified commented Oct 4, 2015

304NotModified commented Oct 4, 2015

304NotModified commented Oct 13, 2015

304NotModified commented Oct 20, 2015

Niklas-Peter commented Oct 20, 2015

304NotModified commented Oct 20, 2015

304NotModified commented Nov 8, 2015

304NotModified commented Nov 8, 2015

Niklas-Peter commented Nov 8, 2015

304NotModified commented Nov 8, 2015

304NotModified commented Jan 24, 2016

304NotModified commented Jan 24, 2016

bhaeussermann Jan 24, 2016

Choose a reason for hiding this comment

bhaeussermann Jan 24, 2016

Choose a reason for hiding this comment

304NotModified Jan 25, 2016

Choose a reason for hiding this comment

304NotModified Jan 25, 2016

Choose a reason for hiding this comment

bhaeussermann commented Jan 24, 2016

304NotModified commented Jan 24, 2016

304NotModified commented Jan 25, 2016

304NotModified commented Apr 4, 2016