7 Commits
1.2.0 ... 1.3.0

9 changed files with 829 additions and 2 deletions

View File

@@ -8,7 +8,26 @@ on:
workflow_dispatch: workflow_dispatch:
jobs: jobs:
test:
runs-on: ubuntu-22.04
container:
image: catthehacker/ubuntu:pwsh-latest
steps:
- name: Check out repository code
uses: actions/checkout@v4
- name: Run pester tests and verify all tests pass
shell: pwsh
run: |
Write-Host "Changing to repository directory: ${{ github.workspace }}"
Set-Location -Path ${{ github.workspace }}
Write-Host "Running Pester tests"
Invoke-Pester -Path . -PassThru | Select-Object -ExpandProperty FailedCount | Should -Be 0 -ErrorAction stop
deploy: deploy:
needs: test
runs-on: ubuntu-22.04 runs-on: ubuntu-22.04
container: container:
image: catthehacker/ubuntu:pwsh-latest image: catthehacker/ubuntu:pwsh-latest

View File

@@ -12,7 +12,7 @@
RootModule = 'PS-GiteaUtilities.psm1' RootModule = 'PS-GiteaUtilities.psm1'
# Version number of this module. # Version number of this module.
ModuleVersion = '1.2.0' ModuleVersion = '1.3.0'
# Supported PSEditions # Supported PSEditions
# CompatiblePSEditions = @() # CompatiblePSEditions = @()

View File

@@ -872,4 +872,142 @@ Function Get-GiteaChildItem {
} }
} }
Export-ModuleMember -Function Set-GiteaConfiguration, Get-GiteaConfiguration, Get-GiteaFileContent, Invoke-GiteaFileDownload, Get-GiteaChildItem, Get-GiteaLFSFile function Get-GiteaReleases {
<#
.SYNOPSIS
Retrieves the releases for a Gitea repository.
.DESCRIPTION
This function retrieves the releases for a Gitea repository using the Gitea API. The function requires the URL of the Gitea server, the owner of the repository, the name of the repository, and a personal access token.
#>
[cmdletbinding()]
param(
[Parameter(ValueFromPipelineByPropertyName)]
[string]$giteaURL = "https://gitea.norwichct.tech",
[Parameter(ValueFromPipelineByPropertyName)]
[string]$repoOwner,
[Parameter(ValueFromPipelineByPropertyName)]
[string]$repoName,
[int]$page,
[int]$limit,
[switch]$includeDrafts,
[switch]$includePreReleases,
[string]$token
)
begin {
# Use configuration if parameters aren't provided
if (-not $PSBoundParameters.ContainsKey('giteaURL') -or
-not $PSBoundParameters.ContainsKey('repoOwner') -or
-not $PSBoundParameters.ContainsKey('token')) {
$config = Get-GiteaConfiguration
if ($config) {
if (-not $PSBoundParameters.ContainsKey('giteaURL')) { $giteaURL = $config.giteaURL }
if (-not $PSBoundParameters.ContainsKey('repoOwner')) { $repoOwner = $config.defaultOwner }
if (-not $PSBoundParameters.ContainsKey('token')) { $token = $config.token }
}
}
# Validate that we have all required parameters
$missingParams = @()
if (-not $giteaURL) { $missingParams += "giteaURL" }
if (-not $repoOwner) { $missingParams += "repoOwner" }
if (-not $token) { $missingParams += "token" }
if ($missingParams.Count -gt 0) {
throw "Missing required parameters: $($missingParams -join ', '). Either provide them directly or set them with Set-GiteaConfiguration."
}
$headers = @{
"Authorization" = "token $token"
"Accept" = "application/json"
}
}
process {
Write-Verbose "Parameters:"
Write-Verbose "giteaURL: $giteaURL"
Write-Verbose "repoOwner: $repoOwner"
Write-Verbose "repoName: $repoName"
Write-Verbose "page: $page"
Write-Verbose "limit: $limit"
Write-Verbose "includeDrafts: $includeDrafts"
Write-Verbose "includePreReleases: $includePreReleases"
Write-Debug "Token: $token"
Write-Verbose "Processing releases for repository: $repoName"
$url = "$giteaURL"
$url += "/api/v1/repos"
$url += "/$repoOwner"
$url += "/$repoName"
$url += "/releases"
if ($includeDrafts -eq $true) {
$url += "?draft=true"
}
else {
$url += "?draft=false"
}
if ($includePreReleases -eq $true) {
$url += "&pre-release=true"
}
if ($page -gt 1) {
$url += "&page=$page"
}
if ($limit -gt 0) {
$url += "&limit=$limit"
}
Write-Verbose "URL: $url"
try {
$result = Invoke-RestMethod -Uri $url -Method Get -Headers $headers
$releases = foreach ($release in $result) {
# Process each asset into its own object
$assets = foreach ($asset in $release.assets) {
[PSCustomObject]@{
Id = $asset.id
Name = $asset.name
Size = $asset.size
DownloadCount = $asset.download_count
CreatedAt = [DateTime]$asset.created_at
UUID = $asset.uuid
DownloadURL = $asset.browser_download_url
}
}
# Create the release object with nested author and assets
[PSCustomObject]@{
Id = $release.id
TagName = $release.tag_name
TargetCommit = $release.target_commitish
Name = $release.name
Description = $release.body
URL = $release.url
HTMLURL = $release.html_url
TarballURL = $release.tarball_url
ZipballURL = $release.zipball_url
UploadURL = $release.upload_url
IsDraft = $release.draft
IsPrerelease = $release.prerelease
CreatedAt = [DateTime]$release.created_at
PublishedAt = [DateTime]$release.published_at
Author = [PSCustomObject]@{
Id = $release.author.id
Username = $release.author.username
Email = $release.author.email
AvatarURL = $release.author.avatar_url
HTMLURL = $release.author.html_url
}
Assets = $assets
}
}
return $releases
}
catch {
Write-Error "Failed to retrieve file '$file' from Gitea: $_"
}
}
}
Export-ModuleMember -Function Set-GiteaConfiguration, Get-GiteaConfiguration, Get-GiteaFileContent, Invoke-GiteaFileDownload, Get-GiteaChildItem, Get-GiteaLFSFile, Get-GiteaReleases

