Merge branch 'user-agent-gke-api' into 'master'

Use custom User-Agent header in GCP Client requests

Closes #40583

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

changelogs/unreleased/user-agent-gke-api.yml

+---
+title: Use custom user agent header in all GCP API requests.
+merge_request: 15705
+author:
+type: changed

lib/google_api/cloud_platform/client.rb

@@ -44,7 +44,7 @@ module GoogleApi
         service = Google::Apis::ContainerV1::ContainerService.new
         service.authorization = access_token
 
-        service.get_zone_cluster(project_id, zone, cluster_id)
+        service.get_zone_cluster(project_id, zone, cluster_id, options: user_agent_header)
       end
 
       def projects_zones_clusters_create(project_id, zone, cluster_name, cluster_size, machine_type:)
@@ -62,14 +62,14 @@ module GoogleApi
             }
           } )
 
-        service.create_cluster(project_id, zone, request_body)
+        service.create_cluster(project_id, zone, request_body, options: user_agent_header)
       end
 
       def projects_zones_operations(project_id, zone, operation_id)
         service = Google::Apis::ContainerV1::ContainerService.new
         service.authorization = access_token
 
-        service.get_zone_operation(project_id, zone, operation_id)
+        service.get_zone_operation(project_id, zone, operation_id, options: user_agent_header)
       end
 
       def parse_operation_id(self_link)
@@ -82,6 +82,12 @@ module GoogleApi
       def token_life_time(expires_at)
         DateTime.strptime(expires_at, '%s').to_time.utc - Time.now.utc
       end
+
+      def user_agent_header
+        Google::Apis::RequestOptions.new.tap do |options|
+          options.header = { 'User-Agent': "GitLab/#{Gitlab::VERSION.match('(\d+\.\d+)').captures.first} (GPN:GitLab;)" }
+        end
+      end
     end
   end
 end

spec/lib/google_api/cloud_platform/client_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe GoogleApi::CloudPlatform::Client do
   let(:token) { 'token' }
   let(:client) { described_class.new(token, nil) }
+  let(:user_agent_options) { client.instance_eval { user_agent_header } }
 
   describe '.session_key_for_redirect_uri' do
     let(:state) { 'random_string' }
@@ -55,7 +56,8 @@ describe GoogleApi::CloudPlatform::Client do
 
     before do
       allow_any_instance_of(Google::Apis::ContainerV1::ContainerService)
-        .to receive(:get_zone_cluster).and_return(gke_cluster)
+        .to receive(:get_zone_cluster).with(any_args, options: user_agent_options)
+        .and_return(gke_cluster)
     end
 
     it { is_expected.to eq(gke_cluster) }
@@ -74,7 +76,8 @@ describe GoogleApi::CloudPlatform::Client do
 
     before do
       allow_any_instance_of(Google::Apis::ContainerV1::ContainerService)
-        .to receive(:create_cluster).and_return(operation)
+        .to receive(:create_cluster).with(any_args, options: user_agent_options)
+        .and_return(operation)
     end
 
     it { is_expected.to eq(operation) }
@@ -102,7 +105,8 @@ describe GoogleApi::CloudPlatform::Client do
 
     before do
       allow_any_instance_of(Google::Apis::ContainerV1::ContainerService)
-        .to receive(:get_zone_operation).and_return(operation)
+        .to receive(:get_zone_operation).with(any_args, options: user_agent_options)
+        .and_return(operation)
     end
 
     it { is_expected.to eq(operation) }
@@ -125,4 +129,18 @@ describe GoogleApi::CloudPlatform::Client do
       it { is_expected.to be_nil }
     end
   end
+
+  describe '#user_agent_header' do
+    subject { client.instance_eval { user_agent_header } }
+
+    it 'returns a RequestOptions object' do
+      expect(subject).to be_instance_of(Google::Apis::RequestOptions)
+    end
+
+    it 'has the correct GitLab version in User-Agent header' do
+      stub_const('Gitlab::VERSION', '10.3.0-pre')
+
+      expect(subject.header).to eq({ 'User-Agent': 'GitLab/10.3 (GPN:GitLab;)' })
+    end
+  end
 end