STAC-22844: restore backwards compatibility - bring back the scope query

Author: fvlankvelt

cmd/rbac/flags.go

@@ -4,14 +4,18 @@ const (
 	Subject    = "subject"
 	Permission = "permission"
 	Resource   = "resource"
+	Scope      = "scope"
 
 	SubjectUsage            = "The handle of the subject of the permissions. If you're using LDAP, please use the usernameKey configured in StackState"
 	PermissionRevokeUsage   = "The permission to revoke"
 	PermissionGrantUsage    = "The permission to grant"
 	PermissionDescribeUsage = "Filter the permissions by permission name"
-	ResourceDescribeUsage   = "Filter the permissions by a resource identifier (e.g. system, a resource name or tag)"
-	ResourceGrantUsage      = "The resource to grant the permission to (e.g. \"system\" or a resource name or tag)"
-	ResourceRevokeUsage     = "The resource to revoke the permission to (e.g. \"system\" or a resource name or tag)"
+	ResourceDescribeUsage   = "Filter the permissions by a resource identifier (e.g. system or a view name)"
+	ResourceGrantUsage      = "The resource to grant the permission to (e.g. \"system\" or a view name)"
+	ResourceRevokeUsage     = "The resource to revoke the permission to (e.g. \"system\" or a view name)"
+	ScopeUsage              = "The query in STQL that will be prepended to every topology element retrieved in StackState. " +
+		"For example, if your scope is \"label = 'A'\", then all STQL executed in StackState" +
+		" (e.g. Retrieving topology) will only return elements that have the label A"
 
 	DefaultResource = "system"
 )

cmd/rbac/rbac_create_subject.go

