magi 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 912ef942160db8fe16a33b901a9213a40dc8482e
+  data.tar.gz: 5a3f6069f1c918788815dde909a74469a3a3e047
+SHA512:
+  metadata.gz: 1b768a1e1a60ffcd0dcf7b8c7f78ffa004e5ffc4c64b395bc852a18ae964f638fe3520dd4331604dd80fda472de21b5c80ddf4b70506c1c88106c03f49a118a0
+  data.tar.gz: cedf3fd66a1b876a3f64a34dee6effe1ab0659b29603888508ab8a5ae2c0681ec2e4352c677fd14a1c54af95f3985f1b765f104e96147d39eba3c08355a0532a

data/Gemfile

@@ -1,19 +1,28 @@
 source "https://rubygems.org"
 
-gem "rails", "3.2.13"
-gem "sqlite3"
+gemspec
+
+gem "font-awesome-rails"
 gem "jquery-rails"
+gem "quiet_assets"
+gem "sidekiq"
+gem "slim"
 
 group :development, :test do
   gem "pry-rails"
 end
 
 group :test do
+  gem "factory_girl_rails"
+  gem "response_code_matchers"
+  gem "rspec-json_matcher"
   gem "rspec-rails"
+  gem "simplecov"
+  gem "thin"
 end
 
 group :assets do
-  gem "sass-rails",   "~> 3.2.3"
+  gem "sass-rails", "~> 3.2.3"
   gem "coffee-rails", "~> 3.2.1"
   gem "uglifier", ">= 1.0.3"
 end

data/Procfile

@@ -0,0 +1,4 @@
+redis: redis-server
+rails: bundle exec rails s
+sidekiq: bundle exec sidekiq
+clockwork: bundle exec clockwork script/clock.rb

data/README.md

@@ -1,6 +1,30 @@
 # Magi
+A continuous integration server implementation.
 
