release 1.31.0, allow multiformData file upload

Georg Martin Weber · Georg Martin Weber · commit dea0e4be021b · 2024-10-02T13:46:53.000+02:00
diff --git a/hull-vidispine-addon/README.md b/hull-vidispine-addon/README.md
@@ -186,6 +186,7 @@ Describes a particular entity on a subresource on an endpoint which is communica
 | `contentType` | The content type header for POST or PUT of the entity `config` and the accept header for all calls. Supported choices are `application/json`, `application/xml` and `text/plain`. Defaults to `application/json`. | `application/json` | `POST` <br> `PUT`
 | `postQueryParams` | Query Parameters to add to the Url of a POST command. Not a frequent use case but required to submit for example the `guid` of a UseCaseDefinition to migrate. | | `POST`
 | `putInsteadOfPost` | Some APIs use PUTting instead of POSTing for creation of new entities. If the subresource uses PUTting instead of POSTing, set this parameter to `true`. | `false` | `POST` <br> `PUT`
+| `multiPartFormData` | Setting this switch to `true` allows to POST single files as multiPartFormData. If `true`, the `config` section is expected to contain a single deliberately named key whose value is the relative file path to the file which is to be POSTed. For example, the following data will post the `myicon.svg` file to the API endpoint: <br><br>`multiPartFormData:`&#160;`true`<br>`config:`<br>&#160;&#160;`files:`&#160;`icons/myicon.svg`<br><br>Physical files need to be stored under `files/hull-vidispine-addon/installation/sources` or a direct subfolder of this path.| `false` | `POST` 
 | `putUriExcludeIdentifier` | Some APIs handle PUTting of entities by PUTing to the parent resource and specifying the entity to create in the body. If the subresource handles PUTting in that way, set this parameter to `true`. If `false` or unspecified, PUT calls will be made to the path which ends with the entities __identifier__. | `false` |  `PUT`
 | `putQueryParams` | Query Parameters to add to the Url of a PUT command. | | `PUT`
 | `remove` | The entity will be DELETEd if it exists. If both `register` and `remove` is true, any found entity is first removed if it exists before it is being created.  | `false` |  `DELETE`
diff --git a/hull-vidispine-addon/files/test/HULL/sources/charts/hull-test/charts/hull-1.31.0.tgz b/hull-vidispine-addon/files/test/HULL/sources/charts/hull-test/charts/hull-1.31.0.tgz
diff --git a/hull-vidispine-addon/files/test/HULL/sources/charts/hull-test/charts/hull-1.31.1.tgz b/hull-vidispine-addon/files/test/HULL/sources/charts/hull-test/charts/hull-1.31.1.tgz
diff --git a/hull-vidispine-addon/files/test/HULL/sources/charts/hull-test/requirements.lock b/hull-vidispine-addon/files/test/HULL/sources/charts/hull-test/requirements.lock
@@ -1,6 +1,6 @@
 dependencies:
 - name: hull
   repository: https://vidispine.github.io/hull
-  version: 1.31.0
-digest: sha256:adabeb4c7c3ccdf593c0015e5164eb105a87cb06d055108dad1dd39c14a9967b
-generated: "2024-09-26T16:39:19.8441659+02:00"
+  version: 1.31.1
+digest: sha256:576263879bbb1616bb924f56a90e381218a44a3f7b4a201aa124a3fe6ec5d1d9
+generated: "2024-10-02T10:02:53.0596199+02:00"
diff --git a/hull-vidispine-addon/hull-vidispine-addon.yaml b/hull-vidispine-addon/hull-vidispine-addon.yaml
@@ -644,60 +644,6 @@ hull:
         - custom-installation-files-setup
         - _HULL_OBJECT_TYPE_DEFAULT_
         data:
-          installation.yaml:
-            inline: |-
-                {{- with  (index $.Values "hull").config.general.data.installation }}
-                  {{- $configScope := . -}}
-                  {{- $configScopeEndpoints := dict -}}
-                  {{- if hasKey . "endpoints" -}}
-                      {{- $configScopeEndpoints = .endpoints -}}
-                  {{- end -}}
-                  {{- range $path, $_ := $.Files.Glob "files/hull-vidispine-addon/installation/endpoints/*.yaml" -}}
-                      {{- $configScopeEndpoints = mergeOverwrite $configScopeEndpoints (dict (base $path | trimSuffix ".yaml") (fromYaml ($.Files.Get $path))) -}}
-                  {{- end -}}
-                  {{- range $endpoint, $endpointval := $configScopeEndpoints -}}
-                      {{- $endpointScope := $endpointval -}}
-                      {{- if $endpointval.endpoint -}}
-                          {{- $subresources := dict -}}
-                          {{- if hasKey $endpointval "subresources" -}}
-                              {{- $subresources = $endpointval.subresources -}}
-                          {{- end -}}
-                          {{- range $path, $_ :=  $.Files.Glob (printf "%s/%s/%s" "files/hull-vidispine-addon/installation/endpoints" $endpoint "*.yaml") -}}
-                              {{- $subresources = mergeOverwrite $subresources (dict (base $path | trimSuffix ".yaml") (fromYaml ($.Files.Get $path))) -}}
-                          {{- end -}}
-                          {{- range $subresource, $subresourceval := $subresources }}
-                              {{- $subresourceScope := $subresourceval -}}
-                              {{- $entities := dict  -}}
-                              {{- if hasKey $subresourceval "entities" -}}
-                                  {{- $entities = $subresourceval.entities -}}
-                              {{- else -}}
-                                {{- $u := set $subresourceval "entities" dict }}
-                              {{- end -}}
-                              {{- range $path, $_ :=  $.Files.Glob (printf "%s/%s/%s/%s" "files/hull-vidispine-addon/installation/endpoints" $endpoint $subresource "*.yaml") -}}
-                                  {{- $entities = mergeOverwrite $entities (dict (base $path | trimSuffix ".yaml") (fromYaml ($.Files.Get $path))) -}}
-                              {{- end -}}
-                              {{- range $entity, $entityval := $entities }}
-                                  {{- $mergedDict := dict -}}
-                                  {{- if hasKey $subresourceval "_DEFAULTS_" -}}
-                                      {{- $mergedDict = deepCopy $subresourceval._DEFAULTS_ -}}
-                                  {{- end -}}
-                                  {{- $t := mergeOverwrite $mergedDict $entityval -}}
-                                  {{- $z := set (index $.Values "hull").config.general.data.installation "endpoints" $configScopeEndpoints }}
-                                  {{- if typeIs "map[string]interface {}" $mergedDict -}}
-                                      {{- if hasKey $mergedDict "config" -}}
-                                          {{- $configDict := $mergedDict.config -}}
-                                      {{- end }}
-                                  {{- end }}
-                                  {{- $t1 := set $subresourceval.entities $entity $mergedDict -}}
-                              {{- end }}
-                          {{- end }}
-                      {{- else -}}
-                          {{- $configScopeEndpoints = unset $configScopeEndpoints $endpoint -}}
-                      {{- end }}
-                  {{- end }}
-                  {{- $_ := include "hull.util.transformation" (dict "PARENT_CONTEXT" $ "SOURCE" $configScope "CALLER" nil "CALLER_KEY" nil "SOURCE_PATH" list) -}}
-                  {{- toYaml $configScope -}}
-                {{ end }}
           Installer.ps1:
             enabled: _HT*hull.config.general.data.installation.config.debug.debugInstallerScript
             inline: |-
diff --git a/images/hull-integration/Dockerfile b/images/hull-integration/Dockerfile
@@ -10,5 +10,6 @@ RUN tar -zxf oras_${VERSION}_*.tar.gz -C oras-install/
 RUN mv oras-install/oras /usr/local/bin/
 RUN rm -rf oras_${VERSION}_*.tar.gz oras-install/
 COPY ./Installer.ps1 /script/Installer.ps1
+COPY ./installation.yaml /script/installation.yaml
 COPY ./get-custom-scripts /get-custom-scripts
 RUN oras --help
diff --git a/images/hull-integration/Installer.ps1 b/images/hull-integration/Installer.ps1
@@ -321,6 +321,27 @@ Class Installer
     [Console]::ResetColor()
   }
 
