Category: PHP

Getting started with AMP stack on Mac OS X Lion

Post author By masnun
Post date June 22, 2012

The other day, I got myself a Macbook Pro which runs OS X Lion. Coming from the Linux world where everything is available at finger tips via package managers, I was at first lost. I tried MAMP and Zend Server CE. I had some issues with Zend Server CE and custom virtual hosts – mostly because I couldn’t figure out which bits to be changed. MAMP worked out pretty well. But I wanted to use the native builds of the AMP stack. I know about macports and homebrew but wanted to do things myself!

(1) Mac OS X ships with built in apache. I enabled “Web Sharing” from System Preference > Sharing. It turned on viewing of my ~/Sites directory at http://localhost/~masnun/. It works but not pretty helpful.

(2) I edited /etc/apache2/httpd.conf to change the document root to ~/Sites. Now I could see my home page on localhost.

(3) I tried creating virtual hosts at ~/VirtualHosts – this worked with MAMP but with the built in Apache, it can not load the virtualhosts from that location because of permission issues. So instead, I reinstated the default location for vhosts inside the “extra” directory. I appended all my virtualhosts in one file. It works!

(4) “NameVirtualHosts *” and a separate virtual host for localhost is must.

(5) Mac OS X has a built in PHP. I just created the default php configuration file at /etc/php.ini

(6) I downloaded MySQL from their website. Installed the packages and imported my existing databases.

(7) PHP by default expects the mysql unix socket to be in /var/mysql/mysql.sock but the package from mysql creates the socket at /tmp/mysql.sock. So I had to edit the socket for mysql, pdo-mysql and mysqli. I needed to change them all because WP uses mysql, phpmyadmin uses mysqli and ZF uses pdo.

(8) I ran the pear installer (as a phar file inside /usr/lib/php) to install pear and pecl.

(9) To install mcrypt extension, I downloaded libmcrypt and source of PHP 5.3.10. I changed directory to PHP’s mcrypt extension directory. Ran “phpize”, “make” and “sudo make install”. Copied the generated extension to my custom extensions directory.

(10) Restarted apache at every step. It’s now working fine 🙂

PHP

Running PHPUnit on Git hook

Post author By masnun
Post date March 18, 2012
7 Comments on Running PHPUnit on Git hook

I use Git and I love Git! I knew about Git hooks but never used in real life. So today I decided to get my hands dirty with Git hooks. I had a feeling it’d be awesome if I could use the “pre-commit” hook to do some routine processing before the changes are committed. I had two things in mind: 1) Unit Testing with PHPUnit or 2) Generating documentation using DocBlox. I chose Unit testing favouring simplicity.

Summary: I have a git repo for my PHP project. I have written some unit tests for the project and I want to run an automated unit test before changes are committed. If the unit tests succeed, the changes will be committed, if one of the tests fails, the commit will not proceed. This will ensure that I am always committing *working* codes to my Git repo.

Understanding Git Hooks
Git hooks are nothing but executable scripts which are run by Git on special events. If the hook script returns an exit code of 0, Git continues with whatever it was doing. For any non zero exit code, Git halts the operation. It’s that simple!

Git hooks are stored in the “.git/hooks” directory of a git repo. There are some samples already generated for us to check out! The script should be named with the hook, that is for the “pre-commit” hook the file name should also be “pre-commit”.

My Lame Unit Test
To begin with, we need at least one test case. So I wrote this really lame unit test and saved it as “Mytest.php”

<?php
class Mytest extends PHPUnit_Framework_TestCase 
{
	public function testSayHello() 
	{
		$this->assertEquals("hello","hello"); //lame :D
	}
}

<?php

class Mytest extends PHPUnit_Framework_TestCase

