Merge pull request #165 from RWS/feature/162-Fix-Remove-IshPublicatio…

…nOutput-with-Force #162 Fixed the Remove-IshPublicationOutput cmdlet for Tridion Docs 15.1
RWS · Sep 22, 2023 · 0f2d285 · 0f2d285
2 parents ad895ef + 29ed92a
commit 0f2d285
Show file tree

Hide file tree

Showing 3 changed files with 112 additions and 11 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,22 @@
+# To learn more about .editorconfig see https://aka.ms/editorconfigdocs
+
+root = true
+
+# All files
+[*]
+indent_style             = space
+indent_size              = 2
+end_of_line              = crlf
+max_line_length          = off
+charset                  = utf-8
+insert_final_newline     = true
+trim_trailing_whitespace = true
+
+# Code files
+[*.cs]
+indent_size             = 4
+
+[*.ps1]
+indent_size             = 4
+
+
diff --git a/...SHRemote/Trisoft.ISHRemote/Cmdlets/PublicationOutput/RemoveIshPublicationOutput.Tests.ps1 b/...SHRemote/Trisoft.ISHRemote/Cmdlets/PublicationOutput/RemoveIshPublicationOutput.Tests.ps1
@@ -0,0 +1,76 @@
+BeforeAll {
+    $cmdletName = "Remove-IshPublicationOutput"
+    Write-Host ("`r`nLoading ISHRemote.PesterSetup.ps1 over BeforeAll-block for MyCommand[" + $cmdletName + "]...")
+    . (Join-Path (Split-Path -Parent $PSCommandPath) "\..\..\ISHRemote.PesterSetup.ps1")
+
+    Write-Host ("Running "+$cmdletName+" Test Data and Variables initialization")
+}
+
+Describe "Remove-IshPublicationOutput" -Tags "Delete" {
+    BeforeAll {
+        $requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "FNAME" |
+                            Set-IshRequestedMetadataField -IshSession $ishSession -Name "FDOCUMENTTYPE" |
+                            Set-IshRequestedMetadataField -IshSession $ishSession -Name "READ-ACCESS" -ValueType Element |
+                            Set-IshRequestedMetadataField -IshSession $ishSession -Name "FUSERGROUP" -ValueType Element 
+        $ishFolderTestRootOriginal = Get-IshFolder -IShSession $ishSession -FolderPath $folderTestRootPath -RequestedMetadata $requestedMetadata
+        $folderIdTestRootOriginal = $ishFolderTestRootOriginal.IshFolderRef
+        $folderTypeTestRootOriginal = $ishFolderTestRootOriginal.IshFolderType
+        Write-Debug ("folderIdTestRootOriginal[" + $folderIdTestRootOriginal + "] folderTypeTestRootOriginal[" + $folderTypeTestRootOriginal + "]")
+        $ownedByTestRootOriginal = Get-IshMetadataField -IshSession $ishSession -Name "FUSERGROUP" -ValueType Element -IshField $ishFolderTestRootOriginal.IshField
+        $readAccessTestRootOriginal = (Get-IshMetadataField -IshSession $ishSession -Name "READ-ACCESS" -ValueType Element -IshField $ishFolderTestRootOriginal.IshField).Split($ishSession.Separator)
+
+        $global:ishFolderCmdlet = Add-IshFolder -IShSession $ishSession -ParentFolderId $folderIdTestRootOriginal -FolderType $folderTypeTestRootOriginal -FolderName $cmdletName -OwnedBy $ownedByTestRootOriginal -ReadAccess $readAccessTestRootOriginal
+        $ishFolderPub = Add-IshFolder -IshSession $ishSession -ParentFolderId ($global:ishFolderCmdlet.IshFolderRef) -FolderType ISHPublication -FolderName "Publication" -OwnedBy $ownedByTestRootOriginal -ReadAccess $readAccessTestRootOriginal
+
+        $ishPublicationOutputMetadata = Set-IshMetadataField -IshSession $ishSession -Name "FTITLE" -Level Logical -Value "Pub $cmdletName $timestamp" |
+                                        Set-IshMetadataField -IshSession $ishSession -Name "FISHPUBSOURCELANGUAGES" -Level Version -ValueType Element -Value $ishLng |
+                                        Set-IshMetadataField -IshSession $ishSession -Name "FISHREQUIREDRESOLUTIONS" -Level Version -ValueType Element -Value $ishResolution
+        $ishObjectPubA = Add-IshPublicationOutput -IshSession $ishSession -IshFolder $ishFolderPub -LanguageCombination $ishLngCombination -OutputFormat $ishOutputFormatDitaXml -Metadata $ishPublicationOutputMetadata
+    }
+
+    Context "Remove-IshPublicationOutput check exceptions" {
+        It "-LogicalId does not exist. Force=Yes" {
+            {Remove-IshPublicationOutput -IshSession $ishSession -LogicalId "NON-EXISTING-LOGICAL-ID" -Version "1" -LanguageCombination $ishLngCombination -OutputFormat $ishOutputFormatDitaXml -Force} | Should -Throw
+        }    
+        It "-LogicalId does not exist" {
+            {Remove-IshPublicationOutput -IshSession $ishSession -LogicalId "NON-EXISTING-LOGICAL-ID" -Version "1" -LanguageCombination $ishLngCombination -OutputFormat $ishOutputFormatDitaXml} | Should -Throw
+        }
+        It "-Version does not exist. Force=Yes" {
+            {Remove-IshPublicationOutput -IshSession $ishSession -LogicalId $ishObjectPubA.IshRef -Version "999" -LanguageCombination $ishLngCombination -OutputFormat $ishOutputFormatDitaXml -Force} | Should -Throw
+        }    
+        It "-Version does not exist" {
+            {Remove-IshPublicationOutput -IshSession $ishSession -LogicalId $ishObjectPubA.IshRef -Version "999" -LanguageCombination $ishLngCombination -OutputFormat $ishOutputFormatDitaXml} | Should -Throw
+        }
+        It "-LanguageCombination does not exist. Force=Yes" {
+            {Remove-IshPublicationOutput -IshSession $ishSession -LogicalId $ishObjectPubA.IshRef -Version "1" -LanguageCombination "NON-EXISTING-LANGUAGE-COMBINATION" -OutputFormat $ishOutputFormatDitaXml -Force} | Should -Throw
+        }    
+        It "-LanguageCombination does not exist" {
+            {Remove-IshPublicationOutput -IshSession $ishSession -LogicalId $ishObjectPubA.IshRef -Version "1" -LanguageCombination "NON-EXISTING-LANGUAGE-COMBINATION" -OutputFormat $ishOutputFormatDitaXml} | Should -Throw
+        }
+        It "-OutputFormat does not exist. Force=Yes" {
+            {Remove-IshPublicationOutput -IshSession $ishSession -LogicalId $ishObjectPubA.IshRef -Version "999" -LanguageCombination $ishLngCombination -OutputFormat "NON-EXISTING-OUTPUT-FORMAT" -Force} | Should -Throw
+        }    
+        It "-OutputFormat does not exist" {
+            {Remove-IshPublicationOutput -IshSession $ishSession -LogicalId $ishObjectPubA.IshRef -Version "999" -LanguageCombination $ishLngCombination -OutputFormat "NON-EXISTING-OUTPUT-FORMAT"} | Should -Throw
+        }
+    }
+
+    Context "Remove-IshPublicationOutput remove PublicationOutput" {
+        It "Logical level removed with Force=Yes" {
+            $ishPubMetadata = $ishPublicationOutputMetadata | Set-IshMetadataField -IshSession $ishSession -Name "FTITLE" -Level Logical -Value "$($____Pester.CurrentTest.Name) $timestamp"
+            $ishPub = Add-IshPublicationOutput -IshSession $ishSession -IshFolder $ishFolderPub -LanguageCombination $ishLngCombination -OutputFormat $ishOutputFormatDitaXml -Metadata $ishPubMetadata
+            Remove-IshPublicationOutput -IshSession $ishSession -LogicalId $ishPub.IshRef -Version $ishPub.version_version_value -LanguageCombination $ishPub.fishpublngcombination -OutputFormat $ishPub.fishoutputformatref_lng_element -Force
+            $requestedMetadataRetrieve = Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FTITLE' -Level Logical
+            $publicationOutput = Get-IshPublicationOutput -IshSession $ishSession -LogicalId $ishPub.IshRef -RequestedMetadata $requestedMetadataRetrieve
+            $publicationOutput.length -eq 0 | Should -Be $true
+        }
+    }
+}
+
+AfterAll {
+    Write-Host ("Running "+$cmdletName+" Test Data and Variables cleanup")
+    $folderCmdletRootPath = (Join-Path $folderTestRootPath $cmdletName)
+    try { Get-IshFolder -IshSession $ishSession -FolderPath $folderCmdletRootPath -Recurse | Get-IshFolderContent -IshSession $ishSession | Remove-IshPublicationOutput -IshSession $ishSession -Force } catch { Write-Host "An error occurred: $_" }
+    try { Remove-IshFolder -IshSession $ishSession -FolderPath $folderCmdletRootPath -Recurse } catch { Write-Host "An error occurred: $_" }
+}
+
diff --git a/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/PublicationOutput/RemoveIshPublicationOutput.cs b/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/PublicationOutput/RemoveIshPublicationOutput.cs
@@ -200,22 +200,25 @@ protected override void ProcessRecord()
                         }
                     }
 
