splunk-pickaxe 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e55da5bc5897dd51554a5022a5f3e123a721be1f
-  data.tar.gz: 7a3143d708b70cc5d9cee018b0caecfd40a90e2b
+  metadata.gz: e30eda1563101ee3bf15dfaff58b4bcfcccc3d54
+  data.tar.gz: 553fcc43e768862110d4acd75dcd596a77db4424
 SHA512:
-  metadata.gz: ec70d9d035c320c620c96ab4d00d02d77abc50abed86e2932297861e42446085fcb3a178578e4d8524c5aeb216c8ff64f0743651fea206b98b562e8e8c591dc3
-  data.tar.gz: 6d9d9dc450bf4c4833dcb9aec225e2f603e04d099119a5c99fa905309e1dc2beff82f163a983004653e27438dfaef2c547b7bd54031a57201c7463f46269d54c
+  metadata.gz: c7d145f55702162f5c336c5fea2b63120434249f29f0583351e765cfe1034777051913cdbc792078a647e807955173a2d5ffdf69c193afa8a53a759ea60b59b8
+  data.tar.gz: 2982d1bdc9a7c8e8f1933311cd885d2130fd1e841e73dc1a592e2f45493135211e31b2542cb0a63e19d98f5b76fd3be2e4c7e77f2705dfd01c7b66fb772cb512

data/Gemfile

@@ -14,5 +14,4 @@ gem 'pry-rails', :group => :development
 
 group :release do
   gem 'octokit'
-  gem 'rubygems-tasks'
 end

data/README.md

@@ -8,6 +8,8 @@ A tool for serializing and syncing your repo of Splunk objects across Splunk ins
 This provides a development workflow for Splunk components (e.g., dashboards,
 alerts, reports, etc) and an easy way to apply them consistently.
 
+Check the [changelog](CHANGELOG.md) to see what has changed.
+
 Getting Started
 ---------------
 

data/Rakefile

@@ -22,10 +22,22 @@ task :release do
   update_change_log version
   puts "Change log updated!"
 
+  puts "Publishing the gem ..."
   run_command 'gem build splunk-pickaxe.gemspec'
   run_command "gem push splunk-pickaxe-#{version}.gem"
+  run_command "rm -f splunk-pickaxe-#{version}.gem"
+  puts "Gem published!"
 
+  puts "Creating git tag ..."
+  run_command "git tag #{version}"
+  run_command "git push origin #{version}"
+  puts "Git tag created!"
+
+  puts "Updating to next version ..."
   update_version version
+  puts "Version updated!"
+
+  puts "Gem released!"
 end
 
 task :build_change_log do

data/lib/splunk/pickaxe/cli.rb

@@ -49,9 +49,8 @@ module Splunk
 
         user = options[:user] || Etc.getlogin
         password = options[:password] || cli.ask('Password: ') { |o| o.echo = '*' }
-        execution_path = options[:repo_path] || Dir.getwd
 
-        pickaxe = Pickaxe.configure environment, user, password, execution_path
+        pickaxe = Pickaxe.configure environment, user, password, options
         pickaxe.sync_all
       end
 
@@ -59,14 +58,14 @@ module Splunk
       option :user, type: :string, desc: 'The user to login to splunk with. If this is not provide it will use the current user'
       option :password, type: :string, desc: 'The password to login to splunk with. If this is not provided it will ask for a password'
       option :repo_path, type: :string, desc: 'The path to the repo. If this is not specified it is assumed you are executing from within the repo'
+      option :overwrite, type: :boolean, desc: 'Overwrite any local Splunk objects which differ from remote objects with the same name.'
       def save(environment)
         cli = HighLine.new
 
         user = options[:user] || Etc.getlogin
         password = options[:password] || cli.ask('Password: ') { |o| o.echo = '*' }
-        execution_path = options[:repo_path] || Dir.getwd
 
-        pickaxe = Pickaxe.configure environment, user, password, execution_path
+        pickaxe = Pickaxe.configure environment, user, password, options
         pickaxe.save_all
       end
     end

data/lib/splunk/pickaxe/client.rb

@@ -12,8 +12,9 @@ module Splunk
     class Client
       attr_reader :service, :alerts, :dashboards, :eventypes, :reports, :tags, :field_extractions
 
-      def initialize(service, environment, config)
+      def initialize(service, environment, config, args)
         @service = service
+        @args = args
 
         @alerts = Alerts.new service, environment, config
         @dashboards = Dashboards.new service, environment, config
@@ -33,12 +34,14 @@ module Splunk
       end
 
       def save_all
-        @alerts.save
-        @dashboards.save
-        @eventtypes.save
-        @reports.save
+        overwrite = @args.fetch(:overwrite, false)
+
+        @alerts.save overwrite
+        @dashboards.save overwrite
+        @eventtypes.save overwrite
+        @reports.save overwrite
         # splunk-sdk doesn't seem to support iterating tags
-        @field_extractions.save
+        @field_extractions.save overwrite
       end
     end
   end

data/lib/splunk/pickaxe/config.rb

@@ -13,7 +13,7 @@ module Splunk
         },
         'environments' => {
         },
-        'emails' => []
+        'emails' => [],
       }.freeze
 
       def self.load(execution_path)

