2012-10-02 18:57:13 -04:00
require 'spec_helper'
2017-07-10 10:24:02 -04:00
describe Commit do
2017-01-26 17:44:58 -05:00
let ( :project ) { create ( :project , :public , :repository ) }
2015-05-02 23:11:21 -04:00
let ( :commit ) { project . commit }
describe 'modules' do
subject { described_class }
it { is_expected . to include_module ( Mentionable ) }
it { is_expected . to include_module ( Participable ) }
it { is_expected . to include_module ( Referable ) }
it { is_expected . to include_module ( StaticModel ) }
end
2016-07-27 19:42:38 -04:00
describe '#author' do
it 'looks up the author in a case-insensitive way' do
user = create ( :user , email : commit . author_email . upcase )
expect ( commit . author ) . to eq ( user )
end
2017-07-17 13:18:20 -04:00
it 'caches the author' , :request_store do
2016-07-27 19:42:38 -04:00
user = create ( :user , email : commit . author_email )
2017-07-17 13:18:20 -04:00
expect ( User ) . to receive ( :find_by_any_email ) . and_call_original
2016-07-27 19:42:38 -04:00
expect ( commit . author ) . to eq ( user )
2017-07-17 13:18:20 -04:00
key = " Commit:author: #{ commit . author_email . downcase } "
2016-07-27 19:42:38 -04:00
expect ( RequestStore . store [ key ] ) . to eq ( user )
expect ( commit . author ) . to eq ( user )
end
end
2015-05-02 23:11:21 -04:00
describe '#to_reference' do
2017-01-26 17:44:58 -05:00
let ( :project ) { create ( :project , :repository , path : 'sample-project' ) }
2016-11-02 19:49:13 -04:00
2015-05-02 23:11:21 -04:00
it 'returns a String reference to the object' do
2015-12-01 06:58:45 -05:00
expect ( commit . to_reference ) . to eq commit . id
2015-05-02 23:11:21 -04:00
end
it 'supports a cross-project reference' do
2017-01-26 17:44:58 -05:00
another_project = build ( :project , :repository , name : 'another-project' , namespace : project . namespace )
2016-11-02 19:49:13 -04:00
expect ( commit . to_reference ( another_project ) ) . to eq " sample-project@ #{ commit . id } "
2015-12-01 06:58:45 -05:00
end
end
describe '#reference_link_text' do
2017-01-26 17:44:58 -05:00
let ( :project ) { create ( :project , :repository , path : 'sample-project' ) }
2016-11-02 19:49:13 -04:00
2015-12-01 06:58:45 -05:00
it 'returns a String reference to the object' do
expect ( commit . reference_link_text ) . to eq commit . short_id
end
it 'supports a cross-project reference' do
2017-01-26 17:44:58 -05:00
another_project = build ( :project , :repository , name : 'another-project' , namespace : project . namespace )
2016-11-02 19:49:13 -04:00
expect ( commit . reference_link_text ( another_project ) ) . to eq " sample-project@ #{ commit . short_id } "
2015-05-02 23:11:21 -04:00
end
end
2012-10-02 18:57:13 -04:00
2013-04-01 09:56:25 -04:00
describe '#title' do
it " returns no_commit_message when safe_message is blank " do
2015-02-12 13:17:35 -05:00
allow ( commit ) . to receive ( :safe_message ) . and_return ( '' )
expect ( commit . title ) . to eq ( " --no commit message " )
2013-04-01 09:56:25 -04:00
end
2012-10-02 18:57:13 -04:00
2017-04-21 11:31:18 -04:00
it 'truncates a message without a newline at natural break to 80 characters' do
2014-08-01 11:06:28 -04:00
message = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id felis id blandit. Vivamus egestas lacinia lacus, sed rutrum mauris.'
2012-10-02 18:57:13 -04:00
2015-02-12 13:17:35 -05:00
allow ( commit ) . to receive ( :safe_message ) . and_return ( message )
2017-04-21 11:31:18 -04:00
expect ( commit . title ) . to eq ( 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id felis…' )
2013-04-01 09:56:25 -04:00
end
2012-10-02 18:57:13 -04:00
2013-04-01 09:56:25 -04:00
it " truncates a message with a newline before 80 characters at the newline " do
message = commit . safe_message . split ( " " ) . first
2012-10-02 18:57:13 -04:00
2015-02-12 13:17:35 -05:00
allow ( commit ) . to receive ( :safe_message ) . and_return ( message + " \n " + message )
expect ( commit . title ) . to eq ( message )
2013-04-01 09:56:25 -04:00
end
2012-10-02 18:57:13 -04:00
2014-08-01 11:06:28 -04:00
it " does not truncates a message with a newline after 80 but less 100 characters " do
2016-05-10 22:58:06 -04:00
message = <<eos
2014-08-01 11:06:28 -04:00
Lorem ipsum dolor sit amet , consectetur adipiscing elit . Donec sodales id felis id blandit .
Vivamus egestas lacinia lacus , sed rutrum mauris .
eos
2012-10-02 18:57:13 -04:00
2015-02-12 13:17:35 -05:00
allow ( commit ) . to receive ( :safe_message ) . and_return ( message )
expect ( commit . title ) . to eq ( message . split ( " \n " ) . first )
2012-10-02 18:57:13 -04:00
end
end
2013-01-03 12:11:14 -05:00
2016-07-26 00:49:06 -04:00
describe '#full_title' do
it " returns no_commit_message when safe_message is blank " do
allow ( commit ) . to receive ( :safe_message ) . and_return ( '' )
expect ( commit . full_title ) . to eq ( " --no commit message " )
end
it " returns entire message if there is no newline " do
message = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id felis id blandit. Vivamus egestas lacinia lacus, sed rutrum mauris.'
allow ( commit ) . to receive ( :safe_message ) . and_return ( message )
expect ( commit . full_title ) . to eq ( message )
end
it " returns first line of message if there is a newLine " do
message = commit . safe_message . split ( " " ) . first
allow ( commit ) . to receive ( :safe_message ) . and_return ( message + " \n " + message )
expect ( commit . full_title ) . to eq ( message )
end
end
2017-04-21 11:31:18 -04:00
describe 'description' do
it 'returns description of commit message if title less than 100 characters' do
message = <<eos
Lorem ipsum dolor sit amet , consectetur adipiscing elit . Donec sodales id felis id blandit .
Vivamus egestas lacinia lacus , sed rutrum mauris .
eos
allow ( commit ) . to receive ( :safe_message ) . and_return ( message )
expect ( commit . description ) . to eq ( 'Vivamus egestas lacinia lacus, sed rutrum mauris.' )
end
it 'returns full commit message if commit title more than 100 characters' do
message = <<eos
Lorem ipsum dolor sit amet , consectetur adipiscing elit . Donec sodales id felis id blandit . Vivamus egestas lacinia lacus , sed rutrum mauris .
Vivamus egestas lacinia lacus , sed rutrum mauris .
eos
allow ( commit ) . to receive ( :safe_message ) . and_return ( message )
expect ( commit . description ) . to eq ( message )
end
end
2013-01-03 12:11:14 -05:00
describe " delegation " do
subject { commit }
2015-02-12 13:17:35 -05:00
it { is_expected . to respond_to ( :message ) }
it { is_expected . to respond_to ( :authored_date ) }
it { is_expected . to respond_to ( :committed_date ) }
it { is_expected . to respond_to ( :committer_email ) }
it { is_expected . to respond_to ( :author_email ) }
it { is_expected . to respond_to ( :parents ) }
it { is_expected . to respond_to ( :date ) }
it { is_expected . to respond_to ( :diffs ) }
it { is_expected . to respond_to ( :tree ) }
it { is_expected . to respond_to ( :id ) }
it { is_expected . to respond_to ( :to_patch ) }
2013-01-03 12:11:14 -05:00
end
2013-05-30 19:16:49 -04:00
describe '#closes_issues' do
let ( :issue ) { create :issue , project : project }
2017-08-02 15:55:11 -04:00
let ( :other_project ) { create ( :project , :public ) }
2014-10-03 01:48:35 -04:00
let ( :other_issue ) { create :issue , project : other_project }
2016-03-17 16:39:50 -04:00
let ( :commiter ) { create :user }
before do
project . team << [ commiter , :developer ]
other_project . team << [ commiter , :developer ]
end
2013-05-30 19:16:49 -04:00
it 'detects issues that this commit is marked as closing' do
2017-07-20 05:34:09 -04:00
ext_ref = " #{ other_project . full_path } # #{ other_issue . iid } "
2016-03-17 16:39:50 -04:00
allow ( commit ) . to receive_messages (
safe_message : " Fixes # #{ issue . iid } and #{ ext_ref } " ,
committer_email : commiter . email
)
2015-11-30 16:43:54 -05:00
expect ( commit . closes_issues ) . to include ( issue )
expect ( commit . closes_issues ) . to include ( other_issue )
2014-10-03 01:48:35 -04:00
end
2013-05-30 19:16:49 -04:00
end
it_behaves_like 'a mentionable' do
2017-01-26 17:44:58 -05:00
subject { create ( :project , :repository ) . commit }
2015-04-16 16:25:25 -04:00
2015-10-12 10:23:15 -04:00
let ( :author ) { create ( :user , email : subject . author_email ) }
2015-12-01 06:58:45 -05:00
let ( :backref_text ) { " commit #{ subject . id } " }
2015-05-21 17:49:06 -04:00
let ( :set_mentionable_text ) do
- > ( txt ) { allow ( subject ) . to receive ( :safe_message ) . and_return ( txt ) }
end
2013-05-30 19:16:49 -04:00
# Include the subject in the repository stub.
let ( :extra_commits ) { [ subject ] }
end
2015-12-04 09:23:21 -05:00
describe '#hook_attrs' do
2015-12-07 08:13:06 -05:00
let ( :data ) { commit . hook_attrs ( with_changed_files : true ) }
2015-12-04 09:23:21 -05:00
it { expect ( data ) . to be_a ( Hash ) }
2016-10-03 08:11:16 -04:00
it { expect ( data [ :message ] ) . to include ( 'adds bar folder and branch-test text file to check Repository merged_to_root_ref method' ) }
2017-07-25 17:33:06 -04:00
it { expect ( data [ :timestamp ] ) . to eq ( '2016-09-27T14:37:46Z' ) }
2016-10-03 08:11:16 -04:00
it { expect ( data [ :added ] ) . to eq ( [ " bar/branch-test.txt " ] ) }
it { expect ( data [ :modified ] ) . to eq ( [ ] ) }
2015-12-04 09:23:21 -05:00
it { expect ( data [ :removed ] ) . to eq ( [ ] ) }
end
2016-02-22 09:46:39 -05:00
2017-08-16 07:18:07 -04:00
describe '#cherry_pick_message' do
2017-08-17 14:26:06 -04:00
let ( :user ) { create ( :user ) }
2017-08-16 07:18:07 -04:00
context 'of a regular commit' do
2017-08-17 14:26:06 -04:00
let ( :commit ) { project . commit ( 'video' ) }
it { expect ( commit . cherry_pick_message ( user ) ) . to include ( " \n \n (cherry picked from commit 88790590ed1337ab189bccaa355f068481c90bec) " ) }
2017-08-16 07:18:07 -04:00
end
context 'of a merge commit' do
2017-08-17 14:26:06 -04:00
let ( :repository ) { project . repository }
2017-08-21 15:05:11 -04:00
let ( :merge_request ) do
create ( :merge_request ,
source_branch : 'video' ,
target_branch : 'master' ,
source_project : project ,
author : user )
end
2017-08-17 14:26:06 -04:00
2017-08-21 15:05:11 -04:00
let ( :merge_commit ) do
2017-08-17 14:26:06 -04:00
merge_commit_id = repository . merge ( user ,
merge_request . diff_head_sha ,
merge_request ,
2017-09-08 08:00:53 -04:00
'Test message' )
2017-08-17 14:26:06 -04:00
2017-08-21 15:05:11 -04:00
repository . commit ( merge_commit_id )
end
2017-08-17 14:26:06 -04:00
2017-08-21 15:05:11 -04:00
context 'that is found' do
before do
# Artificially mark as completed.
merge_request . update ( merge_commit_sha : merge_commit . id )
end
2017-08-17 14:26:06 -04:00
2017-08-21 15:05:11 -04:00
it do
expected_appended_text = << ~ STR . rstrip
2017-08-17 14:26:06 -04:00
2017-08-21 15:05:11 -04:00
( cherry picked from commit #{merge_commit.sha})
2017-08-16 07:18:07 -04:00
2017-08-21 15:05:11 -04:00
467 dc98f Add new 'videos' directory
88790590 Upload new video file
STR
2017-08-16 07:18:07 -04:00
2017-08-21 15:05:11 -04:00
expect ( merge_commit . cherry_pick_message ( user ) ) . to include ( expected_appended_text )
end
end
2017-08-16 07:18:07 -04:00
2017-08-22 16:20:22 -04:00
context " that is existing but not found " do
it 'does not include details of the merged commits' do
2017-08-21 15:05:11 -04:00
expect ( merge_commit . cherry_pick_message ( user ) ) . to end_with ( " (cherry picked from commit #{ merge_commit . sha } ) " )
end
2017-08-16 07:18:07 -04:00
end
end
end
2016-02-22 09:46:39 -05:00
describe '#reverts_commit?' do
let ( :another_commit ) { double ( :commit , revert_description : " This reverts commit #{ commit . sha } " ) }
2016-11-29 08:47:43 -05:00
let ( :user ) { commit . author }
2016-02-22 09:46:39 -05:00
2016-11-29 08:47:43 -05:00
it { expect ( commit . reverts_commit? ( another_commit , user ) ) . to be_falsy }
2016-02-22 09:46:39 -05:00
context 'commit has no description' do
2017-06-14 14:18:56 -04:00
before do
allow ( commit ) . to receive ( :description? ) . and_return ( false )
end
2016-02-22 09:46:39 -05:00
2016-11-29 08:47:43 -05:00
it { expect ( commit . reverts_commit? ( another_commit , user ) ) . to be_falsy }
2016-02-22 09:46:39 -05:00
end
context " another_commit's description does not revert commit " do
2017-06-14 14:18:56 -04:00
before do
allow ( commit ) . to receive ( :description ) . and_return ( " Foo Bar " )
end
2016-02-22 09:46:39 -05:00
2016-11-29 08:47:43 -05:00
it { e xpect ( commit . reverts_commit? ( another_commit , user ) ) . to be_falsy }
2016-02-22 09:46:39 -05:00
end
context " another_commit's description reverts commit " do
2017-06-14 14:18:56 -04:00
before do
allow ( commit ) . to receive ( :description ) . and_return ( " Foo #{ another_commit . revert_description } Bar " )
end
2016-02-22 09:46:39 -05:00
2016-11-29 08:47:43 -05:00
it { expect ( commit . reverts_commit? ( another_commit , user ) ) . to be_truthy }
2016-02-22 09:46:39 -05:00
end
context " another_commit's description reverts merged merge request " do
before do
revert_description = " This reverts merge request !foo123 "
allow ( another_commit ) . to receive ( :revert_description ) . and_return ( revert_description )
allow ( commit ) . to receive ( :description ) . and_return ( " Foo #{ another_commit . revert_description } Bar " )
end
2016-11-29 08:47:43 -05:00
it { expect ( commit . reverts_commit? ( another_commit , user ) ) . to be_truthy }
2016-02-22 09:46:39 -05:00
end
end
2016-04-16 15:46:26 -04:00
2017-05-02 13:40:20 -04:00
describe '#last_pipeline' do
2017-03-15 20:44:31 -04:00
let! ( :first_pipeline ) do
create ( :ci_empty_pipeline ,
project : project ,
sha : commit . sha ,
status : 'success' )
end
let! ( :second_pipeline ) do
create ( :ci_empty_pipeline ,
project : project ,
sha : commit . sha ,
status : 'success' )
end
2017-05-02 13:40:20 -04:00
it 'returns last pipeline' do
expect ( commit . last_pipeline ) . to eq second_pipeline
2017-03-15 20:44:31 -04:00
end
end
2016-04-16 15:46:26 -04:00
describe '#status' do
2016-12-15 05:14:48 -05:00
context 'without ref argument' do
2016-11-07 10:44:11 -05:00
before do
2016-11-24 03:27:57 -05:00
%w[ success failed created pending ] . each do | status |
2016-11-07 10:44:11 -05:00
create ( :ci_empty_pipeline ,
project : project ,
sha : commit . sha ,
2016-11-24 03:27:57 -05:00
status : status )
2016-11-03 11:39:37 -04:00
end
end
2016-10-27 15:47:49 -04:00
2016-11-23 05:25:32 -05:00
it 'gives compound status from latest pipelines' do
2016-12-14 08:00:06 -05:00
expect ( commit . status ) . to eq ( Ci :: Pipeline . latest_status )
2016-12-15 05:52:36 -05:00
expect ( commit . status ) . to eq ( 'pending' )
2016-11-03 11:39:37 -04:00
end
2016-10-27 15:47:49 -04:00
end
2016-11-03 11:39:37 -04:00
context 'when a particular ref is specified' do
let! ( :pipeline_from_master ) do
create ( :ci_empty_pipeline ,
project : project ,
sha : commit . sha ,
ref : 'master' ,
status : 'failed' )
end
2016-10-27 15:47:49 -04:00
2016-11-03 11:39:37 -04:00
let! ( :pipeline_from_fix ) do
create ( :ci_empty_pipeline ,
project : project ,
sha : commit . sha ,
ref : 'fix' ,
status : 'success' )
end
2016-10-27 15:47:49 -04:00
2016-11-03 11:39:37 -04:00
it 'gives pipelines from a particular branch' do
expect ( commit . status ( 'master' ) ) . to eq ( pipeline_from_master . status )
expect ( commit . status ( 'fix' ) ) . to eq ( pipeline_from_fix . status )
end
2016-10-27 15:47:49 -04:00
2016-11-23 05:25:32 -05:00
it 'gives compound status from latest pipelines if ref is nil' do
2016-12-14 08:00:06 -05:00
expect ( commit . status ( nil ) ) . to eq ( Ci :: Pipeline . latest_status )
2016-12-15 05:52:36 -05:00
expect ( commit . status ( nil ) ) . to eq ( 'failed' )
2016-11-03 11:39:37 -04:00
end
2016-10-27 15:47:49 -04:00
end
2016-04-16 15:46:26 -04:00
end
2016-05-26 07:38:28 -04:00
describe '#participants' do
let ( :user1 ) { build ( :user ) }
let ( :user2 ) { build ( :user ) }
let! ( :note1 ) do
create ( :note_on_commit ,
commit_id : commit . id ,
project : project ,
note : 'foo' )
end
let! ( :note2 ) do
create ( :note_on_commit ,
commit_id : commit . id ,
project : project ,
note : 'bar' )
end
before do
allow ( commit ) . to receive ( :author ) . and_return ( user1 )
allow ( commit ) . to receive ( :committer ) . and_return ( user2 )
end
it 'includes the commit author' do
expect ( commit . participants ) . to include ( commit . author )
end
it 'includes the committer' do
expect ( commit . participants ) . to include ( commit . committer )
end
it 'includes the authors of the commit notes' do
expect ( commit . participants ) . to include ( note1 . author , note2 . author )
end
end
2016-06-21 10:53:16 -04:00
describe '#uri_type' do
it 'returns the URI type at the given path' do
expect ( commit . uri_type ( 'files/html' ) ) . to be ( :tree )
expect ( commit . uri_type ( 'files/images/logo-black.png' ) ) . to be ( :raw )
2016-07-25 11:08:36 -04:00
expect ( project . commit ( 'video' ) . uri_type ( 'files/videos/intro.mp4' ) ) . to be ( :raw )
2016-06-21 10:53:16 -04:00
expect ( commit . uri_type ( 'files/js/application.js' ) ) . to be ( :blob )
end
it " returns nil if the path doesn't exists " do
expect ( commit . uri_type ( 'this/path/doesnt/exist' ) ) . to be_nil
end
end
2016-11-24 09:07:44 -05:00
describe '.from_hash' do
let ( :new_commit ) { described_class . from_hash ( commit . to_hash , project ) }
it 'returns a Commit' do
expect ( new_commit ) . to be_an_instance_of ( described_class )
end
it 'wraps a Gitlab::Git::Commit' do
expect ( new_commit . raw ) . to be_an_instance_of ( Gitlab :: Git :: Commit )
end
it 'stores the correct commit fields' do
expect ( new_commit . id ) . to eq ( commit . id )
expect ( new_commit . message ) . to eq ( commit . message )
end
end
2016-12-15 15:48:26 -05:00
describe '#work_in_progress?' do
[ 'squash! ' , 'fixup! ' , 'wip: ' , 'WIP: ' , '[WIP] ' ] . each do | wip_prefix |
it " detects the ' #{ wip_prefix } ' prefix " do
commit . message = " #{ wip_prefix } #{ commit . message } "
expect ( commit ) . to be_work_in_progress
end
end
it " detects WIP for a commit just saying 'wip' " do
commit . message = " wip "
expect ( commit ) . to be_work_in_progress
end
it " doesn't detect WIP for a commit that begins with 'FIXUP! ' " do
commit . message = " FIXUP! #{ commit . message } "
expect ( commit ) . not_to be_work_in_progress
end
it " doesn't detect WIP for words starting with WIP " do
commit . message = " Wipout #{ commit . message } "
expect ( commit ) . not_to be_work_in_progress
end
end
2016-12-08 09:54:45 -05:00
describe '.valid_hash?' do
it 'checks hash contents' do
expect ( described_class . valid_hash? ( 'abcdef01239ABCDEF' ) ) . to be true
expect ( described_class . valid_hash? ( " abcdef01239ABCD \n EF " ) ) . to be false
expect ( described_class . valid_hash? ( ' abcdef01239ABCDEF ' ) ) . to be false
expect ( described_class . valid_hash? ( 'Gabcdef01239ABCDEF' ) ) . to be false
expect ( described_class . valid_hash? ( 'gabcdef01239ABCDEF' ) ) . to be false
expect ( described_class . valid_hash? ( '-abcdef01239ABCDEF' ) ) . to be false
end
it 'checks hash length' do
expect ( described_class . valid_hash? ( 'a' * 6 ) ) . to be false
expect ( described_class . valid_hash? ( 'a' * 7 ) ) . to be true
expect ( described_class . valid_hash? ( 'a' * 40 ) ) . to be true
expect ( described_class . valid_hash? ( 'a' * 41 ) ) . to be false
end
end
2012-10-02 18:57:13 -04:00
end