develOOp another fine develOOpment

Disclaimer: I’ve had several people contacting me that they didn’t get this thing to work. I guess i still left out some crucial installation/configuration parts. Use with care!

This step by step tutorial explains HOWTO run functional tests in Drupal core. We will do this both from within drupal and from within eclipse.
My machine is running Ubuntu 7.10 and uses the standard Lamp stack which comes with it. PHP 5, Mysql 5, Apache2.

I’m supposing that you already know howto install eclipse 3.3 PDT because the following steps are based on that. _Basically: Just download the all_in_one PDT package, and unpack it into some ~/software/ folder_

1. Get the files
We will use eclipse to checkout drupal core from CVS.
You can also watch this screencast to see how it’s done. [Poor sound quality, sorry for that]

• Switch to the CVS perspective by choosing
  
  • Windows>Open Perspective>Other
    
• Select “CVS repository perspective”
  
• Add a new CVS repository location for drupal core
  
• Right click in the view on your left, and select New > Repository location
  
• Use the following settings and press “Finish”
  
  • Host : cvs.drupal.org
    
  • R. Path : /cvs/drupal
    
  • User : anonymous
    
  • Passwd : anonymous
    
• Conn. Type : pserver
  
• Check-out Drupal HEAD version
  
  • Expand :pserver:anonymous@cvs.drupal.org:/cvs/drupal
    
  • Expand HEAD
    
  • Right click on drupal
    
  • Checkout as project
    
    • select “Check out as project in the workspace”
      
    • call it drupaltesting
      
  • Finish
    

• it will be saved into a folder <workspace-location>/drupaltesting

2. prepare your server

1. CURL is needed for the doing the actual requests on the drupal webpages
   
   • install curl
     
   • sudo apt-get install curl
     
   • install curl extension for php
     
• sudo apt-get install php5-curl
  
2. serve from http://drupaltesting
   
   • in a later stage we are expecting that drupal is not hosted in a subdirectoy of some webroot
     
   • link to drupal in /var/www
     
   • sudo ln -s <workspace-location>/drupaltesting /var/www/drupaltesting
     
   • edit VHOSTs
     
   • sudo gedit /etc/apache2/sites-enabled/000-default
     

• append the following code at the end of the file




<VirtualHost *>
        ServerName drupaltesting
        DocumentRoot /var/www/drupaltesting
        <Directory />
                Options FollowSymLinks
                AllowOverride All
        </Directory>
        <Directory /var/www/drupaltesting>
                Options Indexes FollowSymLinks MultiViews
                AllowOverride All
                Order allow,deny
                allow from all
        </Directory>
</VirtualHost>

• sudo gedit /etc/hosts
  
• replace the line
  
  • 127.0.0.1 localhost
    
  • by
    

• 127.0.0.1 localhost drupaltesting
  

• restart apache
  

• sudo /etc/init.d/apache2 restart
  

• 3. install drupal from http://drupaltesting as you would normally do

3. Run tests from within drupal

• enable the simpletest module in http://drupaltesting/admin/build/modules
• To get an overview of all the tests available

• go to http://drupaltesting/admin/build/simpletest
  
• Select the aggregator test and press ‘Run selected tests’
  
• this can take a while so don’t try to run ALL TEST at this moment because you will be waiting for at least 15 minutes.
  

• Hopefully you’ll be presented a list of a few hundred tests which are all green

4. Run tests from within eclipse
I’m not 100% sure if all following steps are necessary but i had already spend considerable time getting the stuff working, so i preferred writing this doc iso refining the steps.

• Install php commandline
  
• sudo apt-get install php5-cli
  
• Install the plugin
  
• Download version 0.2.3 from Sourceforge
  
• Unpack that zip, which contains a local update site containing only version 0.2.3
  
• Install it by adding a new local update site which points to the location where you just unpacked the zip.
  
• The update site http://simpletest.org/eclipse/ only provides version 0.2.1. Don’t use that version as it is outdated.
  
• Configure the plugin
  
• Windows>preferences>simpletest
  
  • php.exe file : /usr/bin/php
    
  • php.ini file : /ets/php5/conf.d/mysql.ini
    
  • simpletest path : /var/www/drupaltesting/modules/simpletest/simpletest
    
  • Include path : /var/www/drupaltesting/test/test.inc
    
• Suffix : *.test
  
• Configure the default php server
  
  • Windows > Preferences > PHP > PHP Server > New
    
    • Name : drupaltesting
      
  • URL : http://drupaltesting
    
  • Press Finish
    
• Select that server and make it “Default”
  
• Hacking the plugin
  
• Our simpletests NEED drupal, that is why Douglas gave me small php script to include in the tests to be able to run them correctly from within the plugin. Download that file here and save it as /var/www/drupaltesting/test/test.inc.
  
• By default the plugin can only be activated when right-clicking on *.php files, we would like it to also work from drupal’s *.test files.
  
  • To solve that you need to download the adapted plugin.xml into your eclipse/plugins/net.sf.simpletest.eclipse_0.2.3/ folder, and thus overwriting the plugin.xml which is there.
    
  • Or you edit that plugin.xml yourself and search for extension=“php” attributes and replace them by extension=“test”. Also search for <test property=“org.eclipse.debug.ui.matchesPattern” value=”*.php”/> and replace that by <test property=“org.eclipse.debug.ui.matchesPattern” value=”*.test”/>
    
  • Restart eclipse
    
  • Right click on /drupaltesting/modules/aggregator/aggregator.test
    
• In the context menu Your should see Run As > Simpletest
  

• I have noticed that this hacking only works properly if you move that net.sf.. folder first to another location, start eclipse without that plugin, close eclipse, make the changes in the plugin.xml and place the folder back in it’s original location, restart eclipse.