Drupal 8: Debug Kernel, Functional and Unit Tests in PhpStorm by Xdebug

Submitted by Peter Majmesku on Sun, 04/16/2017 - 20:21

The following article is valid for unix based systems like Ubuntu Linux. It teaches you, how to setup your PhpStorm IDE to debug your unit tests via the Xdebug PHP extension in Drupal 8.

  1. Make sure you have read the article at https://www.drupal.org/docs/8/phpunit/running-phpunit-tests to understand how to run automated tests in Drupal 8.
  2. Make sure you have read the article at https://www.jetbrains.com/help/phpstorm/2017.1/configuring-xdebug.html to understand how to setup the Xdebug PHP extension on your system and configure it within PhpStorm.

phpunit.xml Configuration File

For the PhpStorm config you need to make sure to have the phpunit.xml file created by copying the ~/PhpstormProjects/drupal-8.x/core/phpunit.xml.dist into the same directory. Afterwards you must set the environment variables for 

  • SIMPLETEST_BASE_URL
  • SIMPLETEST_DB
  • BROWSERTEST_OUTPUT_DIRECTORY
    • Example value: ~/PhpstormProjects/drupal-8.4.x-dev/sites/simpletest/browser_output
  • PHP_IDE_CONFIG
    • Example value: serverName=d8-4x.dev
    • Be careful in this line! Here you set a key-value pair in the value field. Do not use any quotes here. The full line entry in my config is: <env name="PHP_IDE_CONFIG" value="serverName=d8-4x.dev"/>
  • XDEBUG_CONFIG
    • Example value: idekey=PHPSTORM
    • Again: a key-value pair as value.

in your newly created phpunit.xml file.

PHPUnit Config in Your PhpStorm Project

Make sure you have configured:

  • path to the autoloader script from composer. It is located in ~/PhpstormProjects/drupal-8.4/vendor/autoload.php
  • path to your phpunit.xml file

The config window must look according to the following screenshot (be careful about the paths on your system):

 

PHPUnit config

Define the Server Setting and Map the Tests Directory

Set exactly the same value, which you have previously set in your phpunit.xml file inside the PHP_IDE_CONFIG environment variable for your server. You must also map the directory where your tests are. Do your settings according to the screenshot below.

Server setting directory mapping.

Path to CLI PHP Interpreter

Set the path to the PHP interpreter which is running your command line based scripts. It is usually located at /usr/bin/php. The config must look like in the following screenshots.

php interpreter
php cli

Run a Test File

For being able to execute your test quickly, open the PHP file with your test and hit the debug icon.

Run the test

Step Into Your PHP Code

Chances are, that PhpStorm will output a error message like

Remote file path '/home/your-user/PhpstormProjects/drupal-8.4.x-dev/-' is not mapped to any file path in project.

You can ignore this error and just click the "resum program" button. PhpStorm will reveal the PHP interpreter on your breakpoint quickly. If you know, how the reason for this message can be solved - please put me a hint in the comments. However you could create a file with the name "-" and map to this file in the path settings, but this is not a real fix.

Path settings
Happy debugging

Re-initialize HTML selector after DOM was changed via AJAX

Submitted by Peter Majmesku on Tue, 03/14/2017 - 10:07

Once I was searching for a method to trigger my HTML markup, after I have changed it via an AJAX request. I could not find any non-irritating solution. So I have implemented a "common" cheap solution for this, which was documented at many places in the web (like Stackoverflow threads with many votes on a post). In the old approach, I have loaded JavaScript, which was placed within the fetched HTML markup. This resulted in an ugly structure. Because my HTML and JavaScript was mixed and not entirely separated in files.

Here is an example code with the better solution, which works by separated files:

var initFilterInput = function(el) {
    
el.find('form input').click(function(event) {
        
el.load('/reduced-filters', function() {
            
console.log"Load was performed." );

            
initFilterInput(el);
        });
    });
};

initFilterInput($('.filter-group')); 

In this example I initialize an event listener on a HTML element, which is located by the "filter-group" CSS class. This happens after the entire page load. After the click event is triggered, some HTML markup will be replaced in the current HTML DOM tree. Then this function will call itself by

initFilterInput(el);

and the event triggering still works on the new HTML markup.

Ubuntu: Install Elasticsearch as Docker Container and manage it nicely in GUI

Submitted by Peter Majmesku on Fri, 12/09/2016 - 14:16

Install Docker