+  [string] GetAbsoluteFilePath([string] $path) 
+  {
+    # Get script path
+    $currentPath = (Get-Item -Path ".\" -Verbose).FullName
+    $filePath = ""
+    if ($path -like "*/*" )
+    {
+      $split = $path.split('/')
+      $filePath = Join-Path $currentPath "custom-installation-files-$($split[0])" $split[1]
+    }
+    else
+    {
+      $filePath = Join-Path $currentPath "custom-installation-files" $($path)
+    }
+    if (!(Test-Path $filePath))
+    {
+      throw [Exception]::new("ERROR --> File '$($filePath)' does not exist")
+    }
+    return $filePath
+  }
+
   hidden [string] LogInvokeWebRequestError()
   {
     return $this.LogInvokeWebRequestError($null, $null)
@@ -1103,7 +1124,7 @@ Class Installer
         else
         {
           $this.WriteLog("**** POSTing '$entityType' entry '$identifier' to create it")
-          $this.PostEntity($apiEndpoint, $identifier, $content, $auth, $entity.postQueryParams, $contentType, $headers)
+          $this.PostEntity($apiEndpoint, $identifier, $content, $auth, $entity.postQueryParams, $contentType, $headers, $entity.multiPartFormData -eq $true)
           $lastMethod = "POST"
           $lastUri = $apiEndpoint
         }
@@ -1118,11 +1139,36 @@ Class Installer
   }
 
   # Post an entity
-  hidden [PSCustomObject] PostEntity([string] $postUrl, [string] $identifier, [string] $json, [PSCustomObject] $auth, [PSCustomObject] $postQueryParams, [string] $contentType, [PSCustomObject] $headers)
+  hidden [PSCustomObject] PostEntity([string] $postUrl, [string] $identifier, [string] $json, [PSCustomObject] $auth, [PSCustomObject] $postQueryParams, [string] $contentType, [PSCustomObject] $headers, [bool] $multiPartFormData)
   {
     $this.WriteLog("**** 'URL before: $($postUrl)")
     $url = $this.AppendQueryParamsToUri($postUrl, $postQueryParams, $identifier, $false)
     $this.WriteLog("**** 'URL after: $($url)")
+
+    if ($multiPartFormData)
+    {
+      $decodedJson = $json | ConvertFrom-Json -AsHashTable
+      $multiPartFormDataField = @($decodedJson.Keys)[0]
+      $multiPartFormDataFilePath = $this.GetAbsoluteFilePath(@($decodedJson.Values)[0])
+      $multiPartFormDataFileName = Split-Path $multiPartFormDataFilePath -leaf
+      $this.WriteLog("***** MultiPartFormData: Field=$($multiPartFormDataField) FilePath=$($multiPartFormDataFilePath) FileName=$($multiPartFormDataFileName)'")
+    
+      $fileBytes = [System.IO.File]::ReadAllBytes($multiPartFormDataFilePath);
+      $fileEncoded = [System.Text.Encoding]::GetEncoding('UTF-8').GetString($fileBytes);
+      $boundary = [System.Guid]::NewGuid().ToString(); 
+      $LF = "`r`n";
+
+      $json = ( 
+          "--$boundary",
+          "Content-Disposition: form-data; name=`"$($multiPartFormDataField)`"; filename=`"$($multiPartFormDataFileName)`"",
+          "Content-Type: application/octet-stream$LF",
+          $fileEncoded,
+          "--$boundary--$LF" 
+      ) -join $LF
+
+      $headers["Content-Type"] = "multipart/form-data; boundary=`"$boundary`""
+    }
+
     return $this.InvokeWebRequest($url, "POST", $json, $headers)
   }
 
@@ -1226,21 +1272,7 @@ Class Installer
         if ([String]::IsNullOrEmpty($value))
         {
           $this.WriteLog("**** Determined file path '$($path)' as source for mapping'.")
-          $currentPath = (Get-Item -Path ".\" -Verbose).FullName
-          $filePath = ""
-          if ($path -like "*/*" )
-          {
-            $split = $path.split('/')
-            $filePath = Join-Path $currentPath "custom-installation-files-$($split[0])" $split[1]
-          }
-          else
-          {
-            $filePath = Join-Path $currentPath "custom-installation-files" $($path)
-          }
-          if (!(Test-Path $filePath))
-          {
-            throw [Exception]::new("ERROR --> File '$($filePath)' does not exist")
-          }
+          $filePath = $this.GetAbsoluteFilePath($path)
           $this.WriteLog("**** External Config file found: " + $filePath)
           
           $updateContent = Get-Content -Path $filePath | Out-String
diff --git a/images/hull-integration/installation.yaml b/images/hull-integration/installation.yaml
@@ -0,0 +1,52 @@
+{{- with  (index $.Values "hull").config.general.data.installation }}
+{{- $configScope := . -}}
+{{- $configScopeEndpoints := dict -}}
+{{- if hasKey . "endpoints" -}}
+    {{- $configScopeEndpoints = .endpoints -}}
+{{- end -}}
+{{- range $path, $_ := $.Files.Glob "files/hull-vidispine-addon/installation/endpoints/*.yaml" -}}
+    {{- $configScopeEndpoints = mergeOverwrite $configScopeEndpoints (dict (base $path | trimSuffix ".yaml") (fromYaml ($.Files.Get $path))) -}}
+{{- end -}}
+{{- range $endpoint, $endpointval := $configScopeEndpoints -}}
+    {{- $endpointScope := $endpointval -}}
+    {{- if $endpointval.endpoint -}}
+        {{- $subresources := dict -}}
+        {{- if hasKey $endpointval "subresources" -}}
+            {{- $subresources = $endpointval.subresources -}}
+        {{- end -}}
+        {{- range $path, $_ :=  $.Files.Glob (printf "%s/%s/%s" "files/hull-vidispine-addon/installation/endpoints" $endpoint "*.yaml") -}}
+            {{- $subresources = mergeOverwrite $subresources (dict (base $path | trimSuffix ".yaml") (fromYaml ($.Files.Get $path))) -}}
+        {{- end -}}
+        {{- range $subresource, $subresourceval := $subresources }}
+            {{- $subresourceScope := $subresourceval -}}
+            {{- $entities := dict  -}}
+            {{- if hasKey $subresourceval "entities" -}}
+                {{- $entities = $subresourceval.entities -}}
+            {{- else -}}
+              {{- $u := set $subresourceval "entities" dict }}
+            {{- end -}}
+            {{- range $path, $_ :=  $.Files.Glob (printf "%s/%s/%s/%s" "files/hull-vidispine-addon/installation/endpoints" $endpoint $subresource "*.yaml") -}}
+                {{- $entities = mergeOverwrite $entities (dict (base $path | trimSuffix ".yaml") (fromYaml ($.Files.Get $path))) -}}
+            {{- end -}}
+            {{- range $entity, $entityval := $entities }}
+                {{- $mergedDict := dict -}}
+                {{- if hasKey $subresourceval "_DEFAULTS_" -}}
+                    {{- $mergedDict = deepCopy $subresourceval._DEFAULTS_ -}}
+                {{- end -}}
+                {{- $t := mergeOverwrite $mergedDict $entityval -}}
+                {{- $z := set (index $.Values "hull").config.general.data.installation "endpoints" $configScopeEndpoints }}
+                {{- if typeIs "map[string]interface {}" $mergedDict -}}
+                    {{- if hasKey $mergedDict "config" -}}
+                        {{- $configDict := $mergedDict.config -}}
+                    {{- end }}
+                {{- end }}
+                {{- $t1 := set $subresourceval.entities $entity $mergedDict -}}
+            {{- end }}
+        {{- end }}
+    {{- else -}}
+        {{- $configScopeEndpoints = unset $configScopeEndpoints $endpoint -}}
+    {{- end }}
+{{- end }}
+{{- $_ := include "hull.util.transformation" (dict "PARENT_CONTEXT" $ "SOURCE" $configScope "CALLER" nil "CALLER_KEY" nil "SOURCE_PATH" list) -}}
+{{- toYaml $configScope -}}
+{{ end }}
