Setting up Jenkins Continuous Integration for a PHP project on a Mac Mini Server


With one of my previous post I have run through the steps involve in setting up Jenkins and today I’m going to discuss about the how to get a PHP project integrated with Jenkins on a Mac Mini server(It’s a pain in the ass compared to a Linux box when it comes to setting up Jenkins server).

List of items required

We need to enable and install following modules both on Jenkins as well as on PHP.

  • Jenkins
    • Checkstyle
    • CloverPHP
    • Dry
    • HTML Publisher
    • JDepend
    • Plot
    • PMD
    • Violation
    • xUnit
    • JSHint Report
    • Apache Ant
    • Subversion
    • Jenkins Email Extension
  • PHP modules using the PEAR package
    • phploc
    • pdepend
    • phpmd
    • phpcs
    • phpcpd
    • phpdox
    • phpunit
    • phpcb

Install modules and plugins

Alright, we have list down the items and now lets see how to install each items.

Installation of Jenkins modules

Navigates to Jenkins » Manage Jenkins » Plugin Manager.

Under this section you’ll find four tabs, namely Updates, Available, Installed, Advanced. Select Available tab and tick the above mentioned list of plugins from the list and click on the Install without restart button.

Installation of required PHP modules via PEAR package

Please make sure that you have installed the PHP PEAR package before proceeding with the below steps.

  • phploc – A tool for quickly measuring the size of a PHP project.
    $ sudo pear config-set auto_discover 1
    $ sudo pear install pear.phpunit.de/phploc
  • pdepend – Metrics analysis tool for software developed in PHP.
    $ sudo pear channel-discover pear.pdepend.org
    $ sudo pear install pdepend/PHP_Depend-beta
  • phpmd – It takes a given PHP source code base and look for several potential problems within that source.
    $ sudo pear channel-discover pear.phpmd.org
    $ sudo pear install phpmd/PHP_PMD
  • phpcs – It tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.
    $ sudo pear install PHP_CodeSniffer
  • phpcpd – It is a Copy/Paste Detector (CPD) for PHP code.
    $ pear install pear.phpunit.de/phpcpd
  • phpdox – It is a documentation generator for generating API documentation in HTML format, for instance, from PHP source code.
    $ sudo pear install -f pear.netpirates.net/phpDox-0.5.0
  • phpunit – It is a documentation generator for generating API documentation in HTML format, for instance, from PHP source code.
    $ sudo pear channel-discover pear.phpunit.de
    $ sudo pear install phpunit/PHPUnit
  • phpcb – It is a documentation generator for generating API documentation in HTML format, for instance, from PHP source code.
    $ sudo pear channel-discover pear.phpqatools.org
    $ sudo pear install --alldeps phpqatools/PHP_CodeBrowser

Fixing the issue:
When you execute Build Now from the project’s menu you’ll notice that following message is displayed under Console Output section.

phpcpd:
     [exec] Warning: require(PHPCPD/Autoload.php): failed to open stream: No such file or directory in /usr/bin/phpcpd on line 49
     [exec] Fatal error: require(): Failed opening required 'PHPCPD/Autoload.php' (include_path='.:') in /usr/bin/phpcpd on line 49

Where ever your encounter a similar error please place the following block of code on the top of the respective script. This required script can be found under /usr/bin. For example with phpcpd place the following block of code.

$path = '/usr/lib/php';
set_include_path(get_include_path() . PATH_SEPARATOR . $path);

Preparation of the build script

I used the Template for Jenkins Jobs for PHP Projects for preparing the build script. The site provides a comprehensive guide to create the build script for Apache Ant.

Elephanti the Revolutionary Lifestyle Media Network


Today social media applications plays an important role in our day-to-day activities as a result of the Web 2.0 revolution that took place in the Internet. It has revolutionized the lifestyle of almost all the individuals and business entities, for the majority of them spending at least few minutes with it has become an integral part of the day. The Elephanti, is a retail media ecosystem that aims to provide a platform for both individuals (Shoppers) and business entities (Merchants) to virtually interact with each other to buy and sells items on the go. It composed of a free Web based application for the Merchants and a free smart phone application (iPhone and Android) for Shoppers.

  • The Merchants can sign up for a free account and be able to create a virtual storefront in few minutes and manage its routine activities via the Web based console to update their profile, add products, post discounts, etc…
  • Those who are signing up as Merchants, initially selects their type of business (Single store, Chain store, Mall, Brand, Department store and Freelancer). Each type of business is modeled with an unique, customized set of features to facilitate its main line of business requirements.
  • For Merchant signing up with Elephanti, the system facilitates the merchant to describe the nature of the business and its specialization areas, such as Fashion retail, Cafes, Dinning venue, Cinema, Book stores, Services, Health and Beauty, Consumer electronic, Grocery stores, Automotive, Hotel, Travel and Tourism, Entertainment venue, etc… Each category further goes into a fine level of detailed specializations.
  • Shoppers only needs to download the app into their mobile phones to follow their favorite merchants, search for interesting place, items, create a shopping list, and many more. Using the app, they will be able to look at stores nearby and see what they have, write a review, add items to their shopping lists.
    • Shoppers will be able to look at places nearby and see what they have by check-in to the place, this provides the shopper and the shop owner a customized set of interactive features.
    • Also the Shoppers can discover Friends on the Elephanti network or sending invitations via other social media networks or via an Email and interact with each other through messaging, sharing activity updates, exchange shopping lists, uploading photo(s) to an album and tag their friends or/and places(Merchants), etc…
    • Shoppers can organize list of items planning buy just by creating a shopping lists and select nearby place(Merchant) they plans to buy it.
    • Rate a place and write a review and/or to comment them.

The main idea of Elephanti is to provide a platform for business owners to create a virtual storefront and invite shoppers to get to know about the items they sell and the discounts they offer, in the meantime the Shoppers are benefited by finding places nearby, items they sell and the discounts they offer and getting touch with their friends, plan their activities and many more.

Setting up osTicket to handle customer inquires


osTicket is a widely used open source ticket management systems that can be easily configured to create tickets to inquires via emails, web interface, etc…

Download

It is always advisable to download the latest stable version of osTicket and move it to preferred location to continue the installation process.

Configuration & Database creation

Move the content inside uploads/ to root of the installation folder.

Navigate to includes/ folder and rename ost-config.sample.php to ost-config.php and grant write permission.

$ cp ost-config.sample.php ost-config.php
$ chmod +w ost-config.php

Connect to MYSQL server and create a new database to hold the tables and the corresponding data of the ticket system.

$ mysql -u<username> -p<password>
mysql> create database <database_name>
mysql> show databases;

Basic Installation: Step 1

As shown in Figure 1 provide the relevant information to suite your requirement and click Install to proceed to next step. The information it captured is categorised in to following subsections.

  • Web path & title – Installation URL path and the Title(provide a meaningful title to describe your exact purpose) of the osTicket system
  • System email – The email address which acts as the sender for all the outgoing email via the ticket system.
  • Admin user
  • Database

osTicket - Basic Installation

Figure 1: osTicket – Basic Installation

Basic Installation: Step 2

As shown in Figure 2 once the installation is successful carry out the following two tasks.

  • Revoke write permission from ost-config.php using the following command
    • $ chmod 644 include/ost-config.php
  • Delete the setup directory
    • $ rm -fr setup/

Installation success

Figure 2: osTicket – Installation Successful

Reference

Configuration: General Preferences and Settings

Login to Administration section (http://www.site-url.com/scp/login.php) or click on the Admin Panel link as shown in Figure 2 or invoke Admin Panel (http://www.site-url.com/scp/admin.php) section using the upper navigation bar found on the top right corner. Refer Figure 3.

osTicket - Configuration - Admin Panel

Figure 3: osTicket – Configuration – Admin Panel

Next click on the Settings tab as shown in Figure 3. This section let you manage parameters such as General Settings, Date & Time, Ticket Options & Settings, Email Settings, Autoresponders and Alerts & Notices. I’ll be mainly focusing on parameters found under General Settings and Email Settings.

  • General Settings – Common parameters like Site URL, Title, Site Online/Off-line, Enable Auto Cron, etc…
    • Helpdesk Status – This lets us manage the ticket system go online or off-line.
    • Helpdesk URL – This allows to update the URL fro the ticket system.
    • Default Department – The categorisation which the system used to managed the Staff/Users in the system.
    • Enable Auto Cron – This enables the cronjob tasks scheduled by the system. I’ll be discussing how to configure and set the conjob tasks on the server.
  • Email Settings – Especially important if planning to use the ticket system to fetch email to generate tickets.
    • Incoming Emails – This settings provide the ability to control fetching of emails via POP/IMAP email and email piping.
    • Outgoing Emails – The mail server which outgoing email will be handled.
    • Default System Email – The email address which acts as the sender for all the outgoing email via the ticket system.

Configuration: Admin Panel -> Settings -> API

This section provide the facility to generate the API key used in remote email piping feature. This key needs to be updated in the automail.php or automail.pl files located inside scripts/ folder. Please provide the following two information to generate the API key.

  • Add New IP – Provide the IP address assigned to the server/instance the system is hosted.
  • API Passphrase – This will be used to generated the API key used in email piping feature.

Setting up Email address(es) to automatically fetch to generate tickets.

Lets see how to configure an email account in osTicket to automatically generate a ticket(email ticket) for each email received to the email address. Navigates to Admin Panel -> Email -> Add New Email. Please provide the following information described below.

  • Email Info – Settings are mainly for emailed tickets.
    • Email Address
    • Email Name – The text used as the FROM name of the email.
    • New Ticket Priority – The priority level which the ticket should be assigned.
    • New Ticket Dept – The department which the ticket should get categorised.
    • Login info – Required when IMAP/POP and/or SMTP are enabled
      • Username – The email address or the email ID of the email account.
      • Password – The password of the email account.
  • Mail Account – Setting for fetching incoming emails. Mail fetching must be enabled with autocron active or external cron setup.
    • Status – Enable/Disable email fetch feature
    • Host – Hostname of the POP or IMAP service of the email server
    • Port – The port number which POP or IMAP service available
    • Protocol – IMAP or POP
    • Encryption – Yes or NO
    • Fetch Frequency – The time interval which the ticket system to check for new emails.
    • Maximum Emails Per Fetch
  • SMTP Settings – When enabled the email account will use SMTP server instead of internal PHP mail() function for outgoing emails (optional).
    • Status – Enable/Disable the use of following SMPT details for all out going communication
    • SMTP Host – Hostname of the SMTP service of the email server
    • SMTP Port – The port number which SMTP service available
    • Authentication Required? – Yes or NO

Scheduling the Cron job task

Under General Preferences and Settings we came across a parameter to enables the cronjob tasks scheduled by the system. Open up your favourite editor (preferably vi). and issue following commands.


$ crontab -l //to list already scheduled tasks
$ crontab -e //to scheduled a new task

If this is the first time it will prompt you to select the editor, select one that preferred by you and it will open up the crontab, schedule the task as follows.


# m h dom mon dow command
MAILTO="hayeshais at gmail.com" # this will fire an email upon failure to execute any of the scripts to this email address
*/5 * * * * nobody /usr/bin/php /var/www/api/cron.php
*/5 * * * * nobody wget -q -O /dev/null --user-agent=4816EC4CA293EE2EFCA2C89C88750F4A http://<www.helpdesk.examplesite.com>/api/cron.php
*/5 * * * * nobody /usr/bin/php -q /var/www/api/cron.php

Enjoy.

Amazon s3 with Codeignitor


When selecting the deployment environment as Amazon AWS, it comes up with a nice tool called Amazon S3 (Amazon Simple Storage Service) which can be used as a storage for static content, especially as a content delivery network (CDN).

Amazon S3 provides a simple web services interface that can be used to store and retrieve any amount of data, at any time, from anywhere on the web, and it also consists with a set of APIs to manipulate it via most of the popular programming laguages.

In our project we maintained a separate server, accessed via FTP to store all the images used in the application. The application was developed on top of CI framework, so we didn’t had any problem communicating with the FTP server since the framework itself was geared with a feature rich FTP library. Amazon AWS environment was selected as the hosting environment. With the introduction of Amazon AWS environment we opted to use Amazon S3 as our image repositiry for the project. I found an Amazon S3 PHP library developed for CI on Git Hub. Later extended it to suite our requirements. It can be downloaded over here.

Continuous integration with Jenkins – PHP


Build automation, the practice of automating various tasks that software developers need to perform in their daily routine. These tasks usually include the compilation of source code into binary code and the running of automated tests as well as the packaging and possibly even the deployment of the resulting binaries. Although PHP is an interpreted language and does not use an explicit compilation step it is common to perform code generation or code transformation tasks during a build nowadays.

Jenkins, an Open Source Continuous Integration(CI) tool, is by far the most popular CI tool on the market. Although I’ll be focusing on a PHP project, Jenkins CI tool can be configured to used for various projects that uses different programming languages.

I got the change to setup Jenkins to monitor our PHP project and hoping to set it up for the Android and iPhone projects. The book mentioned at the end of this post nicely guides the reader towards successfully setting up and configuring a PHP project to work with Jenkins.

Please visit http://jenkins-ci.org/ for a detail guide on installing & setting up the Jenkins CI Server environemnt.

Next step would be to install the required PHP Pear packages

$ sudo pear upgrade PEAR
$ sudo pear config-set auto_discover 1
$ sudo pear install pear.phpqatools.org/phpqatools pear.netpirates.net/phpDox

Above pear packages are required to function following plugins on Jenkins

  • PHPUnit is the de-facto standard for the unit testing of PHP code.
  • PHP_CodeSniffer is the most commonly used tool for static analysis of PHP code. It is typically used to detect violations of code formatting standards but also supports software metrics as well as the detection of potential defects.
  • phpcpd (PHP Copy/Paste Detector) searches for duplicated code in a PHP project.
  • PHP_Depend is a tool for static code analysis of PHP code that is inspired by JDepend.
  • phpmd (PHP Mess Detector) allows the definition of rules that operate on the raw data collected by PHP_Depend.
  • phploc measures the scope of a PHP project by, among other metrics, means of different forms of the Lines of Code (LOC) software metric.
  • PHP_CodeBrowser is a report generator that takes the XML output of the aforementioned tools as well as the sourcecode of the project as its input.
  • phpdox for automated API documentation generation for PHP code

Final step is to install the plugins required to integrate PHP projects for Jenkins CI Server. There are more than 500 plugins to choose from. The installation of the plugin(s) can be achieved either by using the Web-based interface or using the Jenkins command line interface, which can be downloaded as follows:

wget http://<hostname&gt;:8080/jnlpJars/jenkins-cli.jar

Install the respective plugins in the following manner, hostname – localhost

java -jar jenkins-cli.jar -s http://<hostname&gt;:8080 install-plugin <plugin name>
...
...
...
java -jar jenkins-cli.jar -s http://<hostname&gt;:8080 safe-restart

References

« Older entries