Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/admin/tool/generator/classes/ -> testplan_backend.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

Test plan generator.

Copyright: 2013 David Monllaó
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 317 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

tool_generator_testplan_backend:: (9 methods):
  get_size_choices()
  get_repourl()
  create_testplan_file()
  create_users_file()
  generate_test_plan()
  generate_users_file()
  get_file_record()
  get_course_test_data()
  has_selected_course_any_problem()


Class: tool_generator_testplan_backend  - X-Ref

Generates the files required by JMeter.

get_size_choices()   X-Ref
Gets a list of size choices supported by this backend.

return: array List of size (int) => text description for display

get_repourl()   X-Ref
Getter for moodle-performance-comparison project URL.

return: string

create_testplan_file($courseid, $size)   X-Ref
Creates the test plan file.

param: int $courseid The target course id
param: int $size The test plan size
return: stored_file

create_users_file($courseid, $updateuserspassword, ?int $size = null)   X-Ref
Creates the users data file.

param: int $courseid The target course id
param: bool $updateuserspassword Updates the course users password to $CFG->tool_generator_users_password
param: int|null $size of the test plan. Used to limit the number of users exported
return: stored_file

generate_test_plan($targetcourseid, $size)   X-Ref
Generates the test plan according to the target course contents.

param: int $targetcourseid The target course id
param: int $size The test plan size
return: string The test plan as a string

generate_users_file($targetcourseid, $updateuserspassword, ?int $size = null)   X-Ref
Generates the user's credentials file with all the course's users

param: int $targetcourseid
param: bool $updateuserspassword Updates the course users password to $CFG->tool_generator_users_password
param: int|null $size of the test plan. Used to limit the number of users exported
return: string The users csv file contents.

get_file_record($filearea, $filetype)   X-Ref
Returns a tool_generator file record

param: string $filearea testplan or users
param: string $filetype The file extension jmx or csv
return: stdClass The file record to use when creating tool_generator files

get_course_test_data($targetcourseid)   X-Ref
Gets the data required to fill the test plan template with the database contents.

param: int $targetcourseid The target course id
return: stdClass The ids required by the test plan

has_selected_course_any_problem($course, $size)   X-Ref
Checks if the selected target course is ok.

param: int|string $course
param: int $size
return: array Errors array or false if everything is ok