1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::UsageMetricDefinitionGenerator, :silence_stdout do
include UsageDataHelpers
let(:key_path) { 'counts_weekly.test_metric' }
let(:dir) { '7d' }
let(:temp_dir) { Dir.mktmpdir }
before do
stub_const("#{described_class}::TOP_LEVEL_DIR", temp_dir)
# Stub Prometheus requests from Gitlab::Utils::UsageData
stub_prometheus_queries
end
after do
FileUtils.rm_rf(temp_dir)
end
describe 'Creating metric definition file' do
let(:sample_metric) { load_sample_metric_definition(filename: sample_filename) }
# Stub version so that `milestone` key remains constant between releases to prevent flakiness.
before do
stub_const('Gitlab::VERSION', '13.9.0')
allow(::Gitlab::Usage::Metrics::NamesSuggestions::Generator).to receive(:generate).and_return('test metric name')
end
context 'without ee option' do
let(:sample_filename) { 'sample_metric_with_name_suggestions.yml' }
let(:metric_definition_path) { Dir.glob(File.join(temp_dir, 'metrics/counts_7d/*_test_metric.yml')).first }
it 'creates a metric definition file using the template' do
described_class.new([key_path], { 'dir' => dir }).invoke_all
expect(YAML.safe_load(File.read(metric_definition_path))).to eq(sample_metric)
end
end
context 'with ee option' do
let(:sample_filename) { 'sample_metric_with_ee.yml' }
let(:metric_definition_path) { Dir.glob(File.join(temp_dir, 'ee/config/metrics/counts_7d/*_test_metric.yml')).first }
before do
stub_const("#{described_class}::TOP_LEVEL_DIR", 'config')
stub_const("#{described_class}::TOP_LEVEL_DIR_EE", File.join(temp_dir, 'ee'))
end
it 'creates a metric definition file using the template' do
described_class.new([key_path], { 'dir' => dir, 'ee': true }).invoke_all
expect(YAML.safe_load(File.read(metric_definition_path))).to eq(sample_metric)
end
end
end
describe 'Validation' do
let(:options) { [key_path, '--dir', dir] }
subject { described_class.start(options) }
it 'does not raise an error' do
expect { subject }.not_to raise_error
end
context 'with a missing directory' do
let(:options) { [key_path, '--pretend'] }
it 'raises an error' do
expect { subject }.to raise_error(RuntimeError)
end
end
context 'with an invalid directory' do
let(:dir) { '8d' }
it 'raises an error' do
expect { subject }.to raise_error(RuntimeError)
end
end
context 'with an already existing metric with the same key_path' do
before do
allow(Gitlab::Usage::MetricDefinition).to receive(:definitions).and_return(Hash[key_path, 'definition'])
end
it 'raises an error' do
expect { subject }.to raise_error(RuntimeError)
end
end
end
describe 'Name suggestions' do
it 'adds name key to metric definition' do
expect(::Gitlab::Usage::Metrics::NamesSuggestions::Generator).to receive(:generate).and_return('some name')
described_class.new([key_path], { 'dir' => dir }).invoke_all
metric_definition_path = Dir.glob(File.join(temp_dir, 'metrics/counts_7d/*_test_metric.yml')).first
expect(YAML.safe_load(File.read(metric_definition_path))).to include("name" => "some name")
end
end
end
|
