jackal-nellie 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd3a2d03685f700eb013bedbeec6447f84aaa911
+  data.tar.gz: 652c480726a50171dea994886809953ce6ad219c
+SHA512:
+  metadata.gz: c5d8057508bf29fa673cd03ba23eb29458686f4e3c153d955bb87d4d05d12b3f59ef8bd08005da816d1e214b4999eec44b9c62bef4cd3050bc1abda8cb789bf7
+  data.tar.gz: 864078a27dea8acf410a8ecb0e1cecdbec7a84a90a209dbb768aa70bfc1e3d209ef6a96bd753118cb3558967eaa10ffe5270de8a626b6402ca9dd554b9a86ad9

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# v0.1.0
+* Initial release

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+## Branches
+
+### `master` branch
+
+The master branch is the current stable released version.
+
+### `develop` branch
+
+The develop branch is the current edge of development.
+
+## Pull requests
+
+* https://github.com/carnivore-rb/jackal-nellie/pulls
+
+Please base all pull requests of the `develop` branch. Merges to
+`master` only occur through the `develop` branch. Pull requests
+based on `master` will likely be cherry picked.
+
+## Issues
+
+Need to report an issue? Use the github issues:
+
+* https://github.com/carnivore-rb/jackal-nellie/issues

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2014 Chris Roberts
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,17 @@
+# Jackal Nellie
+
+Run commands against a repository. That's it.
+
+## Requirements
+
+This service assumes the payload information provided via the code
+fetcher service.
+
+## Configuration
+
+
+
+# Info
+
+* Repository: https://github.com/carnivore-rb/jackal-nellie
+* IRC: Freenode @ #carnivore