data/lib/splunk/pickaxe/cookie_proxy.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Splunk
+  module Pickaxe
+    class CookieProxy < Net::HTTP
+      @@cookies ||= nil
+
+      def request(req, body = nil, &block)  # :yield: +response+
+        if @@cookies 
+          req['Cookie'] = @@cookies
+        end
+        r = super(req,body,&block)
+        c = r.to_hash['set-cookie']
+        if c 
+          @@cookies = c.collect{|ea|ea[/^.*?;/]}.join
+        end
+        return r
+      end
+    end
+  end
+end

data/lib/splunk/pickaxe/objects/dashboards.rb

@@ -41,15 +41,17 @@ module Splunk
         ['.xml']
       end
 
-      def save_config(splunk_entity)
+      def save_config(splunk_entity, overwrite)
         file_path = entity_file_path splunk_entity
 
         puts "- #{splunk_entity['label']}"
-        if File.exist? file_path
-          puts '  Already exists'
-        else
+        if overwrite || !File.exist?(file_path)
+          overwritten = overwrite && File.exist?(file_path)
+
           File.write(file_path, splunk_entity['eai:data'])
-          puts '  Created'
+          puts overwritten ? '  Overwritten' : '  Created'
+        else
+          puts '  Already exists'
         end
       end
     end

data/lib/splunk/pickaxe/objects/field_extractions.rb

@@ -47,13 +47,11 @@ module Splunk
         splunk_entity['value'] != splunk_config(entity)['value']
       end
 
-      def save_config(splunk_entity)
+      def save_config(splunk_entity, overwrite)
         file_path = entity_file_path splunk_entity
 
         puts "- #{splunk_entity.name}"
-        if File.exist? file_path
-          puts '  Already exists'
-        else
+        if overwrite || !File.exist?(file_path)
           config = splunk_entity_keys
                    .map { |k| { k => splunk_entity.fetch(k) } }
                    .reduce({}) { |memo, setting| memo.update(setting) }
@@ -64,11 +62,14 @@ module Splunk
           config['type'] = splunk_entity.fetch('attribute').split('-').first
           config['value'].gsub!(/, /, ',')
 
+          overwritten = overwrite && File.exist?(file_path)
           File.write(file_path, {
             'name' => splunk_entity.name,
             'config' => config
           }.to_yaml)
-          puts ' Created'
+          puts overwritten ? '  Overwritten' : '  Created'
+        else
+          puts '  Already exists'
         end
       end
 

data/lib/splunk/pickaxe/objects.rb

@@ -86,27 +86,32 @@ module Splunk
         end
       end
 
-      def save
+      def save(overwrite)
         puts "Saving all #{entity_dir.capitalize}"
 
+        dir = File.join(pickaxe_config.execution_path, entity_dir)
+        Dir.mkdir dir unless Dir.exist? dir
+
         Splunk::Collection.new(service, splunk_resource)
-                          .map { |e| save_config e }
+                          .map { |e| save_config e, overwrite }
       end
 
-      def save_config(splunk_entity)
+      def save_config(splunk_entity, overwrite)
         file_path = entity_file_path splunk_entity
 
         puts "- #{splunk_entity.name}"
-        if File.exist? file_path
-          puts '  Already exists'
-        else
+        if overwrite || !File.exist?(file_path)
+          overwritten = overwrite && File.exist?(file_path)
+
           File.write(file_path, {
             'name' => splunk_entity.name,
             'config' => splunk_entity_keys
                           .map { |k| { k => splunk_entity.fetch(k) } }
                           .reduce({}) { |memo, setting| memo.update(setting) }
           }.to_yaml)
-          puts ' Created'
+          puts overwritten ? '  Overwritten' : '  Created'
+        else
+          puts '  Already exists'
         end
       end
 

data/lib/splunk/pickaxe/version.rb

@@ -2,6 +2,6 @@
 
 module Splunk
   module Pickaxe
-    VERSION = '2.1.0'
+    VERSION = '2.2.0'
   end
-end
+end

data/lib/splunk/pickaxe.rb

@@ -4,11 +4,12 @@ require 'splunk-sdk-ruby'
 require 'uri'
 require 'splunk/pickaxe/config'
 require 'splunk/pickaxe/client'
+require 'splunk/pickaxe/cookie_proxy'
 
 module Splunk
   module Pickaxe
-    def self.configure(environment, username, password, execution_path = Dir.getwd)
-      config = Config.load execution_path
+    def self.configure(environment, username, password, args)
+      config = Config.load(args.fetch(:repo_path, Dir.getwd))
 
       raise "Unknown environment [#{environment}]. Expected #{config.environments.keys}" unless config.environments.key?(environment)
 
@@ -16,6 +17,7 @@ module Splunk
 
       puts "Connecting to splunk [#{uri}]"
       service = Splunk.connect(
+        proxy: CookieProxy,
         scheme: uri.scheme.to_sym,
         host: uri.host,
         port: uri.port,
@@ -24,7 +26,7 @@ module Splunk
         namespace: config.namespace
       )
 
-      Client.new service, environment.downcase, config
+      Client.new service, environment.downcase, config, args
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splunk-pickaxe
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Bryan Baugher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-07 00:00:00.000000000 Z
+date: 2017-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: splunk-sdk-ruby
@@ -96,6 +96,7 @@ files:
 - lib/splunk/pickaxe/cli.rb
 - lib/splunk/pickaxe/client.rb
 - lib/splunk/pickaxe/config.rb
+- lib/splunk/pickaxe/cookie_proxy.rb
 - lib/splunk/pickaxe/objects.rb
 - lib/splunk/pickaxe/objects/alerts.rb
 - lib/splunk/pickaxe/objects/dashboards.rb