jackal-nellie 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fc28040880f840d3d776b0e5ed41da763ca378e
-  data.tar.gz: 613c27b510f638ed2e313af92f15a890c380aa42
+  metadata.gz: b75d4681c23715ca2f5c2778af3ad04f526d50c8
+  data.tar.gz: f31c526030005cb15e6ba1eff4e22c8d082f3968
 SHA512:
-  metadata.gz: 67d33c02e28ce8a71e1f9d892d1cd781debaeb8a338ee1195f9922d74319313950dfb24d370da8a2a43c0b1f7916756dacf9c3091863b7f109eba324a704f9d8
-  data.tar.gz: 26787ae8a8c550a8e56b30b1268f28f2459b25b8df051d2af3b5546aa7ab4180da2b08963bd95fc082af55cddeebea1a569fca1bcd248e7b0fbc7b0870794c53
+  metadata.gz: 5c21247741e97b33c48523dd8d09b164613eaaa9a23bf31906c686900a4ddf380f7c0d18518fc470a0598acceceb34d13d1a4c30cd7284727d809f227fcc1695
+  data.tar.gz: 484ecdfff4016b31ae1c2348dd5cc8492b0de8d01e2350c01bee801858b784e17b89354f8702591d07df57b05d8b7ceef004cc2f88895724a5c96827ce3d9187

data/README.md

@@ -9,7 +9,38 @@ fetcher service.
 
 ## Configuration
 
+Available configuration options:
 
+* `working_directory` - working directory on host system
+* `script_name` - file name of nellie file (defaults to `.nellie`)
+* `max_execution_time` - maximum number of seconds to allow execution
+
+## Nellie file structure
+
+Nellie supports two file styles:
+
+1. Executable
+2. JSON
+
+### Executable format
+
+If the file is not in a JSON format, nellie will attempt to execute
+it using the `bash` shell.
+
+### JSON format
+
+Nellie also supports a JSON file with the following structure:
+
+```json
+{
+  "commands": [
+    "touch /tmp/test.txt"
+  ],
+  "environment": {
+    "MY_VAR": "MY_VALUE"
+  }
+}
+```
 
 # Info
 

data/lib/jackal-nellie/formatter.rb

@@ -13,7 +13,7 @@ module Jackal
             payload.get(:data, :code_fetcher, :info, :name)
           ].join('/')
           sha = payload.get(:data, :code_fetcher, :info, :commit_sha)
-          "[nellie]: Job completed successfully! (#{repo}@#{sha})"
+          "[#{app_config.fetch(:branding, :name, 'Nellie')}]: Job completed successfully! (#{repo}@#{sha})"
         end
 
         # Message for failure results
@@ -21,17 +21,23 @@ module Jackal
         # @param payload [Smash]
         # @return [String]
         def failure_message(payload)
-          msg = ['[nellie]: Failure encountered:']
+          msg = ["[#{app_config.fetch(:branding, :name, 'Nellie')}]: Failure encountered:"]
           msg << ''
           failed_history = payload.fetch(:data, :nellie, :history, {}).detect do |i|
             i[:exit_code] != 0
           end
           if(failed_history)
+            stdout = asset_store.get(failed_history.get(:logs, :stdout))
+            stdout_pos = stdout.size - 1024
+            stdout.seek(stdout_pos < 0 ? 0 : stdout_pos)
+            stderr = asset_store.get(failed_history.get(:logs, :stderr))
+            stderr_pos = stderr.size - 1034
+            stderr.seek(stderr_pos < 0 ? 0 : stderr_pos)
             msg << '* STDOUT:' << '' << '```'
-            msg << asset_store.get(failed_history.get(:logs, :stdout)).read
+            msg << stdout.read
             msg << '```' << ''
             msg << '* STDERR:' << '' << '```'
-            msg << asset_store.get(failed_history.get(:logs, :stderr)).read
+            msg << stderr.read
             msg << '```'
           else
             msg << '```' << 'Failed to locate logs' << '```'
@@ -44,5 +50,6 @@ module Jackal
   end
 end
 
+require 'jackal-nellie/formatter/github_commit_status'
 require 'jackal-nellie/formatter/github_commit_comment'
 require 'jackal-nellie/formatter/slack_comment'

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

