createTestDB.php

#!/usr/bin/php
<?php
/*
 SPDX-FileCopyrightText: © 2011 Hewlett-Packard Development Company, L.P.
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
require_once(__DIR__ . '/../lib/libTestDB.php');
 
$Options = getopt('c:d:esh');
$usage = $argv[0] . ": [-h] -c path [-d name] [-s]\n" .
  "-c path:  The path to the fossology system configuration directory\n" .
  "-d name:  Drop the named data base.\n" .
  "-e:       create ONLY an empty db, sysconf dir and repository\n" .
  "-h:       This message (Usage)\n" .
  "-s:       Start the scheduler with the new sysconfig directory\n" .
  "Examples:\n".
  "  Create a test DB: 'createTestDb.php' \n" .
  "  Drop the database fosstest1537938: 'createTestDb.php -d fosstest1537938'\n" .
  "  Create test DB, start scheduler: 'createTestDb.php -s'\n" .
  "  Create empty DB, sysconf and repo: 'createTestDb.php -e'\n";
 
$pathPrefix = '/srv/fossologyTestRepo';
$dbPrefix = 'fosstest';
 
// check if the user is in the fossy group
$gid_array = posix_getgroups();
$gflag = 0; // 0: in the fossy group, 1: not in the fossy group
foreach($gid_array as $gid)
{
  $gid_info = posix_getgrgid ($gid);
  if ($gid_info['name'] === 'fossy')
  {
    $gflag = 1; // the user is in fossy group
    break;
  }
}
$uid = posix_getuid();
$uid_info = posix_getpwuid($uid);
if ($uid_info['name'] === 'root') $gflag = 1; // user is root
 
if ($gflag == 0)
{
//    echo "FATAL: The user must be in the fossy group.\n";
//    exit(1);
}
 
// create .pgpass file and place in the users home dir who is running this
// program.  This file will be needed later in the code.
$user = getenv('USER');
$userHome = getenv('HOME');
$ipv4 = gethostbyname(gethostname());
$fullHostName = gethostbyaddr(gethostbyname($ipv4));
$contents = "$fullHostName:*:*:fossy:fossy\n";
$pgpass = "$userHome/.pgpass";
 
// check for an existing ~/.pgpass.  If one already exists, and if the
// file already contains a :fossy:fossy entry, then do not modify the
// file at all
$pg_pass_contents = "";     // start with an empty string
if (file_exists($pgpass)) {
    // read the file contents into the string
    $pg_pass_contents = file_get_contents($pgpass);
}
 
// If a fossy:fossy entry does not already exist then add it.
// If the .pgpass file already exists do not overwrite, but append
if (!preg_match('/\:fossy\:fossy/', $pg_pass_contents)) {
    $FD = fopen($pgpass,'w');
    $howmany = fwrite($FD, $contents);
    if($howmany === FALSE)
    {
      echo "FATAL! Could not write .pgpass file to $pgpass\n";
      exit(1);
    }
    fclose($FD);
}
 
// chmod so only owner can read/write it. If this is not set 
// postgres will ignore the .pgpass file.
if(!chmod($pgpass, 0600))
{
  echo "Warning! could not set $pgpass to 0600\n";
}
 
if(array_key_exists('h',$Options))
{
  print "$usage\n";
  exit(0);
}
$sysconfig = NULL;
// use the passed in sysconfdir to start with
if(array_key_exists('c', $Options))
{
  $sysconfig = $Options['c'];
  if(empty($sysconfig))
  {
    echo $usage;
    exit(1);
  }
}
/*
 * Drop DataBase and remove conf dir and repo dir.
 */
if(array_key_exists('d', $Options))
{
  $dropName = $Options['d'];
  if(empty($dropName))
  {
    echo $usage;
    exit(1);
  }
  // check that postgresql is running
  //$ckCmd = "sudo su postgres -c 'echo \\\q | psql'";
  $ckCmd = "psql -c '\q' postgres -U fossy";
  $lastCmd = exec($ckCmd, $ckOut, $ckRtn);
  if($ckRtn != 0)
  {
    echo "ERROR: postgresql isn't running, not deleting database $dropName\n";
    exit(1);
  }
  $existCmd = "psql -l postgres -U fossy|grep -q $dropName";
  $lastExist = exec($existCmd, $existkOut, $existRtn);
  if($existRtn == 0)
  {
    // drop the db
    # stop all users of the fossology db
    $pkillCmd ="sudo pkill -f -u postgres fossy || true";
    $lKill = exec($pkillCmd, $killOut, $killRtn);
    $dropCmd = "sudo su postgres -c 'echo \"drop database $dropName;\"|psql'";
    $lastDrop = exec($dropCmd, $dropOut, $dropRtn);
    if($dropRtn != 0 )
    {
      echo "ERROR: failed to delete database $dropName\n";
      exit(1);
    }
  }
  else
  {
    echo "NOTE: database $dropName does not exist, nothing to delete\n";
  }
  // remove sysconf and repository
  // remove name from string
  $len = strlen($dbPrefix);
  $uni = substr($dropName,$len);
  $rmRepo = $pathPrefix . '/testDbRepo' .$uni;
  $rmConf = $pathPrefix . '/testDbConf' .$uni;
  $last = system("sudo rm -rf $rmConf $rmRepo", $rmRtn);
  exit(0);
}
 
if(empty($sysconfig))
{
  $sysconfig = getenv('SYSCONFDIR');
  //echo "DB: ctdb: sysconfdir from env is:$sysconfig\n";
  if(empty($sysconfig))
  {
    echo "FATAL!, no SYSCONFDIR defined\n";
    echo "either export SYSCONFDIR path and rerun or use -c <sysconfdirpath>\n";
    flush();
    exit(1);
  }
}
 
putenv("SYSCONFDIR=$sysconfig");
$_ENV['SYSCONFDIR'] = $sysconfig;
 
$unique = mt_rand();
$DbName = $dbPrefix . $unique;
 
$createEmpty = array_key_exists('e', $Options);
$startSched = array_key_exists('s', $Options);
 
// create the db
$newDB = createTestDB($DbName);
if($newDB != NULL)
{
  echo "ERROR, could not create database $DbName\n";
  echo $newDB;
  exit(1);
}
 
$confName = 'testDbConf' . $unique;
$confPath = "$pathPrefix/$confName";
$repoName = 'testDbRepo' . $unique;
$repoPath = "$pathPrefix/$repoName";
 
// sysconf and repo's always go in /srv/fossologyTestRepo to ensure enough room.
// perms are 755
if(mkdir($confPath,0755,TRUE) === FALSE)
{
  echo "FATAL! Cannot create test sysconf at:$confPath\n" .
  __FILE__ . " at line " . __LINE__ . "\n";
  exit(1);
}
if(chmod($confPath, 0755) === FALSE )
{
  echo "ERROR: Cannot set mode to 755 on $confPath\n" .
  __FILE__ . " at line " . __LINE__ . "\n";
}
if(mkdir($repoPath,0755,TRUE) === FALSE)
{
  echo "FATAL! Cannot create test repository at:$repoPath\n" .
  __FILE__ . " at line " . __LINE__ . "\n";
  exit(1);
}
if(chmod($repoPath, 0755) === FALSE )
{
  echo "ERROR: Cannot set mode to 755 on $repoPath\n" .
  __FILE__ . " at line " . __LINE__ . "\n";
}
//create Db.conf file
// Should the host be what's in fossology.conf?
$conf = "dbname=$DbName;\n" .
  "host=localhost;\n" .
  "user=fossy;\n" .
  "password=fossy;\n";
 
if(file_put_contents($confPath . "/Db.conf", $conf) === FALSE)
{
  echo "FATAL! Could not create Db.conf file at:$confPath\n";
  exit(1);
}
 
// copy and modify fossology.conf
$fossConf = $sysconfig . '/fossology.conf';
$myConf  = $confPath . '/fossology.conf';
 
if(file_exists($fossConf))
{
  if(copy($fossConf, $myConf) === FALSE)
  {
    echo "FATAL! cannot copy $fossConf to $myConf\n";
    exit(1);
  }
}
 
if(setRepo($confPath, $repoPath) === FALSE)
{
  echo "ERROR!, could not change $sysconfig/fossology.conf, please change by " .
    "hand before running tests\n";
  exit(1);
}
 
// copy mods-enabled from real sysconf.
$modConf = $sysconfig . '/mods-enabled';
$cmd = "cp -RP $modConf $confPath";
if(system($cmd) === FALSE)
{
  //echo "DB: Cannot copy directory $modConf to $confPath\n";
  exit(1);
}
 
// copy version file
// copy and modify fossology.conf
$version = $sysconfig . '/VERSION';
$myVersion  = $confPath . '/VERSION';
if(file_exists($fossConf))
{
  if(copy($version, $myVersion) === FALSE)
  {
    echo "FATAL! cannot copy $version to $myVersion\n";
    exit(1);
  }
}
putenv("SYSCONFDIR=$confPath");
$_ENV['SYSCONFDIR'] = $confPath;
$GLOBALS['SYSCONFDIR'] = $confPath;
 
if($createEmpty)
{
  echo $confPath . "\n";
  exit(0);
}
 
// load the schema
$loaded = TestDBInit(NULL, $DbName);
//echo "DB: return from TestDBinit is:\n";print_r($loaded) . "\n";
if($loaded !== NULL)
{
  echo "ERROR, could not load schema\n";
  echo $loaded;
  exit(1);
}
 
// export to environment the new sysconf dir
// The update has to happen before schema-update gets called or schema-update
// will not end up with the correct sysconf
 
putenv("SYSCONFDIR=$confPath");
$_ENV['SYSCONFDIR'] = $confPath;
$GLOBALS['SYSCONFDIR'] = $confPath;
 
// scheduler should be in $MODDIR/scheduler/agent/fo_scheduler
// no need to check if it's running, as a new one is started with a new
// SYSCONFDIR.
if($startSched)
{
  $skedOut = array();
  $cmd = "sudo $MODDIR/scheduler/agent/fo_scheduler -d -c $confPath";
  $skedLast = exec($cmd, $skedOut, $skedRtn);
  if($skedRtn != 0)
  {
    echo "FATAL! could not start scheduler with -d -c $confPath\n";
    echo implode("\n", $skedOut) . "\n";
    exit(1);
  }
}
echo $confPath . "\n";
exit(0);