How mostenberg/soastaperfperl works
Project type and purpose
• This is an open-source integration tool (a Perl script plus supporting libraries) whose purpose is to automate the execution of SOASTA CloudTest performance tests from within a Jenkins build, collect results, enforce performance thresholds, and publish trends and pass/fail status back into Jenkins.
File structure
• Top-level:
• parseSOASTAResultsSummary.pl: main Perl script
• bin/unzip.exe: Windows helper binary
• http-message-master, HTTP-Cookies-6.01, libwww-perl-master: third-party Perl modules under versioned directories
• README.md: high-level instructions for Jenkins setup
• Each module directory contains a Makefile.PL, lib/HTTP/*, and t/ (tests), indicating standard Perl distribution layout.
• No frontend/backend separation; it's a command-line tool that talks over HTTP to external services.
README for additional insights
• Dependencies: Jenkins Plot Plugin, JUnit publisher
• Workflow:
a) Jenkins sources the code from GitHub into workspace/SOASTA
b) Jenkins runs parseSOASTAResultsSummary.pl with credentials and thresholds
c) Script invokes SCOMMAND tool to trigger test on CloudTest server
d) Script polls or retrieves results via HTTP (using LWP, HTTP::Message, HTTP::Cookies)
e) Script writes .csv files for metrics and an XML JUnit report for thresholds
f) Jenkins Plot Plugin renders time-series graphs, JUnit publisher shows pass/fail
a. Main components
• GitHub Repository (source code + Perl modules)
• Jenkins CI Server
• SCM step
• Build step (invokes Perl script)
• Plot Plugin
• JUnit Publisher
• Workspace/SOASTA directory
• parseSOASTAResultsSummary.pl
• SCOMMAND executable
• HTTP:: libraries (LWP, HTTP::Message, HTTP::Cookies)
• SOASTA CloudTest Server (external performance test endpoint)
• Artifacts:
• CSV files for Avg/90th/etc.
• 5_PERF_THRESHOLD_RESULTS.xml
b. Relationships and interactions
1. Jenkins polls GitHub → clones into workspace/SOASTA
2. Jenkins executes parseSOASTAResultsSummary.pl
3. Script calls SCOMMAND → issues HTTP requests to CloudTest (via LWP + HTTP::Message)
4. CloudTest executes load test → responds with raw result data
5. Script processes data → writes CSV metrics + JUnit XML
6. Jenkins Plot Plugin reads CSV → generates trends graph
7. Jenkins JUnit Publisher reads XML → marks build PASS/FAIL
c. Architectural patterns/design principles
• Modular reuse of existing CPAN libraries
• Single responsibility: script orchestrates test, data collection, reporting
• Clear separation of concerns:
• SCM
• Execution (Jenkins steps)
• HTTP communication layer (LWP modules)
• Data output
• Reporting plugins
d. Key technologies/frameworks/libraries
• Perl (main script)
• CPAN modules: LWP::UserAgent, HTTP::Message, HTTP::Cookies, HTTP::Headers
• SCOMMAND (SOASTA command-line tool)
• Jenkins with Plot Plugin & JUnit Publisher
• GitHub SCM
Detail
• Environment boundaries: Jenkins plugin ecosystem vs. external CloudTest service vs. code repository