Merge branch 'master' into vcheung-20260326-plugin-update-config

Author: vcheung-stripe

api/openapi-spec/spec3.cli.json

@@ -1,6 +1,7 @@
 package resource
 
 import (
+	"encoding/json"
 	"fmt"
 	"net/http"
 	"os"
@@ -48,22 +49,36 @@ func (oc *OperationCmd) runOperationCmd(cmd *cobra.Command, args []string) error
 		return err
 	}
 
-	apiKey, err := oc.Profile.GetAPIKey(oc.Livemode)
-	if err != nil {
-		return err
-	}
+	apiKey, apiKeyErr := oc.Profile.GetAPIKey(oc.Livemode)
 
 	path := formatURL(oc.Path, args)
 	requestParams := make(map[string]interface{})
 	oc.addStringRequestParams(requestParams)
 	oc.addIntRequestParams(requestParams)
 	oc.addBoolRequestParams(requestParams)
 
-	err = oc.addArrayRequestParams(requestParams)
-	if err != nil {
+	if err := oc.addArrayRequestParams(requestParams); err != nil {
 		return err
 	}
 
+	if oc.DryRun {
+		dryRunKey := apiKey
+		if apiKeyErr != nil {
+			dryRunKey = ""
+		}
+		output, err := oc.BuildDryRunOutput(dryRunKey, oc.APIBaseURL, path, &oc.Parameters, requestParams)
+		if err != nil {
+			return err
+		}
+		b, _ := json.MarshalIndent(output, "", "  ")
+		fmt.Fprintln(cmd.OutOrStdout(), string(b))
+		return nil
+	}
+
+	if apiKeyErr != nil {
+		return apiKeyErr
+	}
+
 	if oc.HTTPVerb == http.MethodDelete {
 		// display account information and confirm whether user wants to proceed
 		var mode = "Test"
@@ -99,7 +114,7 @@ func (oc *OperationCmd) runOperationCmd(cmd *cobra.Command, args []string) error
 		return err
 	}
 	// else
-	_, err = oc.MakeRequest(cmd.Context(), apiKey, path, &oc.Parameters, requestParams, false, nil)
+	_, err := oc.MakeRequest(cmd.Context(), apiKey, path, &oc.Parameters, requestParams, false, nil)
 	return err
 }
 

api/openapi-spec/spec3.cli.preview.json

