Injection of zip-compressor for fileTarget #1423

AndreGleichner · 2016-05-02T15:35:42Z

See also Issue #1420.
I need to get archive files zipped on .Net4.0 and thus have added a IFileCompressor interface to LogManager, so that NLog users may call NLog.LogManager.SetFileCompressor() to inject there own preferred file compressor like DotNetZip.

Update from org

…ssor to other platforms

304NotModified · 2016-05-02T16:59:47Z

Sounds good! Will check this in depth this week

304NotModified · 2016-05-02T17:00:58Z

Please add the file headers to the new files so appveyor won't complain

304NotModified · 2016-05-02T17:46:45Z

src/NLog/Common/DefaultFileCompressor.cs

+    /// <summary>
+    /// Uses .Net4.5 ZipArchive
+    /// </summary>
+    public class DefaultFileCompressor : IFileCompressor


good approach

I think is better to only include this class in .Net 45. The bool return is then not needed.

Please use the <see tag for ZipArchive

change it to internal? (easier to maintain)

304NotModified · 2016-05-02T17:53:02Z

reviewed already :)

It's in a good direction, and the following changes makes in perfect IMO:

The IFileCompressor is always used (all platforms)
The Compressor property is of the FileTarget (see code notes) (instead of LogManager)
The Compressor property is null for non-.Net45 platforms.
Some small changes, see code notes.

304NotModified · 2016-05-02T17:56:31Z

src/NLog/LogManager.cs

+        /// 
+        /// </summary>
+        /// <returns></returns>
+        public static IFileCompressor GetFileCompressor()


change to property instead of 2 methods

…ressor to ZipArchiveFileCompressor to better fit in FileTarget which now has a static property DefaultCompressor as well as instance property Compressor. ZipArchiveFileCompressor now only is included by the netfx45 project.

AndreGleichner · 2016-05-02T21:22:11Z

Great to see you already had a chance to check my proposed code. Initially my intention was that IFileCompressor could be used FileTarget independently. After moving all stuff to FileTarget according to your comments, it now seems to be a pretty straightforward to use interface. To be honest i til now only hacked this stuff together w/o any actual test and now have my doubts that i actually can set that FileTarget.DefaultCompressor static property early enough, before NLog actually creates the FileTarget instances. So i guess DefaultCompressor setter would need looping over all FileTarget instances.

304NotModified · 2016-05-02T21:25:07Z

have my doubts that i actually can set that FileTarget.DefaultCompressor static property early enough, before NLog actually creates the FileTarget instances.

It's only important to set it before writing any logevent?

AndreGleichner · 2016-05-02T21:38:57Z

Ok, i guess i just have to set DefaultCompressor before doing any actual logging...i'm a bit unsure how the NLog bootstrap is done.
Could you point me to the right direction of how to fix that AppVeyor thing?

304NotModified · 2016-05-02T22:13:24Z

Could you point me to the right direction of how to fix that AppVeyor thing?

Sure, see line 164, 171 etc: https://ci.appveyor.com/project/nlog/nlog/build/4.0.2397. Let me know if it's unclear (and ignore the typo ;))

…ng ZipArchiveFileCompressor.cs in all project, thus again added NET4_5 checks.

304NotModified · 2016-05-03T20:27:26Z

src/NLog/Targets/FileTarget.cs

+        /// Per instance file compressor to be used to compress log files during archiving.
+        /// Defaults to <see cref="DefaultCompressor"/>.
+        /// </summary>
+        public IFileCompressor Compressor { get; set; }


proposal: rename to FileCompressor

That would have been my personal preference, but you proposed "Compressor" as the property name above ;)

304NotModified · 2016-05-03T20:30:28Z

\0/ it builds.

Some last things about naming and I was a bit confused with two properties, see notes.

AndreGleichner · 2016-05-04T15:10:20Z

I'll remove the per FileTarget Instance Compressor property. Just leaving the static property which I'll rename to FileCompressor. And I'll rename IFileCompressor.Compress() to IFileCompressor.CompressFile().

… the static property which was renamed to FileCompressor. Renamed IFileCompressor.Compress() to IFileCompressor.CompressFile().

304NotModified · 2016-05-04T16:45:06Z

Cool! Think we needs some unit tests and then we are ready to go

AndreGleichner · 2016-05-04T19:16:08Z

I'll see if I can invent some unit tests soon.
It just came to my mind to also support non-zip archive formats like 7z...how about extending IFileCompressor by an ArchiveExtension readonly property to return e.g. ".zip", ".7z", etc?
There're just a few places where zip is hardcoded.

304NotModified · 2016-05-04T19:36:44Z

Good idea about supporting .7z etc. But I think already fits in the current interface? AFAIK the .zip is only used as fallback, so a user could inject how FileCompressor and configure something like "archive.7z"

AndreGleichner · 2016-05-04T19:51:48Z

