Skip to content
GitLab
Commit 4322671d authored by Lückemeyer's avatar Lückemeyer
Browse files

adjusted member and method names to moodle approval criteria

parent e350d2f5
sahal-recommendations-table-privacy-provider-changes moodledta
1 merge request!1Coding style and recommendations
Hide whitespace changes
Inline Side-by-side
Showing
with 74 additions and 83 deletions
+74 -83
dta.zip
+ 0
- 0
View file @ 4322671d
No preview for this file type
dta/locallib.php
+ 7
- 7
View file @ 4322671d
......@@ -153,7 +153,7 @@ class assign_submission_dta extends assign_submission_plugin {
$file = reset($files);
// Send file to backend.
return DtaBackendUtils::sendTestConfigToBackend($this->assignment, $file);
return DtaBackendUtils::sendtestconfigtobackend($this->assignment, $file);
}
/**
......@@ -275,7 +275,7 @@ class assign_submission_dta extends assign_submission_plugin {
$file = reset($files);
// Send file to backend.
$response = DtaBackendUtils::sendSubmissionToBackend($this->assignment, $file);
$response = DtaBackendUtils::sendsubmissiontobackend($this->assignment, $file);
// With a null response, return an error.
if (is_null($response)) {
......@@ -283,10 +283,10 @@ class assign_submission_dta extends assign_submission_plugin {
}
// Convert received json to valid class instances.
$resultsummary = DtaResultSummary::decodeJson($response);
$resultsummary = DtaResultSummary::decodejson($response);
// Persist new results to database.
DbUtils::storeResultSummaryToDatabase($this->assignment->get_instance()->id, $submission->id, $resultsummary);
DbUtils::storeresultsummarytodatabase($this->assignment->get_instance()->id, $submission->id, $resultsummary);
return true;
}
......@@ -303,7 +303,7 @@ class assign_submission_dta extends assign_submission_plugin {
public function view_summary(stdClass $submission, & $showviewlink) {
$showviewlink = true;
return ViewSubmissionUtils::generateSummaryHtml(
return ViewSubmissionUtils::generatesummaryhtml(
$this->assignment->get_instance()->id,
$submission->id
);
......@@ -316,7 +316,7 @@ class assign_submission_dta extends assign_submission_plugin {
* @return string detailed results html
*/
public function view(stdClass $submission) {
return ViewSubmissionUtils::generateDetailHtml(
return ViewSubmissionUtils::generatedetailhtml(
$this->assignment->get_instance()->id,
$submission->id
);
......@@ -383,7 +383,7 @@ class assign_submission_dta extends assign_submission_plugin {
* @return bool
*/
public function delete_instance() {
DbUtils::uninstallPluginCleanUp();
DbUtils::uninstallplugincleanup();
return true;
}
......
dta/models/DtaResult.php
+ 34
- 43
View file @ 4322671d
......@@ -18,8 +18,8 @@ defined('MOODLE_INTERNAL') || die();
class DtaResult {
public $packageName;
public $className;
public $packagename;
public $classname;
public $name;
/**
......@@ -32,12 +32,12 @@ class DtaResult {
*/
public $state;
public $failureType;
public $failureReason;
public $failuretype;
public $failurereason;
public $stacktrace;
public $columnNumber;
public $lineNumber;
public $columnnumber;
public $linenumber;
public $position;
/**
......@@ -59,58 +59,50 @@ class DtaResult {
class DtaResultSummary {
public $timestamp;
public $globalStacktrace;
public $successfulTestCompetencyProfile;
public $overallTestCompetencyProfile;
public $globalstacktrace;
public $successfultestcompetencies;
public $overalltestcompetencies;
public $results;
/**
* @param string $jsonString jsonString containing DtaResultSummary
* @return DtaResultSummary
*/
public static function decodeJson($jsonstring): DtaResultSummary {
public static function decodejson($jsonstring): DtaResultSummary {
$response = json_decode($jsonstring);
$summary = new DtaResultSummary();
$summary->timestamp = $response->timestamp;
$summary->globalStacktrace = $response->globalStacktrace;
$summary->globalstacktrace = $response->globalstacktrace;
$summary->successfulTestCompetencyProfile = $response->successfulTestCompetencyProfile;
$summary->overallTestCompetencyProfile = $response->overallTestCompetencyProfile;
$summary->successfultestcompetencies = $response->successfulTestCompetencyProfile;
$summary->overalltestcompetencies = $response->overallTestCompetencyProfile;
$summary->results = self::decodeJsonResultArray($response->results);
$summary->results = self::decodejsonresultarray($response->results);
return $summary;
}
private static function decodeJsonCompetencyArray($jsonarray): array {
$ret = array();
foreach ($jsonarray as $entry) {
$ret[] = $entry;
}
return $ret;
}
/**
* @param array $jsonArray decoded json array of results array
* @return array of DtaResult
*/
private static function decodeJsonResultArray($jsonarray): array {
private static function decodejsonresultarray($jsonarray): array {
$ret = array();
foreach ($jsonarray as $entry) {
$value = new DtaResult();
$value->packageName = $entry->packageName;
$value->className = $entry->className;
$value->packagename = $entry->packageName;
$value->classname = $entry->className;
$value->name = $entry->name;
$value->state = $entry->state;
$value->failureType = $entry->failureType;
$value->failureReason = $entry->failureReason;
$value->failuretype = $entry->failureType;
$value->failurereason = $entry->failureReason;
$value->stacktrace = $entry->stacktrace;
$value->columnNumber = $entry->columnNumber;
$value->lineNumber = $entry->lineNumber;
$value->columnnumber = $entry->columnNumber;
$value->linenumber = $entry->lineNumber;
$value->position = $entry->position;
$ret[] = $value;
......@@ -118,39 +110,38 @@ class DtaResultSummary {
return $ret;
}
public function resultcount(): int {
return count($this->results);
}
/**
* @param int $state state ordinal number
* @return int count of occurences provided state has
*/
public function stateOccurenceCount(int $state): int {
public function stateoccurencecount(int $state): int {
$num = 0;
foreach ($this->results as $r) {
if ($r->state == $state) {
$num++;
}
}
return $num;
}
public function compilationErrorCount(): int {
return $this->stateOccurenceCount(3);
public function compilationerrorcount(): int {
return $this->stateoccurencecount(3);
}
public function failedCount(): int {
return $this->stateOccurenceCount(2);
}
public function resultCount(): int {
return count($this->results);
public function failedcount(): int {
return $this->stateoccurencecount(2);
}
public function successfulCount(): int {
return $this->stateOccurenceCount(1);
public function successfulcount(): int {
return $this->stateoccurencecount(1);
}
public function unknownCount(): int {
return $this->stateOccurenceCount(0);
public function unknowncount(): int {
return $this->stateoccurencecount(0);
}
}
dta/utils/backend.php
+ 5
- 5
View file @ 4322671d
......@@ -19,7 +19,7 @@ class DtaBackendUtils {
/**
* @return string backend host base url
*/
private static function getBackendBaseUrl(): string {
private static function getbackendbaseurl(): string {
$backendaddress = get_config(assign_submission_dta::COMPONENT_NAME, "backendHost");
if (empty($backendaddress)) {
......@@ -37,8 +37,8 @@ class DtaBackendUtils {
*
* @return bool true if no error occurred
*/
public static function sendTestConfigToBackend($assignment, $file): bool {
$backendaddress = self::getBackendBaseUrl();
public static function sendtestconfigtobackend($assignment, $file): bool {
$backendaddress = self::getbackendbaseurl();
if (empty($backendaddress)) {
return true;
}
......@@ -68,8 +68,8 @@ class DtaBackendUtils {
*
* @return string json string with testresults or null on error
*/
public static function sendSubmissionToBackend($assignment, $file): ?string {
$backendaddress = self::getBackendBaseUrl();
public static function sendsubmissiontobackend($assignment, $file): ?string {
$backendaddress = self::getbackendbaseurl();
if (empty($backendaddress)) {
return true;
}
......
dta/utils/database.php
+ 23
- 23
View file @ 4322671d
......@@ -22,13 +22,13 @@ class DbUtils {
private const TABLE_RESULT = "assignsubmission_dta_result";
/**
* get's summary with all corresponding result entries
* gets summary with all corresponding result entries
*
* @param int $assignmentid assignment id to search for
* @param int $submissionid submission id to search for
* @return DttResultSummary representing given submission
*/
public static function getResultSummaryFromDatabase(
public static function getresultsummaryfromdatabase(
int $assignmentid,
int $submissionid
): DtaResultSummary {
......@@ -48,23 +48,23 @@ class DbUtils {
// Create a summary instance.
$summary = new DtaResultSummary();
$summary->timestamp = $summaryrecord->timestamp;
$summary->globalStacktrace = $summaryrecord->global_stacktrace;
$summary->successfulTestCompetencyProfile = $summaryrecord->successful_competencies;
$summary->overallTestCompetencyProfile = $summaryrecord->tested_competencies;
$summary->globalstacktrace = $summaryrecord->global_stacktrace;
$summary->successfultestcompetencies = $summaryrecord->successful_competencies;
$summary->overalltestcompetencies = $summaryrecord->tested_competencies;
$summary->results = array();
// Create result instances and add to array of summary instance.
foreach ($resultsarray as $rr) {
$result = new DtaResult();
$result->packageName = $rr->package_name;
$result->className = $rr->class_name;
$result->packagename = $rr->package_name;
$result->classname = $rr->class_name;
$result->name = $rr->name;
$result->state = $rr->state;
$result->failureType = $rr->failure_type;
$result->failureReason = $rr->failure_reason;
$result->failuretype = $rr->failure_type;
$result->failurereason = $rr->failure_reason;
$result->stacktrace = $rr->stacktrace;
$result->columnNumber = $rr->column_number;
$result->lineNumber = $rr->line_number;
$result->columnnumber = $rr->column_number;
$result->linenumber = $rr->line_number;
$result->position = $rr->position;
$summary->results[] = $result;
......@@ -81,7 +81,7 @@ class DbUtils {
* @param int submissionid submission of this result
* @param DttResultSummary instance to persist
*/
public static function storeResultSummaryToDatabase(
public static function storeresultsummarytodatabase(
int $assignmentid,
int $submissionid,
DtaResultSummary $summary
......@@ -92,26 +92,26 @@ class DbUtils {
$summaryrecord = new stdClass();
$summaryrecord->assignment_id = $assignmentid;
$summaryrecord->submission_id = $submissionid;
$summaryrecord->successful_competencies = $summary->successfulTestCompetencyProfile;
$summaryrecord->tested_competencies = $summary->overallTestCompetencyProfile;
$summaryrecord->timestamp = $summary->timestamp;
$summaryrecord->global_stacktrace = $summary->globalStacktrace;
$summaryrecord->global_stacktrace = $summary->globalstacktrace;
$summaryrecord->successful_competencies = $summary->successfultestcompetencies;
$summaryrecord->tested_competencies = $summary->overalltestcompetencies;
// Prepare results to persist to array.
$resultrecords = array();
foreach ($summary->results as $r) {
$record = new stdClass();
$record->assignment_id = $assignmentid;
$record->submission_id = $submissionid;
$record->package_name = $r->packageName;
$record->class_name = $r->className;
$record->package_name = $r->packagename;
$record->class_name = $r->classname;
$record->name = $r->name;
$record->state = $r->state;
$record->failure_type = $r->failureType;
$record->failure_reason = $r->failureReason;
$record->failure_type = $r->failuretype;
$record->failure_reason = $r->failurereason;
$record->stacktrace = $r->stacktrace;
$record->column_number = $r->columnNumber;
$record->line_number = $r->lineNumber;
$record->column_number = $r->columnnumber;
$record->line_number = $r->linenumber;
$record->position = $r->position;
$resultrecords[] = $record;
}
......@@ -144,7 +144,7 @@ class DbUtils {
/**
* cleans up database if plugin is uninstalled
*/
public static function uninstallPluginCleanUp(): void {
public static function uninstallplugincleaup(): void {
global $DB;
$DB->delete_records(self::TABLE_RESULT, null);
......
dta/utils/view.php
+ 5
- 5
View file @ 4322671d
......@@ -23,7 +23,7 @@ class ViewSubmissionUtils {
* @param int submissionid submission to create a report for
* @return string html
*/
public static function generateSummaryHtml(
public static function generatesummaryhtml(
int $assignmentid,
int $submissionid
): string {
......@@ -64,7 +64,7 @@ class ViewSubmissionUtils {
* @param int assignmentid assignment
* @param int submissionid submission to create a report for
*/
public static function generateDetailHtml(
public static function generatedetailhtml(
int $assignmentid,
int $submissionid
): string {
......@@ -104,7 +104,7 @@ class ViewSubmissionUtils {
$resultrowattributes = $tablerowattributes;
$resultrowattributes['class'] = $resultrowattributes['class'] . " " . $unknownattributes;
$body .= html_writer::tag("tr", $tmp, $resultrowattributes);
$tmp = "";
......@@ -205,7 +205,7 @@ class ViewSubmissionUtils {
$body = "";
$spacerrow = null;
foreach($summary->results as $r) {
foreach ($summary->results as $r) {
// Add spacer first if not null.
if (!is_null($spacerrow)) {
$body .= $spacerrow;
......@@ -256,7 +256,7 @@ class ViewSubmissionUtils {
"td",
"failure type",
$attributes);
$tmp .= html_writer::tag(
"td",
$r->failureType,
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Dies ist die Gitlab-Instanz des Transferportals der Hochschule für Technik Stuttgart. Hier geht es zurück zum Portal