search

CrowdStrike / cloud-resource-estimator

Cloud deployment size calculation utilities
The Unlicense
17 stars 19 forks source link

Benchmark script and doc updates #28

Closed carlosmmatos closed 1 year ago

carlosmmatos commented 1 year ago

This pull request introduces several improvements to the benchmark.sh script, enhancing its usability and functionality:

  1. Added a usage message function to guide users on how to run the script with proper arguments.
  2. Implemented a function to check if the system has Python3 and pip installed, providing helpful error messages if either is not found.
  3. Refactored the main routine to support specifying one or more cloud providers as arguments. If no arguments are provided, the script attempts to auto-detect the available cloud providers.
  4. Added a function to validate the provided cloud provider argument, ensuring it's one of the supported options (AWS, Azure, or GCP).
  5. Improved error handling and messaging when an invalid cloud provider is specified or if no supported cloud provider is found.
  6. Updated script output and comments for clarity and consistency.
  7. Minor formatting adjustments for better readability.

This PR also updates the documentation to go along with the benchmark script updates. In addition, a new Developer Guide is available to help future contributors.

Finally, the .gitignore file was updated to ignore the cloud-benchmark directory that's generated when the script is executed.