From ab1e1b55a84ffc6b09233a6831be9bdc77c05115 Mon Sep 17 00:00:00 2001
From: syasonik <syasonik@gitlab.com>
Date: Fri, 15 Mar 2019 19:20:59 +0800
Subject: Specify time window for additional metrics api

Adds support for start and end parameters in the #additional_metrics
endpoint of the EnvironmentsController. start and end are meant to be
unix timestamps, per the Prometheus API (as the consumer of this
endpoint will eventually be transitioned to a prometheus endpoint).
This functionality is behind the :metrics_time_window feature flag
for development.
---
 spec/models/concerns/prometheus_adapter_spec.rb | 42 +++++++++++++++++++++++++
 spec/models/environment_spec.rb                 | 23 +++++++++++---
 2 files changed, 61 insertions(+), 4 deletions(-)

(limited to 'spec/models')

diff --git a/spec/models/concerns/prometheus_adapter_spec.rb b/spec/models/concerns/prometheus_adapter_spec.rb
index db20a8b4701..25a2d290f76 100644
--- a/spec/models/concerns/prometheus_adapter_spec.rb
+++ b/spec/models/concerns/prometheus_adapter_spec.rb
@@ -77,6 +77,28 @@ describe PrometheusAdapter, :use_clean_rails_memory_store_caching do
         end
       end
     end
+
+    describe 'additional_metrics' do
+      let(:additional_metrics_environment_query) { Gitlab::Prometheus::Queries::AdditionalMetricsEnvironmentQuery }
+      let(:environment) { build_stubbed(:environment, slug: 'env-slug') }
+      let(:time_window) { [1552642245.067, 1552642095.831] }
+
+      around do |example|
+        Timecop.freeze { example.run }
+      end
+
+      context 'with valid data' do
+        subject { service.query(:additional_metrics_environment, environment, *time_window) }
+
+        before do
+          stub_reactive_cache(service, prometheus_data, additional_metrics_environment_query, environment.id, *time_window)
+        end
+
+        it 'returns reactive data' do
+          expect(subject).to eq(prometheus_data)
+        end
+      end
+    end
   end
 
   describe '#calculate_reactive_cache' do
@@ -121,4 +143,24 @@ describe PrometheusAdapter, :use_clean_rails_memory_store_caching do
       end
     end
   end
+
+  describe '#build_query_args' do
+    subject { service.build_query_args(*args) }
+
+    context 'when active record models are included' do
+      let(:args) { [double(:environment, id: 12)] }
+
+      it 'serializes by id' do
+        is_expected.to eq [12]
+      end
+    end
+
+    context 'when args are safe for serialization' do
+      let(:args) { ['stringy arg', 5, 6.0, :symbolic_arg] }
+
+      it 'does nothing' do
+        is_expected.to eq args
+      end
+    end
+  end
 end
diff --git a/spec/models/environment_spec.rb b/spec/models/environment_spec.rb
index ca5eed60b56..cfe7c7ef0b0 100644
--- a/spec/models/environment_spec.rb
+++ b/spec/models/environment_spec.rb
@@ -687,7 +687,8 @@ describe Environment do
 
   describe '#additional_metrics' do
     let(:project) { create(:prometheus_project) }
-    subject { environment.additional_metrics }
+    let(:metric_params) { [] }
+    subject { environment.additional_metrics(*metric_params) }
 
     context 'when the environment has additional metrics' do
       before do
@@ -695,12 +696,26 @@ describe Environment do
       end
 
       it 'returns the additional metrics from the deployment service' do
-        expect(environment.prometheus_adapter).to receive(:query)
-                                                .with(:additional_metrics_environment, environment)
-                                                .and_return(:fake_metrics)
+        expect(environment.prometheus_adapter)
+          .to receive(:query)
+          .with(:additional_metrics_environment, environment)
+          .and_return(:fake_metrics)
 
         is_expected.to eq(:fake_metrics)
       end
+
+      context 'when time window arguments are provided' do
+        let(:metric_params) { [1552642245.067, Time.now] }
+
+        it 'queries with the expected parameters' do
+          expect(environment.prometheus_adapter)
+            .to receive(:query)
+            .with(:additional_metrics_environment, environment, *metric_params.map(&:to_f))
+            .and_return(:fake_metrics)
+
+          is_expected.to eq(:fake_metrics)
+        end
+      end
     end
 
     context 'when the environment does not have metrics' do
-- 
cgit v1.2.1