Right, in FileTarget its just a fallback. Its actually just the unit tests hardcoding .zip or .txt as archive extension. But that can stay as is...so you're right no need to have such ArchiveExtension property.

PeterHric · 2016-05-09T08:21:32Z

Hi all,
I appreciate this effort. I'd ike to ask if and where is the new .dll available with this patch.
If there was a simple example how to inject FileCompressor and what Interface it must comply to, that would be even fantastisk !
Thank you again for support...

304NotModified · 2016-05-09T08:34:00Z

We needs some unit tests, and then it's ready for merge. After merge I expect the release within a few days.

I you could help us with unit tests, then I can merge (and release) it earlier.

PeterHric · 2016-05-09T09:49:07Z

OK great, How do I help you ? :)

304NotModified · 2016-05-09T11:02:10Z

checkout this PR locally
create a new branch locally from 1.
add unit tests
Create PR to "AndreGleichner:master"

AndreGleichner · 2016-05-09T11:36:36Z

I'd do such UnitTests...just a bit bussy...my main problem just doing a simple UnitTest, ist that I wasn't easily able figuring out whether xUnit is running tests in parallel. If it would I can't just set FileTarget.FileCompressor to another IFileCompressor implementation based on e.g. DotNetZip, because that may crash the other tests also doing file with zip archiving.
That was one of the reasons why my original approach had a per instance compressor property.

304NotModified · 2016-05-09T13:04:12Z

my main problem just doing a simple UnitTest, ist that I wasn't easily able figuring out whether xUnit is running tests in parallel.

I can answer that :) We are not running tests in parallel, so you can set the static and revert with a finally block. We prefer stable tests above test run time, so we will never turn on parallel testing (and we disable it in xUnit2)

I'd do such UnitTests...just a bit bussy

Thanks!

…tforms w/o zip

codecov-io · 2016-05-10T17:46:25Z

Current coverage is 75.41%

Merging #1423 into master will decrease coverage by -4.40%

2 files in src/NLog/Config were modified. more
- Misses +5
- Partials +31
- Hits -36
2 files in src/NLog were modified. more
- Misses +12
- Partials +45
- Hits -57
5 files (not in diff) in ...Log/Targets/Wrappers were modified. more
- Misses +2
- Partials +8
- Hits -10
20 files (not in diff) in src/NLog/Targets were modified. more
- Misses +43
- Partials +81
- Hits -124
4 files (not in diff) in ...g/LogReceiverService were modified. more
- Misses +4
- Partials +5
- Hits -9
5 files (not in diff) in src/NLog/Layouts were modified. more
- Misses +6
- Partials +13
- Hits -19
8 files (not in diff) in ...utRenderers/Wrappers were modified. more
- Misses +1
- Partials +11
- Hits -12
26 files (not in diff) in ...NLog/LayoutRenderers were modified. more
- Misses +50
- Partials +45
- Hits -95
5 files (not in diff) in ...ernal/NetworkSenders were modified. more
- Misses +6
- Partials +16
- Hits -22
5 files (not in diff) in ...ternal/FileAppenders were modified. more
- Misses +9
- Partials +19
- Hits -28

@@             master      #1423   diff @@
==========================================
  Files           267        269     +2   
  Lines         15990      16066    +76   
  Methods           0          0          
  Messages          0          0          
  Branches       1724       1738    +14   
==========================================
- Hits          12762      12116   -646   
- Misses         3228       3528   +300   
- Partials          0        422   +422

Powered by Codecov. Last updated by e052b10...a7178a6

304NotModified · 2016-05-10T18:38:34Z

Codecov is lost again...

304NotModified · 2016-05-10T18:46:08Z

@AndreGleichner is dotnetzip a good library? Then maybe we can release it as separate package. We can then remove it from here and replace it with a mock.

AndreGleichner · 2016-05-10T19:28:13Z

IMO DotNetZip is one of the best pure managed zip libs. The only comparable lib is SharpZipLib. But the latter is GPL thus at work we've used DotNetZip since couple years w/o issues and its licence fits our needs.
Concerning codecov...I'll try to figure out how to increase it....

AndreGleichner · 2016-05-10T19:32:12Z

DotNetZip is only refed by the unit tests...didn't know adding new dependencies there could harm.
To perfom the actual unit test of changed code, it would be enough to inject the ZipArchiveFileCompressor as custom FileCompressor, the mechanics would be the same as with using a real custom implementation.

304NotModified · 2016-05-10T20:26:40Z

The external lib is no problem in the unit tests :)

But I think it's nice to release the implementation as separate package and then we have twice the same code and tests ;)

Codecov is buggy. The -4% is wrong. More unit tests are nice, but right now it's unclear to me what isn't covered.

AndreGleichner · 2016-05-10T20:39:15Z

Anything else i could do to get this pr merged?

304NotModified · 2016-05-10T22:41:28Z

