mirror of
https://github.com/GoodOlClint/PSProxmoxVE.git
synced 2026-07-27 16:28:56 +00:00
Compare commits
30 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 5e5a8fcda4 | |||
| 79c97ec211 | |||
| 098ea7e8d4 | |||
| ff728fc6d6 | |||
| 02254ed13b | |||
| cb97a86c9f | |||
| a1d9550d83 | |||
| ea2bcdc336 | |||
| 239a6b8fe9 | |||
| f3b06171b2 | |||
| fa361a3691 | |||
| 6181c8ce77 | |||
| f2925ba49f | |||
| 9a9830f2e1 | |||
| 4b0ddf566a | |||
| e1bb0d0268 | |||
| 46c4ee3713 | |||
| 7219133050 | |||
| af4ef8402d | |||
| 9bf7b2d922 | |||
| a77d2b2062 | |||
| 7dc39646ae | |||
| 6664861ca9 | |||
| 97ff7701da | |||
| 23ffc3531f | |||
| 2a809b0374 | |||
| 6e2f25a083 | |||
| aca5ff238b | |||
| ac901dbc1b | |||
| 2aa2d5994e |
@@ -25,6 +25,32 @@ jobs:
|
||||
uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||
plugin_marketplaces: 'https://github.com/anthropics/claude-code.git'
|
||||
plugins: 'code-review@claude-code-plugins'
|
||||
prompt: '/code-review:code-review ${{ github.repository }}/pull/${{ github.event.pull_request.number }}'
|
||||
allowed_bots: 'dependabot[bot]'
|
||||
track_progress: true
|
||||
prompt: |
|
||||
REPO: ${{ github.repository }}
|
||||
PR NUMBER: ${{ github.event.pull_request.number }}
|
||||
|
||||
Review this pull request for the PSProxmoxVE PowerShell module.
|
||||
|
||||
Focus areas:
|
||||
1. **DECISIONS.md compliance** — Check against the 13 architectural
|
||||
decisions (D001-D013). Any violation is a regression.
|
||||
2. **Code quality** — Cmdlet conventions (sealed, OutputType,
|
||||
ConfirmImpact.High for destructive, VmId ValidateRange),
|
||||
SecureString for passwords, Uri.EscapeDataString on path params,
|
||||
no bare catch blocks, Newtonsoft-only JSON.
|
||||
3. **API correctness** — Parameter names and enum values must match
|
||||
the PVE OpenAPI spec (see tests/PSProxmoxVE.Core.Tests/Fixtures/
|
||||
pve-api-enums.pve*.json for valid values per PVE version).
|
||||
4. **Tests** — New cmdlets should have xUnit service tests and
|
||||
Pester parameter-validation tests.
|
||||
5. **Security** — No hardcoded credentials, no secrets in logs,
|
||||
TLS verification on by default.
|
||||
|
||||
Provide inline comments for specific issues and a summary comment
|
||||
for general observations. Skip nitpicks unless they indicate a
|
||||
real problem.
|
||||
|
||||
claude_args: |
|
||||
--allowedTools "mcp__github_inline_comment__create_inline_comment,Bash(gh pr comment:*),Bash(gh pr diff:*),Bash(gh pr view:*)"
|
||||
|
||||
@@ -108,6 +108,6 @@ jobs:
|
||||
Publish-Module -Path ./publish/PSProxmoxVE -NuGetApiKey $env:NUGET_API_KEY -Verbose
|
||||
|
||||
- name: Create GitHub Release
|
||||
uses: softprops/action-gh-release@v2
|
||||
uses: softprops/action-gh-release@v3
|
||||
with:
|
||||
generate_release_notes: true
|
||||
|
||||
+45
-18
@@ -7,28 +7,52 @@ and this project adheres to [Conventional Commits](https://www.conventionalcommi
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [0.1.3] - 2026-05-20
|
||||
|
||||
### Added
|
||||
|
||||
- `Connect-PveServer -TimeoutSeconds` to set the session-default `HttpClient` timeout (default 100s; `0` = infinite). (#59)
|
||||
- `Send-PveFile -TimeoutSeconds` and `Invoke-PveStorageDownload -TimeoutSeconds` for per-call override with a 30-minute implicit default so large uploads/downloads no longer trip the 100s default. (#59)
|
||||
|
||||
### Fixed
|
||||
|
||||
- `New-PveVm -DiskSize` and `New-PveContainer -RootFsSize` now normalize unit suffixes (`32G`, `1T`, `32GB`, etc.) to bare GiB before constructing the disk spec. Previously the suffix was passed verbatim, which LVM/LVM-thin storages rejected with `unable to parse lvm volume name '32G'`. Sub-GB units (`M`, `MB`, `K`, `KB`) are now rejected client-side with a clear error. (#58)
|
||||
- `PveHttpClient.SendAsync` surfaces `HttpClient.Timeout` firings as `PveApiException(RequestTimeout)` with the resource path and configured timeout, instead of leaking a raw `TaskCanceledException`. Works across `net48`, `net10.0`, and `netstandard2.0`. (#59)
|
||||
- Disk-size validation runs before `ShouldProcess` so typos like `512M` are caught with `-WhatIf`, regardless of whether `-DiskStorage`/`-RootFsStorage` is also supplied. (#58)
|
||||
|
||||
## [0.1.2] - 2026-03-27
|
||||
|
||||
### Fixed
|
||||
|
||||
- `Get-PveApiToken`: `FullTokenId` is now computed from `UserId!TokenId` (was always empty). (#44)
|
||||
- `Set-PvePermission`: added `token` ACL type with auto-detection from `!` in `-UgId`, enabling permission assignment for API tokens. (#43)
|
||||
- `Connect-PveServer`: always emits the session to the pipeline. Use `-Quiet` to suppress; `-PassThru` is kept hidden for backwards compatibility. (#45)
|
||||
|
||||
## [0.1.1] - 2026-03-26
|
||||
|
||||
### Added
|
||||
|
||||
- Firewall management cmdlets (21): rules, security groups, aliases, IP sets, options at cluster/node/VM/container levels
|
||||
- Backup/vzdump cmdlets (5): ad-hoc backup creation and scheduled backup job CRUD
|
||||
- SDN IPAM cmdlets (3): Get/New/Remove-PveSdnIpam for IPAM plugin management
|
||||
- SDN DNS cmdlets (3): Get/New/Remove-PveSdnDns for DNS plugin management
|
||||
- SDN Controller cmdlets (3): Get/New/Remove-PveSdnController for controller management
|
||||
- PSGallery version badge in README
|
||||
- Integration tests for firewall rules, aliases, IP sets, backup jobs, and OVA import
|
||||
- SDN Update cmdlets (7): Set-PveSdnZone/Vnet/Subnet/Controller/Ipam/Dns + Invoke-PveSdnApply
|
||||
- Set-PveRole, Set-PveStorage, Set-PveApiToken for missing update operations
|
||||
- Get-PveClusterResource: single-call cluster-wide inventory of all VMs, containers, nodes, storage
|
||||
- Task management: Get-PveTaskList (list tasks on node), Stop-PveTask (cancel running tasks)
|
||||
- Pool management cmdlets (4): Get/New/Set/Remove-PvePool
|
||||
- Get-PveBackupInfo: find VMs/containers not covered by backup jobs
|
||||
- VM disk operations: Move-PveVmDisk (storage migration), Remove-PveVmDisk (detach/delete)
|
||||
- Guest agent extensions (6): Get-PveVmGuestOsInfo, Get-PveVmGuestFsInfo, Read/Write-PveVmGuestFile, Set-PveVmGuestPassword, Invoke-PveVmGuestFsTrim
|
||||
- Container gaps (6): Suspend/Resume-PveContainer, Resize-PveContainerDisk, New-PveContainerTemplate, Move-PveContainerVolume, Get-PveContainerInterface
|
||||
- Storage content management (4): Get-PveStorageStatus, Remove/Set-PveStorageContent, New-PveStorageDisk
|
||||
- Node operations (6): Get/Set-PveNodeConfig, Get/Set-PveNodeDns, Start/Stop-PveNodeVms
|
||||
- Access management (9): Get/New/Set/Remove-PveGroup, Get/New/Set/Remove-PveDomain, Set-PvePassword
|
||||
- SDN IPAM cmdlets (3): `Get`/`New`/`Remove-PveSdnIpam` for IPAM plugin management
|
||||
- SDN DNS cmdlets (3): `Get`/`New`/`Remove-PveSdnDns` for DNS plugin management
|
||||
- SDN Controller cmdlets (3): `Get`/`New`/`Remove-PveSdnController` for controller management
|
||||
- SDN Update cmdlets (7): `Set-PveSdnZone`/`Vnet`/`Subnet`/`Controller`/`Ipam`/`Dns` + `Invoke-PveSdnApply`
|
||||
- `Set-PveRole`, `Set-PveStorage`, `Set-PveApiToken` for missing update operations
|
||||
- `Get-PveClusterResource`: single-call cluster-wide inventory of all VMs, containers, nodes, storage
|
||||
- Task management: `Get-PveTaskList` (list tasks on node), `Stop-PveTask` (cancel running tasks)
|
||||
- Pool management cmdlets (4): `Get`/`New`/`Set`/`Remove-PvePool`
|
||||
- `Get-PveBackupInfo`: find VMs/containers not covered by backup jobs
|
||||
- VM disk operations: `Move-PveVmDisk` (storage migration), `Remove-PveVmDisk` (detach/delete)
|
||||
- Guest agent extensions (6): `Get-PveVmGuestOsInfo`, `Get-PveVmGuestFsInfo`, `Read`/`Write-PveVmGuestFile`, `Set-PveVmGuestPassword`, `Invoke-PveVmGuestFsTrim`
|
||||
- Container gaps (6): `Suspend`/`Resume-PveContainer`, `Resize-PveContainerDisk`, `New-PveContainerTemplate`, `Move-PveContainerVolume`, `Get-PveContainerInterface`
|
||||
- Storage content management (4): `Get-PveStorageStatus`, `Remove`/`Set-PveStorageContent`, `New-PveStorageDisk`
|
||||
- Node operations (6): `Get`/`Set-PveNodeConfig`, `Get`/`Set-PveNodeDns`, `Start`/`Stop-PveNodeVms`
|
||||
- Access management (9): `Get`/`New`/`Set`/`Remove-PveGroup`, `Get`/`New`/`Set`/`Remove-PveDomain`, `Set-PvePassword`
|
||||
- Two-tier version gating: introduced vs default version with clear user messaging
|
||||
- 70 xUnit tests validating every `ValidateSet` against the PVE OpenAPI spec, with `pve-api-enums.json` fixture extracted from the full spec
|
||||
- Integration tests for firewall rules, aliases, IP sets, backup jobs, and OVA import
|
||||
- PSGallery version badge in README
|
||||
|
||||
### Changed
|
||||
|
||||
@@ -41,7 +65,7 @@ and this project adheres to [Conventional Commits](https://www.conventionalcommi
|
||||
- `ValidateRange(100, 999999999)` added to all `VmId` parameters
|
||||
- `Uri.EscapeDataString()` applied to all dynamic URL path segments
|
||||
- Hardcoded verb strings replaced with verb class constants (`VerbsCommon.Get`, etc.)
|
||||
- Auth header magic strings extracted to named constants in PveHttpClient
|
||||
- Auth header magic strings extracted to named constants in `PveHttpClient`
|
||||
- Bare `catch` blocks replaced with specific or filtered exception handling
|
||||
- MAML help (dll-Help.xml) and 170 markdown cmdlet docs generated
|
||||
- PSGallery publish workflow with PS 5.1 smoke testing
|
||||
@@ -49,6 +73,9 @@ and this project adheres to [Conventional Commits](https://www.conventionalcommi
|
||||
### Fixed
|
||||
|
||||
- `ConfirmImpact.High` added to all destructive cmdlets (Stop, Reset, Restart, Suspend, Remove, Restore, New-PveTemplate)
|
||||
- Storage `ValidateSet`: removed `glusterfs` (dropped in PVE 9), added `btrfs` and `esxi`
|
||||
- Backup compression: `none` → `0` (PVE expects the string `"0"`, not `"none"`)
|
||||
- Cluster resource filter: removed `lxc` (PVE uses `vm` for both QEMU and LXC)
|
||||
- Hardcoded test password moved from CI workflow to GitHub Actions secret
|
||||
- Terraform variable default password removed (requires env var)
|
||||
|
||||
|
||||
@@ -93,3 +93,21 @@ This repo uses a structured review system to track findings and prevent regressi
|
||||
Finding IDs (F001, F002...) are permanent. A resolved finding is never deleted from
|
||||
findings.json — it is marked `resolved` with evidence of the fix. If a finding reappears,
|
||||
it is marked `regressed` and retains its original ID.
|
||||
|
||||
## Releasing to PSGallery
|
||||
|
||||
Tag-driven: pushing a `v*` tag to `main` triggers `.github/workflows/publish.yml` (build →
|
||||
PS 5.1 smoke test → publish to PSGallery → create GitHub Release with auto-generated notes).
|
||||
|
||||
Each release PR must update **three** things in lockstep before the tag is cut:
|
||||
|
||||
1. `ModuleVersion` in `src/PSProxmoxVE/PSProxmoxVE.psd1` (semver patch for bug-fix-only;
|
||||
minor for new features; major for breaking changes).
|
||||
2. `ReleaseNotes` in the same psd1 — this is what PSGallery surfaces on the version page.
|
||||
Replace the previous version's notes; do not append.
|
||||
3. `CHANGELOG.md` — cut the `[Unreleased]` section into a new `[X.Y.Z] - YYYY-MM-DD`
|
||||
block and reset `[Unreleased]` to empty.
|
||||
|
||||
After merge, tag `main` with `vX.Y.Z` and push the tag. The publish workflow rewrites
|
||||
the psd1 `ModuleVersion` in the build artifact from the tag, so the tag and the source
|
||||
version must match.
|
||||
|
||||
@@ -2815,6 +2815,72 @@
|
||||
"evidence": "Replaced JArray? Nodelist with List<Dictionary<string, object?>>? + NativeListConverter, and JObject? Totem with Dictionary<string, object?>? + NativeDictionaryConverter. Removed Newtonsoft.Json.Linq dependency.",
|
||||
"verified_by": "dotnet build + dotnet test (382 passed)"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "F086",
|
||||
"title": "New-PveVm -DiskSize and New-PveContainer -RootFsSize pass unit suffix verbatim, LVM rejects 'NG'",
|
||||
"category": "api_contract",
|
||||
"severity": "high",
|
||||
"status": "resolved",
|
||||
"first_detected": "2026-05-20",
|
||||
"github_issue": 58,
|
||||
"files": [
|
||||
"src/PSProxmoxVE/Cmdlets/Vms/NewPveVmCmdlet.cs",
|
||||
"src/PSProxmoxVE/Cmdlets/Containers/NewPveContainerCmdlet.cs"
|
||||
],
|
||||
"description": "Disk and rootfs sizes are interpolated directly into the disk spec as '<storage>:<size>'. The parameter docstring advertises 'e.g. 32G' but on LVM/LVM-thin storages PVE parses the value after the colon as a volume name unless it is a bare integer, failing with 'unable to parse lvm volume name \"32G\"'. File-backed storages (NFS, directory) accept either form, masking the bug in mixed environments.",
|
||||
"scan_history": [
|
||||
{
|
||||
"scan_date": "2026-05-20",
|
||||
"local_id": null,
|
||||
"status": "new"
|
||||
},
|
||||
{
|
||||
"scan_date": "2026-05-20",
|
||||
"local_id": null,
|
||||
"status": "fixed"
|
||||
}
|
||||
],
|
||||
"resolution": {
|
||||
"scan_date": "2026-05-20",
|
||||
"evidence": "Added SizeParser.NormalizeToGibibytes() which strips G/GB/T/TB suffixes, rejects sub-GB units with a clear error, and converts TB overflows to ArgumentException. New-PveVm and New-PveContainer normalize -DiskSize and -RootFsSize before ShouldProcess so typos are caught with -WhatIf, regardless of whether the matching -DiskStorage/-RootFsStorage was supplied.",
|
||||
"verified_by": "dotnet build + dotnet test (577 passed, 32 SizeParserTests) + Pester (39 passed, new DiskSize/RootFsSize validation contexts)"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "F087",
|
||||
"title": "HttpClient uses 100s default timeout; Send-PveFile and other long-running calls fail on large payloads",
|
||||
"category": "reliability",
|
||||
"severity": "high",
|
||||
"status": "resolved",
|
||||
"first_detected": "2026-05-20",
|
||||
"github_issue": 59,
|
||||
"files": [
|
||||
"src/PSProxmoxVE.Core/Client/PveHttpClient.cs",
|
||||
"src/PSProxmoxVE.Core/Authentication/PveSession.cs",
|
||||
"src/PSProxmoxVE.Core/Authentication/PveAuthenticator.cs",
|
||||
"src/PSProxmoxVE/Cmdlets/Storage/SendPveFileCmdlet.cs",
|
||||
"src/PSProxmoxVE/Cmdlets/Storage/InvokePveStorageDownloadCmdlet.cs",
|
||||
"src/PSProxmoxVE/Cmdlets/Connection/ConnectPveServerCmdlet.cs"
|
||||
],
|
||||
"description": "PveHttpClient constructs HttpClient without setting Timeout, so .NET's 100s default applies to every request. Send-PveFile, Invoke-PveStorageDownload, and Connect-PveServer expose no way to override it, so multi-GB ISO uploads on a real LAN reliably trip the 100s timeout with TaskCanceledException. PveHttpClient.SendAsync also failed to surface the timeout as a PveApiException, leaking the raw TaskCanceledException to callers.",
|
||||
"scan_history": [
|
||||
{
|
||||
"scan_date": "2026-05-20",
|
||||
"local_id": null,
|
||||
"status": "new"
|
||||
},
|
||||
{
|
||||
"scan_date": "2026-05-20",
|
||||
"local_id": null,
|
||||
"status": "fixed"
|
||||
}
|
||||
],
|
||||
"resolution": {
|
||||
"scan_date": "2026-05-20",
|
||||
"evidence": "Added PveSession.Timeout (default 100s) and a TimeSpan? override on PveHttpClient. Connect-PveServer exposes -TimeoutSeconds to set the session-default; Send-PveFile and Invoke-PveStorageDownload expose -TimeoutSeconds with a 30-minute implicit default so large uploads/downloads do not trip the 100s HttpClient default. -TimeoutSeconds 0 means Timeout.InfiniteTimeSpan. PveHttpClient.SendAsync now catches the TimeoutException-wrapped TaskCanceledException and rethrows it as PveApiException(RequestTimeout) with the resource path.",
|
||||
"verified_by": "dotnet build + dotnet test (passed including new SendAsync_TimeoutFires xUnit test) + Pester (-TimeoutSeconds coverage on all three cmdlets)"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -18,12 +18,22 @@ namespace PSProxmoxVE.Core.Authentication
|
||||
/// Authenticates using username and password, obtaining a ticket and CSRF token.
|
||||
/// The username must be in the form user@realm (e.g. root@pam).
|
||||
/// </summary>
|
||||
/// <param name="hostname">Hostname or IP address of the Proxmox VE server.</param>
|
||||
/// <param name="port">TCP port of the Proxmox VE API.</param>
|
||||
/// <param name="skipCertificateCheck">When true, skips TLS certificate validation.</param>
|
||||
/// <param name="username">Username including realm (e.g. root@pam).</param>
|
||||
/// <param name="password">Plain-text password for the user.</param>
|
||||
/// <param name="timeout">
|
||||
/// Optional HTTP timeout to apply both to the authentication call and to subsequent
|
||||
/// requests made with this session. When null, the default 100s applies.
|
||||
/// </param>
|
||||
public static PveSession AuthenticateWithCredentials(
|
||||
string hostname,
|
||||
int port,
|
||||
bool skipCertificateCheck,
|
||||
string username,
|
||||
string password)
|
||||
string password,
|
||||
TimeSpan? timeout = null)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(hostname))
|
||||
throw new ArgumentException("Hostname cannot be null or empty.", nameof(hostname));
|
||||
@@ -41,7 +51,7 @@ namespace PSProxmoxVE.Core.Authentication
|
||||
};
|
||||
|
||||
string responseBody;
|
||||
using (var httpClient = new PveHttpClient(hostname, port, skipCertificateCheck))
|
||||
using (var httpClient = new PveHttpClient(hostname, port, skipCertificateCheck, timeout))
|
||||
{
|
||||
responseBody = httpClient.Post("/api2/json/access/ticket", formData);
|
||||
}
|
||||
@@ -57,6 +67,8 @@ namespace PSProxmoxVE.Core.Authentication
|
||||
var ticketExpiry = DateTime.UtcNow.AddHours(2);
|
||||
|
||||
var session = new PveSession(hostname, port, skipCertificateCheck, ticket, csrfToken, ticketExpiry);
|
||||
if (timeout.HasValue)
|
||||
session.Timeout = timeout.Value;
|
||||
|
||||
session.ServerVersion = GetVersion(session);
|
||||
|
||||
@@ -67,11 +79,20 @@ namespace PSProxmoxVE.Core.Authentication
|
||||
/// Authenticates using a Proxmox VE API token.
|
||||
/// The token must be in the format USER@REALM!TOKENID=UUID (e.g. root@pam!mytoken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
|
||||
/// </summary>
|
||||
/// <param name="hostname">Hostname or IP address of the Proxmox VE server.</param>
|
||||
/// <param name="port">TCP port of the Proxmox VE API.</param>
|
||||
/// <param name="skipCertificateCheck">When true, skips TLS certificate validation.</param>
|
||||
/// <param name="apiToken">API token in USER@REALM!TOKENID=UUID format.</param>
|
||||
/// <param name="timeout">
|
||||
/// Optional HTTP timeout to apply to requests made with this session.
|
||||
/// When null, the default 100s applies.
|
||||
/// </param>
|
||||
public static PveSession AuthenticateWithApiToken(
|
||||
string hostname,
|
||||
int port,
|
||||
bool skipCertificateCheck,
|
||||
string apiToken)
|
||||
string apiToken,
|
||||
TimeSpan? timeout = null)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(hostname))
|
||||
throw new ArgumentException("Hostname cannot be null or empty.", nameof(hostname));
|
||||
@@ -83,6 +104,8 @@ namespace PSProxmoxVE.Core.Authentication
|
||||
nameof(apiToken));
|
||||
|
||||
var session = new PveSession(hostname, port, skipCertificateCheck, apiToken);
|
||||
if (timeout.HasValue)
|
||||
session.Timeout = timeout.Value;
|
||||
|
||||
session.ServerVersion = GetVersion(session);
|
||||
|
||||
|
||||
@@ -33,6 +33,13 @@ namespace PSProxmoxVE.Core.Authentication
|
||||
/// <summary>The Proxmox VE version detected on the server at connection time.</summary>
|
||||
public PveVersion? ServerVersion { get; internal set; }
|
||||
|
||||
/// <summary>
|
||||
/// The default HTTP request timeout applied to clients created with this session.
|
||||
/// Defaults to 100 seconds (HttpClient's built-in default). Cmdlets that perform
|
||||
/// long-running operations (e.g. Send-PveFile) may override this per-call.
|
||||
/// </summary>
|
||||
public TimeSpan Timeout { get; internal set; } = TimeSpan.FromSeconds(100);
|
||||
|
||||
/// <summary>Returns true if the ticket has expired (only relevant for Ticket auth mode)</summary>
|
||||
public bool IsExpired
|
||||
{
|
||||
|
||||
@@ -37,7 +37,12 @@ namespace PSProxmoxVE.Core.Client
|
||||
/// Creates an HTTP client authenticated with the specified PVE session.
|
||||
/// </summary>
|
||||
/// <param name="session">The authenticated PVE session providing credentials and base URL.</param>
|
||||
public PveHttpClient(PveSession session)
|
||||
/// <param name="timeoutOverride">
|
||||
/// Optional per-instance timeout override. When supplied, takes precedence over
|
||||
/// <see cref="PveSession.Timeout"/>. Pass <see cref="System.Threading.Timeout.InfiniteTimeSpan"/>
|
||||
/// to disable the timeout entirely (useful for multi-GB uploads/downloads).
|
||||
/// </param>
|
||||
public PveHttpClient(PveSession session, TimeSpan? timeoutOverride = null)
|
||||
{
|
||||
_session = session ?? throw new ArgumentNullException(nameof(session));
|
||||
_baseUrl = session.BaseUrl;
|
||||
@@ -49,6 +54,7 @@ namespace PSProxmoxVE.Core.Client
|
||||
(HttpRequestMessage _, X509Certificate2 _, X509Chain _, SslPolicyErrors _) => true;
|
||||
}
|
||||
_httpClient = new HttpClient(handler);
|
||||
_httpClient.Timeout = timeoutOverride ?? session.Timeout;
|
||||
|
||||
_httpClient.DefaultRequestHeaders.Accept.Add(
|
||||
new MediaTypeWithQualityHeaderValue("application/json"));
|
||||
@@ -58,7 +64,7 @@ namespace PSProxmoxVE.Core.Client
|
||||
/// Creates a bare HTTP client for pre-session use (e.g. initial authentication).
|
||||
/// No auth headers are added to requests made with this constructor.
|
||||
/// </summary>
|
||||
internal PveHttpClient(string hostname, int port, bool skipCertificateCheck)
|
||||
internal PveHttpClient(string hostname, int port, bool skipCertificateCheck, TimeSpan? timeout = null)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(hostname))
|
||||
throw new ArgumentException("Hostname cannot be null or empty.", nameof(hostname));
|
||||
@@ -73,6 +79,8 @@ namespace PSProxmoxVE.Core.Client
|
||||
(HttpRequestMessage _, X509Certificate2 _, X509Chain _, SslPolicyErrors _) => true;
|
||||
}
|
||||
_httpClient = new HttpClient(handler);
|
||||
if (timeout.HasValue)
|
||||
_httpClient.Timeout = timeout.Value;
|
||||
|
||||
_httpClient.DefaultRequestHeaders.Accept.Add(
|
||||
new MediaTypeWithQualityHeaderValue("application/json"));
|
||||
@@ -345,6 +353,18 @@ namespace PSProxmoxVE.Core.Client
|
||||
{
|
||||
response = await _httpClient.SendAsync(request).ConfigureAwait(false);
|
||||
}
|
||||
catch (TaskCanceledException ex)
|
||||
{
|
||||
// PveHttpClient.SendAsync passes no CancellationToken to HttpClient.SendAsync,
|
||||
// so a TaskCanceledException reaching here can only be HttpClient.Timeout
|
||||
// firing — on .NET Framework, on .NET Core, and on .NET 5+ (where it also
|
||||
// carries a TimeoutException inner). Wrap it uniformly across frameworks.
|
||||
var seconds = _httpClient.Timeout == System.Threading.Timeout.InfiniteTimeSpan
|
||||
? "infinite"
|
||||
: _httpClient.Timeout.TotalSeconds.ToString("0", System.Globalization.CultureInfo.InvariantCulture) + "s";
|
||||
throw new PveApiException(HttpStatusCode.RequestTimeout,
|
||||
$"Request timed out after {seconds}.", resource, httpMethod, ex);
|
||||
}
|
||||
catch (HttpRequestException ex)
|
||||
{
|
||||
throw new PveApiException(HttpStatusCode.ServiceUnavailable,
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
|
||||
<PackageReference Include="SharpCompress" Version="0.47.3" />
|
||||
<PackageReference Include="SharpCompress" Version="0.48.1" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
|
||||
@@ -0,0 +1,79 @@
|
||||
using System;
|
||||
using System.Globalization;
|
||||
using System.Text.RegularExpressions;
|
||||
|
||||
namespace PSProxmoxVE.Core.Utilities
|
||||
{
|
||||
/// <summary>
|
||||
/// Parses storage size strings (e.g. "32G", "1T", "60") and normalizes them
|
||||
/// to a bare integer count of gibibytes for use in PVE disk specs.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// PVE accepts a size suffix on file-backed storages (NFS, directory) but parses
|
||||
/// the value after the colon as a volume name on LVM-backed storages — so
|
||||
/// <c>local-lvm:32G</c> fails with "unable to parse lvm volume name '32G'" while
|
||||
/// <c>local-lvm:32</c> works on every storage type. Cmdlets that build disk specs
|
||||
/// must normalize size inputs through this helper before joining with the storage.
|
||||
/// </remarks>
|
||||
public static class SizeParser
|
||||
{
|
||||
private static readonly Regex Pattern = new Regex(
|
||||
@"^\s*(?<num>\d+)\s*(?<unit>[A-Za-z]*)\s*$",
|
||||
RegexOptions.Compiled);
|
||||
|
||||
/// <summary>
|
||||
/// Parses a size string and returns the value as a bare integer count of GiB.
|
||||
/// Accepts values like "60", "60G", "60GB" (= 60), "1T", "1TB" (= 1024).
|
||||
/// Sub-GB units are rejected because PVE disk allocation is GB-granular.
|
||||
/// </summary>
|
||||
/// <param name="value">The size string supplied by the user.</param>
|
||||
/// <param name="parameterName">Parameter name used in the error message.</param>
|
||||
/// <returns>The size in whole GiB as a string, suitable for direct use in disk specs.</returns>
|
||||
/// <exception cref="ArgumentException">The input cannot be parsed or uses an unsupported unit.</exception>
|
||||
public static string NormalizeToGibibytes(string value, string parameterName = "size")
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(value))
|
||||
throw new ArgumentException($"{parameterName} must not be null or empty.", parameterName);
|
||||
|
||||
var match = Pattern.Match(value);
|
||||
if (!match.Success)
|
||||
throw new ArgumentException(
|
||||
$"{parameterName} '{value}' is not a valid size. Expected a positive integer optionally suffixed with G, GB, T, or TB (e.g. '32G', '1T', '60').",
|
||||
parameterName);
|
||||
|
||||
if (!long.TryParse(match.Groups["num"].Value, NumberStyles.Integer, CultureInfo.InvariantCulture, out var num) || num <= 0)
|
||||
throw new ArgumentException(
|
||||
$"{parameterName} '{value}' must be a positive integer.",
|
||||
parameterName);
|
||||
|
||||
var unit = match.Groups["unit"].Value.ToUpperInvariant();
|
||||
long gib;
|
||||
switch (unit)
|
||||
{
|
||||
case "":
|
||||
case "G":
|
||||
case "GB":
|
||||
case "GIB":
|
||||
gib = num;
|
||||
break;
|
||||
case "T":
|
||||
case "TB":
|
||||
case "TIB":
|
||||
try { gib = checked(num * 1024L); }
|
||||
catch (OverflowException)
|
||||
{
|
||||
throw new ArgumentException(
|
||||
$"{parameterName} '{value}' is too large to represent in GiB.",
|
||||
parameterName);
|
||||
}
|
||||
break;
|
||||
default:
|
||||
throw new ArgumentException(
|
||||
$"{parameterName} '{value}' uses unsupported unit '{unit}'. Use G, GB, T, or TB. Sub-GB units (M, MB, K, KB) are not supported by PVE disk allocation.",
|
||||
parameterName);
|
||||
}
|
||||
|
||||
return gib.ToString(CultureInfo.InvariantCulture);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -48,6 +48,17 @@ namespace PSProxmoxVE.Cmdlets.Connection
|
||||
[Parameter(Mandatory = false, HelpMessage = "Skip TLS certificate validation.")]
|
||||
public SwitchParameter SkipCertificateCheck { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// HTTP request timeout in seconds for all calls made with this session.
|
||||
/// Defaults to 100 seconds (HttpClient's built-in default). Pass 0 to disable
|
||||
/// the timeout entirely. Cmdlets that perform long-running operations
|
||||
/// (Send-PveFile, Invoke-PveStorageDownload) accept their own -TimeoutSeconds
|
||||
/// that overrides this value per-call.
|
||||
/// </summary>
|
||||
[Parameter(Mandatory = false, HelpMessage = "HTTP timeout in seconds (0 = infinite). Default 100s.")]
|
||||
[ValidateRange(0, int.MaxValue)]
|
||||
public int? TimeoutSeconds { get; set; }
|
||||
|
||||
/// <summary>Deprecated — session is now always output. Kept for backwards compatibility.</summary>
|
||||
[Parameter(Mandatory = false, DontShow = true)]
|
||||
public SwitchParameter PassThru { get; set; }
|
||||
@@ -59,6 +70,13 @@ namespace PSProxmoxVE.Cmdlets.Connection
|
||||
protected override void ProcessRecord()
|
||||
{
|
||||
PveSession session;
|
||||
TimeSpan? timeout = null;
|
||||
if (TimeoutSeconds.HasValue)
|
||||
{
|
||||
timeout = TimeoutSeconds.Value == 0
|
||||
? System.Threading.Timeout.InfiniteTimeSpan
|
||||
: TimeSpan.FromSeconds(TimeoutSeconds.Value);
|
||||
}
|
||||
|
||||
switch (ParameterSetName)
|
||||
{
|
||||
@@ -77,7 +95,7 @@ namespace PSProxmoxVE.Cmdlets.Connection
|
||||
try
|
||||
{
|
||||
session = PveAuthenticator.AuthenticateWithCredentials(
|
||||
Server, Port, SkipCertificateCheck.IsPresent, username, password);
|
||||
Server, Port, SkipCertificateCheck.IsPresent, username, password, timeout);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
@@ -96,7 +114,7 @@ namespace PSProxmoxVE.Cmdlets.Connection
|
||||
try
|
||||
{
|
||||
session = PveAuthenticator.AuthenticateWithApiToken(
|
||||
Server, Port, SkipCertificateCheck.IsPresent, ApiToken!);
|
||||
Server, Port, SkipCertificateCheck.IsPresent, ApiToken!, timeout);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
|
||||
@@ -6,6 +6,7 @@ using Newtonsoft.Json.Linq;
|
||||
using PSProxmoxVE.Core.Client;
|
||||
using PSProxmoxVE.Core.Models.Vms;
|
||||
using PSProxmoxVE.Core.Services;
|
||||
using PSProxmoxVE.Core.Utilities;
|
||||
|
||||
namespace PSProxmoxVE.Cmdlets.Containers
|
||||
{
|
||||
@@ -59,9 +60,13 @@ namespace PSProxmoxVE.Cmdlets.Containers
|
||||
public int? Cores { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// <para type="description">Size of the root filesystem (e.g., "8G").</para>
|
||||
/// <para type="description">
|
||||
/// Size of the root filesystem. Accepts a bare integer in GiB ("8") or a value
|
||||
/// suffixed with G/GB/T/TB (case-insensitive); the value is normalized to a
|
||||
/// bare GiB count before being sent to the API.
|
||||
/// </para>
|
||||
/// </summary>
|
||||
[Parameter(Mandatory = false, HelpMessage = "Size of the root filesystem (e.g. 8G).")]
|
||||
[Parameter(Mandatory = false, HelpMessage = "Size of the root filesystem in GiB (e.g. 8 or 8G).")]
|
||||
public string? RootFsSize { get; set; }
|
||||
|
||||
/// <summary>
|
||||
@@ -125,6 +130,13 @@ namespace PSProxmoxVE.Cmdlets.Containers
|
||||
|
||||
protected override void ProcessRecord()
|
||||
{
|
||||
// Validate -RootFsSize before ShouldProcess so typos like "512M" are rejected
|
||||
// even with -WhatIf, and so the error is raised regardless of whether
|
||||
// -RootFsStorage is also supplied.
|
||||
string? rootFsSizeGib = null;
|
||||
if (!string.IsNullOrEmpty(RootFsSize))
|
||||
rootFsSizeGib = SizeParser.NormalizeToGibibytes(RootFsSize!, nameof(RootFsSize));
|
||||
|
||||
if (!ShouldProcess($"Container on node '{Node}'", "New-PveContainer"))
|
||||
return;
|
||||
|
||||
@@ -160,8 +172,8 @@ namespace PSProxmoxVE.Cmdlets.Containers
|
||||
if (!string.IsNullOrEmpty(RootFsStorage))
|
||||
{
|
||||
var rootFsValue = RootFsStorage!;
|
||||
if (!string.IsNullOrEmpty(RootFsSize))
|
||||
rootFsValue += $":{RootFsSize}";
|
||||
if (rootFsSizeGib != null)
|
||||
rootFsValue += $":{rootFsSizeGib}";
|
||||
config["rootfs"] = rootFsValue;
|
||||
}
|
||||
|
||||
|
||||
@@ -44,6 +44,16 @@ namespace PSProxmoxVE.Cmdlets.Storage
|
||||
[Parameter(Mandatory = false, HelpMessage = "Wait for the task to complete before returning.")]
|
||||
public SwitchParameter Wait { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// HTTP timeout for issuing the download request, in seconds. Pass 0 for infinite.
|
||||
/// When omitted, defaults to 30 minutes. Note: this only bounds the API call that
|
||||
/// schedules the download; the actual file transfer runs server-side and is tracked
|
||||
/// by the returned task.
|
||||
/// </summary>
|
||||
[Parameter(Mandatory = false, HelpMessage = "HTTP timeout in seconds (0 = infinite). Defaults to 1800 (30 min).")]
|
||||
[ValidateRange(0, int.MaxValue)]
|
||||
public int? TimeoutSeconds { get; set; }
|
||||
|
||||
protected override void ProcessRecord()
|
||||
{
|
||||
if (!ShouldProcess($"{Node}/{Storage}/{Filename}", $"Download from {Url}"))
|
||||
@@ -51,7 +61,19 @@ namespace PSProxmoxVE.Cmdlets.Storage
|
||||
|
||||
var session = GetSession();
|
||||
RequireVersion(session, "Storage URL download", 7, 0);
|
||||
using var client = new PveHttpClient(session);
|
||||
|
||||
TimeSpan timeout;
|
||||
if (TimeoutSeconds.HasValue)
|
||||
{
|
||||
timeout = TimeoutSeconds.Value == 0
|
||||
? System.Threading.Timeout.InfiniteTimeSpan
|
||||
: TimeSpan.FromSeconds(TimeoutSeconds.Value);
|
||||
}
|
||||
else
|
||||
{
|
||||
timeout = TimeSpan.FromMinutes(30);
|
||||
}
|
||||
using var client = new PveHttpClient(session, timeout);
|
||||
|
||||
WriteVerbose($"Downloading '{Url}' to {Node}/{Storage}...");
|
||||
var resource = $"nodes/{Uri.EscapeDataString(Node)}/storage/{Uri.EscapeDataString(Storage)}/download-url";
|
||||
|
||||
@@ -60,6 +60,15 @@ namespace PSProxmoxVE.Cmdlets.Storage
|
||||
[Parameter(Mandatory = false, HelpMessage = "Wait for the task to complete before returning.")]
|
||||
public SwitchParameter Wait { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// HTTP timeout for this upload, in seconds. Pass 0 for infinite (no timeout).
|
||||
/// When omitted, defaults to 30 minutes — overriding the session timeout so that
|
||||
/// large file uploads do not trip the default 100-second HttpClient timeout.
|
||||
/// </summary>
|
||||
[Parameter(Mandatory = false, HelpMessage = "HTTP timeout in seconds (0 = infinite). Defaults to 1800 (30 min).")]
|
||||
[ValidateRange(0, int.MaxValue)]
|
||||
public int? TimeoutSeconds { get; set; }
|
||||
|
||||
protected override void ProcessRecord()
|
||||
{
|
||||
var fileName = System.IO.Path.GetFileName(Path);
|
||||
@@ -75,7 +84,18 @@ namespace PSProxmoxVE.Cmdlets.Storage
|
||||
+ $"Connected server is PVE {session.ServerVersion}. The upload will proceed without checksum verification.");
|
||||
}
|
||||
|
||||
using var client = new PveHttpClient(session);
|
||||
TimeSpan timeout;
|
||||
if (TimeoutSeconds.HasValue)
|
||||
{
|
||||
timeout = TimeoutSeconds.Value == 0
|
||||
? System.Threading.Timeout.InfiniteTimeSpan
|
||||
: TimeSpan.FromSeconds(TimeoutSeconds.Value);
|
||||
}
|
||||
else
|
||||
{
|
||||
timeout = TimeSpan.FromMinutes(30);
|
||||
}
|
||||
using var client = new PveHttpClient(session, timeout);
|
||||
|
||||
WriteVerbose($"Uploading {fileName} to {Node}/{Storage} (content={ContentType})...");
|
||||
var resource = $"nodes/{Uri.EscapeDataString(Node)}/storage/{Uri.EscapeDataString(Storage)}/upload";
|
||||
|
||||
@@ -4,6 +4,7 @@ using Newtonsoft.Json.Linq;
|
||||
using PSProxmoxVE.Core.Client;
|
||||
using PSProxmoxVE.Core.Models.Vms;
|
||||
using PSProxmoxVE.Core.Services;
|
||||
using PSProxmoxVE.Core.Utilities;
|
||||
|
||||
namespace PSProxmoxVE.Cmdlets.Vms
|
||||
{
|
||||
@@ -74,9 +75,13 @@ namespace PSProxmoxVE.Cmdlets.Vms
|
||||
public string? Machine { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// <para type="description">Size of the primary disk (e.g., "32G").</para>
|
||||
/// <para type="description">
|
||||
/// Size of the primary disk. Accepts a bare integer in GiB ("32") or a value
|
||||
/// suffixed with G/GB/T/TB (case-insensitive); the value is normalized to a
|
||||
/// bare GiB count before being sent to the API.
|
||||
/// </para>
|
||||
/// </summary>
|
||||
[Parameter(Mandatory = false, HelpMessage = "Size of the primary disk (e.g. 32G).")]
|
||||
[Parameter(Mandatory = false, HelpMessage = "Size of the primary disk in GiB (e.g. 32 or 32G).")]
|
||||
public string? DiskSize { get; set; }
|
||||
|
||||
/// <summary>
|
||||
@@ -123,6 +128,13 @@ namespace PSProxmoxVE.Cmdlets.Vms
|
||||
|
||||
protected override void ProcessRecord()
|
||||
{
|
||||
// Validate -DiskSize before ShouldProcess so typos like "512M" are rejected
|
||||
// even with -WhatIf, and so the error is raised regardless of whether
|
||||
// -DiskStorage is also supplied.
|
||||
string? diskSizeGib = null;
|
||||
if (!string.IsNullOrEmpty(DiskSize))
|
||||
diskSizeGib = SizeParser.NormalizeToGibibytes(DiskSize!, nameof(DiskSize));
|
||||
|
||||
if (!ShouldProcess($"VM on node '{Node}'", "New-PveVm"))
|
||||
return;
|
||||
|
||||
@@ -161,9 +173,9 @@ namespace PSProxmoxVE.Cmdlets.Vms
|
||||
if (!string.IsNullOrEmpty(OsType))
|
||||
config["ostype"] = OsType!;
|
||||
|
||||
if (!string.IsNullOrEmpty(DiskStorage) && !string.IsNullOrEmpty(DiskSize))
|
||||
if (!string.IsNullOrEmpty(DiskStorage) && diskSizeGib != null)
|
||||
{
|
||||
var diskValue = $"{DiskStorage}:{DiskSize}";
|
||||
var diskValue = $"{DiskStorage}:{diskSizeGib}";
|
||||
if (!string.IsNullOrEmpty(DiskFormat))
|
||||
diskValue += $",format={DiskFormat}";
|
||||
config["virtio0"] = diskValue;
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
RootModule = 'PSProxmoxVE.dll'
|
||||
|
||||
# Version number of this module.
|
||||
ModuleVersion = '0.1.2'
|
||||
ModuleVersion = '0.1.3'
|
||||
|
||||
# Supported PSEditions
|
||||
CompatiblePSEditions = @('Desktop', 'Core')
|
||||
@@ -371,7 +371,21 @@
|
||||
ProjectUri = 'https://github.com/goodolclint/PSProxmoxVE'
|
||||
|
||||
# Release notes for this version
|
||||
ReleaseNotes = 'Initial preview release. Supports PVE 8.x and 9.x with VM, container, storage, network, SDN, user/role/permission, template, cloud-init, snapshot, and task management.'
|
||||
ReleaseNotes = @'
|
||||
## 0.1.3
|
||||
|
||||
Fixed:
|
||||
- New-PveVm -DiskSize / New-PveContainer -RootFsSize normalize unit suffixes
|
||||
(32G, 1T, etc.) to bare GiB before sending to PVE so the documented call
|
||||
shape works on LVM/LVM-thin storages (#58).
|
||||
- HttpClient timeouts are now configurable via -TimeoutSeconds on
|
||||
Connect-PveServer (session default), Send-PveFile, and
|
||||
Invoke-PveStorageDownload (per-call, 30-minute implicit default).
|
||||
Timeouts surface as PveApiException(RequestTimeout) instead of a raw
|
||||
TaskCanceledException (#59).
|
||||
|
||||
Full changelog: https://github.com/goodolclint/PSProxmoxVE/blob/main/CHANGELOG.md
|
||||
'@
|
||||
|
||||
}
|
||||
|
||||
|
||||
@@ -100,5 +100,14 @@ namespace PSProxmoxVE.Core.Tests.Authentication
|
||||
|
||||
Assert.True(session.SkipCertificateCheck);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Timeout_DefaultIs100Seconds()
|
||||
{
|
||||
var session = new PveSession(TestHostname, TestPort, false,
|
||||
"root@pam!mytoken=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee");
|
||||
|
||||
Assert.Equal(TimeSpan.FromSeconds(100), session.Timeout);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,101 @@
|
||||
using System;
|
||||
using System.Net;
|
||||
using System.Net.Http;
|
||||
using System.Reflection;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using PSProxmoxVE.Core.Authentication;
|
||||
using PSProxmoxVE.Core.Client;
|
||||
using PSProxmoxVE.Core.Exceptions;
|
||||
using Xunit;
|
||||
|
||||
namespace PSProxmoxVE.Core.Tests.Client
|
||||
{
|
||||
public class PveHttpClientTimeoutTests
|
||||
{
|
||||
private static HttpClient GetInnerHttpClient(PveHttpClient client)
|
||||
{
|
||||
var field = typeof(PveHttpClient).GetField("_httpClient",
|
||||
BindingFlags.Instance | BindingFlags.NonPublic)!;
|
||||
return (HttpClient)field.GetValue(client)!;
|
||||
}
|
||||
|
||||
private static void SetInnerHttpClient(PveHttpClient client, HttpClient newInner)
|
||||
{
|
||||
var field = typeof(PveHttpClient).GetField("_httpClient",
|
||||
BindingFlags.Instance | BindingFlags.NonPublic)!;
|
||||
((HttpClient)field.GetValue(client)!).Dispose();
|
||||
field.SetValue(client, newInner);
|
||||
}
|
||||
|
||||
private static PveSession NewSession()
|
||||
{
|
||||
return new PveSession("pve.example.com", 8006, false,
|
||||
"root@pam!token=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Constructor_UsesSessionTimeoutByDefault()
|
||||
{
|
||||
var session = NewSession();
|
||||
session.Timeout = TimeSpan.FromSeconds(42);
|
||||
|
||||
using var client = new PveHttpClient(session);
|
||||
|
||||
Assert.Equal(TimeSpan.FromSeconds(42), GetInnerHttpClient(client).Timeout);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Constructor_OverrideTakesPrecedenceOverSessionTimeout()
|
||||
{
|
||||
var session = NewSession();
|
||||
session.Timeout = TimeSpan.FromSeconds(42);
|
||||
|
||||
using var client = new PveHttpClient(session, TimeSpan.FromMinutes(30));
|
||||
|
||||
Assert.Equal(TimeSpan.FromMinutes(30), GetInnerHttpClient(client).Timeout);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Constructor_InfiniteTimeSpanIsAccepted()
|
||||
{
|
||||
var session = NewSession();
|
||||
|
||||
using var client = new PveHttpClient(session, Timeout.InfiniteTimeSpan);
|
||||
|
||||
Assert.Equal(Timeout.InfiniteTimeSpan, GetInnerHttpClient(client).Timeout);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task SendAsync_TimeoutFires_ThrowsPveApiExceptionWithRequestTimeout()
|
||||
{
|
||||
var session = NewSession();
|
||||
using var client = new PveHttpClient(session);
|
||||
|
||||
// Swap in an HttpClient with a delaying handler and a 50ms timeout so
|
||||
// HttpClient.Timeout fires reliably without any real network.
|
||||
var delayingClient = new HttpClient(new DelayingHandler(TimeSpan.FromSeconds(30)))
|
||||
{
|
||||
Timeout = TimeSpan.FromMilliseconds(50)
|
||||
};
|
||||
SetInnerHttpClient(client, delayingClient);
|
||||
|
||||
var ex = await Assert.ThrowsAsync<PveApiException>(() => client.GetAsync("version"));
|
||||
Assert.Equal(HttpStatusCode.RequestTimeout, ex.StatusCode);
|
||||
Assert.Contains("timed out", ex.Message, StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
|
||||
private sealed class DelayingHandler : HttpMessageHandler
|
||||
{
|
||||
private readonly TimeSpan _delay;
|
||||
public DelayingHandler(TimeSpan delay) { _delay = delay; }
|
||||
|
||||
protected override async Task<HttpResponseMessage> SendAsync(
|
||||
HttpRequestMessage request, CancellationToken cancellationToken)
|
||||
{
|
||||
await Task.Delay(_delay, cancellationToken).ConfigureAwait(false);
|
||||
return new HttpResponseMessage(HttpStatusCode.OK);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -9,14 +9,14 @@
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.3.0" />
|
||||
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.5.1" />
|
||||
<PackageReference Include="xunit" Version="2.9.3" />
|
||||
<PackageReference Include="xunit.runner.visualstudio" Version="3.1.5">
|
||||
<PrivateAssets>all</PrivateAssets>
|
||||
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
|
||||
</PackageReference>
|
||||
<PackageReference Include="Moq" Version="4.20.72" />
|
||||
<PackageReference Include="coverlet.collector" Version="8.0.1">
|
||||
<PackageReference Include="coverlet.collector" Version="10.0.1">
|
||||
<PrivateAssets>all</PrivateAssets>
|
||||
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
|
||||
</PackageReference>
|
||||
|
||||
@@ -0,0 +1,90 @@
|
||||
using System;
|
||||
using PSProxmoxVE.Core.Utilities;
|
||||
using Xunit;
|
||||
|
||||
namespace PSProxmoxVE.Core.Tests.Utilities
|
||||
{
|
||||
public class SizeParserTests
|
||||
{
|
||||
[Theory]
|
||||
[InlineData("32", "32")]
|
||||
[InlineData("32G", "32")]
|
||||
[InlineData("32g", "32")]
|
||||
[InlineData("32GB", "32")]
|
||||
[InlineData("32gb", "32")]
|
||||
[InlineData("32GiB", "32")]
|
||||
[InlineData("1T", "1024")]
|
||||
[InlineData("1t", "1024")]
|
||||
[InlineData("1TB", "1024")]
|
||||
[InlineData("1TiB", "1024")]
|
||||
[InlineData("2T", "2048")]
|
||||
[InlineData(" 60G ", "60")]
|
||||
[InlineData("60 G", "60")]
|
||||
public void NormalizeToGibibytes_AcceptedInputs_ReturnsBareGibibyteString(string input, string expected)
|
||||
{
|
||||
var result = SizeParser.NormalizeToGibibytes(input);
|
||||
Assert.Equal(expected, result);
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData("512M")]
|
||||
[InlineData("512MB")]
|
||||
[InlineData("1024K")]
|
||||
[InlineData("1024KB")]
|
||||
[InlineData("100B")]
|
||||
[InlineData("1P")]
|
||||
[InlineData("1PB")]
|
||||
public void NormalizeToGibibytes_UnsupportedUnit_Throws(string input)
|
||||
{
|
||||
var ex = Assert.Throws<ArgumentException>(() => SizeParser.NormalizeToGibibytes(input));
|
||||
Assert.Contains("unsupported unit", ex.Message, StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData("")]
|
||||
[InlineData(" ")]
|
||||
[InlineData(null)]
|
||||
public void NormalizeToGibibytes_EmptyOrWhitespace_Throws(string? input)
|
||||
{
|
||||
Assert.Throws<ArgumentException>(() => SizeParser.NormalizeToGibibytes(input!));
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData("abc")]
|
||||
[InlineData("G")]
|
||||
[InlineData("-32")]
|
||||
[InlineData("32.5G")]
|
||||
[InlineData("32 G B")]
|
||||
public void NormalizeToGibibytes_Malformed_Throws(string input)
|
||||
{
|
||||
Assert.Throws<ArgumentException>(() => SizeParser.NormalizeToGibibytes(input));
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData("0")]
|
||||
[InlineData("0G")]
|
||||
public void NormalizeToGibibytes_Zero_Throws(string input)
|
||||
{
|
||||
var ex = Assert.Throws<ArgumentException>(() => SizeParser.NormalizeToGibibytes(input));
|
||||
Assert.Contains("positive", ex.Message, StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void NormalizeToGibibytes_UsesProvidedParameterNameInError()
|
||||
{
|
||||
var ex = Assert.Throws<ArgumentException>(() => SizeParser.NormalizeToGibibytes("512M", "DiskSize"));
|
||||
Assert.Equal("DiskSize", ex.ParamName);
|
||||
Assert.Contains("DiskSize", ex.Message);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void NormalizeToGibibytes_TerabyteOverflow_ThrowsArgumentException()
|
||||
{
|
||||
// long.MaxValue with a T suffix overflows when multiplied by 1024.
|
||||
var input = long.MaxValue.ToString(System.Globalization.CultureInfo.InvariantCulture) + "T";
|
||||
var ex = Assert.Throws<ArgumentException>(() => SizeParser.NormalizeToGibibytes(input, "DiskSize"));
|
||||
Assert.Equal("DiskSize", ex.ParamName);
|
||||
Assert.Contains("too large", ex.Message, StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -112,5 +112,17 @@ Describe 'Connect-PveServer' {
|
||||
$overlap = $credSets | Where-Object { $tokenSets -contains $_ }
|
||||
$overlap | Should -BeNullOrEmpty
|
||||
}
|
||||
|
||||
It 'Should have a TimeoutSeconds parameter' {
|
||||
$script:Cmd.Parameters.ContainsKey('TimeoutSeconds') | Should -BeTrue
|
||||
}
|
||||
|
||||
It 'TimeoutSeconds should reject negative values' {
|
||||
$securePass = ConvertTo-SecureString 'hunter2' -AsPlainText -Force
|
||||
$cred = [System.Management.Automation.PSCredential]::new('root@pam', $securePass)
|
||||
{
|
||||
Connect-PveServer -Server 'pve.example.com' -Credential $cred -TimeoutSeconds -1 -ErrorAction Stop
|
||||
} | Should -Throw
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
#Requires -Module Pester
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Pester 5 tests for New-PveContainer.
|
||||
All tests are fully offline — no live Proxmox VE target is required.
|
||||
#>
|
||||
|
||||
BeforeAll {
|
||||
. $PSScriptRoot/../_TestHelper.ps1
|
||||
}
|
||||
|
||||
Describe 'New-PveContainer' {
|
||||
|
||||
Context 'Command existence' {
|
||||
It 'Should be available after module import' {
|
||||
Get-Command 'New-PveContainer' -ErrorAction SilentlyContinue |
|
||||
Should -Not -BeNullOrEmpty
|
||||
}
|
||||
|
||||
It 'Should be a CmdletInfo (binary cmdlet)' {
|
||||
(Get-Command 'New-PveContainer').CommandType | Should -Be 'Cmdlet'
|
||||
}
|
||||
}
|
||||
|
||||
Context 'ShouldProcess support' {
|
||||
BeforeAll {
|
||||
$script:Cmd = Get-Command 'New-PveContainer'
|
||||
}
|
||||
|
||||
It 'Should support ShouldProcess (WhatIf parameter present)' {
|
||||
$script:Cmd.Parameters.ContainsKey('WhatIf') | Should -BeTrue
|
||||
}
|
||||
|
||||
It 'Should support ShouldProcess (Confirm parameter present)' {
|
||||
$script:Cmd.Parameters.ContainsKey('Confirm') | Should -BeTrue
|
||||
}
|
||||
}
|
||||
|
||||
Context 'RootFsSize validation' {
|
||||
# Validation runs before ShouldProcess so -WhatIf is enough to exercise it
|
||||
# without an active session.
|
||||
|
||||
It 'Should reject sub-GB units (e.g. 512M)' {
|
||||
{ New-PveContainer -Node 'pve-node1' -RootFsStorage 'local-lvm' -RootFsSize '512M' -WhatIf -ErrorAction Stop } |
|
||||
Should -Throw '*unsupported unit*'
|
||||
}
|
||||
|
||||
It 'Should reject sub-GB units even when -RootFsStorage is omitted' {
|
||||
{ New-PveContainer -Node 'pve-node1' -RootFsSize '512M' -WhatIf -ErrorAction Stop } |
|
||||
Should -Throw '*unsupported unit*'
|
||||
}
|
||||
|
||||
It 'Should reject malformed input (e.g. 8.5G)' {
|
||||
{ New-PveContainer -Node 'pve-node1' -RootFsStorage 'local-lvm' -RootFsSize '8.5G' -WhatIf -ErrorAction Stop } |
|
||||
Should -Throw '*not a valid size*'
|
||||
}
|
||||
|
||||
It 'Should accept a bare integer with -WhatIf' {
|
||||
{ New-PveContainer -Node 'pve-node1' -RootFsStorage 'local-lvm' -RootFsSize '8' -WhatIf -ErrorAction Stop } |
|
||||
Should -Not -Throw
|
||||
}
|
||||
|
||||
It 'Should accept "8G" with -WhatIf' {
|
||||
{ New-PveContainer -Node 'pve-node1' -RootFsStorage 'local-lvm' -RootFsSize '8G' -WhatIf -ErrorAction Stop } |
|
||||
Should -Not -Throw
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -154,6 +154,20 @@ Describe 'Send-PveFile' {
|
||||
if (-not $script:CmdExists) { Set-ItResult -Skipped -Because 'Not yet compiled'; return }
|
||||
$script:Cmd.Parameters.ContainsKey('Session') | Should -BeTrue
|
||||
}
|
||||
|
||||
It 'Should have TimeoutSeconds parameter' {
|
||||
if (-not $script:CmdExists) { Set-ItResult -Skipped -Because 'Not yet compiled'; return }
|
||||
$script:Cmd.Parameters.ContainsKey('TimeoutSeconds') | Should -BeTrue
|
||||
}
|
||||
|
||||
It 'TimeoutSeconds should reject negative values' {
|
||||
if (-not $script:CmdExists) { Set-ItResult -Skipped -Because 'Not yet compiled'; return }
|
||||
$tmpIso = [System.IO.Path]::GetTempFileName()
|
||||
try {
|
||||
{ Send-PveFile -Node 'n' -Storage 's' -Path $tmpIso -TimeoutSeconds -1 -Confirm:$false -ErrorAction Stop } |
|
||||
Should -Throw
|
||||
} finally { Remove-Item $tmpIso -ErrorAction SilentlyContinue }
|
||||
}
|
||||
}
|
||||
|
||||
Context 'Without active session' {
|
||||
|
||||
@@ -150,6 +150,17 @@ Describe 'Invoke-PveStorageDownload' {
|
||||
$script:Cmd.Parameters.ContainsKey('Wait') | Should -BeTrue
|
||||
$script:Cmd.Parameters['Wait'].SwitchParameter | Should -BeTrue
|
||||
}
|
||||
|
||||
It 'Should have TimeoutSeconds parameter' {
|
||||
Skip-IfMissing 'Invoke-PveStorageDownload'
|
||||
$script:Cmd.Parameters.ContainsKey('TimeoutSeconds') | Should -BeTrue
|
||||
}
|
||||
|
||||
It 'TimeoutSeconds should reject negative values' {
|
||||
Skip-IfMissing 'Invoke-PveStorageDownload'
|
||||
{ Invoke-PveStorageDownload -Node 'pve1' -Storage 'local' -Url 'https://example.com/test.iso' -Filename 'test.iso' -TimeoutSeconds -1 -Confirm:$false -ErrorAction Stop } |
|
||||
Should -Throw
|
||||
}
|
||||
}
|
||||
|
||||
Context 'Session parameter' {
|
||||
|
||||
@@ -133,4 +133,39 @@ Describe 'New-PveVm' {
|
||||
Should -Throw '*No active Proxmox VE session*'
|
||||
}
|
||||
}
|
||||
|
||||
Context 'DiskSize validation' {
|
||||
# Validation runs before ShouldProcess so -WhatIf is enough to exercise it
|
||||
# without an active session.
|
||||
|
||||
It 'Should reject sub-GB units (e.g. 512M)' {
|
||||
{ New-PveVm -Node 'pve-node1' -DiskStorage 'local-lvm' -DiskSize '512M' -WhatIf -ErrorAction Stop } |
|
||||
Should -Throw '*unsupported unit*'
|
||||
}
|
||||
|
||||
It 'Should reject sub-GB units even when -DiskStorage is omitted' {
|
||||
{ New-PveVm -Node 'pve-node1' -DiskSize '512M' -WhatIf -ErrorAction Stop } |
|
||||
Should -Throw '*unsupported unit*'
|
||||
}
|
||||
|
||||
It 'Should reject malformed input (e.g. 32.5G)' {
|
||||
{ New-PveVm -Node 'pve-node1' -DiskStorage 'local-lvm' -DiskSize '32.5G' -WhatIf -ErrorAction Stop } |
|
||||
Should -Throw '*not a valid size*'
|
||||
}
|
||||
|
||||
It 'Should accept a bare integer with -WhatIf' {
|
||||
{ New-PveVm -Node 'pve-node1' -DiskStorage 'local-lvm' -DiskSize '32' -WhatIf -ErrorAction Stop } |
|
||||
Should -Not -Throw
|
||||
}
|
||||
|
||||
It 'Should accept "32G" with -WhatIf' {
|
||||
{ New-PveVm -Node 'pve-node1' -DiskStorage 'local-lvm' -DiskSize '32G' -WhatIf -ErrorAction Stop } |
|
||||
Should -Not -Throw
|
||||
}
|
||||
|
||||
It 'Should accept "1T" with -WhatIf' {
|
||||
{ New-PveVm -Node 'pve-node1' -DiskStorage 'local-lvm' -DiskSize '1T' -WhatIf -ErrorAction Stop } |
|
||||
Should -Not -Throw
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user