Check language files and database schema with app code checker #4767
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| RESULT=0 | ||
|
|
||
| bash ./build/autoloaderchecker.sh | ||
| RESULT=$(($RESULT+$?)) | ||
| bash ./build/mergejschecker.sh | ||
| RESULT=$(($RESULT+$?)) | ||
| php ./build/translation-checker.php | ||
| RESULT=$(($RESULT+$?)) | ||
| php ./build/htaccess-checker.php | ||
| RESULT=$(($RESULT+$?)) | ||
|
|
||
|
|
||
| for app in $(find "apps/" -mindepth 1 -maxdepth 1 -type d -printf '%f\n'); do | ||
| if | ||
| [ "$app" == "dav" ] || \ | ||
| [ "$app" == "encryption" ] || \ | ||
| [ "$app" == "federatedfilesharing" ] || \ | ||
| [ "$app" == "files" ] || \ | ||
| [ "$app" == "files_external" ] || \ | ||
| [ "$app" == "files_sharing" ] || \ | ||
| [ "$app" == "files_trashbin" ] || \ | ||
| [ "$app" == "files_versions" ] || \ | ||
| [ "$app" == "lookup_server_connector" ] || \ | ||
| [ "$app" == "provisioning_api" ] || \ | ||
| [ "$app" == "testing" ] || \ | ||
| [ "$app" == "twofactor_backupcodes" ] || \ | ||
| [ "$app" == "updatenotification" ] || \ | ||
| [ "$app" == "user_ldap" ] | ||
| then | ||
| ./occ app:check-code --skip-checkers "$app" | ||
| else | ||
| ./occ app:check-code "$app" | ||
| fi | ||
| RESULT=$(($RESULT+$?)) | ||
|
There was a problem hiding this comment. This is not really helpful, because the log doesn't show what is the cause for the failure 🙈 |
||
| done; | ||
|
|
||
| php ./build/signed-off-checker.php | ||
| RESULT=$(($RESULT+$?)) | ||
|
|
||
| exit $RESULT | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| <?php | ||
| /** | ||
| * @copyright Copyright (c) 2017, Joas Schilling <[email protected]> | ||
| * | ||
| * @author Joas Schilling <[email protected]> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace OC\App\CodeChecker; | ||
|
|
||
| class DatabaseSchemaChecker { | ||
|
|
||
| /** | ||
| * @param string $appId | ||
| * @return array | ||
| */ | ||
| public function analyse($appId) { | ||
| $appPath = \OC_App::getAppPath($appId); | ||
| if ($appPath === false) { | ||
| throw new \RuntimeException("No app with given id <$appId> known."); | ||
| } | ||
|
|
||
| if (!file_exists($appPath . '/appinfo/database.xml')) { | ||
| return ['errors' => [], 'warnings' => []]; | ||
| } | ||
|
|
||
| libxml_use_internal_errors(true); | ||
| $loadEntities = libxml_disable_entity_loader(false); | ||
| $xml = simplexml_load_file($appPath . '/appinfo/database.xml'); | ||
| libxml_disable_entity_loader($loadEntities); | ||
|
|
||
|
|
||
| $errors = $warnings = []; | ||
|
|
||
| foreach ($xml->table as $table) { | ||
| // Table names | ||
| if (strpos($table->name, '*dbprefix*') !== 0) { | ||
| $errors[] = 'Database schema error: name of table ' . $table->name . ' does not start with *dbprefix*'; | ||
| } | ||
| $tableName = substr($table->name, strlen('*dbprefix*')); | ||
| if (strpos($tableName, '*dbprefix*') !== false) { | ||
| $warnings[] = 'Database schema warning: *dbprefix* should only appear once in name of table ' . $table->name; | ||
| } | ||
|
|
||
| if (strlen($tableName) > 27) { | ||
| $errors[] = 'Database schema error: Name of table ' . $table->name . ' is too long (' . strlen($tableName) . '), max. 27 characters (21 characters for tables with autoincrement) + *dbprefix* allowed'; | ||
| } | ||
|
|
||
| $hasAutoIncrement = false; | ||
|
|
||
| // Column names | ||
| foreach ($table->declaration->field as $column) { | ||
| if (strpos($column->name, '*dbprefix*') !== false) { | ||
| $warnings[] = 'Database schema warning: *dbprefix* should not appear in name of column ' . $column->name . ' on table ' . $table->name; | ||
| } | ||
|
|
||
| if (strlen($column->name) > 30) { | ||
| $errors[] = 'Database schema error: Name of column ' . $column->name . ' on table ' . $table->name . ' is too long (' . strlen($tableName) . '), max. 30 characters allowed'; | ||
| } | ||
|
|
||
| if ($column->autoincrement) { | ||
| if ($hasAutoIncrement) { | ||
| $errors[] = 'Database schema error: Table ' . $table->name . ' has multiple autoincrement columns'; | ||
| } | ||
|
|
||
| if (strlen($tableName) > 21) { | ||
| $errors[] = 'Database schema error: Name of table ' . $table->name . ' is too long (' . strlen($tableName) . '), max. 27 characters (21 characters for tables with autoincrement) + *dbprefix* allowed'; | ||
| } | ||
|
|
||
| $hasAutoIncrement = true; | ||
| } | ||
| } | ||
|
|
||
| // Index names | ||
| foreach ($table->declaration->index as $index) { | ||
| $hasPrefix = strpos($index->name, '*dbprefix*'); | ||
| if ($hasPrefix !== false && $hasPrefix !== 0) { | ||
| $warnings[] = 'Database schema warning: *dbprefix* should only appear at the beginning in name of index ' . $index->name . ' on table ' . $table->name; | ||
| } | ||
|
|
||
| $indexName = $hasPrefix === 0 ? substr($index->name, strlen('*dbprefix*')) : $index->name; | ||
| if (strlen($indexName) > 27) { | ||
| $errors[] = 'Database schema error: Name of index ' . $index->name . ' on table ' . $table->name . ' is too long (' . strlen($tableName) . '), max. 27 characters + *dbprefix* allowed'; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return ['errors' => $errors, 'warnings' => $warnings]; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| <?php | ||
| /** | ||
| * @copyright Copyright (c) 2017, Joas Schilling <[email protected]> | ||
| * | ||
| * @author Joas Schilling <[email protected]> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace OC\App\CodeChecker; | ||
|
|
||
| class LanguageParseChecker { | ||
|
|
||
| /** | ||
| * @param string $appId | ||
| * @return array | ||
| */ | ||
| public function analyse($appId) { | ||
| $appPath = \OC_App::getAppPath($appId); | ||
| if ($appPath === false) { | ||
| throw new \RuntimeException("No app with given id <$appId> known."); | ||
| } | ||
|
|
||
| if (!is_dir($appPath . '/l10n/')) { | ||
| return []; | ||
| } | ||
|
|
||
| $errors = []; | ||
| $directory = new \DirectoryIterator($appPath . '/l10n/'); | ||
|
|
||
| foreach ($directory as $file) { | ||
| if ($file->getExtension() !== 'json') { | ||
| continue; | ||
| } | ||
|
|
||
| $content = file_get_contents($file->getPathname()); | ||
| json_decode($content, true); | ||
|
|
||
| if (json_last_error() !== JSON_ERROR_NONE) { | ||
| $errors[] = 'Invalid language file found: l10n/' . $file->getFilename() . ': ' . json_last_error_msg(); | ||
| } | ||
| } | ||
|
|
||
| return $errors; | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why a single job?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it was before, but now devs can run this job in a simple fashion aswell