NuGetMetadata.Tests.ps1

Import-Module "./NuGetMetadata.psm1"

$filePath = @{
    test        = "./test/test.zip"
    relative    = "./test/test.zip"
    nupkg       = "./test/example.nupkg"
    nonExistent = "./non-existent.file"
    notZipFile  = "./test/test.txt"
    NugetConfig = "./test/NuGet.Config"
}
$filePath['absolute'] = (Resolve-Path $filePath.relative).Path

$dirPath = @{
    currentFolder = "."
    testProject = ".\test\example"
}

Describe "Get-NupkgMetadata" {
    Context "Given no path (null/empty string)" {
        It "It throws non-terminating exception" {
            { Get-NupkgMetadata $null } | Should throw
            { Get-NupkgMetadata "" } | Should throw
        }
    }
    Context "Given different types of paths" {
        It "works with absolute paths" {
            { Get-NupkgMetadata $filePath.absolute } | Should not be $null
        }
        It "works with relative paths" {
            { Get-NupkgMetadata $filePath.relative } | Should not be $null
        }
    }
    Context "Given non-existent file path" {
        It "Has errors" {
            Get-NupkgMetadata $filePath.nonExistent -ErrorVariable err 2>$null
            $err.Count | Should BeGreaterThan 0
        }
    }
    Context "Given example file path" {
        It "Reads the content of the file" {
            @(Get-NupkgMetadata $filePath.nupkg).Count | Should BeGreaterThan 0
        }
    }
}

Describe "Get-ZipFileEntry" {
    Context "Given a directory path" {
        It "Has errors" {
            Get-ZipFileEntry $dirPath.currentFolder -ErrorVariable err 2>$null
            $err | Should not BeNullOrEmpty
        }
    }
    Context "Given example zip file with some files" {
        $result = Get-ZipFileEntry (Resolve-Path $filePath.test).Path
        It "Return a non-empty collection" {
            $result.Count | Should BeGreaterThan 0
        }
        It "Return a ZipArchiveEntry" {
            $result | Should BeOfType System.IO.Compression.ZipArchiveEntry
        }
    }
    Context "Given a non zip file" {
        It "Has errors" {
            Get-ZipFileEntry $filePath.notZipFile 2>$null -ErrorVariable err
            $err | Should not BeNullOrEmpty
        }
    }
}

Describe "Get-ZipFileEntryContent" {
    Context "Given no zip file entry (null)" {
        It "Returns null" {
            Get-ZipFileEntryContent | Should be $null
        }
    }
    Context "Given a zip file entry" {
        It "Should not throw" { # actually never throws :)
            { Get-ZipFileEntry $filePath.test |
                Get-ZipFileEntryContent } |
                Should not throw
        }
        It "Gets the contents of the file" {
            { Get-ZipFileEntry $filePath.test |
                Get-ZipFileEntryContent } |
                Should not BeNullOrEmpty
        }
    }
    Context "When file couldn't be opened" {
        It "Should have errors" {
            # Pester cannot mock .Open()
            # so we make a stub that always throws
            Add-Type -AssemblyName "System.IO.Compression"
            $zipFile = [System.IO.Compression.ZipFile]::OpenRead($filePath.absolute)
            $obj = $zipFile.Entries[0]
            $obj | Add-Member -MemberType ScriptMethod -Name Open -Value { throw "this method always throw an exception" } -Force
            Get-ZipFileEntryContent $obj -ErrorVariable err 2>$null
            $err | Should not BeNullOrEmpty
            $zipFile.Dispose()
        }
    }
}

Describe "Get-NuGetMetadata" {
    Context "Given no parameters" {
        BeforeEach {
            Push-Location
            Set-Location ".\test\example"
        }
        It "Finds metadata in project file of current directory" {
            $result = Get-NuGetMetadata

            $result.id | Should be "xunit"            
        }
        AfterEach {
            Pop-Location
        }
    }

    Context "Given a directory" {
        It "Finds metadata in project file of given directory" {
            $result = Get-NuGetMetadata -Path $dirPath.testProject

            $result.id | Should be "xunit"
        }
    }

    <#
    Context "Given a NuGet.config file" {
        It "Finds metadata in the specified repository" {
            $result = Get-NuGetMetadata -ConfigPath $filePath.NugetConfig

            $result.id | Should be "xunit"
        }
    }
    #>

    Context "Given both directory and config file parameters" {
        It "Throws an exception because they are mutually exclusive" {
            { Get-NuGetMetadata -Path "C:\" -ConfigPath "C:\NuGet.Config" } | Should throw
        }
    }
}