-## Installation
+![](http://dl.dropbox.com/u/5978869/image/20130607_012059.png)
+
+## Install
 ```
 $ gem install magi
+$ brew install mysql redis # or other commands to install MySQL and Redis
+```
+
+## Usage
+```
+$ magi setup
+$ magi start # open http://localhost:3000
 ```
+
+## Hack
+Magi is just a rails application.
+Feel free to do what you want.
+
+### tools
+* Rails: HTTP server
+* Sidekiq: background worker
+* Redis: worker queue
+* MySQL: store jobs & builds
+
+### todo
+* plugin system
+* cli options (e.g. http port, rails env, redis conf)

data/app/assets/stylesheets/application.css

@@ -8,6 +8,7 @@
  * You're free to add application-wide styles to this file and they'll appear at the top of the
  * compiled file, but it's generally better to create a new file per style scope.
  *
+ *= require font-awesome
  *= require_self
  *= require_tree .
  */

data/app/assets/stylesheets/builds.scss

@@ -0,0 +1,35 @@
+@import "mixin";
+
+section.build {
+  &.success h1 {
+    color: #27AE60;
+  }
+
+  &.failure h1 {
+    color: #C0392B;
+  }
+
+  &.success h1 span:before {
+    content: "\F058";
+  }
+
+  &.build.failure h1 span:before {
+    content: "\F057";
+  }
+
+  &.build.unfinished h1 span:before {
+    content: "\F056";
+  }
+
+  td {
+    padding-right: 1em;
+  }
+
+  pre {
+    @include box;
+    margin-top: 1em;
+    padding: .5em 1em;
+    background: #eee;
+    overflow-x: scroll;
+  }
+}

data/app/assets/stylesheets/common.scss

@@ -0,0 +1,69 @@
+@import "mixin";
+
+* {
+  margin: 0;
+  padding: 0;
+}
+
+body {
+  color: #333;
+  font-family: "Helvetica Neue", "Calibri", sans-serif;
+  line-height: 1.7;
+}
+
+a {
+  color: inherit;
+  text-decoration: none;
+}
+
+i {
+  margin-right: .3em;
+}
+
+textarea,
+input {
+  font-size: 1em;
+}
+
+textarea,
+input[type="text"] {
+  @include box;
+  width: 100%;
+}
+
+*:before {
+  margin-right: .3em;
+  font-family: FontAwesome;
+}
+
+.button {
+  @include box;
+  width: 10em;
+  font-size: 1em;
+  color: white;
+  background: #F39C12;
+  border-color: #F39C12;
+  line-height: inherit;
+  cursor: pointer;
+  text-align: center;
+}
+
+section.breadcrumbs {
+  ul {
+    @include box;
+    border-color: #eee;
+    background: #eee;
+    list-style: none;
+    overflow: hidden;
+    color: #888;
+  }
+
+  li {
+    float: left;
+    margin-right: 1em;
+  }
+
+  li.delimiter:before {
+    content: "\F105";
+  }
+}

data/app/assets/stylesheets/jobs.scss

@@ -0,0 +1,121 @@
+@import "mixin";
+
+section.jobs {
+  h1:before {
+    content: "\F13D";
+  }
+
+  p {
+    color: #ccc;
+  }
+
+  ul {
+    margin-top: 1em;
+  }
+}
+
+section.job_settings {
+  h1:before {
+    content: "\F085";
+  }
+
+  td {
+    padding-right: 1em;
+  }
+
+  input[type="submit"] {
+    margin-top: 1em;
+    background: #34495e;
+    border-color: #34495e;
+  }
+}
+
+section.jobs,
+section.builds {
+  .buttons {
+    overflow: hidden;
+  }
+
+  .buttons a {
+    float: left;
+    display: block;
+    margin-right: 1em;
+  }
+
+  .buttons a.new:before {
+    content: "\F040";
+  }
+
+  .buttons a.run:before {
+    content: "\F04B";
+  }
+
+  .buttons a.new,
+  .buttons a.settings {
+    background: #2C3E50;
+    border-color: #2C3E50;
+  }
+
+  .buttons a.settings:before {
+    content: "\F013";
+  }
+
+  .buttons a.delete {
+    background: #C0392B;
+    border-color: #C0392B;
+  }
+
+  .buttons a.delete:before {
+    content: "\F014";
+  }
+
+  .button {
+    margin-top: .5em;
+  }
+
+  ul {
+    margin-top: 1em;
+    list-style: none;
+  }
+
+  li a {
+    @include box;
+    display: block;
+  }
+
+  li a:hover {
+    background: #fafafa;
+  }
+
+  li.unfinished a:before {
+    content: "\F056";
+  }
+
+  li.success a:before {
+    content: "\F058";
+    color: #27AE60;
+  }
+
+  li.failure a:before {
+    content: "\F057";
+    color: #C0392B;
+  }
+
+  li.success a {
+    border-color: #27AE60;
+  }
+
+  li.failure a {
+    border-color: #C0392B;
+  }
+
+  li span {
+    margin-right: 1em;
+  }
+}
+
+section.builds {
+  h1:before {
+    content: "\F0FB";
+  }
+}

data/app/assets/stylesheets/layout.scss

@@ -0,0 +1,19 @@
+header {
+  background: #333;
+
+  a {
+    color: white;
+    font-weight: normal;
+  }
+
+  .inner {
+    width: 920px;
+    margin: 0 auto;
+  }
+}
+
+section {
+  width: 920px;
+  margin: 0 auto;
+  padding: 20px;
+}

data/app/assets/stylesheets/mixin.scss

@@ -0,0 +1,6 @@
+@mixin box {
+  border-radius: .4em;
+  border: solid 2px #999;
+  padding: .2em .6em;
+  margin-bottom: .5em;
+}

data/app/controllers/application_controller.rb

@@ -1,3 +1,19 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
+
+  respond_to :html, :json
+
+  private
+
+  def require_resource_params
+    head 400 unless resource_params
+  end
+
+  def resource_name
+    self.class.name.split("::").last.sub(/Controller$/, "").singularize.underscore
+  end
+
+  def resource_params
+    params[resource_name]
+  end
 end

data/app/controllers/builds_controller.rb

@@ -0,0 +1,45 @@
+class BuildsController < ApplicationController
+  before_filter :require_job
+  before_filter :require_resources, only: :index
+  before_filter :require_resource, only: [:show, :update, :destroy]
+  before_filter :require_resource_params, only: :update
+
+  def index
+    respond_with @resources
+  end
+
+  def show
+    respond_with @resource
+  end
+
+  def create
+    resource = @job.queue
+    respond_with resource, location: [@job, resource]
+  end
+
+  def update
+    respond_with @resource.update_attributes(resource_params.slice(:status))
+  end
+
+  def destroy
+    respond_with @resource.destroy
+  end
+
+  private
+
+  def require_job
+    @job = Job.find(params[:job_id])
+  end
+
+  def scope
+    @job.builds
+  end
+
+  def require_resources
+    @resources = scope
+  end
+
+  def require_resource
+    @resource = scope.find(params[:id])
+  end
+end

data/app/controllers/jobs_controller.rb

@@ -0,0 +1,43 @@
+class JobsController < ApplicationController
+  before_filter :require_resource_params, only: [:create, :update]
+  before_filter :require_resources, only: :index
+  before_filter :require_resource, only: [:show, :edit, :update, :destroy]
+
+  def index
+    respond_with @resources
+  end
+
+  def show
+    respond_with @resource
+  end
+
+  def new
+    respond_with @resource = scope.new
+  end
+
+  def create
+    respond_with @resource = scope.create_with_properties(resource_params)
+  end
+
+  def update
+    respond_with @resource.update_attributes_with_properties(resource_params)
+  end
+
+  def destroy
+    respond_with @resource.destroy
+  end
+
+  private
+
+  def scope
+    Job.scoped
+  end
+
+  def require_resources
+    @resources = scope
+  end
+
+  def require_resource
+    @resource = scope.find(params[:id])
+  end
+end

data/app/models/build.rb

@@ -0,0 +1,39 @@
+class Build < ActiveRecord::Base
+  attr_accessible :finished_at, :started_at, :output, :status
+
+  validates :job_id, presence: true
+
+  belongs_to :job, touch: true
+
+  scope :recent, -> { order("created_at DESC") }
+
+  scope :finished, -> { where("finished_at IS NOT NULL") }
+
+  # Pushes this build to worker's queue.
+  def queue
+    BuildWorker.perform_async(id)
+  end
+
+  # Runs this build, usually called from BuildWorker#perform.
+  def start
+    update_attributes!(started_at: Time.now)
+    result = job.start
+    update_attributes!(finished_at: Time.now, status: result[:status], output: result[:output])
+  end
+
+  # Returns elapsed sec as a Float or nil.
+  def sec
+    finished_at - started_at if finished_at && started_at
+  end
+
+  def status_name
+    case status
+    when true
+      "success"
+    when false
+      "failure"
+    when nil
+      "unfinished"
+    end
+  end
+end

data/app/models/job.rb

@@ -0,0 +1,88 @@
+class Job < ActiveRecord::Base
+  attr_accessible :name, :config
+
+  serialize :config, Hash
+
+  validates :name, presence: true
+
+  has_many :builds
+
+  scope :recent, -> { order("updated_at DESC") }
+
+  delegate :status, :status_name, :status_icon_css_class, to: :last_finished_build, allow_nil: true
+
+  class << self
+    def create_with_properties(properties)
+      job = new
+      properties.each {|key, value| job.send("#{key}=", value) }
+      job.tap(&:save)
+    end
+
+    def queue
+      select(&:scheduled?).each(&:queue)
+    end
+
+    def property(name)
+      properties << name
+
+      define_method(name) do
+        config[name.to_s]
+      end
+
+      define_method("#{name}=") do |value|
+        config[name.to_s] = value
+      end
+    end
+
+    def properties
+      @properties ||= []
+    end
+  end
+
+  property(:description)
+
+  property(:schedule)
+
+  property(:script)
+
+  def start
+    script ? execute : raise_script_not_found
+  end
+
+  def scheduler
+    Magi::Scheduler.new(schedule)
+  end
+
+  def scheduled?
+    schedule && scheduler.scheduled?
+  end
+
+  def queue
+    builds.create.tap(&:queue)
+  end
+
+  def status_name
+    last_finished_build.try(:status_name) || "unfinished"
+  end
+
+  def last_finished_build
+    builds.finished.order(:finished_at).last
+  end
+
+  def update_attributes_with_properties(properties)
+    properties.each {|key, value| send("#{key}=", value) }
+    tap(&:save)
+  end
+
+  private
+
+  def execute
+    Magi::Executer.execute(script)
+  end
+
+  def raise_script_not_found
+    raise ScriptNotFound, 'You must set script["config"]'
+  end
+
+  class ScriptNotFound < StandardError; end
+end

data/app/views/builds/show.html.slim

@@ -0,0 +1,36 @@
+section.breadcrumbs
+  ul
+    li= link_to "Home", jobs_path
+    li.delimiter
+    li= link_to @resource.job.name, @resource.job
+    li.delimiter
+    li= link_to "##{@resource.id}", [@resource.job, @resource]
+
+section.build class = @resource.status_name
+  h1
+    span ##{@resource.id}
+
+  table
+    tr
+      td started_at
+      td= ":"
+      td= @resource.started_at
+
+    tr
+      td finished_at
+      td= ":"
+      td= @resource.finished_at
+
+    tr
+      td sec
+      td= ":"
+      td= @resource.sec
+
+    tr
+      td status
+      td= ":"
+      td= @resource.status_name
+
+  pre
+    code
+      = @resource.output

data/app/views/jobs/_form.html.slim

@@ -0,0 +1,27 @@
+section.job_settings
+  h1 Settings
+
+  = form_for resource do |f|
+    .field
+      p= f.label :name
+      p= f.text_field :name, placeholder: "required"
+
+    .field
+      p= f.label :description
+      p= f.text_area :description, rows: 3
+
+    .field
+      p= f.label :script
+      p= f.text_area :script, rows: 6
+
+    .field
+      p= f.label :schedule
+      p= f.text_field :schedule, placeholder: "* * * * *"
+
+    - (resource.class.properties - [:description, :schedule, :script]).each do |name|
+      .field
+        p= f.label name
+        p= f.text_field name
+
+    .field
+      p= f.submit class: "button"

data/app/views/jobs/edit.html.slim

@@ -0,0 +1,9 @@
+section.breadcrumbs
+  ul
+    li= link_to "Home", jobs_path
+    li.delimiter
+    li= link_to @resource.name, @resource
+    li.delimiter
+    li= link_to "settings", edit_job_path(@resource)
+
+= render "form", resource: @resource

data/app/views/jobs/index.html.slim

@@ -0,0 +1,19 @@
+section.breadcrumbs
+  ul
+    li= link_to "Home", jobs_path
+
+section.jobs
+  h1 JOBS
+
+  p #{Job.count} jobs are found.
+
+
+  .buttons
+    = link_to "New", [:new, :job], class: "button new"
+
+  ul
+    - @resources.recent.each do |resource|
+      li class = resource.status_name
+        = link_to resource do
+          span
+            = resource.name

data/app/views/jobs/new.html.slim

@@ -0,0 +1,7 @@
+section.breadcrumbs
+  ul
+    li= link_to "Home", jobs_path
+    li.delimiter
+    li= link_to "Create Job", @resource
+
+= render "form", resource: @resource

data/app/views/jobs/show.html.slim

@@ -0,0 +1,24 @@
+section.breadcrumbs
+  ul
+    li= link_to "Home", jobs_path
+    li.delimiter
+    li= link_to @resource.name, @resource
+
+section.builds
+  h1
+    = @resource.name
+
+  p
+    = @resource.description || "(no description)"
+
+  .buttons
+    = link_to "Run", [@resource, :builds], method: "POST", class: "button run"
+    = link_to "Settings", [:edit, @resource], class: "button settings"
+    = link_to "Delete", @resource, method: "DELETE", confirm: "Are you sure?", class: "button delete"
+
+  ul
+    - @resource.builds.recent.limit(10).each do |build|
+      li class = build.status_name
+        = link_to [@resource, build] do
+          span.id ##{build.id}
+          span= build.finished_at