googleanalytics.test in Google Analytics 7
Same filename and directory in other branches
Test file for Google Analytics module.
File
googleanalytics.testView source
<?php
/**
* @file
* Test file for Google Analytics module.
*/
class GoogleAnalyticsBasicTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Google Analytics basic tests',
'description' => 'Test basic functionality of Google Analytics module.',
'group' => 'Google Analytics',
);
}
function setUp() {
parent::setUp('googleanalytics');
$permissions = array(
'access administration pages',
'administer google analytics',
);
// User to set up google_analytics.
$this->admin_user = $this
->drupalCreateUser($permissions);
$this
->drupalLogin($this->admin_user);
}
function testGoogleAnalyticsConfiguration() {
// Check for setting page's presence.
$this
->drupalGet('admin/config/system/googleanalytics');
$this
->assertRaw(t('Web Property ID'), '[testGoogleAnalyticsConfiguration]: Settings page displayed.');
// Check for account code validation.
$edit['googleanalytics_account'] = $this
->randomName(2);
$this
->drupalPost('admin/config/system/googleanalytics', $edit, t('Save configuration'));
$this
->assertRaw(t('A valid Google Analytics Web Property ID is case sensitive and formatted like UA-xxxxxxx-yy.'), '[testGoogleAnalyticsConfiguration]: Invalid Web Property ID number validated.');
}
function testGoogleAnalyticsPageVisibility() {
$ua_code = 'UA-123456-1';
variable_set('googleanalytics_account', $ua_code);
// Show tracking on "every page except the listed pages".
variable_set('googleanalytics_visibility_pages', 0);
// Disable tracking one "admin*" pages only.
variable_set('googleanalytics_pages', "admin\nadmin/*");
// Enable tracking only for authenticated users only.
variable_set('googleanalytics_roles', array(
DRUPAL_AUTHENTICATED_RID => DRUPAL_AUTHENTICATED_RID,
));
// Check tracking code visibility.
$this
->drupalGet('');
$this
->assertRaw($ua_code, '[testGoogleAnalyticsPageVisibility]: Tracking code is displayed for authenticated users.');
// Test whether tracking code is not included on pages to omit.
$this
->drupalGet('admin');
$this
->assertNoRaw($ua_code, '[testGoogleAnalyticsPageVisibility]: Tracking code is not displayed on admin page.');
$this
->drupalGet('admin/config/system/googleanalytics');
// Checking for tracking code URI here, as $ua_code is displayed in the form.
$this
->assertNoRaw('google-analytics.com/ga.js', '[testGoogleAnalyticsPageVisibility]: Tracking code is not displayed on admin subpage.');
// Test whether tracking code display is properly flipped.
variable_set('googleanalytics_visibility_pages', 1);
$this
->drupalGet('admin');
$this
->assertRaw($ua_code, '[testGoogleAnalyticsPageVisibility]: Tracking code is displayed on admin page.');
$this
->drupalGet('admin/config/system/googleanalytics');
// Checking for tracking code URI here, as $ua_code is displayed in the form.
$this
->assertRaw('google-analytics.com/ga.js', '[testGoogleAnalyticsPageVisibility]: Tracking code is displayed on admin subpage.');
$this
->drupalGet('');
$this
->assertNoRaw($ua_code, '[testGoogleAnalyticsPageVisibility]: Tracking code is NOT displayed on front page.');
// Test whether tracking code is not display for anonymous.
$this
->drupalLogout();
$this
->drupalGet('');
$this
->assertNoRaw($ua_code, '[testGoogleAnalyticsPageVisibility]: Tracking code is NOT displayed for anonymous.');
// Switch back to every page except the listed pages.
variable_set('googleanalytics_visibility_pages', 0);
// Enable tracking code for all user roles.
variable_set('googleanalytics_roles', array());
// Test whether 403 forbidden tracking code is shown if user has no access.
$this
->drupalGet('admin');
$this
->assertRaw('/403.html', '[testGoogleAnalyticsPageVisibility]: 403 Forbidden tracking code shown if user has no access.');
// Test whether 404 not found tracking code is shown on non-existent pages.
$this
->drupalGet($this
->randomName(64));
$this
->assertRaw('/404.html', '[testGoogleAnalyticsPageVisibility]: 404 Not Found tracking code shown on non-existent page.');
// DNT Tests:
// Enable caching of pages for anonymous users.
variable_set('cache', 1);
// Test whether DNT headers will fail to disable embedding of tracking code.
$this
->drupalGet('', array(), array(
'DNT: 1',
));
$this
->assertRaw('_gaq.push(["_trackPageview"]);', '[testGoogleAnalyticsDNTVisibility]: DNT header send from client, but page caching is enabled and tracker cannot removed.');
// DNT works only with caching of pages for anonymous users disabled.
variable_set('cache', 0);
$this
->drupalGet('');
$this
->assertRaw('_gaq.push(["_trackPageview"]);', '[testGoogleAnalyticsDNTVisibility]: Tracking is enabled without DNT header.');
// Test whether DNT header is able to remove the tracking code.
$this
->drupalGet('', array(), array(
'DNT: 1',
));
$this
->assertNoRaw('_gaq.push(["_trackPageview"]);', '[testGoogleAnalyticsDNTVisibility]: DNT header received from client. Tracking has been disabled by browser.');
// Disable DNT feature and see if tracker is still embedded.
variable_set('googleanalytics_privacy_donottrack', 0);
$this
->drupalGet('', array(), array(
'DNT: 1',
));
$this
->assertRaw('_gaq.push(["_trackPageview"]);', '[testGoogleAnalyticsDNTVisibility]: DNT feature is disabled, DNT header from browser has been ignored.');
}
function testGoogleAnalyticsTrackingCode() {
$ua_code = 'UA-123456-2';
variable_set('googleanalytics_account', $ua_code);
// Show tracking code on every page except the listed pages.
variable_set('googleanalytics_visibility_pages', 0);
// Enable tracking code for all user roles.
variable_set('googleanalytics_roles', array());
/* Sample JS code as added to page:
<script type="text/javascript" src="/sites/all/modules/google_analytics/googleanalytics.js?w"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-123456-7']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
*/
// Test whether tracking code uses latest JS.
variable_set('googleanalytics_cache', 0);
$this
->drupalGet('');
$this
->assertRaw('google-analytics.com/ga.js', '[testGoogleAnalyticsTrackingCode]: Latest tracking code used.');
// Test whether the alternate doubleclick library is used
variable_set('googleanalytics_trackdoubleclick', 1);
$this
->drupalGet('');
$this
->assertRaw('stats.g.doubleclick.net/dc.js', '[testGoogleAnalyticsTrackingCode]: Doubleclick tracking code used.');
// Test whether anonymize visitors IP address feature has been enabled.
$this
->drupalGet('');
$this
->assertNoRaw('_gaq.push(["_gat._anonymizeIp"]);', '[testGoogleAnalyticsTrackingCode]: Anonymize visitors IP address not found on frontpage.');
// Enable anonymizing of IP addresses.
variable_set('googleanalytics_tracker_anonymizeip', 1);
$this
->drupalGet('');
$this
->assertRaw('_gaq.push(["_gat._anonymizeIp"]);', '[testGoogleAnalyticsTrackingCode]: Anonymize visitors IP address found on frontpage.');
// Test whether single domain tracking is active.
$this
->drupalGet('');
$this
->assertNoRaw('_gaq.push(["_setDomainName"', '[testGoogleAnalyticsTrackingCode]: Single domain tracking is active.');
// Enable "One domain with multiple subdomains".
variable_set('googleanalytics_domain_mode', 1);
$this
->drupalGet('');
// Test may run on localhost, an ipaddress or real domain name.
// TODO: Workaround to run tests successfully. This feature cannot tested reliable.
global $cookie_domain;
if (count(explode('.', $cookie_domain)) > 2 && !is_numeric(str_replace('.', '', $cookie_domain))) {
$this
->assertRaw('_gaq.push(["_setDomainName",', '[testGoogleAnalyticsTrackingCode]: One domain with multiple subdomains is active on real host.');
}
else {
// Special cases, Localhost and IP addresses don't show '_setDomainName'.
$this
->assertNoRaw('_gaq.push(["_setDomainName",', '[testGoogleAnalyticsTrackingCode]: One domain with multiple subdomains may be active on localhost (test result is not reliable).');
}
// Enable "Multiple top-level domains" tracking.
variable_set('googleanalytics_domain_mode', 2);
variable_set('googleanalytics_cross_domains', "www.example.com\nwww.example.net");
$this
->drupalGet('');
$this
->assertRaw('_gaq.push(["_setDomainName", "none"]);', '[testGoogleAnalyticsTrackingCode]: _setDomainName: "none" found. Cross domain tracking is active.');
$this
->assertRaw('_gaq.push(["_setAllowLinker", true]);', '[testGoogleAnalyticsTrackingCode]: _setAllowLinker: true found. Cross domain tracking is active.');
$this
->assertRaw('"trackCrossDomains":["www.example.com","www.example.net"]', '[testGoogleAnalyticsTrackingCode]: Cross domain tracking with www.example.com and www.example.net is active.');
// Test whether the BEFORE and AFTER code is added to the tracker.
variable_set('googleanalytics_codesnippet_before', '_setDetectFlash(false);');
variable_set('googleanalytics_codesnippet_after', '_gaq.push(["t2._setAccount", "UA-123456-3"]);_gaq.push(["t2._trackPageview"]);');
$this
->drupalGet('');
$this
->assertRaw('_setDetectFlash(false);', '[testGoogleAnalyticsTrackingCode]: Before codesnippet has been found with "Flash" detection disabled.');
$this
->assertRaw('t2._setAccount', '[testGoogleAnalyticsTrackingCode]: After codesnippet with "t2" tracker has been found.');
}
}
class GoogleAnalyticsCustomVariablesTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Google Analytics Custom Variables tests',
'description' => 'Test custom variables functionality of Google Analytics module.',
'group' => 'Google Analytics',
'dependencies' => array(
'token',
),
);
}
function setUp() {
parent::setUp('googleanalytics', 'token');
$permissions = array(
'access administration pages',
'administer google analytics',
);
// User to set up google_analytics.
$this->admin_user = $this
->drupalCreateUser($permissions);
}
function testGoogleAnalyticsCustomVariables() {
$ua_code = 'UA-123456-3';
variable_set('googleanalytics_account', $ua_code);
// Basic test if the feature works.
$custom_vars = array(
'slots' => array(
1 => array(
'slot' => 1,
'name' => 'Foo 1',
'value' => 'Bar 1',
'scope' => 3,
),
2 => array(
'slot' => 2,
'name' => 'Foo 2',
'value' => 'Bar 2',
'scope' => 2,
),
3 => array(
'slot' => 3,
'name' => 'Foo 3',
'value' => 'Bar 3',
'scope' => 3,
),
4 => array(
'slot' => 4,
'name' => 'Foo 4',
'value' => 'Bar 4',
'scope' => 2,
),
5 => array(
'slot' => 5,
'name' => 'Foo 5',
'value' => 'Bar 5',
'scope' => 1,
),
),
);
variable_set('googleanalytics_custom_var', $custom_vars);
$this
->drupalGet('');
foreach ($custom_vars['slots'] as $slot) {
$this
->assertRaw("_gaq.push(['_setCustomVar', " . $slot['slot'] . ", \"" . $slot['name'] . "\", \"" . $slot['value'] . "\", " . $slot['scope'] . "]);", '[testGoogleAnalyticsCustomVariables]: _setCustomVar ' . $slot['slot'] . ' is shown.');
}
// Test whether tokens are replaced in custom variable names.
$site_slogan = $this
->randomName(16);
variable_set('site_slogan', $site_slogan);
$custom_vars = array(
'slots' => array(
1 => array(
'slot' => 1,
'name' => 'Name: [site:slogan]',
'value' => 'Value: [site:slogan]',
'scope' => 3,
),
2 => array(
'slot' => 2,
'name' => '',
'value' => $this
->randomName(16),
'scope' => 1,
),
3 => array(
'slot' => 3,
'name' => $this
->randomName(16),
'value' => '',
'scope' => 2,
),
4 => array(
'slot' => 4,
'name' => '',
'value' => '',
'scope' => 3,
),
5 => array(
'slot' => 5,
'name' => '',
'value' => '',
'scope' => 3,
),
),
);
variable_set('googleanalytics_custom_var', $custom_vars);
$this
->verbose('<pre>' . print_r($custom_vars, TRUE) . '</pre>');
$this
->drupalGet('');
$this
->assertRaw("_gaq.push(['_setCustomVar', 1, \"Name: {$site_slogan}\", \"Value: {$site_slogan}\", 3]", '[testGoogleAnalyticsCustomVariables]: Tokens have been replaced in custom variable.');
$this
->assertNoRaw("_gaq.push(['_setCustomVar', 2,", '[testGoogleAnalyticsCustomVariables]: Value with empty name is not shown.');
$this
->assertNoRaw("_gaq.push(['_setCustomVar', 3,", '[testGoogleAnalyticsCustomVariables]: Name with empty value is not shown.');
$this
->assertNoRaw("_gaq.push(['_setCustomVar', 4,", '[testGoogleAnalyticsCustomVariables]: Empty name and value is not shown.');
$this
->assertNoRaw("_gaq.push(['_setCustomVar', 5,", '[testGoogleAnalyticsCustomVariables]: Empty name and value is not shown.');
}
}
class GoogleAnalyticsStatusMessagesTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Google Analytics status messages tests',
'description' => 'Test status messages functionality of Google Analytics module.',
'group' => 'Google Analytics',
);
}
function setUp() {
parent::setUp('googleanalytics');
$permissions = array(
'access administration pages',
'administer google analytics',
);
// User to set up google_analytics.
$this->admin_user = $this
->drupalCreateUser($permissions);
}
function testGoogleAnalyticsStatusMessages() {
$ua_code = 'UA-123456-4';
variable_set('googleanalytics_account', $ua_code);
// Enable logging of errors only.
variable_set('googleanalytics_trackmessages', array(
'error' => 'error',
));
$this
->drupalPost('user/login', array(), t('Log in'));
$this
->assertRaw('_gaq.push(["_trackEvent", "Messages", "Error message", "Username field is required."]);', '[testGoogleAnalyticsStatusMessages]: _trackEvent "Username field is required." is shown.');
$this
->assertRaw('_gaq.push(["_trackEvent", "Messages", "Error message", "Password field is required."]);', '[testGoogleAnalyticsStatusMessages]: _trackEvent "Password field is required." is shown.');
// @todo: investigate why drupal_set_message() fails.
//drupal_set_message('Example status message.', 'status');
//drupal_set_message('Example warning message.', 'warning');
//drupal_set_message('Example error message.', 'error');
//drupal_set_message('Example error <em>message</em> with html tags and <a href="http://example.com/">link</a>.', 'error');
//$this->drupalGet('');
//$this->assertNoRaw('_gaq.push(["_trackEvent", "Messages", "Status message", "Example status message."]);', '[testGoogleAnalyticsStatusMessages]: Example status message is not enabled for tracking.');
//$this->assertNoRaw('_gaq.push(["_trackEvent", "Messages", "Warning message", "Example warning message."]);', '[testGoogleAnalyticsStatusMessages]: Example warning message is not enabled for tracking.');
//$this->assertRaw('_gaq.push(["_trackEvent", "Messages", "Error message", "Example error message."]);', '[testGoogleAnalyticsStatusMessages]: Example error message is shown.');
//$this->assertRaw('_gaq.push(["_trackEvent", "Messages", "Error message", "Example error message with html tags and link."]);', '[testGoogleAnalyticsStatusMessages]: HTML has been stripped successful from Example error message with html tags and link.');
}
}
class GoogleAnalyticsRolesTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Google Analytics role tests',
'description' => 'Test roles functionality of Google Analytics module.',
'group' => 'Google Analytics',
);
}
function setUp() {
parent::setUp('googleanalytics');
$permissions = array(
'access administration pages',
'administer google analytics',
);
// User to set up google_analytics.
$this->admin_user = $this
->drupalCreateUser($permissions);
}
function testGoogleAnalyticsRolesTracking() {
$ua_code = 'UA-123456-4';
variable_set('googleanalytics_account', $ua_code);
// Test if the default settings are working as expected.
// Add to the selected roles only.
variable_set('googleanalytics_visibility_roles', 0);
// Enable tracking for all users.
variable_set('googleanalytics_roles', array());
// Check tracking code visibility.
$this
->drupalGet('');
$this
->assertRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is displayed for anonymous users on frontpage with default settings.');
$this
->drupalGet('admin');
$this
->assertRaw('/403.html', '[testGoogleAnalyticsRoleVisibility]: 403 Forbidden tracking code is displayed for anonymous users in admin section with default settings.');
$this
->drupalLogin($this->admin_user);
$this
->drupalGet('');
$this
->assertRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is displayed for authenticated users on frontpage with default settings.');
$this
->drupalGet('admin');
$this
->assertNoRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is NOT displayed for authenticated users in admin section with default settings.');
// Test if the non-default settings are working as expected.
// Enable tracking only for authenticated users.
variable_set('googleanalytics_roles', array(
DRUPAL_AUTHENTICATED_RID => DRUPAL_AUTHENTICATED_RID,
));
$this
->drupalGet('');
$this
->assertRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is displayed for authenticated users only on frontpage.');
$this
->drupalLogout();
$this
->drupalGet('');
$this
->assertNoRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is NOT displayed for anonymous users on frontpage.');
// Add to every role except the selected ones.
variable_set('googleanalytics_visibility_roles', 1);
// Enable tracking for all users.
variable_set('googleanalytics_roles', array());
// Check tracking code visibility.
$this
->drupalGet('');
$this
->assertRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is added to every role and displayed for anonymous users.');
$this
->drupalGet('admin');
$this
->assertRaw('/403.html', '[testGoogleAnalyticsRoleVisibility]: 403 Forbidden tracking code is shown for anonymous users if every role except the selected ones is selected.');
$this
->drupalLogin($this->admin_user);
$this
->drupalGet('');
$this
->assertRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is added to every role and displayed on frontpage for authenticated users.');
$this
->drupalGet('admin');
$this
->assertNoRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is added to every role and NOT displayed in admin section for authenticated users.');
// Disable tracking for authenticated users.
variable_set('googleanalytics_roles', array(
DRUPAL_AUTHENTICATED_RID => DRUPAL_AUTHENTICATED_RID,
));
$this
->drupalGet('');
$this
->assertNoRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is NOT displayed on frontpage for excluded authenticated users.');
$this
->drupalGet('admin');
$this
->assertNoRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is NOT displayed in admin section for excluded authenticated users.');
$this
->drupalLogout();
$this
->drupalGet('');
$this
->assertRaw($ua_code, '[testGoogleAnalyticsRoleVisibility]: Tracking code is displayed on frontpage for included anonymous users.');
}
}
class GoogleAnalyticsPhpFilterTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Google Analytics PhpFilter tests',
'description' => 'Test PhpFilter functionality of Google Analytics module.',
'group' => 'Google Analytics',
);
}
function setUp() {
parent::setUp('googleanalytics', 'php');
// Administrator with all permissions.
$permissions_admin_user = array(
'access administration pages',
'administer google analytics',
'use PHP for tracking visibility',
);
$this->admin_user = $this
->drupalCreateUser($permissions_admin_user);
// Administrator who cannot configure tracking visibility with PHP.
$permissions_delegated_admin_user = array(
'access administration pages',
'administer google analytics',
);
$this->delegated_admin_user = $this
->drupalCreateUser($permissions_delegated_admin_user);
}
function testGoogleAnalyticsPhpFilter() {
$ua_code = 'UA-123456-1';
$this
->drupalLogin($this->admin_user);
$edit = array();
$edit['googleanalytics_account'] = $ua_code;
$edit['googleanalytics_visibility_pages'] = 2;
$edit['googleanalytics_pages'] = '<?php return 0; ?>';
$this
->drupalPost('admin/config/system/googleanalytics', $edit, t('Save configuration'));
// Compare saved setting with posted setting.
$googleanalytics_pages = variable_get('googleanalytics_pages', $this
->randomName(8));
$this
->assertEqual('<?php return 0; ?>', $googleanalytics_pages, '[testGoogleAnalyticsPhpFilter]: PHP code snippet is intact.');
// Check tracking code visibility.
variable_set('googleanalytics_pages', '<?php return TRUE; ?>');
$this
->drupalGet('');
$this
->assertRaw('google-analytics.com/ga.js', '[testGoogleAnalyticsPhpFilter]: Tracking is displayed on frontpage page.');
$this
->drupalGet('admin');
$this
->assertRaw('google-analytics.com/ga.js', '[testGoogleAnalyticsPhpFilter]: Tracking is displayed on admin page.');
variable_set('googleanalytics_pages', '<?php return FALSE; ?>');
$this
->drupalGet('');
$this
->assertNoRaw('google-analytics.com/ga.js', '[testGoogleAnalyticsPhpFilter]: Tracking is not displayed on frontpage page.');
// Test administration form.
variable_set('googleanalytics_pages', '<?php return TRUE; ?>');
$this
->drupalGet('admin/config/system/googleanalytics');
$this
->assertRaw(t('Pages on which this PHP code returns <code>TRUE</code> (experts only)'), '[testGoogleAnalyticsPhpFilter]: Permission to administer PHP for tracking visibility.');
$this
->assertRaw(check_plain('<?php return TRUE; ?>'), '[testGoogleAnalyticsPhpFilter]: PHP code snippted is displayed.');
// Login the delegated user and check if fields are visible.
$this
->drupalLogin($this->delegated_admin_user);
$this
->drupalGet('admin/config/system/googleanalytics');
$this
->assertNoRaw(t('Pages on which this PHP code returns <code>TRUE</code> (experts only)'), '[testGoogleAnalyticsPhpFilter]: No permission to administer PHP for tracking visibility.');
$this
->assertNoRaw(check_plain('<?php return TRUE; ?>'), '[testGoogleAnalyticsPhpFilter]: No permission to view PHP code snippted.');
// Set a different value and verify that this is still the same after the post.
variable_set('googleanalytics_pages', '<?php return 0; ?>');
$edit = array();
$edit['googleanalytics_account'] = $ua_code;
$this
->drupalPost('admin/config/system/googleanalytics', $edit, t('Save configuration'));
// Compare saved setting with posted setting.
$googleanalytics_visibility_pages = variable_get('googleanalytics_visibility_pages', 0);
$googleanalytics_pages = variable_get('googleanalytics_pages', $this
->randomName(8));
$this
->assertEqual(2, $googleanalytics_visibility_pages, '[testGoogleAnalyticsPhpFilter]: Pages on which this PHP code returns TRUE is selected.');
$this
->assertEqual('<?php return 0; ?>', $googleanalytics_pages, '[testGoogleAnalyticsPhpFilter]: PHP code snippet is intact.');
}
}Classes
Name |
Description |
|---|---|
| GoogleAnalyticsBasicTest | @file Test file for Google Analytics module. |
| GoogleAnalyticsCustomVariablesTest | |
| GoogleAnalyticsPhpFilterTest | |
| GoogleAnalyticsRolesTest | |
| GoogleAnalyticsStatusMessagesTest |