-
Notifications
You must be signed in to change notification settings - Fork 65
/
SS4FileMigrationHelperTest.php
311 lines (266 loc) · 12 KB
/
SS4FileMigrationHelperTest.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
<?php
namespace SilverStripe\Assets\Tests\Dev\Tasks;
use DateTime;
use GuzzleHttp\Psr7\StreamWrapper;
use Intervention\Image\AbstractFont;
use Intervention\Image\AbstractShape;
use Intervention\Image\Gd\Font;
use Intervention\Image\ImageManager;
use Silverstripe\Assets\Dev\TestAssetStore;
use SilverStripe\Assets\File;
use SilverStripe\Assets\Dev\Tasks\FileMigrationHelper;
use SilverStripe\Assets\FilenameParsing\FileIDHelperResolutionStrategy;
use SilverStripe\Assets\FilenameParsing\FileResolutionStrategy;
use SilverStripe\Assets\FilenameParsing\HashFileIDHelper;
use SilverStripe\Assets\FilenameParsing\NaturalFileIDHelper;
use SilverStripe\Assets\FilenameParsing\ParsedFileID;
use SilverStripe\Assets\Filesystem;
use SilverStripe\Assets\Flysystem\FlysystemAssetStore;
use SilverStripe\Assets\Folder;
use SilverStripe\Assets\Image;
use SilverStripe\Assets\Storage\AssetStore;
use SilverStripe\Assets\Storage\FileHashingService;
use SilverStripe\Assets\Tests\Dev\Tasks\FileMigrationHelperTest\Extension;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\Security\Member;
use SilverStripe\Versioned\Versioned;
/**
* Test a generic SS4.3 to SS4.4 file migration. Also serve as basis for more fancy file migration test
*/
class SS4FileMigrationHelperTest extends SapphireTest
{
protected $usesTransactions = false;
protected static $fixture_file = '../../FileTest.yml';
protected static $required_extensions = array(
File::class => array(
Extension::class,
)
);
public function setUp()
{
Config::nest(); // additional nesting here necessary
Config::modify()->merge(File::class, 'migrate_legacy_file', false);
// Set backend root to /FileMigrationHelperTest/assets
TestAssetStore::activate('FileMigrationHelperTest');
$this->defineOriginStrategy();
parent::setUp();
// Ensure that each file has a local record file in this new assets base
/** @var File $file */
foreach (File::get()->filter('ClassName', File::class) as $file) {
$filename = $file->getFilename();
// Create an archive version of the file
DBDatetime::set_mock_now('2000-01-01 11:00:00');
$file->setFromString('Archived content of ' . $filename, $filename);
$file->write();
$file->publishSingle();
DBDatetime::clear_mock_now();
// Publish a version of the file
$file->setFromString('Published content of ' . $filename, $filename);
$file->write();
$file->publishSingle(Versioned::DRAFT, Versioned::LIVE);
// Create a draft of the file
$file->setFromString('Draft content of ' . $filename, $filename);
$file->write();
}
// Let's create some variants for our images
/** @var Image $image */
foreach (Image::get() as $image) {
$filename = $image->getFilename();
// Create an archive version of our image with a thumbnail
DBDatetime::set_mock_now('2000-01-01 11:00:00');
$stream = $this->generateImage('Archived', $filename)->stream($image->getExtension());
$image->setFromStream(StreamWrapper::getResource($stream), $filename);
$image->write();
$image->CMSThumbnail();
$image->publishSingle();
DBDatetime::clear_mock_now();
// Publish a live version of our image with a thumbnail
$stream = $this->generateImage('Published', $filename)->stream($image->getExtension());
$image->setFromStream(StreamWrapper::getResource($stream), $filename);
$image->write();
$image->CMSThumbnail();
$image->publishSingle();
// Create a draft version of our images with a thumbnail
$stream = $this->generateImage('Draft', $filename)->stream($image->getExtension());
$image->setFromStream(StreamWrapper::getResource($stream), $filename);
$image->CMSThumbnail();
$image->write();
}
$this->defineDestinationStrategy();
}
/**
* Generate a placeholder image
* @param string $targetedStage
* @param string $filename
* @return \Intervention\Image\Image
*/
private function generateImage($targetedStage, $filename)
{
/** @var ImageManager $imageManager */
$imageManager = Injector::inst()->create(ImageManager::class);
return $imageManager
->canvas(400, 300, '#142237')
->text($targetedStage, 20, 170, function (AbstractFont $font) {
$font->color('#44C8F5');
})->text($filename, 20, 185, function (AbstractFont $font) {
$font->color('#ffffff');
})->rectangle(20, 200, 100, 202, function (AbstractShape $shape) {
$shape->background('#DA1052');
});
}
/**
* Called by set up before creating all the fixture entries. Defines the original startegies for the assets store.
*/
protected function defineOriginStrategy()
{
/** @var FlysystemAssetStore $store */
$store = Injector::inst()->get(AssetStore::class);
$hashHelper = new HashFileIDHelper();
$protected = FileIDHelperResolutionStrategy::create();
$protected->setVersionedStage(Versioned::DRAFT);
$protected->setDefaultFileIDHelper($hashHelper);
$protected->setResolutionFileIDHelpers([$hashHelper]);
$store->setProtectedResolutionStrategy($protected);
$public = FileIDHelperResolutionStrategy::create();
$public->setVersionedStage(Versioned::LIVE);
$public->setDefaultFileIDHelper($hashHelper);
$public->setResolutionFileIDHelpers([$hashHelper]);
$store->setPublicResolutionStrategy($public);
}
/**
* Called by set up after creating all the fixture entries. Defines the targeted strategies that the
* FileMigrationHelper should move the files to.
*/
protected function defineDestinationStrategy()
{
/** @var FlysystemAssetStore $store */
$store = Injector::inst()->get(AssetStore::class);
$hashHelper = new HashFileIDHelper();
$naturalHelper = new NaturalFileIDHelper();
$protected = FileIDHelperResolutionStrategy::create();
$protected->setVersionedStage(Versioned::DRAFT);
$protected->setDefaultFileIDHelper($hashHelper);
$protected->setResolutionFileIDHelpers([$hashHelper, $naturalHelper]);
$store->setProtectedResolutionStrategy($protected);
$public = FileIDHelperResolutionStrategy::create();
$public->setVersionedStage(Versioned::LIVE);
$public->setDefaultFileIDHelper($naturalHelper);
$public->setResolutionFileIDHelpers([$hashHelper, $naturalHelper]);
$store->setPublicResolutionStrategy($public);
}
public function tearDown()
{
TestAssetStore::reset();
parent::tearDown();
Config::unnest();
}
public function testMigration()
{
$helper = new FileMigrationHelper();
$result = $helper->run(TestAssetStore::base_path());
// Let's look at our draft files
Versioned::withVersionedMode(function () {
Versioned::set_stage(Versioned::DRAFT);
foreach (File::get()->filter('ClassName', File::class) as $file) {
$this->assertFileAt($file, AssetStore::VISIBILITY_PROTECTED, 'Draft');
}
foreach (Image::get() as $image) {
$this->assertImageAt($image, AssetStore::VISIBILITY_PROTECTED, 'Draft');
}
});
// Let's look at our live files
Versioned::withVersionedMode(function () {
Versioned::set_stage(Versioned::LIVE);
// There's one file with restricted views, the published version of this file will be protected
$restrictedFileID = $this->idFromFixture(File::class, 'restrictedViewFolder-file4');
$this->lookAtRestrictedFile($restrictedFileID);
/** @var File $file */
foreach (File::get()->filter('ClassName', File::class)->exclude('ID', $restrictedFileID) as $file) {
$this->assertFileAt($file, AssetStore::VISIBILITY_PUBLIC, 'Published');
}
foreach (Image::get() as $image) {
$this->assertImageAt($image, AssetStore::VISIBILITY_PUBLIC, 'Published');
}
});
}
/**
* Test that this restricted file is protected. This test is in its own method so that transition where this
* scenario can not exist can override it.
* @param $restrictedFileID
*/
protected function lookAtRestrictedFile($restrictedFileID)
{
$restrictedFile = File::get()->byID($restrictedFileID);
$this->assertFileAt($restrictedFile, AssetStore::VISIBILITY_PROTECTED, 'Published');
}
/**
* Convenience method to group a bunch of assertions about a regular files
* @param File $file
* @param string $visibility Expected visibility of the file
* @param string $stage Stage that we are testing, will appear in some error messages and in the expected content
*/
protected function assertFileAt(File $file, $visibility, $stage)
{
$ucVisibility = ucfirst($visibility);
$filename = $file->getFilename();
$hash = $file->getHash();
/** @var FlysystemAssetStore $store */
$store = Injector::inst()->get(AssetStore::class);
/** @var Filesystem $fs */
$fs = call_user_func([$store, "get{$ucVisibility}Filesystem"]);
/** @var FileResolutionStrategy $strategy */
$strategy = call_user_func([$store, "get{$ucVisibility}ResolutionStrategy"]);
$this->assertEquals(
$visibility,
$store->getVisibility($filename, $hash),
sprintf('%s version of %s should be %s', $stage, $filename, $visibility)
);
$expectedURL = $strategy->buildFileID(new ParsedFileID($filename, $hash));
$this->assertTrue(
$fs->has($expectedURL),
sprintf('%s version of %s should be on %s store under %s', $stage, $filename, $visibility, $expectedURL)
);
$this->assertEquals(
sprintf('%s content of %s', $stage, $filename),
$fs->read($expectedURL),
sprintf('%s version of %s on %s store has wrong content', $stage, $filename, $visibility)
);
}
/**
* Convenience method to group a bunch of assertions about an image
* @param File $file
* @param string $visibility Expected visibility of the file
* @param string $stage Stage that we are testing, will appear in some error messages
*/
protected function assertImageAt(Image $file, $visibility, $stage)
{
$ucVisibility = ucfirst($visibility);
$filename = $file->getFilename();
$hash = $file->getHash();
$pfid = new ParsedFileID($filename, $hash);
/** @var FlysystemAssetStore $store */
$store = Injector::inst()->get(AssetStore::class);
/** @var Filesystem $fs */
$fs = call_user_func([$store, "get{$ucVisibility}Filesystem"]);
/** @var FileResolutionStrategy $strategy */
$strategy = call_user_func([$store, "get{$ucVisibility}ResolutionStrategy"]);
$this->assertEquals(
$visibility,
$store->getVisibility($filename, $hash),
sprintf('%s version of %s should be %s', $stage, $filename, $visibility)
);
$expectedURL = $strategy->buildFileID($pfid);
$this->assertTrue(
$fs->has($expectedURL),
sprintf('%s version of %s should be on %s store under %s', $stage, $filename, $visibility, $expectedURL)
);
$expectedURL = $strategy->buildFileID($pfid->setVariant('FillWzEwMCwxMDBd'));
$this->assertTrue(
$fs->has($expectedURL),
sprintf('%s thumbnail of %s should be on %s store under %s', $stage, $filename, $visibility, $expectedURL)
);
}
}