Improve CMakeLists.txt to allow installation of composer and dependencies

Author: Jamie Snape

.gitignore

@@ -1,12 +1,10 @@
-.buildpath
 .DS_Store
 .idea/
-.project
 .sass-cache/
-.settings/
 .vagrant/
-.zfproject.xml
 bower_components/
-nbproject/
+composer.lock
+composer.phar
+cron.yaml
 node_modules/
 vendor/

CMakeLists.txt

@@ -17,38 +17,58 @@
 # limitations under the License.
 #=============================================================================
 
-cmake_minimum_required(VERSION 2.8)
+cmake_minimum_required(VERSION 2.8.7)
 project(Midas)
 
-find_program(PHP "php" CACHE STRING "PHP executable")
+get_filename_component(REAL_SOURCE_DIR ${CMAKE_SOURCE_DIR} REALPATH)
+get_filename_component(REAL_BINARY_DIR "${CMAKE_BINARY_DIR}" REALPATH)
+if(${REAL_SOURCE_DIR} STREQUAL ${REAL_BINARY_DIR})
+    message(FATAL_ERROR "Binary directory must not be same as the source directory")
+endif()
+
+find_program(PHP "php" DOC "Path to the PHP executable")
 if(NOT PHP)
     message(FATAL_ERROR "Please set the path to the PHP executable")
 endif()
 
-find_file(COMPOSER_LOCK "composer.lock" PATHS ${CMAKE_CURRENT_SOURCE_DIR} NO_DEFAULT_PATH)
+#-----------------------------------------------------------------------------
+# Download and run composer to install third-party dependencies, if necessary
+#-----------------------------------------------------------------------------
+
+find_file(COMPOSER_LOCK "composer.lock" PATHS ${CMAKE_CURRENT_SOURCE_DIR} NO_DEFAULT_PATH DOC "Path to the composer lock file")
 if(NOT COMPOSER_LOCK)
-    find_file(COMPOSER_PHAR "composer.phar")
+    find_file(COMPOSER_PHAR "composer.phar" PATHS ${CMAKE_CURRENT_SOURCE_DIR} DOC "Path to the composer PHP archive")
     if(NOT COMPOSER_PHAR)
