3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * Tests for linking to resource files
32 class CRM_Core_ResourcesTest
extends CiviUnitTestCase
{
35 * @var CRM_Core_Resources
40 * @var CRM_Extension_Mapper
44 public function setUp() {
47 list ($this->basedir
, $this->container
, $this->mapper
) = $this->_createMapper();
48 $cache = new CRM_Utils_Cache_Arraycache(array());
49 $this->res
= new CRM_Core_Resources($this->mapper
, $cache, NULL);
50 $this->res
->setCacheCode('resTest');
51 CRM_Core_Resources
::singleton($this->res
);
53 // Templates injected into regions should normally be file names, but for unit-testing it's handy to use "string:" notation
54 require_once 'CRM/Core/Smarty/resources/String.php';
55 civicrm_smarty_register_string_resource();
58 public function testAddScriptFile() {
60 ->addScriptFile('com.example.ext', 'foo%20bar.js', 0, 'testAddScriptFile')
61 ->addScriptFile('com.example.ext', 'foo%20bar.js', 0, 'testAddScriptFile')// extra
62 ->addScriptFile('civicrm', 'foo%20bar.js', 0, 'testAddScriptFile');
64 $smarty = CRM_Core_Smarty
::singleton();
65 $actual = $smarty->fetch('string:{crmRegion name=testAddScriptFile}{/crmRegion}');
66 $expected = "" // stable ordering: alphabetical by (snippet.weight,snippet.name)
67 . "<script type=\"text/javascript\" src=\"http://core-app/foo%20bar.js?r=resTest\">\n</script>\n"
68 . "<script type=\"text/javascript\" src=\"http://ext-dir/com.example.ext/foo%20bar.js?r=resTest\">\n</script>\n";
69 $this->assertEquals($expected, $actual);
73 * When adding a script file, any ts() expressions should be translated and added to the 'strings'
75 * FIXME: This can't work because the tests run in English and CRM_Core_Resources optimizes
76 * away the English data from $settings['strings']
77 * public function testAddScriptFile_strings() {
78 * file_put_contents($this->mapper->keyToBasePath('com.example.ext') . '/hello.js', 'alert(ts("Hello world"));');
79 * $this->res->addScriptFile('com.example.ext', 'hello.js', 0, 'testAddScriptFile_strings');
80 * $settings = $this->res->getSettings();
81 * $expected = array('Hello world');
82 * $this->assertEquals($expected, $settings['strings']);
87 * Ensure that adding a script URL creates expected markup.
89 public function testAddScriptURL() {
91 ->addScriptUrl('/whiz/foo%20bar.js', 0, 'testAddScriptURL')
92 ->addScriptUrl('/whiz/foo%20bar.js', 0, 'testAddScriptURL')// extra
93 ->addScriptUrl('/whizbang/foo%20bar.js', 0, 'testAddScriptURL');
95 $smarty = CRM_Core_Smarty
::singleton();
96 $actual = $smarty->fetch('string:{crmRegion name=testAddScriptURL}{/crmRegion}');
97 $expected = "" // stable ordering: alphabetical by (snippet.weight,snippet.name)
98 . "<script type=\"text/javascript\" src=\"/whiz/foo%20bar.js\">\n</script>\n"
99 . "<script type=\"text/javascript\" src=\"/whizbang/foo%20bar.js\">\n</script>\n";
100 $this->assertEquals($expected, $actual);
103 public function testAddScript() {
105 ->addScript('alert("hi");', 0, 'testAddScript')
106 ->addScript('alert("there");', 0, 'testAddScript');
108 $smarty = CRM_Core_Smarty
::singleton();
109 $actual = $smarty->fetch('string:{crmRegion name=testAddScript}{/crmRegion}');
111 . "<script type=\"text/javascript\">\nalert(\"hi\");\n</script>\n"
112 . "<script type=\"text/javascript\">\nalert(\"there\");\n</script>\n";
113 $this->assertEquals($expected, $actual);
116 public function testAddVars() {
118 ->addVars('food', array('fruit' => array('mine' => 'apple', 'ours' => 'banana')))
119 ->addVars('food', array('fruit' => array('mine' => 'new apple', 'yours' => 'orange')));
120 $this->assertTreeEquals(
126 'mine' => 'new apple',
132 $this->res
->getSettings()
136 public function testAddSetting() {
138 ->addSetting(array('fruit' => array('mine' => 'apple')))
139 ->addSetting(array('fruit' => array('yours' => 'orange')));
140 $this->assertTreeEquals(
141 array('fruit' => array('yours' => 'orange', 'mine' => 'apple')),
142 $this->res
->getSettings()
144 $actual = $this->res
->renderSetting();
145 $expected = json_encode(array('fruit' => array('yours' => 'orange', 'mine' => 'apple')));
146 $this->assertTrue(strpos($actual, $expected) !== FALSE);
149 public function testAddSettingFactory() {
150 $this->res
->addSettingsFactory(function () {
151 return array('fruit' => array('yours' => 'orange'));
153 $this->res
->addSettingsFactory(function () {
154 return array('fruit' => array('mine' => 'apple'));
157 $actual = $this->res
->getSettings();
158 $expected = array('fruit' => array('yours' => 'orange', 'mine' => 'apple'));
159 $this->assertTreeEquals($expected, $actual);
162 public function testAddSettingAndSettingFactory() {
163 $this->res
->addSetting(array('fruit' => array('mine' => 'apple')));
165 $muckableValue = array('fruit' => array('yours' => 'orange', 'theirs' => 'apricot'));
166 $this->res
->addSettingsFactory(function () use (&$muckableValue) {
167 return $muckableValue;
169 $actual = $this->res
->getSettings();
170 $expected = array('fruit' => array('mine' => 'apple', 'yours' => 'orange', 'theirs' => 'apricot'));
171 $this->assertTreeEquals($expected, $actual);
173 // note: the setting is not fixed based on what the factory returns when registered; it's based
174 // on what the factory returns when getSettings is called
175 $muckableValue = array('fruit' => array('yours' => 'banana'));
176 $actual = $this->res
->getSettings();
177 $expected = array('fruit' => array('mine' => 'apple', 'yours' => 'banana'));
178 $this->assertTreeEquals($expected, $actual);
181 public function testCrmJS() {
182 $smarty = CRM_Core_Smarty
::singleton();
184 $actual = $smarty->fetch('string:{crmScript ext=com.example.ext file=foo%20bar.js region=testCrmJS}');
185 $this->assertEquals('', $actual);
187 $actual = $smarty->fetch('string:{crmScript url=/whiz/foo%20bar.js region=testCrmJS weight=1}');
188 $this->assertEquals('', $actual);
190 $actual = $smarty->fetch('string:{crmRegion name=testCrmJS}{/crmRegion}');
191 $expected = "" // stable ordering: alphabetical by (snippet.weight,snippet.name)
192 . "<script type=\"text/javascript\" src=\"http://ext-dir/com.example.ext/foo%20bar.js?r=resTest\">\n</script>\n"
193 . "<script type=\"text/javascript\" src=\"/whiz/foo%20bar.js\">\n</script>\n";
194 $this->assertEquals($expected, $actual);
197 public function testAddStyleFile() {
199 ->addStyleFile('com.example.ext', 'foo%20bar.css', 0, 'testAddStyleFile')
200 ->addStyleFile('com.example.ext', 'foo%20bar.css', 0, 'testAddStyleFile')// extra
201 ->addStyleFile('civicrm', 'foo%20bar.css', 0, 'testAddStyleFile');
203 $smarty = CRM_Core_Smarty
::singleton();
204 $actual = $smarty->fetch('string:{crmRegion name=testAddStyleFile}{/crmRegion}');
205 $expected = "" // stable ordering: alphabetical by (snippet.weight,snippet.name)
206 . "<link href=\"http://core-app/foo%20bar.css?r=resTest\" rel=\"stylesheet\" type=\"text/css\"/>\n"
207 . "<link href=\"http://ext-dir/com.example.ext/foo%20bar.css?r=resTest\" rel=\"stylesheet\" type=\"text/css\"/>\n";
208 $this->assertEquals($expected, $actual);
211 public function testAddStyleURL() {
213 ->addStyleUrl('/whiz/foo%20bar.css', 0, 'testAddStyleURL')
214 ->addStyleUrl('/whiz/foo%20bar.css', 0, 'testAddStyleURL')// extra
215 ->addStyleUrl('/whizbang/foo%20bar.css', 0, 'testAddStyleURL');
217 $smarty = CRM_Core_Smarty
::singleton();
218 $actual = $smarty->fetch('string:{crmRegion name=testAddStyleURL}{/crmRegion}');
219 $expected = "" // stable ordering: alphabetical by (snippet.weight,snippet.name)
220 . "<link href=\"/whiz/foo%20bar.css\" rel=\"stylesheet\" type=\"text/css\"/>\n"
221 . "<link href=\"/whizbang/foo%20bar.css\" rel=\"stylesheet\" type=\"text/css\"/>\n";
222 $this->assertEquals($expected, $actual);
225 public function testAddStyle() {
227 ->addStyle('body { background: black; }', 0, 'testAddStyle')
228 ->addStyle('body { text-color: black; }', 0, 'testAddStyle');
230 $smarty = CRM_Core_Smarty
::singleton();
231 $actual = $smarty->fetch('string:{crmRegion name=testAddStyle}{/crmRegion}');
233 . "<style type=\"text/css\">\nbody { background: black; }\n</style>\n"
234 . "<style type=\"text/css\">\nbody { text-color: black; }\n</style>\n";
235 $this->assertEquals($expected, $actual);
238 public function testCrmCSS() {
239 $smarty = CRM_Core_Smarty
::singleton();
241 $actual = $smarty->fetch('string:{crmStyle ext=com.example.ext file=foo%20bar.css region=testCrmCSS}');
242 $this->assertEquals('', $actual);
244 $actual = $smarty->fetch('string:{crmStyle url=/whiz/foo%20bar.css region=testCrmCSS weight=1}');
245 $this->assertEquals('', $actual);
247 $actual = $smarty->fetch('string:{crmRegion name=testCrmCSS}{/crmRegion}');
248 $expected = "" // stable ordering: alphabetical by (snippet.weight,snippet.name)
249 . "<link href=\"http://ext-dir/com.example.ext/foo%20bar.css?r=resTest\" rel=\"stylesheet\" type=\"text/css\"/>\n"
250 . "<link href=\"/whiz/foo%20bar.css\" rel=\"stylesheet\" type=\"text/css\"/>\n";
251 $this->assertEquals($expected, $actual);
254 public function testGetURL() {
256 'http://core-app/dir/file%20name.txt',
257 $this->res
->getURL('civicrm', 'dir/file%20name.txt')
260 'http://ext-dir/com.example.ext/dir/file%20name.txt',
261 $this->res
->getURL('com.example.ext', 'dir/file%20name.txt')
265 $this->res
->getURL('civicrm')
268 'http://ext-dir/com.example.ext/',
269 $this->res
->getURL('com.example.ext')
273 public function testCrmResURL() {
274 $smarty = CRM_Core_Smarty
::singleton();
276 $actual = $smarty->fetch('string:{crmResURL ext=com.example.ext file=foo%20bar.png}');
277 $this->assertEquals('http://ext-dir/com.example.ext/foo%20bar.png', $actual);
279 $actual = $smarty->fetch('string:{crmResURL ext=com.example.ext file=foo%20bar.png addCacheCode=1}');
280 $this->assertEquals('http://ext-dir/com.example.ext/foo%20bar.png?r=resTest', $actual);
282 $actual = $smarty->fetch('string:{crmResURL ext=com.example.ext}');
283 $this->assertEquals('http://ext-dir/com.example.ext/', $actual);
286 public function testGlob() {
289 $this->res
->glob('com.example.ext', 'info.xml')
292 array('js/example.js'),
293 $this->res
->glob('com.example.ext', 'js/*.js')
296 array('js/example.js'),
297 $this->res
->glob('com.example.ext', array('js/*.js'))
302 * @param CRM_Utils_Cache_Interface $cache
303 * @param string $cacheKey
306 * [string $basedir, CRM_Extension_Container_Interface, CRM_Extension_Mapper]
308 public function _createMapper(CRM_Utils_Cache_Interface
$cache = NULL, $cacheKey = NULL) {
309 $basedir = rtrim($this->createTempDir('ext-'), '/');
310 mkdir("$basedir/com.example.ext");
311 mkdir("$basedir/com.example.ext/js");
312 file_put_contents("$basedir/com.example.ext/info.xml", "<extension key='com.example.ext' type='report'><file>oddball</file></extension>");
313 file_put_contents("$basedir/com.example.ext/js/example.js", "alert('Boo!');");
314 // not needed for now // file_put_contents("$basedir/weird/bar/oddball.php", "<?php\n");
315 $c = new CRM_Extension_Container_Basic($basedir, 'http://ext-dir', $cache, $cacheKey);
316 $mapper = new CRM_Extension_Mapper($c, NULL, NULL, '/pathto/civicrm', 'http://core-app');
317 return array($basedir, $c, $mapper);