Miscellaneous

remove user-agents.dat filter - workflow run + it has to be versioned
update-data - push/pop-location safety
added compatible ps editions
updated tests - conversion test

Author: alan-null

.gitignore

@@ -1,2 +1 @@
-Fake-UserAgent/data/user-agents.dat
 temp/

Fake-UserAgent/Fake-UserAgent.psd1

@@ -8,6 +8,7 @@
     Copyright         = '(c) Alan Plocieniak. All rights reserved.'
     Description       = 'PowerShell module for generating random User Agents.'
     PowerShellVersion = '5.0'
+    CompatiblePSEditions = 'Desktop', 'Core'
     FunctionsToExport = '*'
     PrivateData       = @{
         PSData = @{

Fake-UserAgent/Private/Get-UserAgentData.ps1

@@ -4,7 +4,7 @@ function Get-UserAgentData {
     $datPath = Join-Path -Path $PSScriptRoot -ChildPath "..\data\user-agents.dat"
 
     if (-Not(Test-Path $datPath)) {
-        Initialize-Dataset
+        Write-Error 'User agent data not found.'
     }
 
     Import-Clixml -Path $datPath

Fake-UserAgent/Public/Get-UserAgent.ps1

@@ -3,8 +3,6 @@ function Get-UserAgent {
     param ()
 
     $data = Get-UserAgentData
-    return $data
+    return ,$data
 
-}
-
-Export-ModuleMember -Function Get-UserAgent
+}

Fake-UserAgent/data/user-agents.dat

@@ -0,0 +1,58 @@
+Import-Module .\Fake-UserAgent\Fake-UserAgent.psm1 -Force
+
+Describe 'Fake-UserAgent.Tests' {
+    Context "Get-UserAgentData Tests" {
+
+        BeforeAll {
+            $datPath = '.\Fake-UserAgent\data\user-agents.dat'
+        }
+
+        It "should have initialized state" {
+            Test-Path $datPath | Should -Be $true
+        }
+
+        It "should have user agents" {
+            $agents = Get-UserAgent
+            $agents | Should -Not -BeNullOrEmpty
+            $agents.Count | Should -BeGreaterThan 0
+        }
+    }
+
+    Context "UA file update Tests" {
+
+        BeforeAll {
+            $datPath = '.\Fake-UserAgent\data\user-agents.dat'
+            Remove-Item -Path $datPath -ErrorAction SilentlyContinue
+        }
+
+        It "should have broken state" {
+            Test-Path $datPath | Should -Be $false
+            { Get-UserAgent -ErrorAction SilentlyContinue } | Should -Throw
+        }
+
+        It "should download and update user agents" {
+            { .\update-data.ps1  6>$null } | Should -Not -Throw
+        }
+
+        It "should have initialized state" {
+            Test-Path $datPath | Should -Be $true
+        }
+
+        It "should have the same number of user agents" {
+            $raw = Get-Content .\temp\user-agents.json -Raw | ConvertFrom-Json
+            $processed = Get-UserAgent
+            $processed.Count | Should -Be $raw.Count
+        }
+
+        It "should have the same user agent values" {
+            $raw = Get-Content .\temp\user-agents.json -Raw | ConvertFrom-Json
+            $processed = Get-UserAgent
+
+            for ($i = 0; $i -lt 200; $i++) {
+                $processed[$i].ua           | Should -Be $raw[$i].userAgent
+                $processed[$i].type         | Should -Be $raw[$i].deviceCategory
+                $processed[$i].platform     | Should -Be $raw[$i].platform
+            }
+        }
+    }
+}

Tests/Fake-UserAgent.Tests.ps1

@@ -4,7 +4,10 @@ function Initialize-Dataset {
     )
     Process {
 
-        Get-Content $uaJsonPath -Raw | ConvertFrom-Json | % {
+        $uaParser = [UAParser.Parser]::GetDefault()
+
+        [System.Object[]]$uas = Get-Content $uaJsonPath -Raw | ConvertFrom-Json
+        $uas  | % {
             $ua_result = $uaParser.Parse($_.userAgent)
             [PSCustomObject]@{
                 ua                          = $_.userAgent

Tests/Toggl.API.Tests.ps1

@@ -12,19 +12,22 @@ if (Test-Path $temp) {
     Remove-Item -Path $temp -Recurse -Force
 }
 New-Item -ItemType Directory -Path $temp | Out-Null
-Push-Location -Path $temp
 
 
-Write-Host 'Downloading user-agents.json...'
-Invoke-WebRequest -Uri $uaJsonUri -OutFile "user-agents.json.gz"
+try {
+    Push-Location -Path $temp
+    Write-Host 'Downloading user-agents.json...'
+    Invoke-WebRequest -Uri $uaJsonUri -OutFile "user-agents.json.gz"
 
-Write-Host 'Decompressing user-agents.json...'
-ConvertFrom-Gzip -InputObject (Get-Item "user-agents.json.gz") -RemoveInputFile
+    Write-Host 'Decompressing user-agents.json...'
+    ConvertFrom-Gzip -InputObject (Get-Item "user-agents.json.gz") -RemoveInputFile
 
-Write-Host 'Processing user-agents.json...'
-$processed = Initialize-Dataset -uaJsonPath "user-agents.json"
-
-Pop-Location
+    Write-Host 'Processing user-agents.json...'
+    $processed = Initialize-Dataset -uaJsonPath "user-agents.json"
+}
+finally {
+    Pop-Location
+}
 
 Write-Host 'Exporting user-agents.dat...'
 Push-Location .\Fake-UserAgent\data