BUG: Refs #212. Fixed bug in chmod warning, and rewrite of tests.

Michael Grauer · yuzhengZ · commit c1c0afa237af · 2011-10-18T18:13:29.000-04:00
There was a bug when a file was tested to see if it could be chmod-ed,
a warning was issued if the file could not be chmoded and this broke
json parsing.  Now I've changed this to first check the UID of the process,
and see if that is the same as the UID of the file, if not, then don't perform
the chmod test and hence don't generate the warning.

Also in this commit is the creation of the BatchmakeControllerTest superclass
and changes in the batchmake tests to use this superclass.  This superclass
helps streamline batchmake testing, so the user doesn't have to set as many
properties manually to test the batchmake module.
diff --git a/modules/batchmake/controllers/components/KWBatchmakeComponent.php b/modules/batchmake/controllers/components/KWBatchmakeComponent.php
@@ -67,16 +67,11 @@ public function __construct($alternateConfig = null)
 
   /**
    * helper function to load the correct config file
-   * @param string $alternateConfig path to alternative config ini file
    * @return config array with config properties
    */
-  protected function loadConfig($alternateConfig = null)
+  protected function loadConfig()
     {
-    if($alternateConfig)
-      {
-      $config = parse_ini_file($alternateConfig, false);
-      }
-    elseif(file_exists(MIDAS_BATCHMAKE_MODULE_LOCAL_CONFIG))
+    if(file_exists(MIDAS_BATCHMAKE_MODULE_LOCAL_CONFIG))
       {
       $config = parse_ini_file(MIDAS_BATCHMAKE_MODULE_LOCAL_CONFIG, false);
       }
@@ -92,25 +87,31 @@ protected function loadConfig($alternateConfig = null)
    * will load the configuration property values for this module, and filter
    * out only those properties that are in the 'batchmake.' config namespace,
    * removing the 'batchmake.' from the key name.
-   * @param string $alternateConfig a path to an alternate config ini file
+   * @param string $alternateConfig an array of alternate config props
    * @return array of batchmake module specific config properties
    */
   public function loadConfigProperties($alternateConfig = null)
     {
-    $configPropertiesParamVals = array();
-    $rawConfig = $this->loadConfig($alternateConfig);
-
-    $modulePropertyNamespace = MIDAS_BATCHMAKE_MODULE . '.';
-    foreach($rawConfig as $configProperty => $configPropertyVal)
+    if(!isset($alternateConfig))
       {
-      $ind = strpos($configProperty, $modulePropertyNamespace);
-      if($ind !== false && $ind  == 0)
+      $configPropertiesParamVals = array();
+      $rawConfig = $this->loadConfig();
+
+      $modulePropertyNamespace = MIDAS_BATCHMAKE_MODULE . '.';
+      foreach($rawConfig as $configProperty => $configPropertyVal)
         {
-        $reducedKey = substr($configProperty, strpos($configProperty, '.') + 1);
-        $configPropertiesParamVals[$reducedKey] = $configPropertyVal;
+        $ind = strpos($configProperty, $modulePropertyNamespace);
+        if($ind !== false && $ind  == 0)
+          {
+          $reducedKey = substr($configProperty, strpos($configProperty, '.') + 1);
+          $configPropertiesParamVals[$reducedKey] = $configPropertyVal;
+          }
         }
       }
-
+    else
+      {
+      $configPropertiesParamVals = $alternateConfig;
+      }
     $this->componentConfig = $configPropertiesParamVals;
     $this->configScriptDir = $this->componentConfig[MIDAS_BATCHMAKE_SCRIPT_DIR_PROPERTY];
     $this->configAppDir = $this->componentConfig[MIDAS_BATCHMAKE_APP_DIR_PROPERTY];
@@ -129,7 +130,7 @@ public function loadConfigProperties($alternateConfig = null)
    * @TODO from KWUtils, may need to be moved, but first tested
    * checks whether the file at the passed in path has the passed in options.
    */
-  protected function checkFileFlag($file, $options = 0x0)
+  protected function checkFileFlag($file, $processUserUid, $options = 0x0)
     {
     $exist    = file_exists($file);
     Zend_Loader::loadClass("InternationalizationComponent", BASE_PATH.'/core/controllers/components');
@@ -157,7 +158,7 @@ protected function checkFileFlag($file, $options = 0x0)
       }
     if(!KWUtils::isWindows() && $exist && ($options & MIDAS_BATCHMAKE_CHECK_IF_CHMODABLE))
       {
-      $chmodable = $this->IsChmodable($file);
+      $chmodable = $this->IsChmodable($file, $processUserUid);
       $status .= $chmodable ? " / Chmodable" : " / NotChmodable";
       $ret = $ret && $chmodable;
       }
@@ -172,7 +173,7 @@ protected function checkFileFlag($file, $options = 0x0)
    * Note: If return true, the mode of the file will be MIDAS_BATCHMAKE_DEFAULT_MKDIR_MODE
    *       On windows, return always True
    */
-  protected function isChmodable($fileOrDirectory)
+  protected function isChmodable($fileOrDirectory, $processUserUid)
     {
     if(KWUtils::isWindows())
       {
@@ -196,8 +197,20 @@ protected function isChmodable($fileOrDirectory)
 
     if(is_writable($fileOrDirectory))
       {
-      // Try to re-apply them
-      $return = chmod($fileOrDirectory, $current_perms);
+      // first check on the uid of the fileOrDirectory
+      // if that is different than the processUserUid, then chmod
+      // will return false and add a warning, so let's prevent this beforehand
+      $fileStat = stat($fileOrDirectory);
+      $fileUid = $fileStat['uid'];
+      if($fileUid !== $processUserUid)
+        {
+        return false;
+        }
+      else
+        {
+         // Try to re-apply them
+        $return = chmod($fileOrDirectory, $current_perms);
+        }
       }
     else
       {
@@ -227,13 +240,48 @@ public function testconfig($alternateConfigValues = null)
       $configToTest = $this->componentConfig;
       }
 
+    Zend_Loader::loadClass("InternationalizationComponent", BASE_PATH.'/core/controllers/components');
+
+    // Process web server user information
+
+    // TODO what should be done if there are warnings??
+    $processUser  = posix_getpwuid(posix_geteuid());
+    $processUserUid = $processUser['uid'];
+    $processGroup = posix_getgrgid(posix_geteuid());
+
+    $phpProcessString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_STRING);
+    $phpProcessUserString = $phpProcessString . ' ' . InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_USER_STRING);
+    $phpProcessNameString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_NAME_STRING);
+    $phpProcessGroupString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_GROUP_STRING);
+    $phpProcessHomeString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_HOME_STRING);
+    $phpProcessShellString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_SHELL_STRING);
+    $unknownString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_UNKNOWN_STRING);
+
+    $phpProcessUserNameString = $phpProcessUserString . '[' . $phpProcessNameString . ']';
+    $phpProcessUserGroupString = $phpProcessUserString . '[' . $phpProcessGroupString . ']';
+    $phpProcessUserHomeString = $phpProcessUserString . '[' . $phpProcessHomeString . ']';
+    $phpProcessUserShellString = $phpProcessUserString . '[' . $phpProcessShellString . ']';
+
+    $processProperties = array($phpProcessUserNameString => !empty($processUser[MIDAS_BATCHMAKE_PHP_PROCESS_NAME_STRING]) ? $processUser[MIDAS_BATCHMAKE_PHP_PROCESS_NAME_STRING] : "",
+    $phpProcessUserGroupString => !empty($processGroup[MIDAS_BATCHMAKE_PHP_PROCESS_NAME_STRING]) ? $processGroup[MIDAS_BATCHMAKE_PHP_PROCESS_NAME_STRING] : "",
+    $phpProcessUserHomeString => !empty($processUser[MIDAS_BATCHMAKE_DIR_KEY]) ? $processUser[MIDAS_BATCHMAKE_DIR_KEY] : "",
+    $phpProcessUserShellString => !empty($processUser[MIDAS_BATCHMAKE_PHP_PROCESS_SHELL_STRING]) ? $processUser[MIDAS_BATCHMAKE_PHP_PROCESS_SHELL_STRING] : "");
+
+    foreach($processProperties as $property => $value)
+      {
+      $status   = !empty($value);
+      $configStatus[]   = array(MIDAS_BATCHMAKE_PROPERTY_KEY => $property,
+      MIDAS_BATCHMAKE_STATUS_KEY => $status ? $value : $unknownString,
+      MIDAS_BATCHMAKE_TYPE_KEY => $status ? MIDAS_BATCHMAKE_STATUS_TYPE_INFO : MIDAS_BATCHMAKE_STATUS_TYPE_WARNING);
+      }
+
     foreach(self::$configPropertiesRequirements as $configProperty => $configPropertyRequirement)
       {
       $configPropertyVal = $configToTest[$configProperty];
       if($configPropertyVal)
         {
         // if the property exists, check its configuration
-        list($result, $status) = $this->checkFileFlag($configPropertyVal, $configPropertyRequirement);
+        list($result, $status) = $this->checkFileFlag($configPropertyVal, $processUserUid, $configPropertyRequirement);
         $configStatus[] = array(MIDAS_BATCHMAKE_PROPERTY_KEY => $configProperty, MIDAS_BATCHMAKE_STATUS_KEY => $status, MIDAS_BATCHMAKE_TYPE_KEY => $result ? MIDAS_BATCHMAKE_STATUS_TYPE_INFO : MIDAS_BATCHMAKE_STATUS_TYPE_ERROR);
         // the property is in error, therefore so is the global config
         if(!$result)
@@ -255,8 +303,6 @@ public function testconfig($alternateConfigValues = null)
       {
       $appPath = $configToTest[$pathProperty] ."/" . KWUtils::formatAppName($app);
       list($result, $status) = $this->checkFileFlag($appPath, MIDAS_BATCHMAKE_CHECK_IF_EXECUTABLE);
-      Zend_Loader::loadClass("InternationalizationComponent", BASE_PATH.'/core/controllers/components');
-
       $applicationString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_APPLICATION_STRING);
       $configStatus[] = array(MIDAS_BATCHMAKE_PROPERTY_KEY => $applicationString . ' ' .$appPath, MIDAS_BATCHMAKE_STATUS_KEY => $status, MIDAS_BATCHMAKE_TYPE_KEY => $result ? MIDAS_BATCHMAKE_STATUS_TYPE_INFO : MIDAS_BATCHMAKE_STATUS_TYPE_ERROR);
       // the property is in error, therefore so is the global config
@@ -266,37 +312,6 @@ public function testconfig($alternateConfigValues = null)
         }
       }
 
