Implement TestCommand for database connectivity (CFM-275)

app/src/Command/TestCommand.php

@@ -0,0 +1,104 @@
+<?php
+/**
+ * COmanage Registry Test Command
+ *
+ * Portions licensed to the University Corporation for Advanced Internet
+ * Development, Inc. ("UCAID") under one or more contributor license agreements.
+ * See the NOTICE file distributed with this work for additional information
+ * regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with the
+ * License. You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @link          https://www.internet2.edu/comanage COmanage Project
+ * @package       registry
+ * @since         COmanage Registry v5.0.0
+ * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
+ */
+
+declare(strict_types=1);
+
+namespace App\Command;
+
+use Cake\Console\Arguments;
+use Cake\Console\Command;
+use Cake\Console\ConsoleIo;
+use Cake\Console\ConsoleOptionParser;
+use Cake\Datasource\ConnectionManager;
+
+class TestCommand extends Command
+{
+  protected $io = null;
+
+  /**
+   * Register command specific options.
+   *
+   * @param  ConsoleOptionParser  $parser   Console Option Parser
+   * @return ConsoleOptionParser            Console Option Parser
+   * @since  COmanage Registry v5.0.0
+   */
+
+  public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
+  {
+    $parser->addOption('test', [
+      'help'    => __d('command', 'opt.test.test'),
+      'short'   => 't',
+      'choices' => ['database']
+    ])->addOption('datasource', [
+      'help'    => __d('command', 'opt.test.database.source'),
+      'default' => 'default'
+    ]);
+
+    return $parser;
+  }
+
+  /**
+   * Execute the Setup Command.
+   *
+   * @since  COmanage Registry v5.0.0
+   * @param  Arguments  $args  Command Arguments
+   * @param  ConsoleIo  $io    Console IO
+   */
+
+  public function execute(Arguments $args, ConsoleIo $io)
+  {
+    global $argv;
+
+    $this->io = $io;
+
+    // The test we want to run
+    $test = $args->getOption('test');
+
+    switch($test) {
+      case 'database':
+        $this->testDatabase($args->getOption('datasource'));
+        break;
+    }
+  }
+
+  /**
+   * Test database connectivity for the default
+   */
+
+  protected function testDatabase(string $source): int {
+    try {
+      $cxn = ConnectionManager::get($source);
+      $this->io->out(__d('command', 'opt.test.database.ok'));
+    }
+    catch(\Exception $e) {
+      $this->io->error($e->getMessage());
+      $this->abort(static::CODE_ERROR);
+    }
+
+    return static::CODE_SUCCESS;
+  }
+}