stac-api-load-testing 0.2.0__tar.gz

stac_api_load_testing-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Jonathan Healy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

stac_api_load_testing-0.2.0/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: stac_api_load_testing
+Version: 0.2.0
+Summary: Load testing for stac compliant apis
+Home-page: https://github.com/Healy-Hyperspatial/stac-api-load-testing
+Author: Jonathan Healy
+Author-email: jonathan.d.healy@gmail.com
+License: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=7.1.2
+Requires-Dist: locust
+Requires-Dist: setuptools
+Requires-Dist: Cython
+Requires-Dist: bzt
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+
+# stac-api-load-testing
+Taurus and Locust load testing tools for stac-api backends.
+
+![Alt text](readme_files/taurus-pgstac.png?raw=true "stac-fastapi-pgstac")
+
+
+## Run stac-fastapi backends locally (elasticsearch|opensearch|pgstac|mongo)
+```$ docker-compose up elasticsearch```   
+```$ docker-compose up app-elasticsearch```
+
+## Install locally for development
+```$ pip install -e .```  
+    
+## Install from PyPI   
+```$ pip install stac-api-load-testing```  
+
+```
+Usage: stac-api-load-testing [OPTIONS]
+
+  Entry point for the stac-api-load-testing CLI tool.
+
+  This tool facilitates data ingestion, Locust load testing, and Taurus
+  performance testing against a specified STAC API endpoint.
+
+  Args:     
+  ingest (bool): If True, ingest sample data into the specified STAC API.     
+  locust (bool): If True, execute Locust load tests against the
+  specified STAC API.     
+  taurus (bool): If True, perform Taurus performance
+  testing with custom settings against the specified STAC API.     
+  concurrency (int): Specifies the number of concurrent users for Taurus testing. Default is 10.      
+  ramp_up (str): Specifies the ramp-up period for Taurus testing, in Taurus notation (e.g., '1m' for 1 minute). Default is '1m'.  
+  iterations (int): Specifies the number of iterations each virtual user will
+  execute in Taurus testing. Default is 100.     
+  api_address (str): The base URL of the STAC API to be tested.
+
+Options:
+  -i, --ingest               Ingest sample data into the STAC API.
+  -l, --locust               Run Locust load tests against the STAC API.
+  -t, --taurus               Run the Taurus wrapper for performance testing
+                             against the STAC API.
+  -c, --concurrency INTEGER  Number of concurrent users for Taurus option.
+  -r, --ramp-up TEXT         Ramp-up time for Taurus option.
+  -n, --iterations INTEGER   Number of iterations for Taurus option.
+  -a, --api-address TEXT     Specify the STAC API URL to test against.
+  --version                  Show the version and exit.
+  --help                     Show this message and exit.
+```
+
+## Ingest test data - http://localhost:8084 is just an example url
+```$ stac-api-load-testing --ingest --api-address http://localhost:8084```
+
+## Run Locust Load Testing Ouside of Taurus Wrapper
+```$ stac-api-load-testing --locust --api-address http://localhost:8084```  
+- go to ```http://localhost:8089``` and start with desired settings
+
+## Inside of Taurus Wrapper
+```$ stac-api-load-testing --taurus --api-address http://localhost:8084```
+
+## Debugging Locust tasks using a single simulated user
+```$ python stac_api_load_testing/config_files/locustfile.py```

stac_api_load_testing-0.2.0/README.md

