Merge pull request #80 from rosette-api/RCB-615-release-php-binding

Rcb 615 release php binding

Author: seth-mg

.gitignore

@@ -19,3 +19,7 @@ composer.lock
 vendor/
 bin/
 *.cache
+
+# Code coverage
+coverage.xml
+coverage/

CI.Jenkinsfile

@@ -1,8 +1,8 @@
 // These are Debian images.
-def php_versions = [7.1, 7.2, 7.3, 7.4, 8.0, 8.1, 8.2]
+def php_versions = [7.3, 7.4, 8.0, 8.1, 8.2]
 
 def runVersion(sourceDir, ver) {
-    mySonarOpts = "-Dsonar.sources=/source -Dsonar.host.url=${env.SONAR_HOST_URL} -Dsonar.login=${env.SONAR_AUTH_TOKEN}"
+    mySonarOpts = "-Dsonar.host.url=${env.SONAR_HOST_URL} -Dsonar.login=${env.SONAR_AUTH_TOKEN}"
     if ("${env.CHANGE_ID}" != "null") {
         mySonarOpts = "$mySonarOpts -Dsonar.pullrequest.key=${env.CHANGE_ID} -Dsonar.pullrequest.branch=${env.BRANCH_NAME}"
     } else {
@@ -12,12 +12,15 @@ def runVersion(sourceDir, ver) {
         mySonarOpts = "$mySonarOpts -Dsonar.pullrequest.base=${env.CHANGE_TARGET} -Dsonar.pullrequest.branch=${env.CHANGE_BRANCH}"
     }
 
-    // Only run Sonar once.  Use 7.4 until we get our 8.x ducks in a row.
-    if (ver == 7.4) {
+    // Only run Sonar once.
+    // There is an equivalent check in CI.sh.  Update both!!!!
+    // The coverage tool version we are using doesn't like 8.2.
+    // TODO:  Add CS Fixer Execution somewhere in CI.sh during the 8.2 extras.
+    if (ver == 8.1) {
         sonarExec = "cd /root/ && \
                wget -q https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.8.0.2856-linux.zip && \
                unzip -q sonar-scanner-cli-4.8.0.2856-linux.zip && \
-               cd /source && \
+               cd /php-source && \
                /root/sonar-scanner-4.8.0.2856-linux/bin/sonar-scanner ${mySonarOpts}"
     } else {
         sonarExec = "echo Skipping Sonar for this version."
@@ -27,9 +30,9 @@ def runVersion(sourceDir, ver) {
     sh "docker run --rm \
             --pull always \
             -e ROSETTE_API_KEY=${env.ROSETTE_API_KEY} \
-            -v ${sourceDir}:/source \
+            -v ${sourceDir}:/php-source \
             php:${ver}-cli \
-            bash -c \"cd /source && \
+            bash -c \"cd /php-source && \
                       ./CI.sh && \
                       ${sonarExec}\""
 }

CI.sh

@@ -1,12 +1,12 @@
 #!/usr/bin/env bash
-set -ex
+set -e
 
 this_script=$(basename "$0")
 
 # Install some tools
 echo "*** [${this_script}] Installing some OS packages"
-apt-get update
-apt-get install -y git wget zip
+apt-get update > /dev/null 2>&1
+apt-get install -y git wget zip > /dev/null 2>&1
 
 # The composer installation steps via https://getcomposer.org/download/
 # and https://getcomposer.org/doc/faqs/how-to-install-composer-programmatically.md
@@ -28,7 +28,7 @@ echo "*** [${this_script}] Removing composer-setup.php"
 php -r "unlink('composer-setup.php');"
 
 echo "*** [${this_script}] Changing to binding source directory"
-pushd /source
+pushd /php-source
 
 # TODO:  Review if we should be using a compose.lock file instead.
 echo "*** [${this_script}] Running composer update"
@@ -37,15 +37,46 @@ composer update
 echo "*** [${this_script}] Running composer install"
 composer install --prefer-source --no-interaction
 
-echo "*** [${this_script}] Running phpspec"
-bin/phpspec run --config=phpspec.yml --bootstrap=./vendor/autoload.php --no-interaction --format=pretty
+#Install Xdebug coverage tool
+version=$(php -v | awk 'match($0, /PHP [78]\.[0-4]/) { print substr($0, RSTART, RLENGTH) } ' | awk '{print $2}')
+echo "*** [${this_script}] PHP version: $version"
+if [ "${version}" == "8.1" ]; then
+    # Installation according to https://xdebug.org/docs/install#source
+    echo "*** [${this_script}] Installing Xdebug coverage tool"
+    cd /
+    git clone https://github.com/xdebug/xdebug.git
+    cd xdebug
+    git checkout 3.1.5 > /dev/null 2>&1
+    phpize
+    ./configure --enable-xdebug  > /dev/null 2>&1
+    make  > /dev/null 2>&1
+    make install  > /dev/null 2>&1
+    echo "zend_extension=xdebug" > /usr/local/etc/php/conf.d/99-xdebug.ini
+    export XDEBUG_MODE=coverage
+    cd /php-source
+    echo "*** [${this_script}] Running phpspec"
+    bin/phpspec run --config=phpspec.coverage.yml --bootstrap=./vendor/autoload.php --no-interaction --format=pretty
+else 
+    echo "*** [${this_script}] Skipping test coverage generation for this version"
+    echo "*** [${this_script}] Running phpspec"
+    bin/phpspec run --config=phpspec.yml --bootstrap=./vendor/autoload.php --no-interaction --format=pretty
+fi
 
 echo "*** [${this_script}] Running examples"
 pushd examples
 for example in $(ls *.php); do
-    echo "*** [${this_script}] Running ${example}"
-    php ${example} --key ${ROSETTE_API_KEY}
-    # TODO:  Capture output in a file and only print it for errors.
+    echo "*** [${this_script}] Running ${example} with PHP ${version}"
+    php ${example} --key ${ROSETTE_API_KEY} > "${example}-output.txt" 2>&1
+    # Disable error mode for grep
+    set +e
+    if grep -q Exception "${example}-output.txt"; then
+      echo "*** [${this_script}] ${example} failed!"
+      cat "${example}-output.txt"
+      rm -f "${example}-output.txt"
+      exit 1
+    fi
+    set -e
+    rm -f "${example}-output.txt"
 done
 
 echo "*** [${this_script}] Finished!"

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2015 Basis Technology Corporation.
+Copyright (c) 2014-2023 Basis Technology Corporation.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.