From 4613673e1c905b7e0acddfd72a666f53c1afc8bf Mon Sep 17 00:00:00 2001 From: Anas Muhammed Date: Wed, 23 Oct 2024 16:03:27 +0400 Subject: [PATCH] refactor: rename size to limit --- .../data-sources/falcon_intel_indicators.md | 6 +++--- docs/plugins/plugins.json | 2 +- .../crowdstrike/data_falcon_intel_indicators.go | 9 +++++---- .../data_falcon_intel_indicators_test.go | 17 +++-------------- 4 files changed, 12 insertions(+), 22 deletions(-) diff --git a/docs/plugins/crowdstrike/data-sources/falcon_intel_indicators.md b/docs/plugins/crowdstrike/data-sources/falcon_intel_indicators.md index c61688d5..2b03eced 100644 --- a/docs/plugins/crowdstrike/data-sources/falcon_intel_indicators.md +++ b/docs/plugins/crowdstrike/data-sources/falcon_intel_indicators.md @@ -80,9 +80,9 @@ The data source supports the following execution arguments: data falcon_intel_indicators { # limit the number of queried items # - # Required integer. - # For example: - size = 42 + # Optional integer. + # Default value: + limit = 10 # Indicators filter expression using Falcon Query Language (FQL) # diff --git a/docs/plugins/plugins.json b/docs/plugins/plugins.json index 6590ece3..1910ef55 100644 --- a/docs/plugins/plugins.json +++ b/docs/plugins/plugins.json @@ -176,7 +176,7 @@ ], "arguments": [ "filter", - "size", + "limit", "sort" ] }, diff --git a/internal/crowdstrike/data_falcon_intel_indicators.go b/internal/crowdstrike/data_falcon_intel_indicators.go index 658bf916..a69c5654 100644 --- a/internal/crowdstrike/data_falcon_intel_indicators.go +++ b/internal/crowdstrike/data_falcon_intel_indicators.go @@ -23,9 +23,10 @@ func makeFalconIntelIndicatorsDataSource(loader ClientLoaderFn) *plugin.DataSour 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", }, { @@ -53,9 +54,9 @@ func fetchFalconIntelIndicatorsData(loader ClientLoaderFn) plugin.RetrieveDataFu Detail: err.Error(), }} } - size, _ := params.Args.GetAttrVal("size").AsBigFloat().Int64() + limit, _ := params.Args.GetAttrVal("limit").AsBigFloat().Int64() apiParams := intel.NewQueryIntelIndicatorEntitiesParams().WithDefaults() - apiParams.SetLimit(&size) + apiParams.SetLimit(&limit) apiParams.SetContext(ctx) if filter := params.Args.GetAttrVal("filter"); !filter.IsNull() { filterStr := filter.AsString() diff --git a/internal/crowdstrike/data_falcon_intel_indicators_test.go b/internal/crowdstrike/data_falcon_intel_indicators_test.go index 71521beb..5294e9ca 100644 --- a/internal/crowdstrike/data_falcon_intel_indicators_test.go +++ b/internal/crowdstrike/data_falcon_intel_indicators_test.go @@ -91,7 +91,7 @@ func (s *CrowdstrikeIntelIndicatorsTestSuite) 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) @@ -125,7 +125,7 @@ func (s *CrowdstrikeIntelIndicatorsTestSuite) 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{{ @@ -148,7 +148,7 @@ func (s *CrowdstrikeIntelIndicatorsTestSuite) 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{{ @@ -157,14 +157,3 @@ func (s *CrowdstrikeIntelIndicatorsTestSuite) TestError() { diagtest.DetailContains("something went wrong"), }}.AssertMatch(s.T(), diags, nil) } - -func (s *CrowdstrikeIntelIndicatorsTestSuite) TestMissingArgs() { - plugintest.NewTestDecoder( - s.T(), - s.Datasource().Args, - ).Decode([]diagtest.Assert{ - diagtest.IsError, - diagtest.SummaryEquals("Missing required attribute"), - diagtest.DetailContains("size"), - }) -}