@@ -0,0 +1,61 @@
+# stac-api-load-testing
+Taurus and Locust load testing tools for stac-api backends.
+
+![Alt text](readme_files/taurus-pgstac.png?raw=true "stac-fastapi-pgstac")
+
+
+## Run stac-fastapi backends locally (elasticsearch|opensearch|pgstac|mongo)
+```$ docker-compose up elasticsearch```   
+```$ docker-compose up app-elasticsearch```
+
+## Install locally for development
+```$ pip install -e .```  
+    
+## Install from PyPI   
+```$ pip install stac-api-load-testing```  
+
+```
+Usage: stac-api-load-testing [OPTIONS]
+
+  Entry point for the stac-api-load-testing CLI tool.
+
+  This tool facilitates data ingestion, Locust load testing, and Taurus
+  performance testing against a specified STAC API endpoint.
+
+  Args:     
+  ingest (bool): If True, ingest sample data into the specified STAC API.     
+  locust (bool): If True, execute Locust load tests against the
+  specified STAC API.     
+  taurus (bool): If True, perform Taurus performance
+  testing with custom settings against the specified STAC API.     
+  concurrency (int): Specifies the number of concurrent users for Taurus testing. Default is 10.      
+  ramp_up (str): Specifies the ramp-up period for Taurus testing, in Taurus notation (e.g., '1m' for 1 minute). Default is '1m'.  
+  iterations (int): Specifies the number of iterations each virtual user will
+  execute in Taurus testing. Default is 100.     
+  api_address (str): The base URL of the STAC API to be tested.
+
+Options:
+  -i, --ingest               Ingest sample data into the STAC API.
+  -l, --locust               Run Locust load tests against the STAC API.
+  -t, --taurus               Run the Taurus wrapper for performance testing
+                             against the STAC API.
+  -c, --concurrency INTEGER  Number of concurrent users for Taurus option.
+  -r, --ramp-up TEXT         Ramp-up time for Taurus option.
+  -n, --iterations INTEGER   Number of iterations for Taurus option.
+  -a, --api-address TEXT     Specify the STAC API URL to test against.
+  --version                  Show the version and exit.
+  --help                     Show this message and exit.
+```
+
+## Ingest test data - http://localhost:8084 is just an example url
+```$ stac-api-load-testing --ingest --api-address http://localhost:8084```
+
+## Run Locust Load Testing Ouside of Taurus Wrapper
+```$ stac-api-load-testing --locust --api-address http://localhost:8084```  
+- go to ```http://localhost:8089``` and start with desired settings
+
+## Inside of Taurus Wrapper
+```$ stac-api-load-testing --taurus --api-address http://localhost:8084```
+
+## Debugging Locust tasks using a single simulated user
+```$ python stac_api_load_testing/config_files/locustfile.py```

stac_api_load_testing-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

stac_api_load_testing-0.2.0/setup.py

@@ -0,0 +1,35 @@
+"""stac-api-load-testing setup.py."""
+from setuptools import setup
+
+__version__ = "0.2.0"
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setup(
+    name="stac_api_load_testing",
+    version=__version__,
+    description="Load testing for stac compliant apis",
+    url="https://github.com/Healy-Hyperspatial/stac-api-load-testing",
+    include_package_data=True,
+    install_requires=[
+        "click>=7.1.2",
+        "locust",
+        "setuptools",
+        "Cython",
+        "bzt",
+    ],
+    packages=["stac_api_load_testing"],
+    entry_points={
+        "console_scripts": ["stac-api-load-testing=stac_api_load_testing.cli:main"]
+    },
+    author="Jonathan Healy",
+    author_email="jonathan.d.healy@gmail.com",
+    license="MIT",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    python_requires=">=3.7",
+    extras_require={
+        "test": ["pytest"],
+    },
+)

stac_api_load_testing-0.2.0/stac_api_load_testing/cli.py