-                    // Delete logical cards which do not have any languages anymore
-                    foreach (string logicalId in logicalIdsVersionsCollection.AllKeys)
+                    if ((IshSession.ServerIshVersion.MajorVersion < 15) || ((IshSession.ServerIshVersion.MajorVersion == 15) && (IshSession.ServerIshVersion.MinorVersion < 1)))
                     {
-                        bool logicalIdFound = false;
-                        foreach (var retrievedObject in retrievedObjects)
+                        // Delete logical cards which do not have any languages anymore
+                        foreach (string logicalId in logicalIdsVersionsCollection.AllKeys)
                         {
-                            if (retrievedObject.IshRef == logicalId)
+                            bool logicalIdFound = false;
+                            foreach (var retrievedObject in retrievedObjects)
                             {
-                                logicalIdFound = true;
+                                if (retrievedObject.IshRef == logicalId)
+                                {
+                                    logicalIdFound = true;
+                                }
                             }
-                        }
-                        if (!logicalIdFound)
-                        {
-                            if (ShouldProcess(logicalId + "==="))
+                            if (!logicalIdFound)
                             {
-                                IshSession.PublicationOutput25.Delete(logicalId, "", "", "", "");
+                                if (ShouldProcess(logicalId + "==="))
+                                {
+                                    IshSession.PublicationOutput25.Delete(logicalId, "", "", "", "");
+                                }
                             }
                         }
                     }