{

public function testSayHello()

{

$this->assertEquals("hello","hello"); //lame :D

}

Try running the script with PHPUnit like this:

phpunit Mytest.php

1	phpunit Mytest.php

Output:

PHPUnit 3.6.10 by Sebastian Bergmann.

.

Time: 0 seconds, Memory: 4.50Mb

PHPUnit 3.6.10 by Sebastian Bergmann.

Time: 0 seconds, Memory: 4.50Mb

Okay, so we have a valid unit test that passes. Now let’s add a Git pre-commit hook to run this unit test before commit is made.

Setting Up Git Hook
Assuming that your project is already under Git DVCS, navigate to .git/hooks and create a file named “pre-commit” with the following contents:

#!/usr/bin/php
<?php
// Hook configuration
$project = 'My Test';
$testSuiteFile = '/home/masnun/test/Mytest.php';

// Tell the commiter what the hook is doing
echo PHP_EOL;
echo '+ Starting unit tests'.PHP_EOL;

// Execute project unit tests
exec('phpunit '.$testSuiteFile, $output, $returnCode);

// if the build failed, output a summary and fail
if ($returnCode !== 0)
{
    // find the line with the summary; this might not be the last
    while (($minimalTestSummary = array_pop($output)) !== null)
    {
        if (strpos($minimalTestSummary, 'Tests:') !== false)
        {
            break;
        }
    }

    // output the status and abort the commit
    echo '+ Test suite for '.$project.' failed:'.PHP_EOL;
    echo $minimalTestSummary;
    echo chr(27).'[0m'.PHP_EOL; // disable colors and add a line break
    echo PHP_EOL;
    exit(1);
}

echo '+ All tests for '.$project.' passed.'.PHP_EOL;
echo PHP_EOL;
exit(0);

#!/usr/bin/php

<?php

// Hook configuration

$project = 'My Test';

$testSuiteFile = '/home/masnun/test/Mytest.php';

// Tell the commiter what the hook is doing

echo PHP_EOL;

echo '+ Starting unit tests'.PHP_EOL;

// Execute project unit tests

exec('phpunit '.$testSuiteFile, $output, $returnCode);

// if the build failed, output a summary and fail

if ($returnCode !== 0)

{

// find the line with the summary; this might not be the last

while (($minimalTestSummary = array_pop($output)) !== null)

{

if (strpos($minimalTestSummary, 'Tests:') !== false)

{

break;

}

// output the status and abort the commit

echo '+ Test suite for '.$project.' failed:'.PHP_EOL;

echo $minimalTestSummary;

echo chr(27).'[0m'.PHP_EOL; // disable colors and add a line break

echo PHP_EOL;

exit(1);

}

echo '+ All tests for '.$project.' passed.'.PHP_EOL;

echo PHP_EOL;

exit(0);

PS: The pre-commit script is a modified version of this nice Gist: https://gist.github.com/975252

Make the “pre-commit” file executable by issuing this command:

chmod a+x pre-commit

1	chmod a+x pre-commit

NB: This is important that you make the script executable otherwise it will not function as a hook.

Making a Commit
We shall create some file or make some changes and try to commit. In my case, I just added the “Mytest.php” file and tried to commit. Here’s the output:

masnun@ubuntu:~/test$ git commit -am "added changes"

+ Starting unit tests
+ All tests for My Test passed.

[master 3c473de] added changes
 1 files changed, 1 insertions(+), 1 deletions(-)
masnun@ubuntu:~/test$

masnun@ubuntu:~/test$ git commit -am "added changes"

+ Starting unit tests

+ All tests for My Test passed.

[master 3c473de] added changes

1 files changed, 1 insertions(+), 1 deletions(-)

masnun@ubuntu:~/test$

Aha! All tests passed and the commit was made. Now let’s force the unit test to fail. Change the unit test to look like this:

<?php
class Mytest extends PHPUnit_Framework_TestCase 
{
	public function testSayHello() 
	{
		$this->assertEquals("hellox","hello"); //let's fail - hellox is never equal to hello 
	}
}

<?php

class Mytest extends PHPUnit_Framework_TestCase

{

public function testSayHello()

{

$this->assertEquals("hellox","hello"); //let's fail - hellox is never equal to hello

}

And let’s commit now:

masnun@ubuntu:~/test$ git commit -am "this commit should fail"

+ Starting unit tests
+ Test suite for My Test failed:
Tests: 1, Assertions: 1, Failures: 1.
masnun@ubuntu:~/test$

masnun@ubuntu:~/test$ git commit -am "this commit should fail"

+ Starting unit tests

+ Test suite for My Test failed:

Tests: 1, Assertions: 1, Failures: 1.

masnun@ubuntu:~/test$

Compare the output with previous output. There is nothing similar to:

[master 3c473de] added changes
 1 files changed, 1 insertions(+), 1 deletions(-)

1 2	[master 3c473de] added changes 1 files changed, 1 insertions(+), 1 deletions(-)

The commit was not made because the test failed. So, it worked! 😀

I am really loving what it is going to offer me! I shall be writing tests for most of my projects so I never unintentionally break something in a commit. Unit testing is just one type of validation, I believe we could use lots of others (eg. PHP Code Sniffer) 🙂

Linux PHP

Installing PHPUnit on Ubuntu

Post author By masnun
Post date March 18, 2012
1 Comment on Installing PHPUnit on Ubuntu

Summary: I am on Ubuntu 11.10 and have the necessity to install PHPUnit. From my past experience, I know that installing via repository installs old version + fails to run. So I decided to install it via PEAR. Here’s a walk through!

Upgrade PEAR
Damn! The shipped version of pear via the “php-pear” package is outdated. The first thing we need to do is upgrade our PEAR setup. We have to ask pear to upgrade itself!

sudo pear upgrade PEAR

1	sudo pear upgrade PEAR

That should upgrade our pear to the latest version available!

Setup PHPUnit
To install PHPUnit, we have to set auto discovery turned on and discover the PHPUnit PEAR channel. Then we force install PHPUnit with all dependencies. That’s simple!

sudo pear config-set auto_discover 1
sudo pear install --force --alldeps pear.phpunit.de/PHPUnit

1 2	sudo pear config-set auto_discover 1 sudo pear install --force --alldeps pear.phpunit.de/PHPUnit

If everything goes okay, we have a working setup of PHPUnit by now! Type “phpunit –version” on console and check out the output! Ooops! It didn’t work! We’re getting an error message regarding “require_once()”. The issue is obvious, the PEAR directory which contains all PEAR packages haven’t been added to the php include_path.

Fix it this way:

sudo vim /etc/php5/conf.d/phpunit.ini

1	sudo vim /etc/php5/conf.d/phpunit.ini

Vim editor window will open with the empty buffer. If you’re not comfortable with vim, just use another text editor. Type in the following directives:

;include path to phpunit
[PEAR]
include_path=${include_path} ":/usr/share/php/"

;include path to phpunit

[PEAR]

include_path=${include_path} ":/usr/share/php/"

Save and quit. We had to do this manually because pear doesn’t automatically set the include_path to the pear location (which is “/usr/share/php/”).

Now try on terminal:

phpunit --version

1	phpunit --version

The output should look like:

masnun@ubuntu:~$ phpunit --version
PHPUnit 3.6.10 by Sebastian Bergmann.

1 2	masnun@ubuntu:~$ phpunit --version PHPUnit 3.6.10 by Sebastian Bergmann.

Happy Unit testing!

Recent Posts

Recent Comments

Archives

Categories