test_cp2foss.php

<?php
/*
 Copyright (C) 2012-2014 Hewlett-Packard Development Company, L.P.

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 version 2 as published by the Free Software Foundation.

 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 General Public License for more details.

 You should have received a copy of the GNU General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

require_once("./test_common.php");

class test_cp2foss extends \PHPUnit\Framework\TestCase
{

  public $SYSCONF_DIR = "/usr/local/etc/fossology/";
  public $DB_NAME;
  public $PG_CONN;
  public $DB_COMMAND;

  // fossology_testconfig is the temporary system configuration directory
  // created by the src/testing/db/create_test_database.php script.
  // It is initialized via the Makefile and passed in via the
  // FOSSOLOGY_TESTCONFIG environment variable.
  public $fossology_testconfig;

  // scheduler_path is the absolute path to the scheduler binary
  public $scheduler_path;

  // cp2foss_path is the absolute path to the cp2foss binary
  public $cp2foss_path;

  /* initialization */

  // this method is run once for the entire test class, before any of the
  // test methods are executed.
  public static function setUpBeforeClass()
  {

    global $fossology_testconfig;
    global $scheduler_path;
    global $cp2foss_path;

    fwrite(STDOUT, "--> Running " . __METHOD__ . " method.\n");

    $fossology_testconfig = getenv('FOSSOLOGY_TESTCONFIG');
    fwrite(STDOUT, __METHOD__ . " got fossology_testconfig = '$fossology_testconfig'\n");

    /* locate cp2foss binary */
    // first get the absolute path to the current fossology src/ directory
    $fo_base_dir = realpath(__DIR__ . '/../..');
    $cp2foss_path = $fo_base_dir . "/cli/cp2foss";
    if (!is_executable($cp2foss_path)) {
        print "Error:  cp2foss path '" . $cp2foss_path . "' is not executable!\n";
        exit(1);
    }
    $cp2foss_path .= " -s ";

    /* locate the scheduler binary */
    $scheduler_path = $fossology_testconfig . "/mods-enabled/scheduler/agent/fo_scheduler";
    if (!is_executable($scheduler_path)) {
        print "Error:  Scheduler path '$scheduler_path' is not executable!\n";
        exit(1);
    }

    /* invoke the scheduler */
    $scheduler_cmd = "$scheduler_path --daemon --reset --verbose=952 -c $fossology_testconfig";
    fwrite(STDOUT, "DEBUG: Starting scheduler with '$scheduler_cmd'\n");
    exec($scheduler_cmd, $output, $return_var);
    //print_r($output);
    if ( $return_var != 0 ) {
        print "Error: Could not start scheduler '$scheduler_path'\n";
        print "$output\n";
        exit(1);
    }
    print "\nStarting functional test for cp2foss. \n";

  }


  // this method is run once before each test method defined for this test class.
  protected function setUp()
  {

    fwrite(STDOUT, "--> Running " . __METHOD__ . " method.\n");

    //$SYSCONF_DIR = "/usr/local/etc/fossology/";
    //$DB_NAME = "fossology";
    //$DB_COMMAND = "../../testing/db/createTestDB.php";

    // these calls are deprecated with the new create_test_database call
    //create_db();
    //add_user();
    //preparations();
    //scheduler_operation();
  }

  function test_upload_from_server()
  {
    //global $SYSCONF_DIR;
    global $fossology_testconfig;
    global $cp2foss_path;

    fwrite(STDOUT, " ----> Running " . __METHOD__ . "\n");

    $test_dbh = connect_to_DB($fossology_testconfig);

    $auth = "--username fossy --password fossy -c $fossology_testconfig";

    $out = "";
    $pos = 0;
    $command = "$cp2foss_path $auth -q all -d 'regular expression testing' '../*.php' -v";
    fwrite(STDOUT, "DEBUG: Running $command\n");
    $last = exec("$command 2>&1", $out, $rtn);
    //fwrite(STDOUT, "DEBUG: $out[5] \n");
    //fwrite(STDOUT, print_r($out));
    $upload_id = 0;
    if ($out && $out[13]) {
      $upload_id = get_upload_id($out[6]);
    } else {
      $this->assertFalse(true);
    }
    fwrite(STDOUT, "DEBUG: $upload_id \n");
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "ununpack", $upload_id);
    $this->assertEquals(1, $agent_status);
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "nomos", $upload_id);
    $this->assertEquals(1, $agent_status);
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "copyright", $upload_id);
    $this->assertEquals(1, $agent_status);
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "pkgagent", $upload_id);
    $this->assertEquals(1, $agent_status);

    $is_exist = check_file_uploadtree($test_dbh, 'src', $upload_id);
    fwrite(STDOUT, "DEBUG: is_exist is:$is_exist\n");
    $this->assertEquals(0, $is_exist);

    $out = "";
    $pos = 0;
    $command = "$cp2foss_path $auth ./test_cp2foss.php";
    fwrite(STDOUT, "DEBUG: test_upload_from_server executing '$command'\n");
    $last = exec("$command 2>&1", $out, $rtn);
    #print "DEBUG: output is:\n";
    #print_r($out);
    //DEBUG
    $repo_string = "Uploading to folder: 'Software Repository'";
    $repo_pos = strpos($out[2], $repo_string);
    $output_msg_count = count($out);
    print "DEBUG: \$this->assertGreaterThan(0, $repo_pos);\n";
    $this->assertGreaterThan(0, $repo_pos);
    print "DEBUG: \$this->assertEquals(4, $output_msg_count);\n";
    $this->assertEquals(5, $output_msg_count);
    $upload_id = 0;
    if ($out && $out[4]) {
      $upload_id = get_upload_id($out[4]);
      print "DEBUG: Upload_id is $upload_id\n";
    } else {
      print "DEBUG:  Did not get an upload_id!\n";
      $this->assertFalse(true);
    }
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh,"ununpack", $upload_id);
    $this->assertEquals(1, $agent_status);

    $out = "";
    $pos = 0;
    $command = "$cp2foss_path $auth ./";
    fwrite(STDOUT, "DEBUG: test_upload_from_server executing '$command'\n");
    $last = exec("$command 2>&1", $out, $rtn);
    // print_r($out);
    $repo_string = "Uploading to folder: 'Software Repository'";
    $repo_pos = strpos($out[2], $repo_string);
    $output_msg_count = count($out);
    $this->assertGreaterThan(0, $repo_pos);
    $this->assertEquals(5, $output_msg_count);
    $upload_id = 0;
    if ($out && $out[4]) {
      $upload_id = get_upload_id($out[4]);
    } else {
      $this->assertFalse(true);
    }
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "ununpack", $upload_id);
    $this->assertEquals(1, $agent_status);

    $out = "";
    $pos = 0;
    $upload_path = "upload_path";
    $command = "$cp2foss_path $auth ./ -f $upload_path -d upload_des -q all -v";
    fwrite(STDOUT, "DEBUG: Executing '$command'\n");
    $last = exec("$command 2>&1", $out, $rtn);
    //print_r($out);
    $repo_string = "Uploading to folder: '/$upload_path'";
    $repo_pos = strpos($out[8], $repo_string);
    $output_msg_count = count($out);
    print "DEBUG: \$this->assertGreaterThan(0, $repo_pos), $repo_string\n";
    $this->assertGreaterThan(0, $repo_pos);
    $scheduled_agent_info_1 = "agent_pkgagent is queued to run on";
    $scheduled_agent_info_2 = "agent_nomos is queued to run on";
    $scheduled_agent_info_3 = "agent_mimetype is queued to run on";
    $scheduled_agent_info_4 = "agent_copyright is queued to run on";
    $pos = false;
    $pos = strpos($out[$output_msg_count - 1], $scheduled_agent_info_1);
    $this->assertEquals(0, $pos);
    $pos = false;
    $pos = strpos($out[$output_msg_count - 2], $scheduled_agent_info_2);
    $this->assertEquals(0, $pos);
    $pos = false;
    $pos = strpos($out[$output_msg_count - 4], $scheduled_agent_info_3);
    $this->assertEquals(0, $pos);
    $pos = false;
    $pos = strpos($out[$output_msg_count - 6], $scheduled_agent_info_4);
    $this->assertEquals(0, $pos, $out[$output_msg_count-4]);
    $upload_id = 0;

    if ($out && $out[12]) {
      $upload_id = get_upload_id($out[12]);
    } else {
      $this->assertFalse(true);
    }
    $agent_status = 0;
    sleep(5);
    $agent_status = check_agent_status($test_dbh, "ununpack", $upload_id);
    $this->assertEquals(1, $agent_status);
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "copyright", $upload_id);
    $this->assertEquals(1, $agent_status);
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "nomos", $upload_id);
    $this->assertEquals(1, $agent_status);
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "mimetype", $upload_id);
    $this->assertEquals(1, $agent_status);
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "pkgagent", $upload_id);
    $this->assertEquals(1, $agent_status);

    $out = "";
    $pos = 0;
    $command = "$cp2foss_path $auth -q all -A -f test/exclude -n 'test exclue dir'  -d 'test des exclude dir' -X .svn ./ -v";
    fwrite(STDOUT, "DEBUG: Running $command\n");
    $last = exec("$command 2>&1", $out, $rtn);
    // print_r($out);
    $upload_id = 0;
    if ($out && $out[24]) {
      $upload_id = get_upload_id($out[24]);
    } else {
      $this->assertFalse(true);
    }
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "ununpack", $upload_id);
    $this->assertEquals(1, $agent_status);

    $out = "";
    $pos = 0;
    $command = "$cp2foss_path $auth -q all -A -f 'regular expression testing' -n 'test globbing dir' -d 'test des globbing' '*.php' -v";
    fwrite(STDOUT, "DEBUG: Running $command\n");
    $last = exec("$command 2>&1", $out, $rtn);
    //print_r($out);
    $upload_id = 0;
    if ($out && $out[18]) {
      $upload_id = get_upload_id($out[18]);
    } else {
      $this->assertFalse(true);
    }
    fwrite(STDOUT, "Debug: upload_id is:$upload_id\n");
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "ununpack", $upload_id);
    $this->assertEquals(1, $agent_status);
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "nomos", $upload_id);
    $this->assertEquals(1, $agent_status);
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "copyright", $upload_id);
    $this->assertEquals(1, $agent_status);
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh, "pkgagent", $upload_id);
    $this->assertEquals(1, $agent_status);

    pg_close($test_dbh);

    fwrite(STDOUT,"DEBUG: Done running " . __METHOD__ . "\n");
  }

  function test_upload_from_url()
  {
    //global $SYSCONF_DIR;
    global $fossology_testconfig;
    global $cp2foss_path;

    fwrite(STDOUT, " ----> Running " . __METHOD__ . "\n");
    $test_dbh = connect_to_DB($fossology_testconfig);

    $auth = "--username fossy --password fossy -c $fossology_testconfig";
    $out = "";
    $pos = 0;
    $command = "$cp2foss_path $auth http://www.fossology.org/testdata/rpms/fedora/10/SRPMS/fossology-1.1.0-1.fc10.src.rpm -d 'fossology des' -f 'fossology path' -n 'test package'";
    fwrite(STDOUT, "DEBUG: Executing '$command'\n");
    $last = exec("$command 2>&1", $out, $rtn);
    sleep(50);
    //print "DEBUG: output is:\n";
    //print_r($out);

    $upload_id = 0;
    if ($out && $out[5]) {
      $upload_id = get_upload_id($out[5]);
    } else {
      $this->assertFalse(true);
    }
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh,"ununpack", $upload_id);
    $this->assertEquals(1, $agent_status);
    $agent_status = 0;
    $agent_status = check_agent_status($test_dbh,"nomos", $upload_id);
    $this->assertEquals(0, $agent_status);

    pg_close($test_dbh);

    fwrite(STDOUT,"DEBUG: Done running " . __METHOD__ . "\n");

  }

  function test_list_agent_and_others()
  {
    global $fossology_testconfig;
    global $cp2foss_path;
    //global $SYSCONF_DIR;

    fwrite(STDOUT, " ----> Running " . __METHOD__ . "\n");
    $auth = "--username fossy --password fossy -c $fossology_testconfig";
    $command = "$cp2foss_path $auth -h";
    fwrite(STDOUT, "DEBUG: Executing '$command'\n");
    $last = exec("$command 2>&1", $out, $rtn);
    $output_msg_count = count($out);
    $this->assertEquals(68, $output_msg_count, "Test that the number of output lines from '$command' is 65");
    // print_r($out);
    $out = "";
    $pos = 0;
    $command = "$cp2foss_path $auth -Q";
    fwrite(STDOUT, "DEBUG: Executing '$command'\n");
    $last = exec("$command 2>&1", $out, $rtn);
    $output_msg_count = count($out);
    $this->assertEquals(10, $output_msg_count);
    $out = "";
    $pos = 0;
    $command = "$cp2foss_path $auth ";
    fwrite(STDOUT, "DEBUG: Executing '$command'\n");
    $last = exec("$command 2>&1", $out, $rtn);
    // print_r($out);
    $output_msg = "FATAL: No files to upload were specified.";
    $this->assertEquals($output_msg, $out[0]);

    fwrite(STDOUT,"DEBUG: Done running " . __METHOD__ . "\n");
  }

  // this method is run once after each test method defined for this test class.
  protected function tearDown()
  {

    global $fossology_testconfig;

    fwrite(STDOUT, "--> Running " . __METHOD__ . " method.\n");

    // TODO:  Drop the test database

    //stop_scheduler();
    //drop_db();
  }

  // this method is run once for the entire test class, after all of the
  // test methods are executed.
  public static function tearDownAfterClass()
  {

    global $fossology_testconfig;
    global $scheduler_path;
    fwrite(STDOUT, "--> Running " . __METHOD__ . " method.\n");

    // stop the scheduler
    print "Stopping the scheduler\n";
    $scheduler_cmd = "$scheduler_path -k -c $fossology_testconfig";
    fwrite(STDOUT, "DEBUG: command is $scheduler_cmd \n");
    exec($scheduler_cmd, $output, $return_var);
    if ( $return_var != 0 ) {
        print "Error: Could not stop scheduler via '$scheduler_cmd'\n";
        print "$output\n";
      #        exit(1);
    }

    // time to drop the database

    sleep(10);
    print "End of functional tests for cp2foss \n";

  }
}