CRXUpdateInfo

- added Id, FileName - changed Version type Functions load order (private vs public) Get-CRX. Test-CRXUpdateAvailable - support two parameters set
PowerShellLibrary · Jan 28, 2025 · c521d53 · c521d53
1 parent 74de841
commit c521d53
Show file tree

Hide file tree

Showing 7 changed files with 96 additions and 57 deletions.
diff --git a/CRX/CRX.psd1 b/CRX/CRX.psd1
@@ -1,15 +1,15 @@
 
 @{
-    RootModule        = 'CRX.psm1'
-    ModuleVersion     = '0.1.1'
-    GUID              = 'b5433b6c-b423-4049-8c5e-b3a50566fcf2'
-    Author            = 'Alan Plocieniak'
-    CompanyName       = 'Alan Plocieniak'
-    Copyright         = '(c) 2025 Alan Plocieniak. All rights reserved.'
-    Description       = 'Module for downloading CRX (extension package) for Chromium-based browsers.'
+    RootModule           = 'CRX.psm1'
+    ModuleVersion        = '0.2.0'
+    GUID                 = 'b5433b6c-b423-4049-8c5e-b3a50566fcf2'
+    Author               = 'Alan Plocieniak'
+    CompanyName          = 'Alan Plocieniak'
+    Copyright            = '(c) 2025 Alan Plocieniak. All rights reserved.'
+    Description          = 'Module for downloading CRX (extension package) for Chromium-based browsers.'
     PowerShellVersion    = '5.1'
     CompatiblePSEditions = 'Desktop', 'Core'
-    FunctionsToExport = '*'
+    FunctionsToExport    = '*'
     PrivateData          = @{
         PSData = @{
             Tags       = @('powershell', 'crx', 'ps', 'power-shell', 'CRX', 'chrome', 'extension' )

diff --git a/CRX/CRX.psm1 b/CRX/CRX.psm1
@@ -1,7 +1,7 @@
 $Public = @( Get-ChildItem -Path $PSScriptRoot\Public -Recurse -Filter *.ps1 -ErrorAction SilentlyContinue )
 $Private = @( Get-ChildItem -Path $PSScriptRoot\Private -Recurse -Filter *.ps1 -ErrorAction SilentlyContinue )
 
-Foreach ($import in @($Public + $Private)) {
+Foreach ($import in @($Private + $Public )) {
     try {
         . $import.fullname
     }

diff --git a/CRX/Private/CRXUpdateInfo.ps1 b/CRX/Private/CRXUpdateInfo.ps1
diff --git a/CRX/Public/Get-CRX.ps1 b/CRX/Public/Get-CRX.ps1
@@ -1,16 +1,29 @@
 function Get-CRX {
-    [CmdletBinding()]
+    [CmdletBinding(DefaultParameterSetName = 'ById')]
     param (
-        [Parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true, ParameterSetName = 'ById')]
         [string]$Id,
 
+        [Parameter(Mandatory = $true, ParameterSetName = 'ByInfo')]
+        $UpdateInfo,
+
         [Parameter(Mandatory = $true)]
         [string]$OutputDirectory
     )
 
-    $info = Get-CRXUpdateInfo -Id $Id
+    if ($PSCmdlet.ParameterSetName -eq 'ById') {
+        $info = Get-CRXUpdateInfo -Id $Id
+    }
+    else {
+        $info = $UpdateInfo
+    }
+
+    if ($null -eq $info) {
+        return $null
+    }
+
     try {
-        $outputPath = Join-Path -Path $OutputDirectory -ChildPath (Split-Path -Leaf $info.Url)
+        $outputPath = Join-Path -Path $OutputDirectory -ChildPath $info.FileName
         Invoke-WebRequest -Uri $info.Url -OutFile $outputPath
         Get-Item -Path $outputPath
     }

diff --git a/CRX/Public/New-CRXUpdateInfo.ps1 b/CRX/Public/New-CRXUpdateInfo.ps1
@@ -0,0 +1,30 @@
+class CRXUpdateInfo {
+    [string]$Id
+    [string]$FileName
+    [version]$Version
+    [string]$Url
+    [string]$SHA256
+    [string]$Status
+    [int]$Size
+
+    CRXUpdateInfo($obj) {
+        if ($obj.version.Contains('.')) {
+            $this.Version = $obj.version
+        }
+        else {
+            $this.Version = $obj.version + ".0"
+        }
+
+        $this.Url = $obj.codebase
+        $this.FileName = Split-Path -Leaf $this.Url.ToLower()
+        $this.Id = $this.FileName.Substring(0, 32)
+        $this.SHA256 = $obj.hash_sha256
+        $this.Status = $obj.status
+        $this.Size = $obj.size
+    }
+}
+
+# work around for ps module class export issues
+function New-CRXUpdateInfo($ob) {
+    return [CRXUpdateInfo]::new($ob)
+}
diff --git a/CRX/Public/Test-CRXUpdateAvailable.ps1 b/CRX/Public/Test-CRXUpdateAvailable.ps1
@@ -1,17 +1,25 @@
 function Test-CRXUpdateAvailable {
-    [CmdletBinding()]
+    [CmdletBinding(DefaultParameterSetName = 'ById')]
     param (
-        [Parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true, ParameterSetName = 'ById')]
         [string]$Id,
 
+        [Parameter(Mandatory = $true, ParameterSetName = 'ByInfo')]
+        $UpdateInfo,
+
         [Parameter(Mandatory = $true)]
         [version]$currentVersion
     )
 
-    $updateInfo = Get-CRXUpdateInfo $Id
+    if ($PSCmdlet.ParameterSetName -eq 'ById') {
+        $updateInfo = Get-CRXUpdateInfo -Id $Id
+    }
+    else {
+        $updateInfo = $UpdateInfo
+    }
+
     if ($updateInfo) {
-        $updateVersion = [version]$updateInfo.Version
-        return $updateVersion -gt $currentVersion
+        return $updateInfo.Version -gt $currentVersion
     }
     else {
         return $false

diff --git a/tests/CRX.Tests.ps1 b/tests/CRX.Tests.ps1
@@ -3,10 +3,13 @@ if (-not (Get-Module -Name Pester)) {
 }
 Import-Module .\CRX\CRX.psm1 -Force
 
+$testUrl = 'https://localhost.com/crx/blobs/ASuc5ohLVu-itAJfZqe6NgPkB0pCREbOH49PhxJq4pMdp7MWQx-ycGQt8dsD8WUSM_dTlB5sLwXljaUve7GTKh485NrRlNGdmT7O5aT9uS4R9jmIqNJBAMZSmuV9IZ0e0VV7jGd-rrI-YR5eoIra2Q/AOCLHCCCFDKJDDGPAAAJLDGLJHLLHGMD_4_0_0_0.crx'
+$testExtensionId = 'aoclhcccfdkjddgpaaajldgljhllhgmd'
+
 Describe 'CRX.Tests' {
     Context 'Get-CRXUpdateInfo' {
         It 'Should return CRXUpdateInfo object' {
-            $response = Get-CRXUpdateInfo "aoclhcccfdkjddgpaaajldgljhllhgmd"
+            $response = Get-CRXUpdateInfo $testExtensionId
             $response.Url | Should -Not -BeNullOrEmpty
             $response.Version | Should -Not -BeNullOrEmpty
         }
@@ -20,48 +23,48 @@ Describe 'CRX.Tests' {
     Context 'Test-CRXUpdateAvailable' {
         It 'Should return true if update is available' {
             Mock -CommandName Get-CRXUpdateInfo -ModuleName CRX -MockWith {
-                return [PSCustomObject]@{
-                    Version = "2.0.0"
-                    Url     = "http://example.com"
-                    SHA256  = "dummyhash"
-                    Status  = "ok"
-                    Size    = 12345
+                New-CRXUpdateInfo @{
+                    version     = "2.0.0"
+                    codebase    = $testUrl
+                    hash_sha256 = "dummyhash"
+                    status      = "ok"
+                    size        = 12345
                 }
             }
-            $result = Test-CRXUpdateAvailable -Id "aoclhcccfdkjddgpaaajldgljhllhgmd" -currentVersion "1.0.0"
+            $result = Test-CRXUpdateAvailable -Id $testExtensionId -currentVersion "1.0.0"
             $result | Should -Be $true
         }
 
         It 'Should return false if no update is available' {
             Mock -CommandName Get-CRXUpdateInfo -ModuleName CRX -MockWith {
-                return [PSCustomObject]@{
-                    Version = "1.0.0"
-                    Url     = "http://example.com"
-                    SHA256  = "dummyhash"
-                    Status  = "ok"
-                    Size    = 12345
+                return New-CRXUpdateInfo @{
+                    version     = "2.0.0"
+                    codebase    = $testUrl
+                    hash_sha256 = "dummyhash"
+                    status      = "ok"
+                    size        = 12345
                 }
             }
-            $result = Test-CRXUpdateAvailable -Id "aoclhcccfdkjddgpaaajldgljhllhgmd" -currentVersion "1.0.0"
+            $result = Test-CRXUpdateAvailable -Id $testExtensionId -currentVersion "2.0.0"
             $result | Should -Be $false
         }
 
         It 'Should return false if update info is null' {
             Mock -CommandName Get-CRXUpdateInfo -ModuleName CRX -MockWith { return $null }
-            $result = Test-CRXUpdateAvailable -Id "aoclhcccfdkjddgpaaajldgljhllhgmd" -currentVersion "1.0.0"
+            $result = Test-CRXUpdateAvailable -Id $testExtensionId -currentVersion "1.0.0"
             $result | Should -Be $false
         }
     }
 
     Context 'Get-CRX' {
         It 'Should download CRX file to specified directory' {
             Mock -CommandName Get-CRXUpdateInfo -ModuleName CRX -MockWith {
-                return [PSCustomObject]@{
-                    Version = "2.0.0"
-                    Url     = "http://example.com/extension.crx"
-                    SHA256  = "dummyhash"
-                    Status  = "ok"
-                    Size    = 12345
+                return New-CRXUpdateInfo @{
+                    version     = "2.0.0"
+                    codebase    = $testUrl
+                    hash_sha256 = "dummyhash"
+                    status      = "ok"
+                    size        = 12345
                 }
             }
 
@@ -71,9 +74,9 @@ Describe 'CRX.Tests' {
             }
 
             $outputDir = ".\temp"
-            $result = Get-CRX -Id "aoclhcccfdkjddgpaaajldgljhllhgmd" -OutputDirectory $outputDir
+            $result = Get-CRX -Id $testExtensionId -OutputDirectory $outputDir
 
-            $expectedPath = Join-Path -Path $outputDir -ChildPath "extension.crx"
+            $expectedPath = Join-Path -Path $outputDir -ChildPath "$testExtensionId`_4_0_0_0.crx"
             Test-Path $expectedPath | Should -Be $true
             $result | Should -BeOfType [System.IO.FileInfo]
             $result.FullName | Should -Be (Resolve-Path $expectedPath | Select-Object -ExpandProperty Path)