@@ -0,0 +1,143 @@
+"""stac-api-load-testing cli tool."""
+import os
+import re
+import subprocess
+
+import click
+import pkg_resources  # type: ignore
+import yaml  # type: ignore
+
+from .data_loader import data_loader
+
+
+def generate_taurus_config(api_url: str, concurrency: int, ramp_up, iterations) -> str:
+    """
+    Generate a custom Taurus configuration file based on the specified settings.
+
+    Args:
+        api_url (str): The base URL for the STAC API to be tested.
+        concurrency (int): The number of concurrent users to simulate.
+        ramp_up (str): The duration over which to ramp up the load test.
+        iterations (int): The total number of iterations to perform.
+
+    Returns:
+        str: The path to the generated Taurus configuration file.
+    """
+    template_path = pkg_resources.resource_filename(
+        __name__, "config_files/taurus_locust.yml"
+    )
+    locustfile_path = pkg_resources.resource_filename(
+        __name__, "config_files/locustfile.py"
+    )
+
+    safe_api_url = re.sub(r"[^a-zA-Z0-9]+", "_", api_url)
+    output_path = f"taurus_config_{safe_api_url}.yml"
+
+    try:
+        with open(template_path, "r") as file:
+            config = yaml.safe_load(file)
+
+        # Setting the script path directly to where `locustfile.py` is expected to be within the package
+        config["execution"][0]["concurrency"] = concurrency
+        config["execution"][0]["ramp-up"] = ramp_up
+        config["execution"][0]["iterations"] = iterations
+        config["scenarios"]["default"]["script"] = locustfile_path
+        config["scenarios"]["default"]["default-address"] = api_url
+
+        with open(output_path, "w") as file:
+            yaml.safe_dump(config, file)
+
+        return output_path
+    except Exception as e:
+        print(f"Error creating Taurus configuration file: {e}")
+        return None
+
+
+@click.command()
+@click.option(
+    "-i", "--ingest", is_flag=True, help="Ingest sample data into the STAC API."
+)
+@click.option(
+    "-l", "--locust", is_flag=True, help="Run Locust load tests against the STAC API."
+)
+@click.option(
+    "-t",
+    "--taurus",
+    is_flag=True,
+    help="Run the Taurus wrapper for performance testing against the STAC API.",
+)
+@click.option(
+    "-c",
+    "--concurrency",
+    default=10,
+    help="Number of concurrent users for Taurus option.",
+    type=int,
+)
+@click.option("-r", "--ramp-up", default="1m", help="Ramp-up time for Taurus option.")
+@click.option(
+    "-n",
+    "--iterations",
+    default=100,
+    help="Number of iterations for Taurus option.",
+    type=int,
+)  # Changed the flag to -n to avoid conflict
+@click.option(
+    "-a",
+    "--api-address",
+    default="http://localhost:8080",
+    help="Specify the STAC API URL to test against.",
+)
+@click.version_option(version="0.2.0")
+def main(
+    ingest: bool,
+    locust: bool,
+    taurus: bool,
+    api_address: str,
+    concurrency: int,
+    ramp_up: str,
+    iterations: int,
+):
+    """
+    Entry point for the stac-api-load-testing CLI tool.
+
+    This tool facilitates data ingestion, Locust load testing, and Taurus performance testing
+    against a specified STAC API endpoint.
+
+    Args:
+        ingest (bool): If True, ingest sample data into the specified STAC API.
+        locust (bool): If True, execute Locust load tests against the specified STAC API.
+        taurus (bool): If True, perform Taurus performance testing with custom settings against the specified STAC API.
+        concurrency (int): Specifies the number of concurrent users for Taurus testing. Default is 10.
+        ramp_up (str): Specifies the ramp-up period for Taurus testing, in Taurus notation (e.g., '1m' for 1 minute). Default is '1m'.
+        iterations (int): Specifies the number of iterations each virtual user will execute in Taurus testing. Default is 100.
+        api_address (str): The base URL of the STAC API to be tested.
+    """
+    os.environ["LOCUST_HOST"] = api_address
+
+    if ingest:
+        # Load data into the STAC API
+        data_loader.load_items(stac_api_base_url=api_address)
+    elif locust:
+        # Execute Locust load tests
+        locust_file_path = pkg_resources.resource_filename(
+            __name__, "config_files/locustfile.py"
+        )
+        subprocess.run(
+            ["locust", "--locustfile", locust_file_path, "--host", api_address],
+            check=True,
+        )
+    elif taurus:
+        # Generate and run a custom Taurus configuration for performance testing
+        config_file_path = generate_taurus_config(
+            api_address, concurrency, ramp_up, iterations
+        )
+        if config_file_path:
+            try:
+                subprocess.run(["bzt", config_file_path], check=True)
+            finally:
+                if os.path.exists(config_file_path):
+                    os.remove(config_file_path)  # Cleanup after running
+
+
+if __name__ == "__main__":
+    main()