Firstly install Docker via this article: https://docs.docker.com/engine/installation/linux/ubuntulinux/. Mind to setup the user and group permissions according to the article. So that you are able to start Docker as non-root user.

Check your user's group setting

Make sure that a group with the name "docker" exists and your user is a member of that group. To add a user to an existing group, execute the following command:

sudo usermod -a -G groupName userName

After your user (mine f.e. is "peter") is being successfully added into the "docker" group, logout and login to ensure that you are acting from the docker user group.

Install Kitematic

Dowload the Kitematic GUI for Docker Debian package via https://github.com/docker/kitematic/releases. This program will empower you, to manage your Docker containers easily via a graphical user interface. Mind that this application is currently beta. Then install it by

sudo dpkg -i dist/Kitematic_0.12.9_amd64.deb
Kitematic - GUI for Docker

Install Elasticsearch as Docker Container by Kitematic

Follow the following steps in Kitematic:

  1. Hit the "New"-Button
  2. Search for "elasticsearch" to see the official Elasticsearch Docker Container in the search result list
  3. Choose the version you want via the tag (version 1.7.2 is the version which works for me)
  4. Hit the button which is labeled with "Create". Kitematic will now install the Elasticsearch Docker container for you.
Kitematic Elasticsearch installation

GUI for Elasticsearch: Jettro

To be able to execute easily queries within Elasticsearch, check status etc., you can install Jettro (https://github.com/jettro/elasticsearch-gui). Just execute the following command inside your Elasticsearch Docker container to install the Elasticsearch plugin:

bin/plugin install jettro/elasticsearch-gui 

Jettro - GUI for Elasticsearch inside the webbrowser

Start the Docker Container automatically on system startup as a Daemon

An official tutorial about this can be found here: https://docs.docker.com/engine/admin/host_integration/. In particular, you can follow the steps below.

Create a file at 

/etc/systemd/system/docker-elasticsearch.service

with the following content:

[Unit]
Description=Elasticsearch container
Requires=docker.service
After=docker.service

[Service]
Restart=always
ExecStart=/usr/bin/docker start -a elasticsearch
ExecStop=/usr/bin/docker stop -t 2 elasticsearch

[Install]
WantedBy=default.target

Now reload the daemon:

sudo systemctl daemon-reload

Start the Elasticsearch Docker container as a service:

sudo systemctl start docker-elasticsearch.service

Enable the service at system startup:

sudo systemctl enable docker-elasticsearch.service

Voilà! Happy search index querying. (:

Disable IPv6 on Ubuntu Linux and Windows 10

Submitted by Peter Majmesku on Wed, 12/07/2016 - 19:57

I had this issue with "sudo apt update" or at trying to install something with composer in the WSL. The issue has been connected with IPv6. So I have disabled IPv6 and the requests where working much faster.

In Ubuntu (not Windows 10) disable IPv6 that way: Add the following lines at the bottom of /etc/sysctl.conf:

net.ipv6.conf.all.disable_ipv6 = 1
net.ipv6.conf.default.disable_ipv6 = 1
net.ipv6.conf.lo.disable_ipv6 = 1

Run sudo sysctl -p to reload the /etc/sysctl.conf settings.

To disable IPv6 only for apt-get:

sudoedit /etc/apt/apt.conf.d/99force-ipv4


Put the following contents in it:

Acquire::ForceIPv4 "true";


Save the file, and you're good to go. If you want to force IPv6 instead, change the 4 to 6 in the file name and settings. To choose between one of them, test with the fast method and see which works better.

In Windows 10 I could fix my issue for the Bash by the execution of a small program from Microsoft: https://support.microsoft.com/en-us/kb/929852

Tags

Linux: Mass rename files by number and timestamp + mass edit of the last-edit date

Submitted by Peter Majmesku on Sun, 12/04/2016 - 21:26

This can be useful for masses of images editing. I needed to change the filenames of my photos to bring them in order for the popular german online print image service PosterXXL. To have all my photos ordered by specific locations, they needed ascending numeric filenames. Here I have stumbled upon useful console commands.

Rename all files to a number plus the current timestamp

ls | cat -n | while read n f; do mv "$f" "file-$(date +%s)-$n.jpg"; done

Change the last edit date of all files in a folder - not the filenames, but in the meta-information of the files

find -print | while read filename; do     touch -d "2 hours ago" "$filename"; done

 

Mass image rename in Linux

Use multiple PHP versions on Ubuntu 16.10 with Apache 2 and in the CLI

Submitted by Peter Majmesku on Thu, 11/10/2016 - 16:55

I needed an easy ability to switch multiple PHP versions on my local development environment. This ability should include the command line interface and webserver components of PHP. Here I am sharing my findings with you. I guess that this functionality is not new on Ubuntu 16.10. Most probably you can use the features already on Ubuntu 16.04 (LTS version) also.

You can use multiple PHP versions with one Apache server. Easily install them via the Apt package manager by the famous PPA from Ondrej. Then you can install multiple PHP versions like so:

sudo apt install php7.1 php5.6 php7.0

For being able to switch the PHP versions within the Apache webserver, you need the Lib Apache packages. You can install them like so:

sudo apt install libapache2-mod-php7.0
sudo apt install libapache2-mod-php7.1
sudo apt install libapache2-mod-php5.6

Afterwards you are able to switch the PHP version, which is being executed by Apache. E.g.:

sudo a2dismod php7.0
sudo a2enmod php5.6
sudo service apache2 restart

To switch he PHP CLI version, you can use the "update-alternatives" command. This command let's choose you the various versions of your program. In the background it will create symlinks for you. For getting into the version chooser dialogue, execute the following command:

sudo update-alternatives --config php

To switch PHP extensions for a specific PHP version, you can use the "phpenmod" and "phpdismod" commands. For enabling the Xdebug PHP extension for PHP 7.0, use the following command:

sudo phpenmod -v 7.0 xdebug

Run Behat tests on Ubuntu 16.10

Submitted by Peter Majmesku on Wed, 10/19/2016 - 15:35

To make it work you need Selenium standalone in version 2.52 and Firefox in version 45. This combination does work. The others do not. Download Selenium standalone in version 2.52 from 

http://selenium-release.storage.googleapis.com/index.html?path=2.52/

Then modify your

/etc/apt/sources.list

to use the packages from Ubuntu 16.04 Xenial. This is described at http://packages.ubuntu.com/xenial/arm64/firefox/download. Afterwards update your package manager, check for the proper package version and install it:

sudo apt update

sudo apt-cache show firefox | grep Version

sudo apt-get install firefox=45.0.2+build1-0ubuntu1

Afterwards you are able to execute your Behat tests. F.e. by this command:

bin/behat --suite=my-test-suite

Install the Shutter screenshot program on Linux (Mint 18)

Submitted by Peter Majmesku on Mon, 10/17/2016 - 18:24

To install Shutter on Linux (Mint 18) with working screenshot editing extension, you must execute the following command. It will install the required packages via the Ubuntu package manager, which are needed for the screenshot editing extension.

sudo apt install shutter libgoo-canvas-perl gnome-web-photo

Then "restart" your computer. Afterwards Shutter looks like in the attached screenshot. Of course it will be in your operating system language. Mine is German.

Happy screen photographing! (:

Apache 2: Troubleshoot Vhost config for local development

Submitted by Peter Majmesku on Mon, 10/17/2016 - 09:46

General permissions

If you get this message in the webbrowser:

You don't have permission to access / on this server

and this one in the error.log file from Apache:

[Mon Oct 17 08:44:39.025804 2016] [core:error] [pid 8335:tid 139844481865472] (13)Permission denied: [client 127.0.0.1:44202] AH00035: access to / denied (filesystem path '/home/peter/Dev') because search permissions are missing on a component of the path

then you need to execute the following command on your user folder (for me: /home/peter):

chmod +x /home/YOUR-USERNAME

If Apache is displaying your PHP file's code in the webbrowser, then run this command (worked for PHP7 on Ubuntu 16.04):

sudo apt install php libapache2-mod-php

Cache folder permissions

I assume you have your webroot files in your userfolder at /home/USER. As the PHP process is writing cache files as the www-data user per default (on Ubuntu/Debian), you must configure user and group permissions. Add the www-data user into the user's group and your user into the www-data group. So that they can use their files. The example command is:

sudo usermod -a -G www-data YOUR-USERNAME

sudo usermod -a -G YOUR-USERS-GROUP www-data

Then make the www-data user (as which Apache is acting), act by your user's group. This setting can be made in the file at /etc/apache2/envvars. Modify the lines as follows:

export APACHE_RUN_USER=www-data
export APACHE_RUN_GROUP=YOUR-USERS-GROUP