splunk-pickaxe 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5aa55d18be3bf8e837799f9749d4600fd31c18d97dd2d55047dcec589bce63a5
-  data.tar.gz: 47e31586bd3b61c81696be2dca691930d1146bde858f928a20c72d1296057c41
+  metadata.gz: f7898620b6ba1c671085b79b5f22d767066dd23b0efe44f3286a8cecd34df1f5
+  data.tar.gz: 8677d479c6a7552f6c82a23a5b58a04ee5ba944c8fd2cb6a6085f6e9979e1bbd
 SHA512:
-  metadata.gz: dad90b3e6d3bd034872edbaa92efc3a93e7031407e71809d3817889229e165d35be331583df6dc2bab06cf8a0d491bf06c0a7f8047de495da77b1bf55b87019b
-  data.tar.gz: 63f9959588456ef9679aa24c0b85afd292f7722a1426e06b41f3544722b087c8db7f3be27289f8aa6c817e3e99c7d1f8a66d393113f105bdfc1e4b2d757962ad
+  metadata.gz: e8c1c83a771dcc15ebe686c8130f3764ef2ccccb26fa3e00689b2888489a76540900281c8c0a242611b6f52c7556cd09670d3a3dc3b5d5cf4e3045afcdfb479e
+  data.tar.gz: 5a0258fb8382a92d505fbf97fb0b0cdeb1a9f68fdb4735c852428ec71e9c7c544c123b303d3bf7164a42f16d69bf41831195d19cece8dca4269f072c9db069b9

data/lib/splunk/pickaxe/cli.rb

@@ -61,6 +61,7 @@ module Splunk
       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.'
+      option :local_save, type: :boolean, desc: 'Only retrieve local Splunk objects from remote'
       def save(environment)
         cli = HighLine.new
 

data/lib/splunk/pickaxe/client.rb

@@ -38,14 +38,15 @@ module Splunk
 
       def save_all
         overwrite = @args.fetch(:overwrite, false)
+        local_save = @args.fetch(:local_save, false)
 
-        @alerts.save overwrite
-        @dashboards.save overwrite
-        @eventtypes.save overwrite
-        @macros.save overwrite
-        @reports.save overwrite
+        @alerts.save overwrite, local_save
+        @dashboards.save overwrite, local_save
+        @eventtypes.save overwrite, local_save
+        @macros.save overwrite, local_save
+        @reports.save overwrite, local_save
         # splunk-sdk doesn't seem to support iterating tags
-        @field_extractions.save overwrite
+        @field_extractions.save overwrite, local_save
       end
     end
   end

data/lib/splunk/pickaxe/objects.rb

@@ -89,32 +89,27 @@ module Splunk
         end
       end
 
-      def save(overwrite)
+      def save(overwrite, local_save)
         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, overwrite }
+                          .map { |e| save_config e, overwrite, local_save }
       end
 
-      def save_config(splunk_entity, overwrite)
+      def save_config(splunk_entity, overwrite, local_save)
         file_path = entity_file_path splunk_entity
 
-        puts "- #{splunk_entity.name}"
-        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 overwritten ? '  Overwritten' : '  Created'
+        if local_save
+          if File.exist?(file_path)
+            puts "- #{splunk_entity.name}"
+            write_to_file(file_path, overwrite, splunk_entity)
+          end
         else
-          puts '  Already exists'
+          puts "- #{splunk_entity.name}"
+          write_to_file(file_path, overwrite, splunk_entity)
         end
       end
 
@@ -171,6 +166,22 @@ module Splunk
         # Must be implemented by child class
         nil
       end
+
+      def write_to_file(file_path, overwrite, splunk_entity)
+        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 overwritten ? '  Overwritten' : '  Created'
+        else
+          puts '  Already exists'
+        end
+      end
     end
   end
 end

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

@@ -44,10 +44,21 @@ module Splunk
         ['.xml']
       end
 
-      def save_config(splunk_entity, overwrite)
+      def save_config(splunk_entity, overwrite, local_save)
         file_path = entity_file_path splunk_entity
 
-        puts "- #{splunk_entity['label']}"
+        if local_save
+          if File.exist?(file_path)
+            puts "- #{splunk_entity['label']}"
+            write_to_file(file_path, overwrite, splunk_entity)
+          end
+        else
+          puts "- #{splunk_entity['label']}"
+          write_to_file(file_path, overwrite, splunk_entity)
+        end
+      end
+
+      def write_to_file(file_path, overwrite, splunk_entity)
         if overwrite || !File.exist?(file_path)
           overwritten = overwrite && File.exist?(file_path)
 

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

@@ -47,10 +47,21 @@ module Splunk
         splunk_entity['value'] != splunk_config(entity)['value']
       end
 
-      def save_config(splunk_entity, overwrite)
+      def save_config(splunk_entity, overwrite, local_save)
         file_path = entity_file_path splunk_entity
 
-        puts "- #{splunk_entity.name}"
+        if local_save
+          if File.exist?(file_path)
+            puts "- #{splunk_entity.name}"
+            write_to_file(file_path, overwrite, splunk_entity)
+          end
+        else
+          puts "- #{splunk_entity.name}"
+          write_to_file(file_path, overwrite, splunk_entity)
+        end
+      end
+
+      def write_to_file(file_path, overwrite, splunk_entity)
         if overwrite || !File.exist?(file_path)
           config = splunk_entity_keys
                    .map { |k| { k => splunk_entity.fetch(k) } }

data/lib/splunk/pickaxe/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splunk-pickaxe
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Bryan Baugher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-24 00:00:00.000000000 Z
+date: 2019-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: splunk-sdk-ruby