spec/lib/gitlab/usage/docs/helper_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
76
77
78
79

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Usage::Docs::Helper do
  subject(:helper) { klass.new }

  let_it_be(:klass) do
    Class.new do
      include Gitlab::Usage::Docs::Helper
    end
  end

  let(:metric_definition) do
    {
      data_category: 'Standard',
      name: 'test_metric',
      description: description,
      product_group: 'group::product intelligence',
      status: 'data_available',
      tier: %w(free premium)
    }
  end

  let(:description) { 'Metric description' }

  describe '#render_name' do
    it { expect(helper.render_name(metric_definition[:name])).to eq('### `test_metric`') }
  end

  describe '#render_description' do
    context 'without description' do
      let(:description) { nil }

      it { expect(helper.render_description(metric_definition)).to eq('Missing description') }
    end

    context 'without description' do
      it { expect(helper.render_description(metric_definition)).to eq('Metric description') }
    end
  end

  describe '#render_yaml_link' do
    let(:yaml_link) { 'config/metrics/license/test_metric.yml' }
    let(:expected) { "[YAML definition](#{yaml_link})" }

    it { expect(helper.render_yaml_link(yaml_link)).to eq(expected) }
  end

  describe '#render_status' do
    let(:expected) { "Status: `data_available`" }

    it { expect(helper.render_status(metric_definition)).to eq(expected) }
  end

  describe '#render_owner' do
    let(:expected) { "Group: `group::product intelligence`" }

    it { expect(helper.render_owner(metric_definition)).to eq(expected) }
  end

  describe '#render_tiers' do
    let(:expected) { "Tiers: `free`, `premium`" }

    it { expect(helper.render_tiers(metric_definition)).to eq(expected) }
  end

  describe '#render_data_category' do
    let(:expected) { 'Data Category: `Standard`' }

    it { expect(helper.render_data_category(metric_definition)).to eq(expected) }
  end

  describe '#render_owner' do
    let(:expected) { "Group: `group::product intelligence`" }

    it { expect(helper.render_owner(metric_definition)).to eq(expected) }
  end
end