-    // Process web server user information
-
-    // TODO what should be done if there are warnings??
-    $processUser  = posix_getpwuid(posix_geteuid());
-    $processGroup = posix_getgrgid(posix_geteuid());
-
-    $phpProcessString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_STRING);
-    $phpProcessUserString = $phpProcessString . ' ' . InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_USER_STRING);
-    $phpProcessNameString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_NAME_STRING);
-    $phpProcessGroupString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_GROUP_STRING);
-    $phpProcessHomeString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_HOME_STRING);
-    $phpProcessShellString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_PHP_PROCESS_SHELL_STRING);
-    $unknownString = InternationalizationComponent::translate(MIDAS_BATCHMAKE_UNKNOWN_STRING);
-
-    $phpProcessUserNameString = $phpProcessUserString . '[' . $phpProcessNameString . ']';
-    $phpProcessUserGroupString = $phpProcessUserString . '[' . $phpProcessGroupString . ']';
-    $phpProcessUserHomeString = $phpProcessUserString . '[' . $phpProcessHomeString . ']';
-    $phpProcessUserShellString = $phpProcessUserString . '[' . $phpProcessShellString . ']';
-
-    $processProperties = array($phpProcessUserNameString => !empty($processUser[MIDAS_BATCHMAKE_PHP_PROCESS_NAME_STRING]) ? $processUser[MIDAS_BATCHMAKE_PHP_PROCESS_NAME_STRING] : "",
-    $phpProcessUserGroupString => !empty($processGroup[MIDAS_BATCHMAKE_PHP_PROCESS_NAME_STRING]) ? $processGroup[MIDAS_BATCHMAKE_PHP_PROCESS_NAME_STRING] : "",
-    $phpProcessUserHomeString => !empty($processUser[MIDAS_BATCHMAKE_DIR_KEY]) ? $processUser[MIDAS_BATCHMAKE_DIR_KEY] : "",
-    $phpProcessUserShellString => !empty($processUser[MIDAS_BATCHMAKE_PHP_PROCESS_SHELL_STRING]) ? $processUser[MIDAS_BATCHMAKE_PHP_PROCESS_SHELL_STRING] : "");
-
-    foreach($processProperties as $property => $value)
-      {
-      $status   = !empty($value);
-      $configStatus[]   = array(MIDAS_BATCHMAKE_PROPERTY_KEY => $property,
-      MIDAS_BATCHMAKE_STATUS_KEY => $status ? $value : $unknownString,
-      MIDAS_BATCHMAKE_TYPE_KEY => $status ? MIDAS_BATCHMAKE_STATUS_TYPE_INFO : MIDAS_BATCHMAKE_STATUS_TYPE_WARNING);
-      }
 
     return array($total_config_correct, $configStatus);
 
