如何在Go单元测试中模拟Pulumi资源？

huangapple
go评论120阅读模式
英文:

How to Mock Pulumi Resources in Go Unit Tests?

问题

我有一个函数，它接受一个 AWS OpenIdConnectProvider Pulumi 资源作为输入，并创建一个带有附加的 AssumeRolePolicy 的 IAM 角色，其中包含来自该 OIDC 提供程序的信息。

问题是：我正在尝试为这个函数编写一个测试，并模拟一个 OIDC 提供程序作为函数调用的输入。我在如何正确模拟这个过程中遇到了困难，目前看起来模拟的数据并不像我期望的那样显示。

看起来我没有正确使用模拟，但我参考了这里的示例（https://github.com/pulumi/examples/blob/master/testing-unit-go/main_test.go）。

更多文档请参考这里（https://www.pulumi.com/docs/guides/testing/unit/）。

  1. package myPkg
  3. import (
  4.    "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
  5.    "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
  6. )
  8. func CreateMyCustomRole(ctx *pulumi.Context, name string, oidcProvider *iam.OpenIdConnectProvider, opts ...pulumi.ResourceOption) (*iam.Role, error) {
  9. 	role := &iam.Role{}
  11. 	componentURN := fmt.Sprintf("%s-custom-role", name)
  13. 	err := ctx.RegisterComponentResource("pkg:aws:MyCustomRole", componentURN, role, opts...)
  14. 	if err != nil {
  15. 		return nil, err
  16. 	}
  18.     url := oidc.Url.ApplyT(func(s string) string {
  19. 		return fmt.Sprint(strings.ReplaceAll(s, "https://", ""), ":sub")
  20. 	}).(pulumi.StringOutput)
  22. 	assumeRolePolicy := pulumi.Sprintf(`{
  23. 			"Version": "2012-10-17",
  24. 			"Statement": [{
  25. 				"Effect": "Allow",
  26. 				"Principal": { "Federated": "%s" },
  27. 				"Action": "sts:AssumeRoleWithWebIdentity",
  28. 				"Condition": {
  29. 					"StringEquals": {
  30. 						"%s": [
  31. 							"system:serviceaccount:kube-system:*",
  32. 							"system:serviceaccount:kube-system:cluster-autoscaler"
  33. 						]
  34.             		}
  35. 				}
  36. 			}]
  37. 		}`, oidcProvider.Arn, url)
  39. 	roleURN := fmt.Sprintf("%s-custom-role", name)
  41. 	role, err = iam.NewRole(ctx, roleURN, &iam.RoleArgs{
  42. 			Name:             pulumi.String(roleURN),
  43. 			Description:      pulumi.String("Create Custom Role"),
  44. 			AssumeRolePolicy: assumeRolePolicy,
  45. 			Tags:             pulumi.ToStringMap(map[string]string{"project": "test"}),
  46. 		})
  47. 	if err != nil {
  48. 		return nil, err
  49. 	}
  51. 	return role, nil
  52. }
  1. package myPkg
  3. import (
  4. 	"sync"
  5. 	"testing"
  7. 	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
  8. 	"github.com/pulumi/pulumi/sdk/v3/go/common/resource"
  9. 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
  10. 	"github.com/stretchr/testify/assert"
  11. )
  13. type mocks int
  15. func (mocks) NewResource(args pulumi.MockResourceArgs) (string, resource.PropertyMap, error) {
  16. 	return args.Name + "_id", args.Inputs, nil
  17. }
  19. func (mocks) Call(args pulumi.MockCallArgs) (resource.PropertyMap, error) {
  20. 	outputs := map[string]interface{}{}
  21. 	if args.Token == "aws:iam/getOpenidConnectProvider:getOpenidConnectProvider" {
  22. 		outputs["arn"] = "arn:aws:iam::123:oidc-provider/oidc.eks.us-west-2.amazonaws.com/id/abc"
  23. 		outputs["id"] = "abc"
  24. 		outputs["url"] = "https://someurl"
  25. 	}
  26. 	return resource.NewPropertyMapFromMap(outputs), nil
  27. }
  29. func TestCreateMyCustomRole(t *testing.T) {
  30. 	err := pulumi.RunErr(func(ctx *pulumi.Context) error {
  32. 		// 获取模拟的 OIDC 提供程序，用作 CreateDefaultAutoscalerRole 的输入
  33. 		oidc, err := iam.GetOpenIdConnectProvider(ctx, "get-test-oidc-provider", pulumi.ID("abc"), &iam.OpenIdConnectProviderState{})
  34. 		assert.NoError(t, err)
  36. 		infra, err := CreateMyCustomRole(ctx, "role1", oidc)
  37. 		assert.NoError(t, err)
  39. 		var wg sync.WaitGroup
  40. 		wg.Add(1)
  42. 		// 检查1：Assume Role Policy 是否正确格式化
  43. 		pulumi.All(infra.URN(), infra.AssumeRolePolicy).ApplyT(func(all []interface{}) error {
  44. 			urn := all[0].(pulumi.URN)
  45. 			assumeRolePolicy := all[1].(string)
  47. 			assert.Equal(t, `{
  48. 			"Version": "2012-10-17",
  49. 			"Statement": [{
  50. 				"Effect": "Allow",
  51. 				"Principal": { "Federated": "arn:aws:iam::123:oidc-provider/oidc.eks.us-west-2.amazonaws.com/id/abc" },
  52. 				"Action": "sts:AssumeRoleWithWebIdentity",
  53. 				"Condition": {
  54. 					"StringEquals": {
  55. 						"someurl:sub": [
  56. 							"system:serviceaccount:kube-system:*",
  57. 							"system:serviceaccount:kube-system:cluster-autoscaler"
  58. 						]
  59.             		}
  60. 				}
  61. 			}]
  62. 		}`, assumeRolePolicy)
  64. 			wg.Done()
  65. 			return nil
  66. 		})
  68. 		wg.Wait()
  69. 		return nil
  70. 	}, pulumi.WithMocks("project", "stack", mocks(0)))
  71. 	assert.NoError(t, err)
  72. }
  74. Output
  1.     	            	Diff:
  2. --- Expected
  3. +++ Actual
  4. @@ -4,3 +4,3 @@
  5. "Effect": "Allow",
  6. -				"Principal": { "Federated": "arn:aws:iam::123:oidc-provider/oidc.eks.us-west-2.amazonaws.com/id/abc" },
  7. +				"Principal": { "Federated": "" },
  8. "Action": "sts:AssumeRoleWithWebIdentity",
  9. @@ -8,3 +8,3 @@
  10. "StringEquals": {
  11. -						"someurl:sub": [
  12. +						":sub": [
  13. "system:serviceaccount:kube-system:*",
  14. "system:serviceaccount:kube-system:cluster-autoscaler"
  15. Test:       	TestCreateMyCustomRole
  2. <details>
  3. <summary>英文:</summary>
  4. I have a function that takes an input of an AWS OpenIdConnectProvider Pulumi Resource and creates a IAM Role with an AssumeRolePolicy attached that contains info from that OIDC provider. 
  5. **The Problem:** I am trying to write a test for this function and mock out a OIDC provider to feed in as input for the function call. I&#39;m having trouble understanding how to properly mock this so that the test output shows what I expect, currently it appears that the mocked data isn&#39;t coming up like I&#39;d expect. 
  6. It seems like I&#39;m not using the mock correctly, but I went off the [example here](https://github.com/pulumi/examples/blob/master/testing-unit-go/main_test.go)
  7. [Further Docs here](https://www.pulumi.com/docs/guides/testing/unit/)
  8. ```go
  9. package myPkg
  10. import (
  11. &quot;github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam&quot;
  12. &quot;github.com/pulumi/pulumi/sdk/v3/go/pulumi&quot;
  13. )
  14. func CreateMyCustomRole(ctx *pulumi.Context, name string, oidcProvider *iam.OpenIdConnectProvider, opts ...pulumi.ResourceOption) (*iam.Role, error) {
  15. role := &amp;iam.Role{}
  16. componentURN := fmt.Sprintf(&quot;%s-custom-role&quot;, name)
  17. err := ctx.RegisterComponentResource(&quot;pkg:aws:MyCustomRole&quot;, componentURN, role, opts...)
  18. if err != nil {
  19. return nil, err
  20. }
  21. url := oidc.Url.ApplyT(func(s string) string {
  22. return fmt.Sprint(strings.ReplaceAll(s, &quot;https://&quot;, &quot;&quot;), &quot;:sub&quot;)
  23. }).(pulumi.StringOutput)
  24. assumeRolePolicy := pulumi.Sprintf(`{
  25. &quot;Version&quot;: &quot;2012-10-17&quot;,
  26. &quot;Statement&quot;: [{
  27. &quot;Effect&quot;: &quot;Allow&quot;,
  28. &quot;Principal&quot;: { &quot;Federated&quot;: &quot;%s&quot; },
  29. &quot;Action&quot;: &quot;sts:AssumeRoleWithWebIdentity&quot;,
  30. &quot;Condition&quot;: {
  31. &quot;StringEquals&quot;: {
  32. &quot;%s&quot;: [
  33. &quot;system:serviceaccount:kube-system:*&quot;,
  34. &quot;system:serviceaccount:kube-system:cluster-autoscaler&quot;
  35. ]
  36. }
  37. }
  38. }]
  39. }`, oidcProvider.Arn, url)
  40. roleURN := fmt.Sprintf(&quot;%s-custom-role&quot;, name)
  41. role, err = iam.NewRole(ctx, roleURN, &amp;iam.RoleArgs{
  42. Name:             pulumi.String(roleURN),
  43. Description:      pulumi.String(&quot;Create Custom Role&quot;),
  44. AssumeRolePolicy: assumeRolePolicy,
  45. Tags:             pulumi.ToStringMap(map[string]string{&quot;project&quot;: &quot;test&quot;}),
  46. })
  47. if err != nil {
  48. return nil, err
  49. }
  50. return role, nil
  51. }
  1. package myPkg
  3. import (
  4. 	&quot;sync&quot;
  5. 	&quot;testing&quot;
  7. 	&quot;github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam&quot;
  8. 	&quot;github.com/pulumi/pulumi/sdk/v3/go/common/resource&quot;
  9. 	&quot;github.com/pulumi/pulumi/sdk/v3/go/pulumi&quot;
  10. 	&quot;github.com/stretchr/testify/assert&quot;
  11. )
  13. type mocks int
  15. func (mocks) NewResource(args pulumi.MockResourceArgs) (string, resource.PropertyMap, error) {
  16. 	return args.Name + &quot;_id&quot;, args.Inputs, nil
  17. }
  19. func (mocks) Call(args pulumi.MockCallArgs) (resource.PropertyMap, error) {
  20. 	outputs := map[string]interface{}{}
  21. 	if args.Token == &quot;aws:iam/getOpenidConnectProvider:getOpenidConnectProvider&quot; {
  22. 		outputs[&quot;arn&quot;] = &quot;arn:aws:iam::123:oidc-provider/oidc.eks.us-west-2.amazonaws.com/id/abc&quot;
  23. 		outputs[&quot;id&quot;] = &quot;abc&quot;
  24. 		outputs[&quot;url&quot;] = &quot;https://someurl&quot;
  25. 	}
  26. 	return resource.NewPropertyMapFromMap(outputs), nil
  27. }
  29. func TestCreateMyCustomRole(t *testing.T) {
  30. 	err := pulumi.RunErr(func(ctx *pulumi.Context) error {
  32. 		// Gets the mocked OIDC provider to use as input for the CreateDefaultAutoscalerRole
  33. 		oidc, err := iam.GetOpenIdConnectProvider(ctx, &quot;get-test-oidc-provider&quot;, pulumi.ID(&quot;abc&quot;), &amp;iam.OpenIdConnectProviderState{})
  34. 		assert.NoError(t, err)
  36. 		infra, err := CreateMyCustomRole(ctx, &quot;role1&quot;, oidc})
  37. 		assert.NoError(t, err)
  39. 		var wg sync.WaitGroup
  40. 		wg.Add(1)
  42. 		// check 1: Assume Role Policy is formatted correctly
  43. 		pulumi.All(infra.URN(), infra.AssumeRolePolicy).ApplyT(func(all []interface{}) error {
  44. 			urn := all[0].(pulumi.URN)
  45. 			assumeRolePolicy := all[1].(string)
  47. 			assert.Equal(t, `{
  48. 			&quot;Version&quot;: &quot;2012-10-17&quot;,
  49. 			&quot;Statement&quot;: [{
  50. 				&quot;Effect&quot;: &quot;Allow&quot;,
  51. 				&quot;Principal&quot;: { &quot;Federated&quot;: &quot;arn:aws:iam::123:oidc-provider/oidc.eks.us-west-2.amazonaws.com/id/abc&quot; },
  52. 				&quot;Action&quot;: &quot;sts:AssumeRoleWithWebIdentity&quot;,
  53. 				&quot;Condition&quot;: {
  54. 					&quot;StringEquals&quot;: {
  55. 						&quot;someurl:sub&quot;: [
  56. 							&quot;system:serviceaccount:kube-system:*&quot;,
  57. 							&quot;system:serviceaccount:kube-system:cluster-autoscaler&quot;
  58. 						]
  59. 					}
  60.             	}
  61. 			}]
  62. 		}`, assumeRolePolicy)
  64. 			wg.Done()
  65. 			return nil
  66. 		})
  68. 		wg.Wait()
  69. 		return nil
  70. 	}, pulumi.WithMocks(&quot;project&quot;, &quot;stack&quot;, mocks(0)))
  71. 	assert.NoError(t, err)
  72. }
  74. Output
  1.     	            	Diff:
  2. --- Expected
  3. +++ Actual
  4. @@ -4,3 +4,3 @@
  5. &quot;Effect&quot;: &quot;Allow&quot;,
  6. -				&quot;Principal&quot;: { &quot;Federated&quot;: &quot;arn:aws:iam::123:oidc-provider/oidc.eks.us-west-2.amazonaws.com/id/abc&quot; },
  7. +				&quot;Principal&quot;: { &quot;Federated&quot;: &quot;&quot; },
  8. &quot;Action&quot;: &quot;sts:AssumeRoleWithWebIdentity&quot;,
  9. @@ -8,3 +8,3 @@
  10. &quot;StringEquals&quot;: {
  11. -						&quot;someurl:sub&quot;: [
  12. +						&quot;:sub&quot;: [
  13. &quot;system:serviceaccount:kube-system:*&quot;,
  14. Test:       	TestCreateMyCustomRole
  2. </details>
  3. # 答案1
  4. **得分**: 1
  5. 原来我在使用`NewResource`时弄错了。
  6. 当在测试函数中调用`GetOpenIdConnectProvider`时，它会读取一个资源并创建一个新的资源输出，从而触发对`mocks.NewResource`的调用。
  7. 修复的方法是在`NewResource`函数调用中为`GetOpenIdConnectProvider`返回的资源类型`openIdConnectProvider`定义一个if语句，并使用模拟的输出。
  8. ```go
  9. func (mocks) NewResource(args pulumi.MockResourceArgs) (string, resource.PropertyMap, error) {
  10. pulumi.Printf(args.TypeToken)
  11. outputs := args.Inputs.Mappable()
  12. if args.TypeToken == "aws:iam/openIdConnectProvider:OpenIdConnectProvider" {
  13. outputs["arn"] = "arn:aws:iam::123:oidc-provider/oidc.eks.us-west-2.amazonaws.com/id/abc"
  14. outputs["id"] = "abc"
  15. outputs["url"] = "https://someurl"
  16. }
  17. return args.Name + "_id", resource.NewPropertyMapFromMap(outputs), nil
  18. }
  19. func (mocks) Call(args pulumi.MockCallArgs) (resource.PropertyMap, error) {
  20. outputs := map[string]interface{}{}
  21. return resource.NewPropertyMapFromMap(outputs), nil
  22. }

在下面的代码片段中，我更改了assert，以便它失败并显示对NewResource进行的更改后的差异。

  1. Diff:
  2. --- Expected
  3. +++ Actual
  4. @@ -8,3 +8,3 @@
  5. "StringEquals": {
  6. -                                    "b:sub": [
  7. +                                    "someurl:sub": [
  8. "system:serviceaccount:kube-system:*",
英文:

Turns out I was using the NewResource wrong.

When GetOpenIdConnectProvider is called in the test function it goes to read a resource and create a new resource output which triggers the call to mocks.NewResource

The fix was to instead define an if statement for the resource type returned by the GetOpenIdConnectProvider openIdConnectProviderin the NewResource function call with the mocked outputs.

  1. func (mocks) NewResource(args pulumi.MockResourceArgs) (string, resource.PropertyMap, error) {
  2. 	pulumi.Printf(args.TypeToken)
  3. 	outputs := args.Inputs.Mappable()
  4. 	if args.TypeToken == &quot;aws:iam/openIdConnectProvider:OpenIdConnectProvider&quot; {
  5. 		outputs[&quot;arn&quot;] = &quot;arn:aws:iam::123:oidc-provider/oidc.eks.us-west-2.amazonaws.com/id/abc&quot;
  6. 		outputs[&quot;id&quot;] = &quot;abc&quot;
  7. 		outputs[&quot;url&quot;] = &quot;https://someurl&quot;
  8. 	}
  9. 	return args.Name + &quot;_id&quot;, resource.NewPropertyMapFromMap(outputs), nil
  10. }
  12. func (mocks) Call(args pulumi.MockCallArgs) (resource.PropertyMap, error) {
  13.     outputs := map[string]interface{}{}
  14.     return resource.NewPropertyMapFromMap(outputs), nil
  15. }

Is this below code snippet I changed the assert so that it fails to show what the diff now looks like with the changes made to NewResource above

  1. Diff:
  2. --- Expected
  3. +++ Actual
  4. @@ -8,3 +8,3 @@
  5. &quot;StringEquals&quot;: {
  6. -						&quot;b:sub&quot;: [
  7. +						&quot;someurl:sub&quot;: [
  8. &quot;system:serviceaccount:kube-system:*&quot;,

huangapple
  • 本文由 发表于 2023年4月14日 03:31:39
  • 转载请务必保留本文链接：https://go.coder-hub.com/76009185.html
  • amazon-web-services
  • go
  • mocking
  • pulumi
  • unit-testing
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定