@@ -0,0 +1,43 @@
+require 'jackal'
+
+module Jackal
+  module Nellie
+    module Formatter
+
+      class GithubCommitStatus < Jackal::Formatter
+
+        include MessageExtract
+
+        # Source service
+        SOURCE = :nellie
+        # Destination service
+        DESTINATION = :github_kit
+
+        # Format payload to provide output status to GitHub
+        #
+        # @param payload [Smash]
+        def format(payload)
+          if(payload.get(:data, :nellie, :status))
+            payload.set(:data, :github_kit, :status,
+              Smash.new(
+                :repository => [
+                  payload.get(:data, :code_fetcher, :info, :owner),
+                  payload.get(:data, :code_fetcher, :info, :name)
+                ].join('/'),
+                :reference => payload.get(:data, :code_fetcher, :info, :commit_sha),
+                :state => payload.get(:data, :nellie, :status) == 'success' ? 'success' : 'failure',
+                :extras => {
+                  :context => 'nellie',
+                  :description => payload.get(:data, :nellie, :status) == 'success' ?
+                    "#{app_config.fetch(:branding, :name, 'Nellie')} completed successfully" :
+                    "#{app_config.fetch(:branding, :name, 'Nellie')} failed to complete"
+                }
+              )
+            )
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -21,13 +21,13 @@ module Jackal
             msgs = payload.fetch(:data, :slack, :messages, [])
             if(payload.get(:data, :nellie, :result, :complete))
               msgs << Smash.new(
-                :description => 'Nellie job result:',
+                :description => "#{app_config.fetch(:branding, :name, 'Nellie')} job result:",
                 :message => success_message(payload),
                 :color => :good
               )
             else
               msgs << Smash.new(
-                :description => 'Nellie job result:',
+                :description => "#{app_config.fetch(:branding, :name, 'Nellie')} job result:",
                 :message => failure_message(payload),
                 :color => :bad
               )

data/lib/jackal-nellie/processor.rb

@@ -47,13 +47,18 @@ module Jackal
         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})"
+          begin
+            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
+          ensure
+            debug "Removing nellie job working directory: `#{nellie_cwd}`"
+            FileUtils.rm_rf(File.dirname(nellie_cwd))
           end
           job_completed(:nellie, payload, message)
         end
@@ -76,8 +81,17 @@ module Jackal
         payload.set(:data, :nellie, :history, results)
         payload[:data][:nellie].delete(:commands)
         payload[:data][:nellie].delete(:environment)
+        if(payload.get(:data, :nellie, :cleanup))
+          debug "Cleanup commands detected. Running now."
+          cleanup_results = run_commands(payload[:data][:nellie].delete(:cleanup), process_environment, payload, nellie_cwd)
+          payload.set(:data, :nellie, :cleanup_history, cleanup_results)
+          debug "Cleanup commands have completed."
+        end
         unless(payload.get(:data, :nellie, :result, :failed))
           payload.set(:data, :nellie, :result, :complete, true)