View File

@@ -0,0 +1,173 @@
# Get-GiteaChildItem.Tests.ps1
# Import the module under test
$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
Import-Module -Name $modulePath -Force
Describe 'Get-GiteaChildItem' {
BeforeEach {
# Mock config load
Mock -CommandName Get-GiteaConfiguration -ModuleName PS-GiteaUtilities -MockWith {
return @{
giteaURL = 'https://mock.gitea.com'
defaultOwner = 'mockuser'
defaultRepo = 'mockrepo'
defaultBranch = 'main'
token = 'mocktoken'
}
}
# Mock LFS config
Mock -CommandName Get-GiteaLFSConfiguration -ModuleName PS-GiteaUtilities -MockWith {
return @(".lfs")
}
# Mock web call to list files
Mock -CommandName Invoke-RestMethod -ModuleName PS-GiteaUtilities -MockWith {
return @(
@{
name = "file1.txt"
path = "file1.txt"
type = "file"
size = 123
sha = "abc123"
download_url = "https://mock.gitea.com/file1.txt"
},
@{
name = "subdir"
path = "subdir"
type = "dir"
size = 0
sha = $null
download_url = $null
}
)
}
Mock -CommandName Write-Error -ModuleName PS-GiteaUtilities -MockWith { }
}
Context 'When listing basic items' {
It 'Should return files and directories correctly' {
$result = Get-GiteaChildItem -repoOwner 'mockuser' -repoName 'mockrepo' -Path '' -token 'mocktoken'
$result | Should -Not -BeNullOrEmpty
$result.Count | Should -BeGreaterThan 0
$file = $result | Where-Object { $_.type -eq 'file' }
$dir = $result | Where-Object { $_.type -eq 'dir' }
$file.name | Should -Be 'file1.txt'
$dir.name | Should -Be 'subdir'
}
}
Context 'When filtering only files' {
It 'Should return only files when -File is used' {
$result = Get-GiteaChildItem -repoOwner 'mockuser' -repoName 'mockrepo' -Path '' -token 'mocktoken' -File
$result | Should -Not -BeNullOrEmpty
$result.Count | Should -Be 1
$result[0].type | Should -Be 'file'
}
}
Context 'When recursing into directories' {
BeforeEach {
# Mock recursion call
Mock -CommandName Invoke-RestMethod -ModuleName PS-GiteaUtilities -MockWith {
param($Uri)
if ($Uri -like "*subdir*") {
return @(
@{
name = "nestedfile.txt"
path = "subdir/nestedfile.txt"
type = "file"
size = 456
sha = "def456"
download_url = "https://mock.gitea.com/subdir/nestedfile.txt"
}
)
} else {
return @(
@{
name = "file1.txt"
path = "file1.txt"
type = "file"
size = 123
sha = "abc123"
download_url = "https://mock.gitea.com/file1.txt"
},
@{
name = "subdir"
path = "subdir"
type = "dir"
size = 0
sha = $null
download_url = $null
}
)
}
}
}
It 'Should retrieve nested files when -Recurse is used' {
$result = Get-GiteaChildItem -repoOwner 'mockuser' -repoName 'mockrepo' -Path '' -token 'mocktoken' -Recurse
$nested = $result | Where-Object { $_.Path -eq 'subdir/nestedfile.txt' }
$nested | Should -Not -BeNullOrEmpty
$nested.size | Should -Be 456
}
}
Context 'When recursion depth limit is enforced' {
BeforeEach {
# Same recursion mock as above
Mock -CommandName Invoke-RestMethod -ModuleName PS-GiteaUtilities -MockWith {
param($Uri)
if ($Uri -like "*subdir*") {
return @(
@{
name = "nestedfile.txt"
path = "subdir/nestedfile.txt"
type = "file"
size = 456
sha = "def456"
download_url = "https://mock.gitea.com/subdir/nestedfile.txt"
}
)
} else {
return @(
@{
name = "file1.txt"
path = "file1.txt"
type = "file"
size = 123
sha = "abc123"
download_url = "https://mock.gitea.com/file1.txt"
},
@{
name = "subdir"
path = "subdir"
type = "dir"
size = 0
sha = $null
download_url = $null
}
)
}
}
}
It 'Should not recurse deeper than depth limit' {
$result = Get-GiteaChildItem -repoOwner 'mockuser' -repoName 'mockrepo' -Path '' -token 'mocktoken' -Recurse -Depth 0
$nested = $result | Where-Object { $_.Path -eq 'subdir/nestedfile.txt' }
$nested | Should -BeNullOrEmpty
}
}
}