@@ -1,7 +1,10 @@
 package resource
 
 import (
+	"bytes"
 	"context"
+	"encoding/json"
+	"fmt"
 	"io"
 	"net/http"
 	"net/http/httptest"
@@ -13,6 +16,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/stripe/stripe-cli/pkg/config"
+	"github.com/stripe/stripe-cli/pkg/requests"
 )
 
 func TestNewOperationCmd(t *testing.T) {
@@ -164,6 +168,206 @@ func TestRunOperationCmd_NoAPIKey(t *testing.T) {
 	require.Error(t, err, "your API key has not been configured. Use `stripe login` to set your API key")
 }
 
+func TestRunOperationCmd_DryRun(t *testing.T) {
+	serverCalled := false
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		serverCalled = true
+		w.WriteHeader(http.StatusOK)
+	}))
+	defer ts.Close()
+
+	viper.Reset()
+
+	parentCmd := &cobra.Command{Annotations: make(map[string]string)}
+	profile := config.Profile{APIKey: "sk_test_1234567890abcdef"}
+	oc := NewOperationCmd(parentCmd, "foo", "/v1/bars/{id}", http.MethodPost, map[string]string{
+		"param1": "string",
+	}, map[string][]string{}, &config.Config{Profile: profile}, false, "")
+	oc.APIBaseURL = ts.URL
+
+	var buf bytes.Buffer
+	oc.Cmd.SetOut(&buf)
+	oc.Cmd.Flags().Set("param1", "value1")
+	oc.Cmd.Flags().Set("dry-run", "true")
+
+	err := oc.runOperationCmd(oc.Cmd, []string{"bar_123"})
+
+	require.NoError(t, err)
+	require.False(t, serverCalled, "HTTP server should not be called during dry-run")
+
+	var result requests.DryRunOutput
+	require.NoError(t, json.Unmarshal(buf.Bytes(), &result))
+	// "sk_test_1234567890abcdef" (24 chars) redacts to "sk_test_************cdef"
+	require.Equal(t, requests.DryRunOutput{DryRun: requests.DryRunDetails{
+		Method: "POST",
+		URL:    ts.URL + "/v1/bars/bar_123",
+		Params: map[string]interface{}{"param1": "value1"},
+		Headers: map[string]string{
+			"Authorization": "Bearer sk_test_************cdef",
+			"Content-Type":  "application/x-www-form-urlencoded",
+		},
+	}}, result)
+}
+
+func TestRunOperationCmd_DryRun_NoAPIKey(t *testing.T) {
+	viper.Reset()
+
+	parentCmd := &cobra.Command{Annotations: make(map[string]string)}
+	oc := NewOperationCmd(parentCmd, "foo", "/v1/bars/{id}", http.MethodPost, map[string]string{}, map[string][]string{}, &config.Config{}, false, "")
+
+	var buf bytes.Buffer
+	oc.Cmd.SetOut(&buf)
+	oc.Cmd.Flags().Set("dry-run", "true")
+
+	err := oc.runOperationCmd(oc.Cmd, []string{"bar_123"})
+
+	require.NoError(t, err, "dry-run should succeed even without an API key")
+
+	var result requests.DryRunOutput
+	require.NoError(t, json.Unmarshal(buf.Bytes(), &result))
+	require.Equal(t, requests.DryRunOutput{DryRun: requests.DryRunDetails{
+		Method:  "POST",
+		URL:     "https://api.stripe.com/v1/bars/bar_123",
+		Params:  map[string]interface{}{},
+		Headers: map[string]string{"Content-Type": "application/x-www-form-urlencoded"},
+	}}, result)
+}
+
+// assertDryRunParityV1 checks that structured dry-run params are semantically
+// consistent with the URL-encoded body received by a test server.
+// One-directional: every param in dry-run must appear in the server request.
+func assertDryRunParityV1(t *testing.T, serverBody []byte, dryRunParams map[string]interface{}) {
+	t.Helper()
+	serverVals, err := url.ParseQuery(string(serverBody))
+	require.NoError(t, err)
+	flattenAndAssert(t, serverVals, dryRunParams, "")
+}
+
+func flattenAndAssert(t *testing.T, serverVals url.Values, params map[string]interface{}, prefix string) {
+	t.Helper()
+	for k, v := range params {
+		fullKey := k
+		if prefix != "" {
+			fullKey = prefix + "[" + k + "]"
+		}
+		switch val := v.(type) {
+		case string:
+			require.Equal(t, val, serverVals.Get(fullKey), "param %q mismatch", fullKey)
+		case map[string]interface{}:
+			flattenAndAssert(t, serverVals, val, fullKey)
+		case []interface{}:
+			for _, item := range val {
+				require.Contains(t, serverVals[fullKey+"[]"], fmt.Sprint(item))
+			}
+		default:
+			require.Equal(t, fmt.Sprint(val), serverVals.Get(fullKey), "param %q mismatch", fullKey)
+		}
+	}
+}
+
+func TestRunOperationCmd_DryRunParity_V1(t *testing.T) {
+	var capturedPath string
+	var capturedBody []byte
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		capturedPath = r.URL.Path
+		capturedBody, _ = io.ReadAll(r.Body)
+		w.WriteHeader(http.StatusOK)
+	}))
+	defer ts.Close()
+
+	viper.Reset()
+	profile := config.Profile{APIKey: "sk_test_1234"}
+	propFlags := map[string]string{
+		"param1":    "string",
+		"int-param": "integer",
+		"arr-param": "array",
+	}
+
+	newOC := func(dryRun bool) (*OperationCmd, *cobra.Command) {
+		parentCmd := &cobra.Command{Annotations: make(map[string]string)}
+		oc := NewOperationCmd(parentCmd, "foo", "/v1/bars/{id}", http.MethodPost,
+			propFlags, map[string][]string{}, &config.Config{Profile: profile}, false, "")
+		oc.APIBaseURL = ts.URL
+		oc.Cmd.Flags().Set("param1", "value1")
+		oc.Cmd.Flags().Set("int-param", "42")
+		oc.Cmd.Flags().Set("arr-param", "x")
+		oc.Cmd.Flags().Set("arr-param", "y")
+		oc.Cmd.Flags().Set("data", "metadata[env]=staging")
+		oc.Cmd.Flags().Set("data", "metadata[version]=2")
+		if dryRun {
+			oc.Cmd.Flags().Set("dry-run", "true")
+		}
+		parentCmd.SetArgs([]string{"foo", "bar_123"})
+		return oc, parentCmd
+	}
+
+	// --- LIVE RUN ---
+	_, liveCmd := newOC(false)
+	require.NoError(t, liveCmd.ExecuteContext(t.Context()))
+
+	// --- DRY-RUN ---
+	dryOC, dryCmd := newOC(true)
+	var buf bytes.Buffer
+	dryOC.Cmd.SetOut(&buf)
+	require.NoError(t, dryCmd.ExecuteContext(t.Context()))
+
+	var dryOut requests.DryRunOutput
+	require.NoError(t, json.Unmarshal(buf.Bytes(), &dryOut))
+
+	require.Equal(t, "/v1/bars/bar_123", capturedPath)
+	require.Contains(t, dryOut.DryRun.URL, "/v1/bars/bar_123")
+	assertDryRunParityV1(t, capturedBody, dryOut.DryRun.Params)
+}
+
+func TestRunOperationCmd_DryRunParity_V2(t *testing.T) {
+	var capturedBody []byte
+	var capturedQuery string
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		capturedBody, _ = io.ReadAll(r.Body)
+		capturedQuery = r.URL.RawQuery
+		w.WriteHeader(http.StatusOK)
+	}))
+	defer ts.Close()
+
+	viper.Reset()
+	profile := config.Profile{APIKey: "sk_test_1234"}
+	jsonData := `{"event_name": "foo", "value": 100}`
+
+	newOC := func(dryRun bool) (*OperationCmd, *cobra.Command) {
+		parentCmd := &cobra.Command{Annotations: make(map[string]string)}
+		oc := NewOperationCmd(parentCmd, "create", "/v2/billing/meter_events",
+			http.MethodPost, map[string]string{}, map[string][]string{},
+			&config.Config{Profile: profile}, false, "")
+		oc.APIBaseURL = ts.URL
+		oc.Cmd.Flags().Set("data", jsonData)
+		if dryRun {
+			oc.Cmd.Flags().Set("dry-run", "true")
+		}
+		parentCmd.SetArgs([]string{"create"})
+		return oc, parentCmd
+	}
+
+	// --- LIVE RUN ---
+	_, liveCmd := newOC(false)
+	require.NoError(t, liveCmd.ExecuteContext(t.Context()))
+
+	// --- DRY-RUN ---
+	dryOC, dryCmd := newOC(true)
+	var buf bytes.Buffer
+	dryOC.Cmd.SetOut(&buf)
+	require.NoError(t, dryCmd.ExecuteContext(t.Context()))
+
+	var dryOut requests.DryRunOutput
+	require.NoError(t, json.Unmarshal(buf.Bytes(), &dryOut))
+
+	require.Equal(t, "", capturedQuery)
+	var liveParams map[string]interface{}
+	require.NoError(t, json.Unmarshal(capturedBody, &liveParams))
+
+	require.Equal(t, liveParams, dryOut.DryRun.Params)
+	require.NotContains(t, dryOut.DryRun.URL, "?")
+}
+
 func TestConstructParamFromDot(t *testing.T) {
 	param := constructParamFromDot("shipping.address.line1")
 	require.Equal(t, "shipping[address][line1]", param)