+          if(payload.get(:data, :nellie, :release_assets))
+            set_github_release_assets(payload, nellie_cwd)
+          end
         end
         payload.set(:data, :nellie, :status,
           payload.get(:data, :nellie, :result, :complete) ? 'success' : 'error'
@@ -85,6 +99,47 @@ module Jackal
         true
       end
 
+      # Populate for pushing github release assets
+      #
+      # @param payload [Smash]
+      # @param nellie_cwd [String] working directory of repo
+      # @return [NilClass]
+      def set_github_release_assets(payload, nellie_cwd)
+        release_assets = Dir.glob(File.join(nellie_cwd, payload.get(:data, :nellie, :release_assets)))
+        unless(release_assets.empty?)
+          debug "Release assets detected: #{release_assets}"
+          release_asset_keys = release_assets.map do |asset|
+            asset_key = "nellie/release-assets/#{payload[:id]}/#{File.basename(asset)}"
+            asset_store.put(asset_key, File.open(asset, 'rb'))
+            asset_key
+          end
+          if(payload.get(:data, :code_fetcher, :info, :ref).to_s.include?('/tags/'))
+            version = payload.get(:data, :code_fetcher, :info, :ref).to_s.sub(/^.*\/tags\//, '')
+          else
+            version = payload.get(:data, :code_fetcher, :info, :commit_sha).to_s[0,6]
+            prerelease = true
+          end
+          payload.set(:data, :github_kit, :release,
+            Smash.new(
+              :repository => [
+                payload.get(:data, :code_fetcher, :info, :owner),
+                payload.get(:data, :code_fetcher, :info, :name)
+              ].join('/'),
+              :reference => payload.get(:data, :code_fetcher, :info, :commit_sha),
+              :tag_name => version,
+              :name => [
+                payload.get(:data, :code_fetcher, :info, :name),
+                version
+              ].join('-'),
+              :body => "Release - #{payload.get(:data, :code_fetcher, :info, :name)} <#{version}>",
+              :prerelease => prerelease,
+              :assets => release_asset_keys
+            )
+          )
+          nil
+        end
+      end
+
       # Run collection of commands
       #
       # @param commands [Array<String>] commands to execute
@@ -96,9 +151,10 @@ module Jackal
         results = []
         commands.each do |command|
           process_manager.process(payload[:id], command) do |process|
+            info "Running command `#{command}` in `#{process_cwd}`"
             result = Smash.new
-            stdout = process_manager.create_io_tmp(Carnivore.uuid, 'stdout')
-            stderr = process_manager.create_io_tmp(Carnivore.uuid, 'stderr')
+            stdout = process_manager.create_io_tmp(payload[:id], 'stdout')
+            stderr = process_manager.create_io_tmp(payload[:id], 'stderr')
             process.io.stdout = stdout
             process.io.stderr = stderr
             process.cwd = process_cwd
@@ -123,6 +179,8 @@ module Jackal
               io.close
               File.delete(io.path)
             end
+            info "Completed command `#{command}` in `#{process_cwd}`. " \
+              "Runtime: #{result[:stop_time] - result[:start_time]} seconds"
             results << result
             unless(process.exit_code == 0)
               payload.set(:data, :nellie, :result, :failed, true)
@@ -146,6 +204,8 @@ module Jackal
             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, {}))
+            payload[:data].set(:nellie, :cleanup, Array(nellie_cmds[:cleanup])) if nellie_cmds[:cleanup]
+            payload[:data].set(:nellie, :release_assets, nellie_cmds[:release]) if nellie_cmds[:release]
           rescue => e
             debug "Parsing nellie file failed. Assuming direct execution. (#{script_path})"
             payload[:data].set(:nellie, :commands,
@@ -167,17 +227,22 @@ module Jackal
         repository_path = File.join(
           working_directory,
           payload[:id],
-          payload.get(:data, :code_fetcher, :asset)
+          payload.get(:data, :code_fetcher, :asset).sub(/\..*$/, '')
         )
         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))
+        code_asset = asset_store.get(payload.get(:data, :code_fetcher, :asset))
+        packed_code_asset_path = File.join(working_directory, "code-asset-#{payload[:id]}.zip")
+        FileUtils.cp(code_asset.path, packed_code_asset_path)
+        packed_code_asset = File.open(packed_code_asset_path, 'rb')
         asset_store.unpack(
-          asset_store.get(payload.get(:data, :code_fetcher, :asset)),
+          packed_code_asset,
           repository_path
         )
+        File.unlink(packed_code_asset_path)
         repository_path
       end
 

data/lib/jackal-nellie/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackal-nellie
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-01 00:00:00.000000000 Z
+date: 2017-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jackal
@@ -86,6 +86,7 @@ files:
 - lib/jackal-nellie.rb
 - lib/jackal-nellie/formatter.rb
 - lib/jackal-nellie/formatter/github_commit_comment.rb
+- lib/jackal-nellie/formatter/github_commit_status.rb
 - lib/jackal-nellie/formatter/slack_comment.rb
 - lib/jackal-nellie/processor.rb
 - lib/jackal-nellie/version.rb
@@ -114,4 +115,3 @@ signing_key:
 specification_version: 4
 summary: Message processing helper
 test_files: []
-has_rdoc: