spec/lib/gitlab/usage_data_counters/aggregated_metrics_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

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe 'aggregated metrics' do
  RSpec::Matchers.define :be_known_event do
    match do |event|
      Gitlab::UsageDataCounters::HLLRedisCounter.known_event?(event)
    end

    failure_message do |event|
      "Event with name: `#{event}` can not be found within `#{Gitlab::UsageDataCounters::HLLRedisCounter::KNOWN_EVENTS_PATH}`"
    end
  end

  let_it_be(:known_events) do
    Gitlab::UsageDataCounters::HLLRedisCounter.known_events
  end

  Gitlab::UsageDataCounters::HLLRedisCounter.aggregated_metrics.tap do |aggregated_metrics|
    it 'all events has unique name' do
      event_names = aggregated_metrics&.map { |event| event[:name] }

      expect(event_names).to eq(event_names&.uniq)
    end

    aggregated_metrics&.each do |aggregate|
      context "for #{aggregate[:name]} aggregate of #{aggregate[:events].join(' ')}" do
        let_it_be(:events_records) { known_events.select { |event| aggregate[:events].include?(event[:name]) } }

        it "only refers to known events" do
          expect(aggregate[:events]).to all be_known_event
        end

        it "has expected structure" do
          expect(aggregate.keys).to include(*%w[name operator events])
        end

        it "uses allowed aggregation operators" do
          expect(Gitlab::UsageDataCounters::HLLRedisCounter::ALLOWED_METRICS_AGGREGATIONS).to include aggregate[:operator]
        end

        it "uses events from the same Redis slot" do
          event_slots = events_records.map { |event| event[:redis_slot] }.uniq

          expect(event_slots).to contain_exactly(be_present)
        end

        it "uses events with the same aggregation period" do
          event_slots = events_records.map { |event| event[:aggregation] }.uniq

          expect(event_slots).to contain_exactly(be_present)
        end
      end
    end
  end
end