Merge branch 'master' into feat/zis-updated-iter

Author: piksel

.github/workflows/build-test.yml

@@ -1,6 +1,11 @@
 name: Build and Test
 
 on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Tag Ref'
+        required: true
   pull_request:
     branches: [ master ]
   push:
@@ -9,24 +14,30 @@ on:
 
 jobs:
   Build:
-    runs-on: ${{ matrix.os }}-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu, windows, macos]
+        os: [ubuntu-latest, windows-2019, macos-latest]
         target: [netstandard2.0, netstandard2.1]
         include:
-          - os: windows
+          - os: windows-2019
             target: net45
     env:
       LIB_PROJ: src/ICSharpCode.SharpZipLib/ICSharpCode.SharpZipLib.csproj
     steps:
     - uses: actions/checkout@v2
-      
+      with:
+        ref: ${{ github.events.inputs.tag }}
+        fetch-depth: 0
+
     - name: Setup .NET Core
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: '3.1.x'
+        
+    - name: Show .NET info
+      run: dotnet --info
 
     - name: Build library (Debug)
       run: dotnet build -c debug -f ${{ matrix.target }} ${{ env.LIB_PROJ }}
@@ -39,47 +50,77 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu, windows, macos]
+        # Windows testing is combined with code coverage
+        os: [ubuntu, macos]
         target: [netcoreapp3.1]
-        include:
-          - os: windows
-            target: net46
     steps:
     - uses: actions/checkout@v2
-      
+      with:
+        fetch-depth: 0
+
     - name: Setup .NET Core
       if: matrix.target == 'netcoreapp3.1'
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: '3.1.x'
 
-    # NOTE: This is the temporary fix for https://github.com/actions/virtual-environments/issues/1090
-    - name: Cleanup before restore
-      if: ${{ matrix.os == 'windows' }}
-      run: dotnet clean ICSharpCode.SharpZipLib.sln && dotnet nuget locals all --clear
-
     - name: Restore test dependencies
       run: dotnet restore
 
     - name: Run tests (Debug)
       run: dotnet test -c debug -f ${{ matrix.target }} --no-restore
 
     - name: Run tests (Release)
-      # Only upload code coverage for windows in an attempt to fix the broken code coverage
-      if: ${{ matrix.os == 'windows' }}
-      run: dotnet test -c release -f ${{ matrix.target }} --no-restore --collect="XPlat Code Coverage"
-      
-    - name: Run tests with coverage (Release)
-      # Only upload code coverage for windows in an attempt to fix the broken code coverage
-      if: ${{ matrix.os != 'windows' }}
       run: dotnet test -c release -f ${{ matrix.target }} --no-restore
 
+      
+  CodeCov:
+    name: Code Coverage
+    runs-on: windows-2019
+    env:
+      DOTCOVER_VER: 2021.1.2
+      DOTCOVER_PKG: jetbrains.dotcover.commandlinetools
+      COVER_SNAPSHOT: SharpZipLib.dcvr
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+        
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '3.1.x'
+        
+    # NOTE: This is the temporary fix for https://github.com/actions/virtual-environments/issues/1090
+    - name: Cleanup before restore
+      run: dotnet clean ICSharpCode.SharpZipLib.sln && dotnet nuget locals all --clear
+   
+    - name: Install codecov
+      run: nuget install -o tools -version ${{env.DOTCOVER_VER}} ${{env.DOTCOVER_PKG}}
+   
+    - name: Add dotcover to path
+      run: echo "$(pwd)\tools\${{env.DOTCOVER_PKG}}.${{env.DOTCOVER_VER}}\tools" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+   
+    - name: Run tests with code coverage
+      run: dotcover dotnet --output=${{env.COVER_SNAPSHOT}} --filters=-:ICSharpCode.SharpZipLib.Tests -- test -c release
+   
+    - name: Create code coverage report
+      run: dotcover report --source=${{env.COVER_SNAPSHOT}} --reporttype=detailedxml --output=dotcover-report.xml
+  
     - name: Upload coverage to Codecov
       uses: codecov/[email protected]
+      with:
+        files: dotcover-report.xml
+        
+    - name: Upload coverage snapshot artifact
+      uses: actions/upload-artifact@v2
+      with:
+        name: Code coverage snapshot
+        path: ${{env.COVER_SNAPSHOT}}
 
   Pack:
-    needs: [Build, Test]
-    runs-on: windows-latest
+    needs: [Build, Test, CodeCov]
+    runs-on: windows-2019
     env:
       PKG_SUFFIX: ''
       PKG_PROJ: src/ICSharpCode.SharpZipLib/ICSharpCode.SharpZipLib.csproj
@@ -88,6 +129,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
       with:
+        ref: ${{ github.events.inputs.tag }}
         fetch-depth: 0
 
     - name: Setup .NET Core
@@ -106,8 +148,18 @@ jobs:
       if: ${{ github.event_name == 'pull_request' }}
       run: echo "PKG_SUFFIX=-PR" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
 
+    - name: Set package version
+      continue-on-error: true
+      run: |-
+        $PKG_GIT_VERSION="$(git describe --tags --abbrev | % { $_.substring(1) })"
+        Write-Output "::notice::Git describe: $PKG_GIT_VERSION" 
+        Write-Output "::notice::Package suffix: $env:PKG_SUFFIX"
+        $PKG_VERSION = "${PKG_GIT_VERSION}${env:PKG_SUFFIX}"
+        Write-Output "::notice::Package version: $PKG_VERSION"
+        Write-Output "PKG_VERSION=$PKG_VERSION" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
     - name: Create nuget package
-      run: dotnet pack ${{ env.PKG_PROJ }} -c Release --output dist ${{ env.PKG_PROPS }} /p:Version=$(git describe --abbrev | % { $_.substring(1) })${{ env.PKG_SUFFIX }}
+      run: dotnet pack ${{ env.PKG_PROJ }} -c Release --output dist ${{ env.PKG_PROPS }} /p:Version=${{ env.PKG_VERSION }}
 
     - name: Upload nuget package artifact
       uses: actions/upload-artifact@v2

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '40 7 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'csharp' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.gitignore

@@ -253,3 +253,4 @@ paket-files/
 /test/ICSharpCode.SharpZipLib.TestBootstrapper/Properties/launchSettings.json
 _testRunner/
 docs/help/api/.manifest
+/benchmark/ICSharpCode.SharpZipLib.Benchmark/BenchmarkDotNet.Artifacts/results

ICSharpCode.SharpZipLib.sln

@@ -15,8 +15,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ICSharpCode.SharpZipLib", "
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ICSharpCode.SharpZipLib.Tests", "test\ICSharpCode.SharpZipLib.Tests\ICSharpCode.SharpZipLib.Tests.csproj", "{82211166-9C45-4603-8E3A-2CA2EFFCBC26}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ICSharpCode.SharpZipLib.TestBootstrapper", "test\ICSharpCode.SharpZipLib.TestBootstrapper\ICSharpCode.SharpZipLib.TestBootstrapper.csproj", "{535D7365-C5B1-4253-9233-D72D972CA851}"
-EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ICSharpCode.SharpZipLib.Benchmark", "benchmark\ICSharpCode.SharpZipLib.Benchmark\ICSharpCode.SharpZipLib.Benchmark.csproj", "{C51E638B-DDD0-48B6-A6BD-EBC4E6A104C7}"
 EndProject
 Global
@@ -33,10 +31,6 @@ Global
 		{82211166-9C45-4603-8E3A-2CA2EFFCBC26}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{82211166-9C45-4603-8E3A-2CA2EFFCBC26}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{82211166-9C45-4603-8E3A-2CA2EFFCBC26}.Release|Any CPU.Build.0 = Release|Any CPU
