Extend quick actions dsl50199-quick-actions-refactor

* Extend quick actions dsl to allow specifying model types
to which given quick action applies
* Rename issuable attribute to noteable in interpret_service.rb
* Refactor and reorder quick action specs
* Create a shared example spec for each quick action to be used for
issue, merge request and commit specs.

https://gitlab.com/gitlab-org/gitlab-ce/issues/50199

2 files changed, 55 insertions, 1 deletions

diff --git a/spec/lib/gitlab/quick_actions/command_definition_spec.rb b/spec/lib/gitlab/quick_actions/command_definition_spec.rb
index 136cfb5bcc5..b6e0adbc1c2 100644
--- a/spec/lib/gitlab/quick_actions/command_definition_spec.rb
+++ b/spec/lib/gitlab/quick_actions/command_definition_spec.rb
@@ -69,6 +69,36 @@ describe Gitlab::QuickActions::CommandDefinition do
         expect(subject.available?(opts)).to be true
       end
     end
+
+    context "when the command has types" do
+      before do
+        subject.types = [Issue, Commit]
+      end
+
+      context "when the command target type is allowed" do
+        it "returns true" do
+          opts[:quick_action_target] = Issue.new
+          expect(subject.available?(opts)).to be true
+        end
+      end
+
+      context "when the command target type is not allowed" do
+        it "returns true" do
+          opts[:quick_action_target] = MergeRequest.new
+          expect(subject.available?(opts)).to be false
+        end
+      end
+    end
+
+    context "when the command has no types" do
+      it "any target type is allowed" do
+        opts[:quick_action_target] = Issue.new
+        expect(subject.available?(opts)).to be true
+
+        opts[:quick_action_target] = MergeRequest.new
+        expect(subject.available?(opts)).to be true
+      end
+    end
   end
 
   describe "#execute" do
diff --git a/spec/lib/gitlab/quick_actions/dsl_spec.rb b/spec/lib/gitlab/quick_actions/dsl_spec.rb
index fd4df8694ba..185adab1ff6 100644
--- a/spec/lib/gitlab/quick_actions/dsl_spec.rb
+++ b/spec/lib/gitlab/quick_actions/dsl_spec.rb
@@ -48,13 +48,19 @@ describe Gitlab::QuickActions::Dsl do
       substitution :something do |text|
         "#{text} Some complicated thing you want in here"
       end
+
+      desc 'A command with types'
+      types Issue, Commit
+      command :has_types do
+        "Has Issue and Commit types"
+      end
     end
   end
 
   describe '.command_definitions' do
     it 'returns an array with commands definitions' do
       no_args_def, explanation_with_aliases_def, dynamic_description_def,
-      cc_def, cond_action_def, with_params_parsing_def, substitution_def =
+      cc_def, cond_action_def, with_params_parsing_def, substitution_def, has_types =
         DummyClass.command_definitions
 
       expect(no_args_def.name).to eq(:no_args)
@@ -63,6 +69,7 @@ describe Gitlab::QuickActions::Dsl do
       expect(no_args_def.explanation).to eq('')
       expect(no_args_def.params).to eq([])
       expect(no_args_def.condition_block).to be_nil
+      expect(no_args_def.types).to eq([])
       expect(no_args_def.action_block).to be_a_kind_of(Proc)
       expect(no_args_def.parse_params_block).to be_nil
       expect(no_args_def.warning).to eq('')
@@ -73,6 +80,7 @@ describe Gitlab::QuickActions::Dsl do
       expect(explanation_with_aliases_def.explanation).to eq('Static explanation')
       expect(explanation_with_aliases_def.params).to eq(['The first argument'])
       expect(explanation_with_aliases_def.condition_block).to be_nil
+      expect(explanation_with_aliases_def.types).to eq([])
       expect(explanation_with_aliases_def.action_block).to be_a_kind_of(Proc)
       expect(explanation_with_aliases_def.parse_params_block).to be_nil
       expect(explanation_with_aliases_def.warning).to eq('Possible problem!')
@@ -83,6 +91,7 @@ describe Gitlab::QuickActions::Dsl do
       expect(dynamic_description_def.explanation).to eq('')
       expect(dynamic_description_def.params).to eq(['The first argument', 'The second argument'])
       expect(dynamic_description_def.condition_block).to be_nil
+      expect(dynamic_description_def.types).to eq([])
       expect(dynamic_description_def.action_block).to be_a_kind_of(Proc)
       expect(dynamic_description_def.parse_params_block).to be_nil
       expect(dynamic_description_def.warning).to eq('')
@@ -93,6 +102,7 @@ describe Gitlab::QuickActions::Dsl do
       expect(cc_def.explanation).to eq('')
       expect(cc_def.params).to eq([])
       expect(cc_def.condition_block).to be_nil
+      expect(cc_def.types).to eq([])
       expect(cc_def.action_block).to be_nil
       expect(cc_def.parse_params_block).to be_nil
       expect(cc_def.warning).to eq('')
@@ -103,6 +113,7 @@ describe Gitlab::QuickActions::Dsl do
       expect(cond_action_def.explanation).to be_a_kind_of(Proc)
       expect(cond_action_def.params).to eq([])
       expect(cond_action_def.condition_block).to be_a_kind_of(Proc)
+      expect(cond_action_def.types).to eq([])
       expect(cond_action_def.action_block).to be_a_kind_of(Proc)
       expect(cond_action_def.parse_params_block).to be_nil
       expect(cond_action_def.warning).to eq('')
@@ -113,6 +124,7 @@ describe Gitlab::QuickActions::Dsl do
       expect(with_params_parsing_def.explanation).to eq('')
       expect(with_params_parsing_def.params).to eq([])
       expect(with_params_parsing_def.condition_block).to be_nil
+      expect(with_params_parsing_def.types).to eq([])
       expect(with_params_parsing_def.action_block).to be_a_kind_of(Proc)
       expect(with_params_parsing_def.parse_params_block).to be_a_kind_of(Proc)
       expect(with_params_parsing_def.warning).to eq('')
@@ -123,9 +135,21 @@ describe Gitlab::QuickActions::Dsl do
       expect(substitution_def.explanation).to eq('')
       expect(substitution_def.params).to eq(['<Comment>'])
       expect(substitution_def.condition_block).to be_nil
+      expect(substitution_def.types).to eq([])
       expect(substitution_def.action_block.call('text')).to eq('text Some complicated thing you want in here')
       expect(substitution_def.parse_params_block).to be_nil
       expect(substitution_def.warning).to eq('')
+
+      expect(has_types.name).to eq(:has_types)
+      expect(has_types.aliases).to eq([])
+      expect(has_types.description).to eq('A command with types')
+      expect(has_types.explanation).to eq('')
+      expect(has_types.params).to eq([])
+      expect(has_types.condition_block).to be_nil
+      expect(has_types.types).to eq([Issue, Commit])
+      expect(has_types.action_block).to be_a_kind_of(Proc)
+      expect(has_types.parse_params_block).to be_nil
+      expect(has_types.warning).to eq('')
     end
   end
 end