Merge branch 'feature/sm/34314-add-hasvariable-concern' into 'master'

Implement `HasVariable` concern

Closes #34314

See merge request !12448

app/models/ci/variable.rb

 module Ci
   class Variable < ActiveRecord::Base
     extend Ci::Model
+    include HasVariable
 
     belongs_to :project
 
-    validates :key,
-      presence: true,
-      uniqueness: { scope: :project_id },
-      length: { maximum: 255 },
-      format: { with: /\A[a-zA-Z0-9_]+\z/,
-                message: "can contain only letters, digits and '_'." }
+    validates :key, uniqueness: { scope: :project_id }
 
-    scope :order_key_asc, -> { reorder(key: :asc) }
     scope :unprotected, -> { where(protected: false) }
-
-    attr_encrypted :value,
-       mode: :per_attribute_iv_and_salt,
-       insecure_mode: true,
-       key: Gitlab::Application.secrets.db_key_base,
-       algorithm: 'aes-256-cbc'
-
-    def to_runner_variable
-      { key: key, value: value, public: false }
-    end
   end
 end

app/models/concerns/has_variable.rb

+module HasVariable
+  extend ActiveSupport::Concern
+
+  included do
+    validates :key,
+      presence: true,
+      length: { maximum: 255 },
+      format: { with: /\A[a-zA-Z0-9_]+\z/,
+                message: "can contain only letters, digits and '_'." }
+
+    scope :order_key_asc, -> { reorder(key: :asc) }
+
+    attr_encrypted :value,
+       mode: :per_attribute_iv_and_salt,
+       insecure_mode: true,
+       key: Gitlab::Application.secrets.db_key_base,
+       algorithm: 'aes-256-cbc'
+
+    def to_runner_variable
+      { key: key, value: value, public: false }
+    end
+  end
+end

spec/models/ci/variable_spec.rb

@@ -3,14 +3,8 @@ require 'spec_helper'
 describe Ci::Variable, models: true do
   subject { build(:ci_variable) }
 
-  let(:secret_value) { 'secret' }
-
-  it { is_expected.to validate_presence_of(:key) }
+  it { is_expected.to include_module(HasVariable) }
   it { is_expected.to validate_uniqueness_of(:key).scoped_to(:project_id) }
-  it { is_expected.to validate_length_of(:key).is_at_most(255) }
-  it { is_expected.to allow_value('foo').for(:key) }
-  it { is_expected.not_to allow_value('foo bar').for(:key) }
-  it { is_expected.not_to allow_value('foo/bar').for(:key) }
 
   describe '.unprotected' do
     subject { described_class.unprotected }
@@ -33,36 +27,4 @@ describe Ci::Variable, models: true do
       end
     end
   end
-
-  describe '#value' do
-    before do
-      subject.value = secret_value
-    end
-
-    it 'stores the encrypted value' do
-      expect(subject.encrypted_value).not_to be_nil
-    end
-
-    it 'stores an iv for value' do
-      expect(subject.encrypted_value_iv).not_to be_nil
-    end
-
-    it 'stores a salt for value' do
-      expect(subject.encrypted_value_salt).not_to be_nil
-    end
-
-    it 'fails to decrypt if iv is incorrect' do
-      subject.encrypted_value_iv = SecureRandom.hex
-      subject.instance_variable_set(:@value, nil)
-      expect { subject.value }
-        .to raise_error(OpenSSL::Cipher::CipherError, 'bad decrypt')
-    end
-  end
-
-  describe '#to_runner_variable' do
-    it 'returns a hash for the runner' do
-      expect(subject.to_runner_variable)
-        .to eq(key: subject.key, value: subject.value, public: false)
-    end
-  end
 end

spec/models/concerns/has_variable_spec.rb

+require 'spec_helper'
+
+describe HasVariable do
+  subject { build(:ci_variable) }
+
+  it { is_expected.to validate_presence_of(:key) }
+  it { is_expected.to validate_length_of(:key).is_at_most(255) }
+  it { is_expected.to allow_value('foo').for(:key) }
+  it { is_expected.not_to allow_value('foo bar').for(:key) }
+  it { is_expected.not_to allow_value('foo/bar').for(:key) }
+
+  describe '#value' do
+    before do
+      subject.value = 'secret'
+    end
+
+    it 'stores the encrypted value' do
+      expect(subject.encrypted_value).not_to be_nil
+    end
+
+    it 'stores an iv for value' do
+      expect(subject.encrypted_value_iv).not_to be_nil
+    end
+
+    it 'stores a salt for value' do
+      expect(subject.encrypted_value_salt).not_to be_nil
+    end
+
+    it 'fails to decrypt if iv is incorrect' do
+      subject.encrypted_value_iv = SecureRandom.hex
+      subject.instance_variable_set(:@value, nil)
+      expect { subject.value }
+        .to raise_error(OpenSSL::Cipher::CipherError, 'bad decrypt')
+    end
+  end
+
+  describe '#to_runner_variable' do
+    it 'returns a hash for the runner' do
+      expect(subject.to_runner_variable)
+        .to eq(key: subject.key, value: subject.value, public: false)
+    end
+  end
+end