Skip to content

Correctly handle blob MD5 sums in custom blob resource, need to be base64-encoded #3718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomas11 merged 2 commits into from
Nov 20, 2024
Merged

Correctly handle blob MD5 sums in custom blob resource, need to be base64-encoded #3718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f70285
Correctly handle blob MD5 sums in custom blob resource, need to be ba…
thomas11 Nov 20, 2024
29dcfee
regenerate
thomas11 Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions provider/cmd/pulumi-resource-azure-native/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627326,7 +627326,7 @@
]
},
"azure-native:datamigration:ServiceTask": {
"description": "A task resource\nAzure REST API version: 2021-06-30.\n\nOther available API versions: 2022-03-30-preview, 2023-07-15-preview.\n\n{{% examples %}}\n## Example Usage\n{{% example %}}\n### Tasks_CreateOrUpdate\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AzureNative = Pulumi.AzureNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var serviceTask = new AzureNative.DataMigration.ServiceTask(\"serviceTask\", new()\n {\n GroupName = \"DmsSdkRg\",\n Properties = \n {\n { \"input\", new AzureNative.DataMigration.Inputs.MongoDbConnectionInfoArgs\n {\n ServerVersion = \"NA\",\n } },\n { \"taskType\", \"Service.Check.OCI\" },\n },\n ServiceName = \"DmsSdkService\",\n TaskName = \"DmsSdkTask\",\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\tdatamigration \"github.com/pulumi/pulumi-azure-native-sdk/datamigration/v2\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\nfunc main() {\npulumi.Run(func(ctx *pulumi.Context) error {\n_, err := datamigration.NewServiceTask(ctx, \"serviceTask\", \u0026datamigration.ServiceTaskArgs{\nGroupName: pulumi.String(\"DmsSdkRg\"),\nProperties: interface{}{\nInput: \u0026datamigration.MongoDbConnectionInfoArgs{\nServerVersion: \"NA\",\n},\nTaskType: pulumi.String(\"Service.Check.OCI\"),\n},\nServiceName: pulumi.String(\"DmsSdkService\"),\nTaskName: pulumi.String(\"DmsSdkTask\"),\n})\nif err != nil {\nreturn err\n}\nreturn nil\n})\n}\n\n```\n\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.azurenative.datamigration.ServiceTask;\nimport com.pulumi.azurenative.datamigration.ServiceTaskArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var serviceTask = new ServiceTask(\"serviceTask\", ServiceTaskArgs.builder()\n .groupName(\"DmsSdkRg\")\n .properties(ConnectToMongoDbTaskPropertiesArgs.builder()\n .input(MongoDbConnectionInfoArgs.builder()\n .serverVersion(\"NA\")\n .build())\n .taskType(\"Service.Check.OCI\")\n .build())\n .serviceName(\"DmsSdkService\")\n .taskName(\"DmsSdkTask\")\n .build());\n\n }\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as azure_native from \"@pulumi/azure-native\";\n\nconst serviceTask = new azure_native.datamigration.ServiceTask(\"serviceTask\", {\n groupName: \"DmsSdkRg\",\n properties: {\n input: {\n serverVersion: \"NA\",\n },\n taskType: \"Service.Check.OCI\",\n },\n serviceName: \"DmsSdkService\",\n taskName: \"DmsSdkTask\",\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_azure_native as azure_native\n\nservice_task = azure_native.datamigration.ServiceTask(\"serviceTask\",\n group_name=\"DmsSdkRg\",\n properties={\n \"input\": {\n \"server_version\": \"NA\",\n },\n \"task_type\": \"Service.Check.OCI\",\n },\n service_name=\"DmsSdkService\",\n task_name=\"DmsSdkTask\")\n\n```\n\n```yaml\nresources:\n serviceTask:\n type: azure-native:datamigration:ServiceTask\n properties:\n groupName: DmsSdkRg\n properties:\n input:\n serverVersion: NA\n taskType: Service.Check.OCI\n serviceName: DmsSdkService\n taskName: DmsSdkTask\n\n```\n\n{{% /example %}}\n{{% /examples %}}\n\n## Import\n\nAn existing resource can be imported using its type token, name, and identifier, e.g.\n\n```sh\n$ pulumi import azure-native:datamigration:ServiceTask DmsSdkTask /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/serviceTasks/{taskName} \n```\n",
"description": "A task resource\nAzure REST API version: 2021-06-30.\n\nOther available API versions: 2022-03-30-preview, 2023-07-15-preview.\n\n{{% examples %}}\n## Example Usage\n{{% example %}}\n### Tasks_CreateOrUpdate\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AzureNative = Pulumi.AzureNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var serviceTask = new AzureNative.DataMigration.ServiceTask(\"serviceTask\", new()\n {\n GroupName = \"DmsSdkRg\",\n Properties = \n {\n { \"input\", new AzureNative.DataMigration.Inputs.ConnectToSourcePostgreSqlSyncTaskInputArgs\n {\n ServerVersion = \"NA\",\n } },\n { \"taskType\", \"Service.Check.OCI\" },\n },\n ServiceName = \"DmsSdkService\",\n TaskName = \"DmsSdkTask\",\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\tdatamigration \"github.com/pulumi/pulumi-azure-native-sdk/datamigration/v2\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\nfunc main() {\npulumi.Run(func(ctx *pulumi.Context) error {\n_, err := datamigration.NewServiceTask(ctx, \"serviceTask\", \u0026datamigration.ServiceTaskArgs{\nGroupName: pulumi.String(\"DmsSdkRg\"),\nProperties: interface{}{\nInput: \u0026datamigration.MongoDbConnectionInfoArgs{\nServerVersion: \"NA\",\n},\nTaskType: pulumi.String(\"Service.Check.OCI\"),\n},\nServiceName: pulumi.String(\"DmsSdkService\"),\nTaskName: pulumi.String(\"DmsSdkTask\"),\n})\nif err != nil {\nreturn err\n}\nreturn nil\n})\n}\n\n```\n\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.azurenative.datamigration.ServiceTask;\nimport com.pulumi.azurenative.datamigration.ServiceTaskArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var serviceTask = new ServiceTask(\"serviceTask\", ServiceTaskArgs.builder()\n .groupName(\"DmsSdkRg\")\n .properties(ConnectToMongoDbTaskPropertiesArgs.builder()\n .input(MongoDbConnectionInfoArgs.builder()\n .serverVersion(\"NA\")\n .build())\n .taskType(\"Service.Check.OCI\")\n .build())\n .serviceName(\"DmsSdkService\")\n .taskName(\"DmsSdkTask\")\n .build());\n\n }\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as azure_native from \"@pulumi/azure-native\";\n\nconst serviceTask = new azure_native.datamigration.ServiceTask(\"serviceTask\", {\n groupName: \"DmsSdkRg\",\n properties: {\n input: {\n serverVersion: \"NA\",\n },\n taskType: \"Service.Check.OCI\",\n },\n serviceName: \"DmsSdkService\",\n taskName: \"DmsSdkTask\",\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_azure_native as azure_native\n\nservice_task = azure_native.datamigration.ServiceTask(\"serviceTask\",\n group_name=\"DmsSdkRg\",\n properties={\n \"input\": {\n \"server_version\": \"NA\",\n },\n \"task_type\": \"Service.Check.OCI\",\n },\n service_name=\"DmsSdkService\",\n task_name=\"DmsSdkTask\")\n\n```\n\n```yaml\nresources:\n serviceTask:\n type: azure-native:datamigration:ServiceTask\n properties:\n groupName: DmsSdkRg\n properties:\n input:\n serverVersion: NA\n taskType: Service.Check.OCI\n serviceName: DmsSdkService\n taskName: DmsSdkTask\n\n```\n\n{{% /example %}}\n{{% /examples %}}\n\n## Import\n\nAn existing resource can be imported using its type token, name, and identifier, e.g.\n\n```sh\n$ pulumi import azure-native:datamigration:ServiceTask DmsSdkTask /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/serviceTasks/{taskName} \n```\n",
"properties": {
"etag": {
"type": "string",
Expand Down Expand Up @@ -797243,7 +797243,7 @@
},
"contentMd5": {
"type": "string",
"description": "The MD5 sum of the blob contents. Cannot be defined if blob type is Append.",
"description": "The MD5 sum of the blob contents, base64-encoded. Cannot be defined if blob type is Append.",
"willReplaceOnChanges": true
},
"contentType": {
Expand Down
2 changes: 1 addition & 1 deletion provider/pkg/gen/__snapshots__/gen_vnet_test.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24185,7 +24185,7 @@
"willReplaceOnChanges": true
},
"contentMd5": {
"description": "The MD5 sum of the blob contents. Cannot be defined if blob type is Append.",
"description": "The MD5 sum of the blob contents, base64-encoded. Cannot be defined if blob type is Append.",
"type": "string",
"willReplaceOnChanges": true
},
Expand Down
11 changes: 8 additions & 3 deletions provider/pkg/resources/customresources/custom_storage_azidentity.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ package customresources

import (
"context"
"encoding/base64"
"fmt"
"net/http"
neturl "net/url"
Expand Down Expand Up @@ -348,7 +349,7 @@ func getBlobSchema() *schema.ResourceSpec {
WillReplaceOnChanges: true,
},
contentMd5: {
Description: "The MD5 sum of the blob contents. Cannot be defined if blob type is Append.",
Description: "The MD5 sum of the blob contents, base64-encoded. Cannot be defined if blob type is Append.",
TypeSpec: schema.TypeSpec{Type: "string"},
WillReplaceOnChanges: true,
},
Expand Down Expand Up @@ -560,7 +561,11 @@ func (r *blob_azidentity) create(ctx context.Context, id string, properties reso

if properties[contentMd5].HasValue() {
md5 := properties[contentMd5].StringValue()
opts.HTTPHeaders.BlobContentMD5 = []byte(md5)
md5Bytes, err := base64.StdEncoding.DecodeString(md5)
if err != nil {
return nil, err
}
opts.HTTPHeaders.BlobContentMD5 = md5Bytes
}

input := []byte{}
Expand Down Expand Up @@ -706,7 +711,7 @@ func azblobToPulumiProperties(name, rg, account, container, azureResourceId stri
containerName: container,
blobName: name,
nameProp: name,
contentMd5: fmt.Sprintf("%x", props.ContentMD5), // the binary hash needs to be hex-encoded
contentMd5: base64.StdEncoding.EncodeToString(props.ContentMD5),
contentType: *props.ContentType,
metadata: props.Metadata,
typeProp: strings.TrimSuffix(string(*props.BlobType), "Blob"),
Expand Down
2 changes: 2 additions & 0 deletions provider/pkg/resources/customresources/custom_storage_azidentity_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package customresources

import (
"crypto/md5"
"encoding/base64"
"testing"

"github.com/Azure/azure-sdk-for-go/sdk/azcore/cloud"
Expand Down Expand Up @@ -151,6 +152,7 @@ func TestAzblobToPulumiProperties(t *testing.T) {
assert.Equal(t, "Block", pulumiBlob[typeProp])

assert.Contains(t, pulumiBlob, contentMd5)
assert.Equal(t, base64.StdEncoding.EncodeToString(azblob.ContentMD5), pulumiBlob[contentMd5])

assert.Contains(t, pulumiBlob, contentType)
assert.Equal(t, "text/plain", pulumiBlob[contentType])
Expand Down
2 changes: 1 addition & 1 deletion sdk/dotnet/Storage/Blob.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ public sealed class BlobArgs : global::Pulumi.ResourceArgs
public Input<string> ContainerName { get; set; } = null!;

/// <summary>
/// The MD5 sum of the blob contents. Cannot be defined if blob type is Append.
/// The MD5 sum of the blob contents, base64-encoded. Cannot be defined if blob type is Append.
/// </summary>
[Input("contentMd5")]
public Input<string>? ContentMd5 { get; set; }
Expand Down
2 changes: 1 addition & 1 deletion sdk/nodejs/storage/blob.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ export interface BlobArgs {
*/
containerName: pulumi.Input<string>;
/**
* The MD5 sum of the blob contents. Cannot be defined if blob type is Append.
* The MD5 sum of the blob contents, base64-encoded. Cannot be defined if blob type is Append.
*/
contentMd5?: pulumi.Input<string>;
/**
Expand Down
6 changes: 3 additions & 3 deletions sdk/python/pulumi_azure_native/storage/blob.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def __init__(__self__, *,
:param pulumi.Input[str] resource_group_name: The name of the resource group within the user's subscription.
:param pulumi.Input['BlobAccessTier'] access_tier: The access tier of the storage blob. Only supported for standard storage accounts, not premium.
:param pulumi.Input[str] blob_name: The name of the storage blob. Must be unique within the storage container the blob is located. If this property is not specified it will be set to the name of the resource.
:param pulumi.Input[str] content_md5: The MD5 sum of the blob contents. Cannot be defined if blob type is Append.
:param pulumi.Input[str] content_md5: The MD5 sum of the blob contents, base64-encoded. Cannot be defined if blob type is Append.
:param pulumi.Input[str] content_type: The content type of the storage blob. Defaults to `application/octet-stream`.
:param pulumi.Input[Mapping[str, pulumi.Input[str]]] metadata: A map of custom blob metadata.
:param pulumi.Input[Union[pulumi.Asset, pulumi.Archive]] source: An asset to copy to the blob contents. This field cannot be specified for Append blobs.
Expand Down Expand Up @@ -127,7 +127,7 @@ def blob_name(self, value: Optional[pulumi.Input[str]]):
@pulumi.getter(name="contentMd5")
def content_md5(self) -> Optional[pulumi.Input[str]]:
"""
The MD5 sum of the blob contents. Cannot be defined if blob type is Append.
The MD5 sum of the blob contents, base64-encoded. Cannot be defined if blob type is Append.
"""
return pulumi.get(self, "content_md5")

Expand Down Expand Up @@ -209,7 +209,7 @@ def __init__(__self__,
:param pulumi.Input[str] account_name: Specifies the storage account in which to create the storage container.
:param pulumi.Input[str] blob_name: The name of the storage blob. Must be unique within the storage container the blob is located. If this property is not specified it will be set to the name of the resource.
:param pulumi.Input[str] container_name: The name of the storage container in which this blob should be created.
:param pulumi.Input[str] content_md5: The MD5 sum of the blob contents. Cannot be defined if blob type is Append.
:param pulumi.Input[str] content_md5: The MD5 sum of the blob contents, base64-encoded. Cannot be defined if blob type is Append.
:param pulumi.Input[str] content_type: The content type of the storage blob. Defaults to `application/octet-stream`.
:param pulumi.Input[Mapping[str, pulumi.Input[str]]] metadata: A map of custom blob metadata.
:param pulumi.Input[str] resource_group_name: The name of the resource group within the user's subscription.
Expand Down