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

(fix) fix potential nil pointer when using namespace data source #9

Closed
wants to merge 2 commits into from
Closed
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
45 changes: 33 additions & 12 deletions internal/provider/helpers.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,45 +5,66 @@ import (
"fmt"

"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/diag"
"github.com/hashicorp/terraform-plugin-framework/path"
"github.com/hashicorp/terraform-plugin-framework/resource"
client "github.com/pomerium/enterprise-client-go"
)

// ConfigureClient is a helper to configure resources and data sources with the API client
func ConfigureClient(req any, resp any) *client.Client {
// First validate the response type
var diagnostics diag.Diagnostics
switch resp.(type) {
case *datasource.ConfigureResponse, *resource.ConfigureResponse:
// valid types
default:
panic(fmt.Sprintf("unexpected response type: %T", resp))
}

// Get provider data based on request type
var providerData any
switch r := req.(type) {
case datasource.ConfigureRequest:
providerData = r.ProviderData
case resource.ConfigureRequest:
providerData = r.ProviderData
default:
panic(fmt.Sprintf("unexpected request type: %T", req))
}

if providerData == nil {
diagnostics.AddWarning(
"Unconfigured Provider",
"Provider has not been configured, resources may not work correctly",
)
setDiagnostics(resp, diagnostics)
return nil
}

client, ok := providerData.(*client.Client)
if !ok {
switch r := resp.(type) {
case *datasource.ConfigureResponse:
r.Diagnostics.AddError(
"Unexpected Data Source Configure Type",
fmt.Sprintf("Expected *client.Client, got: %T.", providerData),
)
case *resource.ConfigureResponse:
r.Diagnostics.AddError(
"Unexpected Resource Configure Type",
fmt.Sprintf("Expected *client.Client, got: %T.", providerData),
)
}
diagnostics.AddError(
"Unexpected Provider Type",
fmt.Sprintf("Expected *client.Client, got: %T", providerData),
)
setDiagnostics(resp, diagnostics)
return nil
}

return client
}

// helper function to set diagnostics on the response
func setDiagnostics(resp any, diagnostics diag.Diagnostics) {
switch r := resp.(type) {
case *datasource.ConfigureResponse:
r.Diagnostics.Append(diagnostics...)
case *resource.ConfigureResponse:
r.Diagnostics.Append(diagnostics...)
}
}

// ImportStatePassthroughID is a helper that implements the common import state pattern
func ImportStatePassthroughID(req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
resp.Diagnostics.Append(resp.State.SetAttribute(context.Background(), path.Root("id"), req.ID)...)
Expand Down
8 changes: 8 additions & 0 deletions internal/provider/namespace_data_source.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ func (d *NamespaceDataSource) Read(ctx context.Context, req datasource.ReadReque
return
}

if d.client == nil {
resp.Diagnostics.AddError(
"Client not configured",
"The provider client is not properly configured. Please check your provider configuration.",
)
return
}

namespaceResp, err := d.client.NamespaceService.GetNamespace(ctx, &pb.GetNamespaceRequest{
Id: data.ID.ValueString(),
})
Expand Down
16 changes: 1 addition & 15 deletions internal/provider/namespaces_data_source.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package provider

import (
"context"
"fmt"

"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
Expand Down Expand Up @@ -59,20 +58,7 @@ func (d *NamespacesDataSource) Schema(_ context.Context, _ datasource.SchemaRequ
}

func (d *NamespacesDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
if req.ProviderData == nil {
return
}

client, ok := req.ProviderData.(*client.Client)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Data Source Configure Type",
fmt.Sprintf("Expected *client.Client, got: %T.", req.ProviderData),
)
return
}

d.client = client
d.client = ConfigureClient(req, resp)
}