diff --git a/modules/batchmake/tests/controllers/BatchmakeControllerTest.php b/modules/batchmake/tests/controllers/BatchmakeControllerTest.php
@@ -0,0 +1,111 @@
+<?php
+/*=========================================================================
+MIDAS Server
+Copyright (c) Kitware SAS. 20 rue de la Villette. All rights reserved.
+69328 Lyon, FRANCE.
+
+See Copyright.txt for details.
+This software is distributed WITHOUT ANY WARRANTY; without even
+the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+PURPOSE.  See the above copyright notices for more information.
+=========================================================================*/
+
+// need to include the module constant for this test
+require_once BASE_PATH.'/modules/batchmake/constant/module.php';
+require_once BASE_PATH.'/library/KWUtils.php';
+
+/** helper class used for testing batchmake module */
+class BatchmakeControllerTest extends ControllerTestCase
+  {
+
+  /**
+   * helper function to return Midas configured temp directory
+   * @return midas temp dir
+   */
+  protected function getTempDirectory()
+    {
+    include_once BASE_PATH.'/core/GlobalController.php';
+    $controller = new MIDAS_GlobalController($this->request, $this->response);
+    return $controller->getTempDirectory();
+    }
+
+  /**
+   * function will create a temporary batchmake config, copying over test data
+   * to the the locations in that config needed for the tests, returning an
+   * array of config property names to directory locations.
+   * @TODO figure out a way to copy over Batchmake or else mock it
+   * @return string
+   */
+  public function setupAndGetConfig()
+    {
+    // create a test batchmake setup in the temp dir
+    // and initialize test data
+    $tmpDir = $this->getTempDirectory() .'/';
+    $subDirs = array("batchmake", "tests");
+    $testDir = KWUtils::createSubDirectories($tmpDir, $subDirs);
+    $configProps = array(MIDAS_BATCHMAKE_TMP_DIR_PROPERTY => $tmpDir.'/batchmake/tests/tmp',
+    MIDAS_BATCHMAKE_BIN_DIR_PROPERTY => $tmpDir.'/batchmake/tests/bin',
+    MIDAS_BATCHMAKE_SCRIPT_DIR_PROPERTY => $tmpDir.'/batchmake/tests/script',
+    MIDAS_BATCHMAKE_APP_DIR_PROPERTY => $tmpDir.'/batchmake/tests/bin',
+    MIDAS_BATCHMAKE_DATA_DIR_PROPERTY => $tmpDir.'/batchmake/tests/data',
+    MIDAS_BATCHMAKE_CONDOR_BIN_DIR_PROPERTY => '/home/condor/bin');//change this with mocks??
+    // now make sure these dirs exist
+    // later can actually add some stuff to these dirs
+    foreach($configProps as $prop => $dir)
+      {
+      if(!file_exists($dir) && !KWUtils::mkDir($dir))
+        {
+        throw new Zend_Exception("couldn't create dir ".$dir);
+        }
+      }
+
+    // now copy over the bms files
+    $srcDir = BASE_PATH . 'modules/batchmake/tests/testfiles/script';
+    $targetDir = $configProps[MIDAS_BATCHMAKE_SCRIPT_DIR_PROPERTY];
+    $extension = '.bms';
+    $this->symlinkFileset($srcDir, $targetDir, $extension);
+
+    // and now the bmms
+    $srcDir = BASE_PATH . 'modules/batchmake/tests/testfiles/bin';
+    $targetDir = $configProps[MIDAS_BATCHMAKE_APP_DIR_PROPERTY];
+    $extension = '.bmm';
+    $this->symlinkFileset($srcDir, $targetDir, $extension);
+
+    return $configProps;
+    }
+
+  /**
+   * looks in the srcDir, finds all files ending with $extension, and
+   * symlinks them to targetDir if there isn't already a file there
+   * by that name
+   * @param type $srcDir
+   * @param type $targetDir
+   * @param type $extension
+   */
+  protected function symlinkFileset($srcDir, $targetDir, $extension)
+    {
+    // open the directory
+    $handle = opendir($srcDir);
+    if(!is_readable($srcDir))
+      {
+      throw new Zend_Exception("can't read ".$srcDir);
+      }
+    // and scan through the items inside
+    while(false !== ($item = readdir($handle)))
+      {
+      // make sure item matches extendsion
+      if((strpos($item, $extension) == strlen($item) - 4))
+        {
+        // link the file if it isn't already there
+        $scriptTarget = $srcDir . '/' . $item;
+        $scriptLink = $targetDir . '/' . $item;
+        if(!file_exists($scriptLink) && !symlink($scriptTarget, $scriptLink))
+          {
+          throw new Zend_Exception($scriptTarget . ' could not be sym-linked to ' . $scriptLink);
+          }
+        }
+      }
+    closedir($handle);
+    }
+
+  }
diff --git a/modules/batchmake/tests/controllers/ConfigControllerTest.php b/modules/batchmake/tests/controllers/ConfigControllerTest.php
@@ -12,9 +12,10 @@
 
 // need to include the module constant for this test
 require_once BASE_PATH.'/modules/batchmake/constant/module.php';
+require_once BASE_PATH.'/modules/batchmake/tests/controllers/BatchmakeControllerTest.php';
 
 /** config controller tests*/
-class ConfigControllerTest extends ControllerTestCase
+class ConfigControllerTest extends BatchmakeControllerTest
   {
 
   protected $kwBatchmakeComponent;
@@ -25,12 +26,13 @@ public function setUp()
     {
     $this->setupDatabase(array('default'));
     $this->_models = array('User');
-    //$this->_daos = array('User');//
-    //$this->_moduleModels = array('Task');//
     $this->enabledModules = array('batchmake');
-    require_once BASE_PATH.'/modules/batchmake/controllers/components/KWBatchmakeComponent.php';
-    $this->kwBatchmakeComponent = new Batchmake_KWBatchmakeComponent(BASE_PATH.'/modules/batchmake/tests/configs/module.local.ini');
     parent::setUp();
+    if(!isset($this->kwBatchmakeComponent))
+      {
+      require_once BASE_PATH.'/modules/batchmake/controllers/components/KWBatchmakeComponent.php';
+      $this->kwBatchmakeComponent = new Batchmake_KWBatchmakeComponent($this->setupAndGetConfig());
+      }
     }
 
 
@@ -49,10 +51,8 @@ public function testIndexAction()
       $this->fail('Unable to find body element');
       }
 
-
     $this->assertQuery("form#configForm");
-    $applicationConfig = $this->kwBatchmakeComponent->loadConfigProperties(BASE_PATH.'/modules/batchmake/tests/configs/module.local.ini');
-    // change a value to something bad
+    $applicationConfig = $this->setupAndGetConfig();
     $this->params = array();
     $this->params[MIDAS_BATCHMAKE_TMP_DIR_PROPERTY] = $applicationConfig[MIDAS_BATCHMAKE_TMP_DIR_PROPERTY];
     $this->params[MIDAS_BATCHMAKE_BIN_DIR_PROPERTY] = $applicationConfig[MIDAS_BATCHMAKE_BIN_DIR_PROPERTY];
diff --git a/modules/batchmake/tests/controllers/components/KWBatchmakeComponentTest.php b/modules/batchmake/tests/controllers/components/KWBatchmakeComponentTest.php
