diff_spec.rb 9.68 KB
Newer Older
Robert Speicher's avatar
Robert Speicher committed
1 2
require "spec_helper"

3
describe Gitlab::Git::Diff, :seed_helper do
4
  let(:repository) { Gitlab::Git::Repository.new('default', TEST_REPO_PATH, '') }
5 6 7 8 9 10 11 12 13 14 15 16 17 18
  let(:gitaly_diff) do
    Gitlab::GitalyClient::Diff.new(
      from_path: '.gitmodules',
      to_path: '.gitmodules',
      old_mode: 0100644,
      new_mode: 0100644,
      from_id: '0792c58905eff3432b721f8c4a64363d8e28d9ae',
      to_id: 'efd587ccb47caf5f31fc954edb21f0a713d9ecc3',
      overflow_marker: false,
      collapsed: false,
      too_large: false,
      patch: "@@ -4,3 +4,6 @@\n [submodule \"gitlab-shell\"]\n \tpath = gitlab-shell\n \turl = https://github.com/gitlabhq/gitlab-shell.git\n+[submodule \"gitlab-grack\"]\n+\tpath = gitlab-grack\n+\turl = https://gitlab.com/gitlab-org/gitlab-grack.git\n"
    )
  end
Robert Speicher's avatar
Robert Speicher committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

  before do
    @raw_diff_hash = {
      diff: <<EOT.gsub(/^ {8}/, "").sub(/\n$/, ""),
        @@ -4,3 +4,6 @@
         [submodule "gitlab-shell"]
         \tpath = gitlab-shell
         \turl = https://github.com/gitlabhq/gitlab-shell.git
        +[submodule "gitlab-grack"]
        +	path = gitlab-grack
        +	url = https://gitlab.com/gitlab-org/gitlab-grack.git

EOT
      new_path: ".gitmodules",
      old_path: ".gitmodules",
      a_mode: '100644',
      b_mode: '100644',
      new_file: false,
      renamed_file: false,
      deleted_file: false,
      too_large: false
    }
  end

  describe '.new' do
    context 'using a Hash' do
      context 'with a small diff' do
        let(:diff) { described_class.new(@raw_diff_hash) }

        it 'initializes the diff' do
          expect(diff.to_hash).to eq(@raw_diff_hash)
        end

        it 'does not prune the diff' do
          expect(diff).not_to be_too_large
        end
      end

      context 'using a diff that is too large' do
        it 'prunes the diff' do
59
          diff = described_class.new(diff: 'a' * 204800)
Robert Speicher's avatar
Robert Speicher committed
60 61 62 63 64 65 66 67 68

          expect(diff.diff).to be_empty
          expect(diff).to be_too_large
        end
      end
    end

    context 'using a Rugged::Patch' do
      context 'with a small diff' do
69
        let(:diff) { described_class.new(gitaly_diff) }
Robert Speicher's avatar
Robert Speicher committed
70 71

        it 'initializes the diff' do
72
          expect(diff.to_hash).to eq(@raw_diff_hash)
Robert Speicher's avatar
Robert Speicher committed
73 74 75 76 77 78 79 80 81
        end

        it 'does not prune the diff' do
          expect(diff).not_to be_too_large
        end
      end

      context 'using a diff that is too large' do
        it 'prunes the diff' do
82 83
          gitaly_diff.too_large = true
          diff = described_class.new(gitaly_diff)
Robert Speicher's avatar
Robert Speicher committed
84 85 86 87 88 89 90 91

          expect(diff.diff).to be_empty
          expect(diff).to be_too_large
        end
      end

      context 'using a collapsable diff that is too large' do
        it 'prunes the diff as a large diff instead of as a collapsed diff' do
92 93
          gitaly_diff.too_large = true
          diff = described_class.new(gitaly_diff, expanded: false)
Robert Speicher's avatar
Robert Speicher committed
94 95 96 97 98 99 100

          expect(diff.diff).to be_empty
          expect(diff).to be_too_large
          expect(diff).not_to be_collapsed
        end
      end
    end
101

102
    context 'using a GitalyClient::Diff' do
103 104
      let(:diff) do
        described_class.new(
105
          Gitlab::GitalyClient::Diff.new(
106 107 108 109 110 111
            to_path: ".gitmodules",
            from_path: ".gitmodules",
            old_mode: 0100644,
            new_mode: 0100644,
            from_id: '357406f3075a57708d0163752905cc1576fceacc',
            to_id: '8e5177d718c561d36efde08bad36b43687ee6bf0',
112
            patch: raw_patch
113 114 115 116 117
          )
        )
      end

      context 'with a small diff' do