-		{535D7365-C5B1-4253-9233-D72D972CA851}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{535D7365-C5B1-4253-9233-D72D972CA851}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{535D7365-C5B1-4253-9233-D72D972CA851}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{535D7365-C5B1-4253-9233-D72D972CA851}.Release|Any CPU.Build.0 = Release|Any CPU
 		{C51E638B-DDD0-48B6-A6BD-EBC4E6A104C7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{C51E638B-DDD0-48B6-A6BD-EBC4E6A104C7}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{C51E638B-DDD0-48B6-A6BD-EBC4E6A104C7}.Release|Any CPU.ActiveCfg = Release|Any CPU

README.md

@@ -1,4 +1,4 @@
-# SharpZipLib [![Build Status](https://github.com/icsharpcode/SharpZipLib/actions/workflows/build-test.yml/badge.svg?branch=master)](https://github.com/icsharpcode/SharpZipLib/actions/workflows/build-test.yml) [![NuGet Version](https://img.shields.io/nuget/v/SharpZipLib.svg)](https://www.nuget.org/packages/SharpZipLib/)
+# SharpZipLib [![Build Status](https://github.com/icsharpcode/SharpZipLib/actions/workflows/build-test.yml/badge.svg?branch=master)](https://github.com/icsharpcode/SharpZipLib/actions/workflows/build-test.yml) [![NuGet Version](https://img.shields.io/nuget/v/SharpZipLib.svg)](https://www.nuget.org/packages/SharpZipLib/) [![openupm](https://img.shields.io/npm/v/org.icsharpcode.sharpziplib?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/org.icsharpcode.sharpziplib/)
 
 Introduction
 ------------

SECURITY.md

@@ -5,10 +5,7 @@
 | Version | Supported          |
 | ------- | ------------------ |
 | 1.3.x   | :white_check_mark: |
-| 1.2.x   | :white_check_mark: |
-| 1.1.x   | :white_check_mark: |
-| 1.0.x   | :white_check_mark: |
-| < 1.0   | :x:                |
+| < 1.3   | :x:                |
 
 ## Reporting a Vulnerability
 

benchmark/ICSharpCode.SharpZipLib.Benchmark/Program.cs

@@ -1,6 +1,4 @@
-using System;
-using BenchmarkDotNet;
-using BenchmarkDotNet.Configs;
+using BenchmarkDotNet.Configs;
 using BenchmarkDotNet.Jobs;
 using BenchmarkDotNet.Running;
 using BenchmarkDotNet.Toolchains.CsProj;

benchmark/ICSharpCode.SharpZipLib.Benchmark/Tar/TarInputStream.cs

@@ -0,0 +1,82 @@
+using System;
+using System.IO;
+using System.Security.Cryptography;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using BenchmarkDotNet.Attributes;
+using ICSharpCode.SharpZipLib.Tar;
+
+namespace ICSharpCode.SharpZipLib.Benchmark.Tar
+{
+	[MemoryDiagnoser]
+	[Config(typeof(MultipleRuntimes))]
+	public class TarInputStream
+	{
+		private readonly byte[] archivedData;
+		private readonly byte[] readBuffer = new byte[1024];
+
+		public TarInputStream()
+		{
+			using (var outputMemoryStream = new MemoryStream())
+			{
+				using (var zipOutputStream =
+				       new ICSharpCode.SharpZipLib.Tar.TarOutputStream(outputMemoryStream, Encoding.UTF8))
+				{
+					var tarEntry = TarEntry.CreateTarEntry("some file");
+					tarEntry.Size = 1024 * 1024;
+					zipOutputStream.PutNextEntry(tarEntry);
+
+					var rng = RandomNumberGenerator.Create();
+					var inputBuffer = new byte[1024];
+					rng.GetBytes(inputBuffer);
+
+					for (int i = 0; i < 1024; i++)
+					{
+						zipOutputStream.Write(inputBuffer, 0, inputBuffer.Length);
+					}
+				}
+
+				archivedData = outputMemoryStream.ToArray();
+			}
+		}
+
+		[Benchmark]
+		public long ReadTarInputStream()
+		{
+			using (var memoryStream = new MemoryStream(archivedData))
+			using (var zipInputStream = new ICSharpCode.SharpZipLib.Tar.TarInputStream(memoryStream, Encoding.UTF8))
+			{
+				var entry = zipInputStream.GetNextEntry();
+
+				while (zipInputStream.Read(readBuffer, 0, readBuffer.Length) > 0)
+				{
+				}
+
+				return entry.Size;
+			}
+		}
+
+		[Benchmark]
+		public async Task<long> ReadTarInputStreamAsync()
+		{
+			using (var memoryStream = new MemoryStream(archivedData))
+			using (var zipInputStream = new ICSharpCode.SharpZipLib.Tar.TarInputStream(memoryStream, Encoding.UTF8))
+			{
+				var entry = await zipInputStream.GetNextEntryAsync(CancellationToken.None);
+
+#if NETCOREAPP2_1_OR_GREATER
+				while (await zipInputStream.ReadAsync(readBuffer.AsMemory()) > 0)
+				{
+				}
+#else
+				while (await zipInputStream.ReadAsync(readBuffer, 0, readBuffer.Length) > 0)
+				{
+				}
+#endif
+
+				return entry.Size;
+			}
+		}
+	}
+}