Merge branch 'improve-usage-data-tests' into 'master'

Improve usage data tests

See merge request gitlab-org/gitlab!27420

spec/factories/usage_data.rb

+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :usage_data, class: 'Gitlab::UsageData' do
+    skip_create # non-model factories (i.e. without #save)
+
+    initialize_with do
+      projects = create_list(:project, 4)
+      create(:board, project: projects[0])
+      create(:jira_service, project: projects[0])
+      create(:jira_service, :without_properties_callback, project: projects[1])
+      create(:jira_service, :jira_cloud_service, project: projects[2])
+      create(:jira_service, :without_properties_callback, project: projects[3],
+             properties: { url: 'https://mysite.atlassian.net' })
+      create(:prometheus_service, project: projects[1])
+      create(:service, project: projects[0], type: 'SlackSlashCommandsService', active: true)
+      create(:service, project: projects[1], type: 'SlackService', active: true)
+      create(:service, project: projects[2], type: 'SlackService', active: true)
+      create(:service, project: projects[2], type: 'MattermostService', active: false)
+      create(:service, :template, type: 'MattermostService', active: true)
+      create(:service, project: projects[2], type: 'CustomIssueTrackerService', active: true)
+      create(:project_error_tracking_setting, project: projects[0])
+      create(:project_error_tracking_setting, project: projects[1], enabled: false)
+      create(:alerts_service, project: projects[0])
+      create(:alerts_service, :inactive, project: projects[1])
+      create_list(:issue, 2, project: projects[0], author: User.alert_bot)
+      create_list(:issue, 2, project: projects[1], author: User.alert_bot)
+      create_list(:issue, 4, project: projects[0])
+      create(:zoom_meeting, project: projects[0], issue: projects[0].issues[0], issue_status: :added)
+      create_list(:zoom_meeting, 2, project: projects[0], issue: projects[0].issues[1], issue_status: :removed)
+      create(:zoom_meeting, project: projects[0], issue: projects[0].issues[2], issue_status: :added)
+      create_list(:zoom_meeting, 2, project: projects[0], issue: projects[0].issues[2], issue_status: :removed)
+      create(:sentry_issue, issue: projects[0].issues[0])
+
+      # Enabled clusters
+      gcp_cluster = create(:cluster_provider_gcp, :created).cluster
+      create(:cluster_provider_aws, :created)
+      create(:cluster_platform_kubernetes)
+      create(:cluster, :group)
+
+      # Disabled clusters
+      create(:cluster, :disabled)
+      create(:cluster, :group, :disabled)
+      create(:cluster, :group, :disabled)
+
+      # Applications
+      create(:clusters_applications_helm, :installed, cluster: gcp_cluster)
+      create(:clusters_applications_ingress, :installed, cluster: gcp_cluster)
+      create(:clusters_applications_cert_manager, :installed, cluster: gcp_cluster)
+      create(:clusters_applications_prometheus, :installed, cluster: gcp_cluster)
+      create(:clusters_applications_crossplane, :installed, cluster: gcp_cluster)
+      create(:clusters_applications_runner, :installed, cluster: gcp_cluster)
+      create(:clusters_applications_knative, :installed, cluster: gcp_cluster)
+      create(:clusters_applications_elastic_stack, :installed, cluster: gcp_cluster)
+      create(:clusters_applications_jupyter, :installed, cluster: gcp_cluster)
+
+      create(:grafana_integration, project: projects[0], enabled: true)
+      create(:grafana_integration, project: projects[1], enabled: true)
+      create(:grafana_integration, project: projects[2], enabled: false)
+
+      ProjectFeature.first.update_attribute('repository_access_level', 0)
+    end
+  end
+end

spec/lib/gitlab/usage_data_spec.rb

@@ -2,223 +2,38 @@
 
 require 'spec_helper'
 
-describe Gitlab::UsageData do
-  let(:projects) { create_list(:project, 4) }
-  let!(:board) { create(:board, project: projects[0]) }
+describe Gitlab::UsageData, :aggregate_failures do
+  include UsageDataHelpers
 
   before do
     allow(ActiveRecord::Base.connection).to receive(:transaction_open?).and_return(false)
   end
-  [true, false].each do |usage_ping_batch_counter_on|
-    describe "when the feature flag usage_ping_batch_counter is set to #{usage_ping_batch_counter_on}" do
-      before do
-        stub_feature_flags(usage_ping_batch_counter: usage_ping_batch_counter_on)
-      end
 
+  shared_examples "usage data execution" do
     describe '#data' do
