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 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Blob do
include FakeBlobHelpers
using RSpec::Parameterized::TableSyntax
let(:project) { build(:project) }
let(:personal_snippet) { build(:personal_snippet) }
let(:project_snippet) { build(:project_snippet, project: project) }
let(:repository) { project.repository }
let(:lfs_enabled) { true }
before do
allow(repository).to receive(:lfs_enabled?) { lfs_enabled }
end
describe '.decorate' do
it 'returns NilClass when given nil' do
expect(described_class.decorate(nil)).to be_nil
end
end
describe '.lazy' do
let(:commit_id) { 'e63f41fe459e62e1228fcef60d7189127aeba95a' }
let(:blob_size_limit) { 10 * 1024 * 1024 }
shared_examples '.lazy checks' do
it 'does not fetch blobs when none are accessed' do
expect(container.repository).not_to receive(:blobs_at)
described_class.lazy(container.repository, commit_id, 'CHANGELOG')
end
it 'fetches all blobs for the same repository when one is accessed' do
expect(container.repository).to receive(:blobs_at)
.with([[commit_id, 'CHANGELOG'], [commit_id, 'CONTRIBUTING.md']], blob_size_limit: blob_size_limit)
.once.and_call_original
expect(other_container.repository).not_to receive(:blobs_at)
changelog = described_class.lazy(container.repository, commit_id, 'CHANGELOG')
contributing = described_class.lazy(same_container.repository, commit_id, 'CONTRIBUTING.md')
described_class.lazy(other_container.repository, commit_id, 'CHANGELOG')
# Access property so the values are loaded
changelog.id
contributing.id
end
it 'does not include blobs from previous requests in later requests' do
changelog = described_class.lazy(container.repository, commit_id, 'CHANGELOG')
contributing = described_class.lazy(same_container.repository, commit_id, 'CONTRIBUTING.md')
# Access property so the values are loaded
changelog.id
contributing.id
readme = described_class.lazy(container.repository, commit_id, 'README.md')
expect(container.repository).to receive(:blobs_at)
.with([[commit_id, 'README.md']], blob_size_limit: blob_size_limit).once.and_call_original
readme.id
end
end
context 'with project' do
let_it_be(:container) { create(:project, :repository) }
let_it_be(:same_container) { Project.find(container.id) }
let_it_be(:other_container) { create(:project, :repository) }
it_behaves_like '.lazy checks'
context 'when the blob size limit is different' do
it 'fetches all blobs for the same repository and same blob size limit when one is accessed' do
expect(container.repository).to receive(:blobs_at)
.with([[commit_id, 'CHANGELOG']], blob_size_limit: 10)
.once.and_call_original
expect(same_container.repository).to receive(:blobs_at)
.with([[commit_id, 'CONTRIBUTING.md'], [commit_id, 'README.md']], blob_size_limit: 20)
.once.and_call_original
expect(other_container.repository).not_to receive(:blobs_at)
changelog = described_class.lazy(container.repository, commit_id, 'CHANGELOG', blob_size_limit: 10)
contributing = described_class.lazy(same_container.repository, commit_id, 'CONTRIBUTING.md',
blob_size_limit: 20)
described_class.lazy(same_container.repository, commit_id, 'README.md',
blob_size_limit: 20)
described_class.lazy(other_container.repository, commit_id, 'CHANGELOG', blob_size_limit: 30)
# Access property so the values are loaded
changelog.id
contributing.id
end
end
context 'with personal snippet' do
let_it_be(:container) { create(:personal_snippet, :repository) }
let_it_be(:same_container) { PersonalSnippet.find(container.id) }
let_it_be(:other_container) { create(:personal_snippet, :repository) }
it_behaves_like '.lazy checks'
end
context 'with project snippet' do
let_it_be(:container) { create(:project_snippet, :repository) }
let_it_be(:same_container) { ProjectSnippet.find(container.id) }
let_it_be(:other_container) { create(:project_snippet, :repository) }
it_behaves_like '.lazy checks'
end
end
end
describe '#data' do
shared_examples '#data checks' do
context 'using a binary blob' do
it 'returns the data as-is' do
data = "\n\xFF\xB9\xC3"
blob = fake_blob(binary: true, data: data, container: container)
expect(blob.data).to eq(data)
end
end
context 'using a text blob' do
it 'converts the data to UTF-8' do
blob = fake_blob(binary: false, data: "\n\xFF\xB9\xC3", container: container)
expect(blob.data).to eq("\n���")
end
end
end
context 'with project' do
let(:container) { project }
it_behaves_like '#data checks'
end
context 'with personal snippet' do
let(:container) { personal_snippet }
it_behaves_like '#data checks'
end
context 'with project snippet' do
let(:container) { project_snippet }
it_behaves_like '#data checks'
end
end
describe '#external_storage_error?' do
subject { blob.external_storage_error? }
context 'if the blob is stored in LFS' do
let(:blob) { fake_blob(path: 'file.pdf', lfs: true) }
context 'when LFS is enabled' do
let(:lfs_enabled) { true }
it { is_expected.to be_falsy }
end
context 'when LFS is not enabled' do
let(:lfs_enabled) { false }
it { is_expected.to be_truthy }
end
end
context 'if the blob is not stored in LFS' do
let(:blob) { fake_blob(path: 'file.md') }
it { is_expected.to be_falsy }
end
end
describe '#stored_externally?' do
subject { blob.stored_externally? }
context 'if the blob is stored in LFS' do
let(:blob) { fake_blob(path: 'file.pdf', lfs: true) }
context 'when LFS is enabled' do
let(:lfs_enabled) { true }
it { is_expected.to be_truthy }
end
context 'when LFS is not enabled' do
let(:lfs_enabled) { false }
it { is_expected.to be_falsy }
end
end
context 'if the blob is not stored in LFS' do
let(:blob) { fake_blob(path: 'file.md') }
it { is_expected.to be_falsy }
end
end
describe '#binary?' do
context 'an lfs object' do
where(:filename, :is_binary) do
'file.pdf' | true
'file.md' | false
'file.txt' | false
'file.ics' | false
'file.rb' | false
'file.exe' | true
'file.ini' | false
'file.wtf' | true
end
with_them do
let(:blob) { fake_blob(path: filename, lfs: true, container: project) }
it { expect(blob.binary?).to eq(is_binary) }
end
end
context 'a non-lfs object' do
let(:blob) { fake_blob(path: 'anything', container: project) }
it 'delegates to binary_in_repo?' do
expect(blob).to receive(:binary_in_repo?) { :result }
expect(blob.binary?).to eq(:result)
end
end
end
describe '#symlink?' do
it 'is true for symlinks' do
symlink_blob = fake_blob(path: 'file', mode: '120000')
expect(symlink_blob.symlink?).to eq true
end
it 'is false for non-symlinks' do
non_symlink_blob = fake_blob(path: 'file', mode: '100755')
expect(non_symlink_blob.symlink?).to eq false
end
end
describe '#executable?' do
it 'is true for executables' do
executable_blob = fake_blob(path: 'file', mode: '100755')
expect(executable_blob.executable?).to eq true
end
it 'is false for non-executables' do
non_executable_blob = fake_blob(path: 'file', mode: '100655')
expect(non_executable_blob.executable?).to eq false
end
end
describe '#extension' do
it 'returns the extension' do
blob = fake_blob(path: 'file.md')
expect(blob.extension).to eq('md')
end
end
describe '#file_type' do
it 'returns the file type' do
blob = fake_blob(path: 'README.md')
expect(blob.file_type).to eq(:readme)
end
end
describe '#simple_viewer' do
context 'when the blob is empty' do
it 'returns an empty viewer' do
blob = fake_blob(data: '', size: 0)
expect(blob.simple_viewer).to be_a(BlobViewer::Empty)
end
end
context 'when the file represented by the blob is binary' do
it 'returns a download viewer' do
blob = fake_blob(binary: true)
expect(blob.simple_viewer).to be_a(BlobViewer::Download)
end
end
context 'when the file represented by the blob is text-based' do
it 'returns a text viewer' do
blob = fake_blob
expect(blob.simple_viewer).to be_a(BlobViewer::Text)
end
end
end
describe '#rich_viewer' do
context 'when the blob has an external storage error' do
let(:lfs_enabled) { false }
it 'returns nil' do
blob = fake_blob(path: 'file.pdf', lfs: true)
expect(blob.rich_viewer).to be_nil
end
end
context 'when the blob is empty' do
it 'returns nil' do
blob = fake_blob(data: '')
expect(blob.rich_viewer).to be_nil
end
end
context 'when the blob is stored externally' do
it 'returns a matching viewer' do
blob = fake_blob(path: 'file.pdf', lfs: true)
expect(blob.rich_viewer).to be_a(BlobViewer::PDF)
end
end
context 'when the blob is binary' do
it 'returns a matching binary viewer' do
blob = fake_blob(path: 'file.pdf', binary: true)
expect(blob.rich_viewer).to be_a(BlobViewer::PDF)
end
end
context 'when the blob is text-based' do
it 'returns a matching text-based viewer' do
blob = fake_blob(path: 'file.md')
expect(blob.rich_viewer).to be_a(BlobViewer::Markup)
end
end
context 'when the blob is video' do
it 'returns a video viewer' do
blob = fake_blob(path: 'file.mp4', binary: true)
expect(blob.rich_viewer).to be_a(BlobViewer::Video)
end
end
context 'when the blob is audio' do
it 'returns an audio viewer' do
blob = fake_blob(path: 'file.wav', binary: true)
expect(blob.rich_viewer).to be_a(BlobViewer::Audio)
end
end
end
describe '#auxiliary_viewer' do
context 'when the blob has an external storage error' do
let(:lfs_enabled) { false }
it 'returns nil' do
blob = fake_blob(path: 'LICENSE', lfs: true)
expect(blob.auxiliary_viewer).to be_nil
end
end
context 'when the blob is empty' do
it 'returns nil' do
blob = fake_blob(data: '')
expect(blob.auxiliary_viewer).to be_nil
end
end
context 'when the blob is stored externally' do
it 'returns a matching viewer' do
blob = fake_blob(path: 'LICENSE', lfs: true)
expect(blob.auxiliary_viewer).to be_a(BlobViewer::License)
end
end
context 'when the blob is binary' do
it 'returns nil' do
blob = fake_blob(path: 'LICENSE', binary: true)
expect(blob.auxiliary_viewer).to be_nil
end
end
context 'when the blob is text-based' do
it 'returns a matching text-based viewer' do
blob = fake_blob(path: 'LICENSE')
expect(blob.auxiliary_viewer).to be_a(BlobViewer::License)
end
end
context 'when the blob is GitlabCiYml' do
it 'returns a matching viewer for .gitlab-ci.yml' do
blob = fake_blob(path: '.gitlab-ci.yml')
expect(blob.auxiliary_viewer).to be_a(BlobViewer::GitlabCiYml)
end
it 'returns nil for non .gitlab-ci.yml' do
blob = fake_blob(path: 'custom-ci.yml')
expect(blob.auxiliary_viewer).to be_nil
end
context 'when the project has a custom CI config path' do
let(:project) { build(:project, ci_config_path: 'custom-ci.yml') }
it 'returns a matching viewer for the custom CI file' do
blob = fake_blob(path: 'custom-ci.yml')
expect(blob.auxiliary_viewer).to be_a(BlobViewer::GitlabCiYml)
end
it 'returns nil for the incorrect CI file' do
blob = fake_blob(path: '.gitlab-ci.yml')
expect(blob.auxiliary_viewer).to be_nil
end
end
end
end
describe '#rendered_as_text?' do
subject { blob.rendered_as_text?(ignore_errors: ignore_errors) }
context 'when ignoring errors' do
let(:ignore_errors) { true }
context 'when the simple viewer is text-based' do
let(:blob) { fake_blob(path: 'file.md', size: 100.megabytes) }
it { is_expected.to be_truthy }
end
context 'when the simple viewer is binary' do
let(:blob) { fake_blob(path: 'file.pdf', binary: true, size: 100.megabytes) }
it { is_expected.to be_falsy }
end
end
context 'when not ignoring errors' do
let(:ignore_errors) { false }
context 'when the viewer has render errors' do
let(:blob) { fake_blob(path: 'file.md', size: 100.megabytes) }
it { is_expected.to be_falsy }
end
context "when the viewer doesn't have render errors" do
let(:blob) { fake_blob(path: 'file.md') }
it { is_expected.to be_truthy }
end
end
end
describe 'policy' do
let(:project) { build(:project) }
subject { described_class.new(fake_blob(path: 'foo'), project) }
it 'works with policy' do
expect(Ability.allowed?(project.creator, :read_blob, subject)).to be_truthy
end
context 'when project is nil' do
subject { described_class.new(fake_blob(path: 'foo')) }
it 'does not err' do
expect(Ability.allowed?(project.creator, :read_blob, subject)).to be_falsey
end
end
end
end
|