diff_spec.rb 9.95 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, '') }
Robert Speicher's avatar
Robert Speicher committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

  before do
    @raw_diff_hash = {
      diff: <<EOT.gsub(/^ {8}/, "").sub(/\n$/, ""),
        --- a/.gitmodules
        +++ b/.gitmodules
        @@ -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
    }

30
    # TODO use a Gitaly diff object instead
31 32 33 34
    @rugged_diff = Gitlab::GitalyClient::StorageSettings.allow_disk_access do
      repository.rugged.diff("5937ac0a7beb003549fc5fd26fc247adbce4a52e^", "5937ac0a7beb003549fc5fd26fc247adbce4a52e", paths:
                                              [".gitmodules"]).patches.first
    end
Robert Speicher's avatar
Robert Speicher committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
  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
53
          diff = described_class.new(diff: 'a' * 204800)
Robert Speicher's avatar
Robert Speicher committed
54 55 56 57 58 59 60 61 62 63 64 65

          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
        let(:diff) { described_class.new(@rugged_diff) }

        it 'initializes the diff' do
66
          expect(diff.to_hash).to eq(@raw_diff_hash)
Robert Speicher's avatar
Robert Speicher committed
67 68 69 70 71 72 73 74 75
        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
76 77
          expect_any_instance_of(String).to receive(:bytesize)
            .and_return(1024 * 1024 * 1024)
Robert Speicher's avatar
Robert Speicher committed
78 79 80 81 82 83 84 85 86 87 88 89 90

          diff = described_class.new(@rugged_diff)

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

      context 'using a collapsable diff that is too large' do
        before do
          # The patch total size is 200, with lines between 21 and 54.
          # This is a quick-and-dirty way to test this. Ideally, a new patch is
          # added to the test repo with a size that falls between the real limits.
91 92
          stub_const("#{described_class}::SIZE_LIMIT", 150)
          stub_const("#{described_class}::COLLAPSE_LIMIT", 100)
Robert Speicher's avatar
Robert Speicher committed
93 94 95
        end

        it 'prunes the diff as a large diff instead of as a collapsed diff' do
Douwe Maan's avatar
Douwe Maan committed
96
          diff = described_class.new(@rugged_diff, expanded: false)
Robert Speicher's avatar
Robert Speicher committed
97 98 99 100 101 102 103 104 105

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

      context 'using a large binary diff' do
        it 'does not prune the diff' do
106 107
          expect_any_instance_of(Rugged::Diff::Delta).to receive(:binary?)
            .and_return(true)
Robert Speicher's avatar
Robert Speicher committed
108 109 110 111 112 113 114

          diff = described_class.new(@rugged_diff)

          expect(diff.diff).not_to be_empty
        end
      end
    end
115

116
    context 'using a GitalyClient::Diff' do
117 118
      let(:diff) do
        described_class.new(
119
          Gitlab::GitalyClient::Diff.new(
120 121 122 123 124 125
            to_path: ".gitmodules",
            from_path: ".gitmodules",
            old_mode: 0100644,
            new_mode: 0100644,
            from_id: '357406f3075a57708d0163752905cc1576fceacc',
            to_id: '8e5177d718c561d36efde08bad36b43687ee6bf0',
126
            patch: raw_patch
127 128 129 130 131
          )
        )
      end

      context 'with a small diff' do
132
        let(:raw_patch) { @raw_diff_hash[:diff] }
133 134 135 136 137 138 139 140 141 142 143

        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
144
        let(:raw_patch) { 'a' * 204800 }
145 146 147 148 149 150

        it 'prunes the diff' do
          expect(diff.diff).to be_empty
          expect(diff).to be_too_large
        end
      end
151 152 153 154 155

      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
156
          expect(diff.diff).to be_utf8
157 158
        end
      end
159
    end
Robert Speicher's avatar
Robert Speicher committed
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 203 204 205 206 207 208 209 210 211 212 213 214 215 216
  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
217
    let(:options) { { max_files: 100, invalid_opt: true } }
Robert Speicher's avatar
Robert Speicher committed
218 219 220 221 222 223 224 225 226 227 228

    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
229
        default_options = { max_files: 5, bad_opt: 1, ignore_whitespace_change: true }
Robert Speicher's avatar
Robert Speicher committed
230 231 232 233 234 235 236 237 238
        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
239
        expect(filtered_options).to have_key(:ignore_whitespace_change)
Robert Speicher's avatar
Robert Speicher committed
240 241 242
      end

      it "should override default options" do
243 244
        expect(filtered_options).to have_key(:max_files)
        expect(filtered_options[:max_files]).to eq(100)
Robert Speicher's avatar
Robert Speicher committed
245 246 247 248
      end
    end
  end

249
  describe '#json_safe_diff' do
micael.bergeron's avatar
micael.bergeron committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
    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
      diff = described_class.new(@rugged_diff)

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

Robert Speicher's avatar
Robert Speicher committed
268 269
  describe '#submodule?' do
    before do
270 271
      # TODO use a Gitaly diff object instead
      rugged_commit = Gitlab::GitalyClient::StorageSettings.allow_disk_access do
272
        repository.rugged.rev_parse('5937ac0a7beb003549fc5fd26fc247adbce4a52e')
273 274 275
      end

      @diffs = rugged_commit.parents[0].diff(rugged_commit).patches
Robert Speicher's avatar
Robert Speicher committed
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
    end

    it { expect(described_class.new(@diffs[0]).submodule?).to eq(false) }
    it { expect(described_class.new(@diffs[1]).submodule?).to eq(true) }
  end

  describe '#line_count' do
    it 'returns the correct number of lines' do
      diff = described_class.new(@rugged_diff)

      expect(diff.line_count).to eq(9)
    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')

306
      diff.too_large!
Robert Speicher's avatar
Robert Speicher committed
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327

      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')

328
      diff.collapse!
Robert Speicher's avatar
Robert Speicher committed
329 330 331 332 333

      expect(diff).to be_collapsed
    end
  end

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

Douwe Maan's avatar
Douwe Maan committed
338
      expect(diff).to be_collapsed
Robert Speicher's avatar
Robert Speicher committed
339 340 341
    end

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

Douwe Maan's avatar
Douwe Maan committed
344
      expect(diff).not_to be_collapsed
Robert Speicher's avatar
Robert Speicher committed
345 346 347
    end
  end

348
  describe '#collapse!' do
Robert Speicher's avatar
Robert Speicher committed
349 350 351
    it 'prunes the diff' do
      diff = described_class.new(diff: "foo\nbar")

352
      diff.collapse!
Robert Speicher's avatar
Robert Speicher committed
353 354 355 356 357 358

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