data/jackal-nellie.gemspec

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'jackal-nellie/version'
+Gem::Specification.new do |s|
+  s.name = 'jackal-nellie'
+  s.version = Jackal::Nellie::VERSION.version
+  s.summary = 'Message processing helper'
+  s.author = 'Chris Roberts'
+  s.email = 'code@chrisroberts.org'
+  s.homepage = 'https://github.com/carnivore-rb/jackal-nellie'
+  s.description = 'Just do stuff'
+  s.require_path = 'lib'
+  s.license = 'Apache 2.0'
+  s.add_dependency 'jackal'
+  s.files = Dir['lib/**/*'] + %w(jackal-nellie.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
+end

data/lib/jackal-nellie.rb

@@ -0,0 +1,10 @@
+require 'jackal'
+
+module Jackal
+  module Nellie
+    autoload :Processor, 'jackal-nellie/processor'
+  end
+end
+
+require 'jackal-nellie/version'
+require 'jackal-nellie/formatter'

data/lib/jackal-nellie/formatter.rb

@@ -0,0 +1,48 @@
+module Jackal
+  module Nellie
+    module Formatter
+      module MessageExtract
+
+        # Message for successful results
+        #
+        # @param payload [Smash]
+        # @return [String]
+        def success_message(payload)
+          repo = [
+            payload.get(:data, :code_fetcher, :info, :owner),
+            payload.get(:data, :code_fetcher, :info, :name)
+          ].join('/')
+          sha = payload.get(:data, :code_fetcher, :info, :commit_sha)
+          "[nellie]: Job completed successfully! (#{repo}@#{sha})"
+        end
+
+        # Message for failure results
+        #
+        # @param payload [Smash]
+        # @return [String]
+        def failure_message(payload)
+          msg = ['[nellie]: Failure encountered:']
+          msg << ''
+          failed_history = payload.fetch(:data, :nellie, :history, {}).detect do |i|
+            i[:exit_code] != 0
+          end
+          if(failed_history)
+            msg << '* STDOUT:' << '' << '```'
+            msg << asset_store.get(failed_history.get(:logs, :stdout)).read
+            msg << '```' << ''
+            msg << '* STDERR:' << '' << '```'
+            msg << asset_store.get(failed_history.get(:logs, :stderr)).read
+            msg << '```'
+          else
+            msg << '```' << 'Failed to locate logs' << '```'
+          end
+          msg.join("\n")
+        end
+
+      end
+    end
+  end
+end
+
+require 'jackal-nellie/formatter/github_commit_comment'
+require 'jackal-nellie/formatter/slack_comment'

data/lib/jackal-nellie/formatter/github_commit_comment.rb

@@ -0,0 +1,39 @@
+require 'jackal'
+
+module Jackal
+  module Nellie
+    module Formatter
+
+      class GithubCommitComment < Jackal::Formatter
+
+        include MessageExtract
+
+        # Source service
+        SOURCE = :nellie
+        # Destination service
+        DESTINATION = :github_kit
+
+        # Format payload to provide output comment to GitHub
+        #
+        # @param payload [Smash]
+        def format(payload)
+          payload.set(:data, :github_kit, :commit_comment,
+            Smash.new(
+              :repository => [
+                payload.get(:data, :code_fetcher, :info, :name),
+                payload.get(:data, :code_fetcher, :info, :owner)
+              ].join('/'),
+              :reference => payload.get(:data, :code_fetcher, :info, :commit_sha)
+            )
+          )
+          if(payload.get(:data, :nellie, :result, :success))
+            payload.set(:data, :github_kit, :commit_comment, :message, success_message(payload))
+          else
+            payload.set(:data, :github_kit, :commit_comment, :message, failure_message(payload))
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/jackal-nellie/formatter/slack_comment.rb

@@ -0,0 +1,42 @@
+require 'jackal'
+
+module Jackal
+  module Nellie
+    module Formatter
+
+      class SlackComment < Jackal::Formatter
+
+        include MessageExtract
+
+        # Source service
+        SOURCE = :nellie
+        # Destination service
+        DESTINATION = :slack
+
+        # Format payload to provide output comment to GitHub
+        #
+        # @param payload [Smash]
+        def format(payload)
+          if(payload.get(:data, :nellie, :result))
+            msgs = payload.fetch(:data, :slack, :messages, [])
+            if(payload.get(:data, :nellie, :result, :complete))
+              msgs << Smash.new(
+                :description => 'Nellie job result:',
+                :message => success_message(payload),
+                :color => :good
+              )
+            else
+              msgs << Smash.new(
+                :description => 'Nellie job result:',
+                :message => failure_message(payload),
+                :color => :bad
+              )
+            end
+            payload.set(:data, :slack, :messages, msgs)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/jackal-nellie/processor.rb

@@ -0,0 +1,187 @@
+require 'jackal-nellie'
+
+module Jackal
+  module Nellie
+    # Command processor
+    class Processor < Callback
+
+      # Default nellie file name
+      DEFAULT_SCRIPT_NAME = '.nellie'
+      # Default working directory
+      DEFAULT_WORKING_DIRECTORY = '/tmp/nellie'
+
+      # Setup callback
+      def setup(*_)
+        require 'fileutils'
+      end
+
+      # @return [String] working directory
+      def working_directory
+        memoize(:working_directory) do
+          wd = config.fetch(:working_directory, DEFAULT_WORKING_DIRECTORY)
+          FileUtils.mkdir_p(wd)
+          wd
+        end
+      end
+
+      # @return [String] nellie command file name
+      def nellie_script_name
+        config.fetch(:script_name, DEFAULT_SCRIPT_NAME)
+      end
+
+      # Determine validity of message
+      #
+      # @param message [Carnivore::Message]
+      # @return [Truthy, Falsey]
+      def valid?(message)
+        super do |payload|
+          payload.get(:data, :code_fetcher, :asset) &&
+            !payload.get(:data, :nellie, :result)
+        end
+      end
+
+      # Run nellie!
+      #
+      # @param message [Carnivore::Message]
+      def execute(message)
+        failure_wrap(message) do |payload|
+          debug "Processing nellie payload!"
+          nellie_cwd = fetch_code(payload)
+          unless(payload.get(:data, :nellie, :commands))
+            extract_nellie_commands(nellie_cwd, payload)
+          end
+          if(payload.get(:data, :nellie, :commands))
+            execute_commands(nellie_cwd, payload)
+          else
+            warn "No nellie commands found for execution on message! (#{message})"
+          end
+          job_completed(:nellie, payload, message)
+        end
+      end
+
+      # Execute commands
+      #
+      # @param nellie_cwd [String] repository directory
+      # @param payload [Smash]
+      # @return [TrueClass]
+      def execute_commands(nellie_cwd, payload)
+        process_environment = payload.fetch(:data, :nellie, :environment, Smash.new).merge(
+          Smash.new(
+            'NELLIE_GIT_COMMIT_SHA' => payload.get(:data, :code_fetcher, :info, :commit_sha),
+            'NELLIE_GIT_REF' => payload.get(:data, :code_fetcher, :info, :reference)
+          )
+        )
+        commands = [payload.get(:data, :nellie, :commands)].flatten.compact
+        results = run_commands(commands, process_environment, payload, nellie_cwd)
+        payload.set(:data, :nellie, :history, results)
+        payload[:data][:nellie].delete(:commands)
+        payload[:data][:nellie].delete(:environment)
+        unless(payload.get(:data, :nellie, :result, :failed))
+          payload.set(:data, :nellie, :result, :complete, true)
+        end
+        payload.set(:data, :nellie, :status,
+          payload.get(:data, :nellie, :result, :complete) ? 'success' : 'error'
+        )
+        true
+      end
+
+      # Run collection of commands
+      #
+      # @param commands [Array<String>] commands to execute
+      # @param env [Hash] environment variables for process
+      # @param payload [Smash]
+      # @param process_cwd [String] working directory for process
+      # @return [Array<Smash>] command results ({:start_time, :stop_time, :exit_code, :logs, :timed_out})
+      def run_commands(commands, env, payload, process_cwd)
+        results = []
+        commands.each do |command|
+          process_manager.process(payload[:id], command) do |process|
+            result = Smash.new
+            stdout = process_manager.create_io_tmp(Celluloid.uuid, 'stdout')
+            stderr = process_manager.create_io_tmp(Celluloid.uuid, 'stderr')
+            process.io.stdout = stdout
+            process.io.stderr = stderr
+            process.cwd = process_cwd
+            process.environment.replace(env.dup)
+            process.leader = true
+            result[:start_time] = Time.now.to_i
+            process.start
+            begin
+              process.poll_for_exit(config.fetch(:max_execution_time, 60))
+            rescue ChildProcess::TimeoutError
+              process.stop
+              result[:timed_out] = true
+            end
+            result[:stop_time] = Time.now.to_i
+            result[:exit_code] = process.exit_code
+            [stdout, stderr].each do |io|
+              key = "nellie/#{File.basename(io.path)}"
+              type = io.path.split('-').last
+              io.rewind
+              asset_store.put(key, io)
+              result.set(:logs, type, key)
+              io.close
+              File.delete(io.path)
+            end
+            results << result
+            unless(process.exit_code == 0)
+              payload.set(:data, :nellie, :result, :failed, true)
+            end
+          end
+          break if payload.get(:data, :nellie, :result, :failed)
+        end
+        results
+      end
+
+      # Extract nellie commands from repository file
+      #
+      # @param nellie_cwd [String] path to repository directory
+      # @param payload [Smash]
+      # @return [TrueClass, FalseClass]
+      def extract_nellie_commands(nellie_cwd, payload)
+        script_path = File.join(nellie_cwd, nellie_script_name)
+        if(File.exists?(script_path))
+          begin
+            nellie_cmds = MultiJson.load(File.read(script_path)).to_smash #Bogo::Config.new(script_path).data
+            debug "Nellie file is structured data. Populating commands into payload. (#{script_path})"
+            payload[:data].set(:nellie, :commands, nellie_cmds[:commands])
+            payload[:data].set(:nellie, :environment, nellie_cmds.fetch(:environment, {}))
+          rescue => e
+            debug "Parsing nellie file failed. Assuming direct execution. (#{script_path})"
+            payload[:data].set(:nellie, :commands,
+              File.executable?(script_path) ? script_path : "/bin/bash #{script_path}"
+            )
+          end
+          true
+        else
+          debug "Failed to locate nellie command file at: #{script_path}"
+          false
+        end
+      end
+
+      # Fetch code from asset store and unpack for local usage
+      #
+      # @param payload [Smash]
+      # @return [String] directory path
+      def fetch_code(payload)
+        repository_path = File.join(
+          working_directory,
+          payload[:message_id],
+          payload.get(:data, :code_fetcher, :asset)
+        )
+        if(File.directory?(repository_path))
+          warn "Existing path detected for repository unpack. Removing! (#{repository_path})"
+          FileUtils.rm_rf(repository_path)
+        end
+        FileUtils.mkdir_p(File.dirname(repository_path))
+        asset_store.unpack(
+          asset_store.get(payload.get(:data, :code_fetcher, :asset)),
+          repository_path,
+          :disable_overwrite
+        )
+        repository_path
+      end
+
+    end
+  end
+end

data/lib/jackal-nellie/version.rb

@@ -0,0 +1,6 @@
+module Jackal
+  module Nellie
+    # Current library version
+    VERSION = Gem::Version.new('0.1.0')
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: jackal-nellie
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jackal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Just do stuff
+email: code@chrisroberts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- jackal-nellie.gemspec
+- lib/jackal-nellie.rb
+- lib/jackal-nellie/formatter.rb
+- lib/jackal-nellie/formatter/github_commit_comment.rb
+- lib/jackal-nellie/formatter/slack_comment.rb
+- lib/jackal-nellie/processor.rb
+- lib/jackal-nellie/version.rb
+homepage: https://github.com/carnivore-rb/jackal-nellie
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Message processing helper
+test_files: []
+has_rdoc: