Add DB constraints check.

src/Shell/DbConstraintsShell.php

@@ -0,0 +1,157 @@
+<?php
+
+namespace Setup\Shell;
+
+use Cake\Console\Shell;
+use Cake\Core\App;
+use Cake\Filesystem\Folder;
+use Cake\ORM\TableRegistry;
+use RuntimeException;
+
+/**
+ * Alerts about possible constraints missing in terms of data integrity issues.
+ * - Optional relation with foreign key not being set back to null when related has* entity has removed been removed.
+ *   This is only relevant if relation is not "dependent => true", though.
+ *
+ * @author Mark Scherer
+ * @license MIT
+ */
+class DbConstraintsShell extends Shell {
+
+	/**
+	 * @param string|null $modelName
+	 *
+	 * @return void
+	 */
+	public function check($modelName = null) {
+		$plugin = $this->param('plugin');
+		$models = $this->_getModels($modelName, $plugin);
+
+		$this->out('Checking ' . count($models) . ' models that need updating:', 1, static::VERBOSE);
+		foreach ($models as $model) {
+			$this->out('### ' . $model->getTable(), 1, static::VERBOSE);
+
+			$schema = $model->getSchema();
+
+			$associations = $model->associations();
+			$relationKeys = $associations->keys();
+			if (!$relationKeys) {
+				continue;
+			}
+
+			foreach ($relationKeys as $relationKey) {
+				$relation = $associations->get($relationKey);
+				if ($relation->type() !== $relation::MANY_TO_ONE) {
+					continue;
+				}
+
+				$this->out('Checking: ' . $model->getAlias() . '.' . $relation->getForeignKey() . ' => ' . $relation->getName() . '.' . $relation->getBindingKey());
+				$field = $schema->getColumn($relation->getForeignKey());
+				if ($field['null'] !== true || $field['default'] !== null) {
+					continue;
+				}
+				// We only care about AIIDs for now
+				if ($field['type'] !== 'integer') {
+					continue;
+				}
+
+				$constraints = $schema->constraints();
+				foreach ($constraints as $constraint) {
+					$constraintDetails = $schema->getConstraint($constraint);
+					if ($constraintDetails['type'] !== 'foreign') {
+						continue;
+					}
+					if ($constraintDetails['columns'] !== [$relation->getForeignKey()]) {
+						continue;
+					}
+
+					if (!empty($constraintDetails['delete']) && $constraintDetails['delete'] === 'setNull') {
+						continue;
+					}
+
+					$this->warn('- Possibly missing a [\'delete\' => \'SET_NULL\'] constraint.');
+				}
+			}
+		}
+
+		$this->out('Done :) Possible nullable foreign key constraints checks executed.');
+	}
+
+	/**
+	 * @return \Cake\Console\ConsoleOptionParser
+	 */
+	public function getOptionParser() {
+		$subcommandParser = [
+			'options' => [
+				'dry-run' => [
+					'short' => 'd',
+					'help' => 'Dry run the command, nothing will actually be modified. It will output the SQL to copy-and-paste, e.g. into a Migrations file.',
+					'boolean' => true,
+				],
+				'plugin' => [
+					'short' => 'p',
+					'help' => 'Plugin',
+				],
+			],
+			'arguments' => [
+				'model' => [
+					'help' => 'Specific model (table)',
+				],
+			],
+		];
+
+		return parent::getOptionParser()
+			->setDescription('A Shell to check database integrity issues regarding nullable foreign key columns.')
+			->addSubcommand('check', [
+				'help' => 'Correct nullable foreign key columns by adding missing on delete constraints.',
+				'parser' => $subcommandParser,
+			]);
+	}
+
+	/**
+	 * @param string|null $model
+	 * @param string|null $plugin
+	 *
+	 * @return \Cake\ORM\Table[]
+	 */
+	protected function _getModels($model, $plugin) {
+		if ($model) {
+			$className = App::className($plugin ? $plugin . '.' : $model, 'Model/Table', 'Table');
+			if (!$className) {
+				throw new RuntimeException('Model not found: ' . $model);
+			}
+
+			return [
+				TableRegistry::getTableLocator()->get($plugin ? $plugin . '.' : $model),
+			];
+		}
+
+		$folders = App::path('Model/Table', $plugin);
+
+		$models = [];
+		foreach ($folders as $folder) {
+			$folderContent = (new Folder($folder))->read(Folder::SORT_NAME, true);
+
+			foreach ($folderContent[1] as $file) {
+				$name = pathinfo($file, PATHINFO_FILENAME);
+
+				preg_match('#^(.+)Table$#', $name, $matches);
+				if (!$matches) {
+					continue;
+				}
+
+				$model = $matches[1];
+
+				$className = App::className($plugin ? $plugin . '.' : $model, 'Model/Table', 'Table');
+				if (!$className) {
+					continue;
+				}
+
+				$models[] = TableRegistry::getTableLocator()->get($plugin ? $plugin . '.' : $model);
+			}
+		}
+
+		return $models;
+	}
+
+}