Merge pull request #503 from jcvrabo/add-info-endpoints

implement the info resource

Author: sneal

client/client.go

@@ -33,6 +33,7 @@ type Client struct {
 	Droplets                  *DropletClient
 	EnvVarGroups              *EnvVarGroupClient
 	FeatureFlags              *FeatureFlagClient
+	Info                      *InfoClient
 	IsolationSegments         *IsolationSegmentClient
 	Jobs                      *JobClient
 	Manifests                 *ManifestClient
@@ -96,6 +97,7 @@ func New(config *config.Config) (*Client, error) {
 	client.Droplets = (*DropletClient)(&client.common)
 	client.EnvVarGroups = (*EnvVarGroupClient)(&client.common)
 	client.FeatureFlags = (*FeatureFlagClient)(&client.common)
+	client.Info = (*InfoClient)(&client.common)
 	client.IsolationSegments = (*IsolationSegmentClient)(&client.common)
 	client.Jobs = (*JobClient)(&client.common)
 	client.Manifests = (*ManifestClient)(&client.common)

client/info.go

@@ -0,0 +1,39 @@
+package client
+
+import (
+	"context"
+
+	"github.com/cloudfoundry/go-cfclient/v3/resource"
+)
+
+type InfoClient commonClient
+
+// Get retrieves information about the Cloud Foundry deployment
+//
+// This endpoint returns metadata about the Cloud Foundry deployment including
+// version, build info, CLI version requirements, and operator-configured custom metadata.
+//
+// Authentication: No authentication required
+func (c *InfoClient) Get(ctx context.Context) (*resource.Info, error) {
+	var info resource.Info
+	err := c.client.get(ctx, "/v3/info", &info)
+	if err != nil {
+		return nil, err
+	}
+	return &info, nil
+}
+
+// GetUsageSummary retrieves platform-wide usage statistics
+//
+// This endpoint returns usage information across the entire Cloud Foundry deployment
+// including started instances, memory usage, routes, service instances, and more.
+//
+// Authentication: Requires authentication with cloud_controller.admin or cloud_controller.admin_read_only scope
+func (c *InfoClient) GetUsageSummary(ctx context.Context) (*resource.InfoUsageSummary, error) {
+	var usageSummary resource.InfoUsageSummary
+	err := c.client.get(ctx, "/v3/info/usage_summary", &usageSummary)
+	if err != nil {
+		return nil, err
+	}
+	return &usageSummary, nil
+}

client/info_test.go

@@ -0,0 +1,43 @@
+package client
+
+import (
+	"context"
+	"net/http"
+	"testing"
+
+	"github.com/cloudfoundry/go-cfclient/v3/testutil"
+)
+
+func TestInfo(t *testing.T) {
+	g := testutil.NewObjectJSONGenerator()
+	info := g.Info().JSON
+	usageSummary := g.InfoUsageSummary().JSON
+
+	tests := []RouteTest{
+		{
+			Description: "Get platform info",
+			Route: testutil.MockRoute{
+				Method:   "GET",
+				Endpoint: "/v3/info",
+				Output:   g.Single(info),
+				Status:   http.StatusOK},
+			Expected: info,
+			Action: func(c *Client, t *testing.T) (any, error) {
+				return c.Info.Get(context.Background())
+			},
+		},
+		{
+			Description: "Get platform usage summary",
+			Route: testutil.MockRoute{
+				Method:   "GET",
+				Endpoint: "/v3/info/usage_summary",
+				Output:   g.Single(usageSummary),
+				Status:   http.StatusOK},
+			Expected: usageSummary,
+			Action: func(c *Client, t *testing.T) (any, error) {
+				return c.Info.GetUsageSummary(context.Background())
+			},
+		},
+	}
+	ExecuteTests(tests, t)
+}

resource/info.go

@@ -0,0 +1,33 @@
+package resource
+
+// Info represents platform information about the Cloud Foundry deployment
+type Info struct {
+	Build         string         `json:"build"`          // The build number of the Cloud Controller API, ends up showing the full version of the api.
+	CLIVersion    InfoCLIVersion `json:"cli_version"`    // Recommended and minimum CLI versions
+	Custom        map[string]any `json:"custom"`         // Custom metadata set by the operator
+	Description   string         `json:"description"`    // Description of the Cloud Foundry deployment
+	Name          string         `json:"name"`           // Name of the Cloud Foundry deployment
+	Version       int            `json:"version"`        // Version of the Cloud Controller API (Major version number)
+	OSBAPIVersion string         `json:"osbapi_version"` // Version of the Open Service Broker API in use
+	RateLimits    InfoRateLimits `json:"rate_limits"`    // Rate limiting configuration
+	Links         Links          `json:"links"`
+}
+
+// InfoCLIVersion contains the minimum CLI version supported and the recommend version
+type InfoCLIVersion struct {
+	Minimum     string `json:"minimum"`     // Minimum supported CLI version
+	Recommended string `json:"recommended"` // Recommended CLI version
+}
+
+// InfoRateLimits contains rate limiting configuration
+type InfoRateLimits struct {
+	Enabled                bool `json:"enabled"`                   // Whether rate limiting is enabled
+	GeneralLimit           int  `json:"general_limit"`             // Number of requests allowed per reset interval
+	ResetIntervalInMinutes int  `json:"reset_interval_in_minutes"` // Time in minutes before rate limit counter resets
+}
+
+// InfoUsageSummary represents platform-wide usage statistics
+type InfoUsageSummary struct {
+	UsageSummary UsageSummary `json:"usage_summary"` // Platform usage statistics
+	Links        Links        `json:"links"`
+}

testutil/object_generator.go

@@ -202,6 +202,16 @@ func (o ObjectJSONGenerator) FeatureFlag() *JSONResource {
 	return o.renderTemplate(r, "feature_flag.json")
 }
 
+func (o ObjectJSONGenerator) Info() *JSONResource {
+	r := &JSONResource{}
+	return o.renderTemplate(r, "info.json")
+}
+
+func (o ObjectJSONGenerator) InfoUsageSummary() *JSONResource {
+	r := &JSONResource{}
+	return o.renderTemplate(r, "info_usage_summary.json")
+}
+
 func (o ObjectJSONGenerator) IsolationSegment() *JSONResource {
 	r := &JSONResource{
 		GUID: RandomGUID(),

testutil/template/info.json

@@ -0,0 +1,27 @@
+{
+  "build": "afa73e3fe",
+  "cli_version": {
+    "minimum": "6.22.0",
+    "recommended": "latest"
+  },
+  "custom": {
+    "arbitrary": "stuff"
+  },
+  "description": "Put your apps here!",
+  "name": "Cloud Foundry",
+  "version": 123,
+  "osbapi_version": "2.15",
+  "rate_limits": {
+    "enabled": true,
+    "general_limit": 2000,
+    "reset_interval_in_minutes": 30
+  },
+  "links": {
+    "self": {
+      "href": "https://api.example.org/v3/info"
+    },
+    "support": {
+      "href": "https://support.example.com"
+    }
+  }
+}

testutil/template/info_usage_summary.json

@@ -0,0 +1,17 @@
+{
+  "usage_summary": {
+    "started_instances": 294,
+    "memory_in_mb": 123945,
+    "routes": 300,
+    "service_instances": 50,
+    "reserved_ports": 10,
+    "domains": 5,
+    "per_app_tasks": 0,
+    "service_keys": 20
+  },
+  "links": {
+    "self": {
+      "href": "https://api.example.org/v3/info/usage_summary"
+    }
+  }
+}