118
        let(:raw_patch) { @raw_diff_hash[:diff] }
119 120 121 122 123 124 125 126 127 128 129

        it 'initializes the diff' do
          expect(diff.to_hash).to eq(@raw_diff_hash)
        end

        it 'does not prune the diff' do
          expect(diff).not_to be_too_large
        end
      end

      context 'using a diff that is too large' do
130
        let(:raw_patch) { 'a' * 204800 }
131 132 133 134 135 136

        it 'prunes the diff' do
          expect(diff.diff).to be_empty
          expect(diff).to be_too_large
        end
      end
137 138 139 140 141

      context 'when the patch passed is not UTF-8-encoded' do
        let(:raw_patch) { @raw_diff_hash[:diff].encode(Encoding::ASCII_8BIT) }

        it 'encodes diff patch to UTF-8' do
Jacob Vosmaer's avatar
Jacob Vosmaer committed
142
          expect(diff.diff).to be_utf8
143 144
        end
      end
145
    end
Robert Speicher's avatar
Robert Speicher committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
  end

  describe 'straight diffs' do
    let(:options) { { straight: true } }
    let(:diffs) { described_class.between(repository, 'feature', 'master', options) }

    it 'has the correct size' do
      expect(diffs.size).to eq(24)
    end

    context 'diff' do
      it 'is an instance of Diff' do
        expect(diffs.first).to be_kind_of(described_class)
      end

      it 'has the correct new_path' do
        expect(diffs.first.new_path).to eq('.DS_Store')
      end

      it 'has the correct diff' do
        expect(diffs.first.diff).to include('Binary files /dev/null and b/.DS_Store differ')
      end
    end
  end

  describe '.between' do
    let(:diffs) { described_class.between(repository, 'feature', 'master') }
    subject { diffs }

    it { is_expected.to be_kind_of Gitlab::Git::DiffCollection }

    describe '#size' do
      subject { super().size }

      it { is_expected.to eq(1) }
    end

    context 'diff' do
      subject { diffs.first }

      it { is_expected.to be_kind_of described_class }

      describe '#new_path' do
        subject { super().new_path }

        it { is_expected.to eq('files/ruby/feature.rb') }
      end

      describe '#diff' do
        subject { super().diff }

        it { is_expected.to include '+class Feature' }
      end
    end
  end

  describe '.filter_diff_options' do
203
    let(:options) { { max_files: 100, invalid_opt: true } }
Robert Speicher's avatar
Robert Speicher committed
204 205 206 207 208 209 210 211 212 213 214

    context "without default options" do
      let(:filtered_options) { described_class.filter_diff_options(options) }

      it "should filter invalid options" do
        expect(filtered_options).not_to have_key(:invalid_opt)
      end
    end

    context "with default options" do
      let(:filtered_options) do
215
        default_options = { max_files: 5, bad_opt: 1, ignore_whitespace_change: true }
Robert Speicher's avatar
Robert Speicher committed
216 217 218 219 220 221 222 223 224
        described_class.filter_diff_options(options, default_options)
      end

      it "should filter invalid options" do
        expect(filtered_options).not_to have_key(:invalid_opt)
        expect(filtered_options).not_to have_key(:bad_opt)
      end

      it "should merge with default options" do
225
        expect(filtered_options).to have_key(:ignore_whitespace_change)
Robert Speicher's avatar
Robert Speicher committed
226 227 228
      end

      it "should override default options" do
229 230
        expect(filtered_options).to have_key(:max_files)
        expect(filtered_options[:max_files]).to eq(100)
Robert Speicher's avatar
Robert Speicher committed
231 232 233 234
      end
    end
  end

235
  describe '#json_safe_diff' do
micael.bergeron's avatar
micael.bergeron committed
236 237 238 239 240 241 242 243 244 245 246 247
    let(:project) { create(:project, :repository) }

    it 'fake binary message when it detects binary' do
      # Rugged will not detect this as binary, but we can fake it
      diff_message = "Binary files files/images/icn-time-tracking.pdf and files/images/icn-time-tracking.pdf differ\n"
      binary_diff = described_class.between(project.repository, 'add-pdf-text-binary', 'add-pdf-text-binary^').first

      expect(binary_diff.diff).not_to be_empty
      expect(binary_diff.json_safe_diff).to eq(diff_message)
    end

    it 'leave non-binary diffs as-is' do