-        before do
-          create(:jira_service, project: projects[0])
-          create(:jira_service, :without_properties_callback, project: projects[1])
-          create(:jira_service, :jira_cloud_service, project: projects[2])
-          create(:jira_service, :without_properties_callback, project: projects[3],
-                 properties: { url: 'https://mysite.atlassian.net' })
-          create(:prometheus_service, project: projects[1])
-          create(:service, project: projects[0], type: 'SlackSlashCommandsService', active: true)
-          create(:service, project: projects[1], type: 'SlackService', active: true)
-          create(:service, project: projects[2], type: 'SlackService', active: true)
-          create(:service, project: projects[2], type: 'MattermostService', active: false)
-          create(:service, :template, type: 'MattermostService', active: true)
-          create(:service, project: projects[2], type: 'CustomIssueTrackerService', active: true)
-          create(:project_error_tracking_setting, project: projects[0])
-          create(:project_error_tracking_setting, project: projects[1], enabled: false)
-          create(:alerts_service, project: projects[0])
-          create(:alerts_service, :inactive, project: projects[1])
-          create_list(:issue, 2, project: projects[0], author: User.alert_bot)
-          create_list(:issue, 2, project: projects[1], author: User.alert_bot)
-          create_list(:issue, 4, project: projects[0])
-          create(:zoom_meeting, project: projects[0], issue: projects[0].issues[0], issue_status: :added)
-          create_list(:zoom_meeting, 2, project: projects[0], issue: projects[0].issues[1], issue_status: :removed)
-          create(:zoom_meeting, project: projects[0], issue: projects[0].issues[2], issue_status: :added)
-          create_list(:zoom_meeting, 2, project: projects[0], issue: projects[0].issues[2], issue_status: :removed)
-          create(:sentry_issue, issue: projects[0].issues[0])
-
-          # Enabled clusters
-          gcp_cluster = create(:cluster_provider_gcp, :created).cluster
-          create(:cluster_provider_aws, :created)
-          create(:cluster_platform_kubernetes)
-          create(:cluster, :group)
-
-          # Disabled clusters
-          create(:cluster, :disabled)
-          create(:cluster, :group, :disabled)
-          create(:cluster, :group, :disabled)
-
-          # Applications
-          create(:clusters_applications_helm, :installed, cluster: gcp_cluster)
-          create(:clusters_applications_ingress, :installed, cluster: gcp_cluster)
-          create(:clusters_applications_cert_manager, :installed, cluster: gcp_cluster)
-          create(:clusters_applications_prometheus, :installed, cluster: gcp_cluster)
-          create(:clusters_applications_crossplane, :installed, cluster: gcp_cluster)
-          create(:clusters_applications_runner, :installed, cluster: gcp_cluster)
-          create(:clusters_applications_knative, :installed, cluster: gcp_cluster)
-          create(:clusters_applications_elastic_stack, :installed, cluster: gcp_cluster)
-          create(:clusters_applications_jupyter, :installed, cluster: gcp_cluster)
-
-          create(:grafana_integration, project: projects[0], enabled: true)
-          create(:grafana_integration, project: projects[1], enabled: true)
-          create(:grafana_integration, project: projects[2], enabled: false)
+      let!(:ud) { build(:usage_data) }
 
+      before do
         allow(Gitlab::GrafanaEmbedUsageData).to receive(:issue_count).and_return(2)
-
-          ProjectFeature.first.update_attribute('repository_access_level', 0)
       end
 
       subject { described_class.data }
 
-        it 'gathers usage data', :aggregate_failures do
-          expect(subject.keys).to include(*%i(
-            active_user_count
-            counts
-            recorded_at
-            edition
-            version
-            installation_type
-            uuid
-            hostname
-            mattermost_enabled
-            signup_enabled
-            ldap_enabled
-            gravatar_enabled
-            omniauth_enabled
-            reply_by_email_enabled
-            container_registry_enabled
-            dependency_proxy_enabled
-            gitlab_shared_runners_enabled
-            gitlab_pages
-            git
-            gitaly
-            database
-            avg_cycle_analytics
-            influxdb_metrics_enabled
-            prometheus_metrics_enabled
-            web_ide_clientside_preview_enabled
-            ingress_modsecurity_enabled
-          ))
+      it 'gathers usage data' do
+        expect(subject.keys).to include(*UsageDataHelpers::USAGE_DATA_KEYS)
       end
 
       it 'gathers usage counts' do
