add argument error handling when getting path id

Author: jooola

hcloud/action.go

@@ -86,8 +86,8 @@ func (a *Action) Error() error {
 
 type nilResource struct{}
 
-func (nilResource) pathID() string {
-	return ""
+func (nilResource) pathID() (string, error) {
+	return "", nil
 }
 
 // ActionClient is a client for the actions API.
@@ -209,7 +209,7 @@ func (c *ResourceActionClient[R]) All(ctx context.Context, opts ActionListOpts)
 }
 
 type actionSupporter interface {
-	pathID() string
+	pathID() (string, error)
 }
 
 // ListFor returns a paginated list of actions for the given Resource.
@@ -220,7 +220,10 @@ func (c *ResourceActionClient[R]) ListFor(ctx context.Context, resource R, opts
 	opPath := c.getBaseURL() + "/%s/actions?%s"
 	ctx = ctxutil.SetOpPath(ctx, opPath)
 
-	id := resource.pathID()
+	id, err := resource.pathID()
+	if err != nil {
+		return nil, nil, invalidArgument("resource", resource, err)
+	}
 
 	reqPath := fmt.Sprintf(opPath, id, opts.values().Encode())
 

hcloud/action_test.go

@@ -407,6 +407,15 @@ func TestResourceActionClientListFor(t *testing.T) {
 		require.Len(t, result, 1)
 		require.Equal(t, int64(1509772237), result[0].ID)
 	})
+
+	t.Run("invalid argument", func(t *testing.T) {
+		ctx, _, client := makeTestUtils(t)
+
+		result, resp, err := client.PrimaryIP.Action.ListFor(ctx, &PrimaryIP{ID: 0}, ActionListOpts{})
+		require.EqualError(t, err, "invalid argument 'resource' [*hcloud.PrimaryIP]: missing field [ID] in [*hcloud.PrimaryIP]")
+		require.Nil(t, result)
+		require.Nil(t, resp)
+	})
 }
 
 func TestResourceActionClientAllFor(t *testing.T) {

hcloud/certificate.go

@@ -82,8 +82,11 @@ type Certificate struct {
 	UsedBy         []CertificateUsedByRef
 }
 
-func (c *Certificate) pathID() string {
-	return strconv.FormatInt(c.ID, 10)
+func (c *Certificate) pathID() (string, error) {
+	if c.ID == 0 {
+		return "", missingField(c, "ID")
+	}
+	return strconv.FormatInt(c.ID, 10), nil
 }
 
 // CertificateCreateResult is the result of creating a certificate.

hcloud/firewall.go

@@ -22,8 +22,11 @@ type Firewall struct {
 	AppliedTo []FirewallResource
 }
 
-func (f *Firewall) pathID() string {
-	return strconv.FormatInt(f.ID, 10)
+func (f *Firewall) pathID() (string, error) {
+	if f.ID == 0 {
+		return "", missingField(f, "ID")
+	}
+	return strconv.FormatInt(f.ID, 10), nil
 }
 
 // FirewallRule represents a Firewall's rules.

hcloud/floating_ip.go

@@ -29,8 +29,11 @@ type FloatingIP struct {
 	Name         string
 }
 
-func (f *FloatingIP) pathID() string {
-	return strconv.FormatInt(f.ID, 10)
+func (f *FloatingIP) pathID() (string, error) {
+	if f.ID == 0 {
+		return "", missingField(f, "ID")
+	}
+	return strconv.FormatInt(f.ID, 10), nil
 }
 
 // DNSPtrForIP returns the reverse DNS pointer of the IP address.

hcloud/image.go

@@ -35,8 +35,11 @@ type Image struct {
 	Deleted    time.Time
 }
 
-func (image *Image) pathID() string {
-	return strconv.FormatInt(image.ID, 10)
+func (image *Image) pathID() (string, error) {
+	if image.ID == 0 {
+		return "", missingField(image, "ID")
+	}
+	return strconv.FormatInt(image.ID, 10), nil
 }
 
 // IsDeprecated returns whether the image is deprecated.

hcloud/load_balancer.go

@@ -32,8 +32,11 @@ type LoadBalancer struct {
 	IngoingTraffic   uint64
 }
 
-func (lb *LoadBalancer) pathID() string {
-	return strconv.FormatInt(lb.ID, 10)
+func (lb *LoadBalancer) pathID() (string, error) {
+	if lb.ID == 0 {
+		return "", missingField(lb, "ID")
+	}
+	return strconv.FormatInt(lb.ID, 10), nil
 }
 
 // LoadBalancerPublicNet represents a Load Balancer's public network.

hcloud/network.go

@@ -57,8 +57,11 @@ type Network struct {
 	ExposeRoutesToVSwitch bool
 }
 
-func (n *Network) pathID() string {
-	return strconv.FormatInt(n.ID, 10)
+func (n *Network) pathID() (string, error) {
+	if n.ID == 0 {
+		return "", missingField(n, "ID")
+	}
+	return strconv.FormatInt(n.ID, 10), nil
 }
 
 // NetworkSubnet represents a subnet of a network in the Hetzner Cloud.

hcloud/primary_ip.go

@@ -35,8 +35,11 @@ type PrimaryIP struct {
 	Datacenter *Datacenter
 }
 
-func (p *PrimaryIP) pathID() string {
-	return strconv.FormatInt(p.ID, 10)
+func (p *PrimaryIP) pathID() (string, error) {
+	if p.ID == 0 {
+		return "", missingField(p, "ID")
+	}
+	return strconv.FormatInt(p.ID, 10), nil
 }
 
 // PrimaryIPProtection represents the protection level of a Primary IP.

hcloud/server.go

@@ -44,8 +44,11 @@ type Server struct {
 	Datacenter *Datacenter
 }
 
-func (s *Server) pathID() string {
-	return strconv.FormatInt(s.ID, 10)
+func (s *Server) pathID() (string, error) {
+	if s.ID == 0 {
+		return "", missingField(s, "ID")
+	}
+	return strconv.FormatInt(s.ID, 10), nil
 }
 
 // ServerProtection represents the protection level of a server.