spec/lib/generators/gitlab/usage_metric_definition_generator_spec.rb


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

# frozen_string_literal: true

require 'generator_helper'

RSpec.describe Gitlab::UsageMetricDefinitionGenerator do
  describe 'Validation' do
    let(:key_path) { 'counter.category.event' }
    let(:dir) { '7d' }
    let(:options) { [key_path, '--dir', dir, '--pretend'] }

    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
    let(:temp_dir) { Dir.mktmpdir }

    before do
      stub_const("#{described_class}::TOP_LEVEL_DIR", temp_dir)
    end

    context 'with product_intelligence_metrics_names_suggestions feature ON' do
      it 'adds name key to metric definition' do
        stub_feature_flags(product_intelligence_metrics_names_suggestions: true)

        expect(::Gitlab::Usage::Metrics::NamesSuggestions::Generator).to receive(:generate).and_return('some name')
        described_class.new(['counts_weekly.test_metric'], { 'dir' => '7d' }).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

    context 'with product_intelligence_metrics_names_suggestions feature OFF' do
      it 'adds name key to metric definition' do
        stub_feature_flags(product_intelligence_metrics_names_suggestions: false)

        expect(::Gitlab::Usage::Metrics::NamesSuggestions::Generator).not_to receive(:generate)
        described_class.new(['counts_weekly.test_metric'], { 'dir' => '7d' }).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)).keys).not_to include(:name)
      end
    end
  end
end