|
| 1 | +package proto5server |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "fmt" |
| 6 | + "slices" |
| 7 | + "testing" |
| 8 | + |
| 9 | + "github.com/hashicorp/go-cty/cty/msgpack" |
| 10 | + "github.com/hashicorp/terraform-plugin-framework/hcl2shim" |
| 11 | + "github.com/hashicorp/terraform-plugin-framework/internal/fwserver" |
| 12 | + "github.com/hashicorp/terraform-plugin-framework/internal/testing/testprovider" |
| 13 | + "github.com/hashicorp/terraform-plugin-framework/list" |
| 14 | + "github.com/hashicorp/terraform-plugin-framework/resource" |
| 15 | + "github.com/hashicorp/terraform-plugin-go/tfprotov5" |
| 16 | + sdk "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" |
| 17 | + terraformsdk "github.com/hashicorp/terraform-plugin-sdk/v2/terraform" |
| 18 | +) |
| 19 | + |
| 20 | +// a resource type defined in SDKv2 |
| 21 | +var sdkResource sdk.Resource = sdk.Resource{ |
| 22 | + Schema: map[string]*sdk.Schema{ |
| 23 | + "id": &sdk.Schema{ |
| 24 | + Type: sdk.TypeString, |
| 25 | + }, |
| 26 | + "name": &sdk.Schema{ |
| 27 | + Type: sdk.TypeString, |
| 28 | + }, |
| 29 | + }, |
| 30 | +} |
| 31 | + |
| 32 | +func diagnosticResult(format string, args ...any) tfprotov5.ListResourceResult { |
| 33 | + return tfprotov5.ListResourceResult{ |
| 34 | + Diagnostics: []*tfprotov5.Diagnostic{ |
| 35 | + { |
| 36 | + Summary: fmt.Sprintf(format, args...), |
| 37 | + }, |
| 38 | + }, |
| 39 | + } |
| 40 | + |
| 41 | +} |
| 42 | +func listFunc(ctx context.Context, req list.ListRequest, stream *list.ListResultsStream) { |
| 43 | + sdkResource, ok := SDKResourceFromContext(ctx) |
| 44 | + if !ok { |
| 45 | + return |
| 46 | + } |
| 47 | + |
| 48 | + stream.Proto5Results = func(push func(tfprotov5.ListResourceResult) bool) { |
| 49 | + // From the resource type, we can obtain an initialized ResourceData value |
| 50 | + d := sdkResource.Data(&terraformsdk.InstanceState{ID: "#groot"}) |
| 51 | + |
| 52 | + // The initialized ResourceData value is schema-aware |
| 53 | + if err := d.Set("name", "Groot"); err != nil { |
| 54 | + push(diagnosticResult("Error setting `name`: %v", err)) |
| 55 | + return |
| 56 | + } |
| 57 | + |
| 58 | + if err := d.Set("nom", "groot"); err == nil { |
| 59 | + push(diagnosticResult("False negative outcome: `nom` is not a schema attribute")) |
| 60 | + return |
| 61 | + } |
| 62 | + |
| 63 | + displayName := "I am Groot" |
| 64 | + |
| 65 | + // Mimic SDK GRPCProviderServer.ReadResource ResourceData -> MsgPack |
| 66 | + state := d.State() |
| 67 | + if state == nil { |
| 68 | + push(diagnosticResult("Expected state to be non-nil")) |
| 69 | + return |
| 70 | + } |
| 71 | + |
| 72 | + schemaBlock := sdkResource.CoreConfigSchema() |
| 73 | + if schemaBlock == nil { |
| 74 | + push(diagnosticResult("Expected schemaBlock to be non-nil")) |
| 75 | + return |
| 76 | + } |
| 77 | + |
| 78 | + // We've copied hcl2shim wholesale for purposes of making the test pass |
| 79 | + newStateVal, err := hcl2shim.HCL2ValueFromFlatmap(state.Attributes, schemaBlock.ImpliedType()) |
| 80 | + if err != nil { |
| 81 | + push(diagnosticResult("Error converting state attributes to HCL2 value: %v", err)) |
| 82 | + return |
| 83 | + } |
| 84 | + |
| 85 | + // Think about this later |
| 86 | + // newStateVal = normalizeNullValues(newStateVal, stateVal, false) |
| 87 | + |
| 88 | + pack, err := msgpack.Marshal(newStateVal, schemaBlock.ImpliedType()) |
| 89 | + if err != nil { |
| 90 | + push(diagnosticResult("Error marshaling new state value to MsgPack: %v", err)) |
| 91 | + return |
| 92 | + } |
| 93 | + |
| 94 | + fmt.Printf("MsgPack: %s\n", pack) |
| 95 | + |
| 96 | + // Construct a tfprotov5.ListResourceResult |
| 97 | + listResult := tfprotov5.ListResourceResult{} |
| 98 | + listResult.Resource = &tfprotov5.DynamicValue{MsgPack: pack} |
| 99 | + listResult.DisplayName = displayName |
| 100 | + |
| 101 | + if !push(listResult) { |
| 102 | + return |
| 103 | + } |
| 104 | + } |
| 105 | +} |
| 106 | + |
| 107 | +func TestServerListResourceProto5ToProto5(t *testing.T) { |
| 108 | + t.Parallel() |
| 109 | + |
| 110 | + server := func(listResource func() list.ListResource) *Server { |
| 111 | + return &Server{ |
| 112 | + FrameworkServer: fwserver.Server{ |
| 113 | + Provider: &testprovider.Provider{ |
| 114 | + ListResourcesMethod: func(ctx context.Context) []func() list.ListResource { |
| 115 | + return []func() list.ListResource{listResource} |
| 116 | + }, |
| 117 | + }, |
| 118 | + }, |
| 119 | + } |
| 120 | + } |
| 121 | + |
| 122 | + listResource := func() list.ListResource { |
| 123 | + return &testprovider.ListResource{ |
| 124 | + ListMethod: listFunc, |
| 125 | + MetadataMethod: func(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) { |
| 126 | + resp.TypeName = "test_resource" |
| 127 | + }, |
| 128 | + } |
| 129 | + } |
| 130 | + aServer := server(listResource) |
| 131 | + |
| 132 | + ctx := context.Background() |
| 133 | + ctx = NewContextWithSDKResource(ctx, &sdkResource) |
| 134 | + req := &tfprotov5.ListResourceRequest{ |
| 135 | + TypeName: "test_resource", |
| 136 | + } |
| 137 | + |
| 138 | + stream, err := aServer.ListResource(ctx, req) |
| 139 | + if err != nil { |
| 140 | + t.Fatalf("unexpected error returned from ListResource: %v", err) |
| 141 | + } |
| 142 | + |
| 143 | + values := slices.Collect(stream.Results) |
| 144 | + if len(values) > 0 { |
| 145 | + if len(values[0].Diagnostics) > 0 { |
| 146 | + for _, diag := range values[0].Diagnostics { |
| 147 | + t.Logf("unexpected diagnostic returned from ListResource: %v", diag) |
| 148 | + } |
| 149 | + t.FailNow() |
| 150 | + } |
| 151 | + } |
| 152 | + |
| 153 | + if len(values) != 1 { |
| 154 | + t.Fatalf("expected 1 list result; got %d list results", len(values)) |
| 155 | + } |
| 156 | + |
| 157 | + value := values[0] |
| 158 | + if value.DisplayName != "I am Groot" { |
| 159 | + t.Fatalf("I am not Groot") |
| 160 | + } |
| 161 | +} |
0 commit comments