Merge branch...

Merge branch '10014-ee-spec-models-ci-build_spec-rb-ee-spec-requests-api-runner_spec-rb-and-ee-spec-services-ci-process_pipeline_service_spec-rb-are-all-failing' into 'master'

Resolve variable masking spec failures

Closes #10014

See merge request gitlab-org/gitlab-ee!9734

app/models/ci/group_variable.rb

@@ -5,6 +5,7 @@ module Ci
     extend Gitlab::Ci::Model
     include HasVariable
     include Presentable
+    include Maskable
 
     belongs_to :group, class_name: "::Group"
 

app/models/ci/variable.rb

@@ -5,6 +5,7 @@ module Ci
     extend Gitlab::Ci::Model
     include HasVariable
     include Presentable
+    include Maskable
 
     belongs_to :project
 

app/models/concerns/has_variable.rb

@@ -21,9 +21,9 @@ module HasVariable
     def key=(new_key)
       super(new_key.to_s.strip)
     end
+  end
 
-    def to_runner_variable
-      { key: key, value: value, public: false }
-    end
+  def to_runner_variable
+    { key: key, value: value, public: false }
   end
 end

app/models/concerns/maskable.rb

+# frozen_string_literal: true
+
+module Maskable
+  extend ActiveSupport::Concern
+
+  # * Single line
+  # * No escape characters
+  # * No variables
+  # * No spaces
+  # * Minimal length of 8 characters
+  # * Absolutely no fun is allowed
+  REGEX = /\A\w{8,}\z/
+
+  included do
+    validates :masked, inclusion: { in: [true, false] }
+    validates :value, format: { with: REGEX }, if: :masked?
+  end
+
+  def to_runner_variable
+    super.merge(masked: masked?)
+  end
+end

changelogs/unreleased/13784-simple-masking-of-protected-variables-in-logs.yml

+---
+title: Add support for masking CI variables.
+merge_request: 25293
+author:
+type: added

db/migrate/20190218134158_add_masked_to_ci_variables.rb

+# frozen_string_literal: true
+
+# See http://doc.gitlab.com/ce/development/migration_style_guide.html
+# for more information on how to write migrations for GitLab.
+
+class AddMaskedToCiVariables < ActiveRecord::Migration[5.0]
+  include Gitlab::Database::MigrationHelpers
+
+  # Set this constant to true if this migration requires downtime.
+  DOWNTIME = false
+
+  disable_ddl_transaction!
+
+  def up
+    add_column_with_default :ci_variables, :masked, :boolean, default: false, allow_null: false
+  end
+
+  def down
+    remove_column :ci_variables, :masked
+  end
+end

db/migrate/20190218134209_add_masked_to_ci_group_variables.rb

+# frozen_string_literal: true
+
+# See http://doc.gitlab.com/ce/development/migration_style_guide.html
+# for more information on how to write migrations for GitLab.
+
+class AddMaskedToCiGroupVariables < ActiveRecord::Migration[5.0]
+  include Gitlab::Database::MigrationHelpers
+
+  # Set this constant to true if this migration requires downtime.
+  DOWNTIME = false
+
+  disable_ddl_transaction!
+
+  def up
+    add_column_with_default :ci_group_variables, :masked, :boolean, default: false, allow_null: false
+  end
+
+  def down
+    remove_column :ci_group_variables, :masked
+  end
+end

db/schema.rb

@@ -556,6 +556,7 @@ ActiveRecord::Schema.define(version: 20190220150130) do
     t.boolean "protected", default: false, null: false
     t.datetime_with_timezone "created_at", null: false
     t.datetime_with_timezone "updated_at", null: false
+    t.boolean "masked", default: false, null: false
     t.index ["group_id", "key"], name: "index_ci_group_variables_on_group_id_and_key", unique: true, using: :btree
   end
 
@@ -766,6 +767,7 @@ ActiveRecord::Schema.define(version: 20190220150130) do
     t.integer "project_id", null: false
     t.boolean "protected", default: false, null: false
     t.string "environment_scope", default: "*", null: false
+    t.boolean "masked", default: false, null: false
     t.index ["project_id", "key", "environment_scope"], name: "index_ci_variables_on_project_id_and_key_and_environment_scope", unique: true, using: :btree
   end
 

ee/spec/models/ci/build_spec.rb

@@ -75,8 +75,8 @@ describe Ci::Build do
     subject { job.variables }
 
     context 'when environment specific variable is defined' do
-      let(:environment_varialbe) do
-        { key: 'ENV_KEY', value: 'environment', public: false }
+      let(:environment_variable) do
+        { key: 'ENV_KEY', value: 'environment', public: false, masked: false }
       end
 
       before do
@@ -85,7 +85,7 @@ describe Ci::Build do
 
         variable =
           build(:ci_variable,
-                environment_varialbe.slice(:key, :value)
+                environment_variable.slice(:key, :value)
                   .merge(project: project, environment_scope: 'stag*'))
 
         variable.save!
@@ -96,7 +96,7 @@ describe Ci::Build do
           stub_licensed_features(variable_environment_scope: true)
         end
 
-        it { is_expected.to include(environment_varialbe) }
+        it { is_expected.to include(environment_variable) }
       end
 
       context 'when variable environment scope is not available' do
@@ -104,12 +104,12 @@ describe Ci::Build do
           stub_licensed_features(variable_environment_scope: false)
         end
 
-        it { is_expected.not_to include(environment_varialbe) }
+        it { is_expected.not_to include(environment_variable) }
       end
 
       context 'when there is a plan for the group' do
         it 'GITLAB_FEATURES should include the features for that plan' do
-          is_expected.to include({ key: 'GITLAB_FEATURES', value: anything, public: true })
+          is_expected.to include({ key: 'GITLAB_FEATURES', value: anything, public: true, masked: false })
           features_variable = subject.find { |v| v[:key] == 'GITLAB_FEATURES' }
           expect(features_variable[:value]).to include('multiple_ldap_servers')
         end

ee/spec/requests/api/runner_spec.rb

@@ -46,7 +46,7 @@ describe API::Runner, :clean_gitlab_redis_shared_state do
             expect(response).to have_http_status(:created)
             expect(json_response).to include(
               "id" => build.id,
-              "variables" => include("key" => 'KEY', "value" => 'value', "public" => true),
+              "variables" => include("key" => 'KEY', "value" => 'value', "public" => true, "masked" => false),
               "image" => a_hash_including("name" => 'ruby'),
               "services" => all(a_hash_including("name" => 'mysql')),
               "job_info" => a_hash_including("name" => 'terminal', "stage" => 'terminal'))

ee/spec/services/ci/process_pipeline_service_spec.rb

@@ -38,7 +38,7 @@ describe Ci::ProcessPipelineService, '#execute' do
       expect(downstream.ci_pipelines.first).to be_pending
       expect(downstream.builds).not_to be_empty
       expect(downstream.builds.first.variables)
-        .to include(key: 'BRIDGE', value: 'cross', public: false)
+        .to include(key: 'BRIDGE', value: 'cross', public: false, masked: false)
     end
   end
 

lib/gitlab/ci/variables/collection/item.rb

@@ -5,12 +5,12 @@ module Gitlab
     module Variables
       class Collection
         class Item
-          def initialize(key:, value:, public: true, file: false)
+          def initialize(key:, value:, public: true, file: false, masked: false)
             raise ArgumentError, "`#{key}` must be of type String or nil value, while it was: #{value.class}" unless
               value.is_a?(String) || value.nil?
 
             @variable = {
-              key: key, value: value, public: public, file: file
+              key: key, value: value, public: public, file: file, masked: masked
             }
           end
 
@@ -27,9 +27,13 @@ module Gitlab
           # don't expose `file` attribute at all (stems from what the runner
           # expects).
           #
+          # If the `variable_masking` feature is enabled we expose the `masked`
+          # attribute, otherwise it's not exposed.
+          #
           def to_runner_variable
             @variable.reject do |hash_key, hash_value|
-              hash_key == :file && hash_value == false
+              (hash_key == :file && hash_value == false) ||
+                (hash_key == :masked && !Feature.enabled?(:variable_masking))
             end
           end
 

spec/factories/ci/group_variables.rb

@@ -2,6 +2,7 @@ FactoryBot.define do
   factory :ci_group_variable, class: Ci::GroupVariable do
     sequence(:key) { |n| "VARIABLE_#{n}" }
     value 'VARIABLE_VALUE'
+    masked false
 
     trait(:protected) do
       protected true

spec/factories/ci/variables.rb

@@ -2,6 +2,7 @@ FactoryBot.define do
   factory :ci_variable, class: Ci::Variable do
     sequence(:key) { |n| "VARIABLE_#{n}" }
     value 'VARIABLE_VALUE'
+    masked false
 
     trait(:protected) do
       protected true

spec/features/group_variables_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'Group variables', :js do
   let(:user) { create(:user) }
   let(:group) { create(:group) }
-  let!(:variable) { create(:ci_group_variable, key: 'test_key', value: 'test value', group: group) }
+  let!(:variable) { create(:ci_group_variable, key: 'test_key', value: 'test_value', group: group) }
   let(:page_path) { group_settings_ci_cd_path(group) }
 
   before do

spec/features/project_variables_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'Project variables', :js do
   let(:user)     { create(:user) }
   let(:project)  { create(:project) }
-  let(:variable) { create(:ci_variable, key: 'test_key', value: 'test value') }
+  let(:variable) { create(:ci_variable, key: 'test_key', value: 'test_value') }
   let(:page_path) { project_settings_ci_cd_path(project) }
 
   before do

spec/lib/gitlab/ci/variables/collection/item_spec.rb

@@ -6,7 +6,7 @@ describe Gitlab::Ci::Variables::Collection::Item do
   let(:expected_value) { variable_value }
 
   let(:variable) do
-    { key: variable_key, value: variable_value, public: true }
+    { key: variable_key, value: variable_value, public: true, masked: false }
   end
 
   describe '.new' do
@@ -88,7 +88,7 @@ describe Gitlab::Ci::Variables::Collection::Item do
       resource = described_class.fabricate(variable)
 
       expect(resource).to be_a(described_class)
-      expect(resource).to eq(key: 'CI_VAR', value: '123', public: false)
+      expect(resource).to eq(key: 'CI_VAR', value: '123', public: false, masked: false)
     end
 
     it 'supports using another collection item' do
@@ -134,7 +134,21 @@ describe Gitlab::Ci::Variables::Collection::Item do
           .to_runner_variable
 
         expect(runner_variable)
-          .to eq(key: 'VAR', value: 'value', public: true, file: true)
+          .to eq(key: 'VAR', value: 'value', public: true, file: true, masked: false)
+      end
+    end
+
+    context 'when variable masking is disabled' do
+      before do
+        stub_feature_flags(variable_masking: false)
+      end
+
+      it 'does not expose the masked field to the runner' do
+        runner_variable = described_class
+          .new(key: 'VAR', value: 'value', masked: true)
+          .to_runner_variable
+
+        expect(runner_variable).to eq(key: 'VAR', value: 'value', public: true)
       end
     end
   end

spec/lib/gitlab/ci/variables/collection_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Gitlab::Ci::Variables::Collection do
   describe '.new' do
     it 'can be initialized with an array' do
-      variable = { key: 'VAR', value: 'value', public: true }
+      variable = { key: 'VAR', value: 'value', public: true, masked: false }
 
       collection = described_class.new([variable])
 
@@ -93,7 +93,7 @@ describe Gitlab::Ci::Variables::Collection do
       collection = described_class.new([{ key: 'TEST', value: '1' }])
 
       expect(collection.to_runner_variables)
-        .to eq [{ key: 'TEST', value: '1', public: true }]
+        .to eq [{ key: 'TEST', value: '1', public: true, masked: false }]
     end
   end
 

spec/models/ci/group_variable_spec.rb

@@ -5,6 +5,7 @@ describe Ci::GroupVariable do
 
   it { is_expected.to include_module(HasVariable) }
   it { is_expected.to include_module(Presentable) }
+  it { is_expected.to include_module(Maskable) }
   it { is_expected.to validate_uniqueness_of(:key).scoped_to(:group_id).with_message(/\(\w+\) has already been taken/) }
 
   describe '.unprotected' do

spec/models/ci/variable_spec.rb

@@ -12,6 +12,7 @@ describe Ci::Variable do
     it { is_expected.to include_module(HasEnvironmentScope) }
     it { is_expected.to include_module(HasVariable) }
     it { is_expected.to include_module(Presentable) }
+    it { is_expected.to include_module(Maskable) }
     it { is_expected.to validate_uniqueness_of(:key).scoped_to(:project_id, :environment_scope).with_message(/\(\w+\) has already been taken/) }
   end
 

spec/models/concerns/has_variable_spec.rb

@@ -57,7 +57,7 @@ describe HasVariable do
   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)
+        .to include(key: subject.key, value: subject.value, public: false)
     end
   end
 end

spec/models/concerns/maskable_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Maskable do
+  let(:variable) { build(:ci_variable) }
+
+  describe 'masked value validations' do
+    subject { variable }
+
+    context 'when variable is masked' do
+      before do
+        subject.masked = true
+      end
+
+      it { is_expected.not_to allow_value('hello').for(:value) }
+      it { is_expected.not_to allow_value('hello world').for(:value) }
+      it { is_expected.not_to allow_value('hello$VARIABLEworld').for(:value) }
+      it { is_expected.not_to allow_value('hello\rworld').for(:value) }
+      it { is_expected.to allow_value('helloworld').for(:value) }
+    end
+
+    context 'when variable is not masked' do
+      before do
+        subject.masked = false
+      end
+
+      it { is_expected.to allow_value('hello').for(:value) }
+      it { is_expected.to allow_value('hello world').for(:value) }
+      it { is_expected.to allow_value('hello$VARIABLEworld').for(:value) }
+      it { is_expected.to allow_value('hello\rworld').for(:value) }
+      it { is_expected.to allow_value('helloworld').for(:value) }
+    end
+  end
+
+  describe 'REGEX' do
+    subject { Maskable::REGEX }
+
+    it 'does not match strings shorter than 8 letters' do
+      expect(subject.match?('hello')).to eq(false)
+    end
+
+    it 'does not match strings with spaces' do
+      expect(subject.match?('hello world')).to eq(false)
+    end
+
+    it 'does not match strings with shell variables' do
+      expect(subject.match?('hello$VARIABLEworld')).to eq(false)
+    end
+
+    it 'does not match strings with escape characters' do
+      expect(subject.match?('hello\rworld')).to eq(false)
+    end
+
+    it 'does not match strings that span more than one line' do
+      string = <<~EOS
+        hello
+        world
+      EOS
+
+      expect(subject.match?(string)).to eq(false)
+    end
+
+    it 'matches valid strings' do
+      expect(subject.match?('helloworld')).to eq(true)
+    end
+  end
+
+  describe '#to_runner_variable' do
+    subject { variable.to_runner_variable }
+
+    it 'exposes the masked attribute' do
+      expect(subject).to include(:masked)
+    end
+  end
+end

spec/requests/api/group_variables_spec.rb

@@ -87,12 +87,12 @@ describe API::GroupVariables do
 
       it 'creates variable' do
         expect do
-          post api("/groups/#{group.id}/variables", user), params: { key: 'TEST_VARIABLE_2', value: 'VALUE_2', protected: true }
+          post api("/groups/#{group.id}/variables", user), params: { key: 'TEST_VARIABLE_2', value: 'PROTECTED_VALUE_2', protected: true }
         end.to change {group.variables.count}.by(1)
 
         expect(response).to have_gitlab_http_status(201)
         expect(json_response['key']).to eq('TEST_VARIABLE_2')
-        expect(json_response['value']).to eq('VALUE_2')
+        expect(json_response['value']).to eq('PROTECTED_VALUE_2')
         expect(json_response['protected']).to be_truthy
       end
 

spec/requests/api/runner_spec.rb

@@ -436,9 +436,9 @@ describe API::Runner, :clean_gitlab_redis_shared_state do
           end
 
           let(:expected_variables) do
-            [{ 'key' => 'CI_JOB_NAME', 'value' => 'spinach', 'public' => true },
-             { 'key' => 'CI_JOB_STAGE', 'value' => 'test', 'public' => true },
-             { 'key' => 'DB_NAME', 'value' => 'postgres', 'public' => true }]
+            [{ 'key' => 'CI_JOB_NAME', 'value' => 'spinach', 'public' => true, 'masked' => false },
+             { 'key' => 'CI_JOB_STAGE', 'value' => 'test', 'public' => true, 'masked' => false },
+             { 'key' => 'DB_NAME', 'value' => 'postgres', 'public' => true, 'masked' => false }]
           end
 
           let(:expected_artifacts) do
@@ -740,12 +740,12 @@ describe API::Runner, :clean_gitlab_redis_shared_state do
 
           context 'when triggered job is available' do
             let(:expected_variables) do
-              [{ 'key' => 'CI_JOB_NAME', 'value' => 'spinach', 'public' => true },
-               { 'key' => 'CI_JOB_STAGE', 'value' => 'test', 'public' => true },
-               { 'key' => 'CI_PIPELINE_TRIGGERED', 'value' => 'true', 'public' => true },
-               { 'key' => 'DB_NAME', 'value' => 'postgres', 'public' => true },
-               { 'key' => 'SECRET_KEY', 'value' => 'secret_value', 'public' => false },
-               { 'key' => 'TRIGGER_KEY_1', 'value' => 'TRIGGER_VALUE_1', 'public' => false }]
+              [{ 'key' => 'CI_JOB_NAME', 'value' => 'spinach', 'public' => true, 'masked' => false },
+               { 'key' => 'CI_JOB_STAGE', 'value' => 'test', 'public' => true, 'masked' => false },
+               { 'key' => 'CI_PIPELINE_TRIGGERED', 'value' => 'true', 'public' => true, 'masked' => false },
+               { 'key' => 'DB_NAME', 'value' => 'postgres', 'public' => true, 'masked' => false },
+               { 'key' => 'SECRET_KEY', 'value' => 'secret_value', 'public' => false, 'masked' => false },
+               { 'key' => 'TRIGGER_KEY_1', 'value' => 'TRIGGER_VALUE_1', 'public' => false, 'masked' => false }]
             end
 
             let(:trigger) { create(:ci_trigger, project: project) }

spec/requests/api/variables_spec.rb

@@ -73,12 +73,12 @@ describe API::Variables do
     context 'authorized user with proper permissions' do
       it 'creates variable' do
         expect do
-          post api("/projects/#{project.id}/variables", user), params: { key: 'TEST_VARIABLE_2', value: 'VALUE_2', protected: true }
+          post api("/projects/#{project.id}/variables", user), params: { key: 'TEST_VARIABLE_2', value: 'PROTECTED_VALUE_2', protected: true }
         end.to change {project.variables.count}.by(1)
 
         expect(response).to have_gitlab_http_status(201)
         expect(json_response['key']).to eq('TEST_VARIABLE_2')
-        expect(json_response['value']).to eq('VALUE_2')
+        expect(json_response['value']).to eq('PROTECTED_VALUE_2')
         expect(json_response['protected']).to be_truthy
       end
 

spec/support/features/variable_list_shared_examples.rb

@@ -8,7 +8,7 @@ shared_examples 'variable list' do
   it 'adds new CI variable' do
     page.within('.js-ci-variable-list-section .js-row:last-child') do
       find('.js-ci-variable-input-key').set('key')
-      find('.js-ci-variable-input-value').set('key value')
+      find('.js-ci-variable-input-value').set('key_value')
     end
 
     click_button('Save variables')
@@ -19,7 +19,7 @@ shared_examples 'variable list' do
     # We check the first row because it re-sorts to alphabetical order on refresh
     page.within('.js-ci-variable-list-section .js-row:nth-child(1)') do
       expect(find('.js-ci-variable-input-key').value).to eq('key')
-      expect(find('.js-ci-variable-input-value', visible: false).value).to eq('key value')
+      expect(find('.js-ci-variable-input-value', visible: false).value).to eq('key_value')
     end
   end
 
@@ -44,7 +44,7 @@ shared_examples 'variable list' do
   it 'adds new protected variable' do
     page.within('.js-ci-variable-list-section .js-row:last-child') do
       find('.js-ci-variable-input-key').set('key')
-      find('.js-ci-variable-input-value').set('key value')
+      find('.js-ci-variable-input-value').set('key_value')
       find('.ci-variable-protected-item .js-project-feature-toggle').click
 
       expect(find('.js-ci-variable-input-protected', visible: false).value).to eq('true')
@@ -58,7 +58,7 @@ shared_examples 'variable list' do
     # We check the first row because it re-sorts to alphabetical order on refresh
     page.within('.js-ci-variable-list-section .js-row:nth-child(1)') do
       expect(find('.js-ci-variable-input-key').value).to eq('key')
-      expect(find('.js-ci-variable-input-value', visible: false).value).to eq('key value')
+      expect(find('.js-ci-variable-input-value', visible: false).value).to eq('key_value')
       expect(find('.js-ci-variable-input-protected', visible: false).value).to eq('true')
     end
   end