Merge branch '33672-add-enable-checkbox-for-grafana-authentication-settings' into 'master'

Backend: Add checkbox to enable/disable grafana authentication

See merge request gitlab-org/gitlab!19234

app/controllers/projects/settings/operations_controller.rb

@@ -70,7 +70,7 @@ module Projects
             project: [:slug, :name, :organization_slug, :organization_name]
           ],
 
-          grafana_integration_attributes: [:token, :grafana_url]
+          grafana_integration_attributes: [:token, :grafana_url, :enabled]
         }
       end
     end

app/helpers/projects_helper.rb

@@ -362,6 +362,10 @@ module ProjectsHelper
     @project.grafana_integration&.token
   end
 
+  def grafana_integration_enabled?
+    @project.grafana_integration&.enabled?
+  end
+
   private
 
   def get_project_nav_tabs(project, current_user)

app/models/grafana_integration.rb

@@ -14,7 +14,11 @@ class GrafanaIntegration < ApplicationRecord
 
   validates :token, :project, presence: true
 
+  validates :enabled, inclusion: { in: [true, false] }
+
   def client
+    return unless enabled?
+
     @client ||= ::Grafana::Client.new(api_url: grafana_url.chomp('/'), token: token)
   end
 end

changelogs/unreleased/33672-add-enable-checkbox-for-grafana-authentication-settings.yml

+---
+title: Migrate enabled flag on grafana_integrations table
+merge_request: 19234
+author:
+type: changed

config/locales/en.yml

@@ -19,6 +19,7 @@ en:
       project/grafana_integration:
         token: "Grafana HTTP API Token"
         grafana_url: "Grafana API URL"
+        grafana_enabled: "Grafana integration enabled"
   views:
     pagination:
       previous: "Prev"

db/migrate/20191029191901_add_enabled_to_grafana_integrations.rb

+# frozen_string_literal: true
+
+class AddEnabledToGrafanaIntegrations < ActiveRecord::Migration[5.2]
+  include Gitlab::Database::MigrationHelpers
+
+  DOWNTIME = false
+
+  disable_ddl_transaction!
+
+  def up
+    add_column_with_default(
+      :grafana_integrations,
+      :enabled,
+      :boolean,
+      allow_null: false,
+      default: false
+    )
+  end
+
+  def down
+    remove_column(:grafana_integrations, :enabled)
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2019_10_26_124116) do
+ActiveRecord::Schema.define(version: 2019_10_29_191901) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_trgm"
@@ -1809,6 +1809,7 @@ ActiveRecord::Schema.define(version: 2019_10_26_124116) do
     t.string "encrypted_token", limit: 255, null: false
     t.string "encrypted_token_iv", limit: 255, null: false
     t.string "grafana_url", limit: 1024, null: false
+    t.boolean "enabled", default: false, null: false
     t.index ["project_id"], name: "index_grafana_integrations_on_project_id"
   end
 

spec/controllers/projects/settings/operations_controller_spec.rb

@@ -186,7 +186,8 @@ describe Projects::Settings::OperationsController do
         {
           grafana_integration_attributes: {
             grafana_url: 'https://grafana.gitlab.com',
-            token: 'eyJrIjoicDRlRTREdjhhOEZ5WjZPWXUzazJOSW0zZHJUejVOd3IiLCJuIjoiVGVzdCBLZXkiLCJpZCI6MX0='
+            token: 'eyJrIjoicDRlRTREdjhhOEZ5WjZPWXUzazJOSW0zZHJUejVOd3IiLCJuIjoiVGVzdCBLZXkiLCJpZCI6MX0=',
+            enabled: 'true'
           }
         }
       end

spec/factories/grafana_integrations.rb

@@ -5,5 +5,6 @@ FactoryBot.define do
     project
     grafana_url { 'https://grafana.example.com' }
     token { SecureRandom.hex(10) }
+    enabled { true }
   end
 end

spec/helpers/projects_helper_spec.rb

@@ -938,4 +938,22 @@ describe ProjectsHelper do
       it { is_expected.to eq(grafana_integration.token) }
     end
   end
+
+  describe '#grafana_integration_enabled?' do
+    let(:project) { create(:project) }
+
+    before do
+      helper.instance_variable_set(:@project, project)
+    end
+
+    subject { helper.grafana_integration_enabled? }
+
+    it { is_expected.to eq(nil) }
+
+    context 'grafana integration exists' do
+      let!(:grafana_integration) { create(:grafana_integration, project: project) }
+
+      it { is_expected.to eq(grafana_integration.enabled) }
+    end
+  end
 end

spec/models/grafana_integration_spec.rb

@@ -34,5 +34,36 @@ describe GrafanaIntegration do
         internal_url
       ).for(:grafana_url)
     end
+
+    it 'disallows non-booleans in enabled column' do
+      is_expected.not_to allow_value(
+        nil
+      ).for(:enabled)
+    end
+
+    it 'allows booleans in enabled column' do
+      is_expected.to allow_value(
+        true,
+        false
+      ).for(:enabled)
+    end
+  end
+
+  describe '.client' do
+    subject(:grafana_integration) { create(:grafana_integration) }
+
+    context 'with grafana integration disabled' do
+      it 'returns a grafana client' do
+        expect(grafana_integration.client).to be_an_instance_of(::Grafana::Client)
+      end
+    end
+
+    context 'with grafana integration enabled' do
+      it 'returns nil' do
+        grafana_integration.update(enabled: false)
+
+        expect(grafana_integration.client).to be(nil)
+      end
+    end
   end
 end