248
      diff = described_class.new(gitaly_diff)
micael.bergeron's avatar
micael.bergeron committed
249 250 251 252 253

      expect(diff.json_safe_diff).to eq(diff.diff)
    end
  end

Robert Speicher's avatar
Robert Speicher committed
254
  describe '#submodule?' do
255 256 257 258 259 260 261 262 263 264 265 266 267
    let(:gitaly_submodule_diff) do
      Gitlab::GitalyClient::Diff.new(
        from_path: 'gitlab-grack',
        to_path: 'gitlab-grack',
        old_mode: 0,
        new_mode: 57344,
        from_id: '0000000000000000000000000000000000000000',
        to_id: '645f6c4c82fd3f5e06f67134450a570b795e55a6',
        overflow_marker: false,
        collapsed: false,
        too_large: false,
        patch: "@@ -0,0 +1 @@\n+Subproject commit 645f6c4c82fd3f5e06f67134450a570b795e55a6\n"
      )
Robert Speicher's avatar
Robert Speicher committed
268 269
    end

270 271
    it { expect(described_class.new(gitaly_diff).submodule?).to eq(false) }
    it { expect(described_class.new(gitaly_submodule_diff).submodule?).to eq(true) }
Robert Speicher's avatar
Robert Speicher committed
272 273 274 275
  end

  describe '#line_count' do
    it 'returns the correct number of lines' do
276
      diff = described_class.new(gitaly_diff)
Robert Speicher's avatar
Robert Speicher committed
277

278
      expect(diff.line_count).to eq(7)
Robert Speicher's avatar
Robert Speicher committed
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
    end
  end

  describe '#too_large?' do
    it 'returns true for a diff that is too large' do
      diff = described_class.new(diff: 'a' * 204800)

      expect(diff.too_large?).to eq(true)
    end

    it 'returns false for a diff that is small enough' do
      diff = described_class.new(diff: 'a')

      expect(diff.too_large?).to eq(false)
    end

    it 'returns true for a diff that was explicitly marked as being too large' do
      diff = described_class.new(diff: 'a')

298
      diff.too_large!
Robert Speicher's avatar
Robert Speicher committed
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319

      expect(diff.too_large?).to eq(true)
    end
  end

  describe '#collapsed?' do
    it 'returns false by default even on quite big diff' do
      diff = described_class.new(diff: 'a' * 20480)

      expect(diff).not_to be_collapsed
    end

    it 'returns false by default for a diff that is small enough' do
      diff = described_class.new(diff: 'a')

      expect(diff).not_to be_collapsed
    end

    it 'returns true for a diff that was explicitly marked as being collapsed' do
      diff = described_class.new(diff: 'a')

320
      diff.collapse!
Robert Speicher's avatar
Robert Speicher committed
321 322 323 324 325

      expect(diff).to be_collapsed
    end
  end

326
  describe '#collapsed?' do
Robert Speicher's avatar
Robert Speicher committed
327
    it 'returns true for a diff that is quite large' do
328
      diff = described_class.new({ diff: 'a' * 20480 }, expanded: false)
Robert Speicher's avatar
Robert Speicher committed
329

Douwe Maan's avatar
Douwe Maan committed
330
      expect(diff).to be_collapsed
Robert Speicher's avatar
Robert Speicher committed
331 332 333
    end

    it 'returns false for a diff that is small enough' do
Douwe Maan's avatar
Douwe Maan committed
334
      diff = described_class.new({ diff: 'a' }, expanded: false)
Robert Speicher's avatar
Robert Speicher committed
335

Douwe Maan's avatar
Douwe Maan committed
336
      expect(diff).not_to be_collapsed
Robert Speicher's avatar
Robert Speicher committed
337 338 339
    end
  end

340
  describe '#collapse!' do
Robert Speicher's avatar
Robert Speicher committed
341 342 343
    it 'prunes the diff' do
      diff = described_class.new(diff: "foo\nbar")

344
      diff.collapse!
Robert Speicher's avatar
Robert Speicher committed
345 346 347 348 349 350

      expect(diff.diff).to eq('')
      expect(diff.line_count).to eq(0)
    end
  end
end