singularity_dsl 1.2.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yzc0YjUwZWE2NmJhNGEzMzkyMzQyMjllY2VlOTk4Yzg3ZjMwYzgxZQ==
+  data.tar.gz: !binary |-
+    YThjODFlMDNhMTUwYTI3N2YxMDlmOWRhMGNjNzQ5MjE4ZDExNDczMg==
+SHA512:
+  metadata.gz: !binary |-
+    MmY2NWFhZWY3ZTA5ZWRjZmU1MjVjYjUwNmI4MmM2YWNkNWI0YmRkYmJjNmNj
+    ZTljYjM3NmIwYzBmMTM4YjNlNjk0OTBkOWY5N2MwM2M4MTEwYTA4OTljNzY2
+    ZjJlMGZmN2ZmYTJhNWNiOWZiMjVmNTM0ZDdjNTliZDhlMjdmZWU=
+  data.tar.gz: !binary |-
+    YzlkYmNiMDM2YzI2MjQzNzY1NWEwMWQ5OGQ2MDJjOTYyMDg0MzQ2YmJhY2E2
+    YTliNzYxNjU0YmNmMzhjNDA3NmRmMDUwODg4NzhkOGE3YzdjN2JhYjNlNDk1
+    YzJjMzUwNDkwMWZiZTNjYjE3NGJiYTJiYjEyZjM0ZThiZmY0ZmE=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Includes:
+    - Rakefile
+    - Gemfile
+  Excludes:
+    - bin/*
+
+MethodLength:
+  Max: 15
+  CountComments: false

data/.singularityrc

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+batch :build do
+  shelltask { command 'bundle' }
+end
+
+batch :test do
+  rubocop
+  rspec
+end
+
+invoke_batch :test

data/Gemfile

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in singularity_dsl.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    singularity_dsl (1.2.5)
+      mixlib-shellout (~> 1.4)
+      rainbow (~> 2.0.0)
+      rake (~> 10.3)
+      rspec (~> 2.6)
+      rubocop (~> 0.23.0)
+      terminal-table (~> 1.4)
+      thor (~> 0.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.0.0)
+    diff-lcs (1.2.5)
+    gem-release (0.7.3)
+    json (1.8.1)
+    mixlib-shellout (1.4.0)
+    parser (2.1.9)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (2.0.0)
+    rake (10.3.2)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.1)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.2)
+    rubocop (0.23.0)
+      json (>= 1.7.7, < 2)
+      parser (~> 2.1.9)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.5.1)
+    slop (3.6.0)
+    terminal-table (1.4.5)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  gem-release
+  singularity_dsl!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 chr0n1x
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# SingularityDsl
+
+A DSL lib for your [SingularityCI](https://github.com/behance/singularity) instance.
+Inspired by TravisCI's `.travis.yml`
+
+...Except with the full power of Ruby, its gems & your awesome JenkinsCI machine(s)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'singularity_dsl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install singularity_dsl
+
+## Usage
+
+TODO: cause there are a lot of things that I want to do
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Make sure you run the tests!
+
+```
+bundle exec rake test:all
+```

data/Rakefile

@@ -0,0 +1,24 @@
+#!/user/bin/env rake
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+namespace :test do
+
+  RuboCop::RakeTask.new(:rubocop)
+
+  RSpec::Core::RakeTask.new(:rspec) do |t|
+    t.rspec_opts = '--format documentation --color'
+  end
+
+  desc 'Run RSpec with code coverage'
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test:rspec'].execute
+  end
+
+  desc 'Run rubocop and rspec test'
+  task all: [:rubocop, :rspec]
+end

data/bin/singularity_runner

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'singularity_dsl/cli/cli'
+SingularityDsl::Cli::Cli.start

data/lib/singularity_dsl/application.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+require 'singularity_dsl/dsl/runner'
+require 'singularity_dsl/errors'
+require 'rainbow'
+
+module SingularityDsl
+  # application singleton - environment container for script
+  class Application
+    include SingularityDsl::Errors
+
+    attr_reader :runner, :dsl
+
+    def initialize
+      @runner = Dsl::Runner.new
+    end
+
+    def load_script(script)
+      @runner.load_ex_script script
+    end
+
+    def load_tasks(path)
+      @runner.dsl.load_tasks_in_path path
+    end
+
+    def run(batch = false, pass_errors = false)
+      begin
+        @runner.execute batch, pass_errors
+      # resource failed, :all_tasks not specified
+      rescue ResourceFail => failure
+        log_resource_fail failure
+      # resource actually failed & threw error
+      rescue ResourceError => error
+        log_resource_error error
+      ensure
+        post_task_runner_actions
+      end
+      @runner.state.exit_code
+    end
+
+    def post_task_runner_actions
+      script_warn @runner.state.failures if @runner.state.failed
+      script_error @runner.state.errors if @runner.state.error
+      @runner.post_actions
+    end
+
+    def change_list(list)
+      list = list.split("\n") if list.is_a? String
+      list = [*list]
+      list.sort!
+      @runner.dsl.changeset = list
+    end
+
+    private
+
+    def log_resource_fail(failure)
+      script_warn 'Script run failed!'
+      script_warn failure.message
+      failure.backtrace.each { |line| puts line }
+    end
+
+    def log_resource_error(error)
+      script_error 'Script run error!'
+      script_error error.message
+      error.backtrace.each { |line| puts line }
+    end
+
+    def script_warn(message)
+      puts Rainbow(message).yellow
+    end
+
+    def script_error(message)
+      puts Rainbow(message).red
+    end
+  end
+end

data/lib/singularity_dsl/cli/cli.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+
+require 'singularity_dsl/application'
+require 'singularity_dsl/cli/table'
+require 'singularity_dsl/dsl/dsl'
+require 'singularity_dsl/errors'
+require 'singularity_dsl/git_helper'
+require 'singularity_dsl/stdout'
+require 'thor'
+
+module SingularityDsl
+  # CLI
+  module Cli
+    # CLI Thor app
+    class Cli < Thor
+      include Errors
+      include Stdout
+      include Table
+
+      def initialize(*args)
+        super
+        @diff_list = nil
+        @git = GitHelper.new
+      end
+
+      class_option :task_path,
+                   aliases: '-t',
+                   type: :string,
+                   desc: 'Directory where custom tasks are defined',
+                   default: './.singularity'
+      class_option :all_tasks,
+                   aliases: '-a',
+                   type: :boolean,
+                   desc: 'Do not stop on task failure(s), collect all results'
+      class_option :script,
+                   aliases: '-s',
+                   type: :string,
+                   desc: 'Specify path to a .singularityrc file',
+                   default: './.singularityrc'
+
+      # TASKS COMMAND
+      desc 'tasks', 'Available tasks.'
+      def tasks
+        dsl = Dsl::Dsl.new
+        dsl.load_tasks_in_path tasks_path if ::File.exist? tasks_path
+        table = task_table
+        dsl.task_list.each do |task|
+          table.add_row task_row(dsl, task)
+        end
+        puts table
+      end
+
+      # TEST COMMAND
+      desc 'test', 'Run singularity script.'
+      def test(app = nil)
+        app ||= setup_app(Application.new, singularity_script, tasks_path)
+        exit(app.run false, options[:all_tasks])
+      end
+
+      # BATCH COMMAND
+      desc 'batch BATCH_NAME', 'Run single task batch in the script.'
+      def batch(batch, app = nil)
+        app ||= setup_app(Application.new, singularity_script, tasks_path)
+        exit(app.run batch, options[:all_tasks])
+      end
+
+      # TEST-MERGE COMMAND
+      desc 'testmerge FORK BRANCH INTO_BRANCH [INTO_FORK]',
+           'Perform a test merge into the local repo.'
+      option :run_task,
+             aliases: '-r',
+             type: :string,
+             desc: 'Run a batch after. If nothing given, script is run as-is',
+             default: ''
+      def testmerge(git_fork, branch, base_branch, base_fork = nil)
+        test_merge git_fork, branch, base_branch, base_fork
+        info 'File changesets'
+        puts @git.diff_remote base_branch, base_fork, '--name-status'
+        @diff_list = @git.diff_remote base_branch, base_fork, '--name-only'
+        @git.remove_remote git_fork
+        @git.remove_remote base_fork
+        batch target_run_task if options[:run_task]
+      end
+
+      private
+
+      def test_merge(git_fork, branch, base_branch, base_fork)
+        @git.clean_reset
+        @git.add_remote base_fork
+        @git.checkout_remote base_branch, base_fork
+        @git.add_remote git_fork
+        @git.merge_remote branch, git_fork
+      end
+
+      def target_run_task
+        target = options[:run_task]
+        target = false if target.eql? ''
+        target
+      end
+
+      def setup_app(app, singularity_script, tasks_path)
+        if File.exist? tasks_path
+          info "Loading tasks from #{tasks_path}"
+          app.load_tasks tasks_path
+        end
+        unless @diff_list.nil?
+          info 'Running with diff-list'
+          puts @diff_list
+          app.change_list @diff_list
+        end
+        info "Loading CI script from #{singularity_script} ..."
+        app.load_script singularity_script
+        app
+      end
+
+      def singularity_script
+        File.expand_path options[:script]
+      end
+
+      def tasks_path
+        File.expand_path options[:task_path]
+      end
+    end
+  end
+end

data/lib/singularity_dsl/cli/table.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'rainbow'
+require 'terminal-table'
+
+module SingularityDsl
+  # CLI
+  module Cli
+    # util CLI table formatting fxs
+    module Table
+      private
+
+      def task_row(dsl, task_class)
+        name = dsl.task_name task_class
+        task_name = dsl.task task_class
+        desc = task_class.new.description
+        [name, task_name, desc]
+      end
+
+      def task_table
+        headers = [
+          Rainbow('Task').yellow,
+          Rainbow('Task Function').yellow,
+          Rainbow('Description').yellow
+        ]
+        table = Terminal::Table.new headings: headers
+        table.style = { border_x: '', border_y: '', border_i: '' }
+        table
+      end
+    end
+  end
+end

data/lib/singularity_dsl/dsl/batch.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'singularity_dsl/task'
+
+module SingularityDsl
+  # DSL classes & fxs
+  module Dsl
+    # wrapper for a batch of tasks
+    class Batch < Task
+      attr_reader :name
+
+      def initialize(name, context, &block)
+        @name = name.to_sym
+        @context = context
+        @proc = block
+      end
+
+      def execute
+        @context.instance_eval(&@proc)
+      end
+    end
+  end
+end

data/lib/singularity_dsl/dsl/changeset.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module SingularityDsl
+  # DSL classes & fxs
+  module Dsl
+    # methods & data to store & describe changesets
+    module Changeset
+      attr_writer :changeset
+
+      @changeset = []
+      @existing = nil
+
+      def files_changed?(types)
+        types = [*types]
+        @changeset ||= []
+        types.any? do |type|
+          @changeset.any? { |file| file.match("\.#{type}$") }
+        end
+      end
+
+      def changed_files(types)
+        types = [*types]
+        @changeset ||= []
+        types.flat_map do |type|
+          existing_files.select { |file| file.match("\.#{type}$") }
+        end.sort
+      end
+
+      private
+
+      def existing_files
+        if @existing.nil?
+          @existing = @changeset.select { |file| ::File.exist?(file) }
+        end
+        @existing
+      end
+    end
+  end
+end

data/lib/singularity_dsl/dsl/components.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'singularity_dsl/dsl/changeset'
+require 'singularity_dsl/dsl/dsl'
+require 'singularity_dsl/dsl/event_store'
+require 'singularity_dsl/dsl/registry'
+require 'singularity_dsl/dsl/runner'

data/lib/singularity_dsl/dsl/dsl.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+require 'singularity_dsl/files'
+require 'singularity_dsl/dsl/changeset'
+require 'singularity_dsl/dsl/event_store'
+require 'singularity_dsl/dsl/registry'
+require 'singularity_dsl/dsl/utils'
+
+module SingularityDsl
+  # DSL classes & fxs
+  module Dsl
+    # wrapper for DSL
+    class Dsl
+      include Changeset
+      include EventStore
+      include Files
+      include Utils
+
+      attr_reader :registry
+
+      def initialize
+        super
+        @registry = Registry.new
+        load_tasks_in_path default_task_dir
+      end
+
+      def define_task(klass)
+        raise_task_def_error klass if task_defined klass
+        # because define_method is private
+        define_singleton_method(task klass) do |&block|
+          @registry.add_task klass.new(&block)
+        end
+      end
+
+      def load_tasks_in_path(path)
+        base_tasks = task_list
+        files_in_path(path).each do |file|
+          SingularityDsl.module_eval(::File.read file)
+        end
+        load_tasks(task_list - base_tasks)
+      end
+
+      def invoke_batch(name)
+        @registry.add_batch_to_runlist name
+      end
+
+      def batch(name, &block)
+        @registry.batch(name, self, &block)
+      end
+
+      private
+
+      def raise_task_def_error(klass)
+        fail "task name clash for #{klass}"
+      end
+
+      def task_defined(klass)
+        singleton_methods(false).include?(task klass)
+      end
+
+      def load_tasks(list)
+        list.each { |klass| define_task klass }
+      end
+
+      def default_task_dir
+        dir = ::File.dirname __FILE__
+        ::File.join dir, '..', 'tasks'
+      end
+    end
+  end
+end

data/lib/singularity_dsl/dsl/event_store.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+module SingularityDsl
+  # DSL classes & fxs
+  module Dsl
+    # default methods to for DSL objects
+    module EventStore
+      attr_reader :error_proc, :fail_proc, :success_proc, :always_proc
+
+      def initialize
+        @error_proc = proc {}
+        @fail_proc = proc {}
+        @success_proc = proc {}
+        @always_proc = proc {}
+      end
+
+      def on_error(&block)
+        @error_proc = Proc.new(&block)
+      end
+
+      def on_fail(&block)
+        @fail_proc = Proc.new(&block)
+      end
+
+      def on_success(&block)
+        @success_proc = Proc.new(&block)
+      end
+
+      def always(&block)
+        @always_proc = Proc.new(&block)
+      end
+    end
+  end
+end

data/lib/singularity_dsl/dsl/registry.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'singularity_dsl/dsl/batch'
+require 'singularity_dsl/task'
+
+module SingularityDsl
+  # DSL classes & fxs
+  module Dsl
+    # wrapper for DSL
+    class Registry
+      def initialize
+        @task_list = []
+        @batch_list = {}
+      end
+
+      def add_task(task)
+        fail_non_type('Task', task) unless task.is_a? Task
+        fail_raw_type('Task', task) unless task.class < Task
+        @task_list.push task
+      end
+
+      def batch(name, context, &block)
+        batch_exists(name) if @batch_list.key? name.to_sym
+        batch = Batch.new(name.to_sym, context, &block)
+        @batch_list[name.to_sym] = batch
+      end
+
+      def add_batch_to_runlist(name)
+        batch_dne name unless @batch_list[name.to_sym]
+        @batch_list[name.to_sym].execute
+      end
+
+      def run_list(batch = false)
+        if batch
+          @task_list = []
+          add_batch_to_runlist batch
+        end
+        @task_list
+      end
+
+      private
+
+      def batch_dne(name)
+        fail "Cannot invoke batch '#{name}', does not exist"
+      end
+
+      def batch_exists(name)
+        fail "A task batch with the name '#{name}' already exists"
+      end
+
+      def fail_non_type(type, task)
+        fail "Non-#{type} given - #{task}"
+      end
+
+      def fail_raw_type(type, task)
+        fail "Cannot use raw #{type} objects - #{task}"
+      end
+    end
+  end
+end