splunk-pickaxe 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 380cb464caac68882fc7d3b81b54dd3fcd5c3f95
-  data.tar.gz: 2b6542dd650ad6e0f3ea7933ca482c26c095b34a
+SHA256:
+  metadata.gz: 5aa55d18be3bf8e837799f9749d4600fd31c18d97dd2d55047dcec589bce63a5
+  data.tar.gz: 47e31586bd3b61c81696be2dca691930d1146bde858f928a20c72d1296057c41
 SHA512:
-  metadata.gz: c0faf0088aa94e73f70e477ae689df7e766b2e6ef01242056782d798314d1077dda754484ab02d00a9a6bc31bbd6053cf9eada6c05eb914e22361faced1a1b4b
-  data.tar.gz: 16fcf217d1e2afc3965c5545be2338e4ce8175f18b0d87b4b5cd992272d871eff249558003ea2a99bb19f48df944c0e0b6707f1525b2a87b538ca64e018a22a8
+  metadata.gz: dad90b3e6d3bd034872edbaa92efc3a93e7031407e71809d3817889229e165d35be331583df6dc2bab06cf8a0d491bf06c0a7f8047de495da77b1bf55b87019b
+  data.tar.gz: 63f9959588456ef9679aa24c0b85afd292f7722a1426e06b41f3544722b087c8db7f3be27289f8aa6c817e3e99c7d1f8a66d393113f105bdfc1e4b2d757962ad

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'bundler', '~> 1.14'
+  gem 'bundler', '~> 2.0'
   gem 'rake', '~> 12.0'
   gem 'rspec', '~> 3.5'
 end

data/README.md

@@ -1,7 +1,7 @@
 Splunk-Pickaxe
 ==============
 
