Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 4.14 KB

README.md

File metadata and controls

67 lines (51 loc) · 4.14 KB
Raw

Paging Volume Test

Provides data out performance metrics for the ODS / AP aimed at analysis of bottlenecks, and providing recommendations for server sizing for representative agency simulation sizes.

Getting Started

  1. Requires Python 3.9+ and Poetry.

  2. Install required Python packages:

    poetry install

Running the Tool

For detailed help, execute poetry run python edfi_paging_test -h.

Sample call using full integrated security, loading from the sample files directory:

poetry run python edfi_paging_test -b "https://localhost:54746" -k "testkey" -s "testsecret" -r "resource1" "resource2"

Supported arguments

Command Line Argument Required Description
-b or --baseUrl yes (no default) ​The base url used to derived api, metadata, oauth, and dependency urls (e.g., http://server)
-k or --key yes (no default) The web API OAuth key
-s or --secret yes (no default) The web API OAuth secret
-i or --ignoreCertificateErrors no (default: false) Ignore certificate errors
-c or --connectionLimit no (default: 5) Maximum concurrent connections to api
-o or --output no (default: out) Directory for writing results
-t or --contentType no (default: csv) Output file content type: CSV, JSON
-r or --resourceList no (no default) (Optional) List of resources to test - if not provided, all resources will be retrieved
-p or --pageSize no (default: 100) The page size to request. Max: 500.
-l or --logLevel no (default: INFO) Override the console output log level: VERBOSE, DEBUG, INFO, WARN, ERROR
-d or --description no (default: Paging Volume Test Run) Description for the test run

Each argument can also be set by environment variable, or by using as .env file. See .env.example. Arguments provided at the command line override any arguments provided by environment variable.

Resource List

When no resource list is provided, the tool will query the OpenAPI (Swagger) metadata to find all available resources, and then retrieve all of them.

To limit to testing specific resources, simply pass the list of resource names to be retrieved. For example, Students StudentSectionAssociations will return only those two resources. To retrieve a resource from an extension, prefix that resource with the extension name and a slash. For example: Students tpdm/Candidates will retrieve all records from the /ed-fi/Students and the tpdm/Candidates endpoints. Note that this is not case sensitive. When using a .env file, the argument is set off as an array, e.g. PERF_RESOURCE_LIST=["students", "StudentSchoolAssociations", "tpdm/candidates"]

Dev Operations

  1. Style check: poetry run flake8
  2. Static typing check: poetry run mypy .
  3. Run unit tests: poetry run pytest
  4. Run unit tests with code coverage: poetry run coverage run -m pytest tests
  5. View code coverage: poetry run coverage report