Skip to content
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.

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

Pass state back to the engine if Apply encountered an error 2 #2713

Merged
merged 2 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
51 changes: 51 additions & 0 deletions pkg/tests/schema_pulumi_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -189,3 +189,54 @@ func TestMakeTerraformResultNilVsEmptyMap(t *testing.T) {
assert.True(t, props["test"].DeepEquals(emptyMap))
})
}

func TestResourceInitFailure(t *testing.T) {
t.Parallel()

resMap := map[string]*schema.Resource{
"prov_test": {
Schema: map[string]*schema.Schema{
"test": {
Type: schema.TypeString,
Required: true,
},
},
CreateContext: func(ctx context.Context, rd *schema.ResourceData, i interface{}) diag.Diagnostics {
rd.SetId("1")
return diag.Errorf("INIT TEST ERROR")
},
},
}
prov := &schema.Provider{ResourcesMap: resMap}
bridgedProvider := pulcheck.BridgedProvider(t, "prov", prov)

pt := pulcheck.PulCheck(t, bridgedProvider, `
name: test
runtime: yaml
resources:
mainRes:
type: prov:index:Test
properties:
test: "hello"
`)

_, err := pt.CurrentStack().Up(pt.Context())
require.Error(t, err)
require.ErrorContains(t, err, "INIT TEST ERROR")

stack := pt.ExportStack(t)

data, err := stack.Deployment.MarshalJSON()
require.NoError(t, err)

var stateMap map[string]interface{}
err = json.Unmarshal(data, &stateMap)
require.NoError(t, err)

resourcesList := stateMap["resources"].([]interface{})
require.Len(t, resourcesList, 3)
mainResState := resourcesList[2].(map[string]interface{}) // stack, provider, resource
initErrors := mainResState["initErrors"].([]interface{})
require.Len(t, initErrors, 1)
require.Contains(t, initErrors[0], "INIT TEST ERROR")
}
45 changes: 23 additions & 22 deletions pkg/tfshim/sdk-v2/provider2.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ func (s *v2InstanceState2) Type() string {
}

func (s *v2InstanceState2) ID() string {
if s.stateValue.IsNull() {
return ""
}
id := s.stateValue.GetAttr("id")
if !id.IsKnown() {
return ""
Expand Down Expand Up @@ -347,15 +350,7 @@ func (p *planResourceChangeImpl) Apply(
maps.Copy(priv, diff.v2InstanceDiff.tf.Meta)
}

resp, err := p.server.ApplyResourceChange(ctx, t, ty, cfg, st, pl, priv, meta)
if err != nil {
return nil, err
}
return &v2InstanceState2{
resourceType: t,
stateValue: resp.stateValue,
meta: resp.meta,
}, nil
return p.server.ApplyResourceChange(ctx, t, ty, cfg, st, pl, priv, meta)
}

// This method is called to service `pulumi refresh` requests and maps naturally to the TF
Expand Down Expand Up @@ -629,7 +624,7 @@ func (s *grpcServer) ApplyResourceChange(
config, priorState, plannedState cty.Value,
plannedMeta map[string]interface{},
providerMeta *cty.Value,
) (*v2InstanceState2, error) {
) (shim.InstanceState, error) {
configVal, err := msgpack.Marshal(config, ty)
if err != nil {
return nil, err
Expand Down Expand Up @@ -662,25 +657,31 @@ func (s *grpcServer) ApplyResourceChange(
}
req.ProviderMeta = &tfprotov5.DynamicValue{MsgPack: providerMetaVal}
}
resp, err := s.gserver.ApplyResourceChange(ctx, req)
if err := handleDiagnostics(ctx, resp.Diagnostics, err); err != nil {
return nil, err
}
newState, err := msgpack.Unmarshal(resp.NewState.MsgPack, ty)
if err != nil {
return nil, err
}
resp, applyErr := s.gserver.ApplyResourceChange(ctx, req)
newState := cty.Value{}
var meta map[string]interface{}
if resp.Private != nil {
if err := json.Unmarshal(resp.Private, &meta); err != nil {
return nil, err
if resp != nil {
if resp.NewState != nil {
newState, err = msgpack.Unmarshal(resp.NewState.MsgPack, ty)
if err != nil {
return nil, err
}
}
if resp.Private != nil {
if err := json.Unmarshal(resp.Private, &meta); err != nil {
return nil, err
}
}
}
returnErr := handleDiagnostics(ctx, resp.Diagnostics, applyErr)
if newState.IsNull() {
return nil, returnErr
}
return &v2InstanceState2{
resourceType: typeName,
stateValue: newState,
meta: meta,
}, nil
}, returnErr
}

func (s *grpcServer) ReadResource(
Expand Down
37 changes: 37 additions & 0 deletions pkg/tfshim/sdk-v2/provider2_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -641,3 +641,40 @@ func (l *testLogger) Error(msg string) {
func (*testLogger) StatusUntyped() any {
return "?"
}

func TestInstanceStateId(t *testing.T) {
t.Parallel()

state := v2InstanceState2{
stateValue: cty.ObjectVal(map[string]cty.Value{
"id": cty.StringVal("1"),
}),
}
assert.Equal(t, "1", state.ID())

state.stateValue = cty.ObjectVal(map[string]cty.Value{
"id": cty.UnknownVal(cty.String),
})
assert.Equal(t, "", state.ID())

state.stateValue = cty.Value{}
assert.Equal(t, "", state.ID())
}

func TestInstanceStateObject(t *testing.T) {
t.Parallel()

state := v2InstanceState2{
stateValue: cty.ObjectVal(map[string]cty.Value{
"id": cty.StringVal("1"),
}),
}
actual, err := state.Object(nil)
require.NoError(t, err)
assert.Equal(t, map[string]interface{}{"id": "1"}, actual)

state.stateValue = cty.Value{}
actual, err = state.Object(nil)
require.NoError(t, err)
assert.Equal(t, map[string]interface{}(nil), actual)
}
Loading