Merge branch 'zj-licensee-key' into 'master'43548-update-language-about-usage-ping-in-admin-settings-and-docs

Client implementation for Licensee#key

See merge request gitlab-org/gitlab-ce!17449

4 files changed, 53 insertions, 9 deletions

diff --git a/app/models/repository.rb b/app/models/repository.rb
index 7888c1019e6..242d9d5f125 100644
--- a/app/models/repository.rb
+++ b/app/models/repository.rb
@@ -590,15 +590,7 @@ class Repository
   def license_key
     return unless exists?
 
-    # The licensee gem creates a Rugged object from the path:
-    # https://github.com/benbalter/licensee/blob/v8.7.0/lib/licensee/projects/git_project.rb
-    begin
-      Licensee.license(path).try(:key)
-    # Normally we would rescue Rugged::Error, but that is banned by lint-rugged
-    # and we need to migrate this endpoint to Gitaly:
-    # https://gitlab.com/gitlab-org/gitaly/issues/1026
-    rescue
-    end
+    raw_repository.license_short_name
   end
   cache_method :license_key
 
diff --git a/lib/gitlab/git/repository.rb b/lib/gitlab/git/repository.rb
index 1c964960983..d7c373ccd6f 100644
--- a/lib/gitlab/git/repository.rb
+++ b/lib/gitlab/git/repository.rb
@@ -1038,6 +1038,21 @@ module Gitlab
         end
       end
 
+      def license_short_name
+        gitaly_migrate(:license_short_name) do |is_enabled|
+          if is_enabled
+            gitaly_repository_client.license_short_name
+          else
+            begin
+              # The licensee gem creates a Rugged object from the path:
+              # https://github.com/benbalter/licensee/blob/v8.7.0/lib/licensee/projects/git_project.rb
+              Licensee.license(path).try(:key)
+            rescue Rugged::Error
+            end
+          end
+        end
+      end
+
       def with_repo_branch_commit(start_repository, start_branch_name)
         Gitlab::Git.check_namespace!(start_repository)
         start_repository = RemoteRepository.new(start_repository) unless start_repository.is_a?(RemoteRepository)
diff --git a/lib/gitlab/gitaly_client/repository_service.rb b/lib/gitlab/gitaly_client/repository_service.rb
index d7e40471798..fdb3247cf4d 100644
--- a/lib/gitlab/gitaly_client/repository_service.rb
+++ b/lib/gitlab/gitaly_client/repository_service.rb
@@ -249,6 +249,14 @@ module Gitlab
 
         raise Gitlab::Git::OSError.new(response.error) unless response.error.empty?
       end
+
+      def license_short_name
+        request = Gitaly::FindLicenseRequest.new(repository: @gitaly_repo)
+
+        response = GitalyClient.call(@storage, :repository_service, :find_license, request, timeout: GitalyClient.fast_timeout)
+
+        response.license_short_name.presence
+      end
     end
   end
 end
diff --git a/spec/lib/gitlab/git/repository_spec.rb b/spec/lib/gitlab/git/repository_spec.rb
index 8e585d9a81c..25defb98b7c 100644
--- a/spec/lib/gitlab/git/repository_spec.rb
+++ b/spec/lib/gitlab/git/repository_spec.rb
@@ -1689,6 +1689,35 @@ describe Gitlab::Git::Repository, seed_helper: true do
     end
   end
 
+  describe '#license_short_name' do
+    shared_examples 'acquiring the Licensee license key' do
+      subject { repository.license_short_name }
+
+      context 'when no license file can be found' do
+        let(:project) { create(:project, :repository) }
+        let(:repository) { project.repository.raw_repository }
+
+        before do
+          project.repository.delete_file(project.owner, 'LICENSE', message: 'remove license', branch_name: 'master')
+        end
+
+        it { is_expected.to be_nil }
+      end
+
+      context 'when an mit license is found' do
+        it { is_expected.to eq('mit') }
+      end
+    end
+
+    context 'when gitaly is enabled' do
+      it_behaves_like 'acquiring the Licensee license key'
+    end
+
+    context 'when gitaly is disabled', :disable_gitaly do
+      it_behaves_like 'acquiring the Licensee license key'
+    end
+  end
+
   describe '#with_repo_branch_commit' do
     context 'when comparing with the same repository' do
       let(:start_repository) { repository }