func (d *NamespacesDataSource) Read(ctx context.Context, _ datasource.ReadRequest, resp *datasource.ReadResponse) {
Expand Down
16 changes: 1 addition & 15 deletions internal/provider/policies_data_source.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package provider

import (
"context"
"fmt"

"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
Expand Down Expand Up @@ -62,20 +61,7 @@ func (d *PoliciesDataSource) Schema(_ context.Context, _ datasource.SchemaReques
}

func (d *PoliciesDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
if req.ProviderData == nil {
return
}

client, ok := req.ProviderData.(*client.Client)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Data Source Configure Type",
fmt.Sprintf("Expected *client.Client, got: %T.", req.ProviderData),
)
return
}

d.client = client
d.client = ConfigureClient(req, resp)
}

func (d *PoliciesDataSource) Read(ctx context.Context, _ datasource.ReadRequest, resp *datasource.ReadResponse) {
Expand Down
16 changes: 1 addition & 15 deletions internal/provider/policy.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package provider

import (
"context"
"fmt"

"github.com/hashicorp/terraform-plugin-framework/path"
"github.com/hashicorp/terraform-plugin-framework/resource"
Expand Down Expand Up @@ -67,20 +66,7 @@ func (r *PolicyResource) Schema(_ context.Context, _ resource.SchemaRequest, res
}

func (r *PolicyResource) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
if req.ProviderData == nil {
return
}

c, ok := req.ProviderData.(*client.Client)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Provider Data Type",
fmt.Sprintf("Expected *client.Client, got: %T.", req.ProviderData),
)
return
}

r.client = c
r.client = ConfigureClient(req, resp)
}

func (r *PolicyResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
Expand Down
16 changes: 1 addition & 15 deletions internal/provider/policy_data_source.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package provider

import (
"context"
"fmt"

"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
Expand Down Expand Up @@ -50,20 +49,7 @@ func (d *PolicyDataSource) Schema(_ context.Context, _ datasource.SchemaRequest,
}

func (d *PolicyDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
if req.ProviderData == nil {
return
}

client, ok := req.ProviderData.(*client.Client)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Data Source Configure Type",
fmt.Sprintf("Expected *client.Client, got: %T.", req.ProviderData),
)
return
}

d.client = client
d.client = ConfigureClient(req, resp)
}

func (d *PolicyDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
Expand Down
17 changes: 1 addition & 16 deletions internal/provider/route.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package provider

import (
"context"
"fmt"

"github.com/hashicorp/terraform-plugin-framework/path"
"github.com/hashicorp/terraform-plugin-framework/resource"
Expand Down Expand Up @@ -75,21 +74,7 @@ func (r *RouteResource) Schema(_ context.Context, _ resource.SchemaRequest, resp
}

func (r *RouteResource) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
if req.ProviderData == nil {
return
}

c, ok := req.ProviderData.(*client.Client)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Resource Configure Type",
fmt.Sprintf("Expected Config, got: %T.", req.ProviderData),
)

return
}

r.client = c
r.client = ConfigureClient(req, resp)
}

func (r *RouteResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
Expand Down
16 changes: 1 addition & 15 deletions internal/provider/route_data_source.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package provider

import (
"context"
"fmt"

"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
Expand Down Expand Up @@ -62,20 +61,7 @@ func (d *RouteDataSource) Schema(_ context.Context, _ datasource.SchemaRequest,
}

func (d *RouteDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
if req.ProviderData == nil {
return
}

client, ok := req.ProviderData.(*client.Client)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Data Source Configure Type",
fmt.Sprintf("Expected *client.Client, got: %T.", req.ProviderData),
)
return
}

d.client = client
d.client = ConfigureClient(req, resp)
}

func (d *RouteDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
Expand Down
16 changes: 1 addition & 15 deletions internal/provider/service_account_data_source.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package provider

import (
"context"
"fmt"

"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
Expand Down Expand Up @@ -58,20 +57,7 @@ func (d *ServiceAccountDataSource) Schema(_ context.Context, _ datasource.Schema
}

func (d *ServiceAccountDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
if req.ProviderData == nil {
return
}

client, ok := req.ProviderData.(*client.Client)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Data Source Configure Type",
fmt.Sprintf("Expected *client.Client, got: %T.", req.ProviderData),
)
return
}

d.client = client
d.client = ConfigureClient(req, resp)
}

func (d *ServiceAccountDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
Expand Down
Loading