View File

@@ -0,0 +1,75 @@
# Get-GiteaConfiguration.Tests.ps1
# Import the module under test
$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
Import-Module -Name $modulePath -Force
Describe 'Get-GiteaConfiguration' {
Context 'When configuration file exists' {
BeforeEach {
# Mock filesystem and import
Mock -CommandName Test-Path -ModuleName PS-GiteaUtilities -MockWith { $true }
Mock -CommandName Import-Clixml -ModuleName PS-GiteaUtilities -MockWith {
return @{
giteaURL = 'https://gitea.example.com'
token = 'ABC123'
}
}
}
It 'Should import configuration and return it' {
$result = Get-GiteaConfiguration
$result | Should -Not -BeNullOrEmpty
$result.giteaURL | Should -Be 'https://gitea.example.com'
$result.token | Should -Be 'ABC123'
}
It 'Should create global variables when LoadVariables is used' {
# Remove any existing variables first
Remove-Variable -Name giteaURL, token -Scope Global -ErrorAction SilentlyContinue
Get-GiteaConfiguration -LoadVariables
(Get-Variable -Name giteaURL -Scope Global).Value | Should -Be 'https://gitea.example.com'
(Get-Variable -Name token -Scope Global).Value | Should -Be 'ABC123'
}
It 'Should overwrite existing variables when Force is used' {
# Set initial variables
Set-Variable -Name giteaURL -Value 'OldURL' -Scope Global
Set-Variable -Name token -Value 'OldToken' -Scope Global
Get-GiteaConfiguration -LoadVariables -Force
(Get-Variable -Name giteaURL -Scope Global).Value | Should -Be 'https://gitea.example.com'
(Get-Variable -Name token -Scope Global).Value | Should -Be 'ABC123'
}
It 'Should not overwrite existing variables without Force' {
# Set initial variables
Set-Variable -Name giteaURL -Value 'OldURL' -Scope Global
Set-Variable -Name token -Value 'OldToken' -Scope Global
Get-GiteaConfiguration -LoadVariables
(Get-Variable -Name giteaURL -Scope Global).Value | Should -Be 'OldURL'
(Get-Variable -Name token -Scope Global).Value | Should -Be 'OldToken'
}
}
Context 'When configuration file does not exist' {
BeforeEach {
Mock -CommandName Test-Path -ModuleName PS-GiteaUtilities -MockWith { $false }
Mock -CommandName Write-Warning -ModuleName PS-GiteaUtilities -MockWith { }
}
It 'Should return null and warn the user' {
$result = Get-GiteaConfiguration
$result | Should -BeNullOrEmpty
Assert-MockCalled -CommandName Write-Warning -ModuleName PS-GiteaUtilities -Times 1
}
}
}

View File

@@ -0,0 +1,119 @@
# Get-GiteaFileContent.Tests.ps1
# Import the module under test
$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
Import-Module -Name $modulePath -Force
Describe 'Get-GiteaFileContent' {
Context 'When all parameters are provided' {
BeforeEach {
Mock -CommandName Invoke-RestMethod -ModuleName PS-GiteaUtilities -MockWith {
return @{
content = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes('Hello World'))
size = 11
sha = 'fake-sha'
}
}
}
It 'Should return file content without decoding by default' {
$result = Get-GiteaFileContent -repoOwner 'user' -repoName 'repo' -filePath 'README.md' -token 'abc123'
$result | Should -Not -BeNullOrEmpty
$result.Success | Should -Be $true
$result.Content | Should -Be ([System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes('Hello World')))
}
It 'Should decode content when -decode is used' {
$result = Get-GiteaFileContent -repoOwner 'user' -repoName 'repo' -filePath 'README.md' -token 'abc123' -decode
$result | Should -Not -BeNullOrEmpty
$result.Success | Should -Be $true
$result.Content | Should -Be 'Hello World'
}
}
Context 'When missing parameters and config is loaded' {
BeforeEach {
Mock -CommandName Get-GiteaConfiguration -ModuleName PS-GiteaUtilities -MockWith {
return @{
giteaURL = 'https://mock.gitea.com'
defaultOwner = 'mockuser'
defaultRepo = 'mockrepo'
defaultBranch = 'main'
token = 'mocktoken'
}
}
Mock -CommandName Invoke-RestMethod -ModuleName PS-GiteaUtilities -MockWith {
return @{
content = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes('Mock Config Content'))
size = 20
sha = 'mock-sha'
}
}
}
It 'Should load configuration from Get-GiteaConfiguration if not all parameters are given' {
$result = Get-GiteaFileContent -filePath 'test.ps1'
$result | Should -Not -BeNullOrEmpty
$result.Path | Should -Be 'test.ps1'
$result.Content | Should -Be ([System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes('Mock Config Content')))
}
}
Context 'When API call fails' {
BeforeEach {
Mock -CommandName Invoke-RestMethod -ModuleName PS-GiteaUtilities -MockWith { throw "API call failed" }
Mock -CommandName Write-Error -ModuleName PS-GiteaUtilities -MockWith { }
}
It 'Should capture error and mark result as unsuccessful' {
$result = Get-GiteaFileContent -repoOwner 'user' -repoName 'repo' -filePath 'badfile.ps1' -token 'abc123'
$result.Success | Should -Be $false
$result.Error | Should -Match 'API call failed'
}
}
Context 'Parameter validation' {
It 'Should throw if required parameters are missing and no config' {
Mock -CommandName Get-GiteaConfiguration -ModuleName PS-GiteaUtilities -MockWith { return $null }
{ Get-GiteaFileContent -filePath 'something.ps1' } | Should -Throw
}
}
Context 'When decoding file content' {
BeforeEach {
# Simulate API returning Base64 content
Mock -CommandName Invoke-RestMethod -ModuleName PS-GiteaUtilities -MockWith {
return @{
content = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes('Hello from API!'))
size = 15
sha = 'fake-sha-for-decode'
}
}
}
It 'Should return base64 encoded content by default (no decode switch)' {
$result = Get-GiteaFileContent -repoOwner 'user' -repoName 'repo' -filePath 'testfile.txt' -token 'abc123'
$result | Should -Not -BeNullOrEmpty
$result.Success | Should -Be $true
$result.Content | Should -Be ([System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes('Hello from API!')))
}
It 'Should decode base64 content into plain text when -decode is used' {
$result = Get-GiteaFileContent -repoOwner 'user' -repoName 'repo' -filePath 'testfile.txt' -token 'abc123' -decode
$result | Should -Not -BeNullOrEmpty
$result.Success | Should -Be $true
$result.Content | Should -Be 'Hello from API!'
}
}
}

View File

@@ -0,0 +1,117 @@
# Get-GiteaReleases.Tests.ps1
# Import the module
$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
Import-Module -Name $modulePath -Force
Describe 'Get-GiteaReleases' {
BeforeEach {
# Mock configuration load
Mock -CommandName Get-GiteaConfiguration -ModuleName PS-GiteaUtilities -MockWith {
return @{
giteaURL = 'https://mock.gitea.com'
defaultOwner = 'mockuser'
token = 'mocktoken'
}
}
# Mock API response
Mock -CommandName Invoke-RestMethod -ModuleName PS-GiteaUtilities -MockWith {
return @(
@{
id = 1
tag_name = "v1.0"
target_commitish = "main"
name = "Release 1"
body = "Initial release"
url = "https://mock.gitea.com/api/v1/releases/1"
html_url = "https://mock.gitea.com/releases/v1.0"
tarball_url = "https://mock.gitea.com/releases/v1.0.tar.gz"
zipball_url = "https://mock.gitea.com/releases/v1.0.zip"
upload_url = "https://mock.gitea.com/releases/uploads"
draft = $false
prerelease = $false
created_at = "2024-01-01T00:00:00Z"
published_at = "2024-01-01T01:00:00Z"
author = @{
id = 101
username = "devuser"
email = "dev@norwichct.org"
avatar_url = "https://mock.gitea.com/avatar.jpg"
html_url = "https://mock.gitea.com/devuser"
}
assets = @(
@{
id = 201
name = "tool.exe"
size = 123456
download_count = 42
created_at = "2024-01-01T00:30:00Z"
uuid = "uuid-1234"
browser_download_url = "https://mock.gitea.com/releases/assets/tool.exe"
}
)
}
)
}
Mock -CommandName Write-Error -ModuleName PS-GiteaUtilities -MockWith { }
}
Context 'Basic usage' {
It 'Should return a list of release objects' {
$result = Get-GiteaReleases -repoOwner 'mockuser' -repoName 'mockrepo' -token 'mocktoken'
$result | Should -Not -BeNullOrEmpty
$result[0].Name | Should -Be 'Release 1'
$result[0].Author.Username | Should -Be 'devuser'
$result[0].Assets.Count | Should -Be 1
$result[0].Assets[0].Name | Should -Be 'tool.exe'
}
}
Context 'Optional switches affect URL' {
It 'Should include draft=true and pre-release=true in URL if switches are set' {
$calledUrl = $null
Mock -CommandName Invoke-RestMethod -ModuleName PS-GiteaUtilities -MockWith {
param($Uri)
$script:calledUrl = $Uri
return @()
}
Get-GiteaReleases -repoOwner 'mockuser' -repoName 'mockrepo' -includeDrafts -includePreReleases -page 2 -limit 10 -token 'mocktoken'
$script:calledUrl | Should -Match 'draft=true'
$script:calledUrl | Should -Match 'pre-release=true'
$script:calledUrl | Should -Match 'page=2'
$script:calledUrl | Should -Match 'limit=10'
}
}
Context 'When required params are missing and no config' {
BeforeEach {
Mock -CommandName Get-GiteaConfiguration -ModuleName PS-GiteaUtilities -MockWith { return $null }
}
It 'Should throw when required parameters are not supplied' {
{ Get-GiteaReleases -repoName 'mockrepo' } | Should -Throw
}
}
Context 'When API call fails' {
BeforeEach {
Mock -CommandName Invoke-RestMethod -ModuleName PS-GiteaUtilities -MockWith {
throw "API call failed"
}
Mock -CommandName Write-Error -ModuleName PS-GiteaUtilities -MockWith { }
}
It 'Should catch and handle the error' {
$null = Get-GiteaReleases -repoOwner 'mockuser' -repoName 'mockrepo' -token 'mocktoken'
# Expect no throw, Write-Error should catch it
}
}
}

View File

@@ -0,0 +1,122 @@
# Invoke-GiteaFileDownload.Tests.ps1
# Import the module under test
$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
Import-Module -Name $modulePath -Force
Describe 'Invoke-GiteaFileDownload' {
BeforeEach {
# Always mock Get-GiteaConfiguration to avoid needing real config
Mock -CommandName Get-GiteaConfiguration -ModuleName PS-GiteaUtilities -MockWith {
return @{ token = 'mocktoken' }
}
# Correct webClient Mock: headers, download, dispose
Mock -CommandName New-Object -ModuleName PS-GiteaUtilities -MockWith {
$headers = New-Object System.Net.WebHeaderCollection
# Create a real object
$webClient = New-Object PSObject
# Add Headers
Add-Member -InputObject $webClient -MemberType NoteProperty -Name Headers -Value $headers
# Add a DownloadFile method
Add-Member -InputObject $webClient -MemberType ScriptMethod -Name DownloadFile -Value {
param($url, $path)
# Fake download (do nothing)
}
# Add a Dispose method
Add-Member -InputObject $webClient -MemberType ScriptMethod -Name Dispose -Value {
# Fake dispose (do nothing)
}
return $webClient
}
# Mock filesystem behavior
Mock -CommandName Test-Path -ModuleName PS-GiteaUtilities -MockWith { $false }
Mock -CommandName New-Item -ModuleName PS-GiteaUtilities -MockWith { }
# Clean captured download data before each test
$script:LastDownloadUrl = $null
$script:LastDownloadPath = $null
}
Context 'When all parameters are valid' {
It 'Should download a file successfully' {
$result = Invoke-GiteaFileDownload -downloadURL 'https://gitea.example.com/raw/path/to/file.txt' -token 'abc123'
$result | Should -Not -BeNullOrEmpty
$result.Success | Should -Be $true
$result.Path | Should -Match 'file\.txt$'
}
}
Context 'When preserving relative paths' {
It 'Should create a path based on filePath with PreserveRelativePath' {
$result = Invoke-GiteaFileDownload -downloadURL 'https://gitea.example.com/raw/path/to/file.txt' `
-filePath 'docs/manual/file.txt' -PreserveRelativePath -token 'abc123'
$result.Path | Should -Match 'docs[\\/]+manual[\\/]+file\.txt$'
$result.Success | Should -Be $true
}
}
Context 'When skipping directories' {
It 'Should skip items with type = dir' {
$result = Invoke-GiteaFileDownload -filePath 'docs/' -type 'dir' -token 'abc123'
$result.Success | Should -Be $true
$result.Error | Should -Match 'Skipped'
}
}
Context 'When file exists and -Force is not used' {
BeforeEach {
# Simulate file already exists
Mock -CommandName Test-Path -ModuleName PS-GiteaUtilities -MockWith {
param($Path, $PathType)
if ($PathType -eq 'Leaf') { return $true } else { return $false }
}
Mock -CommandName Write-Error -ModuleName PS-GiteaUtilities -MockWith { }
}
It 'Should not overwrite existing file without Force' {
$result = Invoke-GiteaFileDownload -downloadURL 'https://gitea.example.com/raw/path/to/existingfile.txt' -token 'abc123'
$result.Success | Should -Be $false
$result.Error | Should -Match 'already exists'
}
}
Context 'When download fails' {
BeforeEach {
Mock -CommandName New-Object -ModuleName PS-GiteaUtilities -MockWith {
$headers = New-Object System.Net.WebHeaderCollection
$webClient = New-Object PSObject
Add-Member -InputObject $webClient -MemberType NoteProperty -Name Headers -Value $headers
Add-Member -InputObject $webClient -MemberType ScriptMethod -Name DownloadFile -Value {
throw "Download failed intentionally"
}
Add-Member -InputObject $webClient -MemberType ScriptMethod -Name Dispose -Value {
return $true
}
return $webClient
}
Mock -CommandName Test-Path -ModuleName PS-GiteaUtilities -MockWith { $false }
Mock -CommandName New-Item -ModuleName PS-GiteaUtilities -MockWith { }
Mock -CommandName Write-Error -ModuleName PS-GiteaUtilities -MockWith { }
}
It 'Should capture error and mark download as failed' {
$result = Invoke-GiteaFileDownload -downloadURL 'https://gitea.example.com/raw/path/to/badfile.txt' -token 'abc123'
$result.Success | Should -Be $false
$result.Error | Should -Match 'Failed to download'
}
}
}

View File

@@ -0,0 +1,64 @@
# Set-GiteaConfiguration.Tests.ps1
Describe 'Set-GiteaConfiguration' {
BeforeAll {
# Import the module dynamically
$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
Import-Module -Name $modulePath -Force
}
Context 'Parameter Validation' {
It 'Should throw a MissingArgument exception if required parameters are missing' {
{ Set-GiteaConfiguration -giteaURL -token} | Should -Throw
}
}
Context 'Configuration Setup' {
BeforeEach {
Mock -CommandName Test-Path -ModuleName PS-GiteaUtilities -MockWith { $false }
Mock -CommandName New-Item -ModuleName PS-GiteaUtilities -MockWith { return $null }
Mock -CommandName Export-Clixml -ModuleName PS-GiteaUtilities -MockWith { return $null }
}
It 'Should create the configuration directory if it does not exist' {
Set-GiteaConfiguration -giteaURL 'https://gitea.example.com' -token 'ABC123' -defaultOwner 'testuser' -defaultRepo 'testrepo'
Assert-MockCalled -CommandName New-Item -ModuleName PS-GiteaUtilities -Times 1
}
It 'Should export the configuration to an XML file' {
Set-GiteaConfiguration -giteaURL 'https://gitea.example.com' -token 'ABC123' -defaultOwner 'testuser' -defaultRepo 'testrepo'
Assert-MockCalled -CommandName Export-Clixml -ModuleName PS-GiteaUtilities -Times 1
}
It 'Should set defaultBranch to "main" if not specified' {
# Important: override the Export-Clixml mock to capture the config
Mock -CommandName Export-Clixml -ModuleName PS-GiteaUtilities -MockWith {
param($Path, $InputObject)
$script:CapturedConfig = $InputObject
}
Set-GiteaConfiguration -giteaURL 'https://gitea.example.com' -token 'ABC123' -defaultOwner 'testuser' -defaultRepo 'testrepo'
$script:CapturedConfig.defaultBranch | Should -Be 'main'
}
}
Context 'When directory already exists' {
BeforeEach {
Mock -CommandName Test-Path -MockWith { $true }
Mock -CommandName New-Item -MockWith { throw "Should not be called" }
Mock -CommandName Export-Clixml -MockWith { return $null }
}
It 'Should not attempt to create the directory' {
Set-GiteaConfiguration -giteaURL 'https://gitea.example.com' -token 'ABC123' -defaultOwner 'testuser' -defaultRepo 'testrepo'
Assert-MockCalled -CommandName New-Item -Times 0
}
}
}