Forced a rebuild. I added an unstable test a few days ago. Not sure what's wrong.

304NotModified · 2016-05-11T17:16:09Z

merged :)

AndreGleichner · 2016-05-11T17:24:04Z

Yeah :)

304NotModified · 2016-05-11T17:46:02Z

@AndreGleichner

PS what is the difference between DotNetZip and DotNetZip.Reduced?

AndreGleichner · 2016-05-11T20:54:06Z

Reduced just means it is w/o self extracting archive support.
Am 11.05.2016 7:46 nachm. schrieb "Julian Verdurmen" <
notifications@github.com>:

@AndreGleichner https://github.com/AndreGleichner

PS hat the difference between DotNetZip and DotNetZip.Reduced

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#1423 (comment)

304NotModified · 2016-05-16T21:38:19Z

This has been released with NLog 4.3.4 :)

AndreGleichner added 3 commits May 2, 2016 15:15

Merge pull request #1 from NLog/master

f42e446

Update from org

Introduced IFileCompressor to allow for .Net4.0 file compression

7372fc4

Made DefaultFileCompressor compile for .Net 4.5 and added IFileCompre…

babaf73

…ssor to other platforms

304NotModified reviewed May 2, 2016
View reviewed changes

304NotModified added the feature label May 2, 2016

304NotModified changed the title ~~Allow zip file archives for platforms other than .Net4.5~~ Injection of zip-compressor for fileTarget May 2, 2016

304NotModified mentioned this pull request May 2, 2016

Zip archives with .NET 3.5 #1420

Closed

304NotModified reviewed May 2, 2016
View reviewed changes

304NotModified added the file-target label May 2, 2016

AndreGleichner added 2 commits May 2, 2016 23:00

Made ZipArchiveFileCompressor internal

1bfaeba

AndreGleichner added 2 commits May 3, 2016 11:35

Performed a msbuild NLog.proj /t:SyncProjectItems. In insists on havi…

f069931

…ng ZipArchiveFileCompressor.cs in all project, thus again added NET4_5 checks.

Added license header to new files

4d17c9c

304NotModified reviewed May 3, 2016
View reviewed changes

Removed the per FileTarget instance Compressor property. Just leaving…

1daf258

… the static property which was renamed to FileCompressor. Renamed IFileCompressor.Compress() to IFileCompressor.CompressFile().

AndreGleichner added 3 commits May 9, 2016 23:45

Added unit tests for FileTarget.FileCompressor for .Net3.5, 4.0, 4.5

c6a7a48

Fixed failed builds other than .Net3.5/4.0/4.5

0769236

Do not restore null FileCompressor

144abdf

304NotModified added this to the 4.3.4 milestone May 10, 2016

For easier code always provide a dummy AssertZipFileContents() on pla…

41a1f38

…tforms w/o zip

upstream sync

3dc9948

304NotModified merged commit 4605707 into NLog:master May 11, 2016

Injection of zip-compressor for fileTarget #1423

Injection of zip-compressor for fileTarget #1423

Conversation

AndreGleichner commented May 2, 2016

304NotModified commented May 2, 2016

304NotModified commented May 2, 2016

304NotModified May 2, 2016 • edited

Choose a reason for hiding this comment

304NotModified commented May 2, 2016

304NotModified May 2, 2016

Choose a reason for hiding this comment

AndreGleichner commented May 2, 2016

304NotModified commented May 2, 2016

AndreGleichner commented May 2, 2016

304NotModified commented May 2, 2016 • edited

304NotModified May 3, 2016

Choose a reason for hiding this comment

AndreGleichner May 4, 2016

Choose a reason for hiding this comment

304NotModified commented May 3, 2016

AndreGleichner commented May 4, 2016

304NotModified commented May 4, 2016

AndreGleichner commented May 4, 2016

304NotModified commented May 4, 2016

AndreGleichner commented May 4, 2016

PeterHric commented May 9, 2016 • edited

304NotModified commented May 9, 2016

PeterHric commented May 9, 2016

304NotModified commented May 9, 2016

AndreGleichner commented May 9, 2016

304NotModified commented May 9, 2016

codecov-io commented May 10, 2016

Current coverage is 75.41%

304NotModified commented May 10, 2016 • edited

304NotModified commented May 10, 2016

AndreGleichner commented May 10, 2016

AndreGleichner commented May 10, 2016

304NotModified commented May 10, 2016

AndreGleichner commented May 10, 2016

304NotModified commented May 10, 2016

304NotModified commented May 11, 2016

AndreGleichner commented May 11, 2016

304NotModified commented May 11, 2016 • edited

AndreGleichner commented May 11, 2016

304NotModified commented May 16, 2016

304NotModified May 2, 2016 •

edited

304NotModified commented May 2, 2016 •

edited

PeterHric commented May 9, 2016 •

edited

304NotModified commented May 10, 2016 •

edited

304NotModified commented May 11, 2016 •

edited