{"id":23122821,"url":"https://github.com/folio-org/folio-perf-test","last_synced_at":"2025-07-28T20:08:55.638Z","repository":{"id":32578968,"uuid":"136349459","full_name":"folio-org/folio-perf-test","owner":"folio-org","description":"Jenkins pipelines to test FOLIO performance and integration","archived":false,"fork":false,"pushed_at":"2023-03-20T09:30:37.000Z","size":979,"stargazers_count":4,"open_issues_count":2,"forks_count":5,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-04-04T23:11:18.554Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Groovy","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/folio-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-06T15:32:27.000Z","updated_at":"2024-11-05T16:03:13.000Z","dependencies_parsed_at":"2024-12-17T07:30:48.765Z","dependency_job_id":"d48b04c5-be34-490d-9239-1f43a17d7dcd","html_url":"https://github.com/folio-org/folio-perf-test","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/folio-org/folio-perf-test","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Ffolio-perf-test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Ffolio-perf-test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Ffolio-perf-test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Ffolio-perf-test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/folio-org","download_url":"https://codeload.github.com/folio-org/folio-perf-test/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Ffolio-perf-test/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267578000,"owners_count":24110351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-28T02:00:09.689Z","response_time":68,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-17T07:30:40.217Z","updated_at":"2025-07-28T20:08:55.610Z","avatar_url":"https://github.com/folio-org.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"folio-perf-test - Jenkins pipeline to test FOLIO performance\n=================================\n\nCopyright (C) 2018-2020 The Open Library Foundation\n\nThis software is distributed under the terms of the Apache License,\nVersion 2.0. See the file \"[LICENSE](LICENSE)\" for more information.\n\nSystem requirements\n-------------------\n\n* Jenkins on Linux with default plugins installed\n\n* Extra Jenkins plugins: Pipeline Utility Steps, HTTP Request Plugin, SSH Agent Plugin, CloudBees AWS Credentials Plugin, Performance\n\n* Install aws-cli and JMeter on Jenkins\n\n* Jenkins access to AWS\n\nTest Strategies\n----------------\n### Metrics:\nThis is a list of metrics that are gathered during this experiment:\n\n* Average response times (ART) for each transaction\n* Min and Max response times\n* Median\n* Failure rate and errors/warnings in the logs\n* Throughtput\n\nThese metrics are collected as part of Performance Report which are generated as build artifact\n\n### Tools:\nTools used for these test cases is JMeter - https://jmeter.apache.org/ Utilized non-GUI JMeter.\n\nFor example, non-GUI commandline to generate report:\n\n`jmeter -Jjmeter.save.saveservice.output_format=xml -n -l jmeter_perf.jtl -t Folio-Test-Plans/mod-inventory-storage/instance-storage/instance-storageTestPlan.jmx -j jmeter_46_instance-storageTestPlan.jmx.log`\n\nReports are generating in Jenkins using JMeter Performance plugin - https://wiki.jenkins.io/display/JENKINS/Performance+Plugin \n\nTests are scheduled to run in Jenkins pipeline - https://jenkins-aws.indexdata.com/job/Automation/job/folio-perf-test/\n \n### SLA Goals:\n* The average response time (AVG RT) for the JMeter captured transaction should not be more than 1000 milliseconds.\n* The percent of CPU utilization on any module should not be more than 50%.\n* JMeter tests running nightly in Jenkins pipeline as a job will fail if even a single test fails \n\n\n### Environment:\n* Engine: PostgreSQL 9.6.8\n* Entire Stack(environment) is created fresh from scratch everyday by populating dataset in database then running JMeter on top of it and once tests complete running, tear down the environment.\n* JMeter scripts are running against ~3 million Harvard dataset\n\n### Workflow used to test all APIs:\n* Create new data by doing POST HTTP request, run JMeter tests and clean it by doing DELETE HTTP request once test completes.\n\n\nQuick start\n-----------\n\n* Import in Jenkins as standard pipeline project\n\n* Pick a Jenkinsfile and adjust build parameters as needed\n\n## Additional information\n\n### Issue tracker\n\nSee project [FOLIO](https://issues.folio.org/browse/FOLIO)\nat the [FOLIO issue tracker](https://dev.folio.org/guidelines/issue-tracker).\n\n### Other documentation\n\nOther [infrastructure projects](https://dev.folio.org/source-code/#other-projects) are described,\nwith further FOLIO Developer documentation at [dev.folio.org](https://dev.folio.org/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffolio-org%2Ffolio-perf-test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffolio-org%2Ffolio-perf-test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffolio-org%2Ffolio-perf-test/lists"}