mirror of
https://github.com/e107inc/e107.git
synced 2025-10-10 20:44:48 +02:00
Partial teardown functionality for cPanel deployer
Also renamed class Prepare_cPanel to cPanelDeployer
This commit is contained in:
Deltik
200
lib/deployers/cpanel_deployer.php
Normal file
200
lib/deployers/cpanel_deployer.php
Normal file
@@ -0,0 +1,200 @@
|
||||
<?php
|
||||
|
||||
include_once(__DIR__ . "/../cpaneluapi/cpaneluapi.class.php");
|
||||
|
||||
define('ACCEPTANCE_TEST_PREFIX', 'acceptance-test-');
|
||||
|
||||
class cPanelDeployer
|
||||
{
|
||||
protected $credentials;
|
||||
protected $cPanel;
|
||||
protected $homedir;
|
||||
protected $docroot;
|
||||
protected $domain;
|
||||
protected $run_id;
|
||||
|
||||
function __construct($credentials)
|
||||
{
|
||||
$this->credentials = $credentials;
|
||||
}
|
||||
|
||||
public function getDomain()
|
||||
{
|
||||
return $this->domain;
|
||||
}
|
||||
|
||||
public function start()
|
||||
{
|
||||
self::println();
|
||||
self::println("=== cPanel Deployer – Bring Up ===");
|
||||
$creds = $this->credentials;
|
||||
if (!$creds['hostname'] ||
|
||||
!$creds['username'] ||
|
||||
!$creds['password'])
|
||||
{
|
||||
self::println("Cannot deploy cPanel environment because credentials are missing. Falling back to manual mode…");
|
||||
return false;
|
||||
}
|
||||
|
||||
$username = &$creds['username'];
|
||||
$password = &$creds['password'];
|
||||
$hostname = &$creds['hostname'];
|
||||
|
||||
$this->run_id = $run_id = uniqid(ACCEPTANCE_TEST_PREFIX);
|
||||
|
||||
self::println("Test run ID: ".$this->run_id);
|
||||
|
||||
$this->cPanel = $cPanel = new cpanelAPI($username, $password, $hostname);
|
||||
|
||||
self::println("Connecting to cPanel at \"${hostname}\" with username \"${username}\"…");
|
||||
|
||||
$domains_data = $cPanel->uapi->DomainInfo->domains_data();
|
||||
if (!$domains_data)
|
||||
{
|
||||
throw new Exception("Cannot connect to cPanel at \"${hostname}\" with username \"${username}\" and password \"${password}\"");
|
||||
}
|
||||
$userdata = $domains_data->{'data'};
|
||||
$this->homedir = $homedir = $userdata->{'main_domain'}->{'homedir'};
|
||||
$this->docroot = $docroot = $userdata->{'main_domain'}->{'documentroot'};
|
||||
$this->domain = $domain = $userdata->{'main_domain'}->{'domain'};
|
||||
|
||||
self::println("Obtained home directory from cPanel: " . $this->homedir);
|
||||
self::println("Obtained document root from cPanel: " . $this->docroot);
|
||||
self::println("Obtained domain name from cPanel: " . $this->domain);
|
||||
|
||||
$acceptance_tests = self::get_active_acceptance_tests($cPanel, $homedir);
|
||||
|
||||
self::println("Adding this test (".$this->run_id.") to registered tests list…");
|
||||
$run_time = microtime(true);
|
||||
array_push($acceptance_tests,
|
||||
['id' => $run_id,
|
||||
'time' => $run_time
|
||||
]);
|
||||
|
||||
self::write_acceptance_tests($cPanel, $homedir, $acceptance_tests);
|
||||
|
||||
$valid_acceptance_test_ids = self::get_acceptance_test_ids($acceptance_tests);
|
||||
self::println("Current unexpired tests: [".implode(", ", $valid_acceptance_test_ids)."]");
|
||||
|
||||
self::prune_inactive_acceptance_test_resources($cPanel, $valid_acceptance_test_ids);
|
||||
|
||||
$db_id = "${username}_${run_id}";
|
||||
self::println("Creating new MySQL database \"${db_id}\"…");
|
||||
$cPanel->uapi->Mysql->create_database(['name' => $db_id]);
|
||||
|
||||
self::println("Creating new MySQL user \"${db_id}\" with password \"${run_id}\"…");
|
||||
$cPanel->uapi->Mysql->create_user(['name' => $db_id, 'password' => $run_id]);
|
||||
self::println("Granting ALL PRIVILEGES to MySQL user \"${db_id}\"…");
|
||||
$cPanel->uapi->Mysql->set_privileges_on_database(['user' => "${username}_${run_id}",
|
||||
'database' => "${username}_${run_id}",
|
||||
'privileges' => 'ALL PRIVILEGES'
|
||||
]);
|
||||
|
||||
# TODO: Upload software to test
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
public function stop()
|
||||
{
|
||||
self::println("=== cPanel Deployer – Tear Down ===");
|
||||
$cPanel = $this->cPanel;
|
||||
$acceptance_tests = self::get_active_acceptance_tests($cPanel, $this->homedir);
|
||||
self::println("Removing this test (".$this->run_id.") from registered tests list…");
|
||||
self::prune_acceptance_tests($acceptance_tests, $this->run_id);
|
||||
self::write_acceptance_tests($cPanel, $this->homedir, $acceptance_tests);
|
||||
|
||||
$valid_acceptance_test_ids = self::get_acceptance_test_ids($acceptance_tests);
|
||||
self::println("Current unexpired tests: [".implode(", ", $valid_acceptance_test_ids)."]");
|
||||
self::prune_inactive_acceptance_test_resources($cPanel, $valid_acceptance_test_ids);
|
||||
}
|
||||
|
||||
private static function println($text = '')
|
||||
{
|
||||
echo($text."\n");
|
||||
}
|
||||
|
||||
private static function prune_inactive_acceptance_test_resources($cPanel, $valid_acceptance_test_ids)
|
||||
{
|
||||
self::println("Pruning expired tests…");
|
||||
$listdbs = $cPanel->api2->MysqlFE->listdbs()->{'cpanelresult'}->{'data'};
|
||||
self::prune_mysql_databases($listdbs, $valid_acceptance_test_ids, $cPanel);
|
||||
|
||||
$listdbusers = $cPanel->api2->MysqlFE->listusers()->{'cpanelresult'}->{'data'};
|
||||
self::prune_mysql_users($listdbusers, $valid_acceptance_test_ids, $cPanel);
|
||||
}
|
||||
|
||||
private static function get_active_acceptance_tests($cPanel, $homedir)
|
||||
{
|
||||
self::println("Retrieving existing registered tests from cPanel account…");
|
||||
$acceptance_tests = [];
|
||||
$acceptance_tests_apiresponse = $cPanel->uapi->Fileman->get_file_content(['dir' => $homedir, 'file' => 'acceptance_tests.status.txt']);
|
||||
if (!is_null($acceptance_tests_apiresponse->{'data'}))
|
||||
{
|
||||
$acceptance_tests_raw = $acceptance_tests_apiresponse->{'data'}->{'content'};
|
||||
$acceptance_tests = (array) json_decode($acceptance_tests_raw, true);
|
||||
self::prune_acceptance_tests($acceptance_tests);
|
||||
}
|
||||
return $acceptance_tests;
|
||||
}
|
||||
|
||||
private static function prune_acceptance_tests(array &$list, $id_to_remove = null)
|
||||
{
|
||||
foreach ($list as $key => $item)
|
||||
{
|
||||
$time = $item['time'];
|
||||
if ($item['id'] === $id_to_remove || $time <= strtotime("now - 10 seconds"))
|
||||
{
|
||||
unset($list[$key]);
|
||||
}
|
||||
}
|
||||
$list = array_values($list);
|
||||
return $list;
|
||||
}
|
||||
|
||||
private static function get_acceptance_test_ids(array $list)
|
||||
{
|
||||
$ids = [];
|
||||
foreach ($list as $item)
|
||||
{
|
||||
$ids[] = $item['id'];
|
||||
}
|
||||
return $ids;
|
||||
}
|
||||
|
||||
private static function write_acceptance_tests($cPanel, $homedir, $acceptance_tests)
|
||||
{
|
||||
$acceptance_tests_json = json_encode($acceptance_tests, JSON_PRETTY_PRINT);
|
||||
|
||||
self::println("Saving registered tests list to cPanel account…");
|
||||
$cPanel->uapi->Fileman->save_file_content(['dir' => $homedir, 'file' => 'acceptance_tests.status.txt', 'content' => $acceptance_tests_json]);
|
||||
}
|
||||
|
||||
private static function prune_mysql_databases($dbs, $ids, $cPanel)
|
||||
{
|
||||
foreach ($dbs as $db)
|
||||
{
|
||||
$db = (array) $db;
|
||||
$offset = strpos($db['db'], ACCEPTANCE_TEST_PREFIX);
|
||||
$questionable_db = substr($db['db'], $offset);
|
||||
if (!in_array($questionable_db, $ids))
|
||||
{
|
||||
$cPanel->uapi->Mysql->delete_database(['name' => $db['db']]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static function prune_mysql_users($users, $ids, $cPanel)
|
||||
{
|
||||
foreach ($users as $user)
|
||||
{
|
||||
$user = (array) $user;
|
||||
$offset = strpos($user['user'], ACCEPTANCE_TEST_PREFIX);
|
||||
$questionable_user = substr($user['user'], $offset);
|
||||
if (!in_array($questionable_user, $ids))
|
||||
{
|
||||
$cPanel->uapi->Mysql->delete_user(['name' => $user['user']]);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user