2019-07-07 11:18:12 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec . describe Commit do
2020-03-13 15:44:24 +05:30
let_it_be ( :project ) { create ( :project , :public , :repository ) }
let_it_be ( :personal_snippet ) { create ( :personal_snippet , :repository ) }
let_it_be ( :project_snippet ) { create ( :project_snippet , :repository ) }
2021-09-30 23:02:18 +05:30
2020-03-13 15:44:24 +05:30
let ( :commit ) { project . commit }
2015-09-11 14:41:01 +05:30
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 ) }
2019-02-02 18:00:53 +05:30
it { is_expected . to include_module ( Presentable ) }
2015-09-11 14:41:01 +05:30
end
2018-03-17 18:26:18 +05:30
describe '.lazy' do
2020-03-13 15:44:24 +05:30
shared_examples '.lazy checks' do
context 'when the commits are found' do
let ( :oids ) do
%w(
498214 de67004b1da3d820901307bed2a68a8ef6
c642fe9b8b9f28f9225d7ea953fe14e74748d53b
6 f6d7e7ed97bb5f0054f2b1df789b39ca89b6ff9
04 8721 d90c449b244b7b4c53a9186b04330174ec
281 d3a76f31c812dbf48abce82ccf6860adedd81
)
end
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
subject { oids . map { | oid | described_class . lazy ( container , oid ) } }
it 'batches requests for commits' do
expect ( container . repository ) . to receive ( :commits_by ) . once . and_call_original
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
subject . first . title
subject . last . title
end
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
it 'maintains ordering' do
subject . each_with_index do | commit , i |
expect ( commit . id ) . to eq ( oids [ i ] )
end
end
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
it 'does not attempt to replace methods via BatchLoader' do
subject . each do | commit |
expect ( commit ) . to receive ( :method_missing ) . and_call_original
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
commit . id
end
2018-03-17 18:26:18 +05:30
end
end
2019-09-04 21:01:54 +05:30
2020-03-13 15:44:24 +05:30
context 'when not found' do
it 'returns nil as commit' do
commit = described_class . lazy ( container , 'deadbeef' ) . __sync
2019-09-04 21:01:54 +05:30
2020-03-13 15:44:24 +05:30
expect ( commit ) . to be_nil
2019-09-04 21:01:54 +05:30
end
end
2018-03-17 18:26:18 +05:30
end
2020-03-13 15:44:24 +05:30
context 'with project' do
let ( :container ) { project }
it_behaves_like '.lazy checks'
end
context 'with personal snippet' do
let ( :container ) { personal_snippet }
it_behaves_like '.lazy checks'
end
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
context 'with project snippet' do
let ( :container ) { project_snippet }
it_behaves_like '.lazy checks'
end
end
2022-10-11 01:57:18 +05:30
describe '.build_from_sidekiq_hash' do
it 'returns a Commit' do
commit = described_class . build_from_sidekiq_hash ( project , id : '123' )
expect ( commit ) . to be_an_instance_of ( Commit )
end
it 'parses date strings into Time instances' do
commit = described_class . build_from_sidekiq_hash ( project ,
id : '123' ,
authored_date : Time . current . to_s )
expect ( commit . authored_date ) . to be_a_kind_of ( Time )
end
end
2020-03-13 15:44:24 +05:30
describe '#diff_refs' do
it 'is equal to itself' do
expect ( commit . diff_refs ) . to eq ( commit . diff_refs )
end
context 'from a factory' do
let ( :commit ) { create ( :commit ) }
it 'is equal to itself' do
expect ( commit . diff_refs ) . to eq ( commit . diff_refs )
2018-03-17 18:26:18 +05:30
end
end
end
2018-11-08 19:23:39 +05:30
describe '#author' , :request_store do
2016-09-13 17:45:13 +05:30
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
2018-11-08 19:23:39 +05:30
it 'caches the author' do
2016-09-13 17:45:13 +05:30
user = create ( :user , email : commit . author_email )
expect ( commit . author ) . to eq ( user )
2018-11-08 19:23:39 +05:30
2017-09-10 17:25:29 +05:30
key = " Commit:author: #{ commit . author_email . downcase } "
2016-09-13 17:45:13 +05:30
2018-12-05 23:21:45 +05:30
expect ( Gitlab :: SafeRequestStore [ key ] ) . to eq ( user )
2016-09-13 17:45:13 +05:30
expect ( commit . author ) . to eq ( user )
end
2018-11-08 19:23:39 +05:30
2020-01-01 13:55:28 +05:30
context 'with a user with an unconfirmed e-mail' do
before do
user = create ( :user )
create ( :email , user : user , email : commit . author_email )
end
it 'returns no user' do
expect ( commit . author ) . to be_nil
end
end
2018-11-08 19:23:39 +05:30
context 'using eager loading' do
let! ( :alice ) { create ( :user , email : 'alice@example.com' ) }
let! ( :bob ) { create ( :user , email : 'hunter2@example.com' ) }
2019-02-15 15:39:39 +05:30
let! ( :jeff ) { create ( :user ) }
2018-11-08 19:23:39 +05:30
let ( :alice_commit ) do
described_class . new ( RepoHelpers . sample_commit , project ) . tap do | c |
c . author_email = 'alice@example.com'
end
end
let ( :bob_commit ) do
# The commit for Bob uses one of his alternative Emails, instead of the
# primary one.
described_class . new ( RepoHelpers . sample_commit , project ) . tap do | c |
c . author_email = 'bob@example.com'
end
end
let ( :eve_commit ) do
described_class . new ( RepoHelpers . sample_commit , project ) . tap do | c |
c . author_email = 'eve@example.com'
end
end
2019-02-15 15:39:39 +05:30
let ( :jeff_commit ) do
# The commit for Jeff uses his private commit email
described_class . new ( RepoHelpers . sample_commit , project ) . tap do | c |
c . author_email = jeff . private_commit_email
end
end
let! ( :commits ) { [ alice_commit , bob_commit , eve_commit , jeff_commit ] }
2018-11-08 19:23:39 +05:30
before do
2020-01-01 13:55:28 +05:30
create ( :email , :confirmed , user : bob , email : 'bob@example.com' )
2018-11-08 19:23:39 +05:30
end
it 'executes only two SQL queries' do
recorder = ActiveRecord :: QueryRecorder . new do
# Running this first ensures we don't run one query for every
# commit.
commits . each ( & :lazy_author )
# This forces the execution of the SQL queries necessary to load the
# data.
commits . each { | c | c . author . try ( :id ) }
end
expect ( recorder . count ) . to eq ( 2 )
end
it " preloads the authors for Commits matching a user's primary Email " do
commits . each ( & :lazy_author )
expect ( alice_commit . author ) . to eq ( alice )
end
it " preloads the authors for Commits using a User's alternative Email " do
commits . each ( & :lazy_author )
expect ( bob_commit . author ) . to eq ( bob )
end
2019-02-15 15:39:39 +05:30
it " preloads the authors for Commits using a User's private commit Email " do
commits . each ( & :lazy_author )
expect ( jeff_commit . author ) . to eq ( jeff )
end
it " preloads the authors for Commits using a User's outdated private commit Email " do
jeff . update! ( username : 'new-username' )
commits . each ( & :lazy_author )
expect ( jeff_commit . author ) . to eq ( jeff )
end
2018-11-08 19:23:39 +05:30
it 'sets the author to Nil if an author could not be found for a Commit' do
commits . each ( & :lazy_author )
expect ( eve_commit . author ) . to be_nil
end
it 'does not execute SQL queries once the authors are preloaded' do
commits . each ( & :lazy_author )
commits . each { | c | c . author . try ( :id ) }
recorder = ActiveRecord :: QueryRecorder . new do
alice_commit . author
bob_commit . author
eve_commit . author
end
expect ( recorder . count ) . to be_zero
end
end
2016-09-13 17:45:13 +05:30
end
2020-01-01 13:55:28 +05:30
describe '#committer' do
2022-07-29 17:44:30 +05:30
context " when committer_email is the user's primary email " do
context 'when the user email is confirmed' do
let! ( :user ) { create ( :user , email : commit . committer_email ) }
2020-01-01 13:55:28 +05:30
2022-07-29 17:44:30 +05:30
it 'returns the user' do
expect ( commit . committer ) . to eq ( user )
expect ( commit . committer ( confirmed : false ) ) . to eq ( user )
end
2020-01-01 13:55:28 +05:30
end
2022-07-29 17:44:30 +05:30
context 'when the user email is unconfirmed' do
let! ( :user ) { create ( :user , :unconfirmed , email : commit . committer_email ) }
2020-01-01 13:55:28 +05:30
2022-07-29 17:44:30 +05:30
it 'returns the user according to confirmed argument' do
expect ( commit . committer ) . to be_nil
expect ( commit . committer ( confirmed : false ) ) . to eq ( user )
end
2020-01-01 13:55:28 +05:30
end
2022-07-29 17:44:30 +05:30
end
2020-01-01 13:55:28 +05:30
2022-07-29 17:44:30 +05:30
context " when committer_email is the user's secondary email " do
let! ( :user ) { create ( :user ) }
context 'when the user email is confirmed' do
let! ( :email ) { create ( :email , :confirmed , user : user , email : commit . committer_email ) }
it 'returns the user' do
expect ( commit . committer ) . to eq ( user )
expect ( commit . committer ( confirmed : false ) ) . to eq ( user )
end
2020-01-01 13:55:28 +05:30
end
2022-07-29 17:44:30 +05:30
context 'when the user email is unconfirmed' do
let! ( :email ) { create ( :email , user : user , email : commit . committer_email ) }
it 'does not return the user' do
expect ( commit . committer ) . to be_nil
expect ( commit . committer ( confirmed : false ) ) . to be_nil
end
2020-01-01 13:55:28 +05:30
end
end
end
2015-09-11 14:41:01 +05:30
describe '#to_reference' do
2020-03-13 15:44:24 +05:30
context 'with project' do
let ( :project ) { create ( :project , :repository , path : 'sample-project' ) }
it 'returns a String reference to the object' do
expect ( commit . to_reference ) . to eq commit . id
end
2017-08-17 22:00:37 +05:30
2020-03-13 15:44:24 +05:30
it 'supports a cross-project reference' do
another_project = build ( :project , :repository , name : 'another-project' , namespace : project . namespace )
expect ( commit . to_reference ( another_project ) ) . to eq " sample-project@ #{ commit . id } "
end
2015-09-11 14:41:01 +05:30
end
2020-03-13 15:44:24 +05:30
context 'with personal snippet' do
let ( :commit ) { personal_snippet . commit }
it 'returns a String reference to the object' do
expect ( commit . to_reference ) . to eq " $ #{ personal_snippet . id } @ #{ commit . id } "
end
it 'supports a cross-snippet reference' do
another_snippet = build ( :personal_snippet )
expect ( commit . to_reference ( another_snippet ) ) . to eq " $ #{ personal_snippet . id } @ #{ commit . id } "
end
end
context 'with project snippet' do
let ( :commit ) { project_snippet . commit }
it 'returns a String reference to the object' do
expect ( commit . to_reference ) . to eq " $ #{ project_snippet . id } @ #{ commit . id } "
end
it 'supports a cross-snippet project reference' do
another_snippet = build ( :personal_snippet )
expect ( commit . to_reference ( another_snippet ) ) . to eq " #{ project_snippet . project . path } $ #{ project_snippet . id } @ #{ commit . id } "
end
2015-09-11 14:41:01 +05:30
end
end
2014-09-02 18:07:02 +05:30
2019-12-04 20:38:33 +05:30
describe '.reference_valid?' do
using RSpec :: Parameterized :: TableSyntax
where ( :ref , :result ) do
'1234567' | true
'123456' | false
'1' | false
'0' * 40 | true
'c1acaa58bbcbc3eafe538cb8274ba387047b69f8' | true
'H1acaa58bbcbc3eafe538cb8274ba387047b69f8' | false
nil | false
end
with_them do
it { expect ( described_class . reference_valid? ( ref ) ) . to eq ( result ) }
end
end
2015-12-23 02:04:40 +05:30
describe '#reference_link_text' do
2017-08-17 22:00:37 +05:30
let ( :project ) { create ( :project , :repository , path : 'sample-project' ) }
2020-03-13 15:44:24 +05:30
context 'with project' do
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
another_project = build ( :project , :repository , name : 'another-project' , namespace : project . namespace )
expect ( commit . reference_link_text ( another_project ) ) . to eq " sample-project@ #{ commit . short_id } "
end
end
context 'with personal snippet' do
let ( :commit ) { personal_snippet . commit }
it 'returns a String reference to the object' do
expect ( commit . reference_link_text ) . to eq " $ #{ personal_snippet . id } @ #{ commit . short_id } "
end
it 'supports a cross-snippet reference' do
another_snippet = build ( :personal_snippet , :repository )
expect ( commit . reference_link_text ( another_snippet ) ) . to eq " $ #{ personal_snippet . id } @ #{ commit . short_id } "
end
2015-12-23 02:04:40 +05:30
end
2020-03-13 15:44:24 +05:30
context 'with project snippet' do
let ( :commit ) { project_snippet . commit }
it 'returns a String reference to the object' do
expect ( commit . reference_link_text ) . to eq " $ #{ project_snippet . id } @ #{ commit . short_id } "
end
it 'supports a cross-snippet project reference' do
another_snippet = build ( :project_snippet , :repository )
expect ( commit . reference_link_text ( another_snippet ) ) . to eq " #{ project_snippet . project . path } $ #{ project_snippet . id } @ #{ commit . short_id } "
end
2015-12-23 02:04:40 +05:30
end
end
2014-09-02 18:07:02 +05:30
describe '#title' do
it " returns no_commit_message when safe_message is blank " do
2015-04-26 12:48:37 +05:30
allow ( commit ) . to receive ( :safe_message ) . and_return ( '' )
2020-03-13 15:44:24 +05:30
expect ( commit . title ) . to eq ( " No commit message " )
2014-09-02 18:07:02 +05:30
end
2017-09-10 17:25:29 +05:30
it 'truncates a message without a newline at natural break to 80 characters' do
2014-09-02 18:07:02 +05:30
message = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id felis id blandit. Vivamus egestas lacinia lacus, sed rutrum mauris.'
2015-04-26 12:48:37 +05:30
allow ( commit ) . to receive ( :safe_message ) . and_return ( message )
2019-02-15 15:39:39 +05:30
expect ( commit . title ) . to eq ( 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id...' )
2014-09-02 18:07:02 +05:30
end
it " truncates a message with a newline before 80 characters at the newline " do
message = commit . safe_message . split ( " " ) . first
2015-04-26 12:48:37 +05:30
allow ( commit ) . to receive ( :safe_message ) . and_return ( message + " \n " + message )
expect ( commit . title ) . to eq ( message )
2014-09-02 18:07:02 +05:30
end
it " does not truncates a message with a newline after 80 but less 100 characters " do
2016-06-02 11:05:42 +05:30
message = <<eos
2014-09-02 18:07:02 +05:30
Lorem ipsum dolor sit amet , consectetur adipiscing elit . Donec sodales id felis id blandit .
Vivamus egestas lacinia lacus , sed rutrum mauris .
eos
2015-04-26 12:48:37 +05:30
allow ( commit ) . to receive ( :safe_message ) . and_return ( message )
expect ( commit . title ) . to eq ( message . split ( " \n " ) . first )
2014-09-02 18:07:02 +05:30
end
end
2016-09-13 17:45:13 +05:30
describe '#full_title' do
it " returns no_commit_message when safe_message is blank " do
allow ( commit ) . to receive ( :safe_message ) . and_return ( '' )
2020-03-13 15:44:24 +05:30
expect ( commit . full_title ) . to eq ( " No commit message " )
2016-09-13 17:45:13 +05:30
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
2021-03-11 19:13:27 +05:30
it 'truncates html representation if more than 1KiB' do
# Commit title is over 2KiB on a single line
huge_commit_title = ( 'panic ' * 350 ) + 'trailing text'
allow ( commit ) . to receive ( :safe_message ) . and_return ( huge_commit_title )
commit . refresh_markdown_cache
full_title_html = commit . full_title_html
expect ( full_title_html . bytesize ) . to be < 2 . kilobytes
expect ( full_title_html ) . not_to include ( 'trailing text' )
end
2016-09-13 17:45:13 +05:30
end
2017-09-10 17:25:29 +05:30
describe 'description' do
2018-11-20 20:47:30 +05:30
it 'returns no_commit_message when safe_message is blank' do
allow ( commit ) . to receive ( :safe_message ) . and_return ( nil )
2020-03-13 15:44:24 +05:30
expect ( commit . description ) . to eq ( 'No commit message' )
2018-11-20 20:47:30 +05:30
end
2017-09-10 17:25:29 +05:30
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
2021-03-08 18:12:59 +05:30
it 'truncates html representation if more than 1Mib' do
# Commit message is over 2MiB
huge_commit_message = [ 'panic' , ( 'panic ' * 350000 ) , 'trailing text' ] . join ( " \n " )
allow ( commit ) . to receive ( :safe_message ) . and_return ( huge_commit_message )
commit . refresh_markdown_cache
description_html = commit . description_html
expect ( description_html . bytesize ) . to be < 2 . megabytes
expect ( description_html ) . not_to include ( 'trailing text' )
end
2017-09-10 17:25:29 +05:30
end
2014-09-02 18:07:02 +05:30
describe " delegation " do
subject { commit }
2015-04-26 12:48:37 +05:30
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 ( :id ) }
2014-09-02 18:07:02 +05:30
end
it_behaves_like 'a mentionable' do
2021-09-04 01:27:46 +05:30
subject ( :commit ) { create ( :project , :repository ) . commit }
2015-09-11 14:41:01 +05:30
2015-10-24 18:46:33 +05:30
let ( :author ) { create ( :user , email : subject . author_email ) }
2015-04-26 12:48:37 +05:30
let ( :backref_text ) { " commit #{ subject . id } " }
2015-09-11 14:41:01 +05:30
let ( :set_mentionable_text ) do
2021-09-04 01:27:46 +05:30
- > ( txt ) { allow ( commit ) . to receive ( :safe_message ) . and_return ( txt ) }
2015-09-11 14:41:01 +05:30
end
2014-09-02 18:07:02 +05:30
# Include the subject in the repository stub.
2021-09-04 01:27:46 +05:30
let ( :extra_commits ) { [ commit ] }
it 'uses the CachedMarkdownField cache instead of the Mentionable cache' , :use_clean_rails_redis_caching do
expect ( commit . title_html ) . not_to be_present
2022-04-04 11:22:00 +05:30
commit . all_references ( project . first_owner ) . all
2021-09-04 01:27:46 +05:30
expect ( commit . title_html ) . to be_present
expect ( Rails . cache . read ( " banzai/commit: #{ commit . id } /safe_message/single_line " ) ) . to be_nil
end
2014-09-02 18:07:02 +05:30
end
2015-12-23 02:04:40 +05:30
describe '#hook_attrs' do
let ( :data ) { commit . hook_attrs ( with_changed_files : true ) }
it { expect ( data ) . to be_a ( Hash ) }
2016-11-03 12:29:30 +05:30
it { expect ( data [ :message ] ) . to include ( 'adds bar folder and branch-test text file to check Repository merged_to_root_ref method' ) }
2020-01-01 13:55:28 +05:30
it { expect ( data [ :timestamp ] ) . to eq ( '2016-09-27T14:37:46+00:00' ) }
2018-03-17 18:26:18 +05:30
it { expect ( data [ :added ] ) . to contain_exactly ( " bar/branch-test.txt " ) }
2016-11-03 12:29:30 +05:30
it { expect ( data [ :modified ] ) . to eq ( [ ] ) }
2015-12-23 02:04:40 +05:30
it { expect ( data [ :removed ] ) . to eq ( [ ] ) }
end
2016-04-02 18:10:28 +05:30
2018-03-17 18:26:18 +05:30
describe '#cherry_pick_message' do
let ( :user ) { create ( :user ) }
context 'of a regular commit' do
let ( :commit ) { project . commit ( 'video' ) }
it { expect ( commit . cherry_pick_message ( user ) ) . to include ( " \n \n (cherry picked from commit 88790590ed1337ab189bccaa355f068481c90bec) " ) }
end
context 'of a merge commit' do
let ( :repository ) { project . repository }
let ( :merge_request ) do
create ( :merge_request ,
source_branch : 'video' ,
target_branch : 'master' ,
source_project : project ,
author : user )
end
let ( :merge_commit ) do
merge_commit_id = repository . merge ( user ,
merge_request . diff_head_sha ,
merge_request ,
'Test message' )
repository . commit ( merge_commit_id )
end
context 'that is found' do
before do
# Artificially mark as completed.
2021-04-29 21:17:54 +05:30
merge_request . update! ( merge_commit_sha : merge_commit . id )
2018-03-17 18:26:18 +05:30
end
it do
expected_appended_text = << ~ STR . rstrip
( cherry picked from commit #{merge_commit.sha})
467 dc98f Add new 'videos' directory
88790590 Upload new video file
STR
expect ( merge_commit . cherry_pick_message ( user ) ) . to include ( expected_appended_text )
end
end
context " that is existing but not found " do
it 'does not include details of the merged commits' do
expect ( merge_commit . cherry_pick_message ( user ) ) . to end_with ( " (cherry picked from commit #{ merge_commit . sha } ) " )
end
end
end
end
2016-04-02 18:10:28 +05:30
describe '#reverts_commit?' do
let ( :another_commit ) { double ( :commit , revert_description : " This reverts commit #{ commit . sha } " ) }
2017-01-15 13:20:01 +05:30
let ( :user ) { commit . author }
2016-04-02 18:10:28 +05:30
2017-01-15 13:20:01 +05:30
it { expect ( commit . reverts_commit? ( another_commit , user ) ) . to be_falsy }
2016-04-02 18:10:28 +05:30
context 'commit has no description' do
2017-09-10 17:25:29 +05:30
before do
allow ( commit ) . to receive ( :description? ) . and_return ( false )
end
2016-04-02 18:10:28 +05:30
2017-01-15 13:20:01 +05:30
it { expect ( commit . reverts_commit? ( another_commit , user ) ) . to be_falsy }
2016-04-02 18:10:28 +05:30
end
context " another_commit's description does not revert commit " do
2017-09-10 17:25:29 +05:30
before do
allow ( commit ) . to receive ( :description ) . and_return ( " Foo Bar " )
end
2016-04-02 18:10:28 +05:30
2017-01-15 13:20:01 +05:30
it { expect ( commit . reverts_commit? ( another_commit , user ) ) . to be_falsy }
2016-04-02 18:10:28 +05:30
end
context " another_commit's description reverts commit " do
2017-09-10 17:25:29 +05:30
before do
allow ( commit ) . to receive ( :description ) . and_return ( " Foo #{ another_commit . revert_description } Bar " )
end
2016-04-02 18:10:28 +05:30
2017-01-15 13:20:01 +05:30
it { expect ( commit . reverts_commit? ( another_commit , user ) ) . to be_truthy }
2016-04-02 18:10:28 +05:30
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
2017-01-15 13:20:01 +05:30
it { expect ( commit . reverts_commit? ( another_commit , user ) ) . to be_truthy }
2016-04-02 18:10:28 +05:30
end
end
2016-06-02 11:05:42 +05:30
2016-06-16 23:09:34 +05:30
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-22 15:30:34 +05:30
2019-05-03 19:53:19 +05:30
shared_examples '#uri_type' do
2018-11-08 19:23:39 +05:30
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 )
2019-10-12 21:52:04 +05:30
expect ( commit . uri_type ( 'files/images/wm.svg' ) ) . to be ( :raw )
2019-12-21 20:55:43 +05:30
expect ( project . commit ( 'audio' ) . uri_type ( 'files/audio/clip.mp3' ) ) . to be ( :raw )
expect ( project . commit ( 'audio' ) . uri_type ( 'files/audio/sample.wav' ) ) . to be ( :raw )
2018-11-08 19:23:39 +05:30
expect ( project . commit ( 'video' ) . uri_type ( 'files/videos/intro.mp4' ) ) . to be ( :raw )
expect ( commit . uri_type ( 'files/js/application.js' ) ) . to be ( :blob )
2016-06-22 15:30:34 +05:30
end
2018-11-08 19:23:39 +05:30
it " returns nil if the path doesn't exists " do
expect ( commit . uri_type ( 'this/path/doesnt/exist' ) ) . to be_nil
expect ( commit . uri_type ( '../path/doesnt/exist' ) ) . to be_nil
2018-03-17 18:26:18 +05:30
end
2018-11-08 19:23:39 +05:30
it 'is nil if the path is nil or empty' do
expect ( commit . uri_type ( nil ) ) . to be_nil
expect ( commit . uri_type ( " " ) ) . to be_nil
2016-06-22 15:30:34 +05:30
end
end
2017-08-17 22:00:37 +05:30
2019-05-03 19:53:19 +05:30
describe '#uri_type with Gitaly enabled' do
it_behaves_like " # uri_type "
end
describe '#uri_type with Rugged enabled' , :enable_rugged do
it 'calls out to the Rugged implementation' do
allow_any_instance_of ( Rugged :: Tree ) . to receive ( :path ) . with ( 'files/html' ) . and_call_original
commit . uri_type ( 'files/html' )
end
it_behaves_like '#uri_type'
end
2021-09-04 01:27:46 +05:30
describe '.diff_max_files' do
subject ( :diff_max_files ) { described_class . diff_max_files }
2022-01-26 12:08:38 +05:30
it 'returns the current settings' do
Gitlab :: CurrentSettings . update! ( diff_max_files : 1234 )
expect ( diff_max_files ) . to eq ( 1234 )
2021-09-04 01:27:46 +05:30
end
end
describe '.diff_max_lines' do
subject ( :diff_max_lines ) { described_class . diff_max_lines }
2022-01-26 12:08:38 +05:30
it 'returns the current settings' do
Gitlab :: CurrentSettings . update! ( diff_max_lines : 65321 )
expect ( diff_max_lines ) . to eq ( 65321 )
2021-09-04 01:27:46 +05:30
end
end
describe '.diff_safe_max_files' do
subject ( :diff_safe_max_files ) { described_class . diff_safe_max_files }
it 'returns the commit diff max divided by the limit factor of 10' do
expect ( :: Commit ) . to receive ( :diff_max_files ) . and_return ( 10 )
expect ( diff_safe_max_files ) . to eq ( 1 )
end
end
describe '.diff_safe_max_lines' do
subject ( :diff_safe_max_lines ) { described_class . diff_safe_max_lines }
it 'returns the commit diff max divided by the limit factor of 10' do
expect ( :: Commit ) . to receive ( :diff_max_lines ) . and_return ( 100 )
expect ( diff_safe_max_lines ) . to eq ( 10 )
end
end
2017-08-17 22:00:37 +05:30
describe '.from_hash' do
2020-03-13 15:44:24 +05:30
subject { described_class . from_hash ( commit . to_hash , container ) }
shared_examples 'returns Commit' do
it 'returns a Commit' do
expect ( subject ) . to be_an_instance_of ( described_class )
end
it 'wraps a Gitlab::Git::Commit' do
expect ( subject . raw ) . to be_an_instance_of ( Gitlab :: Git :: Commit )
end
2017-08-17 22:00:37 +05:30
2020-03-13 15:44:24 +05:30
it 'stores the correct commit fields' do
expect ( subject . id ) . to eq ( commit . id )
expect ( subject . message ) . to eq ( commit . message )
end
2017-08-17 22:00:37 +05:30
end
2020-03-13 15:44:24 +05:30
context 'with project' do
let ( :container ) { project }
it_behaves_like 'returns Commit'
2017-08-17 22:00:37 +05:30
end
2020-03-13 15:44:24 +05:30
context 'with personal snippet' do
let ( :container ) { personal_snippet }
it_behaves_like 'returns Commit'
end
context 'with project snippet' do
let ( :container ) { project_snippet }
it_behaves_like 'returns Commit'
2017-08-17 22:00:37 +05:30
end
end
2022-07-23 23:45:48 +05:30
describe '#draft?' do
2020-07-28 23:09:34 +05:30
[
2022-04-04 11:22:00 +05:30
'squash! ' , 'fixup! ' ,
2021-11-18 22:05:49 +05:30
'draft: ' , '[Draft] ' , '(draft) ' , 'Draft: '
2022-04-04 11:22:00 +05:30
] . each do | draft_prefix |
it " detects the ' #{ draft_prefix } ' prefix " do
commit . message = " #{ draft_prefix } #{ commit . message } "
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
expect ( commit ) . to be_draft
2017-08-17 22:00:37 +05:30
end
end
2022-07-23 23:45:48 +05:30
it " does not detect a commit just saying 'draft' as draft? == true " do
2020-07-28 23:09:34 +05:30
commit . message = " draft "
2022-07-23 23:45:48 +05:30
expect ( commit ) . not_to be_draft
2017-08-17 22:00:37 +05:30
end
2022-04-04 11:22:00 +05:30
[ " FIXUP! " , " Draft - " , " Wipeout " , " WIP: " , " [WIP] " , " wip: " ] . each do | draft_prefix |
2021-11-18 22:05:49 +05:30
it " doesn't detect ' #{ draft_prefix } ' at the start of the title as a draft " do
commit . message = " #{ draft_prefix } #{ commit . message } "
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
expect ( commit ) . not_to be_draft
2021-11-18 22:05:49 +05:30
end
2017-08-17 22:00:37 +05:30
end
end
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
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
describe 'signed commits' do
let ( :gpg_signed_commit ) { project . commit_by ( oid : '0b4bc9a49b562e85de7cc9e834518ea6828729b9' ) }
let ( :x509_signed_commit ) { project . commit_by ( oid : '189a6c924013fc3fe40d6f1ec1dc20214183bc97' ) }
2023-03-04 22:38:38 +05:30
let ( :ssh_signed_commit ) { project . commit_by ( oid : '7b5160f9bb23a3d58a0accdbe89da13b96b1ece9' ) }
2020-03-13 15:44:24 +05:30
let ( :unsigned_commit ) { project . commit_by ( oid : '54fcc214b94e78d7a41a9a8fe6d87a5e59500e51' ) }
let! ( :commit ) { create ( :commit , project : project ) }
it 'returns signature_type properly' do
expect ( gpg_signed_commit . signature_type ) . to eq ( :PGP )
expect ( x509_signed_commit . signature_type ) . to eq ( :X509 )
2023-03-04 22:38:38 +05:30
expect ( ssh_signed_commit . signature_type ) . to eq ( :SSH )
2020-03-13 15:44:24 +05:30
expect ( unsigned_commit . signature_type ) . to eq ( :NONE )
expect ( commit . signature_type ) . to eq ( :NONE )
end
it 'returns has_signature? properly' do
expect ( gpg_signed_commit . has_signature? ) . to be_truthy
expect ( x509_signed_commit . has_signature? ) . to be_truthy
2023-03-04 22:38:38 +05:30
expect ( ssh_signed_commit . has_signature? ) . to be_truthy
2020-03-13 15:44:24 +05:30
expect ( unsigned_commit . has_signature? ) . to be_falsey
expect ( commit . has_signature? ) . to be_falsey
end
2023-03-04 22:38:38 +05:30
context 'when feature flag "ssh_commit_signatures" is disabled' do
before do
stub_feature_flags ( ssh_commit_signatures : false )
end
it 'reports no signature' do
expect ( ssh_signed_commit ) . not_to have_signature
end
it 'does not return signature data' do
expect ( ssh_signed_commit . signature ) . to be_nil
end
end
2018-03-17 18:26:18 +05:30
end
2020-04-08 14:13:33 +05:30
describe '#has_been_reverted?' do
let ( :user ) { create ( :user ) }
let ( :issue ) { create ( :issue , author : user , project : project ) }
it 'returns true if the commit has been reverted' do
create ( :note_on_issue ,
noteable : issue ,
system : true ,
note : commit . revert_description ( user ) ,
project : issue . project )
expect_next_instance_of ( Commit ) do | revert_commit |
expect ( revert_commit ) . to receive ( :reverts_commit? )
. with ( commit , user )
. and_return ( true )
end
expect ( commit . has_been_reverted? ( user , issue . notes_with_associations ) ) . to eq ( true )
end
it 'returns false if the commit has not been reverted' do
expect ( commit . has_been_reverted? ( user , issue . notes_with_associations ) ) . to eq ( false )
end
end
2014-09-02 18:07:02 +05:30
end