Feat/custom extension callback (#9)

* Custom post pecl build callbacks

Author: francisek

.codeclimate.yml

@@ -4,6 +4,10 @@ engines:
     enabled: false
   shellcheck:
     enabled: true
+    exclude_fingerprints:
+      - f3a504d17f12f40fdd844596ffdbf736
+      - 4ccff9eccea3fa979ffe68b8945f0891
+      - 46c633c75fd34040d1a09071df1fd691
 ratings:
   paths:
   - "**.sh"

CHANGELOG.md

@@ -1,14 +1,19 @@
 # Changelog
 
+0.4.0 :
+
+- Fix prefered download site usage
+- Add post pecl build callback
+
 0.3.0 :
 
-- Added variable `php_band_php_extension_dir`
-- Added extension building support
+- Add variable `php_band_php_extension_dir`
+- Add extension building support
 
 0.2.0 : 
 
-- Added a check of configuration files modification date to rebuild
-- Created an asset directory for testing
-- Added possibility to specify the root dir with environment variable PHP_BAND_ASSETS_DIR
+- Add a check of configuration files modification date to rebuild
+- Create an asset directory for testing
+- Add possibility to specify the root dir with environment variable PHP_BAND_ASSETS_DIR
 
 0.1.0 : Initial version

README.md

@@ -119,13 +119,20 @@ The pre_\* and post_\* functions are called with the working directory set to th
 
 Extensions are built and installed after php itself.
 
-It is of your responsability to provide the loading and parameters of the extension to php, generally by creating an extension_name.ini file in the `${php_band_php_install_dir}/conf.d/` directory.
+It is of your responsability to provide the loading and parameters of the extension to php, generally by either:
+
+- create a post extension build callback
+- create an extension_name.ini file in the `${php_band_php_install_dir}/conf.d/` directory.
 
 ### Using pecl
 
 You add some pecl extensions to build in your *configure-php.sh* file by using the function *php_band_pecl_add_package*.
-It takes the package name as first parameter and eventually a string representing user inputs as second parameter.
-The pecl package name must be a string accordingly to [pecl documentation](http://php.net/manual/en/install.pecl.pear.php).
+It takes the following arguments:
+
+- the package name as first parameter is mandatory. Refer to [pecl documentation](http://php.net/manual/en/install.pecl.pear.php) for available formats ;
+- an optionnal string representing user inputs as second parameter. Add a newline character `\n` after each simulated user answer ;
+- an optionnal post build callback name. The default value is `post_pecl_<package name>_build`. If the function exists it will be called on successfull build.
+
 For example to install the xdebug package, use either :
 
 ```
@@ -135,13 +142,13 @@ php_band_pecl_add_package 'xdebug'
 or
 
 ```
-php_band_pecl_add_package 'xdebug-2.5.0'
+php_band_pecl_add_package 'xdebug-2.5.0' '' 'post_pecl_xhprof_build'
 ```
 
 or
 
 ```
-php_band_pecl_add_package 'pecl.php.net/xdebug-stable'
+php_band_pecl_add_package 'pecl.php.net/xdebug-stable' '' 'post_pecl_xhprof_build'
 ```
 
 You may know some extensions defined in a lower config file are not compatible with a specific version (for example, xhprof does not work on 7.x).
@@ -162,7 +169,11 @@ Our `config/configure-php.sh` may look like:
 ```bash
 #!/bin/bash -e
 
-php_band_pecl_add_package 'xhprof-stable'
+php_band_pecl_add_package 'xhprof-stable' '' 'post_pecl_xhprof_build'
+
+post_pecl_xhprof_build() {
+    echo 'extension=xhprof.so' > "${php_band_php_install_dir}/conf.d/xhprof.ini"
+}
 ```
 
 In the `config/7/configure-php.sh` file we won't install pecl version but the git version from branch 'php7':
@@ -192,7 +203,7 @@ extension_custom_xhprof() {
     ./configure --with-php-config=${php_band_php_install_dir}/bin/php-config
     make ${MAKE_OPTS} && make install
 
-    echo "extension=${php_band_php_extension_dir}/xhprof.so" > ${php_band_php_install_dir}/conf.d/xhprof.ini
+    echo "extension=xhprof.so" > ${php_band_php_install_dir}/conf.d/xhprof.ini
 }
 ```
 

bin/php-band

@@ -47,7 +47,7 @@ EOM
 }
 
 command_version() {
-    echo "0.3.0"
+    echo "0.4.0"
     exit 0
 }
 

lib/core.sh

@@ -135,7 +135,7 @@ php_band_check_for_source() {
     php_band_archive_filename=$(php_band_build_source_filename) 
     srcfile="$PHP_BAND_ARCH_DIR/$php_band_archive_filename"
     [ -f "$srcfile" ] && [ -s "$srcfile" ] && return
-    for i in "${php_prefered_sites:?[@]}" ; do
+    for i in "${php_prefered_sites[@]:?}" ; do
         host=$(php_band_apply_shell_expansion "${i%%}")
         log_info "Attempting to download from $host"
         $WGET_BIN -P "$PHP_BAND_ARCH_DIR" -O "$srcfile" "$host"
@@ -172,12 +172,12 @@ php_band_get_php_extension_dir() {
 
 php_band_pecl_add_package() {
     local package="$1"
-    local user_input=$2
+    local options=(${@:2})
     if [ -z "${package}" ]; then
         echo "Package name is mandatory"
         return 1
     fi
-    PHP_BAND_CUSTOM_PECL_EXTENSIONS[$package]=$user_input
+    PHP_BAND_CUSTOM_PECL_EXTENSIONS[$package]=${options[*]}
     return 0
 }
 
@@ -194,20 +194,36 @@ php_band_pecl_remove_package() {
 php_band_pecl_build_extension() {
     local ext_channel="$1"
     local user_input="${2}"
+    local post_install="${3:-post_pecl_$1_build}"
+    local build_output
     log_info "Building pecl extension ${ext_channel}"
-    echo "${user_input}" | "${php_band_php_install_dir}"/bin/pecl install "${ext_channel}" > /dev/null
-    [ $? -eq 0 ] || log_info "Extension building failed"
+    build_output=$(echo -e "${user_input}" | "${php_band_php_install_dir}"/bin/pecl install "${ext_channel}" 2>&1)
+    if [ "" != "$(echo "${build_output}" | grep -i "Build process completed successfully")" ]; then
+        log_info "  Extension built successfully"
+    elif [ "" != "$(echo "${build_output}" | grep -i "already installed")" ]; then
+        log_info "  Extension already built"
+    else
+        log_info "  Extension building failed $(echo "${build_output}" | grep -i 'error')"
+        return
+    fi
+
+    if [ -n "${post_install}" ] && [ "$(type -t "${post_install}")" = "function" ]; then
+        log_info "  Calling post built action ${post_install}"
+        ${post_install}
+    fi
 }
 
 php_band_pecl_build() {
     local cwd
+    local pecl_args
     cwd="$(pwd)"
     echo "Pecl Extensions to install : ${!PHP_BAND_CUSTOM_PECL_EXTENSIONS[*]}"
     for pecl_channel in ${!PHP_BAND_CUSTOM_PECL_EXTENSIONS[*]} ; do
         echo "Pecl extension $pecl_channel requested"
         # shellcheck disable=SC2164
         cd "$cwd"
-        php_band_pecl_build_extension "$pecl_channel" "${PHP_BAND_CUSTOM_PECL_EXTENSIONS[${pecl_channel}]}"
+        pecl_args=${PHP_BAND_CUSTOM_PECL_EXTENSIONS[${pecl_channel}]}
+        php_band_pecl_build_extension "$pecl_channel" ${pecl_args[@]}
     done
     # shellcheck disable=SC2164
     cd "$cwd"
@@ -245,7 +261,7 @@ php_band_external_build() {
         command_to_run="extension_${ext_et}"
         if [ "$(type -t "$command_to_run")" = "function" ]; then
             command_params=${PHP_BAND_CUSTOM_EXTERNAL_EXTENSIONS[$ext_et]}
-            $command_to_run "${command_params[@]}"
+            $command_to_run ${command_params[@]}
         fi
     done
 }

test/10_simple_commands.bats

@@ -4,7 +4,7 @@ load test_helper
 
 @test "Call php-band with query version argument" {
     run bin/php-band --version
-    assert_output "0.3.0" 
+    assert_output "0.4.0" 
     assert_success
 }
 

test/20_pecl_extensions.bats

@@ -10,7 +10,8 @@ setup() {
   local output
   php_band_php_install_dir="${BATS_TEST_DIRNAME}/mock"
   output=$(php_band_pecl_build_extension 'test')
-  assert_equals "Building pecl extension test" "$output"
+  assert_contains "Building pecl extension test" "$output"
+  assert_contains "Extension building failed" "$output"
 }
 
 @test "Request installation of a pecl extension" {