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.

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

Update provider functions testing docs to help users avoid nil pointer error #940

Merged
merged 8 commits into from
Mar 1, 2024
Merged

Update provider functions testing docs to help users avoid nil pointer error #940

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4f32cd1
Fix capitalisation
SarahFrench Feb 29, 2024
72111af
Update example test to mitigate nil pointer error
SarahFrench Feb 29, 2024
920f132
Update website/docs/plugin/framework/functions/testing.mdx
SarahFrench Mar 1, 2024
298feee
Update website/docs/plugin/framework/functions/testing.mdx
SarahFrench Mar 1, 2024
83cca6f
Update website/docs/plugin/framework/functions/testing.mdx
SarahFrench Mar 1, 2024
7693acb
Update website/docs/plugin/framework/functions/testing.mdx
SarahFrench Mar 1, 2024
6b463a1
Update website/docs/plugin/framework/functions/testing.mdx
SarahFrench Mar 1, 2024
595d4e7
Merge branch 'main' into provider-functions-test-docs-fix
bflad Mar 1, 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
20 changes: 11 additions & 9 deletions website/docs/plugin/framework/functions/testing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,9 @@ func TestEchoFunctionRun(t *testing.T) {
// this test case shows how the function would be expected to behave.
"null": {
request: function.RunRequest{
Arguments: function.NewArgumentsData(types.StringNull()),
Arguments: function.NewArgumentsData([]attr.Value{types.StringNull()}),
},
Expected: function.RunResponse{
expected: function.RunResponse{
Result: function.NewResultData(types.StringNull()),
},
},
Expand All @@ -181,17 +181,17 @@ func TestEchoFunctionRun(t *testing.T) {
// this test case shows how the function would be expected to behave.
"unknown": {
request: function.RunRequest{
Arguments: function.NewArgumentsData(types.StringUnknown()),
Arguments: function.NewArgumentsData([]attr.Value{types.StringUnknown()}),
},
Expected: function.RunResponse{
expected: function.RunResponse{
Result: function.NewResultData(types.StringUnknown()),
},
},
"value-valid": {
request: function.RunRequest{
Arguments: function.NewArgumentsData(types.StringValue("test-value")),
Arguments: function.NewArgumentsData([]attr.Value{types.StringValue("test-value")}),
},
Expected: function.RunResponse{
expected: function.RunResponse{
Result: function.NewResultData(types.StringValue("test-value")),
},
},
Expand All @@ -200,9 +200,9 @@ func TestEchoFunctionRun(t *testing.T) {
// it did.
"value-invalid": {
request: function.RunRequest{
Arguments: function.NewArgumentsData(types.StringValue()),
Arguments: function.NewArgumentsData([]attr.Value{types.StringValue("")}),
},
Expected: function.RunResponse{
expected: function.RunResponse{
Error: function.NewArgumentFuncError(0, "error summary: error detail"),
Result: function.NewResultData(types.StringUnknown()),
},
Expand All @@ -215,7 +215,9 @@ func TestEchoFunctionRun(t *testing.T) {
t.Run(name, func(t *testing.T) {
t.Parallel()

got := function.RunResponse{}
got := function.RunResponse{
Result: function.NewResultData(types.StringUnknown()),
}

provider.EchoFunction{}.Run(context.Background(), testCase.request, &got)

Expand Down
Loading