@@ -10,6 +10,7 @@ import (
 
 type CreateSubjectArgs struct {
 	Subject string
+	Scope   string
 }
 
 func CreateSubjectCommand(deps *di.Deps) *cobra.Command {
@@ -24,6 +25,8 @@ func CreateSubjectCommand(deps *di.Deps) *cobra.Command {
 	cmd.Flags().StringVar(&args.Subject, Subject, "", SubjectUsage)
 	cmd.MarkFlagRequired(Subject) //nolint:errcheck
 
+	cmd.Flags().StringVar(&args.Scope, Scope, "", ScopeUsage)
+
 	return cmd
 }
 
@@ -34,7 +37,13 @@ func RunCreateSubjectCommand(args *CreateSubjectArgs) di.CmdWithApiFn {
 		api *stackstate_api.APIClient,
 		serverInfo *stackstate_api.ServerInfo,
 	) common.CLIError {
+		subject := stackstate_api.NewCreateSubject()
+		if args.Scope != "" {
+			subject.SetQuery(args.Scope)
+		}
+
 		resp, err := api.SubjectApi.CreateSubject(cli.Context, args.Subject).
+			CreateSubject(*subject).
 			Execute()
 
 		if err != nil {

cmd/rbac/rbac_create_subject_test.go

@@ -2,6 +2,7 @@ package rbac
 
 import (
 	"fmt"
+	"github.com/stackvista/stackstate-cli/generated/stackstate_api"
 	"testing"
 
 	"github.com/stackvista/stackstate-cli/internal/di"
@@ -23,6 +24,9 @@ func TestCreateSubjectJson(t *testing.T) {
 	assert.Len(t, calls, 1)
 	assert.Equal(t, SomeSubject, calls[0].Psubject)
 
+	expectedSubject := stackstate_api.NewCreateSubject()
+	assert.Equal(t, expectedSubject, calls[0].PcreateSubject)
+
 	expectedJson := []map[string]interface{}{
 		{
 			"created-subject": SomeSubject,
@@ -36,12 +40,16 @@ func TestCreateSubject(t *testing.T) {
 	cli := di.NewMockDeps(t)
 	cmd := CreateSubjectCommand(&cli.Deps)
 
-	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "--subject", SomeOtherSubject)
+	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "--subject", SomeOtherSubject, "--scope", SomeScope)
 
 	calls := *cli.MockClient.ApiMocks.SubjectApi.CreateSubjectCalls
 	assert.Len(t, calls, 1)
 	assert.Equal(t, SomeOtherSubject, calls[0].Psubject)
 
+	otherExpectedSubject := stackstate_api.NewCreateSubject()
+	otherExpectedSubject.SetQuery(SomeScope)
+	assert.Equal(t, otherExpectedSubject, calls[0].PcreateSubject)
+
 	expectedStrings := []string{
 		fmt.Sprintf("Created subject '%s'", SomeOtherSubject),
 	}

generated/stackstate_api/.openapi-generator/FILES

@@ -85,6 +85,7 @@ docs/ComponentHighlightMetricSectionAllOf.md
 docs/ComponentNotFoundError.md
 docs/ComponentQuery.md
 docs/ComponentViewArguments.md
+docs/CreateSubject.md
 docs/DashboardAuthorizationError.md
 docs/DashboardClientErrors.md
 docs/DashboardCloneSchema.md
@@ -510,6 +511,7 @@ model_component_highlight_metric_section_all_of.go
 model_component_not_found_error.go
 model_component_query.go
 model_component_view_arguments.go
+model_create_subject.go
 model_dashboard_authorization_error.go
 model_dashboard_client_errors.go
 model_dashboard_clone_schema.go

generated/stackstate_api/README.md

@@ -281,6 +281,7 @@ Class | Method | HTTP request | Description
  - [ComponentNotFoundError](docs/ComponentNotFoundError.md)
  - [ComponentQuery](docs/ComponentQuery.md)
  - [ComponentViewArguments](docs/ComponentViewArguments.md)
+ - [CreateSubject](docs/CreateSubject.md)
  - [DashboardAuthorizationError](docs/DashboardAuthorizationError.md)
  - [DashboardClientErrors](docs/DashboardClientErrors.md)
  - [DashboardCloneSchema](docs/DashboardCloneSchema.md)

generated/stackstate_api/api/openapi.yaml

@@ -3959,6 +3959,12 @@ paths:
         required: true
         schema:
           $ref: '#/components/schemas/Subject'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateSubject'
+        required: true
       responses:
         "200":
           description: Subject created
@@ -10902,6 +10908,15 @@ components:
       required:
       - handle
       type: object
+    CreateSubject:
+      example:
+        query: query
+      properties:
+        query:
+          type: string
+      type: object
+    Query:
+      type: string
     SubscriptionState:
       discriminator:
         propertyName: _type

generated/stackstate_api/api_subject.go

@@ -0,0 +1,56 @@
+# CreateSubject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Query** | Pointer to **string** |  | [optional] 
+
+## Methods
+
+### NewCreateSubject
+
+`func NewCreateSubject() *CreateSubject`
+
+NewCreateSubject instantiates a new CreateSubject object
+This constructor will assign default values to properties that have it defined,
+and makes sure properties required by API are set, but the set of arguments
+will change when the set of required properties is changed
+
+### NewCreateSubjectWithDefaults
+
+`func NewCreateSubjectWithDefaults() *CreateSubject`
+
+NewCreateSubjectWithDefaults instantiates a new CreateSubject object
+This constructor will only assign default values to properties that have it defined,
+but it doesn't guarantee that properties required by API are set
+
+### GetQuery
+
+`func (o *CreateSubject) GetQuery() string`
+
+GetQuery returns the Query field if non-nil, zero value otherwise.
+
+### GetQueryOk
+
+`func (o *CreateSubject) GetQueryOk() (*string, bool)`
+
+GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetQuery
+
+`func (o *CreateSubject) SetQuery(v string)`
+
+SetQuery sets Query field to given value.
+
+### HasQuery
+
+`func (o *CreateSubject) HasQuery() bool`
+
+HasQuery returns a boolean if a field has been set.
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

generated/stackstate_api/docs/CreateSubject.md

@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 ## CreateSubject
 
-> CreateSubject(ctx, subject).Execute()
+> CreateSubject(ctx, subject).CreateSubject(createSubject).Execute()
 
 Create a subject
 
@@ -33,10 +33,11 @@ import (
 
 func main() {
     subject := "subject_example" // string | 
+    createSubject := *openapiclient.NewCreateSubject() // CreateSubject | 
 
     configuration := openapiclient.NewConfiguration()
     apiClient := openapiclient.NewAPIClient(configuration)
-    resp, r, err := apiClient.SubjectApi.CreateSubject(context.Background(), subject).Execute()
+    resp, r, err := apiClient.SubjectApi.CreateSubject(context.Background(), subject).CreateSubject(createSubject).Execute()
     if err != nil {
         fmt.Fprintf(os.Stderr, "Error when calling `SubjectApi.CreateSubject``: %v\n", err)
         fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -60,6 +61,7 @@ Other parameters are passed through a pointer to a apiCreateSubjectRequest struc
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
 
+ **createSubject** | [**CreateSubject**](CreateSubject.md) |  | 
 
 ### Return type
 
@@ -71,7 +73,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)