-          smau_keys = %i(
-            snippet_create
-            snippet_update
-            snippet_comment
-            merge_request_comment
-            merge_request_create
-            commit_comment
-            wiki_pages_create
-            wiki_pages_update
-            wiki_pages_delete
-            web_ide_views
-            web_ide_commits
-            web_ide_merge_requests
-            web_ide_previews
-            navbar_searches
-            cycle_analytics_views
-            productivity_analytics_views
-            source_code_pushes
-          )
-
-          expected_keys = %i(
-            assignee_lists
-            boards
-            ci_builds
-            ci_internal_pipelines
-            ci_external_pipelines
-            ci_pipeline_config_auto_devops
-            ci_pipeline_config_repository
-            ci_runners
-            ci_triggers
-            ci_pipeline_schedules
-            auto_devops_enabled
-            auto_devops_disabled
-            deploy_keys
-            deployments
-            successful_deployments
-            failed_deployments
-            environments
-            clusters
-            clusters_enabled
-            project_clusters_enabled
-            group_clusters_enabled
-            clusters_disabled
-            project_clusters_disabled
-            group_clusters_disabled
-            clusters_platforms_eks
-            clusters_platforms_gke
-            clusters_platforms_user
-            clusters_applications_helm
-            clusters_applications_ingress
-            clusters_applications_cert_managers
-            clusters_applications_prometheus
-            clusters_applications_crossplane
-            clusters_applications_runner
-            clusters_applications_knative
-            clusters_applications_elastic_stack
-            clusters_applications_jupyter
-            in_review_folder
-            grafana_integrated_projects
-            groups
-            issues
-            issues_created_from_gitlab_error_tracking_ui
-            issues_with_associated_zoom_link
-            issues_using_zoom_quick_actions
-            issues_with_embedded_grafana_charts_approx
-            incident_issues
-            keys
-            label_lists
-            labels
-            lfs_objects
-            merge_requests
-            milestone_lists
-            milestones
-            notes
-            pool_repositories
-            projects
-            projects_imported_from_github
-            projects_asana_active
-            projects_jira_active
-            projects_jira_server_active
-            projects_jira_cloud_active
-            projects_slack_notifications_active
-            projects_slack_slash_active
-            projects_slack_active
-            projects_slack_slash_commands_active
-            projects_custom_issue_tracker_active
-            projects_mattermost_active
-            projects_prometheus_active
-            projects_with_repositories_enabled
-            projects_with_error_tracking_enabled
-            projects_with_alerts_service_enabled
-            pages_domains
-            protected_branches
-            releases
-            remote_mirrors
-            snippets
-            suggestions
-            todos
-            uploads
-            web_hooks
-          ).push(*smau_keys)
-
         count_data = subject[:counts]
 
         expect(count_data[:boards]).to eq(1)
         expect(count_data[:projects]).to eq(4)
-          expect(count_data.values_at(*smau_keys)).to all(be_an(Integer))
-          expect(count_data.keys).to include(*expected_keys)
-          expect(expected_keys - count_data.keys).to be_empty
+        expect(count_data.values_at(*UsageDataHelpers::SMAU_KEYS)).to all(be_an(Integer))
+        expect(count_data.keys).to include(*UsageDataHelpers::COUNTS_KEYS)
+        expect(UsageDataHelpers::COUNTS_KEYS - count_data.keys).to be_empty
       end
 
-        it 'gathers projects data correctly', :aggregate_failures do
+      it 'gathers projects data correctly' do
         count_data = subject[:counts]
 
         expect(count_data[:projects]).to eq(4)
@@ -291,10 +106,23 @@ describe Gitlab::UsageData do
       end
     end
 
+    describe '#license_usage_data' do
+      subject { described_class.license_usage_data }
+
+      it 'gathers license data' do
+        expect(subject[:uuid]).to eq(Gitlab::CurrentSettings.uuid)
+        expect(subject[:version]).to eq(Gitlab::VERSION)
+        expect(subject[:installation_type]).to eq('gitlab-development-kit')
+        expect(subject[:active_user_count]).to eq(User.active.size)
+        expect(subject[:recorded_at]).to be_a(Time)
+      end
+    end
+
+    context 'when not relying on database records' do
       describe '#features_usage_data_ce' do
         subject { described_class.features_usage_data_ce }
 
-        it 'gathers feature usage data', :aggregate_failures do
+        it 'gathers feature usage data' do
           expect(subject[:mattermost_enabled]).to eq(Gitlab.config.mattermost.enabled)
           expect(subject[:signup_enabled]).to eq(Gitlab::CurrentSettings.allow_signup?)
           expect(subject[:ldap_enabled]).to eq(Gitlab.config.ldap.enabled)
@@ -311,7 +139,7 @@ describe Gitlab::UsageData do
       describe '#components_usage_data' do
         subject { described_class.components_usage_data }
 
-        it 'gathers components usage data', :aggregate_failures do
+        it 'gathers components usage data' do
           expect(subject[:gitlab_pages][:enabled]).to eq(Gitlab.config.pages.enabled)
           expect(subject[:gitlab_pages][:version]).to eq(Gitlab::Pages::VERSION)
           expect(subject[:git][:version]).to eq(Gitlab::Git.version)
@@ -360,18 +188,6 @@ describe Gitlab::UsageData do
         end
       end
 
