BigW Consortium Gitlab

blob_show_spec.rb 14.8 KB
Newer Older
1 2
require 'spec_helper'

3
feature 'File blob', :js do
4
  let(:project) { create(:project, :public, :repository) }
Douwe Maan committed
5

6
  def visit_blob(path, anchor: nil, ref: 'master')
7
    visit project_blob_path(project, File.join(ref, path), anchor: anchor)
8

9
    wait_for_requests
Douwe Maan committed
10 11
  end

Douwe Maan committed
12 13 14
  context 'Ruby file' do
    before do
      visit_blob('files/ruby/popen.rb')
Douwe Maan committed
15 16
    end

Douwe Maan committed
17 18 19
    it 'displays the blob' do
      aggregate_failures do
        # shows highlighted Ruby code
Douwe Maan committed
20
        expect(page).to have_css(".js-syntax-highlight")
Douwe Maan committed
21
        expect(page).to have_content("require 'fileutils'")
Douwe Maan committed
22

Douwe Maan committed
23 24
        # does not show a viewer switcher
        expect(page).not_to have_selector('.js-blob-viewer-switcher')
Douwe Maan committed
25

Douwe Maan committed
26 27
        # shows an enabled copy button
        expect(page).to have_selector('.js-copy-blob-source-btn:not(.disabled)')
28 29 30

        # shows a raw button
        expect(page).to have_link('Open raw')
Douwe Maan committed
31
      end
Douwe Maan committed
32
    end
Douwe Maan committed
33 34 35 36 37 38 39 40
  end

  context 'Markdown file' do
    context 'visiting directly' do
      before do
        visit_blob('files/markdown/ruby-style-guide.md')
      end

41
      it 'displays the blob using the rich viewer' do
Douwe Maan committed
42 43 44 45 46 47 48 49 50 51 52 53 54
        aggregate_failures do
          # hides the simple viewer
          expect(page).to have_selector('.blob-viewer[data-type="simple"]', visible: false)
          expect(page).to have_selector('.blob-viewer[data-type="rich"]')

          # shows rendered Markdown
          expect(page).to have_link("PEP-8")

          # shows a viewer switcher
          expect(page).to have_selector('.js-blob-viewer-switcher')

          # shows a disabled copy button
          expect(page).to have_selector('.js-copy-blob-source-btn.disabled')
55 56 57

          # shows a raw button
          expect(page).to have_link('Open raw')
Douwe Maan committed
58 59 60 61 62 63 64
        end
      end

      context 'switching to the simple viewer' do
        before do
          find('.js-blob-viewer-switch-btn[data-viewer=simple]').click

65
          wait_for_requests
Douwe Maan committed
66
        end
Douwe Maan committed
67

68
        it 'displays the blob using the simple viewer' do
Douwe Maan committed
69 70 71 72
          aggregate_failures do
            # hides the rich viewer
            expect(page).to have_selector('.blob-viewer[data-type="simple"]')
            expect(page).to have_selector('.blob-viewer[data-type="rich"]', visible: false)
Douwe Maan committed
73

Douwe Maan committed
74
            # shows highlighted Markdown code
Douwe Maan committed
75
            expect(page).to have_css(".js-syntax-highlight")
Douwe Maan committed
76 77 78 79 80 81 82 83 84 85 86
            expect(page).to have_content("[PEP-8](http://www.python.org/dev/peps/pep-0008/)")

            # shows an enabled copy button
            expect(page).to have_selector('.js-copy-blob-source-btn:not(.disabled)')
          end
        end

        context 'switching to the rich viewer again' do
          before do
            find('.js-blob-viewer-switch-btn[data-viewer=rich]').click

87
            wait_for_requests
Douwe Maan committed
88 89
          end

90
          it 'displays the blob using the rich viewer' do
Douwe Maan committed
91 92 93 94 95 96 97 98 99 100 101
            aggregate_failures do
              # hides the simple viewer
              expect(page).to have_selector('.blob-viewer[data-type="simple"]', visible: false)
              expect(page).to have_selector('.blob-viewer[data-type="rich"]')

              # shows an enabled copy button
              expect(page).to have_selector('.js-copy-blob-source-btn:not(.disabled)')
            end
          end
        end
      end
Douwe Maan committed
102 103
    end

Douwe Maan committed
104 105
    context 'visiting with a line number anchor' do
      before do
106
        visit_blob('files/markdown/ruby-style-guide.md', anchor: 'L1')
Douwe Maan committed
107 108
      end

109
      it 'displays the blob using the simple viewer' do
Douwe Maan committed
110 111 112 113 114 115 116 117 118
        aggregate_failures do
          # hides the rich viewer
          expect(page).to have_selector('.blob-viewer[data-type="simple"]')
          expect(page).to have_selector('.blob-viewer[data-type="rich"]', visible: false)

          # highlights the line in question
          expect(page).to have_selector('#LC1.hll')

          # shows highlighted Markdown code
Douwe Maan committed
119
          expect(page).to have_css(".js-syntax-highlight")
Douwe Maan committed
120
          expect(page).to have_content("[PEP-8](http://www.python.org/dev/peps/pep-0008/)")
Douwe Maan committed
121

Douwe Maan committed
122 123 124 125
          # shows an enabled copy button
          expect(page).to have_selector('.js-copy-blob-source-btn:not(.disabled)')
        end
      end
Douwe Maan committed
126 127 128
    end
  end

Douwe Maan committed
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
  context 'Markdown file (stored in LFS)' do
    before do
      project.add_master(project.creator)

      Files::CreateService.new(
        project,
        project.creator,
        start_branch: 'master',
        branch_name: 'master',
        commit_message: "Add Markdown in LFS",
        file_path: 'files/lfs/file.md',
        file_content: project.repository.blob_at('master', 'files/lfs/lfs_object.iso').data
      ).execute
    end

    context 'when LFS is enabled on the project' do
      before do
        allow(Gitlab.config.lfs).to receive(:enabled).and_return(true)
        project.update_attribute(:lfs_enabled, true)

        visit_blob('files/lfs/file.md')
      end

Douwe Maan committed
152
      it 'displays an error' do
Douwe Maan committed
153 154 155 156 157 158
        aggregate_failures do
          # hides the simple viewer
          expect(page).to have_selector('.blob-viewer[data-type="simple"]', visible: false)
          expect(page).to have_selector('.blob-viewer[data-type="rich"]')

          # shows an error message
159
          expect(page).to have_content('The rendered file could not be displayed because it is stored in LFS. You can download it instead.')
Douwe Maan committed
160 161 162 163 164 165

          # shows a viewer switcher
          expect(page).to have_selector('.js-blob-viewer-switcher')

          # does not show a copy button
          expect(page).not_to have_selector('.js-copy-blob-source-btn')
166

167 168
          # shows a download button
          expect(page).to have_link('Download')
Douwe Maan committed
169 170 171 172 173 174 175
        end
      end

      context 'switching to the simple viewer' do
        before do
          find('.js-blob-viewer-switcher .js-blob-viewer-switch-btn[data-viewer=simple]').click

176
          wait_for_requests
Douwe Maan committed
177 178
        end

Douwe Maan committed
179
        it 'displays an error' do
Douwe Maan committed
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
          aggregate_failures do
            # hides the rich viewer
            expect(page).to have_selector('.blob-viewer[data-type="simple"]')
            expect(page).to have_selector('.blob-viewer[data-type="rich"]', visible: false)

            # shows an error message
            expect(page).to have_content('The source could not be displayed because it is stored in LFS. You can download it instead.')

            # does not show a copy button
            expect(page).not_to have_selector('.js-copy-blob-source-btn')
          end
        end
      end
    end

    context 'when LFS is disabled on the project' do
      before do
        visit_blob('files/lfs/file.md')
      end

      it 'displays the blob' do
        aggregate_failures do
          # shows text
          expect(page).to have_content('size 1575078')

          # does not show a viewer switcher
          expect(page).not_to have_selector('.js-blob-viewer-switcher')

          # shows an enabled copy button
          expect(page).to have_selector('.js-copy-blob-source-btn:not(.disabled)')
210 211 212

          # shows a raw button
          expect(page).to have_link('Open raw')
Douwe Maan committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
        end
      end
    end
  end

  context 'PDF file' do
    before do
      project.add_master(project.creator)

      Files::CreateService.new(
        project,
        project.creator,
        start_branch: 'master',
        branch_name: 'master',
        commit_message: "Add PDF",
        file_path: 'files/test.pdf',
Phil Hughes committed
229
        file_content: project.repository.blob_at('add-pdf-file', 'files/pdf/test.pdf').data
Douwe Maan committed
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
      ).execute

      visit_blob('files/test.pdf')
    end

    it 'displays the blob' do
      aggregate_failures do
        # shows rendered PDF
        expect(page).to have_selector('.js-pdf-viewer')

        # does not show a viewer switcher
        expect(page).not_to have_selector('.js-blob-viewer-switcher')

        # does not show a copy button
        expect(page).not_to have_selector('.js-copy-blob-source-btn')
245 246 247

        # shows a download button
        expect(page).to have_link('Download')
Douwe Maan committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
      end
    end
  end

  context 'ISO file (stored in LFS)' do
    context 'when LFS is enabled on the project' do
      before do
        allow(Gitlab.config.lfs).to receive(:enabled).and_return(true)
        project.update_attribute(:lfs_enabled, true)

        visit_blob('files/lfs/lfs_object.iso')
      end

      it 'displays the blob' do
        aggregate_failures do
          # shows a download link
          expect(page).to have_link('Download (1.5 MB)')

          # does not show a viewer switcher
          expect(page).not_to have_selector('.js-blob-viewer-switcher')

          # does not show a copy button
          expect(page).not_to have_selector('.js-copy-blob-source-btn')
271 272 273

          # shows a download button
          expect(page).to have_link('Download')
Douwe Maan committed
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
        end
      end
    end

    context 'when LFS is disabled on the project' do
      before do
        visit_blob('files/lfs/lfs_object.iso')
      end

      it 'displays the blob' do
        aggregate_failures do
          # shows text
          expect(page).to have_content('size 1575078')

          # does not show a viewer switcher
          expect(page).not_to have_selector('.js-blob-viewer-switcher')

          # shows an enabled copy button
          expect(page).to have_selector('.js-copy-blob-source-btn:not(.disabled)')
293 294 295

          # shows a raw button
          expect(page).to have_link('Open raw')
Douwe Maan committed
296 297 298 299 300 301 302
        end
      end
    end
  end

  context 'ZIP file' do
    before do
Douwe Maan committed
303
      visit_blob('Gemfile.zip')
Douwe Maan committed
304 305 306 307 308 309 310 311 312 313 314 315
    end

    it 'displays the blob' do
      aggregate_failures do
        # shows a download link
        expect(page).to have_link('Download (2.11 KB)')

        # does not show a viewer switcher
        expect(page).not_to have_selector('.js-blob-viewer-switcher')

        # does not show a copy button
        expect(page).not_to have_selector('.js-copy-blob-source-btn')
316 317 318

        # shows a download button
        expect(page).to have_link('Download')
Douwe Maan committed
319
      end
320 321
    end
  end
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

  context 'empty file' do
    before do
      project.add_master(project.creator)

      Files::CreateService.new(
        project,
        project.creator,
        start_branch: 'master',
        branch_name: 'master',
        commit_message: "Add empty file",
        file_path: 'files/empty.md',
        file_content: ''
      ).execute

      visit_blob('files/empty.md')
    end

    it 'displays an error' do
      aggregate_failures do
        # shows an error message
        expect(page).to have_content('Empty file')

        # does not show a viewer switcher
        expect(page).not_to have_selector('.js-blob-viewer-switcher')

        # does not show a copy button
        expect(page).not_to have_selector('.js-copy-blob-source-btn')

        # does not show a download or raw button
        expect(page).not_to have_link('Download')
        expect(page).not_to have_link('Open raw')
      end
    end
  end
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
  context 'binary file that appears to be text in the first 1024 bytes' do
    before do
      visit_blob('encoding/binary-1.bin', ref: 'binary-encoding')
    end

    it 'displays the blob' do
      aggregate_failures do
        # shows a download link
        expect(page).to have_link('Download (23.8 KB)')

        # does not show a viewer switcher
        expect(page).not_to have_selector('.js-blob-viewer-switcher')

        # The specs below verify an arguably incorrect result, but since we only
        # learn that the file is not actually text once the text viewer content
        # is loaded asynchronously, there is no straightforward way to get these
        # synchronously loaded elements to display correctly.
        #
        # Clicking the copy button will result in nothing being copied.
        # Clicking the raw button will result in the binary file being downloaded,
        # as expected.

        # shows an enabled copy button, incorrectly
        expect(page).to have_selector('.js-copy-blob-source-btn:not(.disabled)')

        # shows a raw button, incorrectly
        expect(page).to have_link('Open raw')
      end
    end
  end

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
  context '.gitlab-ci.yml' do
    before do
      project.add_master(project.creator)

      Files::CreateService.new(
        project,
        project.creator,
        start_branch: 'master',
        branch_name: 'master',
        commit_message: "Add .gitlab-ci.yml",
        file_path: '.gitlab-ci.yml',
        file_content: File.read(Rails.root.join('spec/support/gitlab_stubs/gitlab_ci.yml'))
      ).execute

      visit_blob('.gitlab-ci.yml')
    end

    it 'displays an auxiliary viewer' do
      aggregate_failures do
        # shows that configuration is valid
        expect(page).to have_content('This GitLab CI configuration is valid.')

        # shows a learn more link
        expect(page).to have_link('Learn more')
      end
    end
  end

  context '.gitlab/route-map.yml' do
    before do
      project.add_master(project.creator)

      Files::CreateService.new(
        project,
        project.creator,
        start_branch: 'master',
        branch_name: 'master',
        commit_message: "Add .gitlab/route-map.yml",
        file_path: '.gitlab/route-map.yml',
        file_content: <<-MAP.strip_heredoc
          # Team data
          - source: 'data/team.yml'
            public: 'team/'
        MAP
      ).execute

      visit_blob('.gitlab/route-map.yml')
    end

    it 'displays an auxiliary viewer' do
      aggregate_failures do
        # shows that map is valid
        expect(page).to have_content('This Route Map is valid.')

        # shows a learn more link
        expect(page).to have_link('Learn more')
      end
    end
  end

  context 'LICENSE' do
    before do
      visit_blob('LICENSE')
    end

    it 'displays an auxiliary viewer' do
      aggregate_failures do
        # shows license
        expect(page).to have_content('This project is licensed under the MIT License.')

        # shows a learn more link
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
        expect(page).to have_link('Learn more', 'http://choosealicense.com/licenses/mit/')
      end
    end
  end

  context '*.gemspec' do
    before do
      project.add_master(project.creator)

      Files::CreateService.new(
        project,
        project.creator,
        start_branch: 'master',
        branch_name: 'master',
        commit_message: "Add activerecord.gemspec",
        file_path: 'activerecord.gemspec',
        file_content: <<-SPEC.strip_heredoc
          Gem::Specification.new do |s|
            s.platform    = Gem::Platform::RUBY
            s.name        = "activerecord"
          end
        SPEC
      ).execute

      visit_blob('activerecord.gemspec')
    end

    it 'displays an auxiliary viewer' do
      aggregate_failures do
489
        # shows names of dependency manager and package
490 491 492 493 494 495 496
        expect(page).to have_content('This project manages its dependencies using RubyGems and defines a gem named activerecord.')

        # shows a link to the gem
        expect(page).to have_link('activerecord', 'https://rubygems.org/gems/activerecord')

        # shows a learn more link
        expect(page).to have_link('Learn more', 'http://choosealicense.com/licenses/mit/')
497 498 499
      end
    end
  end
500
end