feat(configuration): make max batch results configurable (#11)

* feat(configuration): make max_batch_results configurable

* docs(readme): document environment variable

* test(integrations): updated for new default max_batch_results value

README.md

@@ -44,3 +44,9 @@ fss -i AWS_SECRET_MAN | jq .
 | [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)                                            | `AWS_SECRET_MAN`       |
 
 The *Command Line Argument* above is passed as the `-i` flag. `AWS_SSM` is the default.
+
+## Environment Variables
+
+| Environment Variables   | Description                                                                                                                                                                                                                       | Default  |
+| ---------------------   | ----------                                                                                                                                                                                                                       | -------- |
+| `FSS_MAX_BATCH_RESULTS` | The maximum number of results to request from the underlying secret service per batch. Note that this value might be rejected by the underlying secret service. For example `boto3` validates this value to be <= 50 for AWS SSM | `50`     |

fuzzy_secret_stdout/__main__.py

@@ -1,3 +1,4 @@
+import os
 import sys
 import argparse
 import logging
@@ -14,17 +15,19 @@
 logger = logging.getLogger(__name__)
 
 
+
 def main():
     parser = argparse.ArgumentParser()
-    parser.add_argument('-i', '--integration', choices=Integration.list_options(), default=Integration.AWS_SSM, type=Integration)
+    parser.add_argument("-i", "--integration", choices=Integration.list_options(), default=Integration.AWS_SSM, type=Integration)
+    parser.add_argument("-b", '--max-batch-size', type=int, default=os.environ.get("FSS_MAX_BATCH_RESULTS", 50), dest='max_batch_results')
 
     args = parser.parse_args(sys.argv[1:])
 
     search = FzfPrompt()
     integration_client = create_integration(args.integration)
 
-    with Live(Spinner('dots', text=Text('Loading')), transient=True):
-        result: list[SecretStoreItem] = integration_client.fetch_all()
+    with Live(Spinner("dots", text=Text("Loading")), transient=True):
+        result: list[SecretStoreItem] = integration_client.fetch_all(max_batch_results=args.max_batch_results)
 
     keys: list[str] = [x.key for x in result]
 
@@ -39,5 +42,6 @@ def main():
     for current_result in result:
         sys.stdout.write(current_result.value)
 
-if __name__ == '__main__': # pragma: nocover
+
+if __name__ == "__main__":  # pragma: nocover
     main()

fuzzy_secret_stdout/integrations/__init__.py

@@ -9,7 +9,7 @@
 class SecretIntegration(ABC):
 
     @abstractmethod
-    def fetch_all(self, max_batch_results: Optional[int] = 3) -> list[SecretStoreItem]: # pragma: nocover
+    def fetch_all(self, max_batch_results: Optional[int] = 50) -> list[SecretStoreItem]: # pragma: nocover
         pass
 
     @abstractmethod

fuzzy_secret_stdout/integrations/aws_secret_manager.py

@@ -11,7 +11,7 @@ class AWSSecretManager(SecretIntegration):
     def __init__(self, boto_client) -> None:
         self._boto_client = boto_client
 
-    def fetch_all(self, max_batch_results: Optional[int] = 3) -> list[SecretStoreItem]:
+    def fetch_all(self, max_batch_results: Optional[int] = 50) -> list[SecretStoreItem]:
 
         def inner(boto_client, **kwargs):
             return boto_client.list_secrets(**kwargs)

fuzzy_secret_stdout/integrations/aws_ssm.py

@@ -11,7 +11,7 @@ class AWSParameterStore(SecretIntegration):
     def __init__(self, boto_client) -> None:
         self._boto_client = boto_client
 
-    def fetch_all(self, max_batch_results: Optional[int] = 3) -> list[SecretStoreItem]:
+    def fetch_all(self, max_batch_results: Optional[int] = 50) -> list[SecretStoreItem]:
 
         def inner(boto_client, **kwargs):
             return boto_client.describe_parameters(**kwargs)

tests/integrations/test_aws_secret_manager.py

@@ -17,7 +17,7 @@ def test_fetch_all_no_parameters(list_secrets_return: dict):
     result = integration.fetch_all()
 
     assert result == []
-    assert mock_secret_man.list_secrets.call_args_list == [call(MaxResults=3)]
+    assert mock_secret_man.list_secrets.call_args_list == [call(MaxResults=50)]
 
 
 @pytest.mark.parametrize("max_results", [
@@ -48,7 +48,7 @@ def test_fetch_all__keys_no_pagination():
     integration = AWSSecretManager(mock_secret_man)
     result = integration.fetch_all()
 
-    assert mock_secret_man.list_secrets.call_args_list == [call(MaxResults=3)]
+    assert mock_secret_man.list_secrets.call_args_list == [call(MaxResults=50)]
     assert result == [
         SecretStoreItem(key='param1'),
         SecretStoreItem(key='param2'),
@@ -87,7 +87,7 @@ def test_fetch_all_keys_pagination():
         SecretStoreItem(key='param4')
     ]
 
-    assert mock_secret_man.list_secrets.call_args_list == [call(MaxResults=3), call(NextToken='token1', MaxResults=3), call(NextToken='token2', MaxResults=3)]
+    assert mock_secret_man.list_secrets.call_args_list == [call(MaxResults=50), call(NextToken='token1', MaxResults=50), call(NextToken='token2', MaxResults=50)]
 
 def test_fetch_secrets():
     input = ['param1']

tests/integrations/test_aws_ssm.py

@@ -18,7 +18,7 @@ def test_fetch_all_no_parameters(describe_parameters_return: dict):
     result = integration.fetch_all()
 
     assert result == []
-    assert mock_ssm.describe_parameters.call_args_list == [call(MaxResults=3)]
+    assert mock_ssm.describe_parameters.call_args_list == [call(MaxResults=50)]
 
 
 @pytest.mark.parametrize("max_results", [
@@ -49,7 +49,7 @@ def test_fetch_all_ssm_keys_no_pagination():
     integration = AWSParameterStore(mock_ssm)
     result = integration.fetch_all()
 
-    assert mock_ssm.describe_parameters.call_args_list == [call(MaxResults=3)]
+    assert mock_ssm.describe_parameters.call_args_list == [call(MaxResults=50)]
     assert result == [
         SecretStoreItem(key='param1'),
         SecretStoreItem(key='param2'),
@@ -88,7 +88,7 @@ def test_fetch_all_ssm_keys_pagination():
         SecretStoreItem(key='param4')
     ]
 
-    assert mock_ssm.describe_parameters.call_args_list == [call(MaxResults=3), call(NextToken='token1', MaxResults=3), call(NextToken='token2', MaxResults=3)]
+    assert mock_ssm.describe_parameters.call_args_list == [call(MaxResults=50), call(NextToken='token1', MaxResults=50), call(NextToken='token2', MaxResults=50)]
 
 
 def test_fetch_secrets():