refactor(Page): add test suite and adapt to manifest schema
This commit is contained in:
Rodweil, Theodor
parent
1cebecaed1
commit
52369d540d
3 changed files with 270 additions and 621 deletions
|
|
@ -2,188 +2,6 @@
|
|||
$ErrorActionPreference = "Stop"
|
||||
|
||||
|
||||
function Get-CachedPageMeta
|
||||
{
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Get a locally indexed/cached Confluence page id
|
||||
|
||||
.EXAMPLE
|
||||
Get-CachedPageMeta `
|
||||
-Title 'Page Title' `
|
||||
-Manifest @{...}
|
||||
|
||||
.NOTES
|
||||
To test or not to test, that is the question... Since the
|
||||
`Test-JSON` cmdlet requires serialized JSON, but we are working with
|
||||
the deserialized Hashtable, it's too computationally intense to
|
||||
always test the input upon every call. We therefore only make sure,
|
||||
that correct data is written to the filesystem. For the rest, each
|
||||
function is responsible for themself (learned that that's a valid
|
||||
reflexive pronoun today 🤓).
|
||||
|
||||
This function is lucky to get this note, because it's at the top 💯.
|
||||
Of course this applies to every function.
|
||||
#>
|
||||
Param(
|
||||
[Parameter(Mandatory)] [string] $Title,
|
||||
[Parameter(Mandatory)] [Collections.Hashtable] $Manifest
|
||||
)
|
||||
|
||||
Process
|
||||
{
|
||||
#it's fine this fails, if no `Pages` property is provided, since the
|
||||
#object (according to the schema) would be invalid anyway.
|
||||
$pages = $Manifest | Select -ExpandProperty 'Pages'
|
||||
|
||||
try
|
||||
{
|
||||
$pageMeta = $pages | Select -ExpandProperty $Title
|
||||
|
||||
Write-Debug "page id cache hit: $Title -> $($pageMeta.PageId)"
|
||||
|
||||
$pageMeta
|
||||
}
|
||||
|
||||
catch
|
||||
{
|
||||
Write-Debug "page id cache miss: $Title"
|
||||
|
||||
$null
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
function Get-PageMeta
|
||||
{
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Get a Confluence page id
|
||||
|
||||
.DESCRIPTION
|
||||
First, tries to retrieve from local page id index (cache) through
|
||||
the local alias. If no cache hit, then polls the Confluence
|
||||
instance host for the id by providing a space key and page title.
|
||||
|
||||
.EXAMPLE
|
||||
Get-PageMeta `
|
||||
-Host 'confluence.contoso.com' `
|
||||
-Title 'Testitest' `
|
||||
-Space 'TIARA' `
|
||||
-CacheIndexFile 'confluence-page-cache.json'
|
||||
#>
|
||||
Param(
|
||||
[Parameter(Mandatory)] [string] $Host,
|
||||
[Parameter(Mandatory)] [string] $Title,
|
||||
[Parameter(Mandatory)] [string] $Space,
|
||||
[Parameter(Mandatory)] [Collections.Hashtable] $Manifest
|
||||
)
|
||||
|
||||
Process
|
||||
{
|
||||
if ($Title)
|
||||
{
|
||||
$cachedPageMeta = Get-CachedPageMeta `
|
||||
-Title $Title `
|
||||
-Manifest $Manifest
|
||||
}
|
||||
|
||||
if ($cachedPageMeta)
|
||||
{
|
||||
return $cachedPageMeta
|
||||
}
|
||||
|
||||
$escapedTitle = [uri]::EscapeDataString($Title)
|
||||
|
||||
#TODO: move this to a separate function
|
||||
$query = "title=${escapedTitle}&spaceKey=${Space}&expand=history"
|
||||
|
||||
Invoke-WebRequest `
|
||||
-Uri "https://${Host}/rest/api/content?$query" `
|
||||
-Method 'Get' `
|
||||
-Headers @{
|
||||
'Authorization' = "Bearer $(Get-PersonalAccessToken $Host)"
|
||||
} `
|
||||
-OutVariable response | Out-Null
|
||||
|
||||
$results = ($response.Content | ConvertFrom-JSON).results
|
||||
|
||||
if ($results.Count -gt 1)
|
||||
{
|
||||
throw "more than one result for query: $query"
|
||||
}
|
||||
|
||||
elseif ($results.Count -eq 1)
|
||||
{
|
||||
Update-PageMeta `
|
||||
-PageId $results[0].id `
|
||||
-Version ($results[0]._expandable | Select -ExpandProperty 'version') `
|
||||
-Title $Title `
|
||||
-Manifest $Manifest
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
function Update-PageMeta
|
||||
{
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Register a Confluence page's metadata in the local cache
|
||||
|
||||
.DESCRIPTION
|
||||
|
||||
.EXAMPLE
|
||||
Add-ConfluencePage
|
||||
-Host 'confluence.contoso.com' `
|
||||
-Space 'TIARA' `
|
||||
-Title 'Testitest' `
|
||||
-Content @{}
|
||||
#>
|
||||
Param(
|
||||
[Parameter(Mandatory)] [string] $Title,
|
||||
[Parameter(Mandatory)] [string] $PageId,
|
||||
[Parameter()] [int] $Version,
|
||||
[Parameter()] [string] $AncestorTitle,
|
||||
[Parameter()] [string] $Hash,
|
||||
[Parameter(Mandatory)] [Collections.Hashtable] $Manifest
|
||||
)
|
||||
|
||||
Process
|
||||
{
|
||||
$metaPages = $Manifest.Pages
|
||||
|
||||
if ((-Not $metaPages) -Or (-Not $metaPages.$Title))
|
||||
{
|
||||
throw "page titled `$Title` not indexed in Manifest."
|
||||
}
|
||||
|
||||
$meta = $metaPages.$Title
|
||||
|
||||
$meta['PageId'] = $PageId
|
||||
|
||||
if ($Version)
|
||||
{
|
||||
$meta['Version'] = $Version
|
||||
}
|
||||
|
||||
if ($AncestorTitle)
|
||||
{
|
||||
$meta['AncestorTitle'] = $AncestorTitle
|
||||
}
|
||||
|
||||
# if content didn't update, hash stays the same
|
||||
if ($Hash)
|
||||
{
|
||||
$meta['Hash'] = $Hash
|
||||
}
|
||||
|
||||
Write-Debug "register: $Title -> $PageId"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
function New-Page
|
||||
{
|
||||
<#
|
||||
|
|
@ -206,20 +24,27 @@ function New-Page
|
|||
[Parameter(Mandatory)] [string] $Space,
|
||||
# title of page to be published
|
||||
[Parameter(Mandatory)] [string] $Title,
|
||||
# manifest
|
||||
[Parameter(Mandatory)] [Collections.Hashtable] $Manifest
|
||||
# pages manifest
|
||||
[Parameter(Mandatory)] [Array] $Manifest,
|
||||
# pages manifest index
|
||||
[Parameter()] [Collections.Hashtable] $Index
|
||||
)
|
||||
|
||||
Process
|
||||
{
|
||||
$meta = $Manifest.Pages.$Title
|
||||
$pageMeta = Get-PageMeta `
|
||||
-Host $Host `
|
||||
-Space $Space `
|
||||
-Title $Title `
|
||||
-Manifest $Manifest `
|
||||
-Index $Index
|
||||
|
||||
if (-Not $meta.Ref)
|
||||
if (-Not $pageMeta.Ref)
|
||||
{
|
||||
throw "no reference to local content for page `$Title`."
|
||||
}
|
||||
|
||||
$content = Get-Content -Path $meta.Ref
|
||||
$content = Get-Content -Path $pageMeta.Ref
|
||||
|
||||
$transportBody = @{
|
||||
'type' = 'page'
|
||||
|
|
@ -250,11 +75,13 @@ function New-Page
|
|||
{
|
||||
$response = ($rawResponse.Content | ConvertFrom-JSON)
|
||||
|
||||
$meta.PageId = $response.Id
|
||||
|
||||
$meta.Version = $response.version | Select -ExpandProperty 'number'
|
||||
|
||||
$meta
|
||||
Update-PageMeta `
|
||||
-Title $Title `
|
||||
-Id $response.Id `
|
||||
-Version $response.version.number `
|
||||
-Hash (Get-StringHash $content).Hash `
|
||||
-Manifest $Manifest `
|
||||
-Index $Index
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -280,30 +107,36 @@ function Update-Page
|
|||
[Parameter(Mandatory)] [string] $Space,
|
||||
# title of page to be published
|
||||
[Parameter(Mandatory)] [string] $Title,
|
||||
# manifest
|
||||
[Parameter(Mandatory)] [Collections.Hashtable] $Meta
|
||||
# pages manifest
|
||||
[Parameter(Mandatory)] [Array] $Manifest,
|
||||
# pages manifest index
|
||||
[Parameter()] [Collections.Hashtable] $Index
|
||||
)
|
||||
|
||||
Process
|
||||
{
|
||||
$meta = $Manifest.Pages.$Title
|
||||
$pageMeta = Get-PageMeta `
|
||||
-Host $Host `
|
||||
-Space $Space `
|
||||
-Title $Title `
|
||||
-Manifest $Manifest `
|
||||
-Index $Index
|
||||
|
||||
if (-Not $meta.Ref)
|
||||
if (-Not $pageMeta.Ref)
|
||||
{
|
||||
throw "no reference to local content for page '$Title'."
|
||||
}
|
||||
|
||||
if (-Not $meta.Id)
|
||||
if (-Not $pageMeta.Id)
|
||||
{
|
||||
throw "no id for page '$Title'."
|
||||
}
|
||||
|
||||
$content = Get-Content -Path $meta.Ref
|
||||
$content = Get-Content -Path $pageMeta.Ref
|
||||
|
||||
#FIXME: create a stream instead of reading from filesystem again
|
||||
$hash = (Get-FileHash -Path $meta.Ref -Algorithm SHA256).Hash
|
||||
$hash = (Get-StringHash $content).Hash
|
||||
|
||||
if ($hash -eq $meta.Hash)
|
||||
if ($hash -eq $pageMeta.Hash)
|
||||
{
|
||||
Write-Host "content unchanged, skipping: '$Title'"
|
||||
|
||||
|
|
@ -316,10 +149,10 @@ function Update-Page
|
|||
|
||||
# we're not updating this in place, so that we don't have to reset the
|
||||
# value opon failure
|
||||
$version = $meta.Version + 1
|
||||
$version = $pageMeta.Version + 1
|
||||
|
||||
$transportBody = @{
|
||||
'id' = $PageId
|
||||
'id' = $PageMeta.Id
|
||||
'type' = 'page'
|
||||
'title' = $Title
|
||||
'space' = @{
|
||||
|
|
@ -327,7 +160,7 @@ function Update-Page
|
|||
}
|
||||
'body' = @{
|
||||
'storage' = @{
|
||||
'value' = $Content
|
||||
'value' = $content
|
||||
'representation' = 'storage'
|
||||
}
|
||||
}
|
||||
|
|
@ -337,7 +170,7 @@ function Update-Page
|
|||
} | ConvertTo-JSON
|
||||
|
||||
Invoke-WebRequest `
|
||||
-Uri "https://${Host}/rest/api/content/$PageId" `
|
||||
-Uri "https://${Host}/rest/api/content/$($PageMeta.Id)" `
|
||||
-Method 'Put' `
|
||||
-Headers @{
|
||||
'Authorization' = "Bearer $(Get-PersonalAccessToken $Host)"
|
||||
|
|
@ -351,11 +184,13 @@ function Update-Page
|
|||
{
|
||||
$response = ($rawResponse.Content | ConvertFrom-JSON)
|
||||
|
||||
$meta.Version = $response.version | Select -ExpandProperty 'number'
|
||||
|
||||
$meta.Hash = $hash
|
||||
|
||||
$meta
|
||||
Update-PageMeta `
|
||||
-Title $Title `
|
||||
-Id $pageMeta.Id `
|
||||
-Version $response.version.number `
|
||||
-Hash $hash `
|
||||
-Manifest $Manifest `
|
||||
-Index $Index
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -439,8 +274,6 @@ function Publish-Page
|
|||
continue
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue