notify_spec.rb 18.8 KB
Newer Older
1 2 3 4 5 6
require 'spec_helper'

describe Notify do
  include EmailSpec::Helpers
  include EmailSpec::Matchers

7
  let(:gitlab_sender) { Gitlab.config.gitlab.email_from }
8
  let(:recipient) { create(:user, email: 'recipient@example.com') }
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
9
  let(:project) { create(:project) }
10

Robb Kidd's avatar
Robb Kidd committed
11 12
  shared_examples 'a multiple recipients email' do
    it 'is sent to the given recipient' do
13
      should deliver_to recipient.email
Robb Kidd's avatar
Robb Kidd committed
14 15 16
    end
  end

17 18 19 20 21 22 23 24
  shared_examples 'an email sent from GitLab' do
    it 'is sent from GitLab' do
      sender = subject.header[:from].addrs[0]
      sender.display_name.should eq('GitLab')
      sender.address.should eq(gitlab_sender)
    end
  end

25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
  shared_examples 'an email starting a new thread' do |message_id_prefix|
    it 'has a discussion identifier' do
      should have_header 'Message-ID',  /<#{message_id_prefix}(.*)@#{Gitlab.config.gitlab.host}>/
    end
  end

  shared_examples 'an answer to an existing thread' do |thread_id_prefix|
    it 'has a subject that begins with Re: ' do
      should have_subject /^Re: /
    end

    it 'has headers that reference an existing thread' do
      should have_header 'References',  /<#{thread_id_prefix}(.*)@#{Gitlab.config.gitlab.host}>/
      should have_header 'In-Reply-To', /<#{thread_id_prefix}(.*)@#{Gitlab.config.gitlab.host}>/
    end
  end

Robb Kidd's avatar
Robb Kidd committed
42
  describe 'for new users, the email' do
43
    let(:example_site_path) { root_path }
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
44
    let(:new_user) { create(:user, email: 'newguy@example.com', created_by_id: 1) }
45

46
    subject { Notify.new_user_email(new_user.id, new_user.password) }
47

48 49
    it_behaves_like 'an email sent from GitLab'

50 51 52 53 54
    it 'is sent to the new user' do
      should deliver_to new_user.email
    end

    it 'has the correct subject' do
55
      should have_subject /^Account was created for you$/i
56 57 58 59 60 61 62
    end

    it 'contains the new user\'s login name' do
      should have_body_text /#{new_user.email}/
    end

    it 'contains the new user\'s password' do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
63
      should have_body_text /password/
64 65 66
    end

    it 'includes a link to the site' do
67
      should have_body_text /#{example_site_path}/
68 69 70
    end
  end

Marin Jankovski's avatar
Marin Jankovski committed
71 72 73 74 75 76 77

  describe 'for users that signed up, the email' do
    let(:example_site_path) { root_path }
    let(:new_user) { create(:user, email: 'newguy@example.com', password: "securePassword") }

    subject { Notify.new_user_email(new_user.id, new_user.password) }

78 79
    it_behaves_like 'an email sent from GitLab'

Marin Jankovski's avatar
Marin Jankovski committed
80 81 82 83 84
    it 'is sent to the new user' do
      should deliver_to new_user.email
    end

    it 'has the correct subject' do
85
      should have_subject /^Account was created for you$/i
Marin Jankovski's avatar
Marin Jankovski committed
86 87 88 89 90 91 92
    end

    it 'contains the new user\'s login name' do
      should have_body_text /#{new_user.email}/
    end

    it 'should not contain the new user\'s password' do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
93
      should_not have_body_text /password/
Marin Jankovski's avatar
Marin Jankovski committed
94 95 96 97 98 99 100
    end

    it 'includes a link to the site' do
      should have_body_text /#{example_site_path}/
    end
  end

101 102 103 104 105
  describe 'user added ssh key' do
    let(:key) { create(:personal_key) }

    subject { Notify.new_ssh_key_email(key.id) }

106 107
    it_behaves_like 'an email sent from GitLab'

108 109 110 111 112
    it 'is sent to the new user' do
      should deliver_to key.user.email
    end

    it 'has the correct subject' do
113
      should have_subject /^SSH key was added to your account$/i
114 115 116 117 118 119 120
    end

    it 'contains the new ssh key title' do
      should have_body_text /#{key.title}/
    end

    it 'includes a link to ssh keys page' do
121
      should have_body_text /#{profile_keys_path}/
122 123 124
    end
  end

125 126 127 128 129 130 131 132 133 134
  describe 'user added email' do
    let(:email) { create(:email) }

    subject { Notify.new_email_email(email.id) }

    it 'is sent to the new user' do
      should deliver_to email.user.email
    end

    it 'has the correct subject' do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
135
      should have_subject /^Email was added to your account$/i
136 137 138 139 140 141 142 143 144 145 146
    end

    it 'contains the new email address' do
      should have_body_text /#{email.email}/
    end

    it 'includes a link to emails page' do
      should have_body_text /#{profile_emails_path}/
    end
  end

Robb Kidd's avatar
Robb Kidd committed
147 148
  context 'for a project' do
    describe 'items that are assignable, the email' do
149
      let(:current_user) { create(:user, email: "current@email.com") }
150 151
      let(:assignee) { create(:user, email: 'assignee@example.com') }
      let(:previous_assignee) { create(:user, name: 'Previous Assignee') }
152

Robb Kidd's avatar
Robb Kidd committed
153
      shared_examples 'an assignee email' do
154 155 156 157 158 159
        it 'is sent as the author' do
          sender = subject.header[:from].addrs[0]
          sender.display_name.should eq(current_user.name)
          sender.address.should eq(gitlab_sender)
        end

Robb Kidd's avatar
Robb Kidd committed
160
        it 'is sent to the assignee' do
161
          should deliver_to assignee.email
Robb Kidd's avatar
Robb Kidd committed
162 163
        end
      end
164

Robb Kidd's avatar
Robb Kidd committed
165
      context 'for issues' do
166 167
        let(:issue) { create(:issue, author: current_user, assignee: assignee, project: project) }
        let(:issue_with_description) { create(:issue, author: current_user, assignee: assignee, project: project, description: Faker::Lorem.sentence) }
168

Robb Kidd's avatar
Robb Kidd committed
169
        describe 'that are new' do
170
          subject { Notify.new_issue_email(issue.assignee_id, issue.id) }
171

Robb Kidd's avatar
Robb Kidd committed
172
          it_behaves_like 'an assignee email'
173
          it_behaves_like 'an email starting a new thread', 'issue'
174

Robb Kidd's avatar
Robb Kidd committed
175
          it 'has the correct subject' do
176
            should have_subject /#{project.name} \| #{issue.title} \(##{issue.iid}\)/
Robb Kidd's avatar
Robb Kidd committed
177
          end
178

Robb Kidd's avatar
Robb Kidd committed
179
          it 'contains a link to the new issue' do
180
            should have_body_text /#{project_issue_path project, issue}/
Robb Kidd's avatar
Robb Kidd committed
181 182
          end
        end
183

184 185 186 187 188 189 190 191
        describe 'that are new with a description' do
          subject { Notify.new_issue_email(issue_with_description.assignee_id, issue_with_description.id) }

          it 'contains the description' do
            should have_body_text /#{issue_with_description.description}/
          end
        end

Robb Kidd's avatar
Robb Kidd committed
192
        describe 'that have been reassigned' do
193
          subject { Notify.reassigned_issue_email(recipient.id, issue.id, previous_assignee.id, current_user) }
Robb Kidd's avatar
Robb Kidd committed
194 195

          it_behaves_like 'a multiple recipients email'
196
          it_behaves_like 'an answer to an existing thread', 'issue'
Robb Kidd's avatar
Robb Kidd committed
197

198 199 200 201 202 203
          it 'is sent as the author' do
            sender = subject.header[:from].addrs[0]
            sender.display_name.should eq(current_user.name)
            sender.address.should eq(gitlab_sender)
          end

Robb Kidd's avatar
Robb Kidd committed
204
          it 'has the correct subject' do
205
            should have_subject /#{issue.title} \(##{issue.iid}\)/
Robb Kidd's avatar
Robb Kidd committed
206 207 208
          end

          it 'contains the name of the previous assignee' do
209
            should have_body_text /#{previous_assignee.name}/
Robb Kidd's avatar
Robb Kidd committed
210 211 212 213 214 215 216
          end

          it 'contains the name of the new assignee' do
            should have_body_text /#{assignee.name}/
          end

          it 'contains a link to the issue' do
217
            should have_body_text /#{project_issue_path project, issue}/
Robb Kidd's avatar
Robb Kidd committed
218 219
          end
        end
220 221 222 223

        describe 'status changed' do
          let(:status) { 'closed' }
          subject { Notify.issue_status_changed_email(recipient.id, issue.id, status, current_user) }
224

225 226
          it_behaves_like 'an answer to an existing thread', 'issue'

227 228 229 230 231 232
          it 'is sent as the author' do
            sender = subject.header[:from].addrs[0]
            sender.display_name.should eq(current_user.name)
            sender.address.should eq(gitlab_sender)
          end

233
          it 'has the correct subject' do
234
            should have_subject /#{issue.title} \(##{issue.iid}\)/i
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
          end

          it 'contains the new status' do
            should have_body_text /#{status}/i
          end

          it 'contains the user name' do
            should have_body_text /#{current_user.name}/i
          end

          it 'contains a link to the issue' do
            should have_body_text /#{project_issue_path project, issue}/
          end
        end

Robb Kidd's avatar
Robb Kidd committed
250 251 252
      end

      context 'for merge requests' do
253
        let(:merge_author) { create(:user) }
254
        let(:merge_request) { create(:merge_request, author: current_user, assignee: assignee, source_project: project, target_project: project) }
255
        let(:merge_request_with_description) { create(:merge_request, author: current_user, assignee: assignee, source_project: project, target_project: project, description: Faker::Lorem.sentence) }
Robb Kidd's avatar
Robb Kidd committed
256 257

        describe 'that are new' do
258
          subject { Notify.new_merge_request_email(merge_request.assignee_id, merge_request.id) }
Robb Kidd's avatar
Robb Kidd committed
259 260

          it_behaves_like 'an assignee email'
261
          it_behaves_like 'an email starting a new thread', 'merge_request'
Robb Kidd's avatar
Robb Kidd committed
262 263

          it 'has the correct subject' do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
264
            should have_subject /#{merge_request.title} \(##{merge_request.iid}\)/
Robb Kidd's avatar
Robb Kidd committed
265 266 267
          end

          it 'contains a link to the new merge request' do
268
            should have_body_text /#{project_merge_request_path(project, merge_request)}/
Robb Kidd's avatar
Robb Kidd committed
269 270 271 272 273 274 275 276 277
          end

          it 'contains the source branch for the merge request' do
            should have_body_text /#{merge_request.source_branch}/
          end

          it 'contains the target branch for the merge request' do
            should have_body_text /#{merge_request.target_branch}/
          end
Philip Blatter's avatar
Philip Blatter committed
278 279 280 281

          it 'has the correct message-id set' do
            should have_header 'Message-ID', "<merge_request_#{merge_request.id}@#{Gitlab.config.gitlab.host}>"
          end
Robb Kidd's avatar
Robb Kidd committed
282 283
        end

284 285 286 287 288 289 290 291
        describe 'that are new with a description' do
          subject { Notify.new_merge_request_email(merge_request_with_description.assignee_id, merge_request_with_description.id) }

          it 'contains the description' do
            should have_body_text /#{merge_request_with_description.description}/
          end
        end

Robb Kidd's avatar
Robb Kidd committed
292
        describe 'that are reassigned' do
293
          subject { Notify.reassigned_merge_request_email(recipient.id, merge_request.id, previous_assignee.id, current_user.id) }
Robb Kidd's avatar
Robb Kidd committed
294 295

          it_behaves_like 'a multiple recipients email'
296
          it_behaves_like 'an answer to an existing thread', 'merge_request'
Robb Kidd's avatar
Robb Kidd committed
297

298 299 300 301 302 303
          it 'is sent as the author' do
            sender = subject.header[:from].addrs[0]
            sender.display_name.should eq(current_user.name)
            sender.address.should eq(gitlab_sender)
          end

Robb Kidd's avatar
Robb Kidd committed
304
          it 'has the correct subject' do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
305
            should have_subject /#{merge_request.title} \(##{merge_request.iid}\)/
Robb Kidd's avatar
Robb Kidd committed
306 307 308
          end

          it 'contains the name of the previous assignee' do
309
            should have_body_text /#{previous_assignee.name}/
Robb Kidd's avatar
Robb Kidd committed
310 311 312 313 314 315 316
          end

          it 'contains the name of the new assignee' do
            should have_body_text /#{assignee.name}/
          end

          it 'contains a link to the merge request' do
317
            should have_body_text /#{project_merge_request_path project, merge_request}/
Robb Kidd's avatar
Robb Kidd committed
318
          end
319 320 321 322 323 324
        end

        describe 'that are merged' do
          subject { Notify.merged_merge_request_email(recipient.id, merge_request.id, merge_author.id) }

          it_behaves_like 'a multiple recipients email'
325
          it_behaves_like 'an answer to an existing thread', 'merge_request'
326 327 328 329 330 331 332 333

          it 'is sent as the merge author' do
            sender = subject.header[:from].addrs[0]
            sender.display_name.should eq(merge_author.name)
            sender.address.should eq(gitlab_sender)
          end

          it 'has the correct subject' do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
334
            should have_subject /#{merge_request.title} \(##{merge_request.iid}\)/
335
          end
Robb Kidd's avatar
Robb Kidd committed
336

337 338 339 340 341 342 343
          it 'contains the new status' do
            should have_body_text /merged/i
          end

          it 'contains a link to the merge request' do
            should have_body_text /#{project_merge_request_path project, merge_request}/
          end
Robb Kidd's avatar
Robb Kidd committed
344 345
        end
      end
346 347
    end

348 349 350 351 352
    describe 'project was moved' do
      let(:project) { create(:project) }
      let(:user) { create(:user) }
      subject { Notify.project_was_moved_email(project.id, user.id) }

353 354
      it_behaves_like 'an email sent from GitLab'

355
      it 'has the correct subject' do
356
        should have_subject /Project was moved/
357 358 359 360 361 362 363 364 365 366 367
      end

      it 'contains name of project' do
        should have_body_text /#{project.name_with_namespace}/
      end

      it 'contains new user role' do
        should have_body_text /#{project.ssh_url_to_repo}/
      end
    end

368
    describe 'project access changed' do
369
      let(:project) { create(:project) }
370 371 372 373
      let(:user) { create(:user) }
      let(:users_project) { create(:users_project,
                                   project: project,
                                   user: user) }
374
      subject { Notify.project_access_granted_email(users_project.id) }
375 376 377

      it_behaves_like 'an email sent from GitLab'

378
      it 'has the correct subject' do
379
        should have_subject /Access to project was granted/
380 381 382 383 384
      end
      it 'contains name of project' do
        should have_body_text /#{project.name}/
      end
      it 'contains new user role' do
385
        should have_body_text /#{users_project.human_access}/
386 387 388
      end
    end

Robb Kidd's avatar
Robb Kidd committed
389
    context 'items that are noteable, the email for a note' do
390 391
      let(:note_author) { create(:user, name: 'author_name') }
      let(:note) { create(:note, project: project, author: note_author) }
Robb Kidd's avatar
Robb Kidd committed
392

393
      before :each do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
394
        Note.stub(:find).with(note.id).and_return(note)
395 396
      end

Robb Kidd's avatar
Robb Kidd committed
397
      shared_examples 'a note email' do
398 399 400 401 402 403
        it 'is sent as the author' do
          sender = subject.header[:from].addrs[0]
          sender.display_name.should eq(note_author.name)
          sender.address.should eq(gitlab_sender)
        end

Robb Kidd's avatar
Robb Kidd committed
404
        it 'is sent to the given recipient' do
405
          should deliver_to recipient.email
Robb Kidd's avatar
Robb Kidd committed
406 407 408 409 410 411 412 413
        end

        it 'contains the message from the note' do
          should have_body_text /#{note.note}/
        end
      end

      describe 'on a commit' do
414
        let(:commit) { project.repository.commit }
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
415

Riyad Preukschas's avatar
Riyad Preukschas committed
416
        before(:each) { note.stub(:noteable).and_return(commit) }
Robb Kidd's avatar
Robb Kidd committed
417

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
418
        subject { Notify.note_commit_email(recipient.id, note.id) }
Robb Kidd's avatar
Robb Kidd committed
419 420

        it_behaves_like 'a note email'
421
        it_behaves_like 'an answer to an existing thread', 'commits'
Robb Kidd's avatar
Robb Kidd committed
422 423

        it 'has the correct subject' do
424
          should have_subject /#{commit.title} \(#{commit.short_id}\)/
Robb Kidd's avatar
Robb Kidd committed
425 426 427
        end

        it 'contains a link to the commit' do
428
          should have_body_text commit.short_id
Robb Kidd's avatar
Robb Kidd committed
429 430 431 432
        end
      end

      describe 'on a merge request' do
433
        let(:merge_request) { create(:merge_request, source_project: project, target_project: project) }
434
        let(:note_on_merge_request_path) { project_merge_request_path(project, merge_request, anchor: "note_#{note.id}") }
Robb Kidd's avatar
Robb Kidd committed
435 436
        before(:each) { note.stub(:noteable).and_return(merge_request) }

437
        subject { Notify.note_merge_request_email(recipient.id, note.id) }
Robb Kidd's avatar
Robb Kidd committed
438 439

        it_behaves_like 'a note email'
440
        it_behaves_like 'an answer to an existing thread', 'merge_request'
Robb Kidd's avatar
Robb Kidd committed
441 442

        it 'has the correct subject' do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
443
          should have_subject /#{merge_request.title} \(##{merge_request.iid}\)/
Robb Kidd's avatar
Robb Kidd committed
444 445 446
        end

        it 'contains a link to the merge request note' do
447
          should have_body_text /#{note_on_merge_request_path}/
Robb Kidd's avatar
Robb Kidd committed
448 449 450 451
        end
      end

      describe 'on an issue' do
452
        let(:issue) { create(:issue, project: project) }
453
        let(:note_on_issue_path) { project_issue_path(project, issue, anchor: "note_#{note.id}") }
Robb Kidd's avatar
Robb Kidd committed
454
        before(:each) { note.stub(:noteable).and_return(issue) }
455 456

        subject { Notify.note_issue_email(recipient.id, note.id) }
Robb Kidd's avatar
Robb Kidd committed
457 458

        it_behaves_like 'a note email'
459
        it_behaves_like 'an answer to an existing thread', 'issue'
Robb Kidd's avatar
Robb Kidd committed
460 461

        it 'has the correct subject' do
462
          should have_subject /#{issue.title} \(##{issue.iid}\)/
Robb Kidd's avatar
Robb Kidd committed
463 464 465
        end

        it 'contains a link to the issue note' do
466
          should have_body_text /#{note_on_issue_path}/
Robb Kidd's avatar
Robb Kidd committed
467 468
        end
      end
469 470
    end
  end
471 472 473 474 475 476 477 478

  describe 'group access changed' do
    let(:group) { create(:group) }
    let(:user) { create(:user) }
    let(:membership) { create(:users_group, group: group, user: user) }

    subject { Notify.group_access_granted_email(membership.id) }

479 480
    it_behaves_like 'an email sent from GitLab'

481
    it 'has the correct subject' do
482
      should have_subject /Access to group was granted/
483 484 485 486 487 488 489 490 491 492
    end

    it 'contains name of project' do
      should have_body_text /#{group.name}/
    end

    it 'contains new user role' do
      should have_body_text /#{membership.human_access}/
    end
  end
493 494 495 496 497 498 499 500 501 502 503 504

  describe 'confirmation if email changed' do
    let(:example_site_path) { root_path }
    let(:user) { create(:user, email: 'old-email@mail.com') }

    before do
      user.email = "new-email@mail.com"
      user.save
    end

    subject { ActionMailer::Base.deliveries.last }

505 506
    it_behaves_like 'an email sent from GitLab'

507 508 509 510 511 512 513 514 515 516 517 518
    it 'is sent to the new user' do
      should deliver_to 'new-email@mail.com'
    end

    it 'has the correct subject' do
      should have_subject "Confirmation instructions"
    end

    it 'includes a link to the site' do
      should have_body_text /#{example_site_path}/
    end
  end
519

520
  describe 'email on push with multiple commits' do
521 522 523
    let(:example_site_path) { root_path }
    let(:user) { create(:user) }
    let(:compare) { Gitlab::Git::Compare.new(project.repository.raw_repository, 'cd5c4bac', 'b1e6a9db') }
524 525
    let(:commits) { Commit.decorate(compare.commits) }
    let(:diff_path) { project_compare_path(project, from: commits.first, to: commits.last) }
526 527 528

    subject { Notify.repository_push_email(project.id, 'devs@company.name', user.id, 'master', compare) }

529 530 531 532 533 534
    it 'is sent as the author' do
      sender = subject.header[:from].addrs[0]
      sender.display_name.should eq(user.name)
      sender.address.should eq(gitlab_sender)
    end

535
    it 'is sent to recipient' do
536
      should deliver_to 'devs@company.name'
537 538 539
    end

    it 'has the correct subject' do
540
      should have_subject /#{commits.length} new commits pushed to repository/
541 542 543 544 545 546 547 548 549
    end

    it 'includes commits list' do
      should have_body_text /tree css fixes/
    end

    it 'includes diffs' do
      should have_body_text /Checkout wiki pages for installation information/
    end
550 551 552 553

    it 'contains a link to the diff' do
      should have_body_text /#{diff_path}/
    end
554
  end
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571

  describe 'email on push with a single commit' do
    let(:example_site_path) { root_path }
    let(:user) { create(:user) }
    let(:compare) { Gitlab::Git::Compare.new(project.repository.raw_repository, '8716fc78', 'b1e6a9db') }
    let(:commits) { Commit.decorate(compare.commits) }
    let(:diff_path) { project_commit_path(project, commits.first) }

    subject { Notify.repository_push_email(project.id, 'devs@company.name', user.id, 'master', compare) }

    it 'is sent as the author' do
      sender = subject.header[:from].addrs[0]
      sender.display_name.should eq(user.name)
      sender.address.should eq(gitlab_sender)
    end

    it 'is sent to recipient' do
572
      should deliver_to 'devs@company.name'
573 574 575
    end

    it 'has the correct subject' do
576
      should have_subject /#{commits.first.title}/
577 578 579 580 581 582 583 584 585 586 587 588 589 590
    end

    it 'includes commits list' do
      should have_body_text /tree css fixes/
    end

    it 'includes diffs' do
      should have_body_text /Checkout wiki pages for installation information/
    end

    it 'contains a link to the diff' do
      should have_body_text /#{diff_path}/
    end
  end
591
end