stac_api_load_testing-0.2.0/stac_api_load_testing.egg-info/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: stac_api_load_testing
+Version: 0.2.0
+Summary: Load testing for stac compliant apis
+Home-page: https://github.com/Healy-Hyperspatial/stac-api-load-testing
+Author: Jonathan Healy
+Author-email: jonathan.d.healy@gmail.com
+License: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=7.1.2
+Requires-Dist: locust
+Requires-Dist: setuptools
+Requires-Dist: Cython
+Requires-Dist: bzt
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+
+# stac-api-load-testing
+Taurus and Locust load testing tools for stac-api backends.
+
+![Alt text](readme_files/taurus-pgstac.png?raw=true "stac-fastapi-pgstac")
+
+
+## Run stac-fastapi backends locally (elasticsearch|opensearch|pgstac|mongo)
+```$ docker-compose up elasticsearch```   
+```$ docker-compose up app-elasticsearch```
+
+## Install locally for development
+```$ pip install -e .```  
+    
+## Install from PyPI   
+```$ pip install stac-api-load-testing```  
+
+```
+Usage: stac-api-load-testing [OPTIONS]
+
+  Entry point for the stac-api-load-testing CLI tool.
+
+  This tool facilitates data ingestion, Locust load testing, and Taurus
+  performance testing against a specified STAC API endpoint.
+
+  Args:     
+  ingest (bool): If True, ingest sample data into the specified STAC API.     
+  locust (bool): If True, execute Locust load tests against the
+  specified STAC API.     
+  taurus (bool): If True, perform Taurus performance
+  testing with custom settings against the specified STAC API.     
+  concurrency (int): Specifies the number of concurrent users for Taurus testing. Default is 10.      
+  ramp_up (str): Specifies the ramp-up period for Taurus testing, in Taurus notation (e.g., '1m' for 1 minute). Default is '1m'.  
+  iterations (int): Specifies the number of iterations each virtual user will
+  execute in Taurus testing. Default is 100.     
+  api_address (str): The base URL of the STAC API to be tested.
+
+Options:
+  -i, --ingest               Ingest sample data into the STAC API.
+  -l, --locust               Run Locust load tests against the STAC API.
+  -t, --taurus               Run the Taurus wrapper for performance testing
+                             against the STAC API.
+  -c, --concurrency INTEGER  Number of concurrent users for Taurus option.
+  -r, --ramp-up TEXT         Ramp-up time for Taurus option.
+  -n, --iterations INTEGER   Number of iterations for Taurus option.
+  -a, --api-address TEXT     Specify the STAC API URL to test against.
+  --version                  Show the version and exit.
+  --help                     Show this message and exit.
+```
+
+## Ingest test data - http://localhost:8084 is just an example url
+```$ stac-api-load-testing --ingest --api-address http://localhost:8084```
+
+## Run Locust Load Testing Ouside of Taurus Wrapper
+```$ stac-api-load-testing --locust --api-address http://localhost:8084```  
+- go to ```http://localhost:8089``` and start with desired settings
+
+## Inside of Taurus Wrapper
+```$ stac-api-load-testing --taurus --api-address http://localhost:8084```
+
+## Debugging Locust tasks using a single simulated user
+```$ python stac_api_load_testing/config_files/locustfile.py```

stac_api_load_testing-0.2.0/stac_api_load_testing.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+setup.py
+stac_api_load_testing/cli.py
+stac_api_load_testing.egg-info/PKG-INFO
+stac_api_load_testing.egg-info/SOURCES.txt
+stac_api_load_testing.egg-info/dependency_links.txt
+stac_api_load_testing.egg-info/entry_points.txt
+stac_api_load_testing.egg-info/requires.txt
+stac_api_load_testing.egg-info/top_level.txt

stac_api_load_testing-0.2.0/stac_api_load_testing.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

stac_api_load_testing-0.2.0/stac_api_load_testing.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+stac-api-load-testing = stac_api_load_testing.cli:main

stac_api_load_testing-0.2.0/stac_api_load_testing.egg-info/requires.txt

@@ -0,0 +1,8 @@
+click>=7.1.2
+locust
+setuptools
+Cython
+bzt
+
+[test]
+pytest

stac_api_load_testing-0.2.0/stac_api_load_testing.egg-info/top_level.txt

@@ -0,0 +1 @@
+stac_api_load_testing