Add ci_template known events rake task

Adds a rake task that generates ci_templates.yml. This needs to be ran
whenever a new CI template gets added to make sure an event is defined
for the template inclusion.

lib/gitlab/usage_data_counters/ci_template_unique_counter.rb

@@ -3,6 +3,7 @@
 module Gitlab::UsageDataCounters
   class CiTemplateUniqueCounter
     REDIS_SLOT = 'ci_templates'
+    KNOWN_EVENTS_FILE_PATH = File.expand_path('known_events/ci_templates.yml', __dir__)
 
     # NOTE: Events originating from implicit Auto DevOps pipelines get prefixed with `implicit_`
     TEMPLATE_TO_EVENT = {
@@ -20,31 +21,26 @@ module Gitlab::UsageDataCounters
 
     class << self
       def track_unique_project_event(project_id:, template:, config_source:)
-        if event = unique_project_event(template, config_source)
-          Gitlab::UsageDataCounters::HLLRedisCounter.track_event(event, values: project_id)
-        end
-      end
-
-      private
+        return unless TEMPLATE_TO_EVENT[template] || Feature.enabled?(:track_all_ci_template_inclusions, default_enabled: :yaml)
 
-      def unique_project_event(template, config_source)
-        if TEMPLATE_TO_EVENT[template]
-          template_inclusion_name(config_source, TEMPLATE_TO_EVENT[template])
+        Gitlab::UsageDataCounters::HLLRedisCounter.track_event(ci_template_event_name(template, config_source), values: project_id)
       end
 
-        if Feature.enabled?(:track_all_ci_template_inclusions)
-          template_inclusion_name(config_source, template_to_event(template))
-        end
+      def ci_templates(relative_base = 'lib/gitlab/ci/templates')
+        Dir.glob('**/*.gitlab-ci.yml', base: Rails.root.join(relative_base))
       end
 
-      def template_inclusion_name(config_source, name)
+      def ci_template_event_name(template_name, config_source)
         prefix = 'implicit_' if config_source.to_s == 'auto_devops_source'
+        template_event_name = TEMPLATE_TO_EVENT[template_name] || template_to_event_name(template_name)
 
-        "p_#{REDIS_SLOT}_#{prefix}#{name}"
+        "p_#{REDIS_SLOT}_#{prefix}#{template_event_name}"
       end
 
-      def template_to_event(template)
-        File.basename(template, '.gitlab-ci.yml').underscore
+      private
+
+      def template_to_event_name(template)
+        ActiveSupport::Inflector.parameterize(template.chomp('.gitlab-ci.yml'), separator: '_').underscore
       end
     end
   end

lib/tasks/gitlab/usage_data.rake

@@ -28,5 +28,33 @@ namespace :gitlab do
     task generate_from_yaml: :environment do
       puts Gitlab::Json.pretty_generate(Gitlab::UsageDataMetrics.uncached_data)
     end
+
+    desc 'GitLab | UsageDataMetrics | Generate known_events/ci_templates.yml based on template definitions'
+    task generate_ci_template_events: :environment do
+      banner = <<~BANNER
+          # This file is generated automatically by
+          #   bin/rake gitlab:usage_data:generate_ci_template_events
+          #
+          # Do not edit it manually!
+      BANNER
+
+      repository_includes = ci_template_includes_hash(:repository_source)
+      auto_devops_jobs_includes = ci_template_includes_hash(:auto_devops_source, 'Jobs')
+      auto_devops_security_includes = ci_template_includes_hash(:auto_devops_source, 'Security')
+      all_includes = [*repository_includes, *auto_devops_jobs_includes, *auto_devops_security_includes]
+
+      File.write(Gitlab::UsageDataCounters::CiTemplateUniqueCounter::KNOWN_EVENTS_FILE_PATH, banner + YAML.dump(all_includes).gsub(/ *$/m, ''))
+    end
+
+    def ci_template_includes_hash(source, template_directory = nil)
+      Gitlab::UsageDataCounters::CiTemplateUniqueCounter.ci_templates("lib/gitlab/ci/templates/#{template_directory}").map do |template|
+        {
+          'name' => Gitlab::UsageDataCounters::CiTemplateUniqueCounter.ci_template_event_name("#{template_directory}/#{template}", source),
+          'category' => 'ci_templates',
+          'redis_slot' => Gitlab::UsageDataCounters::CiTemplateUniqueCounter::REDIS_SLOT,
+          'aggregation' => 'weekly'
+        }
+      end
+    end
   end
 end

spec/lib/gitlab/usage_data_counters/ci_template_unique_counter_spec.rb

@@ -77,12 +77,16 @@ RSpec.describe Gitlab::UsageDataCounters::CiTemplateUniqueCounter do
       let(:project_id) { 1 }
       let(:config_source) { :repository_source }
 
-      Dir.glob('**/*.gitlab-ci.yml', base: Rails.root.join('lib/gitlab/ci/templates')) do |template|
+      described_class.ci_templates.each do |template|
         next if described_class::TEMPLATE_TO_EVENT.key?(template)
 
-        it 'has an event defined' do
+        it "has an event defined for #{template}" do
           expect do
-            described_class.track_unique_project_event(project_id: project_id, template: described_class.send(:template_to_event, template), config_source: config_source)
+            described_class.track_unique_project_event(
+              project_id: project_id,
+              template: template,
+              config_source: config_source
+            )
           end.not_to raise_error
         end
 
@@ -104,7 +108,8 @@ RSpec.describe Gitlab::UsageDataCounters::CiTemplateUniqueCounter do
           end
 
           it "tracks #{template}" do
-            expect(Gitlab::UsageDataCounters::HLLRedisCounter).to(receive(:track_event)).with("p_ci_templates_#{File.basename(template, '.gitlab-ci.yml').underscore}", values: project_id)
+            expected_template_event_name = described_class.ci_template_event_name(template, :repository_source)
+            expect(Gitlab::UsageDataCounters::HLLRedisCounter).to(receive(:track_event)).with(expected_template_event_name, values: project_id)
 
             described_class.track_unique_project_event(project_id: project_id, template: template, config_source: config_source)
           end