summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJacob Vosmaer <jacob@gitlab.com>2017-06-16 18:42:41 +0200
committerJacob Vosmaer <jacob@gitlab.com>2017-06-19 11:07:46 +0200
commit76bafc00e62b3a90252f0d229c7ce98c2691da30 (patch)
treef7abad6b427a8a059ec37a1dae005f3795531cd0
parenta4a5cbf29a983d05b5fc69f8e63fc37e100c8637 (diff)
downloadgitlab-ce-76bafc00e62b3a90252f0d229c7ce98c2691da30.tar.gz
Pass Gitaly token on Ruby gRPC requests
-rw-r--r--config/gitlab.yml.example3
-rw-r--r--lib/gitlab/gitaly_client.rb22
-rw-r--r--lib/gitlab/gitaly_client/commit.rb16
-rw-r--r--lib/gitlab/gitaly_client/notifications.rb12
-rw-r--r--lib/gitlab/gitaly_client/ref.rb21
-rw-r--r--spec/lib/gitlab/gitaly_client/commit_spec.rb8
-rw-r--r--spec/lib/gitlab/gitaly_client/notifications_spec.rb2
-rw-r--r--spec/lib/gitlab/gitaly_client/ref_spec.rb10
8 files changed, 57 insertions, 37 deletions
diff --git a/config/gitlab.yml.example b/config/gitlab.yml.example
index 0b33783869b..7c7e444af3a 100644
--- a/config/gitlab.yml.example
+++ b/config/gitlab.yml.example
@@ -454,6 +454,8 @@ production: &base
# introduced in 9.0). Eventually Gitaly use will become mandatory and
# this option will disappear.
enabled: true
+ # Default Gitaly authentication token. Can be overriden per storage.
+ token: ""
#
# 4. Advanced settings
@@ -469,6 +471,7 @@ production: &base
default:
path: /home/git/repositories/
gitaly_address: unix:/home/git/gitlab/tmp/sockets/private/gitaly.socket # TCP connections are supported too (e.g. tcp://host:port)
+ # gitaly_token: 'special token' # Optional: override global gitaly.token for this storage.
## Backup settings
backup:
diff --git a/lib/gitlab/gitaly_client.rb b/lib/gitlab/gitaly_client.rb
index 2343446bf22..e30bcd7ae3a 100644
--- a/lib/gitlab/gitaly_client.rb
+++ b/lib/gitlab/gitaly_client.rb
@@ -1,3 +1,5 @@
+require 'base64'
+
require 'gitaly'
module Gitlab
@@ -48,6 +50,26 @@ module Gitlab
address
end
+ # All RPC calls should use GitalyClient.call. This method makes sure
+ # that per-request authentication headers are set.
+ def self.call(storage, service, rpc, request)
+ metadata = request_metadata(storage)
+ metadata = yield(metadata) if block_given?
+ stub(service, storage).send(rpc, request, metadata)
+ end
+
+ def self.request_metadata(storage)
+ encoded_token = Base64.strict_encode64(token(storage).to_s)
+ { metadata: { 'authorization' => "Bearer #{encoded_token}" } }
+ end
+
+ def self.token(storage)
+ params = Gitlab.config.repositories.storages[storage]
+ raise "storage not found: #{storage.inspect}" if params.nil?
+
+ params['gitaly_token'].presence || Gitlab.config.gitaly['token']
+ end
+
def self.enabled?
Gitlab.config.gitaly.enabled
end
diff --git a/lib/gitlab/gitaly_client/commit.rb b/lib/gitlab/gitaly_client/commit.rb
index ba3da781dad..73c1848c95f 100644
--- a/lib/gitlab/gitaly_client/commit.rb
+++ b/lib/gitlab/gitaly_client/commit.rb
@@ -11,28 +11,26 @@ module Gitlab
end
def is_ancestor(ancestor_id, child_id)
- stub = GitalyClient.stub(:commit, @repository.storage)
request = Gitaly::CommitIsAncestorRequest.new(
repository: @gitaly_repo,
ancestor_id: ancestor_id,
child_id: child_id
)
- stub.commit_is_ancestor(request).value
+ GitalyClient.call(@repository.storage, :commit, :commit_is_ancestor, request).value
end
def diff_from_parent(commit, options = {})
request_params = commit_diff_request_params(commit, options)
request_params[:ignore_whitespace_change] = options.fetch(:ignore_whitespace_change, false)
-
- response = diff_service_stub.commit_diff(Gitaly::CommitDiffRequest.new(request_params))
+ request = Gitaly::CommitDiffRequest.new(request_params)
+ response = GitalyClient.call(@repository.storage, :diff, :commit_diff, request)
Gitlab::Git::DiffCollection.new(GitalyClient::DiffStitcher.new(response), options)
end
def commit_deltas(commit)
- request_params = commit_diff_request_params(commit)
-
- response = diff_service_stub.commit_delta(Gitaly::CommitDeltaRequest.new(request_params))
+ request = Gitaly::CommitDeltaRequest.new(commit_diff_request_params(commit))
+ response = GitalyClient.call(@repository.storage, :diff, :commit_delta, request)
response.flat_map do |msg|
msg.deltas.map { |d| Gitlab::Git::Diff.new(d) }
end
@@ -50,10 +48,6 @@ module Gitlab
paths: options.fetch(:paths, [])
}
end
-
- def diff_service_stub
- GitalyClient.stub(:diff, @repository.storage)
- end
end
end
end
diff --git a/lib/gitlab/gitaly_client/notifications.rb b/lib/gitlab/gitaly_client/notifications.rb
index 719554eac52..78ed433e6b8 100644
--- a/lib/gitlab/gitaly_client/notifications.rb
+++ b/lib/gitlab/gitaly_client/notifications.rb
@@ -1,17 +1,19 @@
module Gitlab
module GitalyClient
class Notifications
- attr_accessor :stub
-
# 'repository' is a Gitlab::Git::Repository
def initialize(repository)
@gitaly_repo = repository.gitaly_repository
- @stub = GitalyClient.stub(:notifications, repository.storage)
+ @storage = repository.storage
end
def post_receive
- request = Gitaly::PostReceiveRequest.new(repository: @gitaly_repo)
- @stub.post_receive(request)
+ GitalyClient.call(
+ @storage,
+ :notifications,
+ :post_receive,
+ Gitaly::PostReceiveRequest.new(repository: @gitaly_repo)
+ )
end
end
end
diff --git a/lib/gitlab/gitaly_client/ref.rb b/lib/gitlab/gitaly_client/ref.rb
index 227fe45642e..6d5f54dd959 100644
--- a/lib/gitlab/gitaly_client/ref.rb
+++ b/lib/gitlab/gitaly_client/ref.rb
@@ -1,29 +1,28 @@
module Gitlab
module GitalyClient
class Ref
- attr_accessor :stub
-
# 'repository' is a Gitlab::Git::Repository
def initialize(repository)
@gitaly_repo = repository.gitaly_repository
- @stub = GitalyClient.stub(:ref, repository.storage)
+ @storage = repository.storage
end
def default_branch_name
request = Gitaly::FindDefaultBranchNameRequest.new(repository: @gitaly_repo)
- branch_name = stub.find_default_branch_name(request).name
-
- Gitlab::Git.branch_name(branch_name)
+ response = GitalyClient.call(@storage, :ref, :find_default_branch_name, request)
+ Gitlab::Git.branch_name(response.name)
end
def branch_names
request = Gitaly::FindAllBranchNamesRequest.new(repository: @gitaly_repo)
- consume_refs_response(stub.find_all_branch_names(request), prefix: 'refs/heads/')
+ response = GitalyClient.call(@storage, :ref, :find_all_branch_names, request)
+ consume_refs_response(response, prefix: 'refs/heads/')
end
def tag_names
request = Gitaly::FindAllTagNamesRequest.new(repository: @gitaly_repo)
- consume_refs_response(stub.find_all_tag_names(request), prefix: 'refs/tags/')
+ response = GitalyClient.call(@storage, :ref, :find_all_tag_names, request)
+ consume_refs_response(response, prefix: 'refs/tags/')
end
def find_ref_name(commit_id, ref_prefix)
@@ -32,8 +31,7 @@ module Gitlab
commit_id: commit_id,
prefix: ref_prefix
)
-
- stub.find_ref_name(request).name
+ GitalyClient.call(@storage, :ref, :find_ref_name, request).name
end
def count_tag_names
@@ -47,7 +45,8 @@ module Gitlab
def local_branches(sort_by: nil)
request = Gitaly::FindLocalBranchesRequest.new(repository: @gitaly_repo)
request.sort_by = sort_by_param(sort_by) if sort_by
- consume_branches_response(stub.find_local_branches(request))
+ response = GitalyClient.call(@storage, :ref, :find_local_branches, request)
+ consume_branches_response(response)
end
private
diff --git a/spec/lib/gitlab/gitaly_client/commit_spec.rb b/spec/lib/gitlab/gitaly_client/commit_spec.rb
index cf1bc74779e..dff5b25c712 100644
--- a/spec/lib/gitlab/gitaly_client/commit_spec.rb
+++ b/spec/lib/gitlab/gitaly_client/commit_spec.rb
@@ -16,7 +16,7 @@ describe Gitlab::GitalyClient::Commit do
right_commit_id: commit.id
)
- expect_any_instance_of(Gitaly::Diff::Stub).to receive(:commit_diff).with(request)
+ expect_any_instance_of(Gitaly::Diff::Stub).to receive(:commit_diff).with(request, kind_of(Hash))
described_class.new(repository).diff_from_parent(commit)
end
@@ -31,7 +31,7 @@ describe Gitlab::GitalyClient::Commit do
right_commit_id: initial_commit.id
)
- expect_any_instance_of(Gitaly::Diff::Stub).to receive(:commit_diff).with(request)
+ expect_any_instance_of(Gitaly::Diff::Stub).to receive(:commit_diff).with(request, kind_of(Hash))
described_class.new(repository).diff_from_parent(initial_commit)
end
@@ -61,7 +61,7 @@ describe Gitlab::GitalyClient::Commit do
right_commit_id: commit.id
)
- expect_any_instance_of(Gitaly::Diff::Stub).to receive(:commit_delta).with(request).and_return([])
+ expect_any_instance_of(Gitaly::Diff::Stub).to receive(:commit_delta).with(request, kind_of(Hash)).and_return([])
described_class.new(repository).commit_deltas(commit)
end
@@ -76,7 +76,7 @@ describe Gitlab::GitalyClient::Commit do
right_commit_id: initial_commit.id
)
- expect_any_instance_of(Gitaly::Diff::Stub).to receive(:commit_delta).with(request).and_return([])
+ expect_any_instance_of(Gitaly::Diff::Stub).to receive(:commit_delta).with(request, kind_of(Hash)).and_return([])
described_class.new(repository).commit_deltas(initial_commit)
end
diff --git a/spec/lib/gitlab/gitaly_client/notifications_spec.rb b/spec/lib/gitlab/gitaly_client/notifications_spec.rb
index e5c9e06a15e..c2b8ca9f501 100644
--- a/spec/lib/gitlab/gitaly_client/notifications_spec.rb
+++ b/spec/lib/gitlab/gitaly_client/notifications_spec.rb
@@ -9,7 +9,7 @@ describe Gitlab::GitalyClient::Notifications do
it 'sends a post_receive message' do
expect_any_instance_of(Gitaly::Notifications::Stub).
- to receive(:post_receive).with(gitaly_request_with_path(storage_name, relative_path))
+ to receive(:post_receive).with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash))
subject.post_receive
end
diff --git a/spec/lib/gitlab/gitaly_client/ref_spec.rb b/spec/lib/gitlab/gitaly_client/ref_spec.rb
index 2ea44ef74b0..3272333bb33 100644
--- a/spec/lib/gitlab/gitaly_client/ref_spec.rb
+++ b/spec/lib/gitlab/gitaly_client/ref_spec.rb
@@ -21,7 +21,7 @@ describe Gitlab::GitalyClient::Ref do
it 'sends a find_all_branch_names message' do
expect_any_instance_of(Gitaly::Ref::Stub).
to receive(:find_all_branch_names).
- with(gitaly_request_with_path(storage_name, relative_path)).
+ with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash)).
and_return([])
client.branch_names
@@ -32,7 +32,7 @@ describe Gitlab::GitalyClient::Ref do
it 'sends a find_all_tag_names message' do
expect_any_instance_of(Gitaly::Ref::Stub).
to receive(:find_all_tag_names).
- with(gitaly_request_with_path(storage_name, relative_path)).
+ with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash)).
and_return([])
client.tag_names
@@ -43,7 +43,7 @@ describe Gitlab::GitalyClient::Ref do
it 'sends a find_default_branch_name message' do
expect_any_instance_of(Gitaly::Ref::Stub).
to receive(:find_default_branch_name).
- with(gitaly_request_with_path(storage_name, relative_path)).
+ with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash)).
and_return(double(name: 'foo'))
client.default_branch_name
@@ -54,7 +54,7 @@ describe Gitlab::GitalyClient::Ref do
it 'sends a find_local_branches message' do
expect_any_instance_of(Gitaly::Ref::Stub).
to receive(:find_local_branches).
- with(gitaly_request_with_path(storage_name, relative_path)).
+ with(gitaly_request_with_path(storage_name, relative_path), kind_of(Hash)).
and_return([])
client.local_branches
@@ -63,7 +63,7 @@ describe Gitlab::GitalyClient::Ref do
it 'parses and sends the sort parameter' do
expect_any_instance_of(Gitaly::Ref::Stub).
to receive(:find_local_branches).
- with(gitaly_request_with_params(sort_by: :UPDATED_DESC)).
+ with(gitaly_request_with_params(sort_by: :UPDATED_DESC), kind_of(Hash)).
and_return([])
client.local_branches(sort_by: 'updated_desc')