require 'spec_helper' describe Gitlab::QuickActions::CommandDefinition do subject { described_class.new(:command) } describe "#all_names" do context "when the command has aliases" do before do subject.aliases = [:alias1, :alias2] end it "returns an array with the name and aliases" do expect(subject.all_names).to eq([:command, :alias1, :alias2]) end end context "when the command doesn't have aliases" do it "returns an array with the name" do expect(subject.all_names).to eq([:command]) end end end describe "#noop?" do context "when the command has an action block" do before do subject.action_block = proc { } end it "returns false" do expect(subject.noop?).to be false end end context "when the command doesn't have an action block" do it "returns true" do expect(subject.noop?).to be true end end end describe "#available?" do let(:opts) { OpenStruct.new(go: false) } context "when the command has a condition block" do before do subject.condition_block = proc { go } end context "when the condition block returns true" do before do opts[:go] = true end it "returns true" do expect(subject.available?(opts)).to be true end end context "when the condition block returns false" do it "returns false" do expect(subject.available?(opts)).to be false end end end context "when the command doesn't have a condition block" do it "returns true" 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 let(:context) { OpenStruct.new(run: false, commands_executed_count: nil) } context "when the command is a noop" do it "doesn't execute the command" do expect(context).not_to receive(:instance_exec) subject.execute(context, nil) expect(context.commands_executed_count).to be_nil expect(context.run).to be false end end context "when the command is not a noop" do before do subject.action_block = proc { self.run = true } end context "when the command is not available" do before do subject.condition_block = proc { false } end it "doesn't execute the command" do subject.execute(context, nil) expect(context.commands_executed_count).to be_nil expect(context.run).to be false end end context "when the command is available" do context "when the commnd has no arguments" do before do subject.action_block = proc { self.run = true } end context "when the command is provided an argument" do it "executes the command" do subject.execute(context, true) expect(context.run).to be true expect(context.commands_executed_count).to eq(1) end end context "when the command is not provided an argument" do it "executes the command" do subject.execute(context, nil) expect(context.run).to be true expect(context.commands_executed_count).to eq(1) end end end context "when the command has 1 required argument" do before do subject.action_block = ->(arg) { self.run = arg } end context "when the command is provided an argument" do it "executes the command" do subject.execute(context, true) expect(context.run).to be true expect(context.commands_executed_count).to eq(1) end end context "when the command is not provided an argument" do it "doesn't execute the command" do subject.execute(context, nil) expect(context.run).to be false end end end context "when the command has 1 optional argument" do before do subject.action_block = proc { |arg = nil| self.run = arg || true } end context "when the command is provided an argument" do it "executes the command" do subject.execute(context, true) expect(context.run).to be true end end context "when the command is not provided an argument" do it "executes the command" do subject.execute(context, nil) expect(context.run).to be true end end end context 'when the command defines parse_params block' do before do subject.parse_params_block = ->(raw) { raw.strip } subject.action_block = ->(parsed) { self.received_arg = parsed } end it 'executes the command passing the parsed param' do subject.execute(context, 'something ') expect(context.received_arg).to eq('something') end end end end end describe '#explain' do context 'when the command is not available' do before do subject.condition_block = proc { false } subject.explanation = 'Explanation' end it 'returns nil' do result = subject.explain({}, nil) expect(result).to be_nil end end context 'when the explanation is a static string' do before do subject.explanation = 'Explanation' end it 'returns this static string' do result = subject.explain({}, nil) expect(result).to eq 'Explanation' end end context 'when warning is set' do before do subject.explanation = 'Explanation' subject.warning = 'dangerous!' end it 'returns this static string' do result = subject.explain({}, nil) expect(result).to eq 'Explanation (dangerous!)' end end context 'when the explanation is dynamic' do before do subject.explanation = proc { |arg| "Dynamic #{arg}" } end it 'invokes the proc' do result = subject.explain({}, 'explanation') expect(result).to eq 'Dynamic explanation' end end end end