TMA-690 && TMA-633 tests now verify that synchronize users action fails when supplied with unsupported sync_mode param

Author: Petr Gadorek

lib/gooddata/lcm/actions/synchronize_user_filters.rb

@@ -19,7 +19,7 @@ class SynchronizeUserFilters < BaseAction
         param :input_source, instance_of(Type::HashType), required: true
 
         description 'Synchronization Mode (e.g. sync_one_project_based_on_pid)'
-        param :sync_mode, instance_of(Type::StringType), required: false
+        param :sync_mode, instance_of(Type::StringType), required: false, default: 'sync_project'
 
         description 'Column That Contains Target Project IDs'
         param :multiple_projects_column, instance_of(Type::StringType), required: false
@@ -47,6 +47,17 @@ class SynchronizeUserFilters < BaseAction
       end
 
       class << self
+        MODES = %w(
+          add_to_organization
+          sync_project
+          sync_domain_and_project
+          sync_multiple_projects_based_on_pid
+          sync_one_project_based_on_pid
+          sync_one_project_based_on_custom_id
+          sync_multiple_projects_based_on_custom_id
+          sync_domain_client_workspaces
+        )
+
         def call(params)
           client = params.gdc_gd_client
           domain_name = params.organization || params.domain
@@ -63,7 +74,10 @@ def call(params)
           symbolized_config[:labels] = symbolized_config[:labels].map { |l| GoodData::Helpers.symbolize_keys(l) }
           headers_in_options = params.csv_headers == 'false' || true
 
-          mode = params.sync_mode || 'sync_project'
+          mode = params.sync_mode
+          unless MODES.include?(mode)
+            fail "The parameter \"sync_mode\" has to have one of the values #{MODES.map(&:to_s).join(', ')} or has to be empty."
+          end
           filters = []
 
           csv_with_headers = if GoodData::UserFilterBuilder.row_based?(symbolized_config)

lib/gooddata/lcm/actions/synchronize_users.rb

@@ -52,7 +52,7 @@ def call(params)
           data_source = GoodData::Helpers::DataSource.new(params.input_source)
           data_product = params.data_product
           mode = params.sync_mode
-          unless mode.nil? || MODES.include?(mode)
+          unless MODES.include?(mode)
             fail "The parameter \"sync_mode\" has to have one of the values #{MODES.map(&:to_s).join(', ')} or has to be empty."
           end
 

lib/gooddata/lcm/helpers/check_helper.rb

@@ -14,9 +14,10 @@ def check_params(specification, params)
           specification.keys.each do |param_name|
             value = params.send(param_name)
             type = specification[param_name][:type]
-
-            if value.nil?
-              if specification[param_name][:opts][:required]
+            if value.nil? || (value.is_a?(String) && value.empty?)
+              if specification[param_name][:opts][:default]
+                params[param_name] = specification[param_name][:opts][:default]
+              elsif specification[param_name][:opts][:required]
                 fail("Mandatory parameter '#{param_name}' of type '#{type}' is not specified")
               end
             else

spec/unit/actions/shared_examples_for_user_actions.rb

@@ -24,3 +24,20 @@
     subject.class.call(params)
   end
 end
+
+shared_examples 'when using unsuported sync_mode' do
+  before do
+    allow(project).to receive(:metadata).and_return(
+      'GOODOT_CUSTOM_PROJECT_ID' => 'project-123'
+    )
+    allow(project).to receive(:uri).and_return('project-uri')
+    allow(data_source).to receive(:realize).and_return('filepath')
+    allow(File).to receive(:open).and_return("client_id\n123456789")
+    allow(project).to receive(:add_data_permissions)
+    allow(domain).to receive(:clients).and_return([])
+  end
+
+  it 'fails' do
+    expect { subject.class.call(params) }.to raise_error(/sync_mode/)
+  end
+end

spec/unit/actions/synchronize_user_filters_spec.rb

@@ -162,11 +162,26 @@
       }
       GoodData::LCM2.convert_to_smart_hash(params)
     end
-
     it 'fails if the MUF set is empty' do
       expect(File).to receive(:open)
       expect(CSV).to receive(:foreach)
       expect { subject.class.call(params) }.to raise_error(/The filter set can not be empty/)
     end
   end
+  context 'when using unsuported sync_mode' do
+    let(:params) do
+      params = {
+        filters_config: { labels: [] },
+        GDC_GD_CLIENT: client,
+        input_source: 'foo',
+        domain: 'bar',
+        multiple_projects_column: 'id_column',
+        sync_mode: 'unsuported_sync_mode', # sync_one_project_based_on_custom_id
+        gdc_logger: logger
+      }
+      GoodData::LCM2.convert_to_smart_hash(params)
+    end
+
+    it_should_behave_like 'when using unsuported sync_mode'
+  end
 end

spec/unit/actions/synchronize_users_spec.rb

@@ -46,11 +46,11 @@
 
       let(:params) do
         params = {
+          sync_mode: 'sync_one_project_based_on_custom_id',
           GDC_GD_CLIENT: client,
           input_source: 'foo',
           domain: 'bar',
           gdc_logger: logger,
-          sync_mode: 'sync_one_project_based_on_custom_id'
         }
         GoodData::LCM2.convert_to_smart_hash(params)
       end
@@ -75,11 +75,11 @@
     context 'when mode requires client_id' do
       let(:params) do
         params = {
+          sync_mode: 'sync_one_project_based_on_pid',
           GDC_GD_CLIENT: client,
           input_source: 'foo',
           domain: 'bar',
-          gdc_logger: logger,
-          sync_mode: 'sync_one_project_based_on_pid'
+          gdc_logger: logger
         }
         GoodData::LCM2.convert_to_smart_hash(params)
       end
@@ -130,5 +130,51 @@
         let(:message_for_project) { :import_users }
       end
     end
+    context 'when using mistyped mode' do
+      let(:params) do
+        params = {
+          GDC_GD_CLIENT: client,
+          input_source: 'foo',
+          domain: 'bar',
+          gdc_logger: logger,
+          sync_mode: 'unsuported_sync_mode'
+        }
+        GoodData::LCM2.convert_to_smart_hash(params)
+      end
+
+      before do
+        allow(domain).to receive(:clients).and_return(organization)
+      end
+      it_should_behave_like 'when using unsuported sync_mode'
+    end
+    context 'when using no mode' do
+      let(:params) do
+        params = {
+          GDC_GD_CLIENT: client,
+          input_source: 'foo',
+          domain: 'bar',
+          gdc_logger: logger
+        }
+        GoodData::LCM2.convert_to_smart_hash(params)
+      end
+
+      before do
+        allow(domain).to receive(:clients).and_return(organization)
+      end
+      before do
+        allow(data_source).to receive(:realize).and_return('filepath')
+        allow(File).to receive(:open).and_return("client_id\n123456789")
+        allow(project).to receive(:metadata).and_return(
+          'GOODOT_CUSTOM_PROJECT_ID' => 'project-123'
+        )
+        allow(project).to receive(:uri).and_return('project-uri')
+        allow(project).to receive(:add_data_permissions)
+        allow(domain).to receive(:clients).and_return([])
+      end
+
+      it 'fails' do
+        expect { subject.class.call(params) }.to raise_error(/sync_mode/)
+      end
+    end
   end
 end

spec/unit/helpers/check_helper_spec.rb

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+require 'gooddata/lcm/actions/base_action'
+require 'gooddata/lcm/helpers/check_helper'
+require 'gooddata/lcm/types/types'
+
+describe 'GoodData::LCM2::Helpers::Checkout' do
+  let(:params) do
+    params = {
+      test_param_two: 'Testing param two',
+      test_param_three: 'Testing param three',
+      test_param_four: 4
+    }
+    GoodData::LCM2.convert_to_smart_hash(params)
+  end
+  it 'verifies required' do
+    PARAMS = GoodData::LCM2::BaseAction.define_params(self) do
+      description 'Testing param one'
+      param :test_param_one, instance_of(GoodData::LCM2::Type::StringType), required: true
+    end
+    expect { GoodData::LCM2::Helpers.check_params(PARAMS, params) }.to raise_error(/Mandatory/)
+  end
+
+  it 'fills default' do
+    PARAMS_2 = GoodData::LCM2::BaseAction.define_params(self) do
+      description 'Testing param one'
+      param :test_param_one, instance_of(GoodData::LCM2::Type::StringType), required: true, default: 'filled_default_value'
+
+      description 'Testing param two'
+      param :test_param_two, instance_of(GoodData::LCM2::Type::StringType), required: false
+    end
+    GoodData::LCM2::Helpers.check_params(PARAMS_2, params)
+    expect(params[:test_param_one]).to match(/filled_default_value/)
+  end
+
+  it 'checks types' do
+    PARAMS_3 = GoodData::LCM2::BaseAction.define_params(self) do
+      description 'Testing param four'
+      param :test_param_four, instance_of(GoodData::LCM2::Type::StringType), required: false
+    end
+    expect { GoodData::LCM2::Helpers.check_params(PARAMS_3, params) }.to raise_error(/has invalid type/)
+  end
+end