Welcome to mirror list, hosted at ThFree Co, Russian Federation.

snowplow_event_definition_generator_spec.rb « gitlab « generators « lib « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: d9fa6b931ad5f0dd313bacd268d2ee4b162f060d (plain)
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::SnowplowEventDefinitionGenerator, :silence_stdout do
  let(:ce_temp_dir) { Dir.mktmpdir }
  let(:ee_temp_dir) { Dir.mktmpdir }
  let(:timestamp) { Time.current.to_i }
  let(:generator_options) { { 'category' => 'Groups::EmailCampaignsController', 'action' => 'click' } }

  before do
    stub_const("#{described_class}::CE_DIR", ce_temp_dir)
    stub_const("#{described_class}::EE_DIR", ee_temp_dir)
  end

  around do |example|
    freeze_time { example.run }
  end

  after do
    FileUtils.rm_rf([ce_temp_dir, ee_temp_dir])
  end

  describe 'Creating event definition file' do
    before do
      stub_const('Gitlab::VERSION', '13.11.0-pre')
    end

    let(:sample_event_dir) { 'lib/generators/gitlab/snowplow_event_definition_generator' }
    let(:file_name) { Dir.children(ce_temp_dir).first }

    it 'creates CE event definition file using the template' do
      sample_event = ::Gitlab::Config::Loader::Yaml.new(fixture_file(File.join(sample_event_dir, 'sample_event.yml'))).load_raw!

      described_class.new([], generator_options).invoke_all

      event_definition_path = File.join(ce_temp_dir, file_name)
      expect(::Gitlab::Config::Loader::Yaml.new(File.read(event_definition_path)).load_raw!).to eq(sample_event)
    end

    describe 'generated filename' do
      it 'includes timestamp' do
        described_class.new([], generator_options).invoke_all

        expect(file_name).to include(timestamp.to_s)
      end

      it 'removes special characters' do
        generator_options = { 'category' => '"`ui:[mavenpackages | t5%348()-=@ ]`"', 'action' => 'click' }

        described_class.new([], generator_options).invoke_all

        expect(file_name).to include('uimavenpackagest')
      end

      it 'cuts name if longer than 100 characters' do
        generator_options = { 'category' => 'a' * 100, 'action' => 'click' }

        described_class.new([], generator_options).invoke_all

        expect(file_name.length).to eq(100)
      end
    end

    context 'event definition already exists' do
      before do
        stub_const('Gitlab::VERSION', '12.11.0-pre')
        described_class.new([], generator_options).invoke_all
      end

      it 'overwrites event definition --force flag set to true' do
        sample_event = ::Gitlab::Config::Loader::Yaml.new(fixture_file(File.join(sample_event_dir, 'sample_event.yml'))).load_raw!

        stub_const('Gitlab::VERSION', '13.11.0-pre')
        described_class.new([], generator_options.merge('force' => true)).invoke_all

        event_definition_path = File.join(ce_temp_dir, file_name)
        event_data = ::Gitlab::Config::Loader::Yaml.new(File.read(event_definition_path)).load_raw!

        expect(event_data).to eq(sample_event)
      end

      it 'raises error when --force flag set to false' do
        expect { described_class.new([], generator_options.merge('force' => false)).invoke_all }
          .to raise_error(StandardError, /Event definition already exists at/)
      end
    end

    describe 'EE' do
      let(:file_name) { Dir.children(ee_temp_dir).first }

      it 'creates EE event definition file using the template' do
        sample_event = ::Gitlab::Config::Loader::Yaml.new(fixture_file(File.join(sample_event_dir, 'sample_event_ee.yml'))).load_raw!

        described_class.new([], generator_options.merge('ee' => true)).invoke_all

        event_definition_path = File.join(ee_temp_dir, file_name)
        expect(::Gitlab::Config::Loader::Yaml.new(File.read(event_definition_path)).load_raw!).to eq(sample_event)
      end
    end
  end
end