-      describe '#license_usage_data' do
-        subject { described_class.license_usage_data }
-
-        it 'gathers license data', :aggregate_failures do
-          expect(subject[:uuid]).to eq(Gitlab::CurrentSettings.uuid)
-          expect(subject[:version]).to eq(Gitlab::VERSION)
-          expect(subject[:installation_type]).to eq('gitlab-development-kit')
-          expect(subject[:active_user_count]).to eq(User.active.count)
-          expect(subject[:recorded_at]).to be_a(Time)
-        end
-      end
-
       describe '#count' do
         let(:relation) { double(:relation) }
 
@@ -405,4 +221,20 @@ describe Gitlab::UsageData do
       end
     end
   end
+
+  context 'when usage usage_ping_batch_counter is true' do
+    before do
+      stub_feature_flags(usage_ping_batch_counter: true)
+    end
+
+    it_behaves_like 'usage data execution'
+  end
+
+  context 'when usage usage_ping_batch_counter is false' do
+    before do
+      stub_feature_flags(usage_ping_batch_counter: false)
+    end
+
+    it_behaves_like 'usage data execution'
+  end
 end

spec/support/helpers/usage_data_helpers.rb

+# frozen_string_literal: true
+
+module UsageDataHelpers
+  SMAU_KEYS = %i(
+      snippet_create
+      snippet_update
+      snippet_comment
+      merge_request_comment
+      merge_request_create
+      commit_comment
+      wiki_pages_create
+      wiki_pages_update
+      wiki_pages_delete
+      web_ide_views
+      web_ide_commits
+      web_ide_merge_requests
+      web_ide_previews
+      navbar_searches
+      cycle_analytics_views
+      productivity_analytics_views
+      source_code_pushes
+    ).freeze
+
+  COUNTS_KEYS = %i(
+      assignee_lists
+      boards
+      ci_builds
+      ci_internal_pipelines
+      ci_external_pipelines
+      ci_pipeline_config_auto_devops
+      ci_pipeline_config_repository
+      ci_runners
+      ci_triggers
+      ci_pipeline_schedules
+      auto_devops_enabled
+      auto_devops_disabled
+      deploy_keys
+      deployments
+      successful_deployments
+      failed_deployments
+      environments
+      clusters
+      clusters_enabled
+      project_clusters_enabled
+      group_clusters_enabled
+      clusters_disabled
+      project_clusters_disabled
+      group_clusters_disabled
+      clusters_platforms_eks
+      clusters_platforms_gke
+      clusters_platforms_user
+      clusters_applications_helm
+      clusters_applications_ingress
+      clusters_applications_cert_managers
+      clusters_applications_prometheus
+      clusters_applications_crossplane
+      clusters_applications_runner
+      clusters_applications_knative
+      clusters_applications_elastic_stack
+      clusters_applications_jupyter
+      in_review_folder
+      grafana_integrated_projects
+      groups
+      issues
+      issues_created_from_gitlab_error_tracking_ui
+      issues_with_associated_zoom_link
+      issues_using_zoom_quick_actions
+      issues_with_embedded_grafana_charts_approx
+      incident_issues
+      keys
+      label_lists
+      labels
+      lfs_objects
+      merge_requests
+      milestone_lists
+      milestones
+      notes
+      pool_repositories
+      projects
+      projects_imported_from_github
+      projects_asana_active
+      projects_jira_active
+      projects_jira_server_active
+      projects_jira_cloud_active
+      projects_slack_notifications_active
+      projects_slack_slash_active
+      projects_slack_active
+      projects_slack_slash_commands_active
+      projects_custom_issue_tracker_active
+      projects_mattermost_active
+      projects_prometheus_active
+      projects_with_repositories_enabled
+      projects_with_error_tracking_enabled
+      projects_with_alerts_service_enabled
+      pages_domains
+      protected_branches
+      releases
+      remote_mirrors
+      snippets
+      suggestions
+      todos
+      uploads
+      web_hooks
+    ).push(*SMAU_KEYS)
+
+  USAGE_DATA_KEYS = %i(
+      active_user_count
+      counts
+      recorded_at
+      edition
+      version
+      installation_type
+      uuid
+      hostname
+      mattermost_enabled
+      signup_enabled
+      ldap_enabled
+      gravatar_enabled
+      omniauth_enabled
+      reply_by_email_enabled
+      container_registry_enabled
+      dependency_proxy_enabled
+      gitlab_shared_runners_enabled
+      gitlab_pages
+      git
+      gitaly
+      database
+      avg_cycle_analytics
+      influxdb_metrics_enabled
+      prometheus_metrics_enabled
+      web_ide_clientside_preview_enabled
+      ingress_modsecurity_enabled
+    ).freeze
+end