barbeque 0.0.1 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e46d5b56b2da9d6dd1f8a969884b89d9279e45c6
-  data.tar.gz: 7cd2c731b320400a63b45b709599b73c8801199b
+  metadata.gz: f577ecaa96a85f7b40832305df8d0283e833f542
+  data.tar.gz: 72ec989120b97cf6efeada1a158d359002c0970c
 SHA512:
-  metadata.gz: 43b4573b33bdfc1178a034fa6e88e3ad016db86cd360d6789095579716641bceb5cac6703de07ac3ad521fa9fb34df579d15381b877bc0d166dfafd213ed96e7
-  data.tar.gz: 7e5f93abd4464bfbac2d6c52051c9ca38eefb89d9ea2e1f83f8b13e4ddde596b1bc77ff8c5838a8131a540c7f281b6010ed3a16808fdd662ea826b7ecfbc6618
+  metadata.gz: 86aab750c582060510dd9107bc8566357df56113a98b46f64109875cadf5524b8b01612b3b362d1d1a886a403c0556caf00f2fa649cb075cfd69432e128a7512
+  data.tar.gz: f7facf66c24eec3c1dab88c7947f3a2dcf1b5befbb60780c52caa60e2eb4b1ce6c16a8e1b7545d0f2736794a06573a816efadd2b8e1f8d6630537b6f9070d31c

data/README.md

@@ -1,8 +1,7 @@
 # Barbeque
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+## Status
+Currently we are migrating from closed-source version to open-source version and writing documentation.
 
 ## Installation
 Add this line to your application's Gemfile:

data/Rakefile

@@ -14,11 +14,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-load 'rails/tasks/statistics.rake'
-
-
-
 require 'bundler/gem_tasks'
+require File.expand_path('../spec/dummy/config/application', __FILE__)
 
+Rails.application.load_tasks

data/app/assets/javascripts/barbeque/application.js

@@ -10,4 +10,9 @@
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
+//= require jquery
+//= require bootstrap-sprockets
+//= require jquery_ujs
+//= require app
+//= require plotly-basic
 //= require_tree .

data/app/assets/javascripts/barbeque/job_definitions.coffee

@@ -0,0 +1,10 @@
+jQuery ($) ->
+  return if $('.job_definitions_controller').length == 0
+
+  $('.use_slack_notification').bind('change', (event) ->
+    enabledField = $('.slack_notification_field')
+    if event.target.value == 'true'
+      enabledField.removeClass('active')
+    else
+      enabledField.addClass('active')
+  )

data/app/assets/stylesheets/barbeque/application.scss

@@ -0,0 +1,7 @@
+@import "bootstrap-sprockets";
+@import "bootstrap";
+@import "AdminLTE/AdminLTE";
+@import "AdminLTE/skins/skin-blue";
+
+@import "barbeque/common";
+@import "barbeque/job_definitions";

data/app/assets/stylesheets/barbeque/common.scss

@@ -0,0 +1,22 @@
+$border_color: #ececec;
+
+.box-body {
+  padding: 12px;
+}
+
+.box-header {
+  .box-title.with_padding {
+    padding: 6px;
+    font-size: 22px;
+  }
+}
+
+.table.table-bordered {
+  margin-bottom: 12px;
+  border-color: $border_color;
+
+  td,
+  th {
+    border-color: $border_color;
+  }
+}

data/app/assets/stylesheets/barbeque/job_definitions.scss

@@ -0,0 +1,21 @@
+.job_definitions_controller {
+  .use_slack_notification_wrapper label {
+    font-weight: normal;
+  }
+
+  .use_slack_notification {
+    margin: 0 2px 0 8px;
+  }
+
+  .slack_notification_field {
+    display: none;
+
+    label {
+      font-weight: normal;
+    }
+
+    &.active {
+      display: block;
+    }
+  }
+}

data/app/controllers/barbeque/api/application_controller.rb

@@ -0,0 +1,22 @@
+require 'garage'
+
+class Barbeque::Api::ApplicationController < ActionController::Base
+  include Garage::ControllerHelper
+
+  rescue_from ActiveRecord::RecordNotFound do |exception|
+    respond_with_error(404, 'record_not_found', exception.message)
+  end
+
+  rescue_from WeakParameters::ValidationError do |exception|
+    respond_with_error(400, 'invalid_parameter', exception.message)
+  end
+
+  private
+
+  # @param [Integer] status_code HTTP status code
+  # @param [String] error_code Must be unique
+  # @param [String] message Error message for API client, not for end user.
+  def respond_with_error(status_code, error_code, message)
+    render json: { status_code: status_code, error_code: error_code, message: message }, status: status_code
+  end
+end

data/app/controllers/barbeque/api/job_executions_controller.rb

@@ -0,0 +1,35 @@
+class Barbeque::Api::JobExecutionsController < Barbeque::Api::ApplicationController
+  include Garage::RestfulActions
+
+  validates :create do
+    string :application, required: true, description: 'Application name of the job'
+    string :job, required: true, description: 'Class of Job to be enqueued'
+    string :queue, required: true, description: 'Queue name to enqueue a job'
+    any :message, required: true, description: 'Free-format JSON'
+  end
+
+  private
+
+  def require_resources
+    protect_resource_as Barbeque::Api::JobExecutionResource
+  end
+
+  def require_resource
+    @resource = Barbeque::JobExecution.find_or_initialize_by(message_id: params[:message_id])
+  end
+
+  def create_resource
+    message_id = enqueue_message
+    Barbeque::JobExecution.new(message_id: message_id).to_resource
+  end
+
+  # @return [String] id of a message queued to SQS.
+  def enqueue_message
+    Barbeque::MessageEnqueuingService.new(
+      application: params[:application],
+      job:         params[:job],
+      queue:       params[:queue],
+      message:     params[:message],
+    ).run
+  end
+end

data/app/controllers/barbeque/api/job_retries_controller.rb

@@ -0,0 +1,28 @@
+class Barbeque::Api::JobRetriesController < Barbeque::Api::ApplicationController
+  include Garage::RestfulActions
+
+  # http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html
+  SQS_MAX_DELAY_SECONDS = 900
+
+  validates :create do
+    integer :delay_seconds, only: 0..SQS_MAX_DELAY_SECONDS
+  end
+
+  private
+
+  def require_resources
+    protect_resource_as Barbeque::Api::JobRetryResource
+  end
+
+  def create_resource
+    result = retry_message
+    Barbeque::JobRetry.new(message_id: result.message_id).to_resource
+  end
+
+  def retry_message
+    Barbeque::MessageRetryingService.new(
+      message_id: params[:job_execution_message_id],
+      delay_seconds: params[:delay_seconds].to_i,
+    ).run
+  end
+end

data/app/controllers/barbeque/api/revision_locks_controller.rb

@@ -0,0 +1,34 @@
+class Barbeque::Api::RevisionLocksController < Barbeque::Api::ApplicationController
+  include Garage::RestfulActions
+
+  validates :create do
+    string :revision, required: true, description: 'Docker image revision to lock'
+  end
+
+  private
+
+  def require_resources
+    protect_resource_as Barbeque::Api::RevisionLockResource
+  end
+
+  def require_resource
+    @resource = Barbeque::App.find_by!(name: params[:app_name])
+  end
+
+  def create_resource
+    app = Barbeque::App.find_by!(name: params[:app_name])
+    image = Barbeque::DockerImage.new(app.docker_image)
+    image.tag = params[:revision]
+    app.update!(docker_image: image.to_s)
+
+    Barbeque::Api::RevisionLockResource.new(app)
+  end
+
+  def destroy_resource
+    image = Barbeque::DockerImage.new(@resource.docker_image)
+    image.tag = 'latest'
+    @resource.update!(docker_image: image.to_s)
+
+    Barbeque::Api::RevisionLockResource.new(@resource)
+  end
+end

data/app/controllers/barbeque/apps_controller.rb

@@ -0,0 +1,43 @@
+class Barbeque::AppsController < Barbeque::ApplicationController
+  def index
+    @apps = Barbeque::App.all
+  end
+
+  def show
+    @app = Barbeque::App.find(params[:id])
+  end
+
+  def new
+    @app = Barbeque::App.new
+  end
+
+  def edit
+    @app = Barbeque::App.find(params[:id])
+  end
+
+  def create
+    @app = Barbeque::App.new(params.require(:app).permit(:name, :docker_image, :description))
+
+    if @app.save
+      redirect_to @app, notice: 'App was successfully created.'
+    else
+      render :new
+    end
+  end
+
+  def update
+    @app = Barbeque::App.find(params[:id])
+    # Name can't be changed after it's created.
+    if @app.update(params.require(:app).permit(:docker_image, :description))
+      redirect_to @app, notice: 'App was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    @app = Barbeque::App.find(params[:id])
+    @app.destroy
+    redirect_to root_path, notice: 'App was successfully destroyed.'
+  end
+end

data/app/controllers/barbeque/job_definitions_controller.rb

@@ -0,0 +1,86 @@
+class Barbeque::JobDefinitionsController < Barbeque::ApplicationController
+  def index
+    @job_definitions = Barbeque::JobDefinition.all
+  end
+
+  def show
+    @job_definition = Barbeque::JobDefinition.find(params[:id])
+    @job_executions = @job_definition.job_executions.order(id: :desc).page(params[:page])
+  end
+
+  def new
+    @job_definition = Barbeque::JobDefinition.new
+    @job_definition.build_slack_notification
+    if params[:job_definition]
+      @job_definition.assign_attributes(new_job_definition_params)
+    end
+  end
+
+  def edit
+    @job_definition = Barbeque::JobDefinition.find(params[:id])
+    if @job_definition.slack_notification.nil?
+      @job_definition.build_slack_notification
+    end
+  end
+
+  def create
+    attributes = new_job_definition_params.merge(command: command_array)
+    @job_definition = Barbeque::JobDefinition.new(attributes)
+
+    if @job_definition.save
+      redirect_to @job_definition, notice: 'Job definition was successfully created.'
+    else
+      render :new
+    end
+  end
+
+  def update
+    @job_definition = Barbeque::JobDefinition.find(params[:id])
+    attributes = params.require(:job_definition).permit(
+      :description,
+      slack_notification_attributes: slack_notification_params,
+    ).merge(command: command_array)
+    if @job_definition.update(attributes)
+      redirect_to @job_definition, notice: 'Job definition was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    @job_definition = Barbeque::JobDefinition.find(params[:id])
+    @job_definition.destroy
+    redirect_to job_definitions_url, notice: 'Job definition was successfully destroyed.'
+  end
+
+  def stats
+    @job_definition = Barbeque::JobDefinition.find(params[:job_definition_id])
+    @days = (params[:days] || 3).to_i
+  end
+
+  def execution_stats
+    job_definition = Barbeque::JobDefinition.find(params[:job_definition_id])
+    days = (params[:days] || 3).to_i
+    now = Time.zone.now
+    render json: job_definition.execution_stats(days.days.ago(now), now)
+  end
+
+  private
+
+  def slack_notification_params
+    %i[id channel notify_success failure_notification_text _destroy]
+  end
+
+  def command_array
+    Shellwords.split(params.require(:job_definition)[:command])
+  end
+
+  def new_job_definition_params
+    params.require(:job_definition).permit(
+      :job,
+      :app_id,
+      :description,
+      slack_notification_attributes: slack_notification_params,
+    )
+  end
+end

data/app/controllers/barbeque/job_executions_controller.rb

@@ -0,0 +1,19 @@
+class Barbeque::JobExecutionsController < Barbeque::ApplicationController
+  def show
+    @job_execution = Barbeque::JobExecution.find(params[:id])
+    log = @job_execution.execution_log
+    @message = log['message']
+    @stdout  = log['stdout']
+    @stderr  = log['stderr']
+  end
+
+  def retry
+    @job_execution = Barbeque::JobExecution.find(params[:job_execution_id])
+    raise ActionController::BadRequest unless @job_execution.failed?
+
+    result = Barbeque::MessageRetryingService.new(message_id: @job_execution.message_id).run
+    @job_execution.retried!
+
+    redirect_to @job_execution, notice: "Succeed to retry (message_id=#{result.message_id})"
+  end
+end

data/app/controllers/barbeque/job_queues_controller.rb

@@ -0,0 +1,59 @@
+class Barbeque::JobQueuesController < Barbeque::ApplicationController
+  def index
+    @job_queues = Barbeque::JobQueue.all
+  end
+
+  def show
+    @job_queue = Barbeque::JobQueue.find(params[:id])
+  end
+
+  def new
+    @job_queue = Barbeque::JobQueue.new
+  end
+
+  def edit
+    @job_queue = Barbeque::JobQueue.find(params[:id])
+  end
+
+  def create
+    @job_queue = Barbeque::JobQueue.new(params.require(:job_queue).permit(:name, :description))
+    @job_queue.queue_url = create_queue(@job_queue).queue_url if @job_queue.valid?
+
+    if @job_queue.save
+      redirect_to @job_queue, notice: 'Job queue was successfully created.'
+    else
+      render :new
+    end
+  end
+
+  def update
+    @job_queue = Barbeque::JobQueue.find(params[:id])
+    # Name can't be changed after it's created.
+    if @job_queue.update(params.require(:job_queue).permit(:description))
+      redirect_to @job_queue, notice: 'Job queue was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    @job_queue = Barbeque::JobQueue.find(params[:id])
+    @job_queue.destroy
+    redirect_to job_queues_url, notice: 'Job queue was successfully destroyed.'
+  end
+
+  private
+
+  # @return [Aws::SQS::Types::CreateQueueResult] A struct which has only queue_url.
+  def create_queue(job_queue)
+    Aws::SQS::Client.new.create_queue(
+      queue_name: job_queue.sqs_queue_name,
+      attributes: {
+        # All SQS queues' "ReceiveMessageWaitTimeSeconds" are configured to be 20s (maximum).
+        # This should be as large as possible to reduce API-calling cost by long polling.
+        # http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html#API_CreateQueue_RequestParameters
+        'ReceiveMessageWaitTimeSeconds' => Barbeque::JobQueue::SQS_RECEIVE_MESSAGE_WAIT_TIME.to_s,
+      },
+    )
+  end
+end