-        message(FATAL_ERROR "Please set the path to composer.phar")
+        message(STATUS "Downloading composer")
+        file(DOWNLOAD https://getcomposer.org/composer.phar ${CMAKE_CURRENT_SOURCE_DIR}/composer.phar STATUS DOWNLOAD_COMPOSER_PHAR_STATUS)
+        list(GET DOWNLOAD_COMPOSER_PHAR_STATUS 0 DOWNLOAD_COMPOSER_PHAR_RESULT)
+        list(GET DOWNLOAD_COMPOSER_PHAR_STATUS 1 DOWNLOAD_COMPOSER_PHAR_ERROR)
+        if(NOT DOWNLOAD_COMPOSER_PHAR_RESULT EQUAL 0)
+    	    message(FATAL_ERROR "Error downloading composer: ${DOWNLOAD_COMPOSER_PHAR_ERROR}")
+        endif()
+        message(STATUS "Downloading composer - done")
+        set(COMPOSER_PHAR ${CMAKE_CURRENT_SOURCE_DIR}/composer.phar CACHE FILEPATH "Path to the composer PHP archive")
     endif()
+    message(STATUS "Executing composer install")
     execute_process(
         COMMAND ${PHP} ${COMPOSER_PHAR} install
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
         RESULT_VARIABLE COMPOSER_INSTALL_RESULT
         OUTPUT_VARIABLE COMPOSER_INSTALL_OUTPUT
         ERROR_VARIABLE COMPOSER_INSTALL_ERROR)
     if(NOT COMPOSER_INSTALL_RESULT EQUAL 0)
         message(STATUS "Composer install output: ${COMPOSER_INSTALL_OUTPUT}")
         message(FATAL_ERROR "Composer install error: ${COMPOSER_INSTALL_ERROR}")
     endif()
-    message(STATUS "Composer install is complete")
+    message(STATUS "Executing composer install - done")
 endif()
 
 #-----------------------------------------------------------------------------
 # Drop all tables from the testing database, then reinstall the database, set
 # a default asset store, and install all modules
 #-----------------------------------------------------------------------------
 
-message(STATUS "Setting up database(s) for testing, please wait...")
+message(STATUS "Setting up database(s) for testing")
 execute_process(
     COMMAND ${PHP} ${CMAKE_CURRENT_SOURCE_DIR}/tests/DatabaseSetup.php
     RESULT_VARIABLE DATABASE_SETUP_RESULT
@@ -58,15 +78,14 @@ if(NOT DATABASE_SETUP_RESULT EQUAL 0)
     message(STATUS "Database setup output: ${DATABASE_SETUP_OUTPUT}")
     message(FATAL_ERROR "Database setup error: ${DATABASE_SETUP_ERROR}")
 endif()
-message(STATUS "Database setup is complete")
+message(STATUS "Setting up database(s) for testing - done")
 
 #-----------------------------------------------------------------------------
 # Setup testing and required parameters for testing
 #-----------------------------------------------------------------------------
 
 include(CTest)
 option(MIDAS_RUN_STYLE_TESTS "Run PHP style tests?" ON)
-set(SERVER_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR})
 
 add_subdirectory(tests)
 add_subdirectory(core/tests)

app.yaml

@@ -47,9 +47,9 @@ env_variables:
 
 skip_files:
 - ^(.*/)?.*/(\.DS_Store|\.htaccess|\.gitignore|CMakeLists\.txt|.*\.java)$
-- ^(.*/)?(\.coveralls.yml|\.project|\.travis.yml|\.zfproject\.xml|composer\.json|COPYRIGHT|CTestConfig\.cmake|LICENSE|README\.md|Vagrantfile)$
+- ^(.*/)?(\.coveralls.yml|\.travis.yml|composer\.json|composer\.lock|COPYRIGHT|CTestConfig\.cmake|cron-sample\.yaml|LICENSE|README\.md|Vagrantfile)$
 - ^(.*/)?core/configs/.*\.local\.ini$
-- ^(.*/)?(\.git|\.idea|\.vagrant|data|log|nbproject|provisioning|tests|tmp|utils)/.*
+- ^(.*/)?(\.git|\.idea|\.vagrant|data|log|provisioning|tests|tmp|utils)/.*
 - ^(.*/)?(core|modules/.*)/(database/pgsql|sqlite|tests)/.*
 - ^(.*/)?library/CMake/.*
-- ^(.*/)?modules/(batchmake|dicom.*|example|metadataextractor|pvw|remoteprocessing|solr|statistics|thumbnailcreator|visualize)/.*
+- ^(.*/)?modules/(batchmake|dicom.*|example|metadataextractor|pvw|remoteprocessing|solr|thumbnailcreator|visualize)/.*

composer.json

@@ -53,8 +53,6 @@
             "/core/configs/*.local.*",
             "/data/*/**",
             "/log/**",
-            "/tests/TestsConfig.php",
-            "!/tests/TestsConfig.php.in",
             "/tmp/*/**"
         ]
     }

tests/.gitignore

@@ -17,8 +17,6 @@
 # limitations under the License.
 #=============================================================================
 
-configure_file(${CMAKE_SOURCE_DIR}/tests/TestsConfig.php.in ${CMAKE_SOURCE_DIR}/tests/TestsConfig.php)
-
 macro(to_titlecase Arg Result)
     string(SUBSTRING ${Arg} 0 1 ArgHead)
     string(TOUPPER ${ArgHead} ArgHead)

tests/CMakeLists.txt

@@ -19,7 +19,6 @@
 =========================================================================*/
 
 require_once dirname(__FILE__).'/TestsBootstrap.php';
-require_once dirname(__FILE__).'/TestsConfig.php';
 require_once BASE_PATH.'/core/controllers/components/UtilityComponent.php';
 
 /** main controller test element */

tests/ControllerTestCase.php

@@ -19,7 +19,6 @@
 =========================================================================*/
 
 require_once dirname(__FILE__).'/TestsBootstrap.php';
-require_once dirname(__FILE__).'/TestsConfig.php';
 require_once BASE_PATH.'/core/controllers/components/UtilityComponent.php';
 
 /** main models test element */

tests/DatabaseTestCase.php

@@ -17,11 +17,12 @@
 # limitations under the License.
 #=============================================================================
 
-# This CMake script should be used to create a new Midas module. Requires CMake v2.8.3+
+# This CMake script should be used to create a new Midas module.
 # Call as
 #   cmake -P NewModule.cmake modulename
 # Where modulename is the name of your module. It should have no spaces in it.
 #
+cmake_minimum_required(VERSION 2.8.7)
 if(NOT DEFINED CMAKE_ARGV3)
   message(FATAL_ERROR "Must pass in module name as an argument: cmake -P NewModule.cmake mymodule")
 endif()