Merge branch '12764-refactor-checksum-code' into 'master'

Refactor checksum code on uploads

Closes #12764

See merge request gitlab-org/gitlab!18065

app/models/concerns/checksummable.rb

+# frozen_string_literal: true
+
+module Checksummable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def hexdigest(path)
+      Digest::SHA256.file(path).hexdigest
+    end
+  end
+end

app/models/lfs_object.rb

@@ -2,6 +2,7 @@
 
 class LfsObject < ApplicationRecord
   include AfterCommitQueue
+  include Checksummable
   include EachBatch
   include ObjectStorage::BackgroundMove
 
@@ -46,7 +47,7 @@ class LfsObject < ApplicationRecord
   # rubocop: enable DestroyAll
 
   def self.calculate_oid(path)
-    Digest::SHA256.file(path).hexdigest
+    self.hexdigest(path)
   end
 end
 

app/models/upload.rb

 # frozen_string_literal: true
 
 class Upload < ApplicationRecord
+  include Checksummable
   # Upper limit for foreground checksum processing
   CHECKSUM_THRESHOLD = 100.megabytes
 
@@ -21,10 +22,6 @@ class Upload < ApplicationRecord
   # hooks are not executed and the file will not be deleted
   after_destroy :delete_file!, if: -> { uploader_class <= FileUploader }
 
-  def self.hexdigest(path)
-    Digest::SHA256.file(path).hexdigest
-  end
-
   class << self
     ##
     # FastDestroyAll concerns
@@ -55,7 +52,7 @@ class Upload < ApplicationRecord
     self.checksum = nil
     return unless needs_checksum?
 
-    self.checksum = Digest::SHA256.file(absolute_path).hexdigest
+    self.checksum = self.class.hexdigest(absolute_path)
   end
 
   # Initialize the associated Uploader class with current model

changelogs/unreleased/12764-refactor-checksum-code.yml

+---
+title: Refactor checksum code in uploads
+merge_request: 18065
+author: briankabiro
+type: other

lib/gitlab/ci/trace.rb

@@ -4,6 +4,7 @@ module Gitlab
   module Ci
     class Trace
       include ::Gitlab::ExclusiveLeaseHelpers
+      include Checksummable
 
       LOCK_TTL = 10.minutes
       LOCK_RETRIES = 2
@@ -193,7 +194,7 @@ module Gitlab
             project: job.project,
             file_type: :trace,
             file: stream,
-            file_sha256: Digest::SHA256.file(path).hexdigest)
+            file_sha256: self.class.hexdigest(path))
         end
       end
 

spec/models/concerns/checksummable_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Checksummable do
+  describe ".hexdigest" do
+    let(:fake_class) do
+      Class.new do
+        include Checksummable
+      end
+    end
+
+    it 'returns the SHA256 sum of the file' do
+      expected = Digest::SHA256.file(__FILE__).hexdigest
+
+      expect(fake_class.hexdigest(__FILE__)).to eq(expected)
+    end
+  end
+end

spec/models/lfs_object_spec.rb

@@ -156,4 +156,15 @@ describe LfsObject do
       end
     end
   end
+
+  describe ".calculate_oid" do
+    let(:lfs_object) { create(:lfs_object, :with_file) }
+
+    it 'returns SHA256 sum of the file' do
+      path = lfs_object.file.path
+      expected = Digest::SHA256.file(path).hexdigest
+
+      expect(described_class.calculate_oid(path)).to eq expected
+    end
+  end
 end

spec/support/shared_examples/ci_trace_shared_examples.rb

@@ -423,7 +423,7 @@ shared_examples_for 'trace with disabled live trace feature' do
         expect(build.job_artifacts_trace.file.filename).to eq('job.log')
         expect(File.exist?(src_path)).to be_falsy
         expect(src_checksum)
-          .to eq(Digest::SHA256.file(build.job_artifacts_trace.file.path).hexdigest)
+          .to eq(described_class.hexdigest(build.job_artifacts_trace.file.path))
         expect(build.job_artifacts_trace.file_sha256).to eq(src_checksum)
       end
     end
@@ -449,7 +449,7 @@ shared_examples_for 'trace with disabled live trace feature' do
         expect(build.job_artifacts_trace.file.filename).to eq('job.log')
         expect(build.old_trace).to be_nil
         expect(src_checksum)
-          .to eq(Digest::SHA256.file(build.job_artifacts_trace.file.path).hexdigest)
+          .to eq(described_class.hexdigest(build.job_artifacts_trace.file.path))
         expect(build.job_artifacts_trace.file_sha256).to eq(src_checksum)
       end
     end
@@ -787,7 +787,7 @@ shared_examples_for 'trace with enabled live trace feature' do
         expect(build.job_artifacts_trace.file.filename).to eq('job.log')
         expect(Ci::BuildTraceChunk.where(build: build)).not_to be_exist
         expect(src_checksum)
-          .to eq(Digest::SHA256.file(build.job_artifacts_trace.file.path).hexdigest)
+          .to eq(described_class.hexdigest(build.job_artifacts_trace.file.path))
         expect(build.job_artifacts_trace.file_sha256).to eq(src_checksum)
       end
     end