kuroko2 0.2.0

data/spec/support/feature_sign_in_helper.rb

@@ -0,0 +1,31 @@
+module FeatureSignInHelper
+  def sign_in(user = create(:user))
+    mock_omni_auth_google_oauth2(
+      uid: user.uid,
+      name: user.name,
+      first_name: user.first_name,
+      last_name: user.last_name,
+      email: user.email,
+      image: user.image,
+    )
+
+    visit kuroko2_path
+    click_on('Sign in with Google')
+  end
+
+  def mock_omni_auth_google_oauth2(options = {})
+    OmniAuth.config.mock_auth[:google_oauth2] = OmniAuth::AuthHash.new(
+      uid: options[:uid] || 'john@example.org',
+      info: {
+        name: options[:name] || "John Doe",
+        first_name: options[:first_name] || "John",
+        last_name: options[:last_name] || "Doe",
+        email: options[:email] || "john@example.org",
+        image: options[:image] || "https://img.example.org/john.doe.png",
+      },
+      credentials: {
+        expires_at: options[:expires_at] || 1.month.since.to_i,
+      }
+    )
+  end
+end

data/spec/support/sign_in_helper.rb

@@ -0,0 +1,5 @@
+module SignInHelper
+  def sign_in(user = create(:user))
+    controller.instance_variable_set(:@_current_user, user)
+  end
+end

data/spec/support/wait_for_ajax.rb

@@ -0,0 +1,11 @@
+module WaitForAjax
+  def wait_for_ajax
+    Timeout.timeout(Capybara.default_max_wait_time) do
+      loop until finished_all_ajax_requests?
+    end
+  end
+
+  def finished_all_ajax_requests?
+    page.evaluate_script('jQuery.active').zero?
+  end
+end

data/spec/workflow/engine_spec.rb

@@ -0,0 +1,241 @@
+require 'rails_helper'
+
+module Kuroko2::Workflow
+  describe Engine do
+    describe '#process' do
+
+      let(:shell) { Kuroko2::Command::Shell.new(hostname: 'rspec', worker_id: 1, worker: worker) }
+      let(:token) { definition.job_instances.first.tokens.first }
+      let(:worker) { create(:worker) }
+
+      context 'with simple sequence' do
+        let!(:definition) do
+          create(:job_definition_with_instances, script: <<-EOF.strip_heredoc)
+          noop: noop0
+          noop: noop1
+          EOF
+        end
+
+        specify do
+          subject.process(token)
+          expect(token.path).to eq '/0-noop'
+
+          subject.process(token)
+          expect(token.path).to eq '/1-noop'
+
+          subject.process(token)
+
+          expect(token).to be_finished
+          expect(Kuroko2::Token.all.count).to eq 0
+        end
+      end
+
+      context 'with simple execution' do
+        let!(:definition) do
+          create(:job_definition_with_instances, script: <<-EOF.strip_heredoc)
+            env: NAME=kuroko
+            execute: echo Hello, $NAME!
+          EOF
+        end
+
+        specify do
+          subject.process(token)
+          subject.process(token)
+          subject.process(token)
+          shell.execute
+          subject.process(token)
+
+          expect(token).to be_finished
+          expect(Kuroko2::Token.all.count).to eq 0
+        end
+      end
+
+      context 'with fork' do
+        let!(:definition) do
+          create(:job_definition_with_instances, script: <<-EOF.strip_heredoc)
+            fork:
+              noop: noop1
+              noop: noop2
+              sequence:
+                noop: noop3
+                noop: noop4
+            noop: noop5
+          EOF
+        end
+
+        specify do
+          subject.process(token)
+          expect(token.path).to eq '/0-fork'
+
+          subject.process(token)
+          expect(token.children.size).to eq 3
+
+          noop1, noop2, sequence = token.children
+
+          subject.process_all
+          [token, noop1, noop2, sequence].each(&:reload)
+          expect(token.path).to eq '/0-fork'
+          expect(noop1.path).to eq '/0-noop'
+          expect(noop2.path).to eq '/0-noop'
+          expect(sequence.path).to eq '/0-sequence'
+
+          subject.process_all
+          [token, noop1, noop2, sequence].each(&:reload)
+          expect(token.path).to eq '/0-fork'
+          expect(noop1.path).to eq '/0-noop'
+          expect(noop2.path).to eq '/0-noop'
+          expect(sequence.path).to eq '/0-sequence/0-noop'
+          expect(noop1.status_name).to eq 'finished'
+          expect(noop2.status_name).to eq 'finished'
+          expect(sequence.status_name).to eq 'working'
+
+          subject.process_all
+          [token, noop1, noop2, sequence].each(&:reload)
+          expect(token.path).to eq '/0-fork'
+          expect(noop1.path).to eq '/0-noop'
+          expect(noop2.path).to eq '/0-noop'
+          expect(sequence.path).to eq '/0-sequence/1-noop'
+          expect(noop1.status_name).to eq 'finished'
+          expect(noop2.status_name).to eq 'finished'
+          expect(sequence.status_name).to eq 'working'
+
+          subject.process_all
+          [token, noop1, noop2, sequence].each(&:reload)
+          expect(token.path).to eq '/0-fork'
+          expect(noop1.path).to eq '/0-noop'
+          expect(noop2.path).to eq '/0-noop'
+          expect(sequence.path).to eq '/0-sequence/1-noop'
+          expect(noop1.status_name).to eq 'finished'
+          expect(noop2.status_name).to eq 'finished'
+          expect(sequence.status_name).to eq 'finished'
+
+          subject.process_all
+          token.reload
+          expect(token.path).to eq '/1-noop'
+          expect(token.status_name).to eq 'working'
+
+          subject.process_all
+          expect(Kuroko2::Token.all.count).to eq 0
+        end
+      end
+
+      context 'retry' do
+        let!(:definition) do
+          create(:job_definition_with_instances, script: <<-EOF.strip_heredoc)
+            execute: test -e #{tmpfile}
+            noop:
+          EOF
+        end
+
+        let!(:tmpfile) do
+          "/tmp/tmp_workflow_spec_skip.#{Process.pid}"
+        end
+
+        after do
+          FileUtils.safe_unlink(tmpfile)
+        end
+
+        specify do
+          subject.process(token)
+          subject.process(token)
+          shell.execute
+          subject.process(token)
+          expect(token.status_name).to eq 'failure'
+
+          FileUtils.touch(tmpfile)
+
+          subject.retry(token)
+
+          subject.process(token)
+          shell.execute
+          subject.process(token)
+          subject.process(token)
+
+          expect(token.status_name).to eq 'finished'
+          expect(Kuroko2::Token.all.count).to eq 0
+        end
+      end
+
+      context 'skip' do
+        let!(:definition) do
+          create(:job_definition_with_instances, script: <<-EOF.strip_heredoc)
+            execute: false
+            noop:
+          EOF
+        end
+
+        specify do
+          subject.process(token)
+          subject.process(token)
+          shell.execute
+          subject.process(token)
+
+          expect(token.status_name).to eq 'failure'
+
+          subject.skip(token)
+          subject.process(token)
+
+          expect(token.status_name).to eq 'finished'
+          expect(Kuroko2::Token.all.count).to eq 0
+        end
+      end
+
+      context 'with auto_skip_error' do
+        let!(:definition) do
+          create(:job_definition_with_instances, script: <<-EOF.strip_heredoc)
+            auto_skip_error: true
+            execute: false
+            noop:
+          EOF
+        end
+
+        specify do
+          subject.process(token)
+          subject.process(token)
+          shell.execute
+          subject.process(token)
+          subject.process(token)
+          shell.execute
+          subject.process(token)
+          subject.process(token)
+
+          expect(token.status_name).to eq 'finished'
+          expect(Kuroko2::Token.all.count).to eq 0
+        end
+      end
+
+      context 'with wait' do
+        let(:wait_definition) do
+          create(:job_definition_with_instances, script: 'noop:')
+        end
+
+        let!(:definition) do
+          create(:job_definition_with_instances, script: <<-EOF.strip_heredoc)
+            wait: #{wait_definition.id}/hourly
+            noop:
+          EOF
+        end
+
+        specify do
+          subject.process(token)
+          expect(token.status_name).to eq 'working'
+          subject.process(token)
+          expect(token.status_name).to eq 'waiting'
+          subject.process(token)
+          expect(token.status_name).to eq 'waiting'
+          subject.process(token)
+          expect(token.status_name).to eq 'waiting'
+          subject.process(token)
+          expect(token.status_name).to eq 'waiting'
+
+          wait_definition.job_instances.first.touch(:finished_at)
+
+          subject.process(token)
+          expect(token.status_name).to eq 'working'
+          subject.process(token)
+          expect(token.status_name).to eq 'finished'
+        end
+      end
+    end
+  end
+end

data/spec/workflow/node_spec.rb

@@ -0,0 +1,62 @@
+require 'rails_helper'
+
+module Kuroko2::Workflow
+  describe Node do
+    around do |example|
+      Node.register(key: :node1, klass: Task::Base)
+      Node.register(key: :node1_1, klass: Task::Base)
+      Node.register(key: :node1_2, klass: Task::Base)
+      Node.register(key: :node2, klass: Task::Base)
+
+      example.run
+
+      Node.deregister(:node1)
+      Node.deregister(:node1_1)
+      Node.deregister(:node1_2)
+      Node.deregister(:node2)
+    end
+
+    let!(:root) do
+      Node.new(:root).tap do |root|
+        root.append_child(node1)
+        root.append_child(node2)
+
+        node1.append_child(node1_1)
+        node1.append_child(node1_2)
+      end
+    end
+    let(:node1) { Node.new(:node1) }
+    let(:node1_1) { Node.new(:node1_1) }
+    let(:node1_2) { Node.new(:node1_2) }
+    let(:node2) { Node.new(:node2) }
+
+    describe '#find' do
+      it { expect(root.find('/0-node1')).to eq node1 }
+      it { expect(root.find('/0-node1/0-node1_1')).to eq node1_1 }
+      it { expect(root.find('/0-node1/1-node1_2')).to eq node1_2 }
+      it { expect(root.find('/1-node2')).to eq node2 }
+
+      it { expect { root.find('invalid query') }.to raise_error(AssertionError) }
+    end
+
+    describe '#next' do
+      it { expect(root.next).to eq node1 }
+      it { expect(node1.next).to eq node1_1 }
+      it { expect(node1_1.next).to eq node1_2 }
+      it { expect(node1_2.next).to eq node2 }
+      it { expect(node2.next).to be_nil }
+    end
+
+    describe '#path' do
+      it { expect(root.path).to eq '' }
+      it { expect(node1.path).to eq '/0-node1' }
+      it { expect(node1_1.path).to eq '/0-node1/0-node1_1' }
+      it { expect(node1_2.path).to eq '/0-node1/1-node1_2' }
+      it { expect(node2.path).to eq '/1-node2' }
+    end
+
+    describe '#to_script' do
+      it { expect(node1.to_script).to eq "node1: \n  node1_1: \n  node1_2: \n" }
+    end
+  end
+end

data/spec/workflow/notifier/hipchat_spec.rb

@@ -0,0 +1,117 @@
+require 'rails_helper'
+
+module Kuroko2::Workflow
+  describe Notifier::Hipchat do
+    let(:job_name) { 'My Job' }
+    let(:hipchat_room) { 'dummy' }
+    let(:instance) do
+      create(:job_definition_with_instances, name: job_name, hipchat_room: hipchat_room).
+        job_instances.first
+    end
+
+    let(:notifier) { Notifier::Hipchat.new(instance) }
+    let(:hipchat_room_object) { double('Hipchat::Room', send: true) }
+
+    before do
+      allow(Kuroko2.config.notifiers.hipchat).to receive(:api_token).and_return('token')
+
+      instance.logs.info('start!')
+      allow(notifier.hipchat).to receive(:[]).with(hipchat_room).
+        and_return(hipchat_room_object)
+    end
+
+    describe '#notify_failure' do
+      it 'sends failure mesasge' do
+        expect(hipchat_room_object).to receive(:send) do |_, message, option|
+          expect(message).to include('FAILURE')
+          expect(option[:color]).to eq('red')
+        end
+
+        notifier.notify_failure
+      end
+
+      context 'with additional_text' do
+        let(:additional_text) { '@EisukeOishi' }
+        before do
+          instance.job_definition.hipchat_additional_text = additional_text
+          instance.save!
+        end
+
+        it 'sends additional message' do
+          expect(hipchat_room_object).to receive(:send) do |_, message, option|
+            expect(message).to include('Failed to execute')
+            expect(option[:color]).to eq('red')
+          end
+
+          notifier.notify_failure
+        end
+      end
+    end
+
+    describe '#notify_cancellation' do
+      before do
+        instance.job_definition.notify_cancellation = true
+        instance.save!
+      end
+
+      it 'sends cancellation mesasge' do
+        expect(hipchat_room_object).to receive(:send) do |_, message, option|
+          expect(message).to include('WARNING')
+          expect(option[:color]).to eq('yellow')
+        end
+
+        notifier.notify_cancellation
+      end
+    end
+
+    describe '#notify_critical' do
+      it 'sends critical mesasge' do
+        expect(hipchat_room_object).to receive(:send) do |_, message, option|
+          expect(message).to include('CRITICAL')
+          expect(option[:color]).to eq('red')
+        end
+
+        notifier.notify_critical
+      end
+
+      context 'with additional_text' do
+        let(:additional_text) { '@EisukeOishi' }
+        before do
+          instance.job_definition.hipchat_additional_text = additional_text
+          instance.save!
+        end
+
+        it 'sends additional message' do
+          expect(hipchat_room_object).to receive(:send) do |_, message, option|
+            expect(message).to include('Failed to execute')
+            expect(option[:color]).to eq('red')
+          end
+
+          notifier.notify_failure
+        end
+      end
+    end
+
+    describe '#notify_finished' do
+      it 'sends finished mesasge' do
+        expect(hipchat_room_object).to receive(:send) do |_, message, option|
+          expect(message).to include('SUCCESS')
+          expect(option[:color]).to eq('green')
+        end
+
+        notifier.notify_finished
+      end
+    end
+
+    describe '#notify_long_elapsed_time' do
+      it 'sends warning mesasge' do
+        expect(hipchat_room_object).to receive(:send) do |_, message, option|
+          expect(message).to include('WARNING')
+          expect(option[:color]).to eq('red')
+        end
+
+        notifier.notify_long_elapsed_time
+      end
+    end
+  end
+end

data/spec/workflow/notifier/mail_spec.rb

@@ -0,0 +1,86 @@
+require 'rails_helper'
+
+module Kuroko2::Workflow
+  describe Notifier::Mail do
+    let(:job_name) { 'MyJob' }
+
+    let(:instance) do
+      create(:job_definition_with_instances, name: job_name).job_instances.first
+    end
+
+    let(:notifier) { Notifier::Mail.new(instance) }
+
+    before do
+      instance.logs.info('start!')
+      ActionMailer::Base.deliveries.clear
+    end
+
+    describe '#notify_cancellation' do
+      context 'with notify_cancellation is true' do
+        before do
+          instance.job_definition.notify_cancellation = true
+          instance.save!
+        end
+
+        it 'sends cancellation mesasge' do
+          expect { notifier.notify_cancellation }.to change {
+            ActionMailer::Base.deliveries.size
+          }.from(0).to(1)
+        end
+      end
+
+      context 'with notify_cancellation is false' do
+        before do
+          instance.job_definition.notify_cancellation = false
+          instance.save!
+        end
+
+        it 'sends cancellation mesasge' do
+          expect { notifier.notify_cancellation }.not_to change {
+            ActionMailer::Base.deliveries.size
+          }
+        end
+      end
+    end
+
+    describe '#notify_failure' do
+      it 'sends failure mesasge' do
+        expect { notifier.notify_failure }.to change {
+          ActionMailer::Base.deliveries.size
+        }.from(0).to(1)
+      end
+    end
+
+    describe '#notify_critical' do
+      it 'sends critical mesasge' do
+        expect { notifier.notify_critical }.to change {
+          ActionMailer::Base.deliveries.size
+        }.from(0).to(1)
+      end
+    end
+
+    describe '#notify_finished' do
+      it 'does not send mail' do
+        expect { notifier.notify_finished }.not_to change {
+          ActionMailer::Base.deliveries.size
+        }
+      end
+    end
+
+    describe '#notify_long_elapsed_time' do
+      it 'sends warning mesasge' do
+        expect { notifier.notify_long_elapsed_time }.to change {
+          ActionMailer::Base.deliveries.size
+        }.from(0).to(1)
+      end
+    end
+
+    describe '#notify_working' do
+      it 'does not send mail' do
+        expect { notifier.notify_working }.not_to change {
+          ActionMailer::Base.deliveries.size
+        }
+      end
+    end
+  end
+end

data/spec/workflow/notifier/slack_spec.rb

@@ -0,0 +1,110 @@
+require 'rails_helper'
+
+module Kuroko2::Workflow
+  describe Notifier::Slack do
+    let(:job_name) { 'My Job' }
+    let(:slack_channel) { '#dummy' }
+    let(:instance) do
+      create(:job_definition_with_instances, name: job_name, slack_channel: slack_channel).
+        job_instances.first
+    end
+
+    let(:notifier) { Notifier::Slack.new(instance) }
+    let(:endpoint) { Kuroko2.config.notifiers.slack.webhook_url }
+    let(:response) { { body: 'ok' } }
+
+    before do
+      instance.logs.info('start!')
+
+      stub_request(:post, endpoint).with(
+        headers: { "Content-Type" => 'application/json' },
+      ).and_return(response)
+    end
+
+    describe '#notify_failure' do
+      it 'sends failure mesasge' do
+        expect(notifier).to receive(:send_to_slack).
+          with(hash_including(channel: slack_channel)).and_call_original
+
+        notifier.notify_failure
+      end
+
+      context 'with additional_text' do
+        let(:additional_text) { '@eisuke-oishi' }
+        before do
+          instance.job_definition.hipchat_additional_text = additional_text
+          instance.save!
+        end
+
+        it 'sends additional message' do
+          expect(notifier).to receive(:send_additional_text_to_slack).once.and_call_original
+          notifier.notify_failure
+        end
+      end
+    end
+
+    describe '#notify_cancellation' do
+      before do
+        instance.job_definition.notify_cancellation = true
+        instance.save!
+      end
+
+      it 'sends cancellation mesasge' do
+        expect(notifier).to receive(:send_to_slack).
+          with(hash_including(channel: slack_channel)).and_call_original
+
+        notifier.notify_cancellation
+      end
+    end
+
+    describe '#notify_critical' do
+      it 'sends critical mesasge' do
+        expect(notifier).to receive(:send_to_slack).
+          with(hash_including(channel: slack_channel)).and_call_original
+
+        notifier.notify_critical
+      end
+
+      context 'with additional_text' do
+        let(:additional_text) { '@eisuke-oishi' }
+
+        before do
+          instance.job_definition.hipchat_additional_text = additional_text
+          instance.save!
+        end
+
+        it 'sends additional message' do
+          expect(notifier).to receive(:send_additional_text_to_slack).and_call_original
+          notifier.notify_failure
+        end
+      end
+    end
+
+    describe '#notify_finished' do
+      it 'sends finished mesasge' do
+        expect(notifier).to receive(:send_to_slack).
+          with(hash_including(channel: slack_channel)).and_call_original
+
+        notifier.notify_finished
+      end
+    end
+
+    describe '#notify_long_elapsed_time' do
+      it 'sends warning mesasge' do
+        expect(notifier).to receive(:send_to_slack).
+          with(hash_including(channel: slack_channel)).and_call_original
+
+        notifier.notify_long_elapsed_time
+      end
+    end
+
+    context 'with invalid response' do
+      let(:response) { { status: 500 } }
+
+      it 'logs to response' do
+        expect(Kuroko2.logger).to receive(:fatal).with(/Failure sending message/)
+        notifier.notify_failure
+      end
+    end
+  end
+end