refactor: rename size to limit

blackstork-io · Oct 23, 2024 · fb8a088 · fb8a088
1 parent 38054ed
commit fb8a088
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 14 deletions.
diff --git a/docs/plugins/crowdstrike/data-sources/falcon_discover_host_details.md b/docs/plugins/crowdstrike/data-sources/falcon_discover_host_details.md
@@ -80,9 +80,9 @@ The data source supports the following execution arguments:
 data falcon_discover_host_details {
   # limit the number of queried items
   #
-  # Required integer.
-  # For example:
-  size = 42
+  # Optional integer.
+  # Default value:
+  limit = 10
 
   # Host search expression using Falcon Query Language (FQL)
   #

diff --git a/docs/plugins/plugins.json b/docs/plugins/plugins.json
@@ -176,7 +176,7 @@
         ],
         "arguments": [
           "filter",
-          "size"
+          "limit"
         ]
       },
       {

diff --git a/examples/templates/crowdstrike/data_falcon_discover_host_details.fabric b/examples/templates/crowdstrike/data_falcon_discover_host_details.fabric
@@ -9,7 +9,7 @@ document "falcon_discover_host_details" {
         client_secret = ""
         client_cloud = "eu-1"
     }
-    size = 100
+    limit = 100
   }
 
   title = "List of discover host details"

diff --git a/examples/templates/crowdstrike/data_falcon_vulnerabilities.fabric b/examples/templates/crowdstrike/data_falcon_vulnerabilities.fabric
@@ -15,7 +15,7 @@ document "vulnerabilities" {
         client_secret = ""
         client_cloud = "eu-1"
     }
-    size = 100
+    limit = 100
   }
 
   title = "List of Falcon vulnerabilities"

diff --git a/internal/crowdstrike/data_falcon_discover_host_details.go b/internal/crowdstrike/data_falcon_discover_host_details.go
@@ -23,9 +23,10 @@ func makeFalconDiscoverHostDetailsDataSource(loader ClientLoaderFn) *plugin.Data
 		Args: &dataspec.RootSpec{
 			Attrs: []*dataspec.AttrSpec{
 				{
-					Name:        "size",
+					Name:        "limit",
 					Type:        cty.Number,
-					Constraints: constraint.Integer | constraint.RequiredNonNull,
+					Constraints: constraint.Integer,
+					DefaultVal:  cty.NumberIntVal(10),
 					Doc:         "limit the number of queried items",
 				},
 				{
@@ -48,9 +49,9 @@ func fetchFalconDiscoverHostDetails(loader ClientLoaderFn) plugin.RetrieveDataFu
 				Detail:   err.Error(),
 			}}
 		}
-		size, _ := params.Args.GetAttrVal("size").AsBigFloat().Int64()
+		limit, _ := params.Args.GetAttrVal("limit").AsBigFloat().Int64()
 		queryHostParams := discover.NewQueryHostsParams().WithDefaults()
-		queryHostParams.SetLimit(&size)
+		queryHostParams.SetLimit(&limit)
 		queryHostParams.SetContext(ctx)
 		queryHostsResponse, err := cli.Discover().QueryHosts(queryHostParams)
 		if err != nil {

diff --git a/internal/crowdstrike/data_falcon_discover_host_details_test.go b/internal/crowdstrike/data_falcon_discover_host_details_test.go
@@ -98,7 +98,7 @@ func (s *CrowdstrikeDiscoverHostDetailsTestSuite) TestBasic() {
 			SetAttr("client_secret", cty.StringVal("test")).
 			Decode(),
 		Args: plugintest.NewTestDecoder(s.T(), s.Datasource().Args).
-			SetAttr("size", cty.NumberIntVal(10)).
+			SetAttr("limit", cty.NumberIntVal(10)).
 			Decode(),
 	})
 	s.Require().Nil(diags)
@@ -132,7 +132,7 @@ func (s *CrowdstrikeDiscoverHostDetailsTestSuite) TestPayloadErrors() {
 			SetAttr("client_secret", cty.StringVal("test")).
 			Decode(),
 		Args: plugintest.NewTestDecoder(s.T(), s.Datasource().Args).
-			SetAttr("size", cty.NumberIntVal(10)).
+			SetAttr("limit", cty.NumberIntVal(10)).
 			Decode(),
 	})
 	diagtest.Asserts{{
@@ -154,7 +154,7 @@ func (s *CrowdstrikeDiscoverHostDetailsTestSuite) TestError() {
 			SetAttr("client_secret", cty.StringVal("test")).
 			Decode(),
 		Args: plugintest.NewTestDecoder(s.T(), s.Datasource().Args).
-			SetAttr("size", cty.NumberIntVal(10)).
+			SetAttr("limit", cty.NumberIntVal(10)).
 			Decode(),
 	})
 	diagtest.Asserts{{
@@ -171,6 +171,6 @@ func (s *CrowdstrikeDiscoverHostDetailsTestSuite) TestMissingArgs() {
 	).Decode([]diagtest.Assert{
 		diagtest.IsError,
 		diagtest.SummaryEquals("Missing required attribute"),
-		diagtest.DetailContains("size"),
+		diagtest.DetailContains("limit"),
 	})
 }