-[![Build Status](https://travis-ci.org/cerner/splunk-pickaxe.svg?branch=master)](https://travis-ci.org/cerner/splunk-pickaxe)
+[![Build Status](https://travis-ci.com/cerner/splunk-pickaxe.svg?branch=master)](https://travis-ci.com/cerner/splunk-pickaxe)
 
 A tool for serializing and syncing your repo of Splunk objects across Splunk instances.
 
@@ -93,6 +93,10 @@ You can override these defaults or any other property by specifying the property
 under the `config` section. [This doc](http://docs.splunk.com/Documentation/Splunk/latest/RESTREF/RESTsearch#saved.2Fsearches.2F.7Bname.7D)
 contains all the properties for an alert.
 
+By default the alert name will have the splunk environment name appended
+to it to differentiate its alert from others. This can be disabled in the
+alert's config by setting `pickaxe.environment.in.name` to `false`.
+
 #### Common Overrides
 
  * To tweak the schedule set `cron_schedule` in the `config` section. By default its setup to run every hour. This should be a cron value (i.e. `0 10 * * 1` or run every Monday at 10am)
@@ -158,6 +162,10 @@ You can override these defaults or any other property by specifying the property
 under the `config` section. [This doc](http://docs.splunk.com/Documentation/Splunk/latest/RESTREF/RESTsearch#saved.2Fsearches.2F.7Bname.7D)
 contains all the properties for an report.
 
+By default the report name will have the splunk environment name appended
+to it to differentiate its report from others. This can be disabled in the
+report's config by setting `pickaxe.environment.in.name` to `false`.
+
 #### Common Overrides
 
  * To tweak the schedule set `cron_schedule` in the `config` section. By default its setup to run every hour. This should be a cron value (i.e. `0 10 * * 1` or run every Monday at 10am)

data/lib/splunk/pickaxe/config.rb

@@ -7,9 +7,11 @@ module Splunk
     class Config
       CONFIG_FILE ||= '.pickaxe.yml'
 
+      SHARING_DEFAULT = 'app'
+
       DEFAULTS ||= {
         'namespace' => {
-          'sharing' => 'app'
+          'sharing' => SHARING_DEFAULT
         },
         'environments' => {
         },
@@ -27,7 +29,6 @@ module Splunk
       attr_reader :namespace, :environment, :execution_path, :emails, :url, :env_config
 
       def initialize(config, environment, execution_path)
-        raise "Config must have a 'namespace / app' config" unless config['namespace'].key?('app')
         raise "Environment [#{environment}] is not configured" unless config['environments'].has_key?(environment)
 
         @execution_path = execution_path
@@ -41,18 +42,32 @@ module Splunk
           @emails = config['emails']
           @url = env_config
           @env_config = { 'url' => @url, 'emails' => @emails }
+
+          # Convert namespace config hash to hash with symbols for keys
+          namespace_config = config['namespace'].each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; }
+          @namespace = Splunk.namespace(namespace_config)
         elsif env_config.is_a?(Hash)
           raise "url config is required for environment [#{environment}]" unless env_config.has_key?('url')
           @url = env_config['url']
           @emails = env_config.has_key?('emails') ? env_config['emails'] : config['emails']
           @env_config = env_config
+
+          # If the environment config has namespace use it otherwise fallback to root config
+          if env_config.has_key?('namespace')
+            raise "Environment config must have a 'namespace / app' config" unless env_config['namespace'].key?('app')
+            namespace_config = env_config['namespace']
+            namespace_config['sharing'] = SHARING_DEFAULT unless namespace_config.has_key?('sharing')
+          else
+            raise "Config must have a 'namespace / app' config" unless config['namespace'].key?('app')
+            namespace_config = config['namespace']
+          end
+
+          # Convert namespace config hash to hash with symbols for keys
+          @namespace = Splunk.namespace(namespace_config.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; })
         else
           raise "Unexepcted value for environment [#{environment}] config. Expected String or Hash, saw #{config['environments'][environment]}"
         end
 
-        # Convert namespace config hash to hash with symbols for keys
-        namespace_config = config['namespace'].each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; }
-        @namespace = Splunk.namespace(namespace_config)
       end
 
       private

data/lib/splunk/pickaxe/objects.rb

@@ -70,11 +70,11 @@ module Splunk
 
       def create(entity)
         entity_collection = Splunk::Collection.new service, splunk_resource
-        entity_collection.create(name(entity), splunk_config(entity))
+        entity_collection.create(name(entity), remove_pickaxe_config(splunk_config(entity)))
       end
 
       def update(splunk_entity, entity)
-        splunk_entity.update(splunk_config(entity))
+        splunk_entity.update(remove_pickaxe_config(splunk_config(entity)))
       end
 
       def find(entity)
@@ -148,6 +148,10 @@ module Splunk
         ['.yml', '.yaml']
       end
 
+      def remove_pickaxe_config config
+        config.select{|key, value| !key.start_with?('pickaxe') }
+      end
+
       def splunk_resource
         # Must be implemented by child class
         nil

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

@@ -26,7 +26,11 @@ module Splunk
 
       def name(entity)
         # The alert name contains the environment name
-        "#{entity['name']} [#{environment.capitalize}]"
+        if splunk_config(entity)['pickaxe.environment.in.name']
+          return "#{entity['name']} [#{environment.capitalize}]"
+        end
+
+        entity['name']
       end
 
       def splunk_config(entity_yaml)
@@ -41,6 +45,9 @@ module Splunk
 
       def alert_defaults
         {
+          # Default to include the environment name in the alert name
+          'pickaxe.environment.in.name' => true,
+
           # Who to email
           'action.email.to' => pickaxe_config.emails.join(','),
 

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

@@ -25,7 +25,11 @@ module Splunk
 
       def name(entity)
         # The report name contains the environment name
-        "#{entity['name']} [#{environment.capitalize}]"
+        if splunk_config(entity)['pickaxe.environment.in.name']
+          return "#{entity['name']} [#{environment.capitalize}]"
+        end
+
+        entity['name']
       end
 
       def splunk_config(entity_yaml)
@@ -40,6 +44,9 @@ module Splunk
 
       def report_defaults
         {
+          # Default to include the environment name in the report name
+          'pickaxe.environment.in.name' => true,
+
           # Who to email
           'action.email.to' => pickaxe_config.emails.join(','),
 

data/lib/splunk/pickaxe/version.rb

@@ -2,6 +2,6 @@
 
 module Splunk
   module Pickaxe
-    VERSION = '2.5.0'
+    VERSION = '2.6.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splunk-pickaxe
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Bryan Baugher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-07 00:00:00.000000000 Z
+date: 2019-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: splunk-sdk-ruby
@@ -127,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A tool